Merge pull request #41 from iMattPro/sub-anywhere

Subscribe Toggle in Notification Dropdown
phpbb-extensions · Jun 1, 2024 · 01c60b5 · 01c60b5
2 parents 08c7348 + 7fcf10d
commit 01c60b5
Show file tree

Hide file tree

Showing 15 changed files with 207 additions and 43 deletions.
diff --git a/config/services.yml b/config/services.yml
@@ -16,6 +16,7 @@ services:
             - '@phpbb.wpn.form_helper'
             - '@language'
             - '@template'
+            - '@notification_manager'
         tags:
             - { name: event.listener }
 

diff --git a/event/listener.php b/event/listener.php
@@ -17,6 +17,7 @@
 use phpbb\controller\helper as controller_helper;
 use phpbb\webpushnotifications\form\form_helper;
 use phpbb\language\language;
+use phpbb\notification\manager;
 use phpbb\template\template;
 
 /**
@@ -27,10 +28,10 @@ class listener implements EventSubscriberInterface
 	public static function getSubscribedEvents()
 	{
 		return [
-			'core.ucp_notifications_output_notification_types_modify_template_vars'	=> 'load_template_data',
 			'core.ucp_display_module_before'	=> 'load_language',
 			'core.acp_main_notice'				=> 'compatibility_notice',
-			'core.page_header_after'			=> 'service_worker_url',
+			'core.page_header_after'			=> 'load_template_data',
+			'core.user_add_modify_notifications_data' => 'add_user_notification_data',
 		];
 	}
 
@@ -46,32 +47,40 @@ public static function getSubscribedEvents()
 	/* @var template */
 	protected $template;
 
+	/* @var manager */
+	protected $phpbb_notifications;
+
 	/**
 	 * Constructor
 	 *
 	 * @param controller_helper $controller_helper Controller helper object
 	 * @param form_helper $form_helper Form helper object
 	 * @param language $language Language object
 	 * @param template $template Template object
+	 * @param manager $phpbb_notifications Notifications manager object
 	 */
-	public function __construct(controller_helper $controller_helper, form_helper $form_helper, language $language, template $template)
+	public function __construct(controller_helper $controller_helper, form_helper $form_helper, language $language, template $template, manager $phpbb_notifications)
 	{
 		$this->controller_helper = $controller_helper;
 		$this->form_helper = $form_helper;
 		$this->language = $language;
 		$this->template = $template;
+		$this->phpbb_notifications = $phpbb_notifications;
 	}
 
 	/**
 	 * Load template data
-	 *
-	 * @param \phpbb\event\data $event
 	 */
-	public function load_template_data($event)
+	public function load_template_data()
 	{
-		if ($event['method_data']['id'] === 'notification.method.phpbb.wpn.webpush')
+		$methods = $this->phpbb_notifications->get_subscription_methods();
+		if (array_key_exists('notification.method.phpbb.wpn.webpush', $methods))
 		{
-			$template_ary = $event['method_data']['method']->get_ucp_template_data($this->controller_helper, $this->form_helper);
+			if (!$this->language->is_set('NOTIFICATION_METHOD_PHPBB_WPN_WEBPUSH'))
+			{
+				$this->language->add_lang('webpushnotifications_module_ucp', 'phpbb/webpushnotifications');
+			}
+			$template_ary = $methods['notification.method.phpbb.wpn.webpush']['method']->get_ucp_template_data($this->controller_helper, $this->form_helper);
 			$this->template->assign_vars($template_ary);
 		}
 	}
@@ -93,13 +102,22 @@ public function compatibility_notice()
 	}
 
 	/**
-	 * Generate service worker URL globally for update
+	 * Add default web push notification settings for new users
+	 *
+	 * @param \phpbb\event\data $event The event object
+	 * @return void
 	 */
