[ticket/14039] Revamp updater

PHPBB3-14039
author: Mate Bartus <mate.bartus@gmail.com> 2015-07-24 09:20:50 +0200
committer: Mate Bartus <mate.bartus@gmail.com> 2015-10-17 23:05:57 +0200
commit: 8f5a0ad6f73e7b7757b02c827436384c96069b5a (patch)
tree: 87a16ddaa2f645d62728f0b4543199e43995bfeb /phpBB/phpbb/install/module/requirements
parent: f1047ac854baba4d1015cd9a555a523b3860f2c9 (diff)
download: forums-8f5a0ad6f73e7b7757b02c827436384c96069b5a.tar
forums-8f5a0ad6f73e7b7757b02c827436384c96069b5a.tar.gz
forums-8f5a0ad6f73e7b7757b02c827436384c96069b5a.tar.bz2
forums-8f5a0ad6f73e7b7757b02c827436384c96069b5a.tar.xz
forums-8f5a0ad6f73e7b7757b02c827436384c96069b5a.zip
5 files changed, 250 insertions, 17 deletions
diff --git a/phpBB/phpbb/install/module/requirements/module.php b/phpBB/phpbb/install/module/requirements/abstract_requirements_module.php
index 79a031bad9..26593e6777 100644
--- a/phpBB/phpbb/install/module/requirements/module.php
+++ b/phpBB/phpbb/install/module/requirements/abstract_requirements_module.php
@@ -15,8 +15,12 @@ namespace phpbb\install\module\requirements;
 
 use phpbb\install\exception\resource_limit_reached_exception;
 use phpbb\install\exception\user_interaction_required_exception;
+use phpbb\install\module_base;
 
