[ticket/14039] Revamp updater

PHPBB3-14039
2025-07-30 21:40:43 +02:00 · 2015-07-24 09:20:50 +02:00
parent f1047ac854
commit 8f5a0ad6f7
94 changed files with 4514 additions and 263 deletions
--- a/phpBB/phpbb/install/module/update_database/task/update.php
+++ b/phpBB/phpbb/install/module/update_database/task/update.php
@@ -0,0 +1,212 @@
+<?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\update_database\task;
+
+use phpbb\db\migration\exception;
+use phpbb\db\output_handler\installer_migrator_output_handler;
+use phpbb\db\output_handler\log_wrapper_migrator_output_handler;
+use phpbb\install\exception\resource_limit_reached_exception;
+use phpbb\install\exception\user_interaction_required_exception;
+use phpbb\install\task_base;
+
+/**
+ * Database updater task
+ */
+class update extends task_base
+{
+	/**
+	 * @var \phpbb\cache\driver\driver_interface
+	 */
+	protected $cache;
+
+	/**
+	 * @var \phpbb\config\config
+	 */
+	protected $config;
+
+	/**
+	 * @var \phpbb\extension\manager
+	 */
+	protected $extension_manager;
+
+	/**
+	 * @var \phpbb\filesystem\filesystem
+	 */
+	protected $filesystem;
+
+	/**
+	 * @var \phpbb\install\helper\config
+	 */
+	protected $installer_config;
+
+	/**
+	 * @var \phpbb\install\helper\iohandler\iohandler_interface
+	 */
+	protected $iohandler;
+
+	/**
+	 * @var \phpbb\language\language
+	 */
+	protected $language;
+
+	/**
+	 * @var \phpbb\log\log
+	 */
+	protected $log;
+
+	/**
+	 * @var \phpbb\db\migrator
+	 */
+	protected $migrator;
+
+	/**
+	 * @var \phpbb\user
+	 */
+	protected $user;
+
+	/**
+	 * @var string
+	 */
+	protected $phpbb_root_path;
+
+	/**
+	 * Constructor
+	 *
+	 * @param \phpbb\install\helper\container_factory				$container
+	 * @param \phpbb\filesystem\filesystem							$filesystem
+	 * @param \phpbb\install\helper\config							$installer_config
+	 * @param \phpbb\install\helper\iohandler\iohandler_interface	$iohandler
+	 * @param \phpbb\language\language								$language
+	 * @param string												$phpbb_root_path
+	 */
+	public function __construct(\phpbb\install\helper\container_factory $container, \phpbb\filesystem\filesystem $filesystem, \phpbb\install\helper\config $installer_config, \phpbb\install\helper\iohandler\iohandler_interface $iohandler, \phpbb\language\language $language, $phpbb_root_path)
+	{
+		$this->filesystem			= $filesystem;
+		$this->installer_config		= $installer_config;
+		$this->iohandler			= $iohandler;
+		$this->language				= $language;
+		$this->phpbb_root_path		= $phpbb_root_path;
+
+		$this->cache				= $container->get('cache.driver');
+		$this->config				= $container->get('config');
+		$this->extension_manager	= $container->get('ext.manager');
+		$this->log					= $container->get('log');
+		$this->migrator				= $container->get('migrator');
+		$this->user					= $container->get('user');
+
+		parent::__construct(true);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function run()
+	{
+		$this->language->add_lang('migrator');
+
+		if (!isset($this->config['version_update_from']))
+		{
+			$this->config->set('version_update_from', $this->config['version']);
+		}
+
+		$original_version = $this->config['version_update_from'];
+
+		$this->migrator->set_output_handler(
+			new log_wrapper_migrator_output_handler(
+				$this->language,
+				new installer_migrator_output_handler($this->iohandler),
+				$this->phpbb_root_path . 'store/migrations_' . time() . '.log',
+				$this->filesystem
+			)
+		);
+
+		$this->migrator->create_migrations_table();
+
+		$migrations = $this->extension_manager
+			->get_finder()
+			->core_path('phpbb/db/migration/data/')
+			->extension_directory('/migrations')
+			->get_classes();
+
+		$this->migrator->set_migrations($migrations);
+		$migration_count = count($migrations);
+		$this->iohandler->set_task_count($migration_count, true);
+		$progress_count = $this->installer_config->get('database_update_count', 0);
+
+		while (!$this->migrator->finished())
+		{
+			try
+			{
+				$this->migrator->update();
+				$progress_count++;
+				$this->iohandler->set_progress('STAGE_UPDATE_DATABASE', $progress_count);
+			}
+			catch (exception $e)
+			{
+				$msg = $e->getParameters();
+				array_unshift($msg, $e->getMessage());
+
+				$this->iohandler->add_error_message($msg);
+				throw new user_interaction_required_exception();
+			}
+
+			if ($this->installer_config->get_time_remaining() <= 0 || $this->installer_config->get_memory_remaining() <= 0)
+			{
+				$this->installer_config->set('database_update_count', $progress_count);
+				throw new resource_limit_reached_exception();
+			}
+		}
+
+		if ($original_version !== $this->config['version'])
+		{
+			$this->log->add(
+				'admin',
+				$this->user->data['user_id'],
+				$this->user->ip,
+				'LOG_UPDATE_DATABASE',
+				false,
+				array(
+					$original_version,
+					$this->config['version']
+				)
+			);
+		}
+
+		$this->iohandler->finish_progress('INLINE_UPDATE_SUCCESSFUL');
+
+		$this->iohandler->add_success_message('INLINE_UPDATE_SUCCESSFUL');
+
+		$this->config->delete('version_update_from');
+
+		$this->cache->purge();
+
+		$this->config->increment('assets_version', 1);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	static public function get_step_count()
+	{
+		return 0;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_task_lang_name()
+	{
+		return '';
+	}
+}