AS1024/Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve webhooks to call external url on task creation/modification

Browse Source
This commit is contained in:
Frédéric Guillot
2014-07-21 20:32:12 -02:30
parent 4ae655ced3
commit 9e1dcf21dc
18 changed files with 320 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
app/Controller/Base.php
View File

@@ -151,6 +151,7 @@ abstract class Base
// Attach events
$this->action->attachEvents();
$this->project->attachEvents();
$this->webhook->attachEvents();
}
/**

8
app/Event/TaskModification.php → app/Event/ProjectModificationDate.php
View File

@@ -6,12 +6,14 @@ use Core\Listener;
use Model\Project;
/**
* Task modification listener
* Project modification date listener
*
* @package events
* Update the last modified field for a project
*
* @package event
* @author Frederic Guillot
*/
class TaskModification implements Listener
class ProjectModificationDate implements Listener
{
/**
* Project model

49
app/Event/WebhookListener.php Normal file
View File

@@ -0,0 +1,49 @@
<?php
namespace Event;
use Core\Listener;
use Model\Webhook;
/**
* Webhook task events
*
* @package event
* @author Frederic Guillot
*/
class WebhookListener implements Listener
{
/**
* Webhook model
*
* @accesss private
* @var \Model\Webhook
*/
private $webhook;
/**
* Constructor
*
* @access public
* @param string $url URL to call
* @param \Model\Webhook $webhook Webhook model instance
*/
public function __construct($url, Webhook $webhook)
{
$this->url = $url;
$this->webhook = $webhook;
}
/**
* Execute the action
*
* @access public
* @param array $data Event data dictionary
* @return bool True if the action was executed or false when not executed
*/
public function execute(array $data)
{
$this->webhook->notify($this->url, $data);
return true;
}
}

2
app/Locales/de_DE/translations.php
View File

@@ -396,4 +396,6 @@ return array(
// 'Creator' => '',
// 'Modification date' => '',
// 'Completion date' => '',
// 'Webhook URL for task creation' => '',
// 'Webhook URL for task modification' => '',
);

2
app/Locales/es_ES/translations.php
View File

@@ -395,4 +395,6 @@ return array(
// 'Creator' => '',
// 'Modification date' => '',
// 'Completion date' => '',
// 'Webhook URL for task creation' => '',
// 'Webhook URL for task modification' => '',
);

2
app/Locales/fr_FR/translations.php
View File

@@ -393,4 +393,6 @@ return array(
'Creator' => 'Créateur',
'Modification date' => 'Date de modification',
'Completion date' => 'Date de complétion',
'Webhook URL for task creation' => 'URL du webhook pour la création de tâche',
'Webhook URL for task modification' => 'URL du webhook pour la modification de tâche',
);

2
app/Locales/pl_PL/translations.php
View File

@@ -396,4 +396,6 @@ return array(
// 'Creator' => '',
// 'Modification date' => '',
// 'Completion date' => '',
// 'Webhook URL for task creation' => '',
// 'Webhook URL for task modification' => '',
);

2
app/Locales/pt_BR/translations.php
View File

@@ -393,4 +393,6 @@ return array(
// 'Creator' => '',
// 'Modification date' => '',
// 'Completion date' => '',
// 'Webhook URL for task creation' => '',
// 'Webhook URL for task modification' => '',
);

2
app/Locales/sv_SE/translations.php
View File

@@ -395,4 +395,6 @@ return array(
// 'Creator' => '',
// 'Modification date' => '',
// 'Completion date' => '',
// 'Webhook URL for task creation' => '',
// 'Webhook URL for task modification' => '',
);

2
app/Locales/zh_CN/translations.php
View File

@@ -401,4 +401,6 @@ return array(
// 'Creator' => '',
// 'Modification date' => '',
// 'Completion date' => '',
// 'Webhook URL for task creation' => '',
// 'Webhook URL for task modification' => '',
);

4
app/Model/Project.php
View File

@@ -4,7 +4,7 @@ namespace Model;
use SimpleValidator\Validator;
use SimpleValidator\Validators;
use Event\TaskModification;
use Event\ProjectModificationDate;
use Core\Security;
/**
@@ -575,7 +575,7 @@ class Project extends Base
Task::EVENT_OPEN,
);
$listener = new TaskModification($this);
$listener = new ProjectModificationDate($this);
foreach ($events as $event_name) {
$this->event->attach($event_name, $listener);

154
app/Model/Webhook.php Normal file
View File

@@ -0,0 +1,154 @@
<?php
namespace Model;
use Event\WebhookListener;
/**
* Webhook model
*
* @package model
* @author Frederic Guillot
*/
class Webhook extends Base
{
/**
* HTTP connection timeout in seconds
*
* @var integer
*/
const HTTP_TIMEOUT = 1;
/**
* Number of maximum redirections for the HTTP client
*
* @var integer
*/
const HTTP_MAX_REDIRECTS = 3;
/**
* HTTP client user agent
*
* @var string
*/
const HTTP_USER_AGENT = 'Kanboard Webhook';
/**
* URL to call for task creation
*
* @access private
* @var string
*/
private $url_task_creation = '';
/**
* URL to call for task modification
*
* @access private
* @var string
*/
private $url_task_modification = '';
/**
* Webook token
*
* @access private
* @var string
*/
private $token = '';
/**
* Attach events
*
* @access public
*/
public function attachEvents()
{
$config = new Config($this->db, $this->event);
$this->url_task_creation = $config->get('webhooks_url_task_creation');
$this->url_task_modification = $config->get('webhooks_url_task_modification');
$this->token = $config->get('webhooks_token');
if ($this->url_task_creation) {
$this->attachCreateEvents();
}
if ($this->url_task_modification) {
$this->attachUpdateEvents();
}
}
/**
* Attach events for task modification
*
* @access public
*/
public function attachUpdateEvents()
{
$events = array(
Task::EVENT_UPDATE,
Task::EVENT_CLOSE,
Task::EVENT_OPEN,
);
$listener = new WebhookListener($this->url_task_modification, $this);
foreach ($events as $event_name) {
$this->event->attach($event_name, $listener);
}
}
/**
* Attach events for task creation
*
* @access public
*/
public function attachCreateEvents()
{
$events = array(
Task::EVENT_CREATE,
);
$listener = new WebhookListener($this->url_task_creation, $this);
foreach ($events as $event_name) {
$this->event->attach($event_name, $listener);
}
}
/**
* Call the external URL
*
* @access public
* @param string $url URL to call
* @param array $task Task data
*/
public function notify($url, array $task)
{
$headers = array(
'Connection: close',
'User-Agent: '.self::HTTP_USER_AGENT,
);
$context = stream_context_create(array(
'http' => array(
'method' => 'POST',
'protocol_version' => 1.1,
'timeout' => self::HTTP_TIMEOUT,
'max_redirects' => self::HTTP_MAX_REDIRECTS,
'header' => implode("\r\n", $headers),
'content' => json_encode($task)
)
));
if (strpos($url, '?') !== false) {
$url .= '&token='.$this->token;
}
else {
$url .= '?token='.$this->token;
}
@file_get_contents($url, false, $context);
}
}

8
app/Schema/Mysql.php
View File

@@ -4,7 +4,13 @@ namespace Schema;
use Core\Security;
const VERSION = 21;
const VERSION = 22;
function version_22($pdo)
{
$pdo->exec("ALTER TABLE config ADD COLUMN webhooks_url_task_modification VARCHAR(255)");
$pdo->exec("ALTER TABLE config ADD COLUMN webhooks_url_task_creation VARCHAR(255)");
}
function version_21($pdo)
{

8
app/Schema/Postgres.php
View File

@@ -4,7 +4,13 @@ namespace Schema;
use Core\Security;
const VERSION = 2;
const VERSION = 3;
function version_3($pdo)
{
$pdo->exec("ALTER TABLE config ADD COLUMN webhooks_url_task_modification VARCHAR(255)");
$pdo->exec("ALTER TABLE config ADD COLUMN webhooks_url_task_creation VARCHAR(255)");
}
function version_2($pdo)
{

8
app/Schema/Sqlite.php
View File

@@ -4,7 +4,13 @@ namespace Schema;
use Core\Security;
const VERSION = 21;
const VERSION = 22;
function version_22($pdo)
{
$pdo->exec("ALTER TABLE config ADD COLUMN webhooks_url_task_modification TEXT");
$pdo->exec("ALTER TABLE config ADD COLUMN webhooks_url_task_creation TEXT");
}
function version_21($pdo)
{

6
app/Templates/config_index.php
View File

@@ -15,6 +15,12 @@
<?= Helper\form_label(t('Timezone'), 'timezone') ?>
<?= Helper\form_select('timezone', $timezones, $values, $errors) ?><br/>
<?= Helper\form_label(t('Webhook URL for task creation'), 'webhooks_url_task_creation') ?>
<?= Helper\form_text('webhooks_url_task_creation', $values, $errors) ?><br/>
<?= Helper\form_label(t('Webhook URL for task modification'), 'webhooks_url_task_modification') ?>
<?= Helper\form_text('webhooks_url_task_modification', $values, $errors) ?><br/>
<div class="form-actions">
<input type="submit" value="<?= t('Save') ?>" class="btn btn-blue"/>
</div>