1 files changed, 259 insertions, 0 deletions
diff --git a/phpBB/install/helper/config.php b/phpBB/install/helper/config.php
new file mode 100644
index 0000000000..b759df737e
--- /dev/null
+++ b/phpBB/install/helper/config.php
@@ -0,0 +1,259 @@
+<?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\helper;
+
+/**
+ * Stores common settings and installation status
+ */
+class config
+{
+	/**
+	 * @var \phpbb\filesystem\filesystem_interface
+	 */
+	protected $filesystem;
+
+	/**
+	 * Array which contains config settings for the installer
+	 *
+	 * The array will also store all the user input, as well as any
+	 * data that is passed to other tasks by a task.
+	 *
+	 * @var array
+	 */
+	protected $installer_config;
+
+	/**
+	 * @var string
+	 */
+	protected $install_config_file;
+
+	/**
+	 * @var \phpbb\php\ini
+	 */
+	protected $php_ini;
+
+	/**
+	 * @var string
+	 */
+	protected $phpbb_root_path;
+
+	/**
+	 * Array containing progress information
+	 *
+	 * @var array
+	 */
+	protected $progress_data;
+
+	/**
+	 * Array containing system information
+	 *
+	 * The array contains run time and memory limitations.
+	 *
+	 * @var array
+	 */
+	protected $system_data;
+
+	/**
+	 * Constructor
+	 */
+	public function __construct(\phpbb\filesystem\filesystem_interface $filesystem, \phpbb\php\ini $php_ini, $phpbb_root_path)
+	{
+		$this->filesystem		= $filesystem;
+		$this->php_ini			= $php_ini;
+		$this->phpbb_root_path	= $phpbb_root_path;
+
+		// Set up data arrays
+		$this->installer_config	= array();
+		$this->system_data		= array();
+		$this->progress_data	= array(
+			'last_task_module_index'	=> 0,
+			'last_task_module_name'		=> '', // Stores the service name of the latest finished module
+			'last_task_index'			=> 0,
+			'last_task_name'			=> '', // Stores the service name of the latest finished task
+		);
+
+		$this->install_config_file = $this->phpbb_root_path . 'store/install_config.php';
+
+		$this->setup_system_data();
+	}
+
+	/**
+	 * Returns data for a specified parameter
+	 *
+	 * @param	string	$param_name	Name of the parameter to return
+	 * @param	mixed	$default	Default value to return when the specified data
+	 * 								does not exist.
+	 *
+	 * @return 	mixed	value of the specified parameter or the default value if the data
+	 * 					cannot be recovered.
+	 */
+	public function get($param_name, $default = false)
+	{
+		return (isset($this->installer_config[$param_name])) ? $this->installer_config[$param_name] : $default;
+	}
+
+	/**
+	 * Sets a parameter in installer_config
+	 *
+	 * @param	string	$param_name	Name of the parameter
+	 * @param	mixed	$value		Values to set the parameter
+	 *
+	 * @return null
+	 */
+	public function set($param_name, $value)
+	{
+		$this->installer_config = array_merge($this->installer_config, array(
+			$param_name => $value,
+		));
+	}
+
+	/**
+	 * Returns system parameter
+	 *
+	 * @param string	$param_name	Name of the parameter
+	 *
+	 * @return mixed	Returns system parameter if it is defined, false otherwise
+	 */
+	public function system_get($param_name)
+	{
+		return (isset($this->system_data[$param_name])) ? $this->system_data[$param_name] : false;
+	}
+
+	/**
+	 * Returns remaining time until the run time limit
+	 *
+	 * @return int	Remaining time until the run time limit in seconds
+	 */
+	public function get_time_remaining()
+	{
+		return ($this->system_data['start_time'] + $this->system_data['max_execution_time']) - time();
+	}
+
+	/**
+	 * Returns remaining memory available for PHP
+	 *
+	 * @return int	Remaining memory until reaching the limit
+	 */
+	public function get_memory_remaining()
+	{
+		if (function_exists('memory_get_usage'))
+		{
+			return ($this->system_data['memory_limit'] - memory_get_usage());
+		}
+
+		// If we cannot get the information then just return a positive number (and cross fingers)
+		return 1;
+	}
+
+	/**
+	 * Saves the latest executed task
+	 *
+	 * @param string	$task_service_name	Name of the installer task service
+	 * @param int		$task_index			Index of the task in the task list array
+	 *
+	 * @return null
+	 */
+	public function set_finished_task($task_service_name, $task_index)
+	{
+		$this->progress_data['last_task_name']	= $task_service_name;
+		$this->progress_data['last_task_index']	= $task_index;
+	}
+
+	/**
+	 * Set active module
+	 *
+	 * @param string	$module_service_name	Name of the installer module service
+	 * @param int		$module_index			Index of the module in the module list array
+	 *
+	 * @return null
+	 */
+	public function set_active_module($module_service_name, $module_index)
+	{
+		$this->progress_data['last_task_module_name']	= $module_service_name;
+		$this->progress_data['last_task_module_index']	= $module_index;
+	}
+
+	/**
+	 * Getter for progress data
+	 *
+	 * @return array
+	 */
+	public function get_progress_data()
+	{
+		return $this->progress_data;
+	}
+
+	/**
+	 * Recovers install configuration from file
+	 *
+	 * @return null
+	 */
+	public function load_config()
+	{
+		if (!$this->filesystem->exists($this->install_config_file))
+		{
+			return;
+		}
+
+		$file_content = @file_get_contents($this->install_config_file);
+		$serialized_data = trim(substr($file_content, 8));
+		$unserialized_data = unserialize($serialized_data);
+
+		$this->installer_config = $unserialized_data['installer_config'];
+		$this->progress_data = $unserialized_data['progress_data'];
+	}
+
+	/**
+	 * Dumps install configuration to disk
+	 *
+	 * @return null
+	 */
+	public function save_config()
+	{
+		// Create array to save
+		$save_array = array(
+			'installer_config'	=> $this->installer_config,
+			'progress_data'		=> $this->progress_data,
+		);
+
+		// Create file content
+		$file_content = '<?php // ';
+		$file_content .= serialize($save_array);
+		$file_content .= "\n";
+
+		// Dump file_content to disk
+		$fp = fopen($this->install_config_file, 'w');
+		fwrite($fp, $file_content);
+		fclose($fp);
+	}
+
+	/**
+	 * Filling up system_data array
+	 *
+	 * @return null
+	 */
+	protected function setup_system_data()
+	{
+		// Query maximum runtime from php.ini
+		$execution_time = $this->php_ini->get_int('max_execution_time');
+		$execution_time = min(15, $execution_time / 2);
+		$this->system_data['max_execution_time'] = $execution_time;
+
+		// Set start time
+		$this->system_data['start_time'] = time();
+
+		// Get memory limit
+		$this->system_data['memory_limit'] = $this->php_ini->get_bytes('memory_limit');
+	}
+}