[ticket/13770] Wither interface for container_builder

PHPBB3-13770

phpBB/bin/phpbbcli.php

@@ -43,21 +43,21 @@ require($phpbb_root_path . 'includes/functions.' . $phpEx);
 require($phpbb_root_path . 'includes/functions_admin.' . $phpEx);
 require($phpbb_root_path . 'includes/utf/utf_tools.' . $phpEx);
 
-$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_config_php_file, $phpbb_root_path, $phpEx);
+$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_root_path, $phpEx);
-$phpbb_container_builder->set_dump_container(false);
+$phpbb_container = $phpbb_container_builder->with_config($phpbb_config_php_file);
+
+$phpbb_container_builder->without_cache();
 
 $input = new ArgvInput();
 
 if ($input->hasParameterOption(array('--safe-mode')))
 {
-	$phpbb_container_builder->set_use_extensions(false);
+	$phpbb_container_builder->without_extensions();
-	$phpbb_container_builder->set_dump_container(false);
 }
 else
 {
 	$phpbb_class_loader_ext = new \phpbb\class_loader('\\', "{$phpbb_root_path}ext/", $phpEx);
 	$phpbb_class_loader_ext->register();
-	phpbb_load_extensions_autoloaders($phpbb_root_path);
 }
 
 $phpbb_container = $phpbb_container_builder->get_container();

phpBB/common.php

@@ -96,21 +96,21 @@ set_error_handler(defined('PHPBB_MSG_HANDLER') ? PHPBB_MSG_HANDLER : 'msg_handle
 $phpbb_class_loader_ext = new \phpbb\class_loader('\\', "{$phpbb_root_path}ext/", $phpEx);
 $phpbb_class_loader_ext->register();
 
-phpbb_load_extensions_autoloaders($phpbb_root_path);
+\Symfony\Component\Debug\Debug::enable(E_ALL);
 
 // Set up container
-try
+/*try
-{
+{*/
-	$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_config_php_file, $phpbb_root_path, $phpEx);
+	$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_root_path, $phpEx);
-	$phpbb_container = $phpbb_container_builder->get_container();
+	$phpbb_container = $phpbb_container_builder->with_config($phpbb_config_php_file)->get_container();
-}
+/*}
 catch (InvalidArgumentException $e)
 {
 	trigger_error(
 		'The requested environment ' . PHPBB_ENVIRONMENT . ' is not available.',
 		E_USER_ERROR
 	);
-}
+}*/
 
 $phpbb_class_loader->set_cache($phpbb_container->get('cache.driver'));
 $phpbb_class_loader_ext->set_cache($phpbb_container->get('cache.driver'));

phpBB/download/file.php

@@ -61,11 +61,9 @@ if (isset($_GET['avatar']))
 	$phpbb_class_loader_ext = new \phpbb\class_loader('\\', "{$phpbb_root_path}ext/", $phpEx);
 	$phpbb_class_loader_ext->register();
 
-	phpbb_load_extensions_autoloaders($phpbb_root_path);
-
 	// Set up container
-	$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_config_php_file, $phpbb_root_path, $phpEx);
+	$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_root_path, $phpEx);
-	$phpbb_container = $phpbb_container_builder->get_container();
+	$phpbb_container = $phpbb_container_builder->with_config($phpbb_config_php_file)->get_container();
 
 	$phpbb_class_loader->set_cache($phpbb_container->get('cache.driver'));
 	$phpbb_class_loader_ext->set_cache($phpbb_container->get('cache.driver'));

phpBB/install/database_update.php

@@ -80,11 +80,13 @@ require($phpbb_root_path . 'includes/utf/utf_tools.' . $phpEx);
 set_error_handler(defined('PHPBB_MSG_HANDLER') ? PHPBB_MSG_HANDLER : 'msg_handler');
 
 // Set up container (must be done here because extensions table may not exist)
-$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_config_php_file, $phpbb_root_path, $phpEx);
+$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_root_path, $phpEx);
-$phpbb_container_builder->set_use_extensions(false);
+$phpbb_container = $phpbb_container_builder
-$phpbb_container_builder->set_use_kernel_pass(false);
+	->with_config($phpbb_config_php_file)
-$phpbb_container_builder->set_dump_container(false);
+	->without_extensions()
-$phpbb_container = $phpbb_container_builder->get_container();
+	->without_cache()
+	->get_container()
+;
 
 // set up caching
 /* @var $cache \phpbb\cache\service */

phpBB/install/index.php

@@ -116,18 +116,20 @@ $phpbb_class_loader_ext->register();
 
 // Set up container
 $phpbb_config_php_file = new \phpbb\config_php_file($phpbb_root_path, $phpEx);
