Merge branch 'main' into Release-1.0.0

iMattPro · web-flow · commit 074918eae53f · 2024-09-09T08:00:56.000-07:00
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -357,14 +357,14 @@ jobs:
                       db: "mcr.microsoft.com/mssql/server:2017-latest"
                       db_alias: 'MSSQL 2017'
                     - php: '7.3'
-                      db: "mcr.microsoft.com/mssql/server:2019-latest"
+                      db: "mcr.microsoft.com/mssql/server:2019-CU27-ubuntu-20.04"
                       db_alias: 'MSSQL 2019'
 
         name: PHP ${{ matrix.php }} - ${{ matrix.db_alias != '' && matrix.db_alias || matrix.db }}
 
         services:
             mssql:
-                image: ${{ matrix.db != 'mcr.microsoft.com/mssql/server:2017-latest' && matrix.db != 'mcr.microsoft.com/mssql/server:2019-latest' && 'mcr.microsoft.com/mssql/server:2017-latest' || matrix.db }}
+                image: ${{ matrix.db != 'mcr.microsoft.com/mssql/server:2017-latest' && matrix.db != 'mcr.microsoft.com/mssql/server:2019-CU27-ubuntu-20.04' && 'mcr.microsoft.com/mssql/server:2017-latest' || matrix.db }}
                 env:
                     SA_PASSWORD: "Pssw0rd_12"
                     ACCEPT_EULA: "y"
@@ -404,7 +404,7 @@ jobs:
               env:
                   MATRIX_DB: ${{ matrix.db }}
               run: |
-                  if [ $MATRIX_DB == 'mcr.microsoft.com/mssql/server:2017-latest' ] || [ $MATRIX_DB == 'mcr.microsoft.com/mssql/server:2019-latest' ]
+                  if [ $MATRIX_DB == 'mcr.microsoft.com/mssql/server:2017-latest' ] || [ $MATRIX_DB == 'mcr.microsoft.com/mssql/server:2019-CU27-ubuntu-20.04' ]
                   then
                       db='mssql'
                   else
diff --git a/composer.json b/composer.json
@@ -24,27 +24,34 @@
     ],
     "require": {
         "php": ">=7.3",
+        "ext-curl": "*",
+        "ext-json": "*",
+        "ext-mbstring": "*",
+        "ext-openssl": "*",
         "composer/installers": "~1.0",
         "minishlink/web-push": "^7.0"
     },
     "require-dev": {
         "phing/phing": "~2.4"
     },
-	"config": {
-		"allow-plugins": {
-			"composer/installers": true
-		}
-	},
-	"extra": {
+    "suggest": {
+        "ext-gmp": "Optional but better for performance"
+    },
+    "config": {
+        "allow-plugins": {
+            "composer/installers": true
+        }
+    },
+    "extra": {
         "display-name": "phpBB Browser Push Notifications",
         "soft-require": {
             "phpbb/phpbb": ">=3.3.12,<4.0.0@dev"
-		},
-		"version-check": {
-			"host": "www.phpbb.com",
-			"directory": "/customise/db/extension/webpushnotifications",
-			"filename": "version_check",
-			"ssl": true
+        },
+        "version-check": {
+            "host": "www.phpbb.com",
+            "directory": "/customise/db/extension/webpushnotifications",
+            "filename": "version_check",
+            "ssl": true
         }
     }
 }
diff --git a/config/services.yml b/config/services.yml
@@ -18,6 +18,7 @@ services:
             - '@phpbb.wpn.form_helper'
             - '@language'
             - '@template'
+            - '@user'
             - '@notification_manager'
             - '%core.root_path%'
         tags:
diff --git a/controller/manifest.php b/controller/manifest.php
@@ -61,6 +61,7 @@ public function handle(): JsonResponse
 		}
 
 		$board_path = $this->config['force_server_vars'] ? $this->config['script_path'] : $this->path_helper->get_web_root_path();
