Merge pull request #159 from iMattPro/notifications

Add notifications for status changes

Author: iMattPro

README.md

@@ -4,7 +4,6 @@ The official Ideas Centre used at [phpBB.com](https://www.phpbb.com/ideas/). Thi
 
 [![Build Status](https://github.com/phpbb/ideas/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbb/ideas/actions)
 [![codecov](https://codecov.io/gh/phpbb/ideas/graph/badge.svg?token=74AITS9CPZ)](https://codecov.io/gh/phpbb/ideas)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/phpbb/ideas/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/phpbb/ideas/?branch=master)
 
 ## Contribute
 

config/services.yml

@@ -82,6 +82,7 @@ services:
             - '@config'
             - '@dbal.conn'
             - '@language'
+            - '@notification_manager'
             - '@user'
             - '%tables.ideas_ideas%'
             - '%tables.ideas_votes%'
@@ -122,3 +123,13 @@ services:
             - [set_name, [cron.task.prune_orphaned_ideas]]
         tags:
             - { name: cron.task }
+
+# ----- Notifications -----
+    phpbb.ideas.notification.type.status:
+        class: phpbb\ideas\notification\type\status
+        parent: notification.type.base
+        shared: false
+        calls:
+            - [set_additional_services, ['@config', '@controller.helper', '@user_loader']]
+        tags:
+            - { name: notification.type }

ext.php

@@ -11,13 +11,13 @@
 namespace phpbb\ideas;
 
 /**
-* This ext class is optional and can be omitted if left empty.
-* However, you can add special (un)installation commands in the
-* methods enable_step(), disable_step() and purge_step(). As it is,
-* these methods are defined in \phpbb\extension\base, which this
-* class extends, but you can overwrite them to give special
-* instructions for those cases.
-*/
+ * This ext class is optional and can be omitted if left empty.
+ * However, you can add special (un)installation commands in the
+ * methods enable_step(), disable_step() and purge_step(). As it is,
+ * these methods are defined in \phpbb\extension\base, which this
+ * class extends, but you can overwrite them to give special
+ * instructions for those cases.
+ */
 class ext extends \phpbb\extension\base
 {
 	public const SORT_AUTHOR = 'author';
@@ -30,44 +30,93 @@ class ext extends \phpbb\extension\base
 	public const SORT_MYIDEAS = 'egosearch';
 	public const SUBJECT_LENGTH = 120;
 	public const NUM_IDEAS = 5;
+	public const NOTIFICATION_TYPE_STATUS = 'phpbb.ideas.notification.type.status';
 
 	/** @var array Idea status names and IDs */
-	public static $statuses = array(
+	public static $statuses = [
 		'NEW'			=> 1,
 		'IN_PROGRESS'	=> 2,
 		'IMPLEMENTED'	=> 3,
 		'DUPLICATE'		=> 4,
 		'INVALID'		=> 5,
-	);
+	];
+
+	/** @var array Cached flipped statuses array */
+	private static $status_names;
 
 	/**
 	 * Return the status name from the status ID.
 	 *
 	 * @param int $id ID of the status.
-	 *
 	 * @return string The status name.
-	 * @static
-	 * @access public
 	 */
 	public static function status_name($id)
 	{
-		return array_flip(self::$statuses)[$id];
+		if (self::$status_names === null)
+		{
+			self::$status_names = array_flip(self::$statuses);
+		}
+
+		return self::$status_names[$id];
 	}
 
 	/**
 	 * Check whether the extension can be enabled.
 	 *
-	 * Requires phpBB >= 3.2.3 due to removal of deprecated Twig functions (ie Twig_SimpleFunction)
 	 * Requires phpBB >= 3.3.0 due to use of PHP 7 features
-	 * Requires PHP >= 7.1.0
+	 * Requires PHP >= 7.2.0
 	 *
 	 * @return bool
-	 * @access public
 	 */
 	public function is_enableable()
 	{
-		return !(PHP_VERSION_ID < 70100 ||
-			phpbb_version_compare(PHPBB_VERSION, '3.3.0', '<') ||
-			phpbb_version_compare(PHPBB_VERSION, '4.0.0-dev', '>='));
+		return PHP_VERSION_ID >= 70200
+			&& phpbb_version_compare(PHPBB_VERSION, '3.3.0', '>=')
+			&& phpbb_version_compare(PHPBB_VERSION, '4.0.0-dev', '<');
+	}
+
+	/**
+	 * Handle notification management for extension lifecycle
+	 *
+	 * @param string $method The notification manager method to call
+	 * @return string
+	 */
+	private function handle_notifications($method)
+	{
+		$this->container->get('notification_manager')->$method(self::NOTIFICATION_TYPE_STATUS);
+		return 'notification';
+	}
+
+	/**
+	 * Enable notifications for the extension
+	 *
+	 * @param mixed $old_state
+	 * @return bool|string
+	 */
+	public function enable_step($old_state)
+	{
+		return $old_state === false ? $this->handle_notifications('enable_notifications') : parent::enable_step($old_state);
+	}
+
+	/**
+	 * Disable notifications for the extension
+	 *
+	 * @param mixed $old_state
+	 * @return bool|string
+	 */
+	public function disable_step($old_state)
+	{
+		return $old_state === false ? $this->handle_notifications('disable_notifications') : parent::disable_step($old_state);
+	}
+
+	/**
+	 * Purge notifications for the extension
+	 *
+	 * @param mixed $old_state
+	 * @return bool|string
+	 */
+	public function purge_step($old_state)
+	{
+		return $old_state === false ? $this->handle_notifications('purge_notifications') : parent::purge_step($old_state);
 	}
 }

factory/base.php

@@ -14,6 +14,7 @@
 use phpbb\config\config;
 use phpbb\db\driver\driver_interface;
 use phpbb\language\language;
+use phpbb\notification\manager as notification_manager;
 use phpbb\user;
 
 /**
@@ -33,6 +34,9 @@ class base
 	/** @var language */
 	protected $language;
 
+	/** @var notification_manager */
+	protected $notification_manager;
+
 	/* @var user */
 	protected $user;
 
@@ -51,22 +55,24 @@ class base
 	/**
 	 * Constructor
 	 *
-	 * @param auth             $auth
-	 * @param config           $config
+	 * @param auth $auth
+	 * @param config $config
 	 * @param driver_interface $db
-	 * @param language         $language
-	 * @param user             $user
-	 * @param string           $table_ideas
-	 * @param string           $table_votes
-	 * @param string           $table_topics
-	 * @param string           $phpEx
+	 * @param language $language
+	 * @param notification_manager $notification_manager
+	 * @param user $user
+	 * @param string $table_ideas
+	 * @param string $table_votes
+	 * @param string $table_topics
+	 * @param string $phpEx
 	 */
-	public function __construct(auth $auth, config $config, driver_interface $db, language $language, user $user, $table_ideas, $table_votes, $table_topics, $phpEx)
+	public function __construct(auth $auth, config $config, driver_interface $db, language $language, notification_manager $notification_manager, user $user, $table_ideas, $table_votes, $table_topics, $phpEx)
 	{
 		$this->auth = $auth;
 		$this->config = $config;
 		$this->db = $db;
 		$this->language = $language;
+		$this->notification_manager = $notification_manager;
 		$this->user = $user;
 
 		$this->php_ext = $phpEx;

factory/idea.php

@@ -70,6 +70,20 @@ public function set_status($idea_id, $status)
 		);
 
 		$this->update_idea_data($sql_ary, $idea_id, $this->table_ideas);
+
+		// Send a notification
+		$idea = $this->get_idea($idea_id);
+		$notifications = $this->notification_manager->get_notified_users(ext::NOTIFICATION_TYPE_STATUS, ['item_id' => (int) $idea_id]);
+		$this->notification_manager->{empty($notifications) ? 'add_notifications' : 'update_notifications'}(
+			ext::NOTIFICATION_TYPE_STATUS,
+			[
+				'idea_id' => (int) $idea_id,
+				'status'  => (int) $status,
+				'user_id' => (int) $this->user->data['user_id'],
+				'idea_author' => (int) $idea['idea_author'],
+				'idea_title' => $idea['idea_title'],
+			]
+		);
 	}
 
 	/**
@@ -262,8 +276,14 @@ public function delete($id, $topic_id = 0)
 		// Delete idea
 		$deleted = $this->delete_idea_data($id, $this->table_ideas);
 
-		// Delete votes
-		$this->delete_idea_data($id, $this->table_votes);
+		if ($deleted)
+		{
+			// Delete votes
+			$this->delete_idea_data($id, $this->table_votes);
+
+			// Delete notifications
+			$this->notification_manager->delete_notifications(ext::NOTIFICATION_TYPE_STATUS, $id);
+		}
 
 		return $deleted;
 	}

language/en/common.php

@@ -38,6 +38,7 @@
 	'IDEA_DELETED'			=> 'Idea successfully deleted.',
 	'IDEA_LIST'				=> 'Idea List',
 	'IDEA_NOT_FOUND'		=> 'Idea not found',
+	'IDEA_STATUS_CHANGE'	=> '<strong>Idea status changed</strong> by %s:',
 	'IDEA_STORED_MOD'		=> 'Your idea has been submitted successfully, but it will need to be approved by a moderator before it is publicly viewable. You will be notified when your idea has been approved.<br /><br /><a href="%s">Return to Ideas</a>.',
 	'IDEAS_TITLE'			=> 'phpBB Ideas',
 	'IDEAS_NOT_AVAILABLE'	=> 'Ideas is not available at this time.',
@@ -66,6 +67,7 @@
 	'NEW'					=> 'New',
 	'NEW_IDEA'				=> 'New Idea',
 	'NO_IDEAS_DISPLAY'		=> 'There are no ideas to display.',
+	'NOTIFICATION_STATUS'	=> '<em>Status: <strong>%s</strong></em>',
 
 	'OPEN_IDEAS'			=> 'Open ideas',
 

language/en/email/status_notification.txt

@@ -0,0 +1,10 @@
+Subject: Idea status - "{IDEA_TITLE}"
+
+Hello {USERNAME},
+
+The status of your Idea topic "{IDEA_TITLE}" at "{SITENAME}" has been updated by {UPDATED_BY} to {STATUS}.
+
+If you want to view the Idea, click the following link:
+{U_VIEW_IDEA}
+
+{EMAIL_SIG}

language/en/info_ucp_ideas.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ *
+ * Ideas extension for the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+if (empty($lang) || !is_array($lang))
+{
+	$lang = [];
+}
+
+// DEVELOPERS PLEASE NOTE
+//
+// All language files should use UTF-8 as their encoding and the files must not contain a BOM.
+//
+// Placeholders can now contain order information, e.g. instead of
+// 'Page %s of %s' you can (and should) write 'Page %1$s of %2$s', this allows
+// translators to re-order the output of data while ensuring it remains correct
+//
+// You do not need this where single placeholders are used, e.g. 'Message %d' is fine
+// equally where a string contains only two placeholders which are used to wrap text
+// in a url you again do not need to specify an order e.g., 'Click %sHERE%s' is fine
+//
+// Some characters you may want to copy&paste:
+// ’ » “ ” …
+//
+
+$lang = array_merge($lang, [
+	'NOTIFICATION_TYPE_IDEAS'	=> 'Your Idea in the Ideas forum has a status change',
+]);