-class module extends \phpbb\install\module_base
+/**
+ * Base class for requirements installer module
+ */
+abstract class abstract_requirements_module extends module_base
 {
 	public function run()
 	{
@@ -33,7 +37,7 @@ class module extends \phpbb\install\module_base
 		foreach ($this->task_collection as $name => $task)
 		{
 			// Run until there are available resources
-			if ($this->install_config->get_time_remaining() <= 0 && $this->install_config->get_memory_remaining() <= 0)
+			if ($this->install_config->get_time_remaining() <= 0 || $this->install_config->get_memory_remaining() <= 0)
 			{
 				throw new resource_limit_reached_exception();
 			}
@@ -99,12 +103,4 @@ class module extends \phpbb\install\module_base
 	{
 		return 0;
 	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_navigation_stage_path()
-	{
-		return array('install', 0, 'requirements');
-	}
 }
diff --git a/phpBB/phpbb/install/module/requirements/install_module.php b/phpBB/phpbb/install/module/requirements/install_module.php
new file mode 100644
index 0000000000..ed0c5fbd94
--- /dev/null
+++ b/phpBB/phpbb/install/module/requirements/install_module.php
@@ -0,0 +1,25 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+namespace phpbb\install\module\requirements;
+
+class install_module extends abstract_requirements_module
+{
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_navigation_stage_path()
+	{
+		return array('install', 0, 'requirements');
+	}
+}
diff --git a/phpBB/phpbb/install/module/requirements/task/check_filesystem.php b/phpBB/phpbb/install/module/requirements/task/check_filesystem.php
index ab6b1091e2..2aec3915e0 100644
--- a/phpBB/phpbb/install/module/requirements/task/check_filesystem.php
+++ b/phpBB/phpbb/install/module/requirements/task/check_filesystem.php
@@ -50,11 +50,9 @@ class check_filesystem extends \phpbb\install\task_base
 	 * @param \phpbb\install\helper\iohandler\iohandler_interface	$response			response helper
 	 * @param string												$phpbb_root_path	relative path to phpBB's root
 	 * @param string												$php_ext			extension of php files
+	 * @param bool													$check_config_php	Whether or not to check if config.php is writable
 	 */
-	public function __construct(\phpbb\filesystem\filesystem_interface $filesystem,
-								\phpbb\install\helper\iohandler\iohandler_interface $response,
-								$phpbb_root_path,
-								$php_ext)
+	public function __construct(\phpbb\filesystem\filesystem_interface $filesystem, \phpbb\install\helper\iohandler\iohandler_interface $response, $phpbb_root_path, $php_ext, $check_config_php = true)
 	{
 		parent::__construct(true);
 
@@ -87,12 +85,16 @@ class check_filesystem extends \phpbb\install\task_base
 				'failable' => true,
 				'is_file' => false,
 			),
-			array(
+		);
+
+		if ($check_config_php)
+		{
+			$this->files_to_check[] = array(
 				'path' => "config.$php_ext",
 				'failable' => false,
 				'is_file' => true,
-			),
-		);
+			);
+		}
 	}
 
 	/**
diff --git a/phpBB/phpbb/install/module/requirements/task/check_update.php b/phpBB/phpbb/install/module/requirements/task/check_update.php
new file mode 100644
index 0000000000..c986c76810
--- /dev/null
+++ b/phpBB/phpbb/install/module/requirements/task/check_update.php
@@ -0,0 +1,185 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+namespace phpbb\install\module\requirements\task;
+
+use phpbb\filesystem\filesystem;
+use phpbb\install\helper\container_factory;
+use phpbb\install\helper\iohandler\iohandler_interface;
+use phpbb\install\helper\update_helper;
+use phpbb\install\task_base;
+
+/**
+ * Check the availability of updater files and update version
+ */
+class check_update extends task_base
+{
+	/**
+	 * @var \phpbb\config\db
+	 */
+	protected $config;
+
+	/**
+	 * @var filesystem
+	 */
+	protected $filesystem;
+
+	/**
+	 * @var iohandler_interface
+	 */
+	protected $iohandler;
+
+	/**
+	 * @var update_helper
+	 */
+	protected $update_helper;
+
+	/**
+	 * @var \phpbb\version_helper
+	 */
+	protected $version_helper;
+
+	/**
+	 * @var string
+	 */
+	protected $phpbb_root_path;
+
+	/**
+	 * @var string
+	 */
+	protected $php_ext;
+
+	/**
+	 * @var bool
+	 */
+	protected $tests_passed;
+
+	/**
+	 * Constructor
+	 *
+	 * @param container_factory		$container
+	 * @param filesystem			$filesystem
+	 * @param iohandler_interface	$iohandler
+	 * @param update_helper			$update_helper
+	 * @param string				$phpbb_root_path
+	 * @param string				$php_ext
+	 */
+	public function __construct(container_factory $container, filesystem $filesystem, iohandler_interface $iohandler, update_helper $update_helper, $phpbb_root_path, $php_ext)
+	{
+		$this->filesystem		= $filesystem;
+		$this->iohandler		= $iohandler;
+		$this->update_helper	= $update_helper;
+		$this->phpbb_root_path	= $phpbb_root_path;
+		$this->php_ext			= $php_ext;
+		$this->tests_passed		= true;
+
+		$this->config			= $container->get('config');
+		$this->version_helper	= $container->get('version_helper');
+
+		parent::__construct(true);
+	}
+
+	/**
+	 * Sets $this->tests_passed
+	 *
+	 * @param	bool	$is_passed
+	 */
+	protected function set_test_passed($is_passed)
+	{
+		// If one test failed, tests_passed should be false
+		$this->tests_passed = $this->tests_passed && $is_passed;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function run()
+	{
+		// Array of update files
+		$update_files = array(
+			$this->phpbb_root_path . 'install/update',
+			$this->phpbb_root_path . 'install/update/index.' . $this->php_ext,
+		);
+
+		// Check for a valid update directory
+		if (!$this->filesystem->exists($update_files) || !$this->filesystem->is_readable($update_files))
+		{
+			$this->iohandler->add_error_message('UPDATE_FILES_NOT_FOUND');
+			$this->set_test_passed(false);
+
+			// If there are no update files, we can't check the version
+			return false;
+		}
+
+		// Recover version numbers
+		$update_info = array();
+		@include($this->phpbb_root_path . 'install/update/index.' . $this->php_ext);
+		$info = (empty($update_info) || !is_array($update_info)) ? false : $update_info;
+		$update_version = false;
+
+		if ($info !== false)
+		{
+			$update_version = (!empty($info['version']['to'])) ? trim($info['version']['to']) : false;
+		}
+
+		// Get current and latest version
+		try
+		{
+			$latest_version = $this->version_helper->get_latest_on_current_branch(true);
+		}
+		catch (\RuntimeException $e)
+		{
+			$latest_version = $update_version;
+		}
+
+		$current_version = (!empty($this->config['version_update_from'])) ? $this->config['version_update_from'] : $this->config['version'];
+
+		// Check if the update package
+		if (!$this->update_helper->phpbb_version_compare($current_version, $update_version, '<'))
+		{
+			$this->iohandler->add_error_message('NO_UPDATE_FILES_UP_TO_DATE');
+			$this->tests_passed = false;
+		}
+
+		// Check if the update package works with the installed version
+		if (empty($info['version']['from']) || $info['version']['from'] !== $current_version)
+		{
+			$this->iohandler->add_error_message(array('INCOMPATIBLE_UPDATE_FILES', $current_version, $info['version']['from'], $update_version));
+			$this->tests_passed = false;
+		}
+
+		// check if this is the latest update package
+		if ($this->update_helper->phpbb_version_compare($update_version, $latest_version, '<'))
+		{
+			$this->iohandler->add_warning_message(array('OLD_UPDATE_FILES', $info['version']['from'], $update_version, $latest_version));
+		}
+
+		return $this->tests_passed;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	static public function get_step_count()
+	{
+		return 0;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_task_lang_name()
+	{
+		return '';
+	}
+}
diff --git a/phpBB/phpbb/install/module/requirements/update_module.php b/phpBB/phpbb/install/module/requirements/update_module.php
new file mode 100644
index 0000000000..223d12faf3
--- /dev/null
+++ b/phpBB/phpbb/install/module/requirements/update_module.php
@@ -0,0 +1,25 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+namespace phpbb\install\module\requirements;
+
+class update_module extends abstract_requirements_module
+{
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_navigation_stage_path()
+	{
+		return array('update', 0, 'requirements');
+	}
+}
author	Mate Bartus <mate.bartus@gmail.com>	2015-07-24 09:20:50 +0200
committer	Mate Bartus <mate.bartus@gmail.com>	2015-10-17 23:05:57 +0200
commit	8f5a0ad6f73e7b7757b02c827436384c96069b5a (patch)
tree	87a16ddaa2f645d62728f0b4543199e43995bfeb /phpBB/phpbb/install/module/requirements
parent	f1047ac854baba4d1015cd9a555a523b3860f2c9 (diff)
download	forums-8f5a0ad6f73e7b7757b02c827436384c96069b5a.tar forums-8f5a0ad6f73e7b7757b02c827436384c96069b5a.tar.gz forums-8f5a0ad6f73e7b7757b02c827436384c96069b5a.tar.bz2 forums-8f5a0ad6f73e7b7757b02c827436384c96069b5a.tar.xz forums-8f5a0ad6f73e7b7757b02c827436384c96069b5a.zip