[ticket/12620] Adds a yaml config file

PHPBB3-12620

phpBB/common.php

@@ -96,14 +96,6 @@ 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();
 
-if (PHPBB_ENVIRONMENT == 'debug' && !class_exists('Goutte\Client', true))
-{
-	trigger_error(
-		'Composer development dependencies have not been set up for the development environment yet, run ' .
-		"'php ../composer.phar install --dev' from the phpBB directory to do so.",
-		E_USER_ERROR
-	);
-}
 phpbb_load_extensions_autoloaders($phpbb_root_path);
 
 // Set up container

phpBB/config/default/container/services_twig.yml

@@ -1,5 +1,5 @@
 parameters:
-    core.template.cache_path: %core.root_path%cache/%environment%/twig/
+    core.template.cache_path: %core.root_path%cache/%core.environment%/twig/
 
 services:
     template.twig.environment:

phpBB/config/development/config.yml

@@ -0,0 +1,5 @@
+imports:
+    - { resource: ../default/config.yml }
+
+core:
+    require_dev_dependencies: true

phpBB/config/development/container/parameters.yml

@@ -0,0 +1,2 @@
+imports:
+    - { resource: ../../default/container/parameters.yml }

phpBB/config/development/container/services.yml

@@ -0,0 +1,2 @@
+imports:
+    - { resource: ../../default/container/services.yml }

phpBB/config/development/parameters.yml

@@ -1,2 +0,0 @@
-imports:
-    - { resource: ../default/parameters.yml }

phpBB/config/development/services.yml

@@ -1,2 +0,0 @@
-imports:
-    - { resource: ../default/services.yml }

phpBB/config/production/config.yml

@@ -0,0 +1,2 @@
+imports:
+    - { resource: ../default/config.yml }

phpBB/config/production/container/parameters.yml

@@ -0,0 +1,2 @@
+imports:
+    - { resource: ../../default/container/parameters.yml }

phpBB/config/production/container/services.yml

@@ -0,0 +1,2 @@
+imports:
+    - { resource: ../../default/container/services.yml }

phpBB/config/production/parameters.yml

@@ -1,2 +0,0 @@
-imports:
-    - { resource: ../default/parameters.yml }

phpBB/config/production/services.yml

@@ -1,2 +0,0 @@
-imports:
-    - { resource: ../default/services.yml }

phpBB/phpbb/di/container_builder.php

@@ -14,9 +14,13 @@
 namespace phpbb\di;
 
 use Symfony\Component\Config\ConfigCache;
+use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
 use Symfony\Component\HttpKernel\DependencyInjection\RegisterListenersPass;
+use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;
 
 class container_builder
 {
@@ -151,7 +155,6 @@ class container_builder
 		}
 		else
 		{
-
 			$container_extensions = array(new \phpbb\di\extension\core($this->get_config_path()));
 
 			if ($this->use_extensions)
@@ -179,7 +182,8 @@ class container_builder
 				}
 			}
 
