Add user option to globally disable web push prompts

iMattPro · iMattPro · commit b3a130bd5835 · 2025-12-28T10:13:10.000-08:00
diff --git a/config/wpn_ucp.yml b/config/wpn_ucp.yml
@@ -13,3 +13,7 @@ phpbb_webpushnotifications_ucp_push_subscribe_controller:
 phpbb_webpushnotifications_ucp_push_unsubscribe_controller:
     path: /push/unsubscribe
     defaults: { _controller: phpbb.wpn.ucp.controller.webpush:unsubscribe }
+
+phpbb_webpushnotifications_ucp_push_toggle_popup_controller:
+    path: /push/toggle-popup
+    defaults: { _controller: phpbb.wpn.ucp.controller.webpush:toggle_popup }
diff --git a/language/en/webpushnotifications_module_ucp.php b/language/en/webpushnotifications_module_ucp.php
@@ -53,4 +53,8 @@
 	'NOTIFY_WEBPUSH_POPUP_MESSAGE'	=> 'We would like to send you browser notifications for replies, private messages, and relevant forum activity. Optional — you can manage these settings at any time.',
 	'NOTIFY_WEBPUSH_POPUP_ALLOW'	=> 'Allow',
 	'NOTIFY_WEBPUSH_POPUP_DENY'		=> 'Deny',
+	'NOTIFY_WEBPUSH_POPUP_DISABLE_PROMPTS'		=> 'Disable web push notification prompts',
+	'NOTIFY_WEBPUSH_POPUP_DISABLE'				=> 'Disable popup prompt',
+	'NOTIFY_WEBPUSH_POPUP_ENABLE'				=> 'Enable popup prompt',
+	'NOTIFY_WEBPUSH_POPUP_PREFERENCE_EXPLAIN'	=> 'Turn this on to stop us from asking you to enable web push notifications on any of your devices. If you disable web push notification prompts, we won’t be able to alert you if you ever become unsubscribed.',
 ]);
diff --git a/migrations/add_user_popup_preference.php b/migrations/add_user_popup_preference.php
@@ -0,0 +1,48 @@
+<?php
+/**
+ *
+ * phpBB Browser Push Notifications. An extension for the phpBB Forum Software package.
+ *
+ * @copyright (c) 2025, 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 add_user_popup_preference extends migration
+{
+	public function effectively_installed()
+	{
+		return $this->db_tools->sql_column_exists($this->table_prefix . 'users', 'user_wpn_popup_disabled');
+	}
+
+	public static function depends_on()
+	{
+		return ['\phpbb\webpushnotifications\migrations\add_popup_prompt'];
+	}
+
+	public function update_schema()
+	{
+		return [
+			'add_columns'	=> [
+				$this->table_prefix . 'users'	=> [
+					'user_wpn_popup_disabled'	=> ['BOOL', 0],
+				],
+			],
+		];
+	}
+
+	public function revert_schema()
+	{
+		return [
+			'drop_columns'	=> [
+				$this->table_prefix . 'users'	=> [
+					'user_wpn_popup_disabled',
+				],
+			],
+		];
+	}
+}
diff --git a/notification/method/webpush.php b/notification/method/webpush.php
@@ -390,11 +390,13 @@ public function get_ucp_template_data(helper $controller_helper, form_helper $fo
 			'NOTIFICATIONS_WEBPUSH_ENABLE'	=> ($this->config['load_notifications'] && $this->config['allow_board_notifications'] && $this->config['wpn_webpush_dropdown_subscribe']) || stripos($this->user->page['page'], 'notification_options'),
 			'U_WEBPUSH_SUBSCRIBE'			=> $controller_helper->route('phpbb_webpushnotifications_ucp_push_subscribe_controller'),
 			'U_WEBPUSH_UNSUBSCRIBE'			=> $controller_helper->route('phpbb_webpushnotifications_ucp_push_unsubscribe_controller'),
+			'U_WEBPUSH_TOGGLE_POPUP'		=> $controller_helper->route('phpbb_webpushnotifications_ucp_push_toggle_popup_controller'),
 			'VAPID_PUBLIC_KEY'				=> $this->config['wpn_webpush_vapid_public'],
 			'U_WEBPUSH_WORKER_URL'			=> $controller_helper->route('phpbb_webpushnotifications_ucp_push_worker_controller'),
 			'SUBSCRIPTIONS'					=> $subscriptions,
 			'WEBPUSH_FORM_TOKENS'			=> $form_helper->get_form_tokens(\phpbb\webpushnotifications\ucp\controller\webpush::FORM_TOKEN_UCP),
-			'S_WEBPUSH_POPUP_PROMPT'		=> $this->config['wpn_webpush_popup_prompt'] && $this->user->id() != ANONYMOUS && $this->user->data['user_type'] != USER_IGNORE,
+			'S_WEBPUSH_POPUP_PROMPT'		=> $this->config['wpn_webpush_popup_prompt'] && $this->user->id() != ANONYMOUS && $this->user->data['user_type'] != USER_IGNORE && !($this->user->data['user_wpn_popup_disabled'] ?? 0),
+			'S_WEBPUSH_POPUP_DISABLED'		=> $this->user->data['user_wpn_popup_disabled'] ?? 0,
 		];
 	}
 
diff --git a/styles/all/template/ucp_notifications_webpush.html b/styles/all/template/ucp_notifications_webpush.html
@@ -3,6 +3,7 @@
 		serviceWorkerUrl: '{{ U_WEBPUSH_WORKER_URL }}',
 		subscribeUrl: '{{ U_WEBPUSH_SUBSCRIBE }}',
 		unsubscribeUrl: '{{ U_WEBPUSH_UNSUBSCRIBE }}',
+		togglePopupUrl: '{{ U_WEBPUSH_TOGGLE_POPUP }}',
 		ajaxErrorTitle: '{{ lang_js('AJAX_ERROR_TITLE') }}',
 		vapidPublicKey: '{{ VAPID_PUBLIC_KEY }}',
 		formTokens: {
diff --git a/styles/all/template/webpush.js b/styles/all/template/webpush.js
@@ -33,6 +33,12 @@ function PhpbbWebpush() {
 	/** @type {HTMLElement} Unsubscribe button */
 	let unsubscribeButton;
 
