7 files changed, 797 insertions, 0 deletions
diff --git a/phpBB/phpbb/di/container_builder.php b/phpBB/phpbb/di/container_builder.php
new file mode 100644
index 0000000000..638c13e86d
--- /dev/null
+++ b/phpBB/phpbb/di/container_builder.php
@@ -0,0 +1,405 @@
+<?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\di;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
+use Symfony\Component\HttpKernel\DependencyInjection\RegisterListenersPass;
+
+class container_builder
+{
+	/** @var string phpBB Root Path */
+	protected $phpbb_root_path;
+
+	/** @var string php file extension  */
+	protected $php_ext;
+
+	/**
+	* The container under construction
+	*
+	* @var ContainerBuilder
+	*/
+	protected $container;
+
+	/**
+	* @var \phpbb\db\driver\driver_interface
+	*/
+	protected $dbal_connection = null;
+
+	/**
+	* @var array the installed extensions
+	*/
+	protected $installed_exts = null;
+
+	/**
+	* Indicates whether the php config file should be injected into the container (default to true).
+	*
+	* @var bool
+	*/
+	protected $inject_config = true;
+
+	/**
+	* Indicates whether extensions should be used (default to true).
+	*
+	* @var bool
+	*/
+	protected $use_extensions = true;
+
+	/**
+	* Defines a custom path to find the configuration of the container (default to $this->phpbb_root_path . 'config')
+	*
+	* @var string
+	*/
+	protected $config_path = null;
+
+	/**
+	* Indicates whether the phpBB compile pass should be used (default to true).
+	*
+	* @var bool
+	*/
+	protected $use_custom_pass = true;
+
+	/**
+	* Indicates whether the kernel compile pass should be used (default to true).
+	*
+	* @var bool
+	*/
+	protected $use_kernel_pass = true;
+
+	/**
+	* Indicates whether the container should be dumped to the filesystem (default to true).
+	*
+	* If DEBUG_CONTAINER is set this option is ignored and a new container is build.
+	*
+	* @var bool
+	*/
+	protected $dump_container = true;
+
+	/**
+	* Indicates if the container should be compiled automatically (default to true).
+	*
+	* @var bool
+	*/
+	protected $compile_container = true;
+
+	/**
+	* Custom parameters to inject into the container.
+	*
+	* Default to true:
+	* 	array(
+	* 		'core.root_path', $this->phpbb_root_path,
+	* 		'core.php_ext', $this->php_ext,
+	* );
+	*
+	* @var array
+	*/
+	protected $custom_parameters = null;
+
+	/**
+	* @var \phpbb\config_php_file
+	*/
+	protected $config_php_file;
+
+	/**
+	* Constructor
+	*
+	* @param \phpbb\config_php_file $config_php_file
+	* @param string $phpbb_root_path Path to the phpbb includes directory.
+	* @param string $php_ext php file extension
+	*/
+	function __construct(\phpbb\config_php_file $config_php_file, $phpbb_root_path, $php_ext)
+	{
+		$this->config_php_file = $config_php_file;
+		$this->phpbb_root_path = $phpbb_root_path;
+		$this->php_ext = $php_ext;
+	}
+
+	/**
+	* Build and return a new Container respecting the current configuration
+	*
+	* @return \phpbb_cache_container|ContainerBuilder
+	*/
+	public function get_container()
+	{
+		$container_filename = $this->get_container_filename();
+		if (!defined('DEBUG_CONTAINER') && $this->dump_container && file_exists($container_filename))
+		{
+			require($container_filename);
+			$this->container = new \phpbb_cache_container();
+		}
+		else
+		{
+			if ($this->config_path === null)
+			{
+				$this->config_path = $this->phpbb_root_path . 'config';
+			}
+			$container_extensions = array(new \phpbb\di\extension\core($this->config_path));
+
+			if ($this->use_extensions)
+			{
+				$installed_exts = $this->get_installed_extensions();
+				$container_extensions[] = new \phpbb\di\extension\ext($installed_exts);
+			}
+
+			if ($this->inject_config)
+			{
+				$container_extensions[] = new \phpbb\di\extension\config($this->config_php_file);
+			}
+
+			$this->container = $this->create_container($container_extensions);
+
+			if ($this->use_custom_pass)
+			{
+				// Symfony Kernel Listeners
+				$this->container->addCompilerPass(new \phpbb\di\pass\collection_pass());
+				$this->container->addCompilerPass(new RegisterListenersPass('dispatcher', 'event.listener_listener', 'event.listener'));
+
+				if ($this->use_kernel_pass)
+				{
+					$this->container->addCompilerPass(new RegisterListenersPass('dispatcher'));
+				}
+			}
+
+			$this->inject_custom_parameters();
+
+			if ($this->compile_container)
+			{
+				$this->container->compile();
+			}
+
+			if ($this->dump_container && !defined('DEBUG_CONTAINER'))
+			{
+				$this->dump_container($container_filename);
+			}
+		}
+
+		$this->container->set('config.php', $this->config_php_file);
+
+		if ($this->compile_container)
+		{
+			$this->inject_dbal();
+		}
+
+		return $this->container;
+	}
+
+	/**
+	* Set if the extensions should be used.
+	*
+	* @param bool $use_extensions
+	*/
+	public function set_use_extensions($use_extensions)
+	{
+		$this->use_extensions = $use_extensions;
+	}
+
+	/**
+	* Set if the phpBB compile pass have to be used.
+	*
+	* @param bool $use_custom_pass
+	*/
+	public function set_use_custom_pass($use_custom_pass)
+	{
+		$this->use_custom_pass = $use_custom_pass;
+	}
+
+	/**
+	* Set if the kernel compile pass have to be used.
+	*
+	* @param bool $use_kernel_pass
+	*/
+	public function set_use_kernel_pass($use_kernel_pass)
+	{
+		$this->use_kernel_pass = $use_kernel_pass;
+	}
+
+	/**
+	* Set if the php config file should be injecting into the container.
+	*
+	* @param bool $inject_config
+	*/
+	public function set_inject_config($inject_config)
+	{
+		$this->inject_config = $inject_config;
+	}
+
+	/**
+	* Set if a dump container should be used.
+	*
+	* If DEBUG_CONTAINER is set this option is ignored and a new container is build.
+	*
+	* @var bool $dump_container
+	*/
+	public function set_dump_container($dump_container)
+	{
+		$this->dump_container = $dump_container;
+	}
+
+	/**
+	* Set if the container should be compiled automatically (default to true).
+	*
+	* @var bool $dump_container
+	*/
+	public function set_compile_container($compile_container)
+	{
+		$this->compile_container = $compile_container;
+	}
+
+	/**
+	* Set a custom path to find the configuration of the container
+	*
+	* @param string $config_path
+	*/
+	public function set_config_path($config_path)
+	{
+		$this->config_path = $config_path;
+	}
+
+	/**
+	* Set custom parameters to inject into the container.
+	*
+	* @param array $custom_parameters
+	*/
+	public function set_custom_parameters($custom_parameters)
+	{
+		$this->custom_parameters = $custom_parameters;
+	}
+
+	/**
+	* Dump the container to the disk.
+	*
+	* @param string $container_filename The name of the file.
+	*/
+	protected function dump_container($container_filename)
+	{
+		$dumper = new PhpDumper($this->container);
+		$cached_container_dump = $dumper->dump(array(
+			'class'         => 'phpbb_cache_container',
+			'base_class'    => 'Symfony\\Component\\DependencyInjection\\ContainerBuilder',
+		));
+
+		file_put_contents($container_filename, $cached_container_dump);
+	}
+
+	/**
+	* Inject the connection into the container if one was opened.
+	*/
+	protected function inject_dbal()
+	{
+		if ($this->dbal_connection !== null)
+		{
+			$this->container->get('dbal.conn')->set_driver($this->dbal_connection);
+		}
+	}
+
+	/**
+	* Get DB connection.
+	*
+	* @return \phpbb\db\driver\driver_interface
+	*/
+	protected function get_dbal_connection()
+	{
+		if ($this->dbal_connection === null)
+		{
+			$dbal_driver_class = $this->config_php_file->convert_30_dbms_to_31($this->config_php_file->get('dbms'));
+			$this->dbal_connection = new $dbal_driver_class();
+			$this->dbal_connection->sql_connect(
+				$this->config_php_file->get('dbhost'),
+				$this->config_php_file->get('dbuser'),
+				$this->config_php_file->get('dbpasswd'),
+				$this->config_php_file->get('dbname'),
+				$this->config_php_file->get('dbport'),
+				defined('PHPBB_DB_NEW_LINK') && PHPBB_DB_NEW_LINK
+			);
+		}
+
+		return $this->dbal_connection;
+	}
+
+	/**
+	* Get enabled extensions.
+	*
+	* @return array enabled extensions
+	*/
+	protected function get_installed_extensions()
+	{
+		$db = $this->get_dbal_connection();
+		$extension_table = $this->config_php_file->get('table_prefix') . 'ext';
+
+		$sql = 'SELECT *
+			FROM ' . $extension_table . '
+			WHERE ext_active = 1';
+
+		$result = $db->sql_query($sql);
+		$rows = $db->sql_fetchrowset($result);
+		$db->sql_freeresult($result);
+
+		$exts = array();
+		foreach ($rows as $row)
+		{
+			$exts[$row['ext_name']] = $this->phpbb_root_path . 'ext/' . $row['ext_name'] . '/';
+		}
+
+		return $exts;
+	}
+
+	/**
+	* Create the ContainerBuilder object
+	*
+	* @param array $extensions Array of Container extension objects
+	* @return ContainerBuilder object
+	*/
+	protected function create_container(array $extensions)
+	{
+		$container = new ContainerBuilder();
+
+		foreach ($extensions as $extension)
+		{
+			$container->registerExtension($extension);
+			$container->loadFromExtension($extension->getAlias());
+		}
+
+		return $container;
+	}
+
+	/**
+	* Inject the customs parameters into the container
+	*/
+	protected function inject_custom_parameters()
+	{
+		if ($this->custom_parameters === null)
+		{
+			$this->custom_parameters = array(
+				'core.root_path' => $this->phpbb_root_path,
+				'core.php_ext' => $this->php_ext,
+			);
+		}
+
+		foreach ($this->custom_parameters as $key => $value)
+		{
+			$this->container->setParameter($key, $value);
+		}
+	}
+
+	/**
+	* Get the filename under which the dumped container will be stored.
+	*
+	* @return string Path for dumped container
+	*/
+	protected function get_container_filename()
+	{
+		$filename = str_replace(array('/', '.'), array('slash', 'dot'), $this->phpbb_root_path);
+		return $this->phpbb_root_path . 'cache/container_' . $filename . '.' . $this->php_ext;
+	}
+}
diff --git a/phpBB/phpbb/di/extension/config.php b/phpBB/phpbb/di/extension/config.php
new file mode 100644
index 0000000000..7984a783df
--- /dev/null
+++ b/phpBB/phpbb/di/extension/config.php
@@ -0,0 +1,89 @@
+<?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\di\extension;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+
+/**
+* Container config extension
+*/
+class config extends Extension
+{
+	/** @var array */
+	protected $config_php;
+
+	public function __construct(\phpbb\config_php_file $config_php)
+	{
+		$this->config_php = $config_php;
+	}
+
+	/**
+	* Loads a specific configuration.
+	*
+	* @param array            $config    An array of configuration values
+	* @param ContainerBuilder $container A ContainerBuilder instance
+	*
+	* @throws \InvalidArgumentException When provided tag is not defined in this extension
+	*/
+	public function load(array $config, ContainerBuilder $container)
+	{
+		$parameters = array(
+			'core.adm_relative_path'	=> $this->config_php->get('phpbb_adm_relative_path') ? $this->config_php->get('phpbb_adm_relative_path') : 'adm/',
+			'core.table_prefix'			=> $this->config_php->get('table_prefix'),
+			'cache.driver.class'		=> $this->convert_30_acm_type($this->config_php->get('acm_type')),
+			'dbal.driver.class'			=> $this->config_php->convert_30_dbms_to_31($this->config_php->get('dbms')),
+			'dbal.dbhost'				=> $this->config_php->get('dbhost'),
+			'dbal.dbuser'				=> $this->config_php->get('dbuser'),
+			'dbal.dbpasswd'				=> $this->config_php->get('dbpasswd'),
+			'dbal.dbname'				=> $this->config_php->get('dbname'),
+			'dbal.dbport'				=> $this->config_php->get('dbport'),
+			'dbal.new_link'				=> defined('PHPBB_DB_NEW_LINK') && PHPBB_DB_NEW_LINK,
+		);
+		$parameter_bag = $container->getParameterBag();
+
+		foreach ($parameters as $parameter => $value)
+		{
+			$container->setParameter($parameter, $parameter_bag->escapeValue($value));
+		}
+	}
+
+	/**
+	* Returns the recommended alias to use in XML.
+	*
+	* This alias is also the mandatory prefix to use when using YAML.
+	*
+	* @return string The alias
+	*/
+	public function getAlias()
+	{
+		return 'config';
+	}
+
+	/**
+	* Convert 3.0 ACM type to 3.1 cache driver class name
+	*
+	* @param string $acm_type ACM type
+	* @return string cache driver class
+	*/
+	protected function convert_30_acm_type($acm_type)
+	{
+		if (preg_match('#^[a-z]+$#', $acm_type))
+		{
+			return 'phpbb\\cache\\driver\\' . $acm_type;
+		}
+
+		return $acm_type;
+	}
+}
diff --git a/phpBB/phpbb/di/extension/core.php b/phpBB/phpbb/di/extension/core.php
new file mode 100644
index 0000000000..ca4fa5c082
--- /dev/null
+++ b/phpBB/phpbb/di/extension/core.php
@@ -0,0 +1,67 @@
+<?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\di\extension;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+use Symfony\Component\Config\FileLocator;
+
+/**
+* Container core extension
+*/
+class core extends Extension
+{
+	/**
+	* Config path
+	* @var string
+	*/
+	protected $config_path;
+
+	/**
+	* Constructor
+	*
+	* @param string $config_path Config path
+	*/
+	public function __construct($config_path)
+	{
+		$this->config_path = $config_path;
+	}
+
+	/**
+	* Loads a specific configuration.
+	*
+	* @param array            $config    An array of configuration values
+	* @param ContainerBuilder $container A ContainerBuilder instance
+	*
+	* @throws \InvalidArgumentException When provided tag is not defined in this extension
+	*/
+	public function load(array $config, ContainerBuilder $container)
+	{
+		$loader = new YamlFileLoader($container, new FileLocator(phpbb_realpath($this->config_path)));
+		$loader->load('services.yml');
+	}
+
+	/**
+	* Returns the recommended alias to use in XML.
+	*
+	* This alias is also the mandatory prefix to use when using YAML.
+	*
+	* @return string The alias
+	*/
+	public function getAlias()
+	{
+		return 'core';
+	}
+}
diff --git a/phpBB/phpbb/di/extension/ext.php b/phpBB/phpbb/di/extension/ext.php
new file mode 100644
index 0000000000..718c992d2e
--- /dev/null
+++ b/phpBB/phpbb/di/extension/ext.php
@@ -0,0 +1,67 @@
+<?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\di\extension;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+use Symfony\Component\Config\FileLocator;
+
+/**
+* Container ext extension
+*/
+class ext extends Extension
+{
+	protected $paths = array();
+
+	public function __construct($enabled_extensions)
+	{
+		foreach ($enabled_extensions as $ext => $path)
+		{
+			$this->paths[] = $path;
+		}
+	}
+
+	/**
+	* Loads a specific configuration.
+	*
+	* @param array            $config    An array of configuration values
+	* @param ContainerBuilder $container A ContainerBuilder instance
+	*
+	* @throws \InvalidArgumentException When provided tag is not defined in this extension
+	*/
+	public function load(array $config, ContainerBuilder $container)
+	{
+		foreach ($this->paths as $path)
+		{
+			if (file_exists($path . '/config/services.yml'))
+			{
+				$loader = new YamlFileLoader($container, new FileLocator(phpbb_realpath($path . '/config')));
+				$loader->load('services.yml');
+			}
+		}
+	}
+
+	/**
+	* Returns the recommended alias to use in XML.
+	*
+	* This alias is also the mandatory prefix to use when using YAML.
+	*
+	* @return string The alias
+	*/
+	public function getAlias()
+	{
+		return 'ext';
+	}
+}
diff --git a/phpBB/phpbb/di/pass/collection_pass.php b/phpBB/phpbb/di/pass/collection_pass.php
new file mode 100644
index 0000000000..a5c054674e
--- /dev/null
+++ b/phpBB/phpbb/di/pass/collection_pass.php
@@ -0,0 +1,44 @@
+<?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\di\pass;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+
+/**
+* Appends an add method call to the definition of each collection service for
+* the services tagged with the appropriate name defined in the collection's
+* service_collection tag.
+*/
+class collection_pass implements CompilerPassInterface
+{
+	/**
+	* Modify the container before it is passed to the rest of the code
+	*
+	* @param ContainerBuilder $container ContainerBuilder object
+	* @return null
+	*/
+	public function process(ContainerBuilder $container)
+	{
+		foreach ($container->findTaggedServiceIds('service_collection') as $id => $data)
+		{
+			$definition = $container->getDefinition($id);
+
+			foreach ($container->findTaggedServiceIds($data[0]['tag']) as $service_id => $service_data)
+			{
+				$definition->addMethodCall('add', array($service_id));
+			}
+		}
+	}
+}
diff --git a/phpBB/phpbb/di/service_collection.php b/phpBB/phpbb/di/service_collection.php
new file mode 100644
index 0000000000..82ca9bf679
--- /dev/null
+++ b/phpBB/phpbb/di/service_collection.php
@@ -0,0 +1,79 @@
+<?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\di;
+
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+* Collection of services to be configured at container compile time.
+*/
+class service_collection extends \ArrayObject
+{
+	/**
+	* @var \Symfony\Component\DependencyInjection\ContainerInterface
+	*/
+	protected $container;
+
+	/**
+	* Constructor
+	*
+	* @param ContainerInterface $container Container object
+	*/
+	public function __construct(ContainerInterface $container)
+	{
+		$this->container = $container;
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function getIterator()
+	{
+		return new service_collection_iterator($this);
+	}
+
+	// Because of a PHP issue we have to redefine offsetExists
+	// (even with a call to the parent):
+	// 		https://bugs.php.net/bug.php?id=66834
+	// 		https://bugs.php.net/bug.php?id=67067
+	// But it triggers a sniffer issue that we have to skip
+	// @codingStandardsIgnoreStart
+	/**
+	* {@inheritdoc}
+	*/
+	public function offsetExists($index)
+	{
+		return parent::offsetExists($index);
+	}
+	// @codingStandardsIgnoreEnd
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function offsetGet($index)
+	{
+		return $this->container->get($index);
+	}
+
+	/**
+	* Add a service to the collection
+	*
+	* @param string $name The service name
+	* @return null
+	*/
+	public function add($name)
+	{
+		$this->offsetSet($name, null);
+	}
+}
diff --git a/phpBB/phpbb/di/service_collection_iterator.php b/phpBB/phpbb/di/service_collection_iterator.php
new file mode 100644
index 0000000000..0d031ab52d
--- /dev/null
+++ b/phpBB/phpbb/di/service_collection_iterator.php
@@ -0,0 +1,46 @@
+<?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\di;
+
+/**
+* Iterator which loads the services when they are requested
+*/
+class service_collection_iterator extends \ArrayIterator
+{
+	/**
+	* @var \phpbb\di\service_collection
+	*/
+	protected $collection;
+
+	/**
+	* Construct an ArrayIterator for service_collection
+	*
+	* @param \phpbb\di\service_collection $collection The collection to iterate over
+	* @param int $flags Flags to control the behaviour of the ArrayObject object.
+	* @see ArrayObject::setFlags()
+	*/
+	public function __construct(service_collection $collection, $flags = 0)
+	{
+		parent::__construct($collection, $flags);
+		$this->collection = $collection;
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function current()
+	{
+		return $this->collection->offsetGet($this->key());
+	}
+}