-$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_config_php_file, $phpbb_root_path, $phpEx);
+$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_root_path, $phpEx);
-$phpbb_container_builder->set_use_extensions(false);
+$phpbb_container = $phpbb_container_builder
-$phpbb_container_builder->set_dump_container(false);
+	->with_config($phpbb_config_php_file)
-$phpbb_container_builder->set_use_custom_pass(false);
+	->without_extensions()
-$phpbb_container_builder->set_inject_config(false);
+	->without_cache()
-$phpbb_container_builder->set_compile_container(false);
+	->without_compiled_container()
+	->get_container()
+;
 
 $other_config_path = $phpbb_root_path . 'install/update/new/config/';
 $config_path = file_exists($other_config_path . 'services.yml') ? $other_config_path : $phpbb_root_path . 'config/';
-$phpbb_container_builder->set_config_path($config_path);
+$phpbb_container_builder->with_config_path($config_path);
 
-$phpbb_container_builder->set_custom_parameters(array(
+$phpbb_container_builder->with_custom_parameters(array(
 	'core.root_path'			=> $phpbb_root_path,
 	'core.adm_relative_path'	=> $phpbb_adm_relative_path,
 	'core.php_ext'				=> $phpEx,

phpBB/install/install_convert.php

@@ -131,8 +131,8 @@ class install_convert extends module
 		// Enable super globals to prevent issues with the new \phpbb\request\request object
 		$request->enable_super_globals();
 		// Create a normal container now
-		$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_config_php_file, $phpbb_root_path, $phpEx);
+		$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_root_path, $phpEx);
-		$phpbb_container = $phpbb_container_builder->get_container();
+		$phpbb_container = $phpbb_container_builder->with_config($phpbb_config_php_file)->get_container();
 
 		// Create cache
 		/* @var $cache \phpbb\cache\service */

phpBB/install/install_install.php

@@ -110,8 +110,8 @@ class install_install extends module
 				$request->enable_super_globals();
 
 				// Create a normal container now
-				$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_config_php_file, $phpbb_root_path, $phpEx);
+				$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_root_path, $phpEx);
-				$phpbb_container = $phpbb_container_builder->get_container();
+				$phpbb_container = $phpbb_container_builder->with_config($phpbb_config_php_file)->get_container();
 
 				// Sets the global variables
 				/* @var $cache \phpbb\cache\service */

phpBB/install/install_update.php

@@ -76,12 +76,16 @@ class install_update extends module
 		$request->enable_super_globals();
 
 		// Create a normal container now
-		$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_config_php_file, $phpbb_root_path, $phpEx);
+		$phpbb_container_builder = new \phpbb\di\container_builder($phpbb_root_path, $phpEx);
-		$phpbb_container_builder->set_dump_container(false);
+		$phpbb_container = $phpbb_container_builder
-		$phpbb_container_builder->set_use_extensions(false);
+			->with_config($phpbb_config_php_file)
+			->without_cache()
+			->without_extensions()
+		;
+
 		if (file_exists($phpbb_root_path . 'install/update/new/config'))
 		{
-			$phpbb_container_builder->set_config_path($phpbb_root_path . 'install/update/new/config');
+			$phpbb_container_builder->with_config_path($phpbb_root_path . 'install/update/new/config');
 		}
 		$phpbb_container = $phpbb_container_builder->get_container();
 

phpBB/phpbb/di/container_builder.php

@@ -13,6 +13,7 @@
 
 namespace phpbb\di;
 
+use phpbb\filesystem\filesystem;
 use Symfony\Component\Config\ConfigCache;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -24,6 +25,11 @@ use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfiguration
 
 class container_builder
 {
+	/**
+	 * @var string The environment to use.
+	 */
+	protected $environment;
+
 	/**
 	 * @var string phpBB Root Path
 	 */
@@ -41,23 +47,6 @@ class container_builder
 	 */
 	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).
 	 *
@@ -72,20 +61,6 @@ class container_builder
 	 */
 	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).
 	 *
@@ -93,7 +68,7 @@ class container_builder
 	 *
 	 * @var bool
 	 */
-	protected $dump_container = true;
+	protected $use_cache = true;
 
 	/**
 	 * Indicates if the container should be compiled automatically (default to true).
@@ -105,7 +80,7 @@ class container_builder
 	/**
 	 * Custom parameters to inject into the container.
 	 *
-	* Default to true:
+	 * Default to:
 	 * 	array(
 	 * 		'core.root_path', $this->phpbb_root_path,
 	 * 		'core.php_ext', $this->php_ext,
@@ -125,16 +100,19 @@ class container_builder
 	 */
 	protected $cache_dir;
 
