[ticket/13713] Introduce notifications for mentions

PHPBB3-13713

phpBB/phpbb/notification/type/mention.php

@@ -0,0 +1,172 @@
+<?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;
+
+/**
+* Post mentioning notifications class
+* This class handles notifying users when they have been mentioned in a post
+*/
+
+class mention extends \phpbb\notification\type\post
+{
+	/**
+	* @var \phpbb\textformatter\s9e\mention_helper
+	*/
+	protected $helper;
+
+	/**
+	* Get notification type name
+	*
+	* @return string
+	*/
+	public function get_type()
+	{
+		return 'notification.type.mention';
+	}
+
+	/**
+	* Language key used to output the text
+	*
+	* @var string
+	*/
+	protected $language_key = 'NOTIFICATION_MENTION';
+
+	/**
+	* 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_MENTION',
+		'group'	=> 'NOTIFICATION_GROUP_POSTING',
+	);
+
+	/**
+	* Is available
+	*/
+	public function is_available()
+	{
+		return true;
+	}
+
+	/**
+	* Find the users who want to receive notifications
+	*
+	* @param array $post Data from submit_post
+	* @param array $options Options for finding users for notification
+	*
+	* @return array
+	*/
+	public function find_users_for_notification($post, $options = array())
+	{
+		$options = array_merge(array(
+			'ignore_users'		=> array(),
+		), $options);
+
+		$user_ids = $this->helper->get_mentioned_users($post['post_text']);
+
+		$user_ids = array_unique($user_ids);
+
+		$user_ids = array_diff($user_ids, [(int) $post['poster_id']]);
+
+		if (empty($user_ids))
+		{
+			return array();
+		}
+
+		return $this->get_authorised_recipients($user_ids, $post['forum_id'], $options, true);
+	}
+
+	/**
+	* Update a notification
+	* TODO: decide what to do with this stuff
+	*
+	* @param array $post Data specific for this type that will be updated
+	* @return true
+	*/
+	public function update_notifications($post)
+	{
+		$old_notifications = $this->notification_manager->get_notified_users($this->get_type(), array(
+			'item_id'	=> static::get_item_id($post),
+		));
+
+		// Find the new users to notify
+		$notifications = $this->find_users_for_notification($post);
+
+		// Find the notifications we must delete
+		$remove_notifications = array_diff(array_keys($old_notifications), array_keys($notifications));
+
+		// Find the notifications we must add
+		$add_notifications = array();
+		foreach (array_diff(array_keys($notifications), array_keys($old_notifications)) as $user_id)
+		{
+			$add_notifications[$user_id] = $notifications[$user_id];
+		}
+
+		// Add the necessary notifications
+		$this->notification_manager->add_notifications_for_users($this->get_type(), $post, $add_notifications);
+
+		// Remove the necessary notifications
+		if (!empty($remove_notifications))
+		{
+			$this->notification_manager->delete_notifications($this->get_type(), static::get_item_id($post), false, $remove_notifications);
+		}
+
+		// return true to continue with the update code in the notifications service (this will update the rest of the notifications)
+		return true;
+	}
+
+	/**
+	* {inheritDoc}
+	*/
+	public function get_redirect_url()
+	{
+		return $this->get_url();
+	}
+
+	/**
+	* Get email template
+	*
+	* @return string|bool
+	*/
+	public function get_email_template()
+	{
+		return 'mention';
+	}
+
+	/**
+	* Get email template variables
+	*
+	* @return array
+	*/
+	public function get_email_template_variables()
+	{
+		$user_data = $this->user_loader->get_user($this->get_data('poster_id'));
+
+		return array_merge(parent::get_email_template_variables(), array(
+			'AUTHOR_NAME'		=> htmlspecialchars_decode($user_data['username']),
+		));
+	}
+
+	/**
+	* Set the helper service used to retrieve mentioned used
+	*
+	* @param \phpbb\textformatter\s9e\mention_helper $helper
+	*/
+	public function set_helper(\phpbb\textformatter\s9e\mention_helper $helper)
+	{
+		$this->helper = $helper;
+	}
+}

phpBB/phpbb/textformatter/s9e/mention_helper.php

@@ -149,4 +149,30 @@ class mention_helper
 			}
 		);
 	}
+
+	/**
+	 * Get a list of mentioned users
+	 * TODO: decide what to do with groups
+	 *
+	 * @param  string   $xml Parsed text
+	 * @return int[]         List of user IDs
+	 */
+	public function get_mentioned_users($xml)
+	{
+		$user_ids = array();
+		if (strpos($xml, '<MENTION ') === false)
+		{
+			return $user_ids;
+		}
+
+		$dom = new \DOMDocument;
+		$dom->loadXML($xml);
+		$xpath = new \DOMXPath($dom);
+		foreach ($xpath->query('//MENTION/@user_id') as $user_id)
+		{
+			$user_ids[] = (int) $user_id->textContent;
+		}
+
+		return $user_ids;
+	}
 }