-	public function service_worker_url()
+	public function add_user_notification_data($event)
 	{
-		if (!$this->template->retrieve_var('U_WEBPUSH_WORKER_URL'))
-		{
-			$this->template->assign_var('U_WEBPUSH_WORKER_URL', $this->controller_helper->route('phpbb_webpushnotifications_ucp_push_worker_controller'));
-		}
+		$notifications_data = $event['notifications_data'];
+		$notifications_data[] = [
+			'item_type'	=> 'notification.type.quote',
+			'method'	=> 'notification.method.phpbb.wpn.webpush',
+		];
+		$notifications_data[] = [
+			'item_type'	=> 'notification.type.pm',
+			'method'	=> 'notification.method.phpbb.wpn.webpush',
+		];
+		$event['notifications_data'] = $notifications_data;
 	}
 }
diff --git a/language/en/webpushnotifications_module_ucp.php b/language/en/webpushnotifications_module_ucp.php
@@ -39,8 +39,10 @@
 
 $lang = array_merge($lang, [
 	'NOTIFICATION_METHOD_PHPBB_WPN_WEBPUSH'	=> 'Web Push',
+	'NOTIFY_WEBPUSH_ENABLE_SHORT'	=> 'Enable Web Push notifications',
 	'NOTIFY_WEBPUSH_ENABLE'			=> 'Enable receiving Web Push notifications',
 	'NOTIFY_WEBPUSH_ENABLE_EXPLAIN'	=> 'Enable receiving browser-based push notifications.<br>The notifications can be turned off at any time in your browser settings, by unsubscribing, or by disabling the push notifications below.',
 	'NOTIFY_WEBPUSH_SUBSCRIBE'		=> 'Subscribe',
 	'NOTIFY_WEBPUSH_UNSUBSCRIBE'	=> 'Unsubscribe',
+	'NOTIFY_WEBPUSH_SUBSCRIBED'		=> 'Subscribed',
 ]);
diff --git a/language/ru/webpushnotifications_module_ucp.php b/language/ru/webpushnotifications_module_ucp.php
@@ -39,8 +39,10 @@
 
 $lang = array_merge($lang, [
 	'NOTIFICATION_METHOD_PHPBB_WPN_WEBPUSH'	=> 'Браузерные push—уведомления',
+	'NOTIFY_WEBPUSH_ENABLE_SHORT'	=> 'Браузерные push—уведомления',
 	'NOTIFY_WEBPUSH_ENABLE'			=> 'Включить браузерные push—уведомления',
 	'NOTIFY_WEBPUSH_ENABLE_EXPLAIN'	=> 'Включение возможности получения браузерных push—уведомлений.<br>Данная возможность может быть отключена в любое время в настройках браузера, с помощью отписки от браузерных push—уведомлений в личном разделе или путём отключения данной функции ниже.',
 	'NOTIFY_WEBPUSH_SUBSCRIBE'		=> 'Подписаться',
 	'NOTIFY_WEBPUSH_UNSUBSCRIBE'	=> 'Отписаться',
+	'NOTIFY_WEBPUSH_SUBSCRIBED'		=> 'Включено',
 ]);
