Merge branch 'main' into Release-1.0.0

Signed-off-by: Matt Friedman <maf675@gmail.com>

# Conflicts:
#	CHANGELOG.md
#	composer.json

Author: iMattPro

.github/workflows/tests.yml

@@ -125,6 +125,8 @@ jobs:
                       db: "mysql:5.7"
                     - php: '8.3'
                       db: "mysql:5.7"
+                    - php: '8.4'
+                      db: "mysql:5.7"
 
         name: PHP ${{ matrix.php }} - ${{ matrix.db_alias != '' && matrix.db_alias || matrix.db }}
 
@@ -247,6 +249,8 @@ jobs:
                       db: "postgres:14"
                     - php: '8.3'
                       db: "postgres:14"
+                    - php: '8.4'
+                      db: "postgres:14"
 
         name: PHP ${{ matrix.php }} - ${{ matrix.db }}
 

CHANGELOG.md

@@ -1,9 +1,18 @@
 # Changelog
 
-### 1.0.0 - 2024-06-16
+### 1.0.0 - 2024-07-01
 
 - First official release.
 
+### 1.0.0-RC10 - 2024-07-01
+
+- Apple mobile devices are now supported through the implementation of progressive web app capabilities.
+- Notifications are now sent in the recipient’s preferred board language.
+- Re-worded and redesigned the enable/subscribe push notification buttons:
+  - In the UCP, the enable/subscribe button clearly indicates its state.
+  - The enable/subscribe toggle in the notification dropdown is now hidden if subscribing is not supported.
+- Added a warning message in the ACP for boards on servers that are not compatible with push notifications.
+
 ### 1.0.0-RC9 - 2024-06-16
 
 - The subscribe toggle in the notification dropdown has been optimized for better mobile usability.

README.md

@@ -37,16 +37,16 @@ Testing push notifications necessitates user-to-user interactions to observe the
 
 1. **User Account Setup:**
 	- Create at least two distinct user accounts for testing purposes.
-    - In user1's account notifications preferences, assign web push notifications and subscribe to receive Push Notifications.
+    - In the notifications preferences for _**User Account 1**_, subscribe to receive Push Notifications (and assign web push notification types if necessary).
 
 2. **Message, Quote, or Reply Interaction:**
-	- Initiate a user-to-user interaction by performing one of the following actions using "User Account 2":
-		- **Private Message:** Send a direct message from "User Account 2" to "User Account 1".
-		- **Quote:** Quote a post or message authored by "User Account 1" using "User Account 2".
-		- **Reply:** Respond to a post or message authored by "User Account 1" using "User Account 2".
+	- Initiate a user-to-user interaction by performing one of the following actions using _**User Account 2**_:
+		- **Private Message:** Send a direct message from _**User Account 2**_ to _**User Account 1**_.
+		- **Quote:** Quote a post or message authored by _**User Account 1**_ using _**User Account 2**_.
+		- **Reply:** Respond to a post or message authored by _**User Account 1**_ using _**User Account 2**_.
 
 3. **Observing Push Notifications:**
-	- Once the interaction is performed from "User Account 2" to engage with "User Account 1," you promptly should see a notification for "User Account 1."
+	- Once the interaction is performed from _**User Account 2**_ to engage with _**User Account 1**_, you promptly should see a notification for _**User Account 1**_.
 
 4. **Caveats for Local Testing**
     - Local testing of Push Notifications only works from a `localhost` address or if your local server has a secure SSL certificate.

acp/wpn_acp_module.php

@@ -105,6 +105,13 @@ public function display_settings()
 			'S_WEBPUSH_METHOD_ENABLED' 		=> $this->config['wpn_webpush_method_enabled'],
 			'U_ACTION'						=> $this->u_action,
 		]);
+
+		if (!$this->request->server('HTTPS', false) && $this->request->server('SERVER_NAME') !== 'localhost')
+		{
+			$this->errors[] = $this->lang->lang('WEBPUSH_INSECURE_SERVER_ERROR');
+		}
+
+		$this->display_errors();
 	}
 
 	/**
@@ -135,13 +142,8 @@ public function save_settings()
 			validate_config_vars($display_settings, $config_array, $this->errors);
 		}
 
-		if (count($this->errors))
+		if ($this->display_errors())
 		{
-			$this->template->assign_vars([
-				'S_ERROR'			=> (bool) count($this->errors),
-				'ERROR_MSG'			=> implode('<br>', $this->errors),
-			]);
-
 			return;
 		}
 
@@ -154,4 +156,21 @@ public function save_settings()
 
 		trigger_error($this->lang->lang('CONFIG_UPDATED') . adm_back_link($this->u_action), E_USER_NOTICE);
 	}
+
+	/**
+	 * Display any errors
+	 *
+	 * @return bool
+	 */
+	public function display_errors()
+	{
+		$has_errors = (bool) count($this->errors);
+
+		$this->template->assign_vars([
+			'S_ERROR'	=> $has_errors,
+			'ERROR_MSG'	=> $has_errors ? implode('<br>', $this->errors) : '',
+		]);
+
+		return $has_errors;
+	}
 }