+	/** @type {HTMLElement} Toggle popup button */
+	let togglePopupButton;
+
+	/** @type {string} URL to toggle popup prompt preference */
+	let togglePopupUrl = '';
+
 	/** @type {function} Escape key handler for popup */
 	let popupEscapeHandler;
 
@@ -44,13 +50,20 @@ function PhpbbWebpush() {
 		serviceWorkerUrl = options.serviceWorkerUrl;
 		subscribeUrl = options.subscribeUrl;
 		unsubscribeUrl = options.unsubscribeUrl;
+		togglePopupUrl = options.togglePopupUrl;
 		this.formTokens = options.formTokens;
 		subscriptions = options.subscriptions;
 		ajaxErrorTitle = options.ajaxErrorTitle;
 		vapidPublicKey = options.vapidPublicKey;
 
 		subscribeButton = document.querySelector('#subscribe_webpush');
 		unsubscribeButton = document.querySelector('#unsubscribe_webpush');
+		togglePopupButton = document.querySelector('#toggle_popup_prompt');
+
+		// Set up toggle popup button handler if it exists (on UCP settings page)
+		if (togglePopupButton) {
+			togglePopupButton.addEventListener('click', togglePopupHandler);
+		}
 
 		// Service workers are only supported in secure context
 		if (window.isSecureContext !== true) {
@@ -352,6 +365,55 @@ function PhpbbWebpush() {
 			});
 	}
 