-			$this->inject_custom_parameters();
+			$loader = new YamlFileLoader($this->container, new FileLocator(phpbb_realpath($this->get_config_path())));
+			$loader->load(PHPBB_ENVIRONMENT . '/config.yml');
 
 			if ($this->compile_container)
 			{
@@ -400,36 +404,59 @@ class container_builder
 	*/
 	protected function create_container(array $extensions)
 	{
-		$container = new ContainerBuilder();
+		$container = new ContainerBuilder(new ParameterBag($this->get_core_parameters()));
+
+		$extensions_alias = array();
 
 		foreach ($extensions as $extension)
 		{
 			$container->registerExtension($extension);
-			$container->loadFromExtension($extension->getAlias());
+			$extensions_alias[] = $extension->getAlias();
+			//$container->loadFromExtension($extension->getAlias());
 		}
 
+		$container->getCompilerPassConfig()->setMergePass(new MergeExtensionConfigurationPass($extensions_alias));
+
 		return $container;
 	}
 
 	/**
-	* Inject the customs parameters into the container
-	*/
-	protected function inject_custom_parameters()
+	 * Returns the core parameters.
+	 *
+	 * @return array An array of core parameters
+	 */
+	protected function get_core_parameters()
 	{
-		if ($this->custom_parameters === null)
+		return array_merge(
+			array(
+				'core.root_path'     => $this->phpbb_root_path,
+				'core.php_ext'       => $this->php_ext,
+				'core.environment'   => PHPBB_ENVIRONMENT,
+				'core.debug'         => DEBUG,
+			),
+			$this->get_env_parameters()
+		);
+	}
+
+	/**
+	 * Gets the environment parameters.
+	 *
+	 * Only the parameters starting with "PHPBB__" are considered.
+	 *
+	 * @return array An array of parameters
+	 */
+	protected function get_env_parameters()
+	{
+		$parameters = array();
+		foreach ($_SERVER as $key => $value)
 		{
-			$this->custom_parameters = array(
-				'core.root_path' => $this->phpbb_root_path,
-				'core.php_ext' => $this->php_ext,
-			);
+			if (0 === strpos($key, 'PHPBB__'))
+			{
+				$parameters[strtolower(str_replace('__', '.', substr($key, 9)))] = $value;
+			}
 		}
 
-		$this->custom_parameters['environment'] = PHPBB_ENVIRONMENT;
-
-		foreach ($this->custom_parameters as $key => $value)
-		{
-			$this->container->setParameter($key, $value);
-		}
+		return $parameters;
 	}
 
 	/**

phpBB/phpbb/di/extension/container_configuration.php

@@ -0,0 +1,38 @@
+<?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\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+class container_configuration implements ConfigurationInterface
+{
+
+	/**
+	 * Generates the configuration tree builder.
+	 *
+	 * @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
+	 */
+	public function getConfigTreeBuilder()
+	{
+		$treeBuilder = new TreeBuilder();
+		$rootNode = $treeBuilder->root('core');
+		$rootNode
+			->children()
+			->booleanNode('require_dev_dependencies')->defaultValue(false)->end()
+			->end()
+		;
+		return $treeBuilder;
+	}
+}

phpBB/phpbb/di/extension/core.php

@@ -13,10 +13,11 @@
 
 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;
+use Symfony\Component\Config\Resource\FileResource;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
 * Container core extension
@@ -42,15 +43,41 @@ class core extends Extension
 	/**
 	* Loads a specific configuration.
 	*
-	* @param array            $config    An array of configuration values
+	* @param array            $configs   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)
+	public function load(array $configs, ContainerBuilder $container)
 	{
 		$loader = new YamlFileLoader($container, new FileLocator(phpbb_realpath($this->config_path)));
-		$loader->load(PHPBB_ENVIRONMENT . '/environment.yml');
+		$loader->load(PHPBB_ENVIRONMENT . '/container/environment.yml');
+
+		$config = $this->getConfiguration($configs, $container);
+		$config = $this->processConfiguration($config, $configs);
+
+		if ($config['require_dev_dependencies'])
+		{
+			if (!class_exists('Goutte\Client', true))
+			{
+				trigger_error(
+					'Composer development dependencies have not been set up for the ' . $container->getParameter('core.environment') . ' environment yet, run ' .
+					"'php ../composer.phar install --dev' from the phpBB directory to do so.",
+					E_USER_ERROR
+				);
+			}
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getConfiguration(array $config, ContainerBuilder $container)
+	{
+		$r = new \ReflectionClass('\phpbb\di\extension\container_configuration');
+		$container->addResource(new FileResource($r->getFileName()));
+
+		return new container_configuration();
 	}
 
 	/**

phpBB/phpbb/di/extension/ext.php

@@ -48,16 +48,16 @@ class ext extends Extension
 			$services_directory = false;
 			$services_file = false;
 
-			if (file_exists($path . 'config/' . PHPBB_ENVIRONMENT . '/environment.yml'))
+			if (file_exists($path . 'config/' . PHPBB_ENVIRONMENT . '/container/environment.yml'))
 			{
-				$services_directory = $path . 'config/' . PHPBB_ENVIRONMENT;
+				$services_directory = $path . 'config/' . PHPBB_ENVIRONMENT . '/container/';
 				$services_file = 'environment.yml';
 			}
 			else if (!is_dir($path . 'config/' . PHPBB_ENVIRONMENT))
 			{
-				if (file_exists($path . 'config/default/environment.yml'))
+				if (file_exists($path . 'config/default/container/environment.yml'))
 				{
-					$services_directory = $path . 'config/default';
+					$services_directory = $path . 'config/default/container/';
 					$services_file = 'environment.yml';
 				}
 				else if (!is_dir($path . 'config/default') && file_exists($path . '/config/services.yml'))