Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | |
0.00% |
0 / 1 |
|
47.06% |
8 / 17 |
CRAP | |
57.35% |
39 / 68 |
topic | |
0.00% |
0 / 1 |
|
47.06% |
8 / 17 |
83.55 | |
57.35% |
39 / 68 |
get_type | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
set_config | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
set_user_loader | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
is_available | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
get_item_id | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
get_item_parent_id | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
find_users_for_notification | |
100.00% |
1 / 1 |
2 | |
100.00% |
13 / 13 |
|||
get_avatar | |
0.00% |
0 / 1 |
2.00 | |
0.00% |
0 / 1 |
|||
get_title | |
0.00% |
0 / 1 |
6.00 | |
0.00% |
0 / 6 |
|||
get_reference | |
0.00% |
0 / 1 |
2.00 | |
0.00% |
0 / 3 |
|||
get_forum | |
0.00% |
0 / 1 |
2.00 | |
0.00% |
0 / 3 |
|||
get_email_template | |
0.00% |
0 / 1 |
2.00 | |
0.00% |
0 / 1 |
|||
get_email_template_variables | |
0.00% |
0 / 1 |
6.00 | |
0.00% |
0 / 11 |
|||
get_url | |
0.00% |
0 / 1 |
2.00 | |
0.00% |
0 / 1 |
|||
users_to_query | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
pre_create_insert_array | |
0.00% |
0 / 1 |
4.10 | |
81.82% |
9 / 11 |
|||
create_insert_array | |
0.00% |
0 / 1 |
5.03 | |
88.89% |
8 / 9 |
<?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\type; | |
/** | |
* Topic notifications class | |
* This class handles notifications for new topics | |
*/ | |
class topic extends \phpbb\notification\type\base | |
{ | |
/** | |
* Get notification type name | |
* | |
* @return string | |
*/ | |
public function get_type() | |
{ | |
return 'notification.type.topic'; | |
} | |
/** | |
* Language key used to output the text | |
* | |
* @var string | |
*/ | |
protected $language_key = 'NOTIFICATION_TOPIC'; | |
/** | |
* Inherit notification read status from topic. | |
* | |
* @var bool | |
*/ | |
protected $inherit_read_status = true; | |
/** | |
* Notification option data (for outputting to the user) | |
* | |
* @var bool|array False if the service should use it's default data | |
* Array of data (including keys 'id', 'lang', and 'group') | |
*/ | |
static public $notification_option = array( | |
'lang' => 'NOTIFICATION_TYPE_TOPIC', | |
'group' => 'NOTIFICATION_GROUP_POSTING', | |
); | |
/** @var \phpbb\user_loader */ | |
protected $user_loader; | |
/** @var \phpbb\config\config */ | |
protected $config; | |
public function set_config(\phpbb\config\config $config) | |
{ | |
$this->config = $config; | |
} | |
public function set_user_loader(\phpbb\user_loader $user_loader) | |
{ | |
$this->user_loader = $user_loader; | |
} | |
/** | |
* Is available | |
*/ | |
public function is_available() | |
{ | |
return $this->config['allow_forum_notify']; | |
} | |
/** | |
* Get the id of the item | |
* | |
* @param array $post The data from the post | |
* @return int The topic id | |
*/ | |
static public function get_item_id($post) | |
{ | |
return (int) $post['topic_id']; | |
} | |
/** | |
* Get the id of the parent | |
* | |
* @param array $post The data from the post | |
* @return int The forum id | |
*/ | |
static public function get_item_parent_id($post) | |
{ | |
return (int) $post['forum_id']; | |
} | |
/** | |
* Find the users who want to receive notifications | |
* | |
* @param array $topic Data from the topic | |
* @param array $options Options for finding users for notification | |
* | |
* @return array | |
*/ | |
public function find_users_for_notification($topic, $options = array()) | |
{ | |
$options = array_merge(array( | |
'ignore_users' => array(), | |
), $options); | |
$users = array(); | |
$sql = 'SELECT user_id | |
FROM ' . FORUMS_WATCH_TABLE . ' | |
WHERE forum_id = ' . (int) $topic['forum_id'] . ' | |
AND notify_status = ' . NOTIFY_YES . ' | |
AND user_id <> ' . (int) $topic['poster_id']; | |
$result = $this->db->sql_query($sql); | |
while ($row = $this->db->sql_fetchrow($result)) | |
{ | |
$users[] = (int) $row['user_id']; | |
} | |
$this->db->sql_freeresult($result); | |
return $this->get_authorised_recipients($users, $topic['forum_id'], $options); | |
} | |
/** | |
* Get the user's avatar | |
*/ | |
public function get_avatar() | |
{ | |
return $this->user_loader->get_avatar($this->get_data('poster_id'), false, true); | |
} | |
/** | |
* Get the HTML formatted title of this notification | |
* | |
* @return string | |
*/ | |
public function get_title() | |
{ | |
if ($this->get_data('post_username')) | |
{ | |
$username = $this->get_data('post_username'); | |
} | |
else | |
{ | |
$username = $this->user_loader->get_username($this->get_data('poster_id'), 'no_profile'); | |
} | |
return $this->language->lang( | |
$this->language_key, | |
$username | |
); | |
} | |
/** | |
* Get the HTML formatted reference of the notification | |
* | |
* @return string | |
*/ | |
public function get_reference() | |
{ | |
return $this->language->lang( | |
'NOTIFICATION_REFERENCE', | |
censor_text($this->get_data('topic_title')) | |
); | |
} | |
/** | |
* Get the forum of the notification reference | |
* | |
* @return string | |
*/ | |
public function get_forum() | |
{ | |
return $this->language->lang( | |
'NOTIFICATION_FORUM', | |
$this->get_data('forum_name') | |
); | |
} | |
/** | |
* Get email template | |
* | |
* @return string|bool | |
*/ | |
public function get_email_template() | |
{ | |
return 'newtopic_notify'; | |
} | |
/** | |
* Get email template variables | |
* | |
* @return array | |
*/ | |
public function get_email_template_variables() | |
{ | |
$board_url = generate_board_url(); | |
if ($this->get_data('post_username')) | |
{ | |
$username = $this->get_data('post_username'); | |
} | |
else | |
{ | |
$username = $this->user_loader->get_username($this->get_data('poster_id'), 'username'); | |
} | |
return array( | |
'AUTHOR_NAME' => html_entity_decode($username, ENT_COMPAT), | |
'FORUM_NAME' => html_entity_decode($this->get_data('forum_name'), ENT_COMPAT), | |
'TOPIC_TITLE' => html_entity_decode(censor_text($this->get_data('topic_title')), ENT_COMPAT), | |
'U_TOPIC' => "{$board_url}/viewtopic.{$this->php_ext}?t={$this->item_id}", | |
'U_VIEW_TOPIC' => "{$board_url}/viewtopic.{$this->php_ext}?t={$this->item_id}", | |
'U_FORUM' => "{$board_url}/viewforum.{$this->php_ext}?f={$this->item_parent_id}", | |
'U_STOP_WATCHING_FORUM' => "{$board_url}/viewforum.{$this->php_ext}?uid={$this->user_id}&f={$this->item_parent_id}&unwatch=forum", | |
); | |
} | |
/** | |
* Get the url to this item | |
* | |
* @return string URL | |
*/ | |
public function get_url() | |
{ | |
return append_sid($this->phpbb_root_path . 'viewtopic.' . $this->php_ext, "t={$this->item_id}"); | |
} | |
/** | |
* Users needed to query before this notification can be displayed | |
* | |
* @return array Array of user_ids | |
*/ | |
public function users_to_query() | |
{ | |
return array($this->get_data('poster_id')); | |
} | |
/** | |
* Pre create insert array function | |
* This allows you to perform certain actions, like run a query | |
* and load data, before create_insert_array() is run. The data | |
* returned from this function will be sent to create_insert_array(). | |
* | |
* @param array $post Post data from submit_post | |
* @param array $notify_users Notify users list | |
* Formatted from find_users_for_notification() | |
* @return array Whatever you want to send to create_insert_array(). | |
*/ | |
public function pre_create_insert_array($post, $notify_users) | |
{ | |
if (!count($notify_users) || !$this->inherit_read_status) | |
{ | |
return array(); | |
} | |
$tracking_data = array(); | |
$sql = 'SELECT user_id, mark_time FROM ' . TOPICS_TRACK_TABLE . ' | |
WHERE topic_id = ' . (int) $post['topic_id'] . ' | |
AND ' . $this->db->sql_in_set('user_id', array_keys($notify_users)); | |
$result = $this->db->sql_query($sql); | |
while ($row = $this->db->sql_fetchrow($result)) | |
{ | |
$tracking_data[$row['user_id']] = $row['mark_time']; | |
} | |
$this->db->sql_freeresult($result); | |
return $tracking_data; | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function create_insert_array($post, $pre_create_data = array()) | |
{ | |
$this->set_data('poster_id', $post['poster_id']); | |
$this->set_data('topic_title', $post['topic_title']); | |
$this->set_data('post_username', (($post['poster_id'] == ANONYMOUS) ? $post['post_username'] : '')); | |
$this->set_data('forum_name', $post['forum_name']); | |
$this->notification_time = $post['post_time']; | |
// Topics can be "read" before they are public (while awaiting approval). | |
// Make sure that if the user has read the topic, it's marked as read in the notification | |
if ($this->inherit_read_status && isset($pre_create_data[$this->user_id]) && $pre_create_data[$this->user_id] >= $this->notification_time) | |
{ | |
$this->notification_read = true; | |
} | |
parent::create_insert_array($post, $pre_create_data); | |
} | |
} |