+	/**
+	 * Handler for toggle popup prompt button
+	 *
+	 * @param {Object} event Toggle button push event
+	 */
+	function togglePopupHandler(event) {
+		event.preventDefault();
+
+		const loadingIndicator = phpbb.loadingIndicator();
+		const formData = new FormData();
+		formData.append('form_token', phpbb.webpush.formTokens.formToken);
+		formData.append('creation_time', phpbb.webpush.formTokens.creationTime.toString());
+
+		fetch(togglePopupUrl, {
+			method: 'POST',
+			headers: {
+				'X-Requested-With': 'XMLHttpRequest',
+			},
+			body: formData,
+		})
+			.then(response => response.json())
+			.then(data => {
+				loadingIndicator.fadeOut(phpbb.alertTime);
+				if (data.success) {
+					// Update toggle icon based on new state
+					const button = document.getElementById('toggle_popup_prompt');
+					if (button) {
+						const icon = button.querySelector('i');
+						if (icon) {
+							if (data.disabled) {
+								icon.classList.remove('fa-toggle-off');
+								icon.classList.add('fa-toggle-on');
+							} else {
+								icon.classList.remove('fa-toggle-on');
+								icon.classList.add('fa-toggle-off');
+							}
+						}
+					}
+					if ('form_tokens' in data) {
+						updateFormTokens(data.form_tokens);
+					}
+				}
+			})
+			.catch(error => {
+				loadingIndicator.fadeOut(phpbb.alertTime);
+				phpbb.alert(ajaxErrorTitle, error);
+			});
+	}
+
 	/**
 	 * Handle subscribe response
 	 *
diff --git a/styles/prosilver/template/event/ucp_notifications_content_before.html b/styles/prosilver/template/event/ucp_notifications_content_before.html
@@ -10,6 +10,15 @@
 						<br><span>{{ lang('NOTIFY_WEBPUSH_ENABLE_EXPLAIN') }}</span>
 					</dd>
 				</dl>
+				<dl>
+					<dt><label for="toggle_popup_prompt">{{ lang('NOTIFY_WEBPUSH_POPUP_DISABLE_PROMPTS') ~ lang('COLON') }}</label></dt>
+					<dd>
+						<button id="toggle_popup_prompt" type="button" name="toggle_popup_prompt" class="wpn-toggle-button" aria-label="{{ lang(S_WEBPUSH_POPUP_DISABLED ? 'NOTIFY_WEBPUSH_POPUP_ENABLE' : 'NOTIFY_WEBPUSH_POPUP_DISABLE') }}">
+							<i class="icon icon-lg fa-fw fa-toggle-{% if S_WEBPUSH_POPUP_DISABLED %}on{% else %}off{% endif %}" aria-hidden="true"></i>
+						</button>
+						<br><span>{{ lang('NOTIFY_WEBPUSH_POPUP_PREFERENCE_EXPLAIN') }}</span>
+					</dd>
+				</dl>
 			</fieldset>
 		</div>
 	</div>
diff --git a/tests/controller/controller_webpush_test.php b/tests/controller/controller_webpush_test.php
@@ -420,6 +420,85 @@ public function test_sub_unsubscribe_success()
 		$this->assertEmpty($this->get_subscription_data());
 	}
 
+	public function test_toggle_popup_enable_to_disable()
+	{
+		$this->form_helper->method('check_form_tokens')->willReturn(true);
+		$this->request->method('is_ajax')->willReturn(true);
+		$this->user->data['user_id'] = 2;
+		$this->user->data['is_bot'] = false;
+		$this->user->data['user_type'] = USER_NORMAL;
+		$this->user->data['user_wpn_popup_disabled'] = 0;
+
+		$response = $this->controller->toggle_popup();
+
+		$this->assertInstanceOf(JsonResponse::class, $response);
+		$response_data = json_decode($response->getContent(), true);
+
+		$this->assertTrue($response_data['success']);
+		$this->assertTrue($response_data['disabled']);
+		$this->assertEquals(1, $this->get_user_popup_preference(2));
+	}
+
+	public function test_toggle_popup_disable_to_enable()
+	{
+		$this->form_helper->method('check_form_tokens')->willReturn(true);
+		$this->request->method('is_ajax')->willReturn(true);
+		$this->user->data['user_id'] = 2;
+		$this->user->data['is_bot'] = false;
+		$this->user->data['user_type'] = USER_NORMAL;
+		$this->user->data['user_wpn_popup_disabled'] = 1;
+
+		// Set initial state
+		$sql = 'UPDATE phpbb_users
+			SET user_wpn_popup_disabled = 1
+			WHERE user_id = 2';
+		$this->db->sql_query($sql);
+
+		$response = $this->controller->toggle_popup();
+
+		$this->assertInstanceOf(JsonResponse::class, $response);
+		$response_data = json_decode($response->getContent(), true);
+
+		$this->assertTrue($response_data['success']);
+		$this->assertFalse($response_data['disabled']);
+		$this->assertEquals(0, $this->get_user_popup_preference(2));
+	}
+
+	public function test_toggle_popup_invalid_form_token()
+	{
+		$this->form_helper->method('check_form_tokens')->willReturn(false);
+
+		$this->expectException(http_exception::class);
+		$this->expectExceptionMessage('FORM_INVALID');
+
+		$this->controller->toggle_popup();
+	}
+
+	public function test_toggle_popup_not_ajax()
+	{
+		$this->form_helper->method('check_form_tokens')->willReturn(true);
+		$this->request->method('is_ajax')->willReturn(false);
+
+		$this->expectException(http_exception::class);
+		$this->expectExceptionMessage('NO_AUTH_OPERATION');
+
+		$this->controller->toggle_popup();
+	}
+
+	public function test_toggle_popup_anonymous_user()
+	{
+		$this->form_helper->method('check_form_tokens')->willReturn(true);
+		$this->request->method('is_ajax')->willReturn(true);
+		$this->user->data['user_id'] = ANONYMOUS;
+		$this->user->data['is_bot'] = false;
+		$this->user->data['user_type'] = USER_NORMAL;
+
+		$this->expectException(http_exception::class);
+		$this->expectExceptionMessage('NO_AUTH_OPERATION');
+
+		$this->controller->toggle_popup();
+	}
+
 	private function get_subscription_data()
 	{
 		$sql = 'SELECT *
@@ -430,4 +509,15 @@ private function get_subscription_data()
 		$this->db->sql_freeresult($result);
 		return $row;
 	}
+
+	private function get_user_popup_preference($user_id)
+	{
+		$sql = 'SELECT user_wpn_popup_disabled
+			FROM phpbb_users
+			WHERE user_id = ' . (int) $user_id;
+		$result = $this->db->sql_query($sql);
+		$value = (int) $this->db->sql_fetchfield('user_wpn_popup_disabled');
+		$this->db->sql_freeresult($result);
+		return $value;
+	}
 }
diff --git a/tests/functional/functional_test.php b/tests/functional/functional_test.php
@@ -162,6 +162,58 @@ public function test_popup_prompt()
 		$this->assertContainsLang('NOTIFY_WEBPUSH_POPUP_DENY', $crawler->filter('#wpn_popup_deny')->text());
 	}
 
+	public function test_popup_preference_toggle()
+	{
+		$this->login();
+		$this->admin_login();
+
+		$this->add_lang_ext('phpbb/webpushnotifications', 'webpushnotifications_module_ucp');
+
+		$this->set_acp_option('wpn_webpush_popup_prompt', 1);
+
+		// Go to UCP notification settings
+		$crawler = self::request('GET', 'ucp.php?i=ucp_notifications&mode=notification_options');
+
+		// Assert toggle button is present
+		$this->assertCount(1, $crawler->filter('#toggle_popup_prompt'));
+		$this->assertContainsLang('NOTIFY_WEBPUSH_POPUP_DISABLE_PROMPTS', $crawler->filter('label[for="toggle_popup_prompt"]')->text());
+
+		// Assert toggle is initially off (prompts enabled)
+		$toggle_icon = $crawler->filter('#toggle_popup_prompt i');
+		$this->assertCount(1, $toggle_icon);
+		$this->assertTrue($toggle_icon->attr('class') !== null && strpos($toggle_icon->attr('class'), 'fa-toggle-off') !== false);
+
+		// After user disables popup (in reality this would be via AJAX, but we test the state)
+		// Set user preference to disabled via DB
+		$db = $this->get_db();
+		$sql = 'UPDATE phpbb_users
+			SET user_wpn_popup_disabled = 1
+			WHERE user_id = 2';
+		$db->sql_query($sql);
+
+		// Reload page
+		$crawler = self::request('GET', 'ucp.php?i=ucp_notifications&mode=notification_options');
+
+		// Assert toggle is now on (prompts disabled)
+		$toggle_icon = $crawler->filter('#toggle_popup_prompt i');
+		$this->assertCount(1, $toggle_icon);
+		$this->assertTrue($toggle_icon->attr('class') !== null && strpos($toggle_icon->attr('class'), 'fa-toggle-on') !== false);
+
+		// Assert popup is not shown on index when user has disabled it
+		$crawler = self::request('GET', 'index.php');
+		$this->assertCount(0, $crawler->filter('#wpn_popup_prompt'));
+
+		// Re-enable popup preference
+		$sql = 'UPDATE phpbb_users
+			SET user_wpn_popup_disabled = 0
+			WHERE user_id = 2';
+		$db->sql_query($sql);
+
+		// Assert popup is shown again
+		$crawler = self::request('GET', 'index.php');
+		$this->assertCount(1, $crawler->filter('#wpn_popup_prompt'));
+	}
+
 	protected function set_acp_option($option, $value)
 	{
 		$crawler = self::request('GET', 'adm/index.php?i=-phpbb-webpushnotifications-acp-wpn_acp_module&mode=webpush&sid=' . $this->sid);
diff --git a/ucp/controller/webpush.php b/ucp/controller/webpush.php
@@ -352,6 +352,30 @@ public function unsubscribe(symfony_request $symfony_request): JsonResponse
 		]);
 	}
 
+	/**
+	 * Handle toggle popup prompt requests
+	 *
+	 * @return JsonResponse
+	 */
+	public function toggle_popup(): JsonResponse
+	{
+		$this->check_subscribe_requests();
+
+		// Toggle the user preference
+		$new_value = !$this->user->data['user_wpn_popup_disabled'];
+
+		$sql = 'UPDATE ' . USERS_TABLE . '
+			SET user_wpn_popup_disabled = ' . (int) $new_value . '
+			WHERE user_id = ' . (int) $this->user->id();
+		$this->db->sql_query($sql);
+
+		return new JsonResponse([
+			'success'		=> true,
+			'disabled'		=> $new_value,
+			'form_tokens'	=> $this->form_helper->get_form_tokens(self::FORM_TOKEN_UCP),
+		]);
+	}
+
 	/**
 	 * Takes an avatar string (usually in full html format already) and extracts the url.
 	 * If the avatar url is a relative path, it's converted to an absolute path.
