[ticket/11444] Moving the in-board notifications to a method class

Currently the in-board method for the notifications is hardcoded and
cannot be disabled. This method should be in his own class extending
`phpbb\notification\method\method_interface`.

It also add the possibility, for each method, to be enabled by default (ie:
no entry in the DB => notification enabled).

https://tracker.phpbb.com/browse/PHPBB3-11444
https://tracker.phpbb.com/browse/PHPBB3-11967

PHPBB3-11444
This commit is contained in:
Nicofuma 2014-04-28 14:00:27 +02:00 committed by Tristan Darricau
parent 58d1d37c16
commit be0d4e20d4
55 changed files with 1229 additions and 609 deletions

View file

@ -14,7 +14,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
# ----- Notification's types ----- # ----- Notification's types -----
@ -39,7 +38,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -57,7 +55,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -75,7 +72,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -93,7 +89,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -111,7 +106,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -129,7 +123,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -147,7 +140,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -165,7 +157,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -183,7 +174,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -201,7 +191,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -219,7 +208,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
calls: calls:
- [set_utils, [@text_formatter.utils]] - [set_utils, [@text_formatter.utils]]
@ -239,7 +227,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -257,7 +244,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -275,7 +261,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -293,7 +278,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -311,7 +295,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -329,7 +312,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -347,7 +329,6 @@ services:
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications%
- %tables.user_notifications% - %tables.user_notifications%
tags: tags:
- { name: notification.type } - { name: notification.type }
@ -361,6 +342,23 @@ services:
tags: tags:
- { name: service_collection, tag: notification.method } - { name: service_collection, tag: notification.method }
notification.method.board:
class: phpbb\notification\method\board
scope: prototype # scope MUST be prototype for this to work!
arguments:
- @user_loader
- @dbal.conn
- @cache.driver
- @user
- @auth
- @config
- %core.root_path%
- %core.php_ext%
- %tables.notification_types%
- %tables.notifications%
tags:
- { name: notification.method }
notification.method.email: notification.method.email:
class: phpbb\notification\method\email class: phpbb\notification\method\email
scope: prototype scope: prototype

View file

@ -94,6 +94,7 @@ class acp_board
'allow_bbcode' => array('lang' => 'ALLOW_BBCODE', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => false), 'allow_bbcode' => array('lang' => 'ALLOW_BBCODE', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => false),
'allow_smilies' => array('lang' => 'ALLOW_SMILIES', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => false), 'allow_smilies' => array('lang' => 'ALLOW_SMILIES', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => false),
'allow_sig' => array('lang' => 'ALLOW_SIG', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => false), 'allow_sig' => array('lang' => 'ALLOW_SIG', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => false),
'allow_board_notifications' => array('lang' => 'ALLOW_BOARD_NOTIFICATIONS', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => false),
'allow_nocensors' => array('lang' => 'ALLOW_NO_CENSORS', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => true), 'allow_nocensors' => array('lang' => 'ALLOW_NO_CENSORS', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => true),
'allow_bookmarks' => array('lang' => 'ALLOW_BOOKMARKS', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => true), 'allow_bookmarks' => array('lang' => 'ALLOW_BOOKMARKS', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => true),
'allow_birthdays' => array('lang' => 'ALLOW_BIRTHDAYS', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => true), 'allow_birthdays' => array('lang' => 'ALLOW_BIRTHDAYS', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => true),

View file

