1 files changed, 585 insertions, 0 deletions
diff --git a/phpBB/includes/extension/manager.php b/phpBB/includes/extension/manager.php
new file mode 100644
index 0000000000..653117adfa
--- /dev/null
+++ b/phpBB/includes/extension/manager.php
@@ -0,0 +1,585 @@
+<?php
+/**
+*
+* @package extension
+* @copyright (c) 2011 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+* The extension manager provides means to activate/deactivate extensions.
+*
+* @package extension
+*/
+class phpbb_extension_manager
+{
+	/** @var ContainerInterface */
+	protected $container;
+
+	protected $db;
+	protected $config;
+	protected $migrator;
+	protected $cache;
+	protected $php_ext;
+	protected $extensions;
+	protected $extension_table;
+	protected $phpbb_root_path;
+	protected $cache_name;
+
+	/**
+	* Creates a manager and loads information from database
+	*
+	* @param ContainerInterface $container A container
+	* @param phpbb_db_driver $db A database connection
+	* @param phpbb_config $config phpbb_config
+	* @param phpbb_db_migrator $migrator
+	* @param phpbb_filesystem $filesystem
+	* @param string $extension_table The name of the table holding extensions
+	* @param string $phpbb_root_path Path to the phpbb includes directory.
+	* @param string $php_ext php file extension
+	* @param phpbb_cache_driver_interface $cache A cache instance or null
+	* @param string $cache_name The name of the cache variable, defaults to _ext
+	*/
+	public function __construct(ContainerInterface $container, phpbb_db_driver $db, phpbb_config $config, phpbb_db_migrator $migrator, phpbb_filesystem $filesystem, $extension_table, $phpbb_root_path, $php_ext = 'php', phpbb_cache_driver_interface $cache = null, $cache_name = '_ext')
+	{
+		$this->container = $container;
+		$this->phpbb_root_path = $phpbb_root_path;
+		$this->db = $db;
+		$this->config = $config;
+		$this->migrator = $migrator;
+		$this->cache = $cache;
+		$this->filesystem = $filesystem;
+		$this->php_ext = $php_ext;
+		$this->extension_table = $extension_table;
+		$this->cache_name = $cache_name;
+
+		$this->extensions = ($this->cache) ? $this->cache->get($this->cache_name) : false;
+
+		if ($this->extensions === false)
+		{
+			$this->load_extensions();
+		}
+	}
+
+	/**
+	* Loads all extension information from the database
+	*
+	* @return null
+	*/
+	public function load_extensions()
+	{
+		$this->extensions = array();
+
+		// Do not try to load any extensions when installing or updating
+		// Note: database updater invokes this code, and in 3.0
+		// there is no extension table therefore the rest of this function
+		// fails
+		if (defined('IN_INSTALL'))
+		{
+			return;
+		}
+
+		$sql = 'SELECT *
+			FROM ' . $this->extension_table;
+
+		$result = $this->db->sql_query($sql);
+		$extensions = $this->db->sql_fetchrowset($result);
+		$this->db->sql_freeresult($result);
+
+		foreach ($extensions as $extension)
+		{
+			$extension['ext_path'] = $this->get_extension_path($extension['ext_name']);
+			$this->extensions[$extension['ext_name']] = $extension;
+		}
+
+		ksort($this->extensions);
+
+		if ($this->cache)
+		{
+			$this->cache->put($this->cache_name, $this->extensions);
+		}
+	}
+
+	/**
+	* Generates the path to an extension
+	*
+	* @param string $name The name of the extension
+	* @param bool $phpbb_relative Whether the path should be relative to phpbb root
+	* @return string Path to an extension
+	*/
+	public function get_extension_path($name, $phpbb_relative = false)
+	{
+		$name = str_replace('.', '', $name);
+
+		return (($phpbb_relative) ? $this->phpbb_root_path : '') . 'ext/' . $name . '/';
+	}
+
+	/**
+	* Instantiates the extension meta class for the extension with the given name
+	*
+	* @param string $name The extension name
+	* @return phpbb_extension_interface Instance of the extension meta class or
+	*                     phpbb_extension_base if the class does not exist
+	*/
+	public function get_extension($name)
+	{
+		$extension_class_name = 'phpbb_ext_' . str_replace('/', '_', $name) . '_ext';
+
+		if (class_exists($extension_class_name))
+		{
+			return new $extension_class_name($this->container);
+		}
+		else
+		{
+			return new phpbb_extension_base($this->container);
+		}
+	}
+
+	/**
+	* Instantiates the metadata manager for the extension with the given name
+	*
+	* @param string $name The extension name
+	* @param string $template The template manager
+	* @return phpbb_extension_metadata_manager Instance of the metadata manager
+	*/
+	public function create_extension_metadata_manager($name, phpbb_template $template)
+	{
+		return new phpbb_extension_metadata_manager($name, $this->config, $this, $template, $this->phpbb_root_path);
+	}
+
+	/**
+	* Runs a step of the extension enabling process.
+	*
+	* Allows the exentension to enable in a long running script that works
+	* in multiple steps across requests. State is kept for the extension
+	* in the extensions table.
+	*
+	* @param	string	$name	The extension's name
+	* @return	bool			False if enabling is finished, true otherwise
+	*/
+	public function enable_step($name)
+	{
+		// ignore extensions that are already enabled
+		if (isset($this->extensions[$name]) && $this->extensions[$name]['ext_active'])
+		{
+			return false;
+		}
+
+		$old_state = (isset($this->extensions[$name]['ext_state'])) ? unserialize($this->extensions[$name]['ext_state']) : false;
+
+		// Returns false if not completed
+		if (!$this->handle_migrations($name, 'enable'))
+		{
+			return true;
+		}
+
+		$extension = $this->get_extension($name);
+		$state = $extension->enable_step($old_state);
+
+		$active = ($state === false);
+
+		$extension_data = array(
+			'ext_name'		=> $name,
+			'ext_active'	=> $active,
+			'ext_state'		=> serialize($state),
+		);
+
+		$this->extensions[$name] = $extension_data;
+		$this->extensions[$name]['ext_path'] = $this->get_extension_path($extension_data['ext_name']);
+		ksort($this->extensions);
+
+		$sql = 'UPDATE ' . $this->extension_table . '
+			SET ' . $this->db->sql_build_array('UPDATE', $extension_data) . "
+			WHERE ext_name = '" . $this->db->sql_escape($name) . "'";
+		$this->db->sql_query($sql);
+
+		if (!$this->db->sql_affectedrows())
+		{
+			$sql = 'INSERT INTO ' . $this->extension_table . '
+				' . $this->db->sql_build_array('INSERT', $extension_data);
+			$this->db->sql_query($sql);
+		}
+
+		if ($this->cache)
+		{
+			$this->cache->purge();
+		}
+
+		return !$active;
+	}
+
+	/**
+	* Enables an extension
+	*
+	* This method completely enables an extension. But it could be long running
+	* so never call this in a script that has a max_execution time.
+	*
+	* @param string $name The extension's name
+	* @return null
+	*/
+	public function enable($name)
+	{
+		while ($this->enable_step($name));
+	}
+
+	/**
+	* Disables an extension
+	*
+	* Calls the disable method on the extension's meta class to allow it to
+	* process the event.
+	*
+	* @param string $name The extension's name
+	* @return bool False if disabling is finished, true otherwise
+	*/
+	public function disable_step($name)
+	{
+		// ignore extensions that are already disabled
+		if (!isset($this->extensions[$name]) || !$this->extensions[$name]['ext_active'])
+		{
+			return false;
+		}
+
+		$old_state = unserialize($this->extensions[$name]['ext_state']);
+
+		$extension = $this->get_extension($name);
+		$state = $extension->disable_step($old_state);
+
+		// continue until the state is false
+		if ($state !== false)
+		{
+			$extension_data = array(
+				'ext_state'		=> serialize($state),
+			);
+			$this->extensions[$name]['ext_state'] = serialize($state);
+
+			$sql = 'UPDATE ' . $this->extension_table . '
+				SET ' . $this->db->sql_build_array('UPDATE', $extension_data) . "
+				WHERE ext_name = '" . $this->db->sql_escape($name) . "'";
+			$this->db->sql_query($sql);
+
+			if ($this->cache)
+			{
+				$this->cache->purge();
+			}
+
+			return true;
+		}
+
+		$extension_data = array(
+			'ext_active'	=> false,
+			'ext_state'		=> serialize(false),
+		);
+		$this->extensions[$name]['ext_active'] = false;
+		$this->extensions[$name]['ext_state'] = serialize(false);
+
+		$sql = 'UPDATE ' . $this->extension_table . '
+			SET ' . $this->db->sql_build_array('UPDATE', $extension_data) . "
+			WHERE ext_name = '" . $this->db->sql_escape($name) . "'";
+		$this->db->sql_query($sql);
+
+		if ($this->cache)
+		{
+			$this->cache->purge();
+		}
+
+		return false;
+	}
+
+	/**
+	* Disables an extension
+	*
+	* Disables an extension completely at once. This process could run for a
+	* while so never call this in a script that has a max_execution time.
+	*
+	* @param string $name The extension's name
+	* @return null
+	*/
+	public function disable($name)
+	{
+		while ($this->disable_step($name));
+	}
+
+	/**
+	* Purge an extension
+	*
+	* Disables the extension first if active, and then calls purge on the
+	* extension's meta class to delete the extension's database content.
+	*
+	* @param string $name The extension's name
+	* @return bool False if purging is finished, true otherwise
+	*/
+	public function purge_step($name)
+	{
+		// ignore extensions that do not exist
+		if (!isset($this->extensions[$name]))
+		{
+			return false;
+		}
+
+		// disable first if necessary
+		if ($this->extensions[$name]['ext_active'])
+		{
+			$this->disable($name);
+		}
+
+		$old_state = unserialize($this->extensions[$name]['ext_state']);
+
+		// Returns false if not completed
+		if (!$this->handle_migrations($name, 'purge'))
+		{
+			return true;
+		}
+
+		$extension = $this->get_extension($name);
+		$state = $extension->purge_step($old_state);
+
+		// continue until the state is false
+		if ($state !== false)
+		{
+			$extension_data = array(
+				'ext_state'		=> serialize($state),
+			);
+			$this->extensions[$name]['ext_state'] = serialize($state);
+
+			$sql = 'UPDATE ' . $this->extension_table . '
+				SET ' . $this->db->sql_build_array('UPDATE', $extension_data) . "
+				WHERE ext_name = '" . $this->db->sql_escape($name) . "'";
+			$this->db->sql_query($sql);
+
+			if ($this->cache)
+			{
+				$this->cache->purge();
+			}
+
+			return true;
+		}
+
+		unset($this->extensions[$name]);
+
+		$sql = 'DELETE FROM ' . $this->extension_table . "
+			WHERE ext_name = '" . $this->db->sql_escape($name) . "'";
+		$this->db->sql_query($sql);
+
+		if ($this->cache)
+		{
+			$this->cache->purge();
+		}
+
+		return false;
+	}
+
+	/**
+	* Purge an extension
+	*
+	* Purges an extension completely at once. This process could run for a while
+	* so never call this in a script that has a max_execution time.
+	*
+	* @param string $name The extension's name
+	* @return null
+	*/
+	public function purge($name)
+	{
+		while ($this->purge_step($name));
+	}
+
+	/**
+	* Retrieves a list of all available extensions on the filesystem
+	*
+	* @return array An array with extension names as keys and paths to the
+	*               extension as values
+	*/
+	public function all_available()
+	{
+		$available = array();
+		if (!is_dir($this->phpbb_root_path . 'ext/'))
+		{
+			return $available;
+		}
+
+		$iterator = new RecursiveIteratorIterator(
+			new RecursiveDirectoryIterator($this->phpbb_root_path . 'ext/', FilesystemIterator::NEW_CURRENT_AND_KEY | FilesystemIterator::FOLLOW_SYMLINKS),
+			RecursiveIteratorIterator::SELF_FIRST);
+		foreach ($iterator as $file_info)
+		{
+			if ($file_info->isFile() && $file_info->getFilename() == 'ext.' . $this->php_ext)
+			{
+				$ext_name = $iterator->getInnerIterator()->getSubPath();
+
+				$ext_name = str_replace(DIRECTORY_SEPARATOR, '/', $ext_name);
+
+				$available[$ext_name] = $this->phpbb_root_path . 'ext/' . $ext_name . '/';
+			}
+		}
+		ksort($available);
+		return $available;
+	}
+
+	/**
+	* Retrieves all configured extensions.
+	*
+	* All enabled and disabled extensions are considered configured. A purged
+	* extension that is no longer in the database is not configured.
+	*
+	* @return array An array with extension names as keys and and the
+	*               database stored extension information as values
+	*/
+	public function all_configured()
+	{
+		$configured = array();
+		foreach ($this->extensions as $name => $data)
+		{
+			$data['ext_path'] = $this->phpbb_root_path . $data['ext_path'];
+			$configured[$name] = $data;
+		}
+		return $configured;
+	}
+
+	/**
+	* Retrieves all enabled extensions.
+	*
+	* @return array An array with extension names as keys and and the
+	*               database stored extension information as values
+	*/
+	public function all_enabled()
+	{
+		$enabled = array();
+		foreach ($this->extensions as $name => $data)
+		{
+			if ($data['ext_active'])
+			{
+				$enabled[$name] = $this->phpbb_root_path . $data['ext_path'];
+			}
+		}
+		return $enabled;
+	}
+
+	/**
+	* Retrieves all disabled extensions.
+	*
+	* @return array An array with extension names as keys and and the
+	*               database stored extension information as values
+	*/
+	public function all_disabled()
+	{
+		$disabled = array();
+		foreach ($this->extensions as $name => $data)
+		{
+			if (!$data['ext_active'])
+			{
+				$disabled[$name] = $this->phpbb_root_path . $data['ext_path'];
+			}
+		}
+		return $disabled;
+	}
+
+	/**
+	* Check to see if a given extension is available on the filesystem
+	*
+	* @param string $name Extension name to check NOTE: Can be user input
+	* @return bool Depending on whether or not the extension is available
+	*/
+	public function available($name)
+	{
+		return file_exists($this->get_extension_path($name, true));
+	}
+
+	/**
+	* Check to see if a given extension is enabled
+	*
+	* @param string $name Extension name to check
+	* @return bool Depending on whether or not the extension is enabled
+	*/
+	public function enabled($name)
+	{
+		return isset($this->extensions[$name]) && $this->extensions[$name]['ext_active'];
+	}
+
+	/**
+	* Instantiates a phpbb_extension_finder.
+	*
+	* @return phpbb_extension_finder An extension finder instance
+	*/
+	public function get_finder()
+	{
+		return new phpbb_extension_finder($this, $this->filesystem, $this->phpbb_root_path, $this->cache, $this->php_ext, $this->cache_name . '_finder');
+	}
+
+	/**
+	* Handle installing/reverting migrations
+	*
+	* @param string $extension_name Name of the extension
+	* @param string $mode enable or purge
+	* @return bool True if completed, False if not completed
+	*/
+	protected function handle_migrations($extension_name, $mode)
+	{
+		$extensions = array(
+			$extension_name => $this->phpbb_root_path . $this->get_extension_path($extension_name),
+		);
+
+		$finder = $this->get_finder();
+		$migrations = array();
+		$file_list = $finder
+			->extension_directory('/migrations')
+			->find_from_paths($extensions);
+
+		if (empty($file_list))
+		{
+			return true;
+		}
+
+		foreach ($file_list as $file)
+		{
+			$migrations[$file['named_path']] = $file['ext_name'];
+		}
+		$migrations = $finder->get_classes_from_files($migrations);
+		$this->migrator->set_migrations($migrations);
+
+		// What is a safe limit of execution time? Half the max execution time should be safe.
+		$safe_time_limit = (ini_get('max_execution_time') / 2);
+		$start_time = time();
+
+		if ($mode == 'enable')
+		{
+			while (!$this->migrator->finished())
+			{
+				$this->migrator->update();
+
+				// Are we approaching the time limit? If so we want to pause the update and continue after refreshing
+				if ((time() - $start_time) >= $safe_time_limit)
+				{
+					return false;
+				}
+			}
+		}
+		else if ($mode == 'purge')
+		{
+			foreach ($migrations as $migration)
+			{
+				while ($this->migrator->migration_state($migration) !== false)
+				{
+					$this->migrator->revert($migration);
+
+					// Are we approaching the time limit? If so we want to pause the update and continue after refreshing
+					if ((time() - $start_time) >= $safe_time_limit)
+					{
+						return false;
+					}
+				}
+			}
+		}
+
+		return true;
+	}
+}