summaryrefslogtreecommitdiff
path: root/app/Model/UserNotificationModel.php
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2016-05-28 19:48:22 -0400
committerFrederic Guillot <fred@kanboard.net>2016-05-28 19:48:22 -0400
commit14713b0ec7ed93ca45578da069ad4e19a7d8addf (patch)
tree79972d53f6091a1ddb17f64a6a05a5523f5d5168 /app/Model/UserNotificationModel.php
parent936376ffe74c583d3cb819e98f53a85137fdf8bc (diff)
Rename all models
Diffstat (limited to 'app/Model/UserNotificationModel.php')
-rw-r--r--app/Model/UserNotificationModel.php204
1 files changed, 204 insertions, 0 deletions
diff --git a/app/Model/UserNotificationModel.php b/app/Model/UserNotificationModel.php
new file mode 100644
index 00000000..d77526f6
--- /dev/null
+++ b/app/Model/UserNotificationModel.php
@@ -0,0 +1,204 @@
+<?php
+
+namespace Kanboard\Model;
+
+use Kanboard\Core\Base;
+use Kanboard\Core\Translator;
+
+/**
+ * User Notification
+ *
+ * @package Kanboard\Model
+ * @author Frederic Guillot
+ */
+class UserNotificationModel extends Base
+{
+ /**
+ * Send notifications to people
+ *
+ * @access public
+ * @param string $event_name
+ * @param array $event_data
+ */
+ public function sendNotifications($event_name, array $event_data)
+ {
+ $users = $this->getUsersWithNotificationEnabled($event_data['task']['project_id'], $this->userSession->getId());
+
+ foreach ($users as $user) {
+ if ($this->userNotificationFilterModel->shouldReceiveNotification($user, $event_data)) {
+ $this->sendUserNotification($user, $event_name, $event_data);
+ }
+ }
+ }
+
+ /**
+ * Send notification to someone
+ *
+ * @access public
+ * @param array $user User
+ * @param string $event_name
+ * @param array $event_data
+ */
+ public function sendUserNotification(array $user, $event_name, array $event_data)
+ {
+ Translator::unload();
+
+ // 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->configModel->get('application_language', 'en_US'));
+ }
+
+ foreach ($this->userNotificationTypeModel->getSelectedTypes($user['id']) as $type) {
+ $this->userNotificationTypeModel->getType($type)->notifyUser($user, $event_name, $event_data);
+ }
+
+ // Restore locales
+ $this->languageModel->loadCurrentLanguage();
+ }
+
+ /**
+ * Get a list of people with notifications enabled
+ *
+ * @access public
+ * @param integer $project_id Project id
+ * @param integer $exclude_user_id User id to exclude
+ * @return array
+ */
+ public function getUsersWithNotificationEnabled($project_id, $exclude_user_id = 0)
+ {
+ if ($this->projectPermissionModel->isEverybodyAllowed($project_id)) {
+ return $this->getEverybodyWithNotificationEnabled($exclude_user_id);
+ }
+
+ $users = array();
+ $members = $this->getProjectUserMembersWithNotificationEnabled($project_id, $exclude_user_id);
+ $groups = $this->getProjectGroupMembersWithNotificationEnabled($project_id, $exclude_user_id);
+
+ foreach (array_merge($members, $groups) as $user) {
+ if (! isset($users[$user['id']])) {
+ $users[$user['id']] = $user;
+ }
+ }
+
+ return array_values($users);
+ }
+
+ /**
+ * Enable notification for someone
+ *
+ * @access public
+ * @param integer $user_id
+ * @return boolean
+ */
+ public function enableNotification($user_id)
+ {
+ return $this->db->table(UserModel::TABLE)->eq('id', $user_id)->update(array('notifications_enabled' => 1));
+ }
+
+ /**
+ * Disable notification for someone
+ *
+ * @access public
+ * @param integer $user_id
+ * @return boolean
+ */
+ public function disableNotification($user_id)
+ {
+ return $this->db->table(UserModel::TABLE)->eq('id', $user_id)->update(array('notifications_enabled' => 0));
+ }
+
+ /**
+ * Save settings for the given user
+ *
+ * @access public
+ * @param integer $user_id User id
+ * @param array $values Form values
+ */
+ public function saveSettings($user_id, array $values)
+ {
+ $types = empty($values['notification_types']) ? array() : array_keys($values['notification_types']);
+
+ if (! empty($types)) {
+ $this->enableNotification($user_id);
+ } else {
+ $this->disableNotification($user_id);
+ }
+
+ $filter = empty($values['notifications_filter']) ? UserNotificationFilterModel::FILTER_BOTH : $values['notifications_filter'];
+ $project_ids = empty($values['notification_projects']) ? array() : array_keys($values['notification_projects']);
+
+ $this->userNotificationFilterModel->saveFilter($user_id, $filter);
+ $this->userNotificationFilterModel->saveSelectedProjects($user_id, $project_ids);
+ $this->userNotificationTypeModel->saveSelectedTypes($user_id, $types);
+ }
+
+ /**
+ * Read user settings to display the form
+ *
+ * @access public
+ * @param integer $user_id User id
+ * @return array
+ */
+ public function readSettings($user_id)
+ {
+ $values = $this->db->table(UserModel::TABLE)->eq('id', $user_id)->columns('notifications_enabled', 'notifications_filter')->findOne();
+ $values['notification_types'] = $this->userNotificationTypeModel->getSelectedTypes($user_id);
+ $values['notification_projects'] = $this->userNotificationFilterModel->getSelectedProjects($user_id);
+ return $values;
+ }
+
+ /**
+ * Get a list of group members with notification enabled
+ *
+ * @access private
+ * @param integer $project_id Project id
+ * @param integer $exclude_user_id User id to exclude
+ * @return array
+ */
+ private function getProjectUserMembersWithNotificationEnabled($project_id, $exclude_user_id)
+ {
+ return $this->db
+ ->table(ProjectUserRoleModel::TABLE)
+ ->columns(UserModel::TABLE.'.id', UserModel::TABLE.'.username', UserModel::TABLE.'.name', UserModel::TABLE.'.email', UserModel::TABLE.'.language', UserModel::TABLE.'.notifications_filter')
+ ->join(UserModel::TABLE, 'id', 'user_id')
+ ->eq(ProjectUserRoleModel::TABLE.'.project_id', $project_id)
+ ->eq(UserModel::TABLE.'.notifications_enabled', '1')
+ ->eq(UserModel::TABLE.'.is_active', 1)
+ ->neq(UserModel::TABLE.'.id', $exclude_user_id)
+ ->findAll();
+ }
+
+ private function getProjectGroupMembersWithNotificationEnabled($project_id, $exclude_user_id)
+ {
+ return $this->db
+ ->table(ProjectGroupRoleModel::TABLE)
+ ->columns(UserModel::TABLE.'.id', UserModel::TABLE.'.username', UserModel::TABLE.'.name', UserModel::TABLE.'.email', UserModel::TABLE.'.language', UserModel::TABLE.'.notifications_filter')
+ ->join(GroupMemberModel::TABLE, 'group_id', 'group_id', ProjectGroupRoleModel::TABLE)
+ ->join(UserModel::TABLE, 'id', 'user_id', GroupMemberModel::TABLE)
+ ->eq(ProjectGroupRoleModel::TABLE.'.project_id', $project_id)
+ ->eq(UserModel::TABLE.'.notifications_enabled', '1')
+ ->neq(UserModel::TABLE.'.id', $exclude_user_id)
+ ->eq(UserModel::TABLE.'.is_active', 1)
+ ->findAll();
+ }
+
+ /**
+ * Get a list of project members with notification enabled
+ *
+ * @access private
+ * @param integer $exclude_user_id User id to exclude
+ * @return array
+ */
+ private function getEverybodyWithNotificationEnabled($exclude_user_id)
+ {
+ return $this->db
+ ->table(UserModel::TABLE)
+ ->columns(UserModel::TABLE.'.id', UserModel::TABLE.'.username', UserModel::TABLE.'.name', UserModel::TABLE.'.email', UserModel::TABLE.'.language', UserModel::TABLE.'.notifications_filter')
+ ->eq('notifications_enabled', '1')
+ ->neq(UserModel::TABLE.'.id', $exclude_user_id)
+ ->eq(UserModel::TABLE.'.is_active', 1)
+ ->findAll();
+ }
+}