Merge pull request #190 from iMattPro/develop

Improve PHP and phpBB compatibility checks

Author: iMattPro

README.md

@@ -15,7 +15,7 @@ QuickInstall is a tool we built to support the community of phpBB extension deve
 4. Point your web browser to the QuickInstall directory (`http://localhost/quickinstall` for instance) and follow the setup instructions.
 
 > **Alternate phpBB Profiles:**<br>
-> You can store additional versions of phpBB and boards with alternate styles or language packs in `sources/phpBB3_alt/` . You can name these alternate phpBB folders whatever you want, e.g.:  `sources/phpBB3_alt/phpBB-3.0.12`, `sources/phpBB3_alt/phpBB-sv`, etc. They will then be available as alternative phpBB3 boards you can choose to install or save as Profiles.
+> You can store additional versions of phpBB and boards with alternate styles or language packs in `sources/phpBB3_alt/` . You can name these alternate phpBB folders whatever you want, e.g.:  `sources/phpBB3_alt/phpBB-3.0.12`, `sources/phpBB3_alt/phpBB-sv`, etc. They will then be available as alternative phpBB3 boards you can choose to install or save as Profiles. [Past releases of phpBB can be downloaded here](https://download.phpbb.com/pub/release/).
 
 > **Adding phpBB Extras**:<br>
 > If you want additional files/folders, such as extensions, to be copied to your boards when they are created, you can put them in the `sources/extra/` directory. By using the same directory structure in `sources/extra/` as phpBB, the files/folders should be mapped to the correct locations in your boards. For example: `sources/extra/ext/phpbb/pages`.

includes/qi.php

@@ -866,4 +866,39 @@ public static function phpbb_version_compare($version1, $version2, $operator = n
 		}
 		return version_compare($version1, $version2, $operator);
 	}
+
+	/**
+	 * Check phpBB compatibility with the PHP environment
+	 *
+	 * phpBB 3.1.x is not compat with PHP >= 7 (700000)
+	 * phpBB 3.2.0-3.2.1 is not compat with PHP >= 7.2 (702000)
+	 * phpBB 3.2.x is not compat with PHP >= 7.3 (703000)
+	 * phpBB 3.3.x is not compat with PHP < 7.1.3 (70103)
+	 * phpBB 4.0.x is not compat with PHP < 7.3 (703000)
+	 *
+	 * @param string $phpbb_version Check a given phpBB version. If none given, will check QI's loaded phpBB.
+	 *
+	 * @return bool
+	 */
+	public static function php_phpbb_incompatible($phpbb_version = '')
+	{
+		if ($phpbb_version)
+		{
+			return
+				(PHP_VERSION_ID >= 70000 && self::phpbb_version_compare($phpbb_version, '3.2', '<')) ||
+				(PHP_VERSION_ID >= 70200 && self::phpbb_version_compare($phpbb_version, '3.2.2', '<')) ||
+				(PHP_VERSION_ID >= 70300 && self::phpbb_version_compare($phpbb_version, '3.3', '<')) ||
+				(PHP_VERSION_ID < 70103 && self::phpbb_version_compare($phpbb_version, '3.3', '>=')) ||
+				(PHP_VERSION_ID < 70300 && self::phpbb_version_compare($phpbb_version, '4.0', '>='))
+			;
+		}
+
+		return
+			(PHP_VERSION_ID >= 70000 && !defined('PHPBB_32')) ||
+			(PHP_VERSION_ID >= 70200 && self::phpbb_version_compare(PHPBB_VERSION, '3.2.2', '<')) ||
+			(PHP_VERSION_ID >= 70300 && !defined('PHPBB_33')) ||
+			(PHP_VERSION_ID < 70103 && defined('PHPBB_33')) ||
+			(PHP_VERSION_ID < 70300 && defined('PHPBB_40'))
+		;
+	}
 }

includes/settings.php

@@ -166,6 +166,16 @@ public function validate()
 			$validation_errors[] = ['BOARDS_DIR_MISSING', $this->get_boards_dir()];
 		}
 
+		// Validate alt environment board's compatibility with current PHP environment
+		if ($this->settings['alt_env'])
+		{
+			$phpbb_version = get_phpbb_version($this->qi_path . 'sources/phpBB3_alt/' . $this->settings['alt_env']);
+			if (qi::php_phpbb_incompatible($phpbb_version))
+			{
+				$validation_errors[] = ['PHP_INCOMPATIBLE', $phpbb_version, PHP_VERSION];
+			}
+		}
+
 		// Adjust boards URL path
 		qi_file::append_slash($this->settings['boards_url']);
 

language/en/qi.php

@@ -230,7 +230,7 @@
 	'PHPBB_QI_FULLLINK'	=> '<a href="https://www.phpbb.com/customise/db/official_tool/phpbb3_quickinstall/">phpBB<small><sup>&reg;</sup></small> QuickInstall</a> %s for phpBB 3.0 - 4.0',
 	'PHPBB_QI_TITLE'	=> 'phpBB&reg; QuickInstall',
 
-	'PHP7_INCOMPATIBLE'	=> 'The board you are trying to install, phpBB %1$s, is not compatible with PHP %2$s.',
+	'PHP_INCOMPATIBLE'	=> 'The board you are trying to use, phpBB %1$s, is not compatible with PHP %2$s. Refer to the Documentation for our compatibility grid.',
 	'PHPINFO'			=> 'PHP info',
 	'PHPINFO_TITLE'		=> 'PHP information',
 	'PHPINFO_EXPLAIN'	=> 'This page lists information on the version of PHP installed on this server. It includes details of loaded modules, available variables and default settings. This information may be useful when diagnosing problems.<br /><br />Please be aware that some hosting companies will limit what information is displayed here for security reasons.<br /><br />You are advised to only give out details on this page on a need to know basis.',

modules/qi_create.php

@@ -22,15 +22,10 @@ public function run()
 		// postgres uses remove_comments function which is defined in functions_admin
 		include($phpbb_root_path . 'includes/functions_admin.' . $phpEx);
 
-		// phpBB 3.1.x is not compat with PHP 7 (700000)
-		// phpBB 3.2.0-3.2.1 is not compat with PHP 7.2 (702000)
-		// phpBB 3.2.x is not compat with PHP 7.3 (703000)
-		if ((PHP_VERSION_ID >= 70000 && !defined('PHPBB_32')) ||
-			(PHP_VERSION_ID >= 70200 && qi::phpbb_version_compare(PHPBB_VERSION, '3.2.2', '<')) ||
-			(PHP_VERSION_ID >= 70300 && !defined('PHPBB_33'))
-		)
-		{
-			trigger_error(qi::lang('PHP7_INCOMPATIBLE', PHPBB_VERSION, PHP_VERSION));
+		// Validate board's compatibility with current PHP environment
+		if (qi::php_phpbb_incompatible())
+		{
+			trigger_error(qi::lang('PHP_INCOMPATIBLE', PHPBB_VERSION, PHP_VERSION));
 		}
 
 		if (defined('PHPBB_31'))