+		$board_url = generate_board_url();
 
 		$manifest = [
 			'name'			=> $this->config['sitename'],
@@ -76,12 +77,12 @@ public function handle(): JsonResponse
 		{
 			$manifest['icons'] = [
 				[
-					'src' => $this->config['icons_path'] . '/' . $this->config['pwa_icon_small'],
+					'src' => $board_url . '/' . $this->config['icons_path'] . '/' . $this->config['pwa_icon_small'],
 					'sizes' => '192x192',
 					'type' => 'image/png'
 				],
 				[
-					'src' => $this->config['icons_path'] . '/' . $this->config['pwa_icon_large'],
+					'src' => $board_url . '/' . $this->config['icons_path'] . '/' . $this->config['pwa_icon_large'],
 					'sizes' => '512x512',
 					'type' => 'image/png'
 				]
diff --git a/event/listener.php b/event/listener.php
@@ -10,16 +10,13 @@
 
 namespace phpbb\webpushnotifications\event;
 
-/**
- * @ignore
- */
-
 use FastImageSize\FastImageSize;
 use phpbb\config\config;
 use phpbb\controller\helper as controller_helper;
 use phpbb\language\language;
 use phpbb\notification\manager;
 use phpbb\template\template;
+use phpbb\user;
 use phpbb\webpushnotifications\form\form_helper;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
@@ -46,6 +43,9 @@ class listener implements EventSubscriberInterface
 	/* @var template */
 	protected $template;
 
+	/** @var user */
+	protected $user;
+
 	/* @var manager */
 	protected $phpbb_notifications;
 
@@ -61,27 +61,29 @@ class listener implements EventSubscriberInterface
 	 * @param form_helper $form_helper Form helper object
 	 * @param language $language Language object
 	 * @param template $template Template object
+	 * @param user $user
 	 * @param manager $phpbb_notifications Notifications manager object
 	 * @param $root_path
 	 */
-	public function __construct(config $config, controller_helper $controller_helper, FastImageSize $imagesize, form_helper $form_helper, language $language, template $template, manager $phpbb_notifications, $root_path)
+	public function __construct(config $config, controller_helper $controller_helper, FastImageSize $imagesize, form_helper $form_helper, language $language, template $template, user $user, manager $phpbb_notifications, $root_path)
 	{
 		$this->config = $config;
 		$this->controller_helper = $controller_helper;
 		$this->imagesize = $imagesize;
 		$this->form_helper = $form_helper;
 		$this->language = $language;
 		$this->template = $template;
+		$this->user = $user;
 		$this->phpbb_notifications = $phpbb_notifications;
 		$this->root_path = $root_path;
 	}
 
 	public static function getSubscribedEvents()
 	{
 		return [
+			'core.page_header_after'			=> [['load_template_data'], ['pwa_manifest']],
 			'core.ucp_display_module_before'	=> 'load_language',
 			'core.acp_main_notice'				=> 'compatibility_notice',
-			'core.page_header_after'			=> 'load_template_data',
 			'core.acp_board_config_edit_add'		=> 'acp_pwa_options',
 			'core.validate_config_variable'		=> 'validate_pwa_options',
 		];
@@ -92,23 +94,30 @@ public static function getSubscribedEvents()
 	 */
 	public function load_template_data()
 	{
+		if (!$this->can_use_notifications())
+		{
+			return;
+		}
+
 		$methods = $this->phpbb_notifications->get_subscription_methods();
 		$webpush_method = $methods['notification.method.phpbb.wpn.webpush'] ?? null;
 
-		if ($webpush_method !== null)
+		if ($webpush_method === null)
 		{
-			if (!$this->language->is_set('NOTIFICATION_METHOD_PHPBB_WPN_WEBPUSH'))
-			{
-				$this->language->add_lang('webpushnotifications_module_ucp', 'phpbb/webpushnotifications');
-			}
+			return;
+		}
 
-			$template_ary = $webpush_method['method']->get_ucp_template_data($this->controller_helper, $this->form_helper);
-			$this->template->assign_vars($template_ary);
+		if (!$this->language->is_set('NOTIFICATION_METHOD_PHPBB_WPN_WEBPUSH'))
+		{
+			$this->load_language();
 		}
+
+		$template_ary = $webpush_method['method']->get_ucp_template_data($this->controller_helper, $this->form_helper);
+		$this->template->assign_vars($template_ary);
 	}
 
 	/**
-	 * Load language file
+	 * Load language file (this is required for the UCP)
 	 */
 	public function load_language()
 	{
@@ -123,6 +132,19 @@ public function compatibility_notice()
 		$this->template->assign_var('S_WPN_COMPATIBILITY_NOTICE', phpbb_version_compare(PHPBB_VERSION, '4.0.0-dev', '>='));
 	}
 
+	/**
+	 * Assign template data for web manifest support
+	 *
+	 * @return void
+	 */
+	public function pwa_manifest()
+	{
+		$this->template->assign_vars([
+			'U_MANIFEST_URL'	=> $this->controller_helper->route('phpbb_webpushnotifications_manifest_controller'),
+			'U_TOUCH_ICON'		=> $this->config['pwa_icon_small'],
+		]);
+	}
+
 	/**
 	 * Progressive web app options for the ACP
 	 *
@@ -217,4 +239,16 @@ protected function add_error($event, $error_key, $param = null)
 		$error[] = $this->language->lang($error_key, $param);
 		$event['error'] = $error;
 	}
+
+	/**
+	 * Can notifications be used by the user?
+	 *
+	 * @return bool
+	 */
+	protected function can_use_notifications()
+	{
+		return $this->config['wpn_webpush_enable']
+			&& ANONYMOUS !== $this->user->id()
+			&& USER_IGNORE !== (int) $this->user->data['user_type'];
+	}
 }
diff --git a/ext.php b/ext.php
@@ -15,21 +15,35 @@
  */
 class ext extends \phpbb\extension\base
 {
+	/**
+	 * Require phpBB 3.3.12 due to new template and core events.
+	 */
+	public const PHPBB_MIN_VERSION = '3.3.12';
+
+	/**
+	 * Should not be installed in phpBB 4 because it already has push notifications.
+	 */
+	public const PHPBB_MAX_VERSION = '4.0.0-dev';
+
+	/**
+	 * Require PHP 7.3 due to 3rd party libraries included.
+	 */
+	public const PHP_MIN_VERSION = '7.3';
+
 	/**
 	 * @var array An array of installation error messages
 	 */
 	protected $errors = [];
 
 	/**
 	 * {@inheritdoc}
-	 *
-	 * Requires phpBB 3.3.12 due to new template and core events.
-	 * Should not be installed in phpBB 4.0.0-a1 because it already has push notifications.
-	 * Requires PHP 7.3 due to 3rd party libraries included.
 	 */
 	public function is_enableable()
 	{
-		return $this->check_phpbb_version()->check_php_version()->result();
+		return $this->check_phpbb_version()
+			->check_php_version()
+			->check_php_requirements()
+			->result();
 	}
 
 	/**
@@ -39,12 +53,12 @@ public function is_enableable()
 	 */
 	protected function check_phpbb_version()
 	{
-		if (phpbb_version_compare(PHPBB_VERSION, '3.3.12', '<'))
+		if (phpbb_version_compare(PHPBB_VERSION, self::PHPBB_MIN_VERSION, '<'))
 		{
 			$this->errors[] = 'PHPBB_VERSION_MIN_ERROR';
 		}
 
-		if (phpbb_version_compare(PHPBB_VERSION, '4.0.0-dev', '>='))
+		if (phpbb_version_compare(PHPBB_VERSION, self::PHPBB_MAX_VERSION, '>='))
 		{
 			$this->errors[] = 'PHPBB_VERSION_MAX_ERROR';
 		}
@@ -67,6 +81,24 @@ protected function check_php_version()
 		return $this;
 	}
 
+	/**
+	 * Check the installed PHP extensions meet this extension's requirements.
+	 *
+	 * @return \phpbb\webpushnotifications\ext
+	 */
+	protected function check_php_requirements()
+	{
+		foreach (['curl', 'mbstring', 'openssl'] as $extension)
+		{
+			if (!extension_loaded($extension))
+			{
+				$this->errors[] = ['PHP_EXT_MISSING', $extension];
+			}
+		}
+
+		return $this;
+	}
+
 	/**
 	 * Return the is_enableable result. Either true, or the best enable failed
 	 * response for the current phpBB environment: array of error messages
@@ -85,7 +117,9 @@ protected function result()
 		{
 			$language = $this->container->get('language');
 			$language->add_lang('install', 'phpbb/webpushnotifications');
-			return array_map([$language, 'lang'], $this->errors);
+			return array_map(static function($error) use ($language) {
+				return call_user_func_array([$language, 'lang'], (array) $error);
+			}, $this->errors);
 		}
 
 		return false;
diff --git a/language/en/install.php b/language/en/install.php
@@ -38,7 +38,8 @@
 //
 
 $lang = array_merge($lang, [
-	'PHPBB_VERSION_MAX_ERROR'	=> 'This extension can not be installed on your board. You are using phpBB 4, which already contains the features in this extension.',
-	'PHPBB_VERSION_MIN_ERROR'	=> 'This extension is not compatible with your board. You must be using phpBB 3.3.12 or newer.',
-	'PHP_VERSION_ERROR'	=> 'This extension is not compatible with your server. Your server must be running PHP 7.3 or newer.',
+	'PHPBB_VERSION_MAX_ERROR'	=> 'This extension can not be installed on this board. This is a phpBB 4 board, which already contains the features in this extension.',
+	'PHPBB_VERSION_MIN_ERROR'	=> 'phpBB ' . \phpbb\webpushnotifications\ext::PHPBB_MIN_VERSION . ' or newer is required.',
+	'PHP_VERSION_ERROR'			=> 'PHP ' . \phpbb\webpushnotifications\ext::PHP_MIN_VERSION . ' or newer is required.',
+	'PHP_EXT_MISSING'			=> 'The “%s” extension for PHP must be installed on this server.',
 ]);
diff --git a/language/ru/install.php b/language/ru/install.php
@@ -39,6 +39,7 @@
 
 $lang = array_merge($lang, [
 	'PHPBB_VERSION_MAX_ERROR'	=> 'Данное расширение несовместимо с установленной версией конференции. Вы используете версию phpBB 4, которая уже содержит соответствующие функции.',
-	'PHPBB_VERSION_MIN_ERROR'	=> 'Данное расширение несовместимо с установленной версией конференции. Необходима версия phpBB 3.3.12 или выше.',
-	'PHP_VERSION_ERROR'	=> 'Данное расширение несовместимо с установленной на сервере версией PHP. Необходима версия PHP 7.3 или выше.',
+	'PHPBB_VERSION_MIN_ERROR'	=> 'Данное расширение несовместимо с установленной версией конференции. Необходима версия phpBB ' . \phpbb\webpushnotifications\ext::PHPBB_MIN_VERSION . ' или выше.',
+	'PHP_VERSION_ERROR'			=> 'Данное расширение несовместимо с установленной на сервере версией PHP. Необходима версия PHP ' . \phpbb\webpushnotifications\ext::PHP_MIN_VERSION . ' или выше.',
+	'PHP_EXT_MISSING'			=> 'На этом сервере должно быть установлено расширение «%s» для PHP.',
 ]);
diff --git a/notification/method/webpush.php b/notification/method/webpush.php
@@ -378,15 +378,13 @@ public function get_ucp_template_data(helper $controller_helper, form_helper $fo
 		}
 
 		return [
-			'NOTIFICATIONS_WEBPUSH_ENABLE'	=> $this->allowed_user() && ($this->config['wpn_webpush_dropdown_subscribe'] || stripos($this->user->page['page'], 'notification_options')),
+			'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'),
 			'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),
-			'U_MANIFEST_URL'				=> $controller_helper->route('phpbb_webpushnotifications_manifest_controller'),
-			'U_TOUCH_ICON'					=> $this->config['pwa_icon_small'],
 		];
 	}
 
@@ -552,17 +550,4 @@ protected function load_recipients_data(): array
 
 		return $notify_users;
 	}
-
-	/**
-	 * User is allowed to use web push notifications
-	 *
-	 * @return bool
-	 */
-	protected function allowed_user()
-	{
-		return $this->user->id() !== ANONYMOUS
-			&& !$this->user->data['is_bot']
-			&& (int) $this->user->data['user_type'] !== USER_IGNORE
-			&& (int) $this->user->data['user_type'] !== USER_INACTIVE;
-	}
 }
diff --git a/styles/all/template/event/overall_header_head_append.html b/styles/all/template/event/overall_header_head_append.html
@@ -1,3 +1,9 @@
+<meta name="apple-mobile-web-app-capable" content="yes">
+<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
+<meta name="apple-mobile-web-app-title" content="{{ SITENAME }}">
+<link rel="manifest" href="{{ U_MANIFEST_URL }}">
+{% if U_TOUCH_ICON %}<link rel="apple-touch-icon" href="{{ T_ICONS_PATH ~ U_TOUCH_ICON }}">{% endif %}
+
 {% if NOTIFICATIONS_WEBPUSH_ENABLE %}
 	{% include '@phpbb_webpushnotifications/ucp_notifications_webpush.html' %}
 {% endif %}
diff --git a/styles/all/template/ucp_notifications_webpush.html b/styles/all/template/ucp_notifications_webpush.html
diff --git a/styles/all/template/webpush.js b/styles/all/template/webpush.js
diff --git a/tests/event/listener_test.php b/tests/event/listener_test.php
diff --git a/tests/notification/notification_method_webpush_test.php b/tests/notification/notification_method_webpush_test.php
diff --git a/ucp/controller/webpush.php b/ucp/controller/webpush.php

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ public function handle(): JsonResponse`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`$board_path = $this->config['force_server_vars'] ? $this->config['script_path'] : $this->path_helper->get_web_root_path();`
	`64`	`+ $board_url = generate_board_url();`
`64`	`65`
`65`	`66`	`$manifest = [`
`66`	`67`	`'name' => $this->config['sitename'],`
`@@ -76,12 +77,12 @@ public function handle(): JsonResponse`
`76`	`77`	`{`
`77`	`78`	`$manifest['icons'] = [`
`78`	`79`	`[`
`79`		`- 'src' => $this->config['icons_path'] . '/' . $this->config['pwa_icon_small'],`
	`80`	`+ 'src' => $board_url . '/' . $this->config['icons_path'] . '/' . $this->config['pwa_icon_small'],`
`80`	`81`	`'sizes' => '192x192',`
`81`	`82`	`'type' => 'image/png'`
`82`	`83`	`],`
`83`	`84`	`[`
`84`		`- 'src' => $this->config['icons_path'] . '/' . $this->config['pwa_icon_large'],`
	`85`	`+ 'src' => $board_url . '/' . $this->config['icons_path'] . '/' . $this->config['pwa_icon_large'],`
`85`	`86`	`'sizes' => '512x512',`
`86`	`87`	`'type' => 'image/png'`
`87`	`88`	`]`