@ -624,7 +624,7 @@ function markread($mode, $forum_id = false, $topic_id = false, $post_time = 0, $
$phpbb_notifications = $phpbb_container->get('notification_manager'); $phpbb_notifications = $phpbb_container->get('notification_manager');
// Mark all topic notifications read for this user // Mark all topic notifications read for this user
$phpbb_notifications->mark_notifications_read(array( $phpbb_notifications->mark_notifications(array(
'notification.type.topic', 'notification.type.topic',
'notification.type.quote', 'notification.type.quote',
'notification.type.bookmark', 'notification.type.bookmark',
@ -694,7 +694,7 @@ function markread($mode, $forum_id = false, $topic_id = false, $post_time = 0, $
/* @var $phpbb_notifications \phpbb\notification\manager */ /* @var $phpbb_notifications \phpbb\notification\manager */
$phpbb_notifications = $phpbb_container->get('notification_manager'); $phpbb_notifications = $phpbb_container->get('notification_manager');
$phpbb_notifications->mark_notifications_read_by_parent(array( $phpbb_notifications->mark_notifications_by_parent(array(
'notification.type.topic', 'notification.type.topic',
'notification.type.approve_topic', 'notification.type.approve_topic',
), $forum_id, $user->data['user_id'], $post_time); ), $forum_id, $user->data['user_id'], $post_time);
@ -711,7 +711,7 @@ function markread($mode, $forum_id = false, $topic_id = false, $post_time = 0, $
} }
$db->sql_freeresult($result); $db->sql_freeresult($result);
$phpbb_notifications->mark_notifications_read_by_parent(array( $phpbb_notifications->mark_notifications_by_parent(array(
'notification.type.quote', 'notification.type.quote',
'notification.type.bookmark', 'notification.type.bookmark',
'notification.type.post', 'notification.type.post',
@ -818,12 +818,12 @@ function markread($mode, $forum_id = false, $topic_id = false, $post_time = 0, $
$phpbb_notifications = $phpbb_container->get('notification_manager'); $phpbb_notifications = $phpbb_container->get('notification_manager');
// Mark post notifications read for this user in this topic // Mark post notifications read for this user in this topic
$phpbb_notifications->mark_notifications_read(array( $phpbb_notifications->mark_notifications(array(
'notification.type.topic', 'notification.type.topic',
'notification.type.approve_topic', 'notification.type.approve_topic',
), $topic_id, $user->data['user_id'], $post_time); ), $topic_id, $user->data['user_id'], $post_time);
$phpbb_notifications->mark_notifications_read_by_parent(array( $phpbb_notifications->mark_notifications_by_parent(array(
'notification.type.quote', 'notification.type.quote',
'notification.type.bookmark', 'notification.type.bookmark',
'notification.type.post', 'notification.type.post',
@ -4254,12 +4254,12 @@ function page_header($page_title = '', $display_online_list = false, $item_id =
// Output the notifications // Output the notifications
$notifications = false; $notifications = false;
if ($config['load_notifications'] && $user->data['user_id'] != ANONYMOUS && $user->data['user_type'] != USER_IGNORE) if ($config['load_notifications'] && $config['allow_board_notifications'] && $user->data['user_id'] != ANONYMOUS && $user->data['user_type'] != USER_IGNORE)
{ {
/* @var $phpbb_notifications \phpbb\notification\manager */ /* @var $phpbb_notifications \phpbb\notification\manager */
$phpbb_notifications = $phpbb_container->get('notification_manager'); $phpbb_notifications = $phpbb_container->get('notification_manager');
$notifications = $phpbb_notifications->load_notifications(array( $notifications = $phpbb_notifications->load_notifications('notification.method.board', array(
'all_unread' => true, 'all_unread' => true,
'limit' => 5, 'limit' => 5,
)); ));
@ -4296,7 +4296,7 @@ function page_header($page_title = '', $display_online_list = false, $item_id =
'U_VIEW_ALL_NOTIFICATIONS' => append_sid("{$phpbb_root_path}ucp.$phpEx", 'i=ucp_notifications'), 'U_VIEW_ALL_NOTIFICATIONS' => append_sid("{$phpbb_root_path}ucp.$phpEx", 'i=ucp_notifications'),
'U_MARK_ALL_NOTIFICATIONS' => append_sid("{$phpbb_root_path}ucp.$phpEx", 'i=ucp_notifications&mode=notification_list&mark=all&token=' . $notification_mark_hash), 'U_MARK_ALL_NOTIFICATIONS' => append_sid("{$phpbb_root_path}ucp.$phpEx", 'i=ucp_notifications&mode=notification_list&mark=all&token=' . $notification_mark_hash),
'U_NOTIFICATION_SETTINGS' => append_sid("{$phpbb_root_path}ucp.$phpEx", 'i=ucp_notifications&mode=notification_options'), 'U_NOTIFICATION_SETTINGS' => append_sid("{$phpbb_root_path}ucp.$phpEx", 'i=ucp_notifications&mode=notification_options'),
'S_NOTIFICATIONS_DISPLAY' => $config['load_notifications'], 'S_NOTIFICATIONS_DISPLAY' => $config['load_notifications'] && $config['allow_board_notifications'],
'S_USER_NEW_PRIVMSG' => $user->data['user_new_privmsg'], 'S_USER_NEW_PRIVMSG' => $user->data['user_new_privmsg'],
'S_USER_UNREAD_PRIVMSG' => $user->data['user_unread_privmsg'], 'S_USER_UNREAD_PRIVMSG' => $user->data['user_unread_privmsg'],

View file

@ -884,7 +884,7 @@ function update_unread_status($unread, $msg_id, $user_id, $folder_id)
/* @var $phpbb_notifications \phpbb\notification\manager */ /* @var $phpbb_notifications \phpbb\notification\manager */
$phpbb_notifications = $phpbb_container->get('notification_manager'); $phpbb_notifications = $phpbb_container->get('notification_manager');
$phpbb_notifications->mark_notifications_read('notification.type.pm', $msg_id, $user_id); $phpbb_notifications->mark_notifications('notification.type.pm', $msg_id, $user_id);
$sql = 'UPDATE ' . PRIVMSGS_TO_TABLE . " $sql = 'UPDATE ' . PRIVMSGS_TO_TABLE . "
SET pm_unread = 0 SET pm_unread = 0

View file

@ -97,7 +97,7 @@ class mcp_pm_reports
/* @var $phpbb_notifications \phpbb\notification\manager */ /* @var $phpbb_notifications \phpbb\notification\manager */
$phpbb_notifications = $phpbb_container->get('notification_manager'); $phpbb_notifications = $phpbb_container->get('notification_manager');
$phpbb_notifications->mark_notifications_read_by_parent('notification.type.report_pm', $report_id, $user->data['user_id']); $phpbb_notifications->mark_notifications_by_parent('report_pm', $report_id, $user->data['user_id']);
$pm_id = $report['pm_id']; $pm_id = $report['pm_id'];
$report_id = $report['report_id']; $report_id = $report['report_id'];

View file

@ -166,7 +166,7 @@ class mcp_queue
{ {
$post_id = (int) $topic_info[$topic_id]['topic_first_post_id']; $post_id = (int) $topic_info[$topic_id]['topic_first_post_id'];
$phpbb_notifications->mark_notifications_read('notification.type.topic_in_queue', $topic_id, $user->data['user_id']); $phpbb_notifications->mark_notifications('topic_in_queue', $topic_id, $user->data['user_id']);
} }
else else
{ {
@ -174,7 +174,7 @@ class mcp_queue
} }
} }
$phpbb_notifications->mark_notifications_read('notification.type.post_in_queue', $post_id, $user->data['user_id']); $phpbb_notifications->mark_notifications('post_in_queue', $post_id, $user->data['user_id']);
$post_info = phpbb_get_post_data(array($post_id), 'm_approve', true); $post_info = phpbb_get_post_data(array($post_id), 'm_approve', true);
@ -738,7 +738,7 @@ class mcp_queue
$phpbb_notifications->add_notifications(array('notification.type.quote'), $post_data); $phpbb_notifications->add_notifications(array('notification.type.quote'), $post_data);
$phpbb_notifications->delete_notifications('notification.type.post_in_queue', $post_id); $phpbb_notifications->delete_notifications('notification.type.post_in_queue', $post_id);
$phpbb_notifications->mark_notifications_read(array( $phpbb_notifications->mark_notifications(array(
'notification.type.quote', 'notification.type.quote',
'notification.type.bookmark', 'notification.type.bookmark',
'notification.type.post', 'notification.type.post',
@ -974,8 +974,8 @@ class mcp_queue
), $topic_data); ), $topic_data);
} }
$phpbb_notifications->mark_notifications_read('notification.type.quote', $topic_data['post_id'], $user->data['user_id']); $phpbb_notifications->mark_notifications('quote', $topic_data['post_id'], $user->data['user_id']);
$phpbb_notifications->mark_notifications_read('notification.type.topic', $topic_id, $user->data['user_id']); $phpbb_notifications->mark_notifications('topic', $topic_id, $user->data['user_id']);
if ($notify_poster) if ($notify_poster)
{ {

View file

@ -142,7 +142,7 @@ class mcp_reports
/* @var $phpbb_notifications \phpbb\notification\manager */ /* @var $phpbb_notifications \phpbb\notification\manager */
$phpbb_notifications = $phpbb_container->get('notification_manager'); $phpbb_notifications = $phpbb_container->get('notification_manager');
$phpbb_notifications->mark_notifications_read('notification.type.report_post', $post_id, $user->data['user_id']); $phpbb_notifications->mark_notifications('report_post', $post_id, $user->data['user_id']);
if (!$report_id && $report['report_closed']) if (!$report_id && $report['report_closed'])
{ {

View file

@ -20,7 +20,7 @@ class ucp_notifications_info
'title' => 'UCP_NOTIFICATION_OPTIONS', 'title' => 'UCP_NOTIFICATION_OPTIONS',
'modes' => array( 'modes' => array(
'notification_options' => array('title' => 'UCP_NOTIFICATION_OPTIONS', 'auth' => '', 'cat' => array('UCP_PREFS')), 'notification_options' => array('title' => 'UCP_NOTIFICATION_OPTIONS', 'auth' => '', 'cat' => array('UCP_PREFS')),
'notification_list' => array('title' => 'UCP_NOTIFICATION_LIST', 'auth' => '', 'cat' => array('UCP_MAIN')), 'notification_list' => array('title' => 'UCP_NOTIFICATION_LIST', 'auth' => 'cfg_allow_board_notifications', 'cat' => array('UCP_MAIN')),
), ),
); );
} }

View file

@ -70,15 +70,6 @@ class ucp_notifications
$phpbb_notifications->delete_subscription($type, 0, $method_data['id']); $phpbb_notifications->delete_subscription($type, 0, $method_data['id']);
} }
} }
if ($request->is_set_post(str_replace('.', '_', $type) . '_notification') && !isset($subscriptions[$type]))
{
$phpbb_notifications->add_subscription($type);
}
else if (!$request->is_set_post(str_replace('.', '_', $type) . '_notification') && isset($subscriptions[$type]))
{
$phpbb_notifications->delete_subscription($type);
}
} }
} }
@ -100,7 +91,7 @@ class ucp_notifications
// Mark all items read // Mark all items read
if ($request->variable('mark', '') == 'all' && check_link_hash($request->variable('token', ''), 'mark_all_notifications_read')) if ($request->variable('mark', '') == 'all' && check_link_hash($request->variable('token', ''), 'mark_all_notifications_read'))
{ {
$phpbb_notifications->mark_notifications_read(false, false, $user->data['user_id'], $form_time); $phpbb_notifications->mark_notifications(false, false, $user->data['user_id'], $form_time);
meta_refresh(3, $this->u_action); meta_refresh(3, $this->u_action);
$message = $user->lang['NOTIFICATIONS_MARK_ALL_READ_SUCCESS']; $message = $user->lang['NOTIFICATIONS_MARK_ALL_READ_SUCCESS'];
@ -131,11 +122,11 @@ class ucp_notifications
if (!empty($mark_read)) if (!empty($mark_read))
{ {
$phpbb_notifications->mark_notifications_read_by_id($mark_read, $form_time); $phpbb_notifications->mark_notifications_by_id($mark_read, $form_time);
} }
} }
$notifications = $phpbb_notifications->load_notifications(array( $notifications = $phpbb_notifications->load_notifications('notification.method.board', array(
'start' => $start, 'start' => $start,
'limit' => $config['topics_per_page'], 'limit' => $config['topics_per_page'],
'count_total' => true, 'count_total' => true,
@ -196,8 +187,6 @@ class ucp_notifications
'NAME' => $user->lang($data['lang']), 'NAME' => $user->lang($data['lang']),
'EXPLAIN' => (isset($user->lang[$data['lang'] . '_EXPLAIN'])) ? $user->lang($data['lang'] . '_EXPLAIN') : '', 'EXPLAIN' => (isset($user->lang[$data['lang'] . '_EXPLAIN'])) ? $user->lang($data['lang'] . '_EXPLAIN') : '',
'SUBSCRIBED' => (isset($subscriptions[$type])) ? true : false,
)); ));
foreach ($notification_methods as $method => $method_data) foreach ($notification_methods as $method => $method_data)
@ -230,7 +219,7 @@ class ucp_notifications
{ {
$notification_methods = $phpbb_notifications->get_subscription_methods(); $notification_methods = $phpbb_notifications->get_subscription_methods();
foreach ($notification_methods as $method => $method_data) foreach($notification_methods as $method => $method_data)
{ {
$template->assign_block_vars($block, array( $template->assign_block_vars($block, array(
'METHOD' => $method_data['id'], 'METHOD' => $method_data['id'],

View file

@ -45,7 +45,7 @@ if (($mark_notification = $request->variable('mark_notification', 0)))
/* @var $phpbb_notifications \phpbb\notification\manager */ /* @var $phpbb_notifications \phpbb\notification\manager */
$phpbb_notifications = $phpbb_container->get('notification_manager'); $phpbb_notifications = $phpbb_container->get('notification_manager');
$notification = $phpbb_notifications->load_notifications(array( $notification = $phpbb_notifications->load_notifications('notification.method.board', array(
'notification_id' => $mark_notification, 'notification_id' => $mark_notification,
)); ));

View file

@ -107,6 +107,7 @@ INSERT INTO phpbb_config (config_name, config_value) VALUES ('email_max_chunk_si
INSERT INTO phpbb_config (config_name, config_value) VALUES ('email_package_size', '20'); INSERT INTO phpbb_config (config_name, config_value) VALUES ('email_package_size', '20');
INSERT INTO phpbb_config (config_name, config_value) VALUES ('enable_confirm', '1'); INSERT INTO phpbb_config (config_name, config_value) VALUES ('enable_confirm', '1');
INSERT INTO phpbb_config (config_name, config_value) VALUES ('enable_mod_rewrite', '0'); INSERT INTO phpbb_config (config_name, config_value) VALUES ('enable_mod_rewrite', '0');
INSERT INTO phpbb_config (config_name, config_value) VALUES ('allow_board_notifications', '1');
INSERT INTO phpbb_config (config_name, config_value) VALUES ('enable_pm_icons', '1'); INSERT INTO phpbb_config (config_name, config_value) VALUES ('enable_pm_icons', '1');
INSERT INTO phpbb_config (config_name, config_value) VALUES ('enable_post_confirm', '1'); INSERT INTO phpbb_config (config_name, config_value) VALUES ('enable_post_confirm', '1');
INSERT INTO phpbb_config (config_name, config_value) VALUES ('feed_enable', '1'); INSERT INTO phpbb_config (config_name, config_value) VALUES ('feed_enable', '1');
@ -813,9 +814,9 @@ INSERT INTO phpbb_profile_fields (field_name, field_type, field_ident, field_len
INSERT INTO phpbb_profile_fields (field_name, field_type, field_ident, field_length, field_minlen, field_maxlen, field_novalue, field_default_value, field_validation, field_required, field_show_novalue, field_show_on_reg, field_show_on_pm, field_show_on_vt, field_show_on_ml, field_show_profile, field_hide, field_no_view, field_active, field_order, field_is_contact, field_contact_desc, field_contact_url) VALUES ('phpbb_googleplus', 'profilefields.type.googleplus', 'phpbb_googleplus', '20', '3', '255', '', '', '[\w]+', 0, 0, 0, 1, 1, 1, 1, 0, 0, 1, 13, 1, 'VIEW_GOOGLEPLUS_PROFILE', 'http://plus.google.com/%s'); INSERT INTO phpbb_profile_fields (field_name, field_type, field_ident, field_length, field_minlen, field_maxlen, field_novalue, field_default_value, field_validation, field_required, field_show_novalue, field_show_on_reg, field_show_on_pm, field_show_on_vt, field_show_on_ml, field_show_profile, field_hide, field_no_view, field_active, field_order, field_is_contact, field_contact_desc, field_contact_url) VALUES ('phpbb_googleplus', 'profilefields.type.googleplus', 'phpbb_googleplus', '20', '3', '255', '', '', '[\w]+', 0, 0, 0, 1, 1, 1, 1, 0, 0, 1, 13, 1, 'VIEW_GOOGLEPLUS_PROFILE', 'http://plus.google.com/%s');
# User Notification Options (for first user) # User Notification Options (for first user)
INSERT INTO phpbb_user_notifications (item_type, item_id, user_id, method) VALUES('notification.type.post', 0, 2, ''); INSERT INTO phpbb_user_notifications (item_type, item_id, user_id, method) VALUES('notification.type.post', 0, 2, 'notification.method.board');
INSERT INTO phpbb_user_notifications (item_type, item_id, user_id, method) VALUES('notification.type.post', 0, 2, 'notification.method.email'); INSERT INTO phpbb_user_notifications (item_type, item_id, user_id, method) VALUES('notification.type.post', 0, 2, 'notification.method.email');
INSERT INTO phpbb_user_notifications (item_type, item_id, user_id, method) VALUES('notification.type.topic', 0, 2, ''); INSERT INTO phpbb_user_notifications (item_type, item_id, user_id, method) VALUES('notification.type.topic', 0, 2, 'notification.method.board');
INSERT INTO phpbb_user_notifications (item_type, item_id, user_id, method) VALUES('notification.type.topic', 0, 2, 'notification.method.email'); INSERT INTO phpbb_user_notifications (item_type, item_id, user_id, method) VALUES('notification.type.topic', 0, 2, 'notification.method.email');
# POSTGRES COMMIT # # POSTGRES COMMIT #

View file

@ -99,6 +99,7 @@ $lang = array_merge($lang, array(
'ALLOW_TOPIC_NOTIFY' => 'Allow subscribing to topics', 'ALLOW_TOPIC_NOTIFY' => 'Allow subscribing to topics',
'BOARD_PM' => 'Private messaging', 'BOARD_PM' => 'Private messaging',
'BOARD_PM_EXPLAIN' => 'Enable private messaging for all users.', 'BOARD_PM_EXPLAIN' => 'Enable private messaging for all users.',
'ALLOW_BOARD_NOTIFICATIONS' => 'Allow board notifications',
)); ));
// Avatar Settings // Avatar Settings

View file

@ -447,6 +447,7 @@ $lang = array_merge($lang, array(
'NOTIFICATION_FORUM' => '<em>Forum:</em> %1$s', 'NOTIFICATION_FORUM' => '<em>Forum:</em> %1$s',
'NOTIFICATION_GROUP_REQUEST' => '<strong>Group request</strong> from %1$s to join the group %2$s.', 'NOTIFICATION_GROUP_REQUEST' => '<strong>Group request</strong> from %1$s to join the group %2$s.',
'NOTIFICATION_GROUP_REQUEST_APPROVED' => '<strong>Group request approved</strong> to join the group %1$s.', 'NOTIFICATION_GROUP_REQUEST_APPROVED' => '<strong>Group request approved</strong> to join the group %1$s.',
'NOTIFICATION_METHOD_INVALID' => 'The method "%s" does not refer to a valid notification method.',
'NOTIFICATION_PM' => '<strong>Private Message</strong> from %1$s:', 'NOTIFICATION_PM' => '<strong>Private Message</strong> from %1$s:',
'NOTIFICATION_POST' => array( 'NOTIFICATION_POST' => array(
1 => '<strong>Reply</strong> from %1$s in topic:', 1 => '<strong>Reply</strong> from %1$s in topic:',

View file

@ -327,6 +327,7 @@ $lang = array_merge($lang, array(
'NOTIFICATION_GROUP_MODERATION' => 'Moderation Notifications', 'NOTIFICATION_GROUP_MODERATION' => 'Moderation Notifications',
'NOTIFICATION_GROUP_ADMINISTRATION' => 'Administration Notifications', 'NOTIFICATION_GROUP_ADMINISTRATION' => 'Administration Notifications',
'NOTIFICATION_GROUP_POSTING' => 'Posting Notifications', 'NOTIFICATION_GROUP_POSTING' => 'Posting Notifications',
'NOTIFICATION_METHOD_BOARD' => 'Notifications',
'NOTIFICATION_METHOD_EMAIL' => 'Email', 'NOTIFICATION_METHOD_EMAIL' => 'Email',
'NOTIFICATION_METHOD_JABBER' => 'Jabber', 'NOTIFICATION_METHOD_JABBER' => 'Jabber',
'NOTIFICATION_TYPE' => 'Notification type', 'NOTIFICATION_TYPE' => 'Notification type',

View file

@ -0,0 +1,73 @@
<?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\db\migration\data\v310;
class notifications_board extends \phpbb\db\migration\migration
{
static public function depends_on()
{
return array('\phpbb\db\migration\data\v310\notifications');
}
public function update_data()
{
return array(
array('config.add', array('allow_board_notifications', 1)),
array('custom', array(array($this, 'update_user_subscriptions'))),
array('custom', array(array($this, 'update_module'))),
);
}
public function update_module()
{
$sql = 'UPDATE ' . MODULES_TABLE . "
SET auth = 'cfg_allow_board_notifications'
WHERE module_basename = 'ucp_notifications'
AND module_mode = 'notification_list'";
$this->sql_query($sql);
}
public function update_user_subscriptions()
{
$sql = 'UPDATE ' . USER_NOTIFICATIONS_TABLE . "
SET method = 'notification.method.board'
WHERE method = ''";
$this->sql_query($sql);
}
public function revert_data()
{
return array(
array('custom', array(array($this, 'revert_user_subscriptions'))),
array('custom', array(array($this, 'revert_module'))),
);
}
public function revert_user_subscriptions()
{
$sql = 'UPDATE ' . USER_NOTIFICATIONS_TABLE . "
SET method = ''
WHERE method = 'notification.method.board'";
$this->sql_query($sql);
}
public function revert_module()
{
$sql = 'UPDATE ' . MODULES_TABLE . "
SET auth = ''
WHERE module_basename = 'ucp_notifications'
AND module_mode = 'notification_list'";
$this->sql_query($sql);
}
}

View file

@ -13,7 +13,7 @@
namespace phpbb\notification; namespace phpbb\notification;
use Symfony\Component\DependencyInjection\ContainerInterface; use \Symfony\Component\DependencyInjection\ContainerInterface;
/** /**
* Notifications service class * Notifications service class
@ -59,9 +59,6 @@ class manager
/** @var string */ /** @var string */
protected $notification_types_table; protected $notification_types_table;
/** @var string */
protected $notifications_table;
/** @var string */ /** @var string */
protected $user_notifications_table; protected $user_notifications_table;
@ -80,12 +77,11 @@ class manager
* @param string $phpbb_root_path * @param string $phpbb_root_path
* @param string $php_ext * @param string $php_ext
* @param string $notification_types_table * @param string $notification_types_table
* @param string $notifications_table
* @param string $user_notifications_table * @param string $user_notifications_table
* *
* @return \phpbb\notification\manager * @return \phpbb\notification\manager
*/ */
public function __construct($notification_types, $notification_methods, ContainerInterface $phpbb_container, \phpbb\user_loader $user_loader, \phpbb\config\config $config, \phpbb\event\dispatcher_interface $phpbb_dispatcher, \phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, $user, $phpbb_root_path, $php_ext, $notification_types_table, $notifications_table, $user_notifications_table) public function __construct($notification_types, $notification_methods, ContainerInterface $phpbb_container, \phpbb\user_loader $user_loader, \phpbb\config\config $config, \phpbb\event\dispatcher_interface $phpbb_dispatcher, \phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, $user, $phpbb_root_path, $php_ext, $notification_types_table, $user_notifications_table)
{ {
$this->notification_types = $notification_types; $this->notification_types = $notification_types;
$this->notification_methods = $notification_methods; $this->notification_methods = $notification_methods;
@ -102,13 +98,13 @@ class manager
$this->php_ext = $php_ext; $this->php_ext = $php_ext;
$this->notification_types_table = $notification_types_table; $this->notification_types_table = $notification_types_table;
$this->notifications_table = $notifications_table;
$this->user_notifications_table = $user_notifications_table; $this->user_notifications_table = $user_notifications_table;
} }
/** /**
* Load the user's notifications * Load the user's notifications for a given method
* *
* @param string $method_name
* @param array $options Optional options to control what notifications are loaded * @param array $options Optional options to control what notifications are loaded
* notification_id Notification id to load (or array of notification ids) * notification_id Notification id to load (or array of notification ids)
* user_id User id to load notifications for (Default: $user->data['user_id']) * user_id User id to load notifications for (Default: $user->data['user_id'])
@ -123,27 +119,21 @@ class manager
* 'notifications' array of notification type objects * 'notifications' array of notification type objects
* 'unread_count' number of unread notifications the user has if count_unread is true in the options * '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 * 'total_count' number of notifications the user has if count_total is true in the options
* @throws \phpbb\notification\exception when the method doesn't refer to a class extending \phpbb\notification\method\method_interface
*/ */
public function load_notifications(array $options = array()) public function load_notifications($method_name, array $options = array())
{ {
// Merge default options $method = $this->get_method_class($method_name);
$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 if (! $method instanceof \phpbb\notification\method\method_interface)
$options['count_unread'] = ($options['all_unread']) ? true : $options['count_unread']; {
throw new \phpbb\notification\exception($this->user->lang('NOTIFICATION_METHOD_INVALID', $method_name));
// 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)) else if ($method->is_available())
{
return $method->load_notifications($options);
}
else
{ {
return array( return array(
'notifications' => array(), 'notifications' => array(),
@ -151,172 +141,80 @@ class manager
'total_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 * Mark notifications read or unread for all available methods
* *
* @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|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 $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|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) * @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)
* @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)
*/ */
public function mark_notifications_read($notification_type_name, $item_id, $user_id, $time = false) public function mark_notifications($notification_type_name, $item_id, $user_id, $time = false, $mark_read = true)
{ {
$time = ($time !== false) ? $time : time(); if (is_array($notification_type_name))
{
$notification_type_id = $this->get_notification_type_ids($notification_type_name);
}
else if ($notification_type_name !== false)
{
$notification_type_id = $this->get_notification_type_id($notification_type_name);
}
else
{
$notification_type_id = false;
}
$sql = 'UPDATE ' . $this->notifications_table . " foreach ($this->get_available_subscription_methods() as $method)
SET notification_read = 1 {
WHERE notification_time <= " . (int) $time . $method->mark_notifications($notification_type_id, $item_id, $user_id, $time, $mark_read);
(($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 * Mark notifications read or unread from a parent identifier for all available methods
* *
* @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 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 $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|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) * @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)
* @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)
*/ */
public function mark_notifications_read_by_parent($notification_type_name, $item_parent_id, $user_id, $time = false) public function mark_notifications_by_parent($notification_type_name, $item_parent_id, $user_id, $time = false, $mark_read = true)
{ {
$time = ($time !== false) ? $time : time(); if (is_array($notification_type_name))
{
$notification_type_id = $this->get_notification_type_ids($notification_type_name);
}
else
{
$notification_type_id = $this->get_notification_type_id($notification_type_name);
}
$sql = 'UPDATE ' . $this->notifications_table . " foreach ($this->get_available_subscription_methods() as $method)
SET notification_read = 1 {
WHERE notification_time <= " . (int) $time . $method->mark_notifications_by_parent($notification_type_id, $item_parent_id, $user_id, $time, $mark_read);
(($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, false, true) : '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 * Mark notifications read or unread for a given method
* *
* @param string $method_name
* @param int|array $notification_id Notification id or array of notification ids. * @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) * @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)
* @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)
*/ */
public function mark_notifications_read_by_id($notification_id, $time = false) public function mark_notifications_by_id($method_name, $notification_id, $time = false, $mark_read = true)
{ {
$time = ($time !== false) ? $time : time(); $method = $this->get_method_class($method_name);
$sql = 'UPDATE ' . $this->notifications_table . " if ($method instanceof \phpbb\notification\method\method_interface && $method->is_available())
SET notification_read = 1 {
WHERE notification_time <= " . (int) $time . ' $method->mark_notifications_by_id($notification_id, $time, $mark_read);
AND ' . ((is_array($notification_id)) ? $this->db->sql_in_set('notification_id', $notification_id) : 'notification_id = ' . (int) $notification_id); }
$this->db->sql_query($sql);
} }
/** /**
@ -411,18 +309,15 @@ class manager
// Make sure not to send new notifications to users who've already been notified about this item // 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 // This may happen when an item was added, but now new users are able to see the item
$sql = 'SELECT n.user_id // We remove each user which was already notified by at least one method.
FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt foreach ($this->get_subscription_methods_instances() as $method)
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']]); $notified_users = $method->get_notified_users($notification_type_id, array('item_id' => $item_id));
foreach ($notified_users as $user => $notifications)
{
unset($notify_users[$user]);
}
} }
$this->db->sql_freeresult($result);
if (!sizeof($notify_users)) if (!sizeof($notify_users))
{ {
@ -434,8 +329,6 @@ class manager
$pre_create_data = $notification->pre_create_insert_array($data, $notify_users); $pre_create_data = $notification->pre_create_insert_array($data, $notify_users);
unset($notification); 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 // 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) foreach ($notify_users as $user => $methods)
{ {
@ -443,8 +336,8 @@ class manager
$notification->user_id = (int) $user; $notification->user_id = (int) $user;
// Insert notification row using buffer. // Generate the insert_array
$insert_buffer->insert($notification->create_insert_array($data, $pre_create_data)); $notification->create_insert_array($data, $pre_create_data);
// Users are needed to send notifications // Users are needed to send notifications
$user_ids = array_merge($user_ids, $notification->users_to_query()); $user_ids = array_merge($user_ids, $notification->users_to_query());
@ -452,8 +345,6 @@ class manager
foreach ($methods as $method) foreach ($methods as $method)
{ {
// setup the notification methods and add the notification to the queue // 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])) if (!isset($notification_methods[$method]))
{ {
$notification_methods[$method] = $this->get_method_class($method); $notification_methods[$method] = $this->get_method_class($method);
@ -462,9 +353,6 @@ class manager
$notification_methods[$method]->add_to_queue($notification); $notification_methods[$method]->add_to_queue($notification);
} }
} }
}
$insert_buffer->flush();
// We need to load all of the users to send notifications // We need to load all of the users to send notifications
$this->user_loader->load_users($user_ids); $this->user_loader->load_users($user_ids);
@ -477,12 +365,13 @@ class manager
} }
/** /**
* Update a notification * Update 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 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 * @param array $data Data specific for this type that will be updated
* @param array $options
*/ */
public function update_notifications($notification_type_name, $data) public function update_notifications($notification_type_name, array $data, array $options = array())
{ {
if (is_array($notification_type_name)) if (is_array($notification_type_name))
{ {
@ -494,27 +383,27 @@ class manager
return; return;
} }
$notification = $this->get_item_type_class($notification_type_name); $this->update_notification($this->get_item_type_class($notification_type_name), $data, $options);
// 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 a notification
$update_array = $notification->create_update_array($data); *
* @param \phpbb\notification\type\type_interface $notification The notification
* @param array $data Data specific for this type that will be updated
* @param array $options
*/
public function update_notification(\phpbb\notification\type\type_interface $notification, array $data, array $options = array())
{
if (empty($options))
{
$options['item_id'] = $notification->get_item_id($data);
}
$sql = 'UPDATE ' . $this->notifications_table . ' foreach ($this->get_available_subscription_methods() as $method)
SET ' . $this->db->sql_build_array('UPDATE', $update_array) . ' {
WHERE notification_type_id = ' . (int) $notification_type_id . ' $method->update_notification($notification, $data, $options);
AND item_id = ' . (int) $item_id; }
$this->db->sql_query($sql);
} }
/** /**
@ -523,14 +412,15 @@ class manager
* @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 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 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) * @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)
* @param mixed $user_id User id (Default: false; not checked)
*/ */
public function delete_notifications($notification_type_name, $item_id, $parent_id = false) public function delete_notifications($notification_type_name, $item_id, $parent_id = false, $user_id = false)
{ {
if (is_array($notification_type_name)) if (is_array($notification_type_name))
{ {
foreach ($notification_type_name as $type) foreach ($notification_type_name as $type)
{ {
$this->delete_notifications($type, $item_id, $parent_id); $this->delete_notifications($type, $item_id, $parent_id, $user_id);
} }
return; return;
@ -538,11 +428,10 @@ class manager
$notification_type_id = $this->get_notification_type_id($notification_type_name); $notification_type_id = $this->get_notification_type_id($notification_type_name);
$sql = 'DELETE FROM ' . $this->notifications_table . ' foreach ($this->get_available_subscription_methods() as $method)
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) . $method->delete_notifications($notification_type_id, $item_id, $parent_id, $user_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);
} }
/** /**
@ -593,17 +482,54 @@ class manager
{ {
$subscription_methods = array(); $subscription_methods = array();
foreach ($this->notification_methods as $method_name => $data) foreach ($this->get_available_subscription_methods() as $method_name => $method)
{
$method = $this->get_method_class($method_name);
if ($method instanceof \phpbb\notification\method\method_interface && $method->is_available())
{ {
$subscription_methods[$method_name] = array( $subscription_methods[$method_name] = array(
'id' => $method->get_type(), 'id' => $method->get_type(),
'lang' => str_replace('.', '_', strtoupper($method->get_type())), 'lang' => str_replace('.', '_', strtoupper($method->get_type())),
); );
} }
return $subscription_methods;
}
/**
* Get all of the subscription methods
*
* @return array Array of method's instances
*/
private function get_subscription_methods_instances()
{
$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)
{
$subscription_methods[$method_name] = $method;
}
}
return $subscription_methods;
}
/**
* Get all of the available subscription methods
*
* @return array Array of method's instances
*/
private function get_available_subscription_methods()
{
$subscription_methods = array();
foreach ($this->get_subscription_methods_instances() as $method_name => $method)
{
if ($method->is_available())
{
$subscription_methods[$method_name] = $method;
}
} }
return $subscription_methods; return $subscription_methods;
@ -646,7 +572,7 @@ class manager
*/ */
public function get_global_subscriptions($user_id = false) public function get_global_subscriptions($user_id = false)
{ {
$user_id = ($user_id === false) ? $this->user->data['user_id'] : $user_id; $user_id = $user_id ?: $this->user->data['user_id'];
$subscriptions = array(); $subscriptions = array();
@ -656,11 +582,9 @@ class manager
{ {
foreach ($types as $id => $type) foreach ($types as $id => $type)
{ {
if (empty($user_notifications[$id])) if (empty($user_notifications[$id]))
{ {
// No rows at all, default to '' $subscriptions[$id] = $this->get_default_methods();
$subscriptions[$id] = array('');
} }
else else
{ {
@ -690,15 +614,20 @@ class manager
* *
* @param string $item_type Type identifier of the subscription * @param string $item_type Type identifier of the subscription
* @param int $item_id The id of the item * @param int $item_id The id of the item
* @param string $method The method of the notification e.g. '', 'email', or 'jabber' * @param string $method The method of the notification e.g. 'board', 'email', or 'jabber'
* (if null a subscription will be added for all the defaults methods)
* @param bool|int $user_id The user_id to add the subscription for (bool false for current user) * @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) public function add_subscription($item_type, $item_id = 0, $method = null, $user_id = false)
{ {
if ($method !== '') if ($method === null)
{ {
// Make sure to subscribe them to the base subscription foreach ($this->get_default_methods() as $method_name)
$this->add_subscription($item_type, $item_id, '', $user_id); {
$this->add_subscription($item_type, $item_id, $method_name, $user_id);
}
return;
} }
$user_id = ($user_id === false) ? $this->user->data['user_id'] : $user_id; $user_id = ($user_id === false) ? $this->user->data['user_id'] : $user_id;
@ -742,32 +671,22 @@ class manager
* *
* @param string $item_type Type identifier of the subscription * @param string $item_type Type identifier of the subscription
* @param int $item_id The id of the item * @param int $item_id The id of the item
* @param string $method The method of the notification e.g. '', 'email', or 'jabber' * @param string $method The method of the notification e.g. 'board', 'email', or 'jabber'
* @param bool|int $user_id The user_id to add the subscription for (bool false for current user) * @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) public function delete_subscription($item_type, $item_id = 0, $method = null, $user_id = false)
{ {
$user_id = ($user_id === false) ? $this->user->data['user_id'] : $user_id; if ($method === null)
{
foreach ($this->get_default_methods() as $method_name)
{
$this->delete_subscription($item_type, $item_id, $method_name, $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; return;
} }
}
$user_id = $user_id ?: $this->user->data['user_id'];
$sql = 'UPDATE ' . $this->user_notifications_table . " $sql = 'UPDATE ' . $this->user_notifications_table . "
SET notify = 0 SET notify = 0
@ -828,15 +747,11 @@ class manager
{ {
$notification_type_id = $this->get_notification_type_id($notification_type_name); $notification_type_id = $this->get_notification_type_id($notification_type_name);
$sql = 'DELETE FROM ' . $this->notifications_table . ' foreach ($this->get_available_subscription_methods() as $method)
WHERE notification_type_id = ' . (int) $notification_type_id; {
$this->db->sql_query($sql); $method->purge_notifications($notification_type_id);
}
$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) catch (\phpbb\notification\exception $e)
{ {
@ -869,12 +784,28 @@ class manager
*/ */
public function prune_notifications($timestamp, $only_read = true) public function prune_notifications($timestamp, $only_read = true)
{ {
$sql = 'DELETE FROM ' . $this->notifications_table . ' foreach ($this->get_available_subscription_methods() as $method)
WHERE notification_time < ' . (int) $timestamp . {
(($only_read) ? ' AND notification_read = 1' : ''); $method->prune_notifications($timestamp, $only_read);
$this->db->sql_query($sql); }
}
$this->config->set('read_notification_last_gc', time(), false); /**
* Helper to get the list of methods enabled by default
*/
public function get_default_methods()
{
$default_methods = array();
foreach ($this->notification_methods as $method)
{
if ($method->is_enabled_by_default() && $method->is_available())
{
$default_methods[] = $method->get_type();
}
}
return $default_methods;
} }
/** /**
@ -977,4 +908,24 @@ class manager
return $notification_type_ids; return $notification_type_ids;
} }
/**
* Find the users which are already notified
*
* @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 retrieve all item types
* @param array $options
* @return array The list of the notified users
*/
public function get_notified_users($notification_type_name, array $options)
{
$notification_type_id = $this->get_notification_type_id($notification_type_name);
$notified_users = array();
foreach ($this->get_available_subscription_methods() as $method)
{
$notified_users = $notified_users + $method->get_notified_users($notification_type_id, $options);
}
return $notified_users;
}
} }

View file

@ -93,6 +93,36 @@ abstract class base implements \phpbb\notification\method\method_interface
$this->notification_manager = $notification_manager; $this->notification_manager = $notification_manager;
} }
/**
* Is the method enable by default?
*
* @return bool
*/
public function is_enabled_by_default()
{
return false;
}
/**
* {@inheritdoc}
*/
public function get_notified_users($notification_type_id, array $options)
{
return array();
}
/**
* {@inheritdoc}
*/
public function load_notifications(array $options = array())
{
return array(
'notifications' => array(),
'unread_count' => 0,
'total_count' => 0,
);
}
/** /**
* Add a notification to the queue * Add a notification to the queue
* *
@ -103,6 +133,55 @@ abstract class base implements \phpbb\notification\method\method_interface
$this->queue[] = $notification; $this->queue[] = $notification;
} }
/**
* {@inheritdoc}
*/
public function update_notification($notification, array $data, array $options)
{
}
/**
* {@inheritdoc
*/
public function mark_notifications($notification_type_id, $item_id, $user_id, $time = false, $mark_read = true)
{
}
/**
* {@inheritdoc}
*/
public function mark_notifications_by_parent($notification_type_id, $item_parent_id, $user_id, $time = false, $mark_read = true)
{
}
/**
* {@inheritdoc}
*/
public function mark_notifications_by_id($notification_id, $time = false, $mark_read = true)
{
}
/**
* {@inheritdoc}
*/
public function delete_notifications($notification_type_id, $item_id, $parent_id = false, $user_id = false)
{
}
/**
* {@inheritdoc}
*/
public function prune_notifications($timestamp, $only_read = true)
{
}
/**
* {@inheritdoc}
*/
public function purge_notifications($notification_type_id)
{
}
/** /**
* Empty the queue * Empty the queue
*/ */

View file

@ -0,0 +1,390 @@
<?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\method;
/**
* In Board notification method class
* This class handles in board notifications. This method is enabled by default.
*
* @package notifications
*/
class board extends \phpbb\notification\method\base
{
/** @var string */
protected $notification_types_table;
/** @var string */
protected $notifications_table;
/**
* Notification Method Board Constructor
*
* @param \phpbb\user_loader $user_loader
* @param \phpbb\db\driver\driver_interface $db
* @param \phpbb\cache\driver\driver_interface $cache
* @param \phpbb\user $user
* @param \phpbb\auth\auth $auth
* @param \phpbb\config\config $config
* @param string $phpbb_root_path
* @param string $php_ext
* @param string $notification_types_table
* @param string $notifications_table
* @return \phpbb\notification\method\board
*/
public function __construct(\phpbb\user_loader $user_loader, \phpbb\db\driver\driver_interface $db, \phpbb\cache\driver\driver_interface $cache, $user, \phpbb\auth\auth $auth, \phpbb\config\config $config, $phpbb_root_path, $php_ext, $notification_types_table, $notifications_table)
{
$this->user_loader = $user_loader;
$this->db = $db;
$this->cache = $cache;
$this->user = $user;
$this->auth = $auth;
$this->config = $config;
$this->phpbb_root_path = $phpbb_root_path;
$this->php_ext = $php_ext;
$this->notification_types_table = $notification_types_table;
$this->notifications_table = $notifications_table;
}
/**
* {@inheritdoc}
*/
public function add_to_queue(\phpbb\notification\type\type_interface $notification)
{
$this->queue[] = $notification;
}
/**
* {@inheritdoc}
*/
public function get_type()
{
return 'notification.method.board';
}
/**
* {@inheritdoc}
*/
public function is_available()
{
return $this->config['allow_board_notifications'];
}
/**
* {@inheritdoc}
*/
public function is_enabled_by_default()
{
return true;
}
/**
* {@inheritdoc}
*/
public function get_notified_users($notification_type_id, array $options)
{
$notified_users = array();
$sql = 'SELECT n.*
FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt
WHERE n.notification_type_id = ' . (int) $notification_type_id .
(isset($options['item_id']) ? ' AND n.item_id = ' . (int) $options['item_id'] : '') .
(isset($options['item_parent_id']) ? ' AND n.item_parent_id = ' . (int) $options['item_parent_id'] : '') .
(isset($options['user_id']) ? ' AND n.user_id = ' . (int) $options['user_id'] : '') .
(isset($options['read']) ? ' AND n.notification_read = ' . (int) $options['read'] : '') .'
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))
{
$notified_users[$row['user_id']] = $row;
}
$this->db->sql_freeresult($result);
return $notified_users;
}
/**
* {@inheritdoc}
*/
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->notification_manager->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->notification_manager->get_item_type_class($item_type);
$item_class->load_special($data, $notifications);
}
}
return array(
'notifications' => $notifications,
'unread_count' => $unread_count,
'total_count' => $total_count,
);
}
/**
* {@inheritdoc}
*/
public function notify()
{
$insert_buffer = new \phpbb\db\sql_insert_buffer($this->db, $this->notifications_table);
foreach ($this->queue as $notification)
{
$data = $notification->get_insert_array();
$insert_buffer->insert($data);
}
$insert_buffer->flush();
// We're done, empty the queue
$this->empty_queue();
}
/**
* {@inheritdoc}
*/
public function update_notification($notification, array $data, array $options)
{
// 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->notification_manager->get_notification_type_id($notification->get_type());
$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 .
(isset($options['item_id']) ? ' AND item_id = ' . (int) $options['item_id'] : '') .
(isset($options['item_parent_id']) ? ' AND item_parent_id = ' . (int) $options['item_parent_id'] : '') .
(isset($options['user_id']) ? ' AND user_id = ' . (int) $options['user_id'] : '') .
(isset($options['read']) ? ' AND notification_read = ' . (int) $options['read'] : '');
$this->db->sql_query($sql);
}
/**
* {@inheritdoc}
*/
public function mark_notifications($notification_type_id, $item_id, $user_id, $time = false, $mark_read = true)
{
$time = ($time !== false) ? $time : time();
$sql = 'UPDATE ' . $this->notifications_table . '
SET notification_read = ' . ($mark_read ? 1 : 0) . '
WHERE notification_time <= ' . (int) $time .
(($notification_type_id !== false) ? ' AND ' .
(is_array($notification_type_id) ? $this->db->sql_in_set('notification_type_id', $notification_type_id) : 'notification_type_id = ' . $notification_type_id) : '') .
(($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);
}
/**
* {@inheritdoc}
*/
public function mark_notifications_by_parent($notification_type_id, $item_parent_id, $user_id, $time = false, $mark_read = true)
{
$time = ($time !== false) ? $time : time();
$sql = 'UPDATE ' . $this->notifications_table . '
SET notification_read = ' . ($mark_read ? 1 : 0) . '
WHERE notification_time <= ' . (int) $time .
(($notification_type_id !== false) ? ' AND ' .
(is_array($notification_type_id) ? $this->db->sql_in_set('notification_type_id', $notification_type_id) : 'notification_type_id = ' . $notification_type_id) : '') .
(($item_parent_id !== false) ? ' AND ' . (is_array($item_parent_id) ? $this->db->sql_in_set('item_parent_id', $item_parent_id, false, true) : '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);
}
/**
* {@inheritdoc}
*/
public function mark_notifications_by_id($notification_id, $time = false, $mark_read = true)
{
$time = ($time !== false) ? $time : time();
$sql = 'UPDATE ' . $this->notifications_table . '
SET notification_read = ' . ($mark_read ? 1 : 0) . '
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);
}
/**
* {@inheritdoc}
*/
public function delete_notifications($notification_type_id, $item_id, $parent_id = false, $user_id = false)
{
$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)) : '') .
(($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);
}
/**
* {@inheritdoc}
*/
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);
}
/**
* {@inheritdoc}
*/
public function purge_notifications($notification_type_id)
{
$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');
}
}

View file

@ -25,12 +25,48 @@ interface method_interface
*/ */
public function get_type(); public function get_type();
/**
* Is the method enable by default?
*
* @return bool
*/
public function is_enabled_by_default();
/** /**
* Is this method available for the user? * Is this method available for the user?
* This is checked on the notifications options * This is checked on the notifications options
*/ */
public function is_available(); public function is_available();
/**
* Return the list of the users already notified
*
* @param int $notification_type_id Type of the notification
* @param array $options
* @return array User
*/
public function get_notified_users($notification_type_id, array $options);
/**
* 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());
/** /**
* Add a notification to the queue * Add a notification to the queue
* *
@ -42,4 +78,72 @@ interface method_interface
* Parse the queue and notify the users * Parse the queue and notify the users
*/ */
public function notify(); public function notify();
/**
* Update a notification
*
* @param \phpbb\notification\type\type_interface $notification Notification to update
* @param array $data Data specific for this type that will be updated
* @param array $options
*/
public function update_notification($notification, array $data, array $options);
/**
* Mark notifications read or unread
*
* @param bool|string $notification_type_id Type identifier of item 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)
* @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)
*/
public function mark_notifications($notification_type_id, $item_id, $user_id, $time = false, $mark_read = true);
/**
* Mark notifications read or unread from a parent identifier
*
* @param string $notification_type_id Type identifier of item 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)
* @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)
*/
public function mark_notifications_by_parent($notification_type_id, $item_parent_id, $user_id, $time = false, $mark_read = true);
/**
* Mark notifications read or unread
*
* @param int $notification_id Notification id 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)
* @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)
*/
public function mark_notifications_by_id($notification_id, $time = false, $mark_read = true);
/**
* Delete a notification
*
* @param string $notification_type_id Type identifier of item 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)
* @param mixed $user_id User id (Default: false; not checked)
*/
public function delete_notifications($notification_type_id, $item_id, $parent_id = false, $user_id = false);
/**
* 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);
/**
* 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_id Type identifier of the subscription
*/
public function purge_notifications($notification_type_id);
} }

View file

@ -164,6 +164,6 @@ class admin_activate_user extends \phpbb\notification\type\base
$this->set_data('user_actkey', $user['user_actkey']); $this->set_data('user_actkey', $user['user_actkey']);
$this->notification_time = $user['user_regdate']; $this->notification_time = $user['user_regdate'];
return parent::create_insert_array($user, $pre_create_data); parent::create_insert_array($user, $pre_create_data);
} }
} }

View file

@ -79,7 +79,7 @@ class approve_post extends \phpbb\notification\type\post
), $options); ), $options);
$users = array(); $users = array();
$users[$post['poster_id']] = array(''); $users[$post['poster_id']] = $this->notification_manager->get_default_methods();
return $this->get_authorised_recipients(array_keys($users), $post['forum_id'], array_merge($options, array( return $this->get_authorised_recipients(array_keys($users), $post['forum_id'], array_merge($options, array(
'item_type' => self::$notification_option['id'], 'item_type' => self::$notification_option['id'],
@ -107,21 +107,24 @@ class approve_post extends \phpbb\notification\type\post
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $post Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($post, $pre_create_data = array()) public function create_insert_array($post, $pre_create_data = array())
{ {
$this->set_data('post_subject', $post['post_subject']); $this->set_data('post_subject', $post['post_subject']);
$data = parent::create_insert_array($post, $pre_create_data); parent::create_insert_array($post, $pre_create_data);
$this->notification_time = $data['notification_time'] = time(); $this->notification_time = time();
}
/**
* {@inheritdoc}
*/
public function get_insert_array()
{
$data = parent::get_insert_array();
$data['notification_time'] = $this->notification_time;
return $data; return $data;
} }

View file

@ -79,7 +79,7 @@ class approve_topic extends \phpbb\notification\type\topic
), $options); ), $options);
$users = array(); $users = array();
$users[$post['poster_id']] = array(''); $users[$post['poster_id']] = $this->notification_manager->get_default_methods();
return $this->get_authorised_recipients(array_keys($users), $post['forum_id'], array_merge($options, array( return $this->get_authorised_recipients(array_keys($users), $post['forum_id'], array_merge($options, array(
'item_type' => self::$notification_option['id'], 'item_type' => self::$notification_option['id'],
@ -107,19 +107,23 @@ class approve_topic extends \phpbb\notification\type\topic
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $post Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($post, $pre_create_data = array()) public function create_insert_array($post, $pre_create_data = array())
{ {
$data = parent::create_insert_array($post, $pre_create_data);
$this->notification_time = $data['notification_time'] = time(); parent::create_insert_array($post, $pre_create_data);
$this->notification_time = time();
}
/**
* {@inheritdoc}
*/
public function get_insert_array()
{
$data = parent::get_insert_array();
$data['notification_time'] = $this->notification_time;
return $data; return $data;
} }

View file

@ -51,9 +51,6 @@ abstract class base implements \phpbb\notification\type\type_interface
/** @var string */ /** @var string */
protected $notification_types_table; protected $notification_types_table;
/** @var string */
protected $notifications_table;
/** @var string */ /** @var string */
protected $user_notifications_table; protected $user_notifications_table;
@ -100,11 +97,10 @@ abstract class base implements \phpbb\notification\type\type_interface
* @param string $phpbb_root_path * @param string $phpbb_root_path
* @param string $php_ext * @param string $php_ext
* @param string $notification_types_table * @param string $notification_types_table
* @param string $notifications_table
* @param string $user_notifications_table * @param string $user_notifications_table
* @return \phpbb\notification\type\base * @return \phpbb\notification\type\base
*/ */
public function __construct(\phpbb\user_loader $user_loader, \phpbb\db\driver\driver_interface $db, \phpbb\cache\driver\driver_interface $cache, $user, \phpbb\auth\auth $auth, \phpbb\config\config $config, $phpbb_root_path, $php_ext, $notification_types_table, $notifications_table, $user_notifications_table) public function __construct(\phpbb\user_loader $user_loader, \phpbb\db\driver\driver_interface $db, \phpbb\cache\driver\driver_interface $cache, $user, \phpbb\auth\auth $auth, \phpbb\config\config $config, $phpbb_root_path, $php_ext, $notification_types_table, $user_notifications_table)
{ {
$this->user_loader = $user_loader; $this->user_loader = $user_loader;
$this->db = $db; $this->db = $db;
@ -117,7 +113,6 @@ abstract class base implements \phpbb\notification\type\type_interface
$this->php_ext = $php_ext; $this->php_ext = $php_ext;
$this->notification_types_table = $notification_types_table; $this->notification_types_table = $notification_types_table;
$this->notifications_table = $notifications_table;
$this->user_notifications_table = $user_notifications_table; $this->user_notifications_table = $user_notifications_table;
} }
@ -207,12 +202,7 @@ abstract class base implements \phpbb\notification\type\type_interface
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $type_data Data unique to this notification type
* @param array $pre_create_data Data from pre_create_insert_array()
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($type_data, $pre_create_data = array()) public function create_insert_array($type_data, $pre_create_data = array())
{ {
@ -227,7 +217,13 @@ abstract class base implements \phpbb\notification\type\type_interface
'notification_data' => array(), 'notification_data' => array(),
), $this->data); ), $this->data);
}
/**
* {@inheritdoc}
*/
public function get_insert_array()
{
$data = $this->data; $data = $this->data;
$data['notification_data'] = serialize($data['notification_data']); $data['notification_data'] = serialize($data['notification_data']);
@ -244,7 +240,8 @@ abstract class base implements \phpbb\notification\type\type_interface
*/ */
public function create_update_array($type_data) public function create_update_array($type_data)
{ {
$data = $this->create_insert_array($type_data); $this->create_insert_array($type_data);
$data = $this->get_insert_array();
// Unset data unique to each row // Unset data unique to each row
unset( unset(
@ -497,8 +494,8 @@ abstract class base implements \phpbb\notification\type\type_interface
{ {
if (!in_array($user_id, $resulting_user_ids) && !isset($options['ignore_users'][$user_id])) if (!in_array($user_id, $resulting_user_ids) && !isset($options['ignore_users'][$user_id]))
{ {
// No rows at all for this user, default to '' // No rows at all for this user, use the default methods
$rowset[$user_id] = array(''); $rowset[$user_id] = $this->notification_manager->get_default_methods();
} }
} }
@ -516,22 +513,21 @@ abstract class base implements \phpbb\notification\type\type_interface
{ {
$this->notification_read = (bool) !$unread; $this->notification_read = (bool) !$unread;
if ($return)
{
$where = array( $where = array(
'notification_type_id = ' . (int) $this->notification_type_id, 'notification_type_id = ' . (int) $this->notification_type_id,
'item_id = ' . (int) $this->item_id, 'item_id = ' . (int) $this->item_id,
'user_id = ' . (int) $this->user_id, 'user_id = ' . (int) $this->user_id,
); );
$where = implode(' AND ', $where);
if ($return) $where = implode(' AND ', $where);
{
return $where; return $where;
} }
else
$sql = 'UPDATE ' . $this->notifications_table . ' {
SET notification_read = ' . (int) $this->notification_read . ' $this->notification_manager->mark_notifications($this->get_type(), (int) $this->item_id, (int) $this->user_id, $this->notification_read);
WHERE ' . $where; }
$this->db->sql_query($sql);
} }
/** /**

View file

@ -91,31 +91,26 @@ class bookmark extends \phpbb\notification\type\post
} }
// Try to find the users who already have been notified about replies and have not read the topic since and just update their notifications // Try to find the users who already have been notified about replies and have not read the topic since and just update their notifications
$update_notifications = array(); $notified_users = $this->notification_manager->get_notified_users($this->get_type(), array(
$sql = 'SELECT n.* 'item_parent_id' => self::get_item_parent_id($post),
FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt 'read' => 0,
WHERE n.notification_type_id = ' . (int) $this->notification_type_id . ' ));
AND n.item_parent_id = ' . (int) self::get_item_parent_id($post) . '
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);
while ($row = $this->db->sql_fetchrow($result))
{
// Do not create a new notification
unset($notify_users[$row['user_id']]);
$notification = $this->notification_manager->get_item_type_class($this->get_type(), $row); foreach ($notified_users as $user => $notification_data)
{
unset($notify_users[$user]);
$notification = $this->notification_manager->get_item_type_class($this->get_type(), $notification_data);
$update_responders = $notification->add_responders($post); $update_responders = $notification->add_responders($post);
if (!empty($update_responders)) if (!empty($update_responders))
{ {
$sql = 'UPDATE ' . $this->notifications_table . ' $this->notification_manager->update_notification($notification, $update_responders, array(
SET ' . $this->db->sql_build_array('UPDATE', $update_responders) . ' 'item_parent_id' => self::get_item_parent_id($post),
WHERE notification_id = ' . $row['notification_id']; 'read' => 0,
$this->db->sql_query($sql); 'user_id' => $user,
));
} }
} }
$this->db->sql_freeresult($result);
return $notify_users; return $notify_users;
} }

View file

@ -125,21 +125,24 @@ class disapprove_post extends \phpbb\notification\type\approve_post
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $post Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($post, $pre_create_data = array()) public function create_insert_array($post, $pre_create_data = array())
{ {
$this->set_data('disapprove_reason', $post['disapprove_reason']); $this->set_data('disapprove_reason', $post['disapprove_reason']);
$data = parent::create_insert_array($post); parent::create_insert_array($post, $pre_create_data);
$this->notification_time = $data['notification_time'] = time(); $this->notification_time = time();
}
/**
* {@inheritdoc}
*/
public function get_insert_array()
{
$data = parent::get_insert_array();
$data['notification_time'] = $this->notification_time;
return $data; return $data;
} }

View file

@ -125,21 +125,24 @@ class disapprove_topic extends \phpbb\notification\type\approve_topic
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $post Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($post, $pre_create_data = array()) public function create_insert_array($post, $pre_create_data = array())
{ {
$this->set_data('disapprove_reason', $post['disapprove_reason']); $this->set_data('disapprove_reason', $post['disapprove_reason']);
$data = parent::create_insert_array($post, $pre_create_data); parent::create_insert_array($post, $pre_create_data);
$this->notification_time = $data['notification_time'] = time(); $this->notification_time = time();
}
/**
* {@inheritdoc}
*/
public function get_insert_array()
{
$data = parent::get_insert_array();
$data['notification_time'] = $this->notification_time;
return $data; return $data;
} }

View file

@ -156,6 +156,6 @@ class group_request extends \phpbb\notification\type\base
{ {
$this->set_data('group_name', $group['group_name']); $this->set_data('group_name', $group['group_name']);
return parent::create_insert_array($group, $pre_create_data); parent::create_insert_array($group, $pre_create_data);
} }
} }

View file

@ -58,7 +58,7 @@ class group_request_approved extends \phpbb\notification\type\base
foreach ($group['user_ids'] as $user_id) foreach ($group['user_ids'] as $user_id)
{ {
$users[$user_id] = array(''); $users[$user_id] = $this->notification_manager->get_default_methods();
} }
return $users; return $users;
@ -87,7 +87,7 @@ class group_request_approved extends \phpbb\notification\type\base
{ {
$this->set_data('group_name', $group['group_name']); $this->set_data('group_name', $group['group_name']);
return parent::create_insert_array($group, $pre_create_data); parent::create_insert_array($group, $pre_create_data);
} }
/** /**

View file

@ -176,13 +176,7 @@ class pm extends \phpbb\notification\type\base
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $pm Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($pm, $pre_create_data = array()) public function create_insert_array($pm, $pre_create_data = array())
{ {
@ -190,6 +184,6 @@ class pm extends \phpbb\notification\type\base
$this->set_data('message_subject', $pm['message_subject']); $this->set_data('message_subject', $pm['message_subject']);
return parent::create_insert_array($pm, $pre_create_data); parent::create_insert_array($pm, $pre_create_data);
} }
} }

View file

@ -131,31 +131,26 @@ class post extends \phpbb\notification\type\base
} }
// Try to find the users who already have been notified about replies and have not read the topic since and just update their notifications // Try to find the users who already have been notified about replies and have not read the topic since and just update their notifications
$update_notifications = array(); $notified_users = $this->notification_manager->get_notified_users($this->get_type(), array(
$sql = 'SELECT n.* 'item_parent_id' => self::get_item_parent_id($post),
FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt 'read' => 0,
WHERE n.notification_type_id = ' . (int) $this->notification_type_id . ' ));
AND n.item_parent_id = ' . (int) self::get_item_parent_id($post) . '
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);
while ($row = $this->db->sql_fetchrow($result))
{
// Do not create a new notification
unset($notify_users[$row['user_id']]);
$notification = $this->notification_manager->get_item_type_class($this->get_type(), $row); foreach ($notified_users as $user => $notification_data)
{
unset($notify_users[$user]);
$notification = $this->notification_manager->get_item_type_class($this->get_type(), $notification_data);
$update_responders = $notification->add_responders($post); $update_responders = $notification->add_responders($post);
if (!empty($update_responders)) if (!empty($update_responders))
{ {
$sql = 'UPDATE ' . $this->notifications_table . ' $this->notification_manager->update_notification($notification, $update_responders, array(
SET ' . $this->db->sql_build_array('UPDATE', $update_responders) . ' 'item_parent_id' => self::get_item_parent_id($post),
WHERE notification_id = ' . $row['notification_id']; 'read' => 0,
$this->db->sql_query($sql); 'user_id' => $user,
));
} }
} }
$this->db->sql_freeresult($result);
return $notify_users; return $notify_users;
} }
@ -363,13 +358,7 @@ class post extends \phpbb\notification\type\base
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $post Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($post, $pre_create_data = array()) public function create_insert_array($post, $pre_create_data = array())
{ {
@ -394,7 +383,7 @@ class post extends \phpbb\notification\type\base
$this->notification_read = true; $this->notification_read = true;
} }
return parent::create_insert_array($post, $pre_create_data); parent::create_insert_array($post, $pre_create_data);
} }
/** /**

View file

@ -131,19 +131,22 @@ class post_in_queue extends \phpbb\notification\type\post
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $post Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($post, $pre_create_data = array()) public function create_insert_array($post, $pre_create_data = array())
{ {
$data = parent::create_insert_array($post, $pre_create_data); parent::create_insert_array($post, $pre_create_data);
$this->notification_time = $data['notification_time'] = time(); $this->notification_time = time();
}
/**
* {@inheritdoc}
*/
public function get_insert_array()
{
$data = parent::get_insert_array();
$data['notification_time'] = $this->notification_time;
return $data; return $data;
} }

View file

@ -109,22 +109,12 @@ class quote extends \phpbb\notification\type\post
*/ */
public function update_notifications($post) public function update_notifications($post)
{ {
$old_notifications = array(); $old_notifications = $this->notification_manager->get_notified_users($this->get_type(), array(
$sql = 'SELECT n.user_id 'item_id' => self::get_item_id($post),
FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt ));
WHERE n.notification_type_id = ' . (int) $this->notification_type_id . '
AND n.item_id = ' . self::get_item_id($post) . '
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))
{
$old_notifications[] = $row['user_id'];
}
$this->db->sql_freeresult($result);
// Find the new users to notify // Find the new users to notify
$notifications = $this->find_users_for_notification($post); $notifications = array_keys($this->find_users_for_notification($post));
// Find the notifications we must delete // Find the notifications we must delete
$remove_notifications = array_diff($old_notifications, array_keys($notifications)); $remove_notifications = array_diff($old_notifications, array_keys($notifications));
@ -142,11 +132,7 @@ class quote extends \phpbb\notification\type\post
// Remove the necessary notifications // Remove the necessary notifications
if (!empty($remove_notifications)) if (!empty($remove_notifications))
{ {
$sql = 'DELETE FROM ' . $this->notifications_table . ' $this->notification_manager->delete_notifications($this->get_type(), self::get_item_id($post), false, $remove_notifications);
WHERE notification_type_id = ' . (int) $this->notification_type_id . '
AND item_id = ' . self::get_item_id($post) . '
AND ' . $this->db->sql_in_set('user_id', $remove_notifications);
$this->db->sql_query($sql);
} }
// return true to continue with the update code in the notifications service (this will update the rest of the notifications) // return true to continue with the update code in the notifications service (this will update the rest of the notifications)

View file

@ -237,13 +237,7 @@ class report_pm extends \phpbb\notification\type\pm
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $post Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($post, $pre_create_data = array()) public function create_insert_array($post, $pre_create_data = array())
{ {
@ -252,6 +246,6 @@ class report_pm extends \phpbb\notification\type\pm
$this->set_data('reason_description', $post['reason_description']); $this->set_data('reason_description', $post['reason_description']);
$this->set_data('report_text', $post['report_text']); $this->set_data('report_text', $post['report_text']);
return parent::create_insert_array($post, $pre_create_data); parent::create_insert_array($post, $pre_create_data);
} }
} }

View file

@ -64,7 +64,7 @@ class report_pm_closed extends \phpbb\notification\type\pm
return array(); return array();
} }
return array($pm['reporter'] => array('')); return array($pm['reporter'] => $this->notification_manager->get_default_methods());
} }
/** /**
@ -144,21 +144,24 @@ class report_pm_closed extends \phpbb\notification\type\pm
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $pm PM Data
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($pm, $pre_create_data = array()) public function create_insert_array($pm, $pre_create_data = array())
{ {
$this->set_data('closer_id', $pm['closer_id']); $this->set_data('closer_id', $pm['closer_id']);
$data = parent::create_insert_array($pm, $pre_create_data); parent::create_insert_array($pm, $pre_create_data);
$this->notification_time = $data['notification_time'] = time(); $this->notification_time = time();
}
/**
* {@inheritdoc}
*/
public function get_insert_array()
{
$data = parent::get_insert_array();
$data['notification_time'] = $this->notification_time;
return $data; return $data;
} }

View file

@ -210,13 +210,7 @@ class report_post extends \phpbb\notification\type\post_in_queue
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $post Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($post, $pre_create_data = array()) public function create_insert_array($post, $pre_create_data = array())
{ {
@ -225,6 +219,6 @@ class report_post extends \phpbb\notification\type\post_in_queue
$this->set_data('reason_description', $post['reason_description']); $this->set_data('reason_description', $post['reason_description']);
$this->set_data('report_text', $post['report_text']); $this->set_data('report_text', $post['report_text']);
return parent::create_insert_array($post, $pre_create_data); parent::create_insert_array($post, $pre_create_data);
} }
} }

View file

@ -71,7 +71,7 @@ class report_post_closed extends \phpbb\notification\type\post
return array(); return array();
} }
return array($post['reporter'] => array('')); return array($post['reporter'] => $this->notification_manager->get_default_methods());
} }
/** /**
@ -151,21 +151,24 @@ class report_post_closed extends \phpbb\notification\type\post
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $post Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($post, $pre_create_data = array()) public function create_insert_array($post, $pre_create_data = array())
{ {
$this->set_data('closer_id', $post['closer_id']); $this->set_data('closer_id', $post['closer_id']);
$data = parent::create_insert_array($post, $pre_create_data); parent::create_insert_array($post, $pre_create_data);
$this->notification_time = $data['notification_time'] = time(); $this->notification_time = time();
}
/**
* {@inheritdoc}
*/
public function get_insert_array()
{
$data = parent::get_insert_array();
$data['notification_time'] = $this->notification_time;
return $data; return $data;
} }

View file

@ -263,13 +263,7 @@ class topic extends \phpbb\notification\type\base
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $post Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($post, $pre_create_data = array()) public function create_insert_array($post, $pre_create_data = array())
{ {
@ -290,6 +284,6 @@ class topic extends \phpbb\notification\type\base
$this->notification_read = true; $this->notification_read = true;
} }
return parent::create_insert_array($post, $pre_create_data); parent::create_insert_array($post, $pre_create_data);
} }
} }

View file

@ -123,19 +123,22 @@ class topic_in_queue extends \phpbb\notification\type\topic
} }
/** /**
* Function for preparing the data for insertion in an SQL query * {@inheritdoc}
* (The service handles insertion)
*
* @param array $topic Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($topic, $pre_create_data = array()) public function create_insert_array($topic, $pre_create_data = array())
{ {
$data = parent::create_insert_array($topic, $pre_create_data); parent::create_insert_array($topic, $pre_create_data);
$this->notification_time = $data['notification_time'] = time(); $this->notification_time = time();
}
/**
* {@inheritdoc}
*/
public function get_insert_array()
{
$data = parent::get_insert_array();
$data['notification_time'] = $this->notification_time;
return $data; return $data;
} }

View file

@ -177,14 +177,18 @@ interface type_interface
/** /**
* Function for preparing the data for insertion in an SQL query * Function for preparing the data for insertion in an SQL query
* (The service handles insertion)
* *
* @param array $type_data The type specific data * @param array $type_data The type specific data
* @param array $pre_create_data Data from pre_create_insert_array() * @param array $pre_create_data Data from pre_create_insert_array()
*/
public function create_insert_array($type_data, $pre_create_data);
/**
* Function for getting the data for insertion in an SQL query
* *
* @return array Array of data ready to be inserted into the database * @return array Array of data ready to be inserted into the database
*/ */
public function create_insert_array($type_data, $pre_create_data); public function get_insert_array();
/** /**
* Function for preparing the data for update in an SQL query * Function for preparing the data for update in an SQL query

View file

@ -16,7 +16,6 @@
<!-- BEGIN notification_methods --> <!-- BEGIN notification_methods -->
<th class="mark">{notification_methods.NAME}</th> <th class="mark">{notification_methods.NAME}</th>
<!-- END notification_methods --> <!-- END notification_methods -->
<th class="mark">{L_NOTIFICATIONS}</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
@ -34,7 +33,6 @@
<!-- BEGIN notification_methods --> <!-- BEGIN notification_methods -->
<td class="mark"><input type="checkbox" name="{notification_types.TYPE}_{notification_methods.METHOD}"<!-- IF notification_methods.SUBSCRIBED --> checked="checked"<!-- ENDIF --> /></td> <td class="mark"><input type="checkbox" name="{notification_types.TYPE}_{notification_methods.METHOD}"<!-- IF notification_methods.SUBSCRIBED --> checked="checked"<!-- ENDIF --> /></td>
<!-- END notification_methods --> <!-- END notification_methods -->
<td class="mark"><input type="checkbox" name="{notification_types.TYPE}_notification"<!-- IF notification_types.SUBSCRIBED --> checked="checked"<!-- ENDIF --> /></td>
</tr> </tr>
<!-- ENDIF --> <!-- ENDIF -->
<!-- END notification_types --> <!-- END notification_types -->

View file

@ -21,15 +21,15 @@ class phpbb_functional_notification_test extends phpbb_functional_test_case
return array( return array(
// Rows inserted by phpBB/install/schemas/schema_data.sql // Rows inserted by phpBB/install/schemas/schema_data.sql
// Also see PHPBB3-11460 // Also see PHPBB3-11460
array('notification.type.post_notification', true), array('notification.type.post_notification.method.board', true),
array('notification.type.topic_notification', true), array('notification.type.topic_notification.method.board', true),
array('notification.type.post_notification.method.email', true), array('notification.type.post_notification.method.email', true),
array('notification.type.topic_notification.method.email', true), array('notification.type.topic_notification.method.email', true),
// Default behaviour for in-board notifications: // Default behaviour for in-board notifications:
// If user did not opt-out, in-board notifications are on. // If user did not opt-out, in-board notifications are on.
array('notification.type.bookmark_notification', true), array('notification.type.bookmark_notification.method.board', true),
array('notification.type.quote_notification', true), array('notification.type.quote_notification.method.board', true),
// Default behaviour for email notifications: // Default behaviour for email notifications:
// If user did not opt-in, email notifications are off. // If user did not opt-in, email notifications are off.

View file

@ -52,7 +52,15 @@ class phpbb_mock_container_builder implements ContainerInterface
{ {
if ($this->has($id)) if ($this->has($id))
{ {
return $this->services[$id]; $service = $this->services[$id];
if (is_array($service) && is_callable($service[0]))
{
return call_user_func_array($service[0], $service[1]);
}
else
{
return $service;
}
} }
throw new Exception('Could not find service: ' . $id); throw new Exception('Could not find service: ' . $id);

View file

@ -32,19 +32,18 @@ class phpbb_mock_notification_manager
); );
} }
public function mark_notifications_read() public function mark_notifications()
{ {
} }
public function mark_notifications_read_by_parent() public function mark_notifications_by_parent()
{ {
} }
public function mark_notifications_read_by_id() public function mark_notifications_by_id()
{ {
} }
public function add_notifications() public function add_notifications()
{ {
return array(); return array();

View file

@ -21,7 +21,7 @@ if (!defined('IN_PHPBB'))
class phpbb_mock_notification_type_post extends \phpbb\notification\type\post class phpbb_mock_notification_type_post extends \phpbb\notification\type\post
{ {
public function __construct($user_loader, $db, $cache, $user, $auth, $config, $phpbb_root_path, $php_ext, $notification_types_table, $notifications_table, $user_notifications_table) public function __construct($user_loader, $db, $cache, $user, $auth, $config, $phpbb_root_path, $php_ext, $notification_types_table, $user_notifications_table)
{ {
$this->user_loader = $user_loader; $this->user_loader = $user_loader;
$this->db = $db; $this->db = $db;
@ -34,7 +34,6 @@ class phpbb_mock_notification_type_post extends \phpbb\notification\type\post
$this->php_ext = $php_ext; $this->php_ext = $php_ext;
$this->notification_types_table = $notification_types_table; $this->notification_types_table = $notification_types_table;
$this->notifications_table = $notifications_table;
$this->user_notifications_table = $user_notifications_table; $this->user_notifications_table = $user_notifications_table;
} }
} }

View file

@ -39,6 +39,13 @@ abstract class phpbb_tests_notification_base extends phpbb_database_test_case
); );
} }
protected function get_notification_methods()
{
return array(
'notification.method.board',
);
}
protected function setUp() protected function setUp()
{ {
parent::setUp(); parent::setUp();
@ -55,6 +62,7 @@ abstract class phpbb_tests_notification_base extends phpbb_database_test_case
'allow_bookmarks' => true, 'allow_bookmarks' => true,
'allow_topic_notify' => true, 'allow_topic_notify' => true,
'allow_forum_notify' => true, 'allow_forum_notify' => true,
'allow_board_notifications' => true,
)); ));
$lang_loader = new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx); $lang_loader = new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx);
$lang = new \phpbb\language\language($lang_loader); $lang = new \phpbb\language\language($lang_loader);
@ -87,7 +95,6 @@ abstract class phpbb_tests_notification_base extends phpbb_database_test_case
$phpbb_root_path, $phpbb_root_path,
$phpEx, $phpEx,
'phpbb_notification_types', 'phpbb_notification_types',
'phpbb_notifications',
'phpbb_user_notifications' 'phpbb_user_notifications'
); );
@ -107,6 +114,18 @@ abstract class phpbb_tests_notification_base extends phpbb_database_test_case
$this->notifications->set_var('notification_types', $types); $this->notifications->set_var('notification_types', $types);
$methods = array();
foreach ($this->get_notification_methods() as $method)
{
$method_parts = explode('.', $method);
$class = $this->build_type('phpbb\notification\method\\' . array_pop($method_parts));
$methods[$method] = $class;
$this->container->set($method, $class);
}
$this->notifications->set_var('notification_methods', $methods);
$this->db->sql_query('DELETE FROM phpbb_notification_types'); $this->db->sql_query('DELETE FROM phpbb_notification_types');
$this->db->sql_query('DELETE FROM phpbb_notifications'); $this->db->sql_query('DELETE FROM phpbb_notifications');
$this->db->sql_query('DELETE FROM phpbb_user_notifications'); $this->db->sql_query('DELETE FROM phpbb_user_notifications');
@ -116,7 +135,7 @@ abstract class phpbb_tests_notification_base extends phpbb_database_test_case
{ {
global $phpbb_root_path, $phpEx; global $phpbb_root_path, $phpEx;
$instance = new $type($this->user_loader, $this->db, $this->cache->get_driver(), $this->user, $this->auth, $this->config, $phpbb_root_path, $phpEx, 'phpbb_notification_types', 'phpbb_notifications', 'phpbb_user_notifications'); $instance = new $type($this->user_loader, $this->db, $this->cache->get_driver(), $this->user, $this->auth, $this->config, $phpbb_root_path, $phpEx, 'phpbb_notification_types', 'phpbb_user_notifications');
if ($type === 'phpbb\\notification\\type\\quote') if ($type === 'phpbb\\notification\\type\\quote')
{ {
@ -126,9 +145,17 @@ abstract class phpbb_tests_notification_base extends phpbb_database_test_case
return $instance; return $instance;
} }
protected function build_method($method)
{
global $phpbb_root_path, $phpEx;
return new $method($this->user_loader, $this->db, $this->cache->get_driver(), $this->user, $this->auth, $this->config,
$phpbb_root_path, $phpEx, 'phpbb_notification_types', 'phpbb_notifications', 'phpbb_user_notifications');
}
protected function assert_notifications($expected, $options = array()) protected function assert_notifications($expected, $options = array())
{ {
$notifications = $this->notifications->load_notifications(array_merge(array( $notifications = $this->notifications->load_notifications('notification.method.board', array_merge(array(
'count_unread' => true, 'count_unread' => true,
'order_by' => 'notification_time', 'order_by' => 'notification_time',
'order_dir' => 'ASC', 'order_dir' => 'ASC',

View file

@ -47,12 +47,13 @@ class test extends \phpbb\notification\type\base
{ {
$this->notification_time = $post['post_time']; $this->notification_time = $post['post_time'];
return parent::create_insert_array($post, $pre_create_data); parent::create_insert_array($post, $pre_create_data);
} }
public function create_update_array($type_data) public function create_update_array($type_data)
{ {
$data = $this->create_insert_array($type_data); $this->create_insert_array($type_data);
$data = $this->get_insert_array();
// Unset data unique to each row // Unset data unique to each row
unset( unset(

View file

@ -126,35 +126,35 @@
<value>notification.type.bookmark</value> <value>notification.type.bookmark</value>
<value>0</value> <value>0</value>
<value>2</value> <value>2</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.bookmark</value> <value>notification.type.bookmark</value>
<value>0</value> <value>0</value>
<value>3</value> <value>3</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.bookmark</value> <value>notification.type.bookmark</value>
<value>0</value> <value>0</value>
<value>4</value> <value>4</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.bookmark</value> <value>notification.type.bookmark</value>
<value>0</value> <value>0</value>
<value>5</value> <value>5</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.bookmark</value> <value>notification.type.bookmark</value>
<value>0</value> <value>0</value>
<value>6</value> <value>6</value>
<value></value> <value>notification.method.board</value>
<value>0</value> <value>0</value>
</row> </row>
</table> </table>

View file

@ -156,49 +156,49 @@
<value>notification.type.post</value> <value>notification.type.post</value>
<value>0</value> <value>0</value>
<value>2</value> <value>2</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.post</value> <value>notification.type.post</value>
<value>0</value> <value>0</value>
<value>3</value> <value>3</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.post</value> <value>notification.type.post</value>
<value>0</value> <value>0</value>
<value>4</value> <value>4</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.post</value> <value>notification.type.post</value>
<value>0</value> <value>0</value>
<value>5</value> <value>5</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.post</value> <value>notification.type.post</value>
<value>0</value> <value>0</value>
<value>6</value> <value>6</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.post</value> <value>notification.type.post</value>
<value>0</value> <value>0</value>
<value>7</value> <value>7</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.post</value> <value>notification.type.post</value>
<value>0</value> <value>0</value>
<value>8</value> <value>8</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
</table> </table>

View file

@ -110,49 +110,49 @@
<value>notification.type.needs_approval</value> <value>notification.type.needs_approval</value>
<value>0</value> <value>0</value>
<value>2</value> <value>2</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.needs_approval</value> <value>notification.type.needs_approval</value>
<value>0</value> <value>0</value>
<value>3</value> <value>3</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.needs_approval</value> <value>notification.type.needs_approval</value>
<value>0</value> <value>0</value>
<value>4</value> <value>4</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.needs_approval</value> <value>notification.type.needs_approval</value>
<value>0</value> <value>0</value>
<value>5</value> <value>5</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.needs_approval</value> <value>notification.type.needs_approval</value>
<value>0</value> <value>0</value>
<value>6</value> <value>6</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.needs_approval</value> <value>notification.type.needs_approval</value>
<value>0</value> <value>0</value>
<value>7</value> <value>7</value>
<value></value> <value>notification.method.board</value>
<value>0</value> <value>0</value>
</row> </row>
<row> <row>
<value>notification.type.needs_approval</value> <value>notification.type.needs_approval</value>
<value>0</value> <value>0</value>
<value>9</value> <value>9</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
</table> </table>

View file

@ -98,35 +98,35 @@
<value>notification.type.quote</value> <value>notification.type.quote</value>
<value>0</value> <value>0</value>
<value>2</value> <value>2</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.quote</value> <value>notification.type.quote</value>
<value>0</value> <value>0</value>
<value>3</value> <value>3</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.quote</value> <value>notification.type.quote</value>
<value>0</value> <value>0</value>
<value>4</value> <value>4</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.quote</value> <value>notification.type.quote</value>
<value>0</value> <value>0</value>
<value>5</value> <value>5</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.quote</value> <value>notification.type.quote</value>
<value>0</value> <value>0</value>
<value>6</value> <value>6</value>
<value></value> <value>notification.method.board</value>
<value>0</value> <value>0</value>
</row> </row>
</table> </table>

View file

@ -106,28 +106,28 @@
<value>notification.type.topic</value> <value>notification.type.topic</value>
<value>0</value> <value>0</value>
<value>2</value> <value>2</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.topic</value> <value>notification.type.topic</value>
<value>0</value> <value>0</value>
<value>6</value> <value>6</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.topic</value> <value>notification.type.topic</value>
<value>0</value> <value>0</value>
<value>7</value> <value>7</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
<row> <row>
<value>notification.type.topic</value> <value>notification.type.topic</value>
<value>0</value> <value>0</value>
<value>8</value> <value>8</value>
<value></value> <value>notification.method.board</value>
<value>1</value> <value>1</value>
</row> </row>
</table> </table>

View file

@ -46,7 +46,7 @@ class phpbb_notification_manager_helper extends \phpbb\notification\manager
$item_parts = explode('.', $item_type); $item_parts = explode('.', $item_type);
$item_type = 'phpbb\notification\type\\' . array_pop($item_parts); $item_type = 'phpbb\notification\type\\' . array_pop($item_parts);
$item = new $item_type($this->user_loader, $this->db, $this->cache->get_driver(), $this->user, $this->auth, $this->config, $this->phpbb_root_path, $this->php_ext, $this->notification_types_table, $this->notifications_table, $this->user_notifications_table); $item = new $item_type($this->user_loader, $this->db, $this->cache->get_driver(), $this->user, $this->auth, $this->config, $this->phpbb_root_path, $this->php_ext, $this->notification_types_table, $this->user_notifications_table);
if ($item_type === 'phpbb\\notification\\type\\quote') if ($item_type === 'phpbb\\notification\\type\\quote')
{ {
@ -65,9 +65,10 @@ class phpbb_notification_manager_helper extends \phpbb\notification\manager
*/ */
public function get_method_class($method_name) public function get_method_class($method_name)
{ {
$method_name = 'phpbb\notification\method\\' . $method_name; $method_parts = explode('.', $method_name);
$method_name = 'phpbb\notification\method\\' . array_pop($method_parts);
$method = new $method_name($this->user_loader, $this->db, $this->cache->get_driver(), $this->user, $this->auth, $this->config, $this->phpbb_root_path, $this->php_ext, $this->notification_types_table, $this->notifications_table, $this->user_notifications_table); $method = new $method_name($this->user_loader, $this->db, $this->cache->get_driver(), $this->user, $this->auth, $this->config, $this->phpbb_root_path, $this->php_ext, $this->notification_types_table, NOTIFICATIONS_TABLE, $this->user_notifications_table);
$method->set_notification_manager($this); $method->set_notification_manager($this);

View file

@ -29,7 +29,7 @@ class phpbb_notification_test extends phpbb_tests_notification_base
$quote_type_id = $this->notifications->get_notification_type_id('notification.type.quote'); $quote_type_id = $this->notifications->get_notification_type_id('notification.type.quote');
$test_type_id = $this->notifications->get_notification_type_id('test'); $test_type_id = $this->notifications->get_notification_type_id('test');
$this->assertEquals(array( self::assertEquals(array(
'test' => $test_type_id, 'test' => $test_type_id,
'notification.type.quote' => $quote_type_id, 'notification.type.quote' => $quote_type_id,
'notification.type.post' => $post_type_id, 'notification.type.post' => $post_type_id,
@ -40,13 +40,13 @@ class phpbb_notification_test extends phpbb_tests_notification_base
'notification.type.post', 'notification.type.post',
) )
)); ));
$this->assertEquals($quote_type_id, $this->notifications->get_notification_type_id('notification.type.quote')); self::assertEquals($quote_type_id, $this->notifications->get_notification_type_id('notification.type.quote'));
try try
{ {
$this->assertEquals(false, $this->notifications->get_notification_type_id('fail')); self::assertEquals(false, $this->notifications->get_notification_type_id('fail'));
$this->fail('Non-existent type should throw an exception'); self::fail('Non-existent type should throw an exception');
} }
catch (Exception $e) {} catch (Exception $e) {}
} }
@ -55,15 +55,15 @@ class phpbb_notification_test extends phpbb_tests_notification_base
{ {
$subscription_types = $this->notifications->get_subscription_types(); $subscription_types = $this->notifications->get_subscription_types();
$this->assertArrayHasKey('NOTIFICATION_GROUP_MISCELLANEOUS', $subscription_types); self::assertArrayHasKey('NOTIFICATION_GROUP_MISCELLANEOUS', $subscription_types);
$this->assertArrayHasKey('NOTIFICATION_GROUP_POSTING', $subscription_types); self::assertArrayHasKey('NOTIFICATION_GROUP_POSTING', $subscription_types);
$this->assertArrayHasKey('notification.type.bookmark', $subscription_types['NOTIFICATION_GROUP_POSTING']); self::assertArrayHasKey('notification.type.bookmark', $subscription_types['NOTIFICATION_GROUP_POSTING']);
$this->assertArrayHasKey('notification.type.post', $subscription_types['NOTIFICATION_GROUP_POSTING']); self::assertArrayHasKey('notification.type.post', $subscription_types['NOTIFICATION_GROUP_POSTING']);
$this->assertArrayHasKey('notification.type.quote', $subscription_types['NOTIFICATION_GROUP_POSTING']); self::assertArrayHasKey('notification.type.quote', $subscription_types['NOTIFICATION_GROUP_POSTING']);
$this->assertArrayHasKey('notification.type.topic', $subscription_types['NOTIFICATION_GROUP_POSTING']); self::assertArrayHasKey('notification.type.topic', $subscription_types['NOTIFICATION_GROUP_POSTING']);
$this->assertArrayHasKey('notification.type.pm', $subscription_types['NOTIFICATION_GROUP_MISCELLANEOUS']); self::assertArrayHasKey('notification.type.pm', $subscription_types['NOTIFICATION_GROUP_MISCELLANEOUS']);
//get_subscription_types //get_subscription_types
//get_subscription_methods //get_subscription_methods
@ -72,12 +72,12 @@ class phpbb_notification_test extends phpbb_tests_notification_base
public function test_subscriptions() public function test_subscriptions()
{ {
$expected_subscriptions = array( $expected_subscriptions = array(
'notification.type.post' => array(''), 'notification.type.post' => array('notification.method.board'),
'notification.type.topic' => array(''), 'notification.type.topic' => array('notification.method.board'),
'notification.type.quote' => array(''), 'notification.type.quote' => array('notification.method.board'),
'notification.type.bookmark' => array(''), 'notification.type.bookmark' => array('notification.method.board'),
'test' => array(''), 'test' => array('notification.method.board'),
'notification.type.pm' => array(''), 'notification.type.pm' => array('notification.method.board'),
); );
$subscriptions = $this->notifications->get_global_subscriptions(2); $subscriptions = $this->notifications->get_global_subscriptions(2);
@ -92,13 +92,13 @@ class phpbb_notification_test extends phpbb_tests_notification_base
$this->assert_array_content_equals($methods, $expected_subscriptions[$item_type]); $this->assert_array_content_equals($methods, $expected_subscriptions[$item_type]);
} }
$this->notifications->delete_subscription('notification.type.post', 0, '', 2); $this->notifications->delete_subscription('notification.type.post', 0, 'notification.method.board', 2);
$this->assertArrayNotHasKey('notification.type.post', $this->notifications->get_global_subscriptions(2)); self::assertArrayNotHasKey('notification.type.post', $this->notifications->get_global_subscriptions(2));
$this->notifications->add_subscription('notification.type.post', 0, '', 2); $this->notifications->add_subscription('notification.type.post', 0, 'notification.method.board', 2);
$this->assertArrayHasKey('notification.type.post', $this->notifications->get_global_subscriptions(2)); self::assertArrayHasKey('notification.type.post', $this->notifications->get_global_subscriptions(2));
} }
public function test_notifications() public function test_notifications()
@ -124,11 +124,11 @@ class phpbb_notification_test extends phpbb_tests_notification_base
'user_id' => 0, 'user_id' => 0,
))); )));
$this->assertEquals(array( self::assertEquals(array(
'notifications' => array(), 'notifications' => array(),
'unread_count' => 0, 'unread_count' => 0,
'total_count' => 0, 'total_count' => 0,
), $this->notifications->load_notifications(array( ), $this->notifications->load_notifications('notification.method.board', array(
'count_unread' => true, 'count_unread' => true,
))); )));

