Send notifications on user mentions

This commit is contained in:
Frederic Guillot 2015-12-29 09:30:36 +01:00
parent 9ff0abd8d6
commit ded63d21a8
19 changed files with 323 additions and 74 deletions

View File

@ -71,7 +71,7 @@ class Task extends Base
{
$this->checkProjectPermission($project_id);
if ($owner_id !== 0 && ! $this->projectPermission->isMember($project_id, $owner_id)) {
if ($owner_id !== 0 && ! $this->projectPermission->isAssignable($project_id, $owner_id)) {
return false;
}
@ -117,7 +117,7 @@ class Task extends Base
return false;
}
if ($owner_id !== null && ! $this->projectPermission->isMember($project_id, $owner_id)) {
if ($owner_id !== null && ! $this->projectPermission->isAssignable($project_id, $owner_id)) {
return false;
}

View File

@ -81,7 +81,7 @@ class BitbucketWebhook extends \Kanboard\Core\Base
if (! empty($task)) {
$user = $this->user->getByUsername($payload['actor']['username']);
if (! empty($user) && ! $this->projectPermission->isMember($this->project_id, $user['id'])) {
if (! empty($user) && ! $this->projectPermission->isAssignable($this->project_id, $user['id'])) {
$user = array();
}
@ -213,7 +213,7 @@ class BitbucketWebhook extends \Kanboard\Core\Base
return false;
}
if (! $this->projectPermission->isMember($this->project_id, $user['id'])) {
if (! $this->projectPermission->isAssignable($this->project_id, $user['id'])) {
return false;
}

View File

@ -149,7 +149,7 @@ class GithubWebhook extends \Kanboard\Core\Base
if (! empty($task)) {
$user = $this->user->getByUsername($payload['comment']['user']['login']);
if (! empty($user) && ! $this->projectPermission->isMember($this->project_id, $user['id'])) {
if (! empty($user) && ! $this->projectPermission->isAssignable($this->project_id, $user['id'])) {
$user = array();
}
@ -266,7 +266,7 @@ class GithubWebhook extends \Kanboard\Core\Base
$user = $this->user->getByUsername($issue['assignee']['login']);
$task = $this->taskFinder->getByReference($this->project_id, $issue['number']);
if (! empty($user) && ! empty($task) && $this->projectPermission->isMember($this->project_id, $user['id'])) {
if (! empty($user) && ! empty($task) && $this->projectPermission->isAssignable($this->project_id, $user['id'])) {
$event = array(
'project_id' => $this->project_id,
'task_id' => $task['id'],

View File

@ -273,7 +273,7 @@ class GitlabWebhook extends \Kanboard\Core\Base
if (! empty($task)) {
$user = $this->user->getByUsername($payload['user']['username']);
if (! empty($user) && ! $this->projectPermission->isMember($this->project_id, $user['id'])) {
if (! empty($user) && ! $this->projectPermission->isAssignable($this->project_id, $user['id'])) {
$user = array();
}

View File

@ -427,7 +427,7 @@ class Action extends Base
return $this->board->getColumnIdByTitle($project_id, $column['title']) ?: false;
case 'user_id':
case 'owner_id':
return $this->projectPermission->isMember($project_id, $param['value']) ? $param['value'] : false;
return $this->projectPermission->isAssignable($project_id, $param['value']) ? $param['value'] : false;
default:
return $param['value'];
}

View File

@ -26,8 +26,9 @@ class Comment extends Base
*
* @var string
*/
const EVENT_UPDATE = 'comment.update';
const EVENT_CREATE = 'comment.create';
const EVENT_UPDATE = 'comment.update';
const EVENT_CREATE = 'comment.create';
const EVENT_USER_MENTION = 'comment.user.mention';
/**
* Get all comments for a given task
@ -110,7 +111,9 @@ class Comment extends Base
$comment_id = $this->persist(self::TABLE, $values);
if ($comment_id) {
$this->container['dispatcher']->dispatch(self::EVENT_CREATE, new CommentEvent(array('id' => $comment_id) + $values));
$event = new CommentEvent(array('id' => $comment_id) + $values);
$this->dispatcher->dispatch(self::EVENT_CREATE, $event);
$this->userMention->fireEvents($values['comment'], self::EVENT_USER_MENTION, $event);
}
return $comment_id;

View File

@ -74,6 +74,10 @@ class Notification extends Base
return e('%s commented on the task #%d', $event_author, $event_data['task']['id']);
case File::EVENT_CREATE:
return e('%s attached a file to the task #%d', $event_author, $event_data['task']['id']);
case Task::EVENT_USER_MENTION:
return e('%s mentioned you in the task #%d', $event_author, $event_data['task']['id']);
case Comment::EVENT_USER_MENTION:
return e('%s mentioned you in a comment on the task #%d', $event_author, $event_data['task']['id']);
default:
return e('Notification');
}
@ -91,52 +95,40 @@ class Notification extends Base
{
switch ($event_name) {
case File::EVENT_CREATE:
$title = e('New attachment on task #%d: %s', $event_data['file']['task_id'], $event_data['file']['name']);
break;
return e('New attachment on task #%d: %s', $event_data['file']['task_id'], $event_data['file']['name']);
case Comment::EVENT_CREATE:
$title = e('New comment on task #%d', $event_data['comment']['task_id']);
break;
return e('New comment on task #%d', $event_data['comment']['task_id']);
case Comment::EVENT_UPDATE:
$title = e('Comment updated on task #%d', $event_data['comment']['task_id']);
break;
return e('Comment updated on task #%d', $event_data['comment']['task_id']);
case Subtask::EVENT_CREATE:
$title = e('New subtask on task #%d', $event_data['subtask']['task_id']);
break;
return e('New subtask on task #%d', $event_data['subtask']['task_id']);
case Subtask::EVENT_UPDATE:
$title = e('Subtask updated on task #%d', $event_data['subtask']['task_id']);
break;
return e('Subtask updated on task #%d', $event_data['subtask']['task_id']);
case Task::EVENT_CREATE:
$title = e('New task #%d: %s', $event_data['task']['id'], $event_data['task']['title']);
break;
return e('New task #%d: %s', $event_data['task']['id'], $event_data['task']['title']);
case Task::EVENT_UPDATE:
$title = e('Task updated #%d', $event_data['task']['id']);
break;
return e('Task updated #%d', $event_data['task']['id']);
case Task::EVENT_CLOSE:
$title = e('Task #%d closed', $event_data['task']['id']);
break;
return e('Task #%d closed', $event_data['task']['id']);
case Task::EVENT_OPEN:
$title = e('Task #%d opened', $event_data['task']['id']);
break;
return e('Task #%d opened', $event_data['task']['id']);
case Task::EVENT_MOVE_COLUMN:
$title = e('Column changed for task #%d', $event_data['task']['id']);
break;
return e('Column changed for task #%d', $event_data['task']['id']);
case Task::EVENT_MOVE_POSITION:
$title = e('New position for task #%d', $event_data['task']['id']);
break;
return e('New position for task #%d', $event_data['task']['id']);
case Task::EVENT_MOVE_SWIMLANE:
$title = e('Swimlane changed for task #%d', $event_data['task']['id']);
break;
return e('Swimlane changed for task #%d', $event_data['task']['id']);
case Task::EVENT_ASSIGNEE_CHANGE:
$title = e('Assignee changed on task #%d', $event_data['task']['id']);
break;
return e('Assignee changed on task #%d', $event_data['task']['id']);
case Task::EVENT_OVERDUE:
$nb = count($event_data['tasks']);
$title = $nb > 1 ? e('%d overdue tasks', $nb) : e('Task #%d is overdue', $event_data['tasks'][0]['id']);
break;
return $nb > 1 ? e('%d overdue tasks', $nb) : e('Task #%d is overdue', $event_data['tasks'][0]['id']);
case Task::EVENT_USER_MENTION:
return e('You were mentioned in the task #%d', $event_data['task']['id']);
case Comment::EVENT_USER_MENTION:
return e('You were mentioned in a comment on the task #%d', $event_data['task']['id']);
default:
$title = e('Notification');
return e('Notification');
}
return $title;
}
}

View File

@ -86,11 +86,24 @@ class ProjectPermission extends Base
* @param integer $user_id
* @return boolean
*/
public function isMember($project_id, $user_id)
public function isAssignable($project_id, $user_id)
{
return in_array($this->projectUserRole->getUserRole($project_id, $user_id), array(Role::PROJECT_MEMBER, Role::PROJECT_MANAGER));
}
/**
* Return true if the user is member
*
* @access public
* @param integer $project_id
* @param integer $user_id
* @return boolean
*/
public function isMember($project_id, $user_id)
{
return in_array($this->projectUserRole->getUserRole($project_id, $user_id), array(Role::PROJECT_MEMBER, Role::PROJECT_MANAGER, Role::PROJECT_VIEWER));
}
/**
* Get active project ids by user
*

View File

@ -41,6 +41,7 @@ class Task extends Base
const EVENT_CREATE_UPDATE = 'task.create_update';
const EVENT_ASSIGNEE_CHANGE = 'task.assignee_change';
const EVENT_OVERDUE = 'task.overdue';
const EVENT_USER_MENTION = 'task.user.mention';
/**
* Recurrence: status

View File

@ -86,8 +86,13 @@ class TaskCreation extends Base
*/
private function fireEvents($task_id, array $values)
{
$values['task_id'] = $task_id;
$this->container['dispatcher']->dispatch(Task::EVENT_CREATE_UPDATE, new TaskEvent($values));
$this->container['dispatcher']->dispatch(Task::EVENT_CREATE, new TaskEvent($values));
$event = new TaskEvent(array('task_id' => $task_id) + $values);
$this->dispatcher->dispatch(Task::EVENT_CREATE_UPDATE, $event);
$this->dispatcher->dispatch(Task::EVENT_CREATE, $event);
if (! empty($values['description'])) {
$this->userMention->fireEvents($values['description'], Task::EVENT_USER_MENTION, $event);
}
}
}

61
app/Model/UserMention.php Normal file
View File

@ -0,0 +1,61 @@
<?php
namespace Kanboard\Model;
use Kanboard\Event\GenericEvent;
/**
* User Mention
*
* @package model
* @author Frederic Guillot
*/
class UserMention extends Base
{
/**
* Get list of mentioned users
*
* @access public
* @param string $content
* @return array
*/
public function getMentionedUsers($content)
{
$users = array();
if (preg_match_all('/@([^\s]+)/', $content, $matches)) {
$users = $this->db->table(User::TABLE)
->columns('id', 'username', 'name', 'email', 'language')
->eq('notifications_enabled', 1)
->neq('id', $this->userSession->getId())
->in('username', array_unique($matches[1]))
->findAll();
}
return $users;
}
/**
* Fire events for user mentions
*
* @access public
* @param string $content
* @param string $eventName
* @param GenericEvent $event
*/
public function fireEvents($content, $eventName, GenericEvent $event)
{
if (empty($event['project_id'])) {
$event['project_id'] = $this->taskFinder->getProjectId($event['task_id']);
}
$users = $this->getMentionedUsers($content);
foreach ($users as $user) {
if ($this->projectPermission->isMember($event['project_id'], $user['id'])) {
$event['mention'] = $user;
$this->dispatcher->dispatch($eventName, $event);
}
}
}
}

View File

@ -21,18 +21,12 @@ class UserNotification extends Base
*/
public function sendNotifications($event_name, array $event_data)
{
$logged_user_id = $this->userSession->isLogged() ? $this->userSession->getId() : 0;
$users = $this->getUsersWithNotificationEnabled($event_data['task']['project_id'], $logged_user_id);
$users = $this->getUsersWithNotificationEnabled($event_data['task']['project_id'], $this->userSession->getId());
if (! empty($users)) {
foreach ($users as $user) {
if ($this->userNotificationFilter->shouldReceiveNotification($user, $event_data)) {
$this->sendUserNotification($user, $event_name, $event_data);
}
foreach ($users as $user) {
if ($this->userNotificationFilter->shouldReceiveNotification($user, $event_data)) {
$this->sendUserNotification($user, $event_name, $event_data);
}
// Restore locales
$this->config->setupTranslations();
}
}
@ -58,6 +52,9 @@ class UserNotification extends Base
foreach ($this->userNotificationType->getSelectedTypes($user['id']) as $type) {
$this->userNotificationType->getType($type)->notifyUser($user, $event_name, $event_data);
}
// Restore locales
$this->config->setupTranslations();
}
/**

View File

@ -121,6 +121,10 @@ class Mail extends Base implements NotificationInterface
case Task::EVENT_ASSIGNEE_CHANGE:
$subject = $this->getStandardMailSubject(e('Assignee change'), $event_data);
break;
case Task::EVENT_USER_MENTION:
case Comment::EVENT_USER_MENTION:
$subject = $this->getStandardMailSubject(e('Mentioned'), $event_data);
break;
case Task::EVENT_OVERDUE:
$subject = e('[%s] Overdue tasks', $event_data['project_name']);
break;

View File

@ -67,6 +67,7 @@ class ClassProvider implements ServiceProviderInterface
'User',
'UserImport',
'UserLocking',
'UserMention',
'UserNotification',
'UserNotificationFilter',
'UserUnreadNotification',

View File

@ -2,6 +2,7 @@
namespace Kanboard\Subscriber;
use Kanboard\Core\Base;
use Kanboard\Event\GenericEvent;
use Kanboard\Model\Task;
use Kanboard\Model\Comment;
@ -9,34 +10,40 @@ use Kanboard\Model\Subtask;
use Kanboard\Model\File;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
class NotificationSubscriber extends \Kanboard\Core\Base implements EventSubscriberInterface
class NotificationSubscriber extends Base implements EventSubscriberInterface
{
public static function getSubscribedEvents()
{
return array(
Task::EVENT_CREATE => array('execute', 0),
Task::EVENT_UPDATE => array('execute', 0),
Task::EVENT_CLOSE => array('execute', 0),
Task::EVENT_OPEN => array('execute', 0),
Task::EVENT_MOVE_COLUMN => array('execute', 0),
Task::EVENT_MOVE_POSITION => array('execute', 0),
Task::EVENT_MOVE_SWIMLANE => array('execute', 0),
Task::EVENT_ASSIGNEE_CHANGE => array('execute', 0),
Subtask::EVENT_CREATE => array('execute', 0),
Subtask::EVENT_UPDATE => array('execute', 0),
Comment::EVENT_CREATE => array('execute', 0),
Comment::EVENT_UPDATE => array('execute', 0),
File::EVENT_CREATE => array('execute', 0),
Task::EVENT_USER_MENTION => 'handleEvent',
Task::EVENT_CREATE => 'handleEvent',
Task::EVENT_UPDATE => 'handleEvent',
Task::EVENT_CLOSE => 'handleEvent',
Task::EVENT_OPEN => 'handleEvent',
Task::EVENT_MOVE_COLUMN => 'handleEvent',
Task::EVENT_MOVE_POSITION => 'handleEvent',
Task::EVENT_MOVE_SWIMLANE => 'handleEvent',
Task::EVENT_ASSIGNEE_CHANGE => 'handleEvent',
Subtask::EVENT_CREATE => 'handleEvent',
Subtask::EVENT_UPDATE => 'handleEvent',
Comment::EVENT_CREATE => 'handleEvent',
Comment::EVENT_UPDATE => 'handleEvent',
Comment::EVENT_USER_MENTION => 'handleEvent',
File::EVENT_CREATE => 'handleEvent',
);
}
public function execute(GenericEvent $event, $event_name)
public function handleEvent(GenericEvent $event, $event_name)
{
$event_data = $this->getEventData($event);
if (! empty($event_data)) {
$this->userNotification->sendNotifications($event_name, $event_data);
$this->projectNotification->sendNotifications($event_data['task']['project_id'], $event_name, $event_data);
if (! empty($event['mention'])) {
$this->userNotification->sendUserNotification($event['mention'], $event_name, $event_data);
} else {
$this->userNotification->sendNotifications($event_name, $event_data);
$this->projectNotification->sendNotifications($event_data['task']['project_id'], $event_name, $event_data);
}
}
}

View File

@ -0,0 +1,7 @@
<h2><?= t('You were mentioned in a comment on the task #%d', $task['id']) ?></h2>
<p><?= $this->e($task['title']) ?></p>
<?= $this->text->markdown($comment['comment']) ?>
<?= $this->render('notification/footer', array('task' => $task, 'application_url' => $application_url)) ?>

View File

@ -0,0 +1,7 @@
<h2><?= t('You were mentioned in the task #%d', $task['id']) ?></h2>
<p><?= $this->e($task['title']) ?></p>
<h2><?= t('Description') ?></h2>
<?= $this->text->markdown($task['description']) ?>
<?= $this->render('notification/footer', array('task' => $task, 'application_url' => $application_url)) ?>

View File

@ -128,6 +128,43 @@ class ProjectPermissionTest extends Base
$this->assertFalse($projectPermission->isUserAllowed(2, 5));
}
public function testIsAssignable()
{
$userModel = new User($this->container);
$projectModel = new Project($this->container);
$groupModel = new Group($this->container);
$groupRoleModel = new ProjectGroupRole($this->container);
$groupMemberModel = new GroupMember($this->container);
$userRoleModel = new ProjectUserRole($this->container);
$projectPermission = new ProjectPermission($this->container);
$this->assertEquals(2, $userModel->create(array('username' => 'user 1')));
$this->assertEquals(3, $userModel->create(array('username' => 'user 2')));
$this->assertEquals(4, $userModel->create(array('username' => 'user 3')));
$this->assertEquals(5, $userModel->create(array('username' => 'user 4')));
$this->assertEquals(1, $projectModel->create(array('name' => 'Project 1')));
$this->assertEquals(2, $projectModel->create(array('name' => 'Project 2')));
$this->assertEquals(1, $groupModel->create('Group A'));
$this->assertTrue($groupMemberModel->addUser(1, 2));
$this->assertTrue($groupRoleModel->addGroup(1, 1, Role::PROJECT_VIEWER));
$this->assertTrue($userRoleModel->addUser(1, 3, Role::PROJECT_MEMBER));
$this->assertTrue($userRoleModel->addUser(1, 4, Role::PROJECT_MANAGER));
$this->assertFalse($projectPermission->isAssignable(1, 2));
$this->assertTrue($projectPermission->isAssignable(1, 3));
$this->assertTrue($projectPermission->isAssignable(1, 4));
$this->assertFalse($projectPermission->isAssignable(1, 5));
$this->assertFalse($projectPermission->isAssignable(2, 2));
$this->assertFalse($projectPermission->isAssignable(2, 3));
$this->assertFalse($projectPermission->isAssignable(2, 4));
$this->assertFalse($projectPermission->isAssignable(2, 5));
}
public function testIsMember()
{
$userModel = new User($this->container);
@ -154,7 +191,7 @@ class ProjectPermissionTest extends Base
$this->assertTrue($userRoleModel->addUser(1, 3, Role::PROJECT_MEMBER));
$this->assertTrue($userRoleModel->addUser(1, 4, Role::PROJECT_MANAGER));
$this->assertFalse($projectPermission->isMember(1, 2));
$this->assertTrue($projectPermission->isMember(1, 2));
$this->assertTrue($projectPermission->isMember(1, 3));
$this->assertTrue($projectPermission->isMember(1, 4));
$this->assertFalse($projectPermission->isMember(1, 5));

View File

@ -0,0 +1,114 @@
<?php
require_once __DIR__.'/../Base.php';
use Kanboard\Core\Security\Role;
use Kanboard\Event\GenericEvent;
use Kanboard\Model\User;
use Kanboard\Model\Task;
use Kanboard\Model\TaskCreation;
use Kanboard\Model\Project;
use Kanboard\Model\ProjectUserRole;
use Kanboard\Model\UserMention;
class UserMentionTest extends Base
{
public function testGetMentionedUsersWithNoMentions()
{
$userModel = new User($this->container);
$userMentionModel = new UserMention($this->container);
$this->assertNotFalse($userModel->create(array('username' => 'user1')));
$this->assertEmpty($userMentionModel->getMentionedUsers('test'));
}
public function testGetMentionedUsersWithNotficationDisabled()
{
$userModel = new User($this->container);
$userMentionModel = new UserMention($this->container);
$this->assertNotFalse($userModel->create(array('username' => 'user1')));
$this->assertEmpty($userMentionModel->getMentionedUsers('test @user1'));
}
public function testGetMentionedUsersWithNotficationEnabled()
{
$userModel = new User($this->container);
$userMentionModel = new UserMention($this->container);
$this->assertNotFalse($userModel->create(array('username' => 'user1')));
$this->assertNotFalse($userModel->create(array('username' => 'user2', 'name' => 'Foobar', 'notifications_enabled' => 1)));
$users = $userMentionModel->getMentionedUsers('test @user2');
$this->assertCount(1, $users);
$this->assertEquals('user2', $users[0]['username']);
$this->assertEquals('Foobar', $users[0]['name']);
$this->assertEquals('', $users[0]['email']);
$this->assertEquals('', $users[0]['language']);
}
public function testGetMentionedUsersWithNotficationEnabledAndUserLoggedIn()
{
$this->container['sessionStorage']->user = array('id' => 3);
$userModel = new User($this->container);
$userMentionModel = new UserMention($this->container);
$this->assertNotFalse($userModel->create(array('username' => 'user1')));
$this->assertNotFalse($userModel->create(array('username' => 'user2', 'name' => 'Foobar', 'notifications_enabled' => 1)));
$this->assertEmpty($userMentionModel->getMentionedUsers('test @user2'));
}
public function testFireEventsWithMultipleMentions()
{
$projectUserRoleModel = new ProjectUserRole($this->container);
$projectModel = new Project($this->container);
$userModel = new User($this->container);
$userMentionModel = new UserMention($this->container);
$event = new GenericEvent(array('project_id' => 1));
$this->assertEquals(2, $userModel->create(array('username' => 'user1', 'name' => 'User 1', 'notifications_enabled' => 1)));
$this->assertEquals(3, $userModel->create(array('username' => 'user2', 'name' => 'User 2', 'notifications_enabled' => 1)));
$this->assertEquals(1, $projectModel->create(array('name' => 'P1')));
$this->assertTrue($projectUserRoleModel->addUser(1, 3, Role::PROJECT_MEMBER));
$this->container['dispatcher']->addListener(Task::EVENT_USER_MENTION, array($this, 'onUserMention'));
$userMentionModel->fireEvents('test @user1 @user2', Task::EVENT_USER_MENTION, $event);
$called = $this->container['dispatcher']->getCalledListeners();
$this->assertArrayHasKey(Task::EVENT_USER_MENTION.'.UserMentionTest::onUserMention', $called);
}
public function testFireEventsWithNoProjectId()
{
$projectUserRoleModel = new ProjectUserRole($this->container);
$projectModel = new Project($this->container);
$taskCreationModel = new TaskCreation($this->container);
$userModel = new User($this->container);
$userMentionModel = new UserMention($this->container);
$event = new GenericEvent(array('task_id' => 1));
$this->assertEquals(2, $userModel->create(array('username' => 'user1', 'name' => 'User 1', 'notifications_enabled' => 1)));
$this->assertEquals(3, $userModel->create(array('username' => 'user2', 'name' => 'User 2', 'notifications_enabled' => 1)));
$this->assertEquals(1, $projectModel->create(array('name' => 'P1')));
$this->assertTrue($projectUserRoleModel->addUser(1, 3, Role::PROJECT_MEMBER));
$this->assertEquals(1, $taskCreationModel->create(array('project_id' => 1, 'title' => 'Task 1')));
$this->container['dispatcher']->addListener(Task::EVENT_USER_MENTION, array($this, 'onUserMention'));
$userMentionModel->fireEvents('test @user1 @user2', Task::EVENT_USER_MENTION, $event);
$called = $this->container['dispatcher']->getCalledListeners();
$this->assertArrayHasKey(Task::EVENT_USER_MENTION.'.UserMentionTest::onUserMention', $called);
}
public function onUserMention($event)
{
$this->assertInstanceOf('Kanboard\Event\GenericEvent', $event);
$this->assertEquals(array('id' => '3', 'username' => 'user2', 'name' => 'User 2', 'email' => null, 'language' => null), $event['mention']);
}
}