[ticket/11744] Group join request notification

PHPBB3-11744

phpBB/config/notifications.yml

@@ -103,6 +103,24 @@ services:
         tags:
             - { name: notification.type }
 
+    notification.type.group_request:
+        class: phpbb_notification_type_group_request
+        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%
+            - %tables.user_notifications%
+        tags:
+            - { name: notification.type }
+
     notification.type.pm:
         class: phpbb_notification_type_pm
         scope: prototype # scope MUST be prototype for this to work!

phpBB/includes/functions_user.php

@@ -2635,7 +2635,7 @@ function group_user_add($group_id, $user_id_ary = false, $username_ary = false,
 */
 function group_user_del($group_id, $user_id_ary = false, $username_ary = false, $group_name = false)
 {
-	global $db, $auth, $config, $phpbb_dispatcher;
+	global $db, $auth, $config, $phpbb_dispatcher, $phpbb_container;
 
 	if ($config['coppa_enable'])
 	{
@@ -2769,6 +2769,10 @@ function group_user_del($group_id, $user_id_ary = false, $username_ary = false,
 
 	group_update_listings($group_id);
 
+	$phpbb_notifications = $phpbb_container->get('notification_manager');
+
+	$phpbb_notifications->delete_notifications('group_request', $user_id_ary, $group_id);
+
 	// Return false - no error
 	return false;
 }
@@ -2858,7 +2862,7 @@ function remove_default_rank($group_id, $user_ids)
 */
 function group_user_attributes($action, $group_id, $user_id_ary = false, $username_ary = false, $group_name = false, $group_attributes = false)
 {
-	global $db, $auth, $phpbb_root_path, $phpEx, $config;
+	global $db, $auth, $phpbb_root_path, $phpEx, $config, $phpbb_container;
 
 	// We need both username and user_id info
 	$result = user_get_id_name($user_id_ary, $username_ary);
@@ -2951,6 +2955,10 @@ function group_user_attributes($action, $group_id, $user_id_ary = false, $userna
 
 			$messenger->save_queue();
 
+			$phpbb_notifications = $phpbb_container->get('notification_manager');
+
+			$phpbb_notifications->delete_notifications('group_request', $user_id_ary, $group_id);
+
 			$log = 'LOG_USERS_APPROVED';
 		break;
 

phpBB/includes/ucp/ucp_groups.php

@@ -198,36 +198,12 @@ class ucp_groups
 								{
 									group_user_add($group_id, $user->data['user_id'], false, false, false, 0, 1);
 
-									include_once($phpbb_root_path . 'includes/functions_messenger.' . $phpEx);
-									$messenger = new messenger();
+									$phpbb_notifications = $phpbb_container->get('notification_manager');
 
-									$sql = 'SELECT u.username, u.username_clean, u.user_email, u.user_notify_type, u.user_jabber, u.user_lang
-										FROM ' . USER_GROUP_TABLE . ' ug, ' . USERS_TABLE . " u
-										WHERE ug.user_id = u.user_id
-											AND ug.group_leader = 1
-											AND ug.group_id = $group_id";
-									$result = $db->sql_query($sql);
-
-									while ($row = $db->sql_fetchrow($result))
-									{
-										$messenger->template('group_request', $row['user_lang']);
-
-										$messenger->set_addresses($row);
-
-										$messenger->assign_vars(array(
-											'USERNAME'			=> htmlspecialchars_decode($row['username']),
-											'GROUP_NAME'		=> htmlspecialchars_decode($group_row[$group_id]['group_name']),
-											'REQUEST_USERNAME'	=> $user->data['username'],
-
-											'U_PENDING'		=> generate_board_url() . "/ucp.$phpEx?i=groups&mode=manage&action=list&g=$group_id",
-											'U_GROUP'		=> generate_board_url() . "/memberlist.$phpEx?mode=group&g=$group_id")
-										);
-
-										$messenger->send($row['user_notify_type']);
-									}
-									$db->sql_freeresult($result);
-
-									$messenger->save_queue();
+									$phpbb_notifications->add_notifications('group_request', array_merge(
+										$group_row[$group_id],
+										array('user_id' => $user->data['user_id'])
+									));
 								}
 
 								add_log('user', $user->data['user_id'], 'LOG_USER_GROUP_JOIN' . (($group_row[$group_id]['group_type'] == GROUP_FREE) ? '' : '_PENDING'), $group_row[$group_id]['group_name']);

phpBB/language/en/common.php

@@ -414,6 +414,7 @@ $lang = array_merge($lang, array(
 		2	=> '<strong>%d</strong> Notifications',
 	),
 	'NOTIFICATION_BOOKMARK'				=> '%1$s replied to the topic "%2$s" you have bookmarked.',
+	'NOTIFICATION_GROUP_REQUEST'		=> '%1$s is requesting to join the group you manage, %2$s.',
 	'NOTIFICATION_PM'					=> '%1$s sent you a Private Message "%2$s".',
 	'NOTIFICATION_POST'					=> '%1$s replied to the topic "%2$s".',
 	'NOTIFICATION_POST_APPROVED'		=> 'Your post was approved "%2$s".',

phpBB/language/en/ucp.php

@@ -313,6 +313,7 @@ $lang = array_merge($lang, array(
 	'NOTIFICATION_METHOD_JABBER'						=> 'Jabber',
 	'NOTIFICATION_TYPE'									=> 'Notification type',
 	'NOTIFICATION_TYPE_BOOKMARK'						=> 'Someone replies to a topic you have bookmarked',
+	'NOTIFICATION_TYPE_GROUP_REQUEST'					=> 'Someone requests to join a group you lead',
 	'NOTIFICATION_TYPE_IN_MODERATION_QUEUE'				=> 'A post or topic needs approval',
 	'NOTIFICATION_TYPE_MODERATION_QUEUE'   				=> 'Your topics/posts are approved or disapproved by a moderator',
 	'NOTIFICATION_TYPE_PM'								=> 'Someone sends you a private message',

phpBB/phpbb/notification/manager.php

@@ -59,7 +59,7 @@ class phpbb_notification_manager
 
 	/**
 	* Notification Constructor
-	* 
+	*
 	* @param array $notification_types
 	* @param array $notification_methods
 	* @param ContainerBuilder $phpbb_container
@@ -490,15 +490,15 @@ class phpbb_notification_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 int|array $item_id Identifier within the type (or array of ids)
-	* @param array $data Data specific for this type that will be updated
+	* @param bool|int|array $parent_id Parent identifier within the type (or array of ids), used in combination with item_id if specified
 	*/
-	public function delete_notifications($notification_type_name, $item_id)
+	public function delete_notifications($notification_type_name, $item_id, $parent_id = false)
 	{
 		if (is_array($notification_type_name))
 		{
 			foreach ($notification_type_name as $type)
 			{
-				$this->delete_notifications($type, $item_id);
+				$this->delete_notifications($type, $item_id, $parent_id);
 			}
 
 			return;
@@ -508,7 +508,8 @@ class phpbb_notification_manager
 
 		$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);
+				AND ' . (is_array($item_id) ? $this->db->sql_in_set('item_id', $item_id) : 'item_id = ' . (int) $item_id) .
+				(($parent_id !== false) ? ' AND ' . ((is_array($parent_id) ? $this->db->sql_in_set('item_parent_id', $parent_id) : 'item_parent_id = ' . (int) $parent_id)) : '');
 		$this->db->sql_query($sql);
 	}
 
@@ -834,12 +835,12 @@ class phpbb_notification_manager
 	protected function load_object($object_name)
 	{
 		$object = $this->phpbb_container->get($object_name);
-		
+
 		if (method_exists($object, 'set_notification_manager'))
 		{
 			$object->set_notification_manager($this);
 		}
-		
+
 		return $object;
 	}
 

phpBB/phpbb/notification/type/group_request.php

@@ -0,0 +1,161 @@
+<?php
+/**
+*
+* @package notifications
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+class phpbb_notification_type_group_request extends phpbb_notification_type_base
+{
+	/**
+	* {@inheritdoc}
+	*/
+	public function get_type()
+	{
+		return 'group_request';
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public static $notification_option = array(
+		'lang'	=> 'NOTIFICATION_TYPE_GROUP_REQUEST',
+	);
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function is_available()
+	{
+		// Leader of any groups?
+		$sql = 'SELECT group_id FROM ' . USER_GROUP_TABLE . '
+			WHERE user_id = ' . (int) $this->user->data['user_id'] . '
+				AND group_leader = 1';
+		$result = $this->db->sql_query_limit($sql, 1);
+		$row = $this->db->sql_fetchrow($result);
+		$this->db->sql_freeresult($result);
+
+		return (!empty($row)) ? true : false;
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public static function get_item_id($group)
+	{
+		return (int) $group['user_id'];
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public static function get_item_parent_id($group)
+	{
+		// Group id is the parent
+		return (int) $group['group_id'];
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function find_users_for_notification($group, $options = array())
+	{
+		$options = array_merge(array(
+			'ignore_users'		=> array(),
+		), $options);
+
+		$sql = 'SELECT user_id FROM ' . USER_GROUP_TABLE . '
+			WHERE group_leader = 1
+				AND group_id = ' . (int) $group['group_id'];
+		$result = $this->db->sql_query($sql);
+
+		$user_ids = array();
+		while ($row = $this->db->sql_fetchrow($result))
+		{
+			$user_ids[] = $row['user_id'];
+		}
+		$this->db->sql_freeresult($result);
+
+		$this->user_loader->load_users($user_ids);
+
+		return $this->check_user_notification_options($user_ids, $options);
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function get_avatar()
+	{
+		return $this->user_loader->get_avatar($this->item_id);
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function get_title()
+	{
+		$username = $this->user_loader->get_username($this->item_id, 'no_profile');
+
+		return $this->user->lang('NOTIFICATION_GROUP_REQUEST', $username, $this->get_data('group_name'));
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function get_email_template()
+	{
+		return 'group_request';
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function get_email_template_variables()
+	{
+		$user_data = $this->user_loader->get_user($this->item_id);
+
+		return array(
+			'GROUP_NAME'		   		=> htmlspecialchars_decode($this->get_data('group_name')),
+			'REQUEST_USERNAME' 	   		=> htmlspecialchars_decode($user_data['username']),
+
+			'U_PENDING'			  		=> generate_board_url() . "/ucp.{$this->php_ext}?i=groups&mode=manage&action=list&g={$this->item_parent_id}",
+			'U_GROUP'					=> generate_board_url() . "/memberlist.{$this->php_ext}?mode=group&g={$this->item_parent_id}",
+		);
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function get_url()
+	{
+		return append_sid($this->phpbb_root_path . 'ucp.' . $this->php_ext, "i=groups&mode=manage&action=list&g={$this->item_parent_id}");
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function users_to_query()
+	{
+		return array($this->item_id);
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function create_insert_array($group, $pre_create_data = array())
+	{
+		$this->set_data('group_name', $group['group_name']);
+
+		return parent::create_insert_array($group, $pre_create_data);
+	}
+}