+	/**
+	 * @var array
+	 */
+	private $container_extensions;
+
 	/**
 	 * 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)
+	function __construct($phpbb_root_path, $php_ext)
 	{
-		$this->config_php_file = $config_php_file;
 		$this->phpbb_root_path = $phpbb_root_path;
 		$this->php_ext = $php_ext;
 	}
@@ -148,51 +126,36 @@ class container_builder
 	{
 		$container_filename = $this->get_container_filename();
 		$config_cache = new ConfigCache($container_filename, defined('DEBUG'));
-		if ($this->dump_container && $config_cache->isFresh())
+		if ($this->use_cache && $config_cache->isFresh())
 		{
 			require($config_cache->getPath());
 			$this->container = new \phpbb_cache_container();
+
+			return $this->container;
 		}
-		else
+
-		{
+		$this->container_extensions = array(new extension\core($this->get_config_path()));
-			$container_extensions = array(new \phpbb\di\extension\core($this->get_config_path()));
 
 		if ($this->use_extensions)
 		{
-				$installed_exts = $this->get_installed_extensions();
+			$this->load_extensions();
-				foreach ($installed_exts as $ext_name => $path)
-				{
-					$extension_class = '\\' . str_replace('/', '\\', $ext_name) . '\\di\\extension';
-
-					if (!class_exists($extension_class))
-					{
-						$extension_class = '\phpbb\extension\di\extension_base';
 		}
 
-					$container_extensions[] = new $extension_class($ext_name, $path);
+		// Inject the config
-				}
+		$this->container_extensions[] = new extension\config($this->config_php_file);
-			}
 
-			if ($this->inject_config)
+		$this->container = $this->create_container($this->container_extensions);
-			{
-				$container_extensions[] = new \phpbb\di\extension\config($this->config_php_file);
-			}
 
-			$this->container = $this->create_container($container_extensions);
+		// Easy collections through tags
+		$this->container->addCompilerPass(new pass\collection_pass());
 
-			if ($this->use_custom_pass)
+		// Event listeners "phpBB style"
-			{
-				// 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)
+		// Event listeners "Symfony style"
-				{
 		$this->container->addCompilerPass(new RegisterListenersPass('dispatcher'));
-				}
-			}
 
-			$filesystem = new \phpbb\filesystem\filesystem();
+		$filesystem = new filesystem();
 		$loader = new YamlFileLoader($this->container, new FileLocator($filesystem->realpath($this->get_config_path())));
 		$loader->load($this->container->getParameter('core.environment') . '/config.yml');
 
@@ -201,94 +164,153 @@ class container_builder
 		if ($this->compile_container)
 		{
 			$this->container->compile();
-			}
 
-			if ($this->dump_container)
+			if ($this->use_cache)
 			{
 				$this->dump_container($config_cache);
 			}
 		}
 
-		$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.
+	 * Enable the extensions.
 	 *
-	* @param bool $use_extensions
+	 * @param string $environment The environment to use
+	 * @return $this
 	 */
-	public function set_use_extensions($use_extensions)
+	public function with_environment($environment)
 	{
-		$this->use_extensions = $use_extensions;
+		$this->environment = $environment;
+
+		return $this;
 	}
 
 	/**
-	* Set if the phpBB compile pass have to be used.
+	 * Enable the extensions.
 	 *
-	* @param bool $use_custom_pass
+	 * @return $this
 	 */
-	public function set_use_custom_pass($use_custom_pass)
+	public function with_extensions()
 	{
-		$this->use_custom_pass = $use_custom_pass;
+		$this->use_extensions = true;
+
+		return $this;
 	}
 
 	/**
-	* Set if the kernel compile pass have to be used.
+	 * Disable the extensions.
 	 *
-	* @param bool $use_kernel_pass
+	 * @return $this
 	 */
-	public function set_use_kernel_pass($use_kernel_pass)
+	public function without_extensions()
 	{
-		$this->use_kernel_pass = $use_kernel_pass;
+		$this->use_extensions = false;
+
+		return $this;
 	}
 
 	/**
-	* Set if the php config file should be injecting into the container.
+	 * Enable the caching of 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
+	 * @return $this
 	 */
-	public function set_dump_container($dump_container)
+	public function with_cache()
 	{
-		$this->dump_container = $dump_container;
+		$this->use_cache = true;
+
+		return $this;
 	}
 
 	/**
-	* Set if the container should be compiled automatically (default to true).
+	 * Disable the caching of the container.
 	 *
-	* @var bool $dump_container
+	 * @return $this
 	 */
