mirror of
https://github.com/phpbb/phpbb.git
synced 2025-10-26 05:06:12 +01:00
950 lines
32 KiB
PHP
950 lines
32 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
* This file is part of the phpBB Forum Software package.
|
|
*
|
|
* @copyright (c) phpBB Limited <https://www.phpbb.com>
|
|
* @license GNU General Public License, version 2 (GPL-2.0)
|
|
*
|
|
* For full copyright and license information, please see
|
|
* the docs/CREDITS.txt file.
|
|
*
|
|
*/
|
|
|
|
namespace phpbb\notification;
|
|
|
|
use Symfony\Component\DependencyInjection\ContainerInterface;
|
|
|
|
/**
|
|
* Notifications service class
|
|
*/
|
|
class manager
|
|
{
|
|
/** @var array */
|
|
protected $notification_types;
|
|
|
|
/** @var array */
|
|
protected $notification_methods;
|
|
|
|
/** @var ContainerInterface */
|
|
protected $phpbb_container;
|
|
|
|
/** @var \phpbb\user_loader */
|
|
protected $user_loader;
|
|
|
|
/** @var \phpbb\config\config */
|
|
protected $config;
|
|
|
|
/** @var \phpbb\db\driver\driver_interface */
|
|
protected $db;
|
|
|
|
/** @var \phpbb\cache\service */
|
|
protected $cache;
|
|
|
|
/** @var \phpbb\user */
|
|
protected $user;
|
|
|
|
/** @var string */
|
|
protected $phpbb_root_path;
|
|
|
|
/** @var string */
|
|
protected $php_ext;
|
|
|
|
/** @var string */
|
|
protected $notification_types_table;
|
|
|
|
/** @var string */
|
|
protected $notifications_table;
|
|
|
|
/** @var string */
|
|
protected $user_notifications_table;
|
|
|
|
/**
|
|
* Notification Constructor
|
|
*
|
|
* @param array $notification_types
|
|
* @param array $notification_methods
|
|
* @param ContainerInterface $phpbb_container
|
|
* @param \phpbb\user_loader $user_loader
|
|
* @param \phpbb\config\config $config
|
|
* @param \phpbb\db\driver\driver_interface $db
|
|
* @param \phpbb\cache\service $cache
|
|
* @param \phpbb\user $user
|
|
* @param string $phpbb_root_path
|
|
* @param string $php_ext
|
|
* @param string $notification_types_table
|
|
* @param string $notifications_table
|
|
* @param string $user_notifications_table
|
|
*
|
|
* @return \phpbb\notification\manager
|
|
*/
|
|
public function __construct($notification_types, $notification_methods, ContainerInterface $phpbb_container, \phpbb\user_loader $user_loader, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, $user, $phpbb_root_path, $php_ext, $notification_types_table, $notifications_table, $user_notifications_table)
|
|
{
|
|
$this->notification_types = $notification_types;
|
|
$this->notification_methods = $notification_methods;
|
|
$this->phpbb_container = $phpbb_container;
|
|
|
|
$this->user_loader = $user_loader;
|
|
$this->config = $config;
|
|
$this->db = $db;
|
|
$this->cache = $cache;
|
|
$this->user = $user;
|
|
|
|
$this->phpbb_root_path = $phpbb_root_path;
|
|
$this->php_ext = $php_ext;
|
|
|
|
$this->notification_types_table = $notification_types_table;
|
|
$this->notifications_table = $notifications_table;
|
|
$this->user_notifications_table = $user_notifications_table;
|
|
}
|
|
|
|
/**
|
|
* Load the user's notifications
|
|
*
|
|
* @param array $options Optional options to control what notifications are loaded
|
|
* notification_id Notification id to load (or array of notification ids)
|
|
* user_id User id to load notifications for (Default: $user->data['user_id'])
|
|
* order_by Order by (Default: notification_time)
|
|
* order_dir Order direction (Default: DESC)
|
|
* limit Number of notifications to load (Default: 5)
|
|
* start Notifications offset (Default: 0)
|
|
* all_unread Load all unread notifications? If set to true, count_unread is set to true (Default: false)
|
|
* count_unread Count all unread notifications? (Default: false)
|
|
* count_total Count all notifications? (Default: false)
|
|
* @return array Array of information based on the request with keys:
|
|
* 'notifications' array of notification type objects
|
|
* 'unread_count' number of unread notifications the user has if count_unread is true in the options
|
|
* 'total_count' number of notifications the user has if count_total is true in the options
|
|
*/
|
|
public function load_notifications(array $options = array())
|
|
{
|
|
// Merge default options
|
|
$options = array_merge(array(
|
|
'notification_id' => false,
|
|
'user_id' => $this->user->data['user_id'],
|
|
'order_by' => 'notification_time',
|
|
'order_dir' => 'DESC',
|
|
'limit' => 0,
|
|
'start' => 0,
|
|
'all_unread' => false,
|
|
'count_unread' => false,
|
|
'count_total' => false,
|
|
), $options);
|
|
|
|
// If all_unread, count_unread must be true
|
|
$options['count_unread'] = ($options['all_unread']) ? true : $options['count_unread'];
|
|
|
|
// Anonymous users and bots never receive notifications
|
|
if ($options['user_id'] == $this->user->data['user_id'] && ($this->user->data['user_id'] == ANONYMOUS || $this->user->data['user_type'] == USER_IGNORE))
|
|
{
|
|
return array(
|
|
'notifications' => array(),
|
|
'unread_count' => 0,
|
|
'total_count' => 0,
|
|
);
|
|
}
|
|
|
|
$notifications = $user_ids = array();
|
|
$load_special = array();
|
|
$total_count = $unread_count = 0;
|
|
|
|
if ($options['count_unread'])
|
|
{
|
|
// Get the total number of unread notifications
|
|
$sql = 'SELECT COUNT(n.notification_id) AS unread_count
|
|
FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt
|
|
WHERE n.user_id = ' . (int) $options['user_id'] . '
|
|
AND n.notification_read = 0
|
|
AND nt.notification_type_id = n.notification_type_id
|
|
AND nt.notification_type_enabled = 1';
|
|
$result = $this->db->sql_query($sql);
|
|
$unread_count = (int) $this->db->sql_fetchfield('unread_count');
|
|
$this->db->sql_freeresult($result);
|
|
}
|
|
|
|
if ($options['count_total'])
|
|
{
|
|
// Get the total number of notifications
|
|
$sql = 'SELECT COUNT(n.notification_id) AS total_count
|
|
FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt
|
|
WHERE n.user_id = ' . (int) $options['user_id'] . '
|
|
AND nt.notification_type_id = n.notification_type_id
|
|
AND nt.notification_type_enabled = 1';
|
|
$result = $this->db->sql_query($sql);
|
|
$total_count = (int) $this->db->sql_fetchfield('total_count');
|
|
$this->db->sql_freeresult($result);
|
|
}
|
|
|
|
if (!$options['count_total'] || $total_count)
|
|
{
|
|
$rowset = array();
|
|
|
|
// Get the main notifications
|
|
$sql = 'SELECT n.*, nt.notification_type_name
|
|
FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt
|
|
WHERE n.user_id = ' . (int) $options['user_id'] .
|
|
(($options['notification_id']) ? ((is_array($options['notification_id'])) ? ' AND ' . $this->db->sql_in_set('n.notification_id', $options['notification_id']) : ' AND n.notification_id = ' . (int) $options['notification_id']) : '') . '
|
|
AND nt.notification_type_id = n.notification_type_id
|
|
AND nt.notification_type_enabled = 1
|
|
ORDER BY n.' . $this->db->sql_escape($options['order_by']) . ' ' . $this->db->sql_escape($options['order_dir']);
|
|
$result = $this->db->sql_query_limit($sql, $options['limit'], $options['start']);
|
|
|
|
while ($row = $this->db->sql_fetchrow($result))
|
|
{
|
|
$rowset[$row['notification_id']] = $row;
|
|
}
|
|
$this->db->sql_freeresult($result);
|
|
|
|
// Get all unread notifications
|
|
if ($unread_count && $options['all_unread'] && !empty($rowset))
|
|
{
|
|
$sql = 'SELECT n.*, nt.notification_type_name
|
|
FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt
|
|
WHERE n.user_id = ' . (int) $options['user_id'] . '
|
|
AND n.notification_read = 0
|
|
AND ' . $this->db->sql_in_set('n.notification_id', array_keys($rowset), true) . '
|
|
AND nt.notification_type_id = n.notification_type_id
|
|
AND nt.notification_type_enabled = 1
|
|
ORDER BY n.' . $this->db->sql_escape($options['order_by']) . ' ' . $this->db->sql_escape($options['order_dir']);
|
|
$result = $this->db->sql_query_limit($sql, $options['limit'], $options['start']);
|
|
|
|
while ($row = $this->db->sql_fetchrow($result))
|
|
{
|
|
$rowset[$row['notification_id']] = $row;
|
|
}
|
|
$this->db->sql_freeresult($result);
|
|
}
|
|
|
|
foreach ($rowset as $row)
|
|
{
|
|
$notification = $this->get_item_type_class($row['notification_type_name'], $row);
|
|
|
|
// Array of user_ids to query all at once
|
|
$user_ids = array_merge($user_ids, $notification->users_to_query());
|
|
|
|
// Some notification types also require querying additional tables themselves
|
|
if (!isset($load_special[$row['notification_type_name']]))
|
|
{
|
|
$load_special[$row['notification_type_name']] = array();
|
|
}
|
|
$load_special[$row['notification_type_name']] = array_merge($load_special[$row['notification_type_name']], $notification->get_load_special());
|
|
|
|
$notifications[$row['notification_id']] = $notification;
|
|
}
|
|
|
|
$this->user_loader->load_users($user_ids);
|
|
|
|
// Allow each type to load its own special items
|
|
foreach ($load_special as $item_type => $data)
|
|
{
|
|
$item_class = $this->get_item_type_class($item_type);
|
|
|
|
$item_class->load_special($data, $notifications);
|
|
}
|
|
}
|
|
|
|
return array(
|
|
'notifications' => $notifications,
|
|
'unread_count' => $unread_count,
|
|
'total_count' => $total_count,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Mark notifications read
|
|
*
|
|
* @param bool|string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types). False to mark read for all item types
|
|
* @param bool|int|array $item_id Item id or array of item ids. False to mark read for all item ids
|
|
* @param bool|int|array $user_id User id or array of user ids. False to mark read for all user ids
|
|
* @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)
|
|
*/
|
|
public function mark_notifications_read($notification_type_name, $item_id, $user_id, $time = false)
|
|
{
|
|
$time = ($time !== false) ? $time : time();
|
|
|
|
$sql = 'UPDATE ' . $this->notifications_table . "
|
|
SET notification_read = 1
|
|
WHERE notification_time <= " . (int) $time .
|
|
(($notification_type_name !== false) ? ' AND ' .
|
|
(is_array($notification_type_name) ? $this->db->sql_in_set('notification_type_id', $this->get_notification_type_ids($notification_type_name)) : 'notification_type_id = ' . $this->get_notification_type_id($notification_type_name)) : '') .
|
|
(($user_id !== false) ? ' AND ' . (is_array($user_id) ? $this->db->sql_in_set('user_id', $user_id) : 'user_id = ' . (int) $user_id) : '') .
|
|
(($item_id !== false) ? ' AND ' . (is_array($item_id) ? $this->db->sql_in_set('item_id', $item_id) : 'item_id = ' . (int) $item_id) : '');
|
|
$this->db->sql_query($sql);
|
|
}
|
|
|
|
/**
|
|
* Mark notifications read from a parent identifier
|
|
*
|
|
* @param string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types)
|
|
* @param bool|int|array $item_parent_id Item parent id or array of item parent ids. False to mark read for all item parent ids
|
|
* @param bool|int|array $user_id User id or array of user ids. False to mark read for all user ids
|
|
* @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)
|
|
*/
|
|
public function mark_notifications_read_by_parent($notification_type_name, $item_parent_id, $user_id, $time = false)
|
|
{
|
|
$time = ($time !== false) ? $time : time();
|
|
|
|
$sql = 'UPDATE ' . $this->notifications_table . "
|
|
SET notification_read = 1
|
|
WHERE notification_time <= " . (int) $time .
|
|
(($notification_type_name !== false) ? ' AND ' .
|
|
(is_array($notification_type_name) ? $this->db->sql_in_set('notification_type_id', $this->get_notification_type_ids($notification_type_name)) : 'notification_type_id = ' . $this->get_notification_type_id($notification_type_name)) : '') .
|
|
(($item_parent_id !== false) ? ' AND ' . (is_array($item_parent_id) ? $this->db->sql_in_set('item_parent_id', $item_parent_id) : 'item_parent_id = ' . (int) $item_parent_id) : '') .
|
|
(($user_id !== false) ? ' AND ' . (is_array($user_id) ? $this->db->sql_in_set('user_id', $user_id) : 'user_id = ' . (int) $user_id) : '');
|
|
$this->db->sql_query($sql);
|
|
}
|
|
|
|
/**
|
|
* Mark notifications read
|
|
*
|
|
* @param int|array $notification_id Notification id or array of notification ids.
|
|
* @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)
|
|
*/
|
|
public function mark_notifications_read_by_id($notification_id, $time = false)
|
|
{
|
|
$time = ($time !== false) ? $time : time();
|
|
|
|
$sql = 'UPDATE ' . $this->notifications_table . "
|
|
SET notification_read = 1
|
|
WHERE notification_time <= " . (int) $time . '
|
|
AND ' . ((is_array($notification_id)) ? $this->db->sql_in_set('notification_id', $notification_id) : 'notification_id = ' . (int) $notification_id);
|
|
$this->db->sql_query($sql);
|
|
}
|
|
|
|
/**
|
|
* Add a notification
|
|
*
|
|
* @param string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types)
|
|
* Note: If you send an array of types, any user who could receive multiple notifications from this single item will only receive
|
|
* a single notification. If they MUST receive multiple notifications, call this function multiple times instead of sending an array
|
|
* @param array $data Data specific for this type that will be inserted
|
|
* @param array $options Optional options to control what notifications are loaded
|
|
* ignore_users array of data to specify which users should not receive certain types of notifications
|
|
* @return array Information about what users were notified and how they were notified
|
|
*/
|
|
public function add_notifications($notification_type_name, $data, array $options = array())
|
|
{
|
|
$options = array_merge(array(
|
|
'ignore_users' => array(),
|
|
), $options);
|
|
|
|
if (is_array($notification_type_name))
|
|
{
|
|
$notified_users = array();
|
|
$temp_options = $options;
|
|
|
|
foreach ($notification_type_name as $type)
|
|
{
|
|
$temp_options['ignore_users'] = $options['ignore_users'] + $notified_users;
|
|
$notified_users += $this->add_notifications($type, $data, $temp_options);
|
|
}
|
|
|
|
return $notified_users;
|
|
}
|
|
|
|
$item_id = $this->get_item_type_class($notification_type_name)->get_item_id($data);
|
|
|
|
// find out which users want to receive this type of notification
|
|
$notify_users = $this->get_item_type_class($notification_type_name)->find_users_for_notification($data, $options);
|
|
|
|
$this->add_notifications_for_users($notification_type_name, $data, $notify_users);
|
|
|
|
return $notify_users;
|
|
}
|
|
|
|
/**
|
|
* Add a notification for specific users
|
|
*
|
|
* @param string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types)
|
|
* @param array $data Data specific for this type that will be inserted
|
|
* @param array $notify_users User list to notify
|
|
*/
|
|
public function add_notifications_for_users($notification_type_name, $data, $notify_users)
|
|
{
|
|
if (is_array($notification_type_name))
|
|
{
|
|
foreach ($notification_type_name as $type)
|
|
{
|
|
$this->add_notifications_for_users($type, $data, $notify_users);
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
$notification_type_id = $this->get_notification_type_id($notification_type_name);
|
|
|
|
$item_id = $this->get_item_type_class($notification_type_name)->get_item_id($data);
|
|
|
|
$user_ids = array();
|
|
$notification_objects = $notification_methods = array();
|
|
|
|
// Never send notifications to the anonymous user!
|
|
unset($notify_users[ANONYMOUS]);
|
|
|
|
// Make sure not to send new notifications to users who've already been notified about this item
|
|
// This may happen when an item was added, but now new users are able to see the item
|
|
$sql = 'SELECT n.user_id
|
|
FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt
|
|
WHERE n.notification_type_id = ' . (int) $notification_type_id . '
|
|
AND n.item_id = ' . (int) $item_id . '
|
|
AND nt.notification_type_id = n.notification_type_id
|
|
AND nt.notification_type_enabled = 1';
|
|
$result = $this->db->sql_query($sql);
|
|
while ($row = $this->db->sql_fetchrow($result))
|
|
{
|
|
unset($notify_users[$row['user_id']]);
|
|
}
|
|
$this->db->sql_freeresult($result);
|
|
|
|
if (!sizeof($notify_users))
|
|
{
|
|
return;
|
|
}
|
|
|
|
// Allow notifications to perform actions before creating the insert array (such as run a query to cache some data needed for all notifications)
|
|
$notification = $this->get_item_type_class($notification_type_name);
|
|
$pre_create_data = $notification->pre_create_insert_array($data, $notify_users);
|
|
unset($notification);
|
|
|
|
$insert_buffer = new \phpbb\db\sql_insert_buffer($this->db, $this->notifications_table);
|
|
|
|
// Go through each user so we can insert a row in the DB and then notify them by their desired means
|
|
foreach ($notify_users as $user => $methods)
|
|
{
|
|
$notification = $this->get_item_type_class($notification_type_name);
|
|
|
|
$notification->user_id = (int) $user;
|
|
|
|
// Insert notification row using buffer.
|
|
$insert_buffer->insert($notification->create_insert_array($data, $pre_create_data));
|
|
|
|
// Users are needed to send notifications
|
|
$user_ids = array_merge($user_ids, $notification->users_to_query());
|
|
|
|
foreach ($methods as $method)
|
|
{
|
|
// setup the notification methods and add the notification to the queue
|
|
if ($method) // blank means we just insert it as a notification, but do not notify them by any other means
|
|
{
|
|
if (!isset($notification_methods[$method]))
|
|
{
|
|
$notification_methods[$method] = $this->get_method_class($method);
|
|
}
|
|
|
|
$notification_methods[$method]->add_to_queue($notification);
|
|
}
|
|
}
|
|
}
|
|
|
|
$insert_buffer->flush();
|
|
|
|
// We need to load all of the users to send notifications
|
|
$this->user_loader->load_users($user_ids);
|
|
|
|
// run the queue for each method to send notifications
|
|
foreach ($notification_methods as $method)
|
|
{
|
|
$method->notify();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Update a notification
|
|
*
|
|
* @param string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types)
|
|
* @param array $data Data specific for this type that will be updated
|
|
*/
|
|
public function update_notifications($notification_type_name, $data)
|
|
{
|
|
if (is_array($notification_type_name))
|
|
{
|
|
foreach ($notification_type_name as $type)
|
|
{
|
|
$this->update_notifications($type, $data);
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
$notification = $this->get_item_type_class($notification_type_name);
|
|
|
|
// Allow the notifications class to over-ride the update_notifications functionality
|
|
if (method_exists($notification, 'update_notifications'))
|
|
{
|
|
// Return False to over-ride the rest of the update
|
|
if ($notification->update_notifications($data) === false)
|
|
{
|
|
return;
|
|
}
|
|
}
|
|
|
|
$notification_type_id = $this->get_notification_type_id($notification_type_name);
|
|
$item_id = $notification->get_item_id($data);
|
|
$update_array = $notification->create_update_array($data);
|
|
|
|
$sql = 'UPDATE ' . $this->notifications_table . '
|
|
SET ' . $this->db->sql_build_array('UPDATE', $update_array) . '
|
|
WHERE notification_type_id = ' . (int) $notification_type_id . '
|
|
AND item_id = ' . (int) $item_id;
|
|
$this->db->sql_query($sql);
|
|
}
|
|
|
|
/**
|
|
* Delete a notification
|
|
*
|
|
* @param string|array $notification_type_name Type identifier or array of item types (only acceptable if the $item_id is identical for the specified types)
|
|
* @param int|array $item_id Identifier within the type (or array of ids)
|
|
* @param mixed $parent_id Parent identifier within the type (or array of ids), used in combination with item_id if specified (Default: false; not checked)
|
|
*/
|
|
public function delete_notifications($notification_type_name, $item_id, $parent_id = false)
|
|
{
|
|
if (is_array($notification_type_name))
|
|
{
|
|
foreach ($notification_type_name as $type)
|
|
{
|
|
$this->delete_notifications($type, $item_id, $parent_id);
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
$notification_type_id = $this->get_notification_type_id($notification_type_name);
|
|
|
|
$sql = 'DELETE FROM ' . $this->notifications_table . '
|
|
WHERE notification_type_id = ' . (int) $notification_type_id . '
|
|
AND ' . (is_array($item_id) ? $this->db->sql_in_set('item_id', $item_id) : 'item_id = ' . (int) $item_id) .
|
|
(($parent_id !== false) ? ' AND ' . ((is_array($parent_id) ? $this->db->sql_in_set('item_parent_id', $parent_id) : 'item_parent_id = ' . (int) $parent_id)) : '');
|
|
$this->db->sql_query($sql);
|
|
}
|
|
|
|
/**
|
|
* Get all of the subscription types
|
|
*
|
|
* @return array Array of item types
|
|
*/
|
|
public function get_subscription_types()
|
|
{
|
|
$subscription_types = array();
|
|
|
|
foreach ($this->notification_types as $type_name => $data)
|
|
{
|
|
$type = $this->get_item_type_class($type_name);
|
|
|
|
if ($type instanceof \phpbb\notification\type\type_interface && $type->is_available())
|
|
{
|
|
$options = array_merge(array(
|
|
'id' => $type->get_type(),
|
|
'lang' => 'NOTIFICATION_TYPE_' . strtoupper($type->get_type()),
|
|
'group' => 'NOTIFICATION_GROUP_MISCELLANEOUS',
|
|
), (($type::$notification_option !== false) ? $type::$notification_option : array()));
|
|
|
|
$subscription_types[$options['group']][$options['id']] = $options;
|
|
}
|
|
}
|
|
|
|
// Move Miscellaneous to the very last section
|
|
if (isset($subscription_types['NOTIFICATION_GROUP_MISCELLANEOUS']))
|
|
{
|
|
$miscellaneous = $subscription_types['NOTIFICATION_GROUP_MISCELLANEOUS'];
|
|
unset($subscription_types['NOTIFICATION_GROUP_MISCELLANEOUS']);
|
|
$subscription_types['NOTIFICATION_GROUP_MISCELLANEOUS'] = $miscellaneous;
|
|
}
|
|
|
|
return $subscription_types;
|
|
}
|
|
|
|
/**
|
|
* Get all of the subscription methods
|
|
*
|
|
* @return array Array of methods
|
|
*/
|
|
public function get_subscription_methods()
|
|
{
|
|
$subscription_methods = array();
|
|
|
|
foreach ($this->notification_methods as $method_name => $data)
|
|
{
|
|
$method = $this->get_method_class($method_name);
|
|
|
|
if ($method instanceof \phpbb\notification\method\method_interface && $method->is_available())
|
|
{
|
|
$subscription_methods[$method_name] = array(
|
|
'id' => $method->get_type(),
|
|
'lang' => str_replace('.', '_', strtoupper($method->get_type())),
|
|
);
|
|
}
|
|
}
|
|
|
|
return $subscription_methods;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get user's notification data
|
|
*
|
|
* @param int $user_id The user_id of the user to get the notifications for
|
|
*
|
|
* @return array User's notification
|
|
*/
|
|
protected function get_user_notifications($user_id)
|
|
{
|
|
$sql = 'SELECT method, notify, item_type
|
|
FROM ' . $this->user_notifications_table . '
|
|
WHERE user_id = ' . (int) $user_id . '
|
|
AND item_id = 0';
|
|
|
|
$result = $this->db->sql_query($sql);
|
|
$user_notifications = array();
|
|
|
|
while ($row = $this->db->sql_fetchrow($result))
|
|
{
|
|
$user_notifications[$row['item_type']][] = $row;
|
|
}
|
|
|
|
$this->db->sql_freeresult($result);
|
|
|
|
return $user_notifications;
|
|
}
|
|
|
|
/**
|
|
* Get global subscriptions (item_id = 0)
|
|
*
|
|
* @param bool|int $user_id The user_id to add the subscription for (bool false for current user)
|
|
*
|
|
* @return array Subscriptions
|
|
*/
|
|
public function get_global_subscriptions($user_id = false)
|
|
{
|
|
$user_id = ($user_id === false) ? $this->user->data['user_id'] : $user_id;
|
|
|
|
$subscriptions = array();
|
|
|
|
$user_notifications = $this->get_user_notifications($user_id);
|
|
|
|
foreach ($this->get_subscription_types() as $types)
|
|
{
|
|
foreach ($types as $id => $type)
|
|
{
|
|
|
|
if (empty($user_notifications[$id]))
|
|
{
|
|
// No rows at all, default to ''
|
|
$subscriptions[$id] = array('');
|
|
}
|
|
else
|
|
{
|
|
foreach ($user_notifications[$id] as $user_notification)
|
|
{
|
|
if (!$user_notification['notify'])
|
|
{
|
|
continue;
|
|
}
|
|
|
|
if (!isset($subscriptions[$id]))
|
|
{
|
|
$subscriptions[$id] = array();
|
|
}
|
|
|
|
$subscriptions[$id][] = $user_notification['method'];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return $subscriptions;
|
|
}
|
|
|
|
/**
|
|
* Add a subscription
|
|
*
|
|
* @param string $item_type Type identifier of the subscription
|
|
* @param int $item_id The id of the item
|
|
* @param string $method The method of the notification e.g. '', 'email', or 'jabber'
|
|
* @param bool|int $user_id The user_id to add the subscription for (bool false for current user)
|
|
*/
|
|
public function add_subscription($item_type, $item_id = 0, $method = '', $user_id = false)
|
|
{
|
|
if ($method !== '')
|
|
{
|
|
// Make sure to subscribe them to the base subscription
|
|
$this->add_subscription($item_type, $item_id, '', $user_id);
|
|
}
|
|
|
|
$user_id = ($user_id === false) ? $this->user->data['user_id'] : $user_id;
|
|
|
|
$sql = 'SELECT notify
|
|
FROM ' . $this->user_notifications_table . "
|
|
WHERE item_type = '" . $this->db->sql_escape($item_type) . "'
|
|
AND item_id = " . (int) $item_id . '
|
|
AND user_id = ' .(int) $user_id . "
|
|
AND method = '" . $this->db->sql_escape($method) . "'";
|
|
$this->db->sql_query($sql);
|
|
$current = $this->db->sql_fetchfield('notify');
|
|
$this->db->sql_freeresult();
|
|
|
|
if ($current === false)
|
|
{
|
|
$sql = 'INSERT INTO ' . $this->user_notifications_table . ' ' .
|
|
$this->db->sql_build_array('INSERT', array(
|
|
'item_type' => $item_type,
|
|
'item_id' => (int) $item_id,
|
|
'user_id' => (int) $user_id,
|
|
'method' => $method,
|
|
'notify' => 1,
|
|
));
|
|
$this->db->sql_query($sql);
|
|
}
|
|
else if (!$current)
|
|
{
|
|
$sql = 'UPDATE ' . $this->user_notifications_table . "
|
|
SET notify = 1
|
|
WHERE item_type = '" . $this->db->sql_escape($item_type) . "'
|
|
AND item_id = " . (int) $item_id . '
|
|
AND user_id = ' .(int) $user_id . "
|
|
AND method = '" . $this->db->sql_escape($method) . "'";
|
|
$this->db->sql_query($sql);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete a subscription
|
|
*
|
|
* @param string $item_type Type identifier of the subscription
|
|
* @param int $item_id The id of the item
|
|
* @param string $method The method of the notification e.g. '', 'email', or 'jabber'
|
|
* @param bool|int $user_id The user_id to add the subscription for (bool false for current user)
|
|
*/
|
|
public function delete_subscription($item_type, $item_id = 0, $method = '', $user_id = false)
|
|
{
|
|
$user_id = ($user_id === false) ? $this->user->data['user_id'] : $user_id;
|
|
|
|
// If no method, make sure that no other notification methods for this item are selected before deleting
|
|
if ($method === '')
|
|
{
|
|
$sql = 'SELECT COUNT(*) as num_notifications
|
|
FROM ' . $this->user_notifications_table . "
|
|
WHERE item_type = '" . $this->db->sql_escape($item_type) . "'
|
|
AND item_id = " . (int) $item_id . '
|
|
AND user_id = ' .(int) $user_id . "
|
|
AND method <> ''
|
|
AND notify = 1";
|
|
$this->db->sql_query($sql);
|
|
$num_notifications = $this->db->sql_fetchfield('num_notifications');
|
|
$this->db->sql_freeresult();
|
|
|
|
if ($num_notifications)
|
|
{
|
|
return;
|
|
}
|
|
}
|
|
|
|
$sql = 'UPDATE ' . $this->user_notifications_table . "
|
|
SET notify = 0
|
|
WHERE item_type = '" . $this->db->sql_escape($item_type) . "'
|
|
AND item_id = " . (int) $item_id . '
|
|
AND user_id = ' .(int) $user_id . "
|
|
AND method = '" . $this->db->sql_escape($method) . "'";
|
|
$this->db->sql_query($sql);
|
|
|
|
if (!$this->db->sql_affectedrows())
|
|
{
|
|
$sql = 'INSERT INTO ' . $this->user_notifications_table . ' ' .
|
|
$this->db->sql_build_array('INSERT', array(
|
|
'item_type' => $item_type,
|
|
'item_id' => (int) $item_id,
|
|
'user_id' => (int) $user_id,
|
|
'method' => $method,
|
|
'notify' => 0,
|
|
));
|
|
$this->db->sql_query($sql);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Disable all notifications of a certain type
|
|
*
|
|
* This should be called when an extension which has notification types
|
|
* is disabled so that all those notifications are hidden and do not
|
|
* cause errors
|
|
*
|
|
* @param string $notification_type_name Type identifier of the subscription
|
|
*/
|
|
public function disable_notifications($notification_type_name)
|
|
{
|
|
$sql = 'UPDATE ' . $this->notification_types_table . "
|
|
SET notification_type_enabled = 0
|
|
WHERE notification_type_name = '" . $this->db->sql_escape($notification_type_name) . "'";
|
|
$this->db->sql_query($sql);
|
|
}
|
|
|
|
/**
|
|
* Purge all notifications of a certain type
|
|
*
|
|
* This should be called when an extension which has notification types
|
|
* is purged so that all those notifications are removed
|
|
*
|
|
* @param string $notification_type_name Type identifier of the subscription
|
|
*/
|
|
public function purge_notifications($notification_type_name)
|
|
{
|
|
// If a notification is never used, its type will not be added to the database
|
|
// nor its id cached. If this method is called by an extension during the
|
|
// purge step, and that extension never used its notifications,
|
|
// get_notification_type_id() will throw an exception. However,
|
|
// because no notification type was added to the database,
|
|
// there is nothing to delete, so we can silently drop the exception.
|
|
try
|
|
{
|
|
$notification_type_id = $this->get_notification_type_id($notification_type_name);
|
|
|
|
$sql = 'DELETE FROM ' . $this->notifications_table . '
|
|
WHERE notification_type_id = ' . (int) $notification_type_id;
|
|
$this->db->sql_query($sql);
|
|
|
|
$sql = 'DELETE FROM ' . $this->notification_types_table . '
|
|
WHERE notification_type_id = ' . (int) $notification_type_id;
|
|
$this->db->sql_query($sql);
|
|
|
|
$this->cache->destroy('notification_type_ids');
|
|
}
|
|
catch (\phpbb\notification\exception $e)
|
|
{
|
|
// Continue
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Enable all notifications of a certain type
|
|
*
|
|
* This should be called when an extension which has notification types
|
|
* that was disabled is re-enabled so that all those notifications that
|
|
* were hidden are shown again
|
|
*
|
|
* @param string $notification_type_name Type identifier of the subscription
|
|
*/
|
|
public function enable_notifications($notification_type_name)
|
|
{
|
|
$sql = 'UPDATE ' . $this->notification_types_table . "
|
|
SET notification_type_enabled = 1
|
|
WHERE notification_type_name = '" . $this->db->sql_escape($notification_type_name) . "'";
|
|
$this->db->sql_query($sql);
|
|
}
|
|
|
|
/**
|
|
* Delete all notifications older than a certain time
|
|
*
|
|
* @param int $timestamp Unix timestamp to delete all notifications that were created before
|
|
* @param bool $only_read True (default) to only prune read notifications
|
|
*/
|
|
public function prune_notifications($timestamp, $only_read = true)
|
|
{
|
|
$sql = 'DELETE FROM ' . $this->notifications_table . '
|
|
WHERE notification_time < ' . (int) $timestamp .
|
|
(($only_read) ? ' AND notification_read = 1' : '');
|
|
$this->db->sql_query($sql);
|
|
|
|
$this->config->set('read_notification_last_gc', time(), false);
|
|
}
|
|
|
|
/**
|
|
* Helper to get the notifications item type class and set it up
|
|
*/
|
|
public function get_item_type_class($notification_type_name, $data = array())
|
|
{
|
|
$item = $this->load_object($notification_type_name);
|
|
|
|
$item->set_initial_data($data);
|
|
|
|
return $item;
|
|
}
|
|
|
|
/**
|
|
* Helper to get the notifications method class and set it up
|
|
*/
|
|
public function get_method_class($method_name)
|
|
{
|
|
return $this->load_object($method_name);
|
|
}
|
|
|
|
/**
|
|
* Helper to load objects (notification types/methods)
|
|
*/
|
|
protected function load_object($object_name)
|
|
{
|
|
$object = $this->phpbb_container->get($object_name);
|
|
|
|
if (method_exists($object, 'set_notification_manager'))
|
|
{
|
|
$object->set_notification_manager($this);
|
|
}
|
|
|
|
return $object;
|
|
}
|
|
|
|
/**
|
|
* Get the notification type id from the name
|
|
*
|
|
* @param string $notification_type_name The name
|
|
* @return int the notification_type_id
|
|
* @throws \phpbb\notification\exception
|
|
*/
|
|
public function get_notification_type_id($notification_type_name)
|
|
{
|
|
$notification_type_ids = $this->cache->get('notification_type_ids');
|
|
|
|
if ($notification_type_ids === false)
|
|
{
|
|
$notification_type_ids = array();
|
|
|
|
$sql = 'SELECT notification_type_id, notification_type_name
|
|
FROM ' . $this->notification_types_table;
|
|
$result = $this->db->sql_query($sql);
|
|
while ($row = $this->db->sql_fetchrow($result))
|
|
{
|
|
$notification_type_ids[$row['notification_type_name']] = (int) $row['notification_type_id'];
|
|
}
|
|
$this->db->sql_freeresult($result);
|
|
|
|
$this->cache->put('notification_type_ids', $notification_type_ids);
|
|
}
|
|
|
|
if (!isset($notification_type_ids[$notification_type_name]))
|
|
{
|
|
if (!isset($this->notification_types[$notification_type_name]) && !isset($this->notification_types['notification.type.' . $notification_type_name]))
|
|
{
|
|
throw new \phpbb\notification\exception($this->user->lang('NOTIFICATION_TYPE_NOT_EXIST', $notification_type_name));
|
|
}
|
|
|
|
$sql = 'INSERT INTO ' . $this->notification_types_table . ' ' . $this->db->sql_build_array('INSERT', array(
|
|
'notification_type_name' => $notification_type_name,
|
|
'notification_type_enabled' => 1,
|
|
));
|
|
$this->db->sql_query($sql);
|
|
|
|
$notification_type_ids[$notification_type_name] = (int) $this->db->sql_nextid();
|
|
|
|
$this->cache->put('notification_type_ids', $notification_type_ids);
|
|
}
|
|
|
|
return $notification_type_ids[$notification_type_name];
|
|
}
|
|
|
|
/**
|
|
* Get notification type ids (as an array)
|
|
*
|
|
* @param array $notification_type_names Array of strings
|
|
* @return array Array of integers
|
|
*/
|
|
public function get_notification_type_ids(array $notification_type_names)
|
|
{
|
|
$notification_type_ids = array();
|
|
|
|
foreach ($notification_type_names as $name)
|
|
{
|
|
$notification_type_ids[$name] = $this->get_notification_type_id($name);
|
|
}
|
|
|
|
return $notification_type_ids;
|
|
}
|
|
}
|