[ticket/12775] Add a conter_factory class and remove functions_container

PHPBB3-12775

phpBB/common.php

@@ -21,11 +21,11 @@ if (!defined('IN_PHPBB'))
 }
 
 require($phpbb_root_path . 'includes/startup.' . $phpEx);
+require($phpbb_root_path . 'phpbb/di/container_factory.' . $phpEx);
 
-if (file_exists($phpbb_root_path . 'config.' . $phpEx))
+$factory = new \phpbb\di\container_factory($phpbb_root_path, $phpEx);
-{
+$config_file_data = $factory->load_config_file();
-	require($phpbb_root_path . 'config.' . $phpEx);
+extract($config_file_data);
-}
 
 if (!defined('PHPBB_INSTALLED'))
 {
@@ -80,7 +80,6 @@ require($phpbb_root_path . 'phpbb/class_loader.' . $phpEx);
 
 require($phpbb_root_path . 'includes/functions.' . $phpEx);
 require($phpbb_root_path . 'includes/functions_content.' . $phpEx);
-require($phpbb_root_path . 'includes/functions_container.' . $phpEx);
 include($phpbb_root_path . 'includes/functions_compatibility.' . $phpEx);
 
 require($phpbb_root_path . 'includes/constants.' . $phpEx);
@@ -98,7 +97,8 @@ $phpbb_class_loader_ext->register();
 phpbb_load_extensions_autoloaders($phpbb_root_path);
 
 // Set up container
-$phpbb_container = phpbb_create_default_container($phpbb_root_path, $phpEx);
+$phpbb_container = $factory->get_container();
+
 
 $phpbb_class_loader->set_cache($phpbb_container->get('cache.driver'));
 $phpbb_class_loader_ext->set_cache($phpbb_container->get('cache.driver'));

phpBB/phpbb/di/container_factory.php

@@ -0,0 +1,361 @@
+<?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\ContainerInterface;
+use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
+
+class container_factory
+{
+	/** @var string phpBB Root Path */
+	protected $phpbb_root_path;
+
+	/** @var string php file extension  */
+	protected $php_ext;
+
+	/**
+	* The container under construction
+	*
+	* @var ContainerInterface
+	*/
+	protected $container = null;
+
+	/**
+	* @var \phpbb\db\driver\driver_interface
+	*/
+	protected $dbal_connection = null;
+
+	/**
+	* @var array the installed extensions
+	*/
+	protected $installed_exts = null;
+
+	/**
+	* Indicates if the php config file has been loaded.
+	*
+	* @var bool
+	*/
+	protected $config_loaded = false;
+
+	/**
+	* The content of the php config file
+	*
+	* @var array
+	*/
+	protected $config_data = array();
+
+	/**
+	* Indicates if the php config file should be injecting into the container (default to true).
+	*
+	* @var bool
+	*/
+	protected $inject_config = true;
+
+	/**
+	* Indicates if the extensions should be used (default to true).
+	*
+	* @var bool
+	*/
+	protected $use_extensions = true;
+
+	/**
+	* Defines a custom path to find the configuration of the container.
+	*
+	* @var string
+	*/
+	protected $config_path = null;
+
+	/**
+	* Indicates if the phpBB compile pass have to be used (default to true).
+	*
+	* @var bool
+	*/
+	protected $use_custom_pass = true;
+
+	/**
+	* Indicates if a dump container should be used (default to true).
+	*
+	* If DEBUG_CONTAINER is set this option is ignored and a new container is build.
+	*
+	* @var bool
+	*/
+	protected $dump_container = true;
+
+	/**
+	* Constructor
+	*
+	* @param string $phpbb_root_path Path to the phpbb includes directory.
+	* @param string $php_ext php file extension
+	*/
+	function __construct($phpbb_root_path, $php_ext)
+	{
+		$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)
+			{
+				$config_path = $this->phpbb_root_path . 'config';
+			}
+			$container_extensions = array(new \phpbb\di\extension\core($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)
+			{
+				$this->load_config_file();
+				$container_extensions[] = new \phpbb\di\extension\config($this->config_data);
+			}
+
+			$this->container = $this->create_container($container_extensions);
+
+			if ($this->use_custom_pass)
+			{
+				$this->container->addCompilerPass(new \phpbb\di\pass\collection_pass());
+				$this->container->addCompilerPass(new \phpbb\di\pass\kernel_pass());
+			}
+
+			$this->container->setParameter('core.root_path', $this->phpbb_root_path);
+			$this->container->setParameter('core.php_ext', $this->php_ext);
+
+			$this->container->compile();
+
+			if ($this->dump_container && defined('DEBUG'))
+			{
+				$this->dump_container($container_filename);
+			}
+		}
+
+		// Impossible because we have a compiled (and so frozen) container
+		/*if ($this->inject_config)
+		{
+			$this->inject_config();
+		}*/
+
+		// Frozen container, we can't modify either the services or the parameters
+		//$this->inject_dbal();
+
+		return $this->container;
+	}
+
+	/**
+	* Load the config file, store the information and return them
+	*
+	* @return bool|array Return the content of the config file or false if the file does not exists.
+	*/
+	public function load_config_file()
+	{
+		if (!$this->config_loaded)
+		{
+			if (file_exists($this->phpbb_root_path . 'config.' . $this->php_ext))
+			{
+				$x7eeee37ce4d5f1ce4d968ed8fdd9bcbb = null;
+				$x7eeee37ce4d5f1ce4d968ed8fdd9bcbb = get_defined_vars();
+
+				require($this->phpbb_root_path . 'config.' . $this->php_ext);
+				$this->config_data = array_diff_key(get_defined_vars(), $x7eeee37ce4d5f1ce4d968ed8fdd9bcbb);
+
+				$this->config_loaded = true;
+			}
+			else
+			{
+				return false;
+			}
+		}
+
+		return $this->config_data;
+	}
+
+	/**
+	* 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_customPass($use_custom_pass)
+	{
+		$this->use_custom_pass = $use_custom_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 setDumpContainer($dump_container)
+	{
+		$this->dump_container = $dump_container;
+	}
+
+	/**
+	* Set a custom path to find the configuration of the container
+	*
+	* @param string $config_path
+	*/
+	public function setConfigPath($config_path)
+	{
+		$this->config_path = $config_path;
+	}
+
+	/**
+	* Dump the container to the disk.
+	*
+	* @param string $container_filename The name of the file.
+	*/
+	protected function dump_container($container_filename)
+	{
+		// Lastly, we create our cached container class
+		$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->set('dbal.conn', $this->dbal_connection);
+		}
+	}
+
+	/**
+	* Get DB connection.
+	*
+	* @return \phpbb\db\driver\driver_interface
+	*/
+	protected function get_dbal_connection()
+	{
+		if ($this->dbal_connection === null)
+		{
+			$this->load_config_file();
+			$dbal_driver_class = phpbb_convert_30_dbms_to_31($this->config_data['dbms']);
+			$this->dbal_connection = new $dbal_driver_class();
+			$this->dbal_connection->sql_connect(
+				$this->config_data['dbhost'],
+				$this->config_data['dbuser'],
+				$this->config_data['dbpasswd'],
+				$this->config_data['dbname'],
+				$this->config_data['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_data['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;
+	}
+
+	/**
+	* 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;
+	}
+}

phpBB/phpbb/di/extension/config.php

@@ -21,9 +21,12 @@ use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 */
 class config extends Extension
 {
-	public function __construct($config_file)
+	/** @var array */
+	protected $config_file_data;
+
+	public function __construct($config_file_data)
 	{
-		$this->config_file = $config_file;
+		$this->config_file_data = $config_file_data;
 	}
 
 	/**
@@ -36,7 +39,7 @@ class config extends Extension
 	*/
 	public function load(array $config, ContainerBuilder $container)
 	{
-		require($this->config_file);
+		extract($this->config_file_data);
 
 		$container->setParameter('core.adm_relative_path', (isset($phpbb_adm_relative_path) ? $phpbb_adm_relative_path : 'adm/'));
 		$container->setParameter('core.table_prefix', $table_prefix);