Add user filter/condition for notifications

5 files changed, 261 insertions, 99 deletions

diff --git a/app/Model/Base.php b/app/Model/Base.php
index 784545fe..51ae782d 100644
--- a/app/Model/Base.php
+++ b/app/Model/Base.php
@@ -143,4 +143,23 @@ abstract class Base extends \Core\Base
             'url' => $this->helper->url->to('task', 'show', array('task_id' => $task['id'], 'project_id' => $task['project_id'])),
         );
     }
+
+    /**
+     * Group a collection of records by a column
+     *
+     * @access public
+     * @param  array   $collection
+     * @param  string  $column
+     * @return array
+     */
+    public function groupByColumn(array $collection, $column)
+    {
+        $result = array();
+
+        foreach ($collection as $item) {
+            $result[$item[$column]][] = $item;
+        }
+
+        return $result;
+    }
 }
diff --git a/app/Model/Notification.php b/app/Model/Notification.php
index 0c2a5d24..7255a414 100644
--- a/app/Model/Notification.php
+++ b/app/Model/Notification.php
@@ -21,186 +21,326 @@ class Notification extends Base
     const TABLE = 'user_has_notifications';
 
     /**
-     * Get a list of people with notifications enabled
+     * User filters
+     *
+     * @var integer
+     */
+    const FILTER_NONE      = 1;
+    const FILTER_ASSIGNEE  = 2;
+    const FILTER_CREATOR   = 3;
+    const FILTER_BOTH      = 4;
+
+    /**
+     * Send overdue tasks
      *
      * @access public
-     * @param  integer   $project_id      Project id
-     * @param  array     $exclude_users   List of user_id to exclude
-     * @return array
      */