View file

@ -50,7 +50,7 @@ abstract class phpbb_notification_submit_post_base extends phpbb_database_test_c
{ {
parent::setUp(); parent::setUp();
global $auth, $cache, $config, $db, $phpbb_container, $phpbb_dispatcher, $user, $request, $phpEx, $phpbb_root_path; global $auth, $cache, $config, $db, $phpbb_container, $phpbb_dispatcher, $user, $request, $phpEx, $phpbb_root_path, $user_loader;
// Database // Database
$this->db = $this->new_dbal(); $this->db = $this->new_dbal();
@ -69,7 +69,11 @@ abstract class phpbb_notification_submit_post_base extends phpbb_database_test_c
))); )));
// Config // Config
$config = new \phpbb\config\config(array('num_topics' => 1,'num_posts' => 1,)); $config = new \phpbb\config\config(array(
'num_topics' => 1,
'num_posts' => 1,
'allow_board_notifications' => true,
));
$cache = new \phpbb\cache\service( $cache = new \phpbb\cache\service(
new \phpbb\cache\driver\dummy(), new \phpbb\cache\driver\dummy(),
@ -111,28 +115,44 @@ abstract class phpbb_notification_submit_post_base extends phpbb_database_test_c
$notification_types_array = array(); $notification_types_array = array();
foreach ($notification_types as $type) foreach ($notification_types as $type)
{ {
$class = $this->build_type($type);
$phpbb_container->set('notification.type.' . $type, array(array($this, 'build_type'), array($type)));
$notification_types_array['notification.type.' . $type] = $class;
}
// Methods Types
$class_name = 'phpbb\notification\method\board';
$class = new $class_name(
$user_loader, $db, $cache->get_driver(), $user, $auth, $config,
$phpbb_root_path, $phpEx,
NOTIFICATION_TYPES_TABLE, NOTIFICATIONS_TABLE);
$phpbb_container->set('notification.method.board', $class);
$notification_methods_array = array('notification.method.board' => $class);
// Notification Manager
$phpbb_notifications = new \phpbb\notification\manager($notification_types_array, $notification_methods_array,
$phpbb_container, $user_loader, $config, $phpbb_dispatcher, $db, $cache, $user,
$phpbb_root_path, $phpEx,
NOTIFICATION_TYPES_TABLE, USER_NOTIFICATIONS_TABLE);
$phpbb_container->set('notification_manager', $phpbb_notifications);
}
public function build_type($type)
{
global $auth, $cache, $config, $db, $phpbb_container, $phpbb_dispatcher, $user, $request, $phpEx, $phpbb_root_path, $user_loader;
$class_name = '\phpbb\notification\type\\' . $type; $class_name = '\phpbb\notification\type\\' . $type;
$class = new $class_name( $class = new $class_name(
$user_loader, $db, $cache->get_driver(), $user, $auth, $config, $user_loader, $db, $cache->get_driver(), $user, $auth, $config,
$phpbb_root_path, $phpEx, $phpbb_root_path, $phpEx,
NOTIFICATION_TYPES_TABLE, NOTIFICATIONS_TABLE, USER_NOTIFICATIONS_TABLE); NOTIFICATION_TYPES_TABLE, USER_NOTIFICATIONS_TABLE);
if ($type === 'quote') if ($type === 'quote')
{ {
$class->set_utils(new \phpbb\textformatter\s9e\utils); $class->set_utils(new \phpbb\textformatter\s9e\utils);
} }
$phpbb_container->set('notification.type.' . $type, $class); return $class;
$notification_types_array['notification.type.' . $type] = $class;
}
// Notification Manager
$phpbb_notifications = new \phpbb\notification\manager($notification_types_array, array(),
$phpbb_container, $user_loader, $config, $phpbb_dispatcher, $db, $cache, $user,
$phpbb_root_path, $phpEx,
NOTIFICATION_TYPES_TABLE, NOTIFICATIONS_TABLE, USER_NOTIFICATIONS_TABLE);
$phpbb_container->set('notification_manager', $phpbb_notifications);
} }
/** /**
@ -157,4 +177,11 @@ abstract class phpbb_notification_submit_post_base extends phpbb_database_test_c
$this->assertEquals($expected_after, $this->db->sql_fetchrowset($result)); $this->assertEquals($expected_after, $this->db->sql_fetchrowset($result));
$this->db->sql_freeresult($result); $this->db->sql_freeresult($result);
} }
protected function build_method($method)
{
global $phpbb_root_path, $phpEx;
return new $method($this->user_loader, $this->db, $this->cache->get_driver(), $this->user, $this->auth, $this->config, $phpbb_root_path, $phpEx, 'phpbb_notification_types', 'phpbb_notifications', 'phpbb_user_notifications');
}
} }

View file

@ -61,7 +61,7 @@ class phpbb_notification_user_list_trim_test extends phpbb_database_test_case
$user_loader->load_users(array(2, 3, 4, 5, 6)); $user_loader->load_users(array(2, 3, 4, 5, 6));
$this->notification = new phpbb_mock_notification_type_post( $this->notification = new phpbb_mock_notification_type_post(
$user_loader, null, null, $user, null, null, $phpbb_root_path, $phpEx, null, null, null $user_loader, null, null, $user, null, null, $phpbb_root_path, $phpEx, null, null
); );
} }