config/routing.yml

@@ -1,3 +1,7 @@
 phpbb_webpushnotifications_ucp_routing:
     resource: wpn_ucp.yml
     prefix: /user
+
+phpbb_webpushnotifications_manifest_controller:
+    path: /manifest
+    defaults: { _controller: phpbb.wpn.controller.manifest:handle }

config/services.yml

@@ -12,11 +12,14 @@ services:
     phpbb.wpn.listener:
         class: phpbb\webpushnotifications\event\listener
         arguments:
+            - '@config'
             - '@controller.helper'
+            - '@upload_imagesize'
             - '@phpbb.wpn.form_helper'
             - '@language'
             - '@template'
             - '@notification_manager'
+            - '%core.root_path%'
         tags:
             - { name: event.listener }
 
@@ -26,6 +29,7 @@ services:
         arguments:
             - '@config'
             - '@dbal.conn'
+            - '@language'
             - '@log'
             - '@user_loader'
             - '@user'
@@ -51,3 +55,10 @@ services:
             - '%tables.phpbb.wpn.notification_push%'
             - '%tables.phpbb.wpn.push_subscriptions%'
 
+    phpbb.wpn.controller.manifest:
+        class: phpbb\webpushnotifications\controller\manifest
+        arguments:
+            - '@config'
+            - '@language'
+            - '@path_helper'
+            - '@user'

controller/manifest.php

@@ -0,0 +1,93 @@
+<?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\controller;
+
+use phpbb\config\config;
+use phpbb\exception\http_exception;
+use phpbb\language\language;
+use phpbb\path_helper;
+use phpbb\user;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+
+class manifest
+{
+	/** @var config */
+	protected $config;
+
+	/** @var language */
+	protected $language;
+
+	/** @var path_helper */
+	protected $path_helper;
+
+	/** @var user */
+	protected $user;
+
+	/**
+	 * Constructor for webpush controller
+	 *
+	 * @param config $config
+	 * @param path_helper $path_helper
+	 * @param language $language
+	 * @param user $user
+	 */
+	public function __construct(config $config, language $language, path_helper $path_helper, user $user)
+	{
+		$this->config = $config;
+		$this->path_helper = $path_helper;
+		$this->language = $language;
+		$this->user = $user;
+	}
+
+	/**
+	 * Handle creation of a manifest json file for progressive web-app support
+	 *
+	 * @return JsonResponse
+	 */
+	public function handle(): JsonResponse
+	{
+		if ($this->user->data['is_bot'] || $this->user->data['user_type'] == USER_INACTIVE)
+		{
+			throw new http_exception(Response::HTTP_FORBIDDEN, 'Forbidden');
+		}
+
+		$board_path = $this->config['force_server_vars'] ? $this->config['script_path'] : $this->path_helper->get_web_root_path();
+
+		$manifest = [
+			'name'			=> $this->config['sitename'],
+			'short_name'	=> $this->config['pwa_short_name'] ?: substr($this->config['sitename'], 0, 12),
+			'display'		=> 'standalone',
+			'orientation'	=> 'portrait',
+			'dir'			=> $this->language->lang('DIRECTION'),
+			'start_url'		=> $board_path,
+			'scope'			=> $board_path,
+		];
+
+		if (!empty($this->config['pwa_icon_small']) && !empty($this->config['pwa_icon_large']))
+		{
+			$manifest['icons'] = [
+				[
+					'src' => $this->config['icons_path'] . '/' . $this->config['pwa_icon_small'],
+					'sizes' => '192x192',
+					'type' => 'image/png'
+				],
+				[
+					'src' => $this->config['icons_path'] . '/' . $this->config['pwa_icon_large'],
+					'sizes' => '512x512',
+					'type' => 'image/png'
+				]
+			];
+		}
+
+		return new JsonResponse($manifest);
+	}
+}