diff --git a/migrations/update_user_notifications.php b/migrations/update_user_notifications.php
@@ -0,0 +1,94 @@
+<?php
+/**
+ *
+ * phpBB Browser Push Notifications. An extension for the phpBB Forum Software package.
+ *
+ * @copyright (c) 2024, phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+
+namespace phpbb\webpushnotifications\migrations;
+
+use phpbb\db\migration\migration;
+
+class update_user_notifications extends migration
+{
+	/**
+	 * @inheritDoc
+	 */
+	public static function depends_on()
+	{
+		return ['\phpbb\webpushnotifications\migrations\add_webpush'];
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function effectively_installed()
+	{
+		$sql = 'SELECT method
+			FROM ' . $this->table_prefix . "user_notifications
+			WHERE method = '" . $this->db->sql_escape('notification.method.phpbb.wpn.webpush') . "'";
+		$result = $this->db->sql_query_limit($sql, 1);
+		$row = $this->db->sql_fetchrow($result);
+		$this->db->sql_freeresult($result);
+
+		return $row !== false;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function update_data()
+	{
+		return [
+			['custom', [[$this, 'update_notifications']]],
+		];
+	}
+
+	/**
+	 * Add default push notifications for users in chunks
+	 *
+	 * @param $start int Start value for the update
+	 * @return int|true Next start value or true if complete
+	 */
+	public function update_notifications($start)
+	{
+		$start = (int) $start;
+		$limit = 500;
+		$updated = 0;
+
+		$sql_ary = [];
+
+		$sql = 'SELECT user_id
+			FROM ' . $this->table_prefix . 'users
+			WHERE user_type <> ' . USER_IGNORE . '
+			ORDER BY user_id ASC';
+		$result = $this->db->sql_query_limit($sql, $limit, $start);
+
+		while ($row = $this->db->sql_fetchrow($result))
+		{
+			$sql_ary[] = [
+				'item_type'		=> 'notification.type.pm',
+				'item_id'		=> 0,
+				'user_id'		=> (int) $row['user_id'],
+				'notify'		=> 1,
+				'method'		=> 'notification.method.phpbb.wpn.webpush',
+			];
+			$sql_ary[] = [
+				'item_type'		=> 'notification.type.quote',
+				'item_id'		=> 0,
+				'user_id'		=> (int) $row['user_id'],
+				'notify'		=> 1,
+				'method'		=> 'notification.method.phpbb.wpn.webpush',
+			];
+			$updated++;
+		}
+		$this->db->sql_freeresult($result);
+
+		$this->db->sql_multi_insert($this->table_prefix . 'user_notifications', $sql_ary);
+
+		return ($updated === $limit) ? $start + $limit : true;
+	}
+}
diff --git a/styles/all/template/event/notification_dropdown_footer_after.html b/styles/all/template/event/notification_dropdown_footer_after.html
@@ -0,0 +1,7 @@
+{% if NOTIFICATIONS_WEBPUSH_ENABLE and not notification_types|default and not notification_list|default %}
+	<div class="wpn-notification-dropdown-footer">
+		<span class="ellipsis-text">{{ lang('NOTIFY_WEBPUSH_ENABLE_SHORT') ~ lang('COLON') }}</span>
+		<button id="subscribe_webpush" name="subscribe_webpush"><i class="icon fa-toggle-off fa-fw icon-lightgray"></i><span>{{ lang('NOTIFY_WEBPUSH_SUBSCRIBE') }}</span></button>
+		<button id="unsubscribe_webpush" name="unsubscribe_webpush" class="hidden"><i class="icon fa-toggle-on fa-fw icon-blue"></i><span>{{ lang('NOTIFY_WEBPUSH_SUBSCRIBED') }}</span></button>
+	</div>
+{% endif %}
diff --git a/styles/all/template/event/overall_header_head_append.html b/styles/all/template/event/overall_header_head_append.html
@@ -0,0 +1,3 @@
+{% if NOTIFICATIONS_WEBPUSH_ENABLE %}
+	{% include '@phpbb_webpushnotifications/ucp_notifications_webpush.html' %}
+{% endif %}
diff --git a/...r/template/ucp_notifications_webpush.html → ...l/template/ucp_notifications_webpush.html b/...r/template/ucp_notifications_webpush.html → ...l/template/ucp_notifications_webpush.html
@@ -18,4 +18,5 @@
 </script>
 
 {% INCLUDEJS '@phpbb_webpushnotifications/webpush.js' %}
+{% INCLUDEJS '@phpbb_webpushnotifications/update_worker.js' %}
 {% INCLUDECSS '@phpbb_webpushnotifications/phpbb_wpn.css' %}
diff --git a/styles/all/template/update_worker.js b/styles/all/template/update_worker.js
@@ -1,8 +1,9 @@
 'use strict';
 
+/* global phpbbWebpushOptions, domReady */
 function webpushWorkerUpdate() {
 	if ('serviceWorker' in navigator) {
-		navigator.serviceWorker.getRegistration(serviceWorkerUrl)
+		navigator.serviceWorker.getRegistration(phpbbWebpushOptions.serviceWorkerUrl)
 			.then((registration) => {
 				registration.update();
 			})
@@ -13,7 +14,6 @@ function webpushWorkerUpdate() {
 	}
 }
 // Do not redeclare function if exist
-/* global domReady */
 if (typeof domReady === 'undefined') {
 	window.domReady = function(callBack) {
 		if (document.readyState === 'loading') {
@@ -25,6 +25,5 @@ if (typeof domReady === 'undefined') {
 }
 
 domReady(() => {
-	/* global serviceWorkerUrl */
 	webpushWorkerUpdate();
 });
diff --git a/styles/all/theme/phpbb_wpn.css b/styles/all/theme/phpbb_wpn.css
@@ -0,0 +1,26 @@
+.button[disabled],
+.button[disabled]:hover,
+.button.disabled,
+.button.disabled:hover {
+	background: #e0e0e0;
+	border-color: #9e9e9e;
+	color: #9e9e9e;
+}
+
+.button.hidden {
+	display: none;
+}
+
+.wpn-notification-dropdown-footer {
+	font-size: 12px;
+	white-space: nowrap;
+	border-top: solid 1px #b9b9b9;
+	display: flex;
+	flex-wrap: nowrap;
+	justify-content: space-between;
+	padding: 5px 25px;
+}
+
+.wpn-notification-dropdown-footer button:disabled {
+	opacity: 0.7;
+}
diff --git a/styles/prosilver/template/event/overall_footer_after.html b/styles/prosilver/template/event/overall_footer_after.html
diff --git a/styles/prosilver/template/event/ucp_notifications_form_before.html b/styles/prosilver/template/event/ucp_notifications_form_before.html
diff --git a/styles/prosilver/theme/phpbb_wpn.css b/styles/prosilver/theme/phpbb_wpn.css
diff --git a/tests/event/listener_test.php b/tests/event/listener_test.php
@@ -30,6 +30,9 @@ class listener_test extends \phpbb_database_test_case
 	/** @var \phpbb\webpushnotifications\notification\method\webpush */
 	protected $notification_method_webpush;
 
+	/* @var \PHPUnit\Framework\MockObject\MockObject|\phpbb\notification\manager */
+	protected $phpbb_notifications;
+
 	protected static function setup_extensions()
 	{
 		return ['phpbb/webpushnotifications'];
@@ -81,6 +84,10 @@ protected function setUp(): void
 			->setMethods(array())
 			->getMock();
 
+		$this->notifications = $this->getMockBuilder('\phpbb\notification\manager')
+			->disableOriginalConstructor()
+			->getMock();
+
 		$this->notification_method_webpush = new \phpbb\webpushnotifications\notification\method\webpush(
 			$this->config,
 			$db,
@@ -101,7 +108,8 @@ protected function set_listener()
 			$this->controller_helper,
 			$this->form_helper,
 			$this->language,
-			$this->template
+			$this->template,
+			$this->notifications
 		);
 	}
 
@@ -114,10 +122,10 @@ public function test_construct()
 	public function test_getSubscribedEvents()
 	{
 		self::assertEquals([
-			'core.ucp_notifications_output_notification_types_modify_template_vars',
 			'core.ucp_display_module_before',
 			'core.acp_main_notice',
 			'core.page_header_after',
+			'core.user_add_modify_notifications_data',
 		], array_keys(\phpbb\webpushnotifications\event\listener::getSubscribedEvents()));
 	}
 
@@ -215,10 +223,13 @@ public function test_get_ucp_template_data($user_id, $method_data, $subscription
 		$this->set_listener();
 
 		$method_data['method'] = $this->notification_method_webpush;
-		$event_data = ['method_data'];
+
+		$this->notifications->expects(self::once())
+			->method('get_subscription_methods')
+			->willReturn([$method_data['id'] => $method_data]);
 
 		$dispatcher = new \phpbb\event\dispatcher();
-		$dispatcher->addListener('core.ucp_notifications_output_notification_types_modify_template_vars', [$this->listener, 'load_template_data']);
-		$dispatcher->trigger_event('core.ucp_notifications_output_notification_types_modify_template_vars', compact($event_data));
+		$dispatcher->addListener('core.page_header_after', [$this->listener, 'load_template_data']);
+		$dispatcher->trigger_event('core.page_header_after');
 	}
 }