Merge pull request #76 from iMattPro/improvements

Add better PHP requirement checks

Author: iMattPro

.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

composer.json

@@ -24,26 +24,33 @@
     ],
     "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": "imattpro.github.io",
-			"directory": "/version",
-			"filename": "webpushnotifications.json"
+        },
+        "version-check": {
+            "host": "imattpro.github.io",
+            "directory": "/version",
+            "filename": "webpushnotifications.json"
         }
     }
 }

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;

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.',
 ]);

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.',
 ]);