First commit

fguillot · fguillot · commit c6189c419678 · 2015-10-17T21:07:47.000-04:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2015 Frédéric Guillot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/Locale/cs_CZ/translations.php b/Locale/cs_CZ/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Nápověda pro Slack integraci.',
+    'Channel/Group/User (Optional)' => 'Kanál/Skupina/Uživatel (volitelně)',
+);
+
diff --git a/Locale/da_DK/translations.php b/Locale/da_DK/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    // 'Help on Slack integration' => '',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Locale/de_DE/translations.php b/Locale/de_DE/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Hilfe für Slack-Integration.',
+    'Channel/Group/User (Optional)' => 'Kanal/Gruppe/Benutzer (optional)',
+);
+
diff --git a/Locale/es_ES/translations.php b/Locale/es_ES/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Ayuda sobre integración Desatendida',
+    'Channel/Group/User (Optional)' => 'Canal/Grupo/Usuario (Opcional)',
+);
+
diff --git a/Locale/fi_FI/translations.php b/Locale/fi_FI/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    // 'Help on Slack integration' => '',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Locale/fr_FR/translations.php b/Locale/fr_FR/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Aide sur l\'intégration avec Slack',
+    'Channel/Group/User (Optional)' => 'Canal/Groupe/Utilisateur (Optionnel)',
+);
+
diff --git a/Locale/hu_HU/translations.php b/Locale/hu_HU/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    // 'Help on Slack integration' => '',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Locale/id_ID/translations.php b/Locale/id_ID/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Bantuan pada integrasi Slack',
+    'Channel/Group/User (Optional)' => 'Kanal/Grup/Pengguna (pilihan)',
+);
+
diff --git a/Locale/it_IT/translations.php b/Locale/it_IT/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Guida all\'integrazione con Slack',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Locale/ja_JP/translations.php b/Locale/ja_JP/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Slack 連携のヘルプ',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Locale/nb_NO/translations.php b/Locale/nb_NO/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    // 'Help on Slack integration' => '',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Locale/nl_NL/translations.php b/Locale/nl_NL/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    // 'Help on Slack integration' => '',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Locale/pl_PL/translations.php b/Locale/pl_PL/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    // 'Help on Slack integration' => '',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Locale/pt_BR/translations.php b/Locale/pt_BR/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Ajuda sobre integração com o Slack',
+    'Channel/Group/User (Optional)' => 'Canal/Grupo/Utilizador (Opcional)',
+);
+
diff --git a/Locale/pt_PT/translations.php b/Locale/pt_PT/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Ajuda na integração com o Slack',
+    'Channel/Group/User (Optional)' => 'Canal/Grupo/Utilizador (Opcional)',
+);
+
diff --git a/Locale/ru_RU/translations.php b/Locale/ru_RU/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Помощь по интеграции Slack',
+    'Channel/Group/User (Optional)' => 'Канал/Группа/Пользователь (опционально)',
+);
+
diff --git a/Locale/sr_Latn_RS/translations.php b/Locale/sr_Latn_RS/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    // 'Help on Slack integration' => '',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Locale/sv_SE/translations.php b/Locale/sv_SE/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Hjälp för Slack integration',
+    'Channel/Group/User (Optional)' => 'Kanal/Grupp/Användare (valfri)',
+);
+
diff --git a/Locale/th_TH/translations.php b/Locale/th_TH/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    // 'Help on Slack integration' => '',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Locale/tr_TR/translations.php b/Locale/tr_TR/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    // 'Help on Slack integration' => '',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Locale/zh_CN/translations.php b/Locale/zh_CN/translations.php
@@ -0,0 +1,7 @@
+<?php
+
+return array(
+    'Help on Slack integration' => 'Slack 整合帮助',
+    // 'Channel/Group/User (Optional)' => '',
+);
+
diff --git a/Makefile b/Makefile
@@ -0,0 +1,4 @@
+PLUGIN_NAME = Slack
+
+all:
+	@ git archive HEAD --prefix=${PLUGIN_NAME}/ --format=zip -o ${PLUGIN_NAME}.zip
diff --git a/Notification/Slack.php b/Notification/Slack.php
@@ -0,0 +1,107 @@
+<?php
+
+namespace Kanboard\Plugin\Slack\Notification;
+
+use Kanboard\Core\Base;
+use Kanboard\Notification\NotificationInterface;
+
+/**
+ * Slack Notification
+ *
+ * @package  notification
+ * @author   Frederic Guillot
+ */
+class Slack extends Base implements NotificationInterface
+{
+    /**
+     * Send notification to a user
+     *
+     * @access public
+     * @param  array     $user
+     * @param  string    $event_name
+     * @param  array     $event_data
+     */
+    public function notifyUser(array $user, $event_name, array $event_data)
+    {
+        $webhook = $this->userMetadata->get($user['id'], 'slack_webhook_url', $this->config->get('slack_webhook_url'));
+        $channel = $this->userMetadata->get($user['id'], 'slack_webhook_channel');
+
+        if (! empty($webhook)) {
+            $project = $this->project->getById($event_data['task']['project_id']);
+            $this->sendMessage($webhook, $channel, $project, $event_name, $event_data);
+        }
+    }
+
+    /**
+     * Send notification to a project
+     *
+     * @access public
+     * @param  array     $project
+     * @param  string    $event_name
+     * @param  array     $event_data
+     */
+    public function notifyProject(array $project, $event_name, array $event_data)
+    {
+        $webhook = $this->projectMetadata->get($project['id'], 'slack_webhook_url', $this->config->get('slack_webhook_url'));
+        $channel = $this->projectMetadata->get($project['id'], 'slack_webhook_channel');
+
+        if (! empty($webhook)) {
+            $this->sendMessage($webhook, $channel, $project, $event_name, $event_data);
+        }
+    }
+
+    /**
+     * Get message to send
+     *
+     * @access public
+     * @param  array     $project
+     * @param  string    $event_name
+     * @param  array     $event_data
+     */
+    public function getMessage(array $project, $event_name, array $event_data)
+    {
+        if ($this->userSession->isLogged()) {
+            $author = $this->user->getFullname($this->session['user']);
+            $title = $this->notification->getTitleWithAuthor($author, $event_name, $event_data);
+        } else {
+            $title = $this->notification->getTitleWithoutAuthor($event_name, $event_data);
+        }
+
+        $message = '*['.$project['name'].']* ';
+        $message .= $title;
+        $message .= ' ('.$event_data['task']['title'].')';
+
+        if ($this->config->get('application_url') !== '') {
+            $message .= ' - <';
+            $message .= $this->helper->url->to('task', 'show', array('task_id' => $event_data['task']['id'], 'project_id' => $project['id']), '', true);
+            $message .= '|'.t('view the task on Kanboard').'>';
+        }
+
+        return array(
+            'text' => $message,
+            'username' => 'Kanboard',
+            'icon_url' => 'http://kanboard.net/assets/img/favicon.png',
+        );
+    }
+
+    /**
+     * Send message to Slack
+     *
+     * @access private
+     * @param  srting    $webhook
+     * @param  string    $channel
+     * @param  array     $project
+     * @param  string    $event_name
+     * @param  array     $event_data
+     */
+    private function sendMessage($webhook, $channel, array $project, $event_name, array $event_data)
+    {
+        $payload = $this->getMessage($project, $event_name, $event_data);
+
+        if (! empty($channel)) {
+            $payload['channel'] = $channel;
+        }
+
+        $this->httpClient->postJson($webhook, $payload);
+    }
+}
diff --git a/Plugin.php b/Plugin.php
@@ -0,0 +1,49 @@
+<?php
+
+namespace Kanboard\Plugin\Slack;
+
+use Kanboard\Core\Translator;
+use Kanboard\Core\Plugin\Base;
+
+/**
+ * Slack Plugin
+ *
+ * @package  slack
+ * @author   Frederic Guillot
+ */
+class Plugin extends Base
+{
+    public function initialize()
+    {
+        $this->template->hook->attach('template:config:integrations', 'slack:config/integration');
+        $this->template->hook->attach('template:project:integrations', 'slack:project/integration');
+        $this->template->hook->attach('template:user:integrations', 'slack:user/integration');
+
+        $this->userNotificationType->setType('slack', t('Slack'), '\Kanboard\Plugin\Slack\Notification\Slack');
+        $this->projectNotificationType->setType('slack', t('Slack'), '\Kanboard\Plugin\Slack\Notification\Slack');
+
+        $this->on('session.bootstrap', function($container) {
+            Translator::load($container['config']->getCurrentLanguage(), __DIR__.'/Locale');
+        });
+    }
+
+    public function getPluginDescription()
+    {
+        return 'Receive notifications on Slack';
+    }
+
+    public function getPluginAuthor()
+    {
+        return 'Frédéric Guillot';
+    }
+
+    public function getPluginVersion()
+    {
+        return '1.0.0';
+    }
+
+    public function getPluginHomepage()
+    {
+        return 'https://github.com/kanboard/plugin-slack';
+    }
+}
diff --git a/README.md b/README.md
@@ -0,0 +1,42 @@
+Slack plugin for Kanboard
+=========================
+
+Receive Kanboard notifications on Slack.
+
+Author
+------
+
+- Frederic Guillot
+- License MIT
+
+Installation
+------------
+
+- Create a folder **plugins/Slack**
+- Copy all files under this directory
+
+Configuration
+-------------
+
+Firstly, you have to generate a new webhook url in Slack (**Configured Integrations > Incoming Webhook**).
+
+You can define only one webhook url (**Settings > Integrations > Slack**) and override the channel for each project and user.
+
+### Receive individual user notifications
+
+- Go to your user profile then choose **Integrations > Slack**
+- Copy and paste the webhook url from Slack or leave it blank if you want to use the global webhook url
+- Use `@username` to receive direct message to your user
+- Enable Slack in your user notifications **Notifications > Slack**
+
+### Receive project notifications to a room
+
+- Go to the project settings then choose **Integrations > Slack**
+- Copy and paste the webhook url from Slack or leave it blank if you want to use the global webhook url
+- Use `#channel` to receive messages in a specific channel
+- Enable Slack in your project notifications **Notifications > Slack**
+
+## Troubleshooting
+
+- Enable the debug mode
+- All connection errors with the Slack API are recorded in the log files `data/debug.log` or syslog
diff --git a/Template/config/integration.php b/Template/config/integration.php
diff --git a/Template/project/integration.php b/Template/project/integration.php
diff --git a/Template/user/integration.php b/Template/user/integration.php