-    public function getUsersWithNotification($project_id, array $exclude_users = array())
+    public function sendOverdueTaskNotifications()
     {
-        if ($this->projectPermission->isEverybodyAllowed($project_id)) {
+        $tasks = $this->taskFinder->getOverdueTasks();
+        $projects = array();
 
-            return $this->db
-                        ->table(User::TABLE)
-                        ->columns(User::TABLE.'.id', User::TABLE.'.username', User::TABLE.'.name', User::TABLE.'.email', User::TABLE.'.language')
-                        ->eq('notifications_enabled', '1')
-                        ->neq('email', '')
-                        ->notin(User::TABLE.'.id', $exclude_users)
-                        ->findAll();
+        foreach ($this->groupByColumn($tasks, 'project_id') as $project_id => $project_tasks) {
+
+            // Get the list of users that should receive notifications for each projects
+            $users = $this->notification->getUsersWithNotificationEnabled($project_id);
+
+            foreach ($users as $user) {
+                $this->sendUserOverdueTaskNotifications($user, $project_tasks);
+            }
         }
 
-        return $this->db
-            ->table(ProjectPermission::TABLE)
-            ->columns(User::TABLE.'.id', User::TABLE.'.username', User::TABLE.'.name', User::TABLE.'.email', User::TABLE.'.language')
-            ->join(User::TABLE, 'id', 'user_id')
-            ->eq('project_id', $project_id)
-            ->eq('notifications_enabled', '1')
-            ->neq('email', '')
-            ->notin(User::TABLE.'.id', $exclude_users)
-            ->findAll();
+        return $tasks;
     }
 
     /**
-     * Get the list of users to send the notification for a given project
+     * Send overdue tasks for a given user
      *
      * @access public
-     * @param  integer   $project_id      Project id
-     * @param  array     $exclude_users   List of user_id to exclude
-     * @return array
+     * @param  array   $user
+     * @param  array   $tasks
      */
-    public function getUsersList($project_id, array $exclude_users = array())
+    public function sendUserOverdueTaskNotifications(array $user, array $tasks)
     {
-        // Exclude the connected user
-        if (Session::isOpen() && $this->userSession->isLogged()) {
-            $exclude_users[] = $this->userSession->getId();
+        $user_tasks = array();
+
+        foreach ($tasks as $task) {
+            if ($this->notification->shouldReceiveNotification($user, array('task' => $task))) {
+                $user_tasks[] = $task;
+            }
         }
 
-        $users = $this->getUsersWithNotification($project_id, $exclude_users);
+        if (! empty($user_tasks)) {
+            $this->sendEmailNotification(
+                $user,
+                Task::EVENT_OVERDUE,
+                array('tasks' => $user_tasks, 'project_name' => $tasks[0]['project_name'])
+            );
+        }
+    }
 
-        foreach ($users as $index => $user) {
+    /**
+     * Send notifications to people
+     *
+     * @access public
+     * @param  string $event_name
+     * @param  array  $event_data
+     */
+    public function sendNotifications($event_name, array $event_data)
+    {
+        $logged_user_id = $this->userSession->isLogged() ? $this->userSession->getId() : 0;
+        $users = $this->notification->getUsersWithNotificationEnabled($event_data['task']['project_id'], $logged_user_id);
 
-            $projects = $this->db->table(self::TABLE)
-                                 ->eq('user_id', $user['id'])
-                                 ->findAllByColumn('project_id');
+        foreach ($users as $user) {
+            if ($this->shouldReceiveNotification($user, $event_data)) {
+                $this->sendEmailNotification($user, $event_name, $event_data);
+            }
+        }
 
-            // The user have selected only some projects
-            if (! empty($projects)) {
+        // Restore locales
+        $this->config->setupTranslations();
+    }
 
-                // If the user didn't select this project we remove that guy from the list
-                if (! in_array($project_id, $projects)) {
-                    unset($users[$index]);
-                }
-            }
+    /**
+     * Send email notification to someone
+     *
+     * @access public
+     * @param  array     $user        User
+     * @param  string    $event_name
+     * @param  array     $event_data
+     */
+    public function sendEmailNotification(array $user, $event_name, array $event_data)
+    {
+        // Use the user language otherwise use the application language (do not use the session language)
+        if (! empty($user['language'])) {
+            Translator::load($user['language']);
+        }
+        else {
+            Translator::load($this->config->get('application_language', 'en_US'));
         }
 
-        return $users;
+        $this->emailClient->send(
+            $user['email'],
+            $user['name'] ?: $user['username'],
+            $this->getMailSubject($event_name, $event_data),
+            $this->getMailContent($event_name, $event_data)
+        );
     }
 
     /**
-     * Send the email notifications
+     * Return true if the user should receive notification
      *
      * @access public
-     * @param  string    $template    Template name
-     * @param  array     $users       List of users
-     * @param  array     $data        Template data
+     * @param  array  $user
+     * @param  array  $event_data
+     * @return boolean
      */
-    public function sendEmails($template, array $users, array $data)
+    public function shouldReceiveNotification(array $user, array $event_data)
     {
-        foreach ($users as $user) {
+        $filters = array(
+            'filterNone',
+            'filterAssignee',
+            'filterCreator',
+            'filterBoth',
+        );
 
-            // Use the user language otherwise use the application language (do not use the session language)
-            if (! empty($user['language'])) {
-                Translator::load($user['language']);
-            }
-            else {
-                Translator::load($this->config->get('application_language', 'en_US'));
+        foreach ($filters as $filter) {
+            if ($this->$filter($user, $event_data)) {
+                return $this->filterProject($user, $event_data);
             }
+        }
 
-            $this->emailClient->send(
-                $user['email'],
-                $user['name'] ?: $user['username'],
-                $this->getMailSubject($template, $data),
-                $this->getMailContent($template, $data)
-            );
+        return false;
+    }
+
+    /**
+     * Return true if the user will receive all notifications
+     *
+     * @access public
+     * @param  array  $user
+     * @param  array  $event_data
+     * @return boolean
+     */
+    public function filterNone(array $user, array $event_data)
+    {
+        return $user['notifications_filter'] == self::FILTER_NONE;
+    }
+
+    /**
+     * Return true if the user is the assignee and selected the filter "assignee"
+     *
+     * @access public
+     * @param  array  $user
+     * @param  array  $event_data
+     * @return boolean
+     */
+    public function filterAssignee(array $user, array $event_data)
+    {
+        return $user['notifications_filter'] == self::FILTER_ASSIGNEE && $event_data['task']['owner_id'] == $user['id'];
+    }
+
+    /**
+     * Return true if the user is the creator and enabled the filter "creator"
+     *
+     * @access public
+     * @param  array  $user
+     * @param  array  $event_data
+     * @return boolean
+     */
+    public function filterCreator(array $user, array $event_data)
+    {
+        return $user['notifications_filter'] == self::FILTER_CREATOR && $event_data['task']['creator_id'] == $user['id'];
+    }
+
+    /**
+     * Return true if the user is the assignee or the creator and selected the filter "both"
+     *
+     * @access public
+     * @param  array  $user
+     * @param  array  $event_data
+     * @return boolean
+     */
+    public function filterBoth(array $user, array $event_data)
+    {
+        return $user['notifications_filter'] == self::FILTER_BOTH &&
+               ($event_data['task']['creator_id'] == $user['id'] || $event_data['task']['owner_id'] == $user['id']);
+    }
+
+    /**
+     * Return true if the user want to receive notification for the selected project
+     *
+     * @access public
+     * @param  array  $user
+     * @param  array  $event_data
+     * @return boolean
+     */
+    public function filterProject(array $user, array $event_data)
+    {
+        $projects = $this->db->table(self::TABLE)->eq('user_id', $user['id'])->findAllByColumn('project_id');
+
+        if (! empty($projects)) {
+            return in_array($event_data['task']['project_id'], $projects);
         }
 
-        // Restore locales
-        $this->config->setupTranslations();
+        return true;
     }
 
     /**
-     * Get the mail subject for a given label
+     * Get a list of people with notifications enabled
      *
-     * @access private
-     * @param  string    $label       Label
-     * @param  array     $data        Template data
+     * @access public
+     * @param  integer   $project_id        Project id
+     * @param  array     $exclude_user_id   User id to exclude
+     * @return array
      */
-    private function getStandardMailSubject($label, array $data)
+    public function getUsersWithNotificationEnabled($project_id, $exclude_user_id = 0)
     {
-        return sprintf('[%s][%s] %s (#%d)', $data['task']['project_name'], $label, $data['task']['title'], $data['task']['id']);
+        if ($this->projectPermission->isEverybodyAllowed($project_id)) {
+
+            return $this->db
+                        ->table(User::TABLE)
+                        ->columns(User::TABLE.'.id', User::TABLE.'.username', User::TABLE.'.name', User::TABLE.'.email', User::TABLE.'.language', User::TABLE.'.notifications_filter')
+                        ->eq('notifications_enabled', '1')
+                        ->neq('email', '')
+                        ->neq(User::TABLE.'.id', $exclude_user_id)
+                        ->findAll();
+        }
+
+        return $this->db
+            ->table(ProjectPermission::TABLE)
+            ->columns(User::TABLE.'.id', User::TABLE.'.username', User::TABLE.'.name', User::TABLE.'.email', User::TABLE.'.language', User::TABLE.'.notifications_filter')
+            ->join(User::TABLE, 'id', 'user_id')
+            ->eq('project_id', $project_id)
+            ->eq('notifications_enabled', '1')
+            ->neq('email', '')
+            ->neq(User::TABLE.'.id', $exclude_user_id)
+            ->findAll();
+    }
+
+    /**
+     * Get the mail content for a given template name
+     *
+     * @access public
+     * @param  string    $event_name  Event name
+     * @param  array     $event_data  Event data
+     * @return string
+     */
+    public function getMailContent($event_name, array $event_data)
+    {
+        return $this->template->render(
+            'notification/'.str_replace('.', '_', $event_name),
+            $event_data + array('application_url' => $this->config->get('application_url'))
+        );
     }
 
     /**
      * Get the mail subject for a given template name
      *
      * @access public
-     * @param  string    $template    Template name
-     * @param  array     $data        Template data
+     * @param  string    $event_name  Event name
+     * @param  array     $event_data  Event data
+     * @return string
      */
     public function getMailSubject($template, array $data)
     {
         switch ($template) {
-            case 'file_creation':
+            case Task::EVENT_CREATE:
                 $subject = $this->getStandardMailSubject(e('New attachment'), $data);
                 break;
-            case 'comment_creation':
+            case Comment::EVENT_CREATE:
                 $subject = $this->getStandardMailSubject(e('New comment'), $data);
                 break;
-            case 'comment_update':
+            case Comment::EVENT_UPDATE:
                 $subject = $this->getStandardMailSubject(e('Comment updated'), $data);
                 break;
-            case 'subtask_creation':
+            case Subtask::EVENT_CREATE:
                 $subject = $this->getStandardMailSubject(e('New subtask'), $data);
                 break;
-            case 'subtask_update':
+            case Subtask::EVENT_UPDATE:
                 $subject = $this->getStandardMailSubject(e('Subtask updated'), $data);
                 break;
-            case 'task_creation':
+            case Task::EVENT_CREATE:
                 $subject = $this->getStandardMailSubject(e('New task'), $data);
                 break;
-            case 'task_update':
+            case Task::EVENT_UPDATE:
                 $subject = $this->getStandardMailSubject(e('Task updated'), $data);
                 break;
-            case 'task_close':
+            case Task::EVENT_CLOSE:
                 $subject = $this->getStandardMailSubject(e('Task closed'), $data);
                 break;
-            case 'task_open':
+            case Task::EVENT_OPEN:
                 $subject = $this->getStandardMailSubject(e('Task opened'), $data);
                 break;
-            case 'task_move_column':
+            case Task::EVENT_MOVE_COLUMN:
                 $subject = $this->getStandardMailSubject(e('Column Change'), $data);
                 break;
-            case 'task_move_position':
+            case Task::EVENT_MOVE_POSITION:
                 $subject = $this->getStandardMailSubject(e('Position Change'), $data);
                 break;
-            case 'task_assignee_change':
+            case Task::EVENT_ASSIGNEE_CHANGE:
                 $subject = $this->getStandardMailSubject(e('Assignee Change'), $data);
                 break;
-            case 'task_due':
-                $subject = e('[%s][Due tasks]', $data['project']);
+            case Task::EVENT_OVERDUE:
+                $subject = e('[%s] Overdue tasks', $data['project_name']);
                 break;
             default:
-                $subject = e('[Kanboard] Notification');
+                $subject = e('Notification');
         }
 
         return $subject;
     }
 
     /**
-     * Get the mail content for a given template name
+     * Get the mail subject for a given label
      *
-     * @access public
-     * @param  string    $template    Template name
+     * @access private
+     * @param  string    $label       Label
      * @param  array     $data        Template data
+     * @return string
      */
-    public function getMailContent($template, array $data)
+    private function getStandardMailSubject($label, array $data)
     {
-        return $this->template->render(
-            'notification/'.$template,
-            $data + array('application_url' => $this->config->get('application_url'))
-        );
+        return sprintf('[%s][%s] %s (#%d)', $data['task']['project_name'], $label, $data['task']['title'], $data['task']['id']);
     }
 
     /**
@@ -219,7 +359,8 @@ class Notification extends Base
 
             // Activate notifications
             $this->db->table(User::TABLE)->eq('id', $user_id)->update(array(
-                'notifications_enabled' => '1'
+                'notifications_enabled' => '1',
+                'notifications_filter'  => empty($values['notifications_filter']) ? self::FILTER_BOTH : $values['notifications_filter'],
             ));
 
             // Save selected projects
@@ -251,9 +392,7 @@ class Notification extends Base
      */
     public function readSettings($user_id)
     {
-        $values = array();
-        $values['notifications_enabled'] = $this->db->table(User::TABLE)->eq('id', $user_id)->findOneColumn('notifications_enabled');
-
+        $values = $this->db->table(User::TABLE)->eq('id', $user_id)->columns('notifications_enabled', 'notifications_filter')->findOne();
         $projects = $this->db->table(self::TABLE)->eq('user_id', $user_id)->findAllByColumn('project_id');
 
         foreach ($projects as $project_id) {
diff --git a/app/Model/SubtaskTimeTracking.php b/app/Model/SubtaskTimeTracking.php
index d4edf660..93a698b6 100644
--- a/app/Model/SubtaskTimeTracking.php
+++ b/app/Model/SubtaskTimeTracking.php
@@ -105,7 +105,8 @@ class SubtaskTimeTracking extends Base
                     ->join(Subtask::TABLE, 'id', 'subtask_id')
                     ->join(Task::TABLE, 'id', 'task_id', Subtask::TABLE)
                     ->join(User::TABLE, 'id', 'user_id', self::TABLE)
-                    ->eq(Task::TABLE.'.project_id', $project_id);
+                    ->eq(Task::TABLE.'.project_id', $project_id)
+                    ->asc(self::TABLE.'.id');
     }
 
     /**
diff --git a/app/Model/Task.php b/app/Model/Task.php
index abd787ad..71d973a4 100644
--- a/app/Model/Task.php
+++ b/app/Model/Task.php
@@ -40,6 +40,7 @@ class Task extends Base
     const EVENT_OPEN            = 'task.open';
     const EVENT_CREATE_UPDATE   = 'task.create_update';
     const EVENT_ASSIGNEE_CHANGE = 'task.assignee_change';
+    const EVENT_OVERDUE         = 'task.overdue';
 
     /**
      * Recurrence: status
diff --git a/app/Model/TaskFinder.php b/app/Model/TaskFinder.php
index 6f53249a..5a1d33c6 100644
--- a/app/Model/TaskFinder.php
+++ b/app/Model/TaskFinder.php
@@ -168,6 +168,8 @@ class TaskFinder extends Base
                         Task::TABLE.'.title',
                         Task::TABLE.'.date_due',
                         Task::TABLE.'.project_id',
+                        Task::TABLE.'.creator_id',
+                        Task::TABLE.'.owner_id',
                         Project::TABLE.'.name AS project_name',
                         User::TABLE.'.username AS assignee_username',
                         User::TABLE.'.name AS assignee_name'