-	public function set_compile_container($compile_container)
+	public function without_cache()
 	{
-		$this->compile_container = $compile_container;
+		$this->use_cache = false;
+
+		return $this;
 	}
 
 	/**
-	* Set a custom path to find the configuration of the container
+	 * Set the cache directory.
+	 *
+	 * @param string $cache_dir The cache directory.
+	 * @return $this
+	 */
+	public function with_cache_dir($cache_dir)
+	{
+		$this->cache_dir = $cache_dir;
+
+		return $this;
+	}
+
+	/**
+	 * Enable the compilation of the container.
+	 *
+	 * @return $this
+	 */
+	public function with_compiled_container()
+	{
+		$this->compile_container = true;
+
+		return $this;
+	}
+
+	/**
+	 * Disable the compilation of the container.
+	 *
+	 * @return $this
+	 */
+	public function without_compiled_container()
+	{
+		$this->compile_container = false;
+
+		return $this;
+	}
+
+	/**
+	 * Set a custom path to find the configuration of the container.
 	 *
 	 * @param string $config_path
+	 * @return $this
 	 */
-	public function set_config_path($config_path)
+	public function with_config_path($config_path)
 	{
 		$this->config_path = $config_path;
+
+		return $this;
+	}
+
+	/**
+	 * Set custom parameters to inject into the container.
+	 *
+	 * @param array $custom_parameters
+	 * @return $this
+	 */
+	public function with_custom_parameters($custom_parameters)
+	{
+		$this->custom_parameters = $custom_parameters;
+
+		return $this;
+	}
+
+	/**
+	 * Set custom parameters to inject into the container.
+	 *
+	 * @param \phpbb\config_php_file $config_php_file
+	 * @return $this
+	 */
+	public function with_config(\phpbb\config_php_file $config_php_file)
+	{
+		$this->config_php_file = $config_php_file;
+
+		return $this;
 	}
 
 	/**
@@ -301,26 +323,6 @@ class container_builder
 		return $this->config_path ?: $this->phpbb_root_path . 'config';
 	}
 
-	/**
-	* Set custom parameters to inject into the container.
-	*
-	* @param array $custom_parameters
-	*/
-	public function set_custom_parameters($custom_parameters)
-	{
-		$this->custom_parameters = $custom_parameters;
-	}
-
-	/**
-	 * Set the path to the cache directory.
-	 *
-	 * @param string $cache_dir Path to the cache directory
-	 */
-	public function set_cache_dir($cache_dir)
-	{
-		$this->cache_dir = $cache_dir;
-	}
-
 	/**
 	 * Returns the path to the cache directory (default: root_path/cache/environment).
 	 *
@@ -331,6 +333,57 @@ class container_builder
 		return $this->cache_dir ?: $this->phpbb_root_path . 'cache/' . $this->get_environment() . '/';
 	}
 
+	/**
+	 * Load the enabled extensions.
+	 */
+	protected function load_extensions()
+	{
+		if ($this->config_php_file !== null)
+		{
+			// Build an intermediate container to load the ext list from the database
+			$container_builder = new container_builder($this->phpbb_root_path, $this->php_ext);
+			$ext_container = $container_builder
+				->without_cache()
+				->without_extensions()
+				->with_config($this->config_php_file)
+				->with_environment('production')
+				->without_compiled_container()
+				->get_container()
+			;
+
+			$ext_container->register('cache.driver', '\\phpbb\\cache\\driver\\null');
+			$ext_container->compile();
+
+			$extensions = $ext_container->get('ext.manager')->all_enabled();
+
+			// Load each extension found
+			foreach ($extensions as $ext_name => $path)
+			{
+				$extension_class = '\\' . str_replace('/', '\\', $ext_name) . '\\di\\extension';
+
+				if (!class_exists($extension_class))
+				{
+					$extension_class = '\\phpbb\\extension\\di\\extension_base';
+				}
+
+				$this->container_extensions[] = new $extension_class($ext_name, $path);
+
+				// Load extension autoloader
+				$filename = $path . 'vendor/autoload.php';
+				if (file_exists($filename))
+				{
+					require $filename;
+				}
+			}
+		}
+		else
+		{
+			// To load the extensions we need the database credentials.
+			// Automatically disable the extensions if we don't have them.
+			$this->use_extensions = false;
+		}
+	}
+
 	/**
 	 * Dump the container to the disk.
 	 *
@@ -347,68 +400,6 @@ class container_builder
 		$cache->write($cached_container_dump, $this->container->getResources());
 	}
 
-	/**
-	* 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
 	 *
@@ -425,7 +416,6 @@ class container_builder
 		{
 			$container->registerExtension($extension);
 			$extensions_alias[] = $extension->getAlias();
-			//$container->loadFromExtension($extension->getAlias());
 		}
 
 		$container->getCompilerPassConfig()->setMergePass(new MergeExtensionConfigurationPass($extensions_alias));
@@ -504,6 +494,6 @@ class container_builder
 	 */
 	protected function get_environment()
 	{
-		return PHPBB_ENVIRONMENT;
+		return $this->environment ?: PHPBB_ENVIRONMENT;
 	}
 }