diff options
author | Tristan Darricau <github@nicofuma.fr> | 2014-10-04 16:30:34 +0200 |
---|---|---|
committer | Tristan Darricau <github@nicofuma.fr> | 2014-11-20 20:59:48 +0100 |
commit | 6cbb60d13f75da6d9b6c6d60555ea119df79b5c0 (patch) | |
tree | 3977e49d0e6eee7bf153973a81f459b0b0a612f1 | |
parent | 74cd97e75b1dce43a05d8e15e9fbccf01e833b57 (diff) | |
download | forums-6cbb60d13f75da6d9b6c6d60555ea119df79b5c0.tar forums-6cbb60d13f75da6d9b6c6d60555ea119df79b5c0.tar.gz forums-6cbb60d13f75da6d9b6c6d60555ea119df79b5c0.tar.bz2 forums-6cbb60d13f75da6d9b6c6d60555ea119df79b5c0.tar.xz forums-6cbb60d13f75da6d9b6c6d60555ea119df79b5c0.zip |
[ticket/12620] Adds a yaml config file
PHPBB3-12620
38 files changed, 135 insertions, 44 deletions
diff --git a/phpBB/common.php b/phpBB/common.php index 85568ab10e..2fa0c46b22 100644 --- a/phpBB/common.php +++ b/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 diff --git a/phpBB/config/default/config.yml b/phpBB/config/default/config.yml new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/phpBB/config/default/config.yml diff --git a/phpBB/config/default/parameters.yml b/phpBB/config/default/container/parameters.yml index 8ecc1428f4..8ecc1428f4 100644 --- a/phpBB/config/default/parameters.yml +++ b/phpBB/config/default/container/parameters.yml diff --git a/phpBB/config/default/services.yml b/phpBB/config/default/container/services.yml index 3f36a5178a..3f36a5178a 100644 --- a/phpBB/config/default/services.yml +++ b/phpBB/config/default/container/services.yml diff --git a/phpBB/config/default/services_auth_providers.yml b/phpBB/config/default/container/services_auth_providers.yml index 89303a684a..89303a684a 100644 --- a/phpBB/config/default/services_auth_providers.yml +++ b/phpBB/config/default/container/services_auth_providers.yml diff --git a/phpBB/config/default/services_avatars.yml b/phpBB/config/default/container/services_avatars.yml index 8e5b1fdbfe..8e5b1fdbfe 100644 --- a/phpBB/config/default/services_avatars.yml +++ b/phpBB/config/default/container/services_avatars.yml diff --git a/phpBB/config/default/services_captcha.yml b/phpBB/config/default/container/services_captcha.yml index e3f617e909..e3f617e909 100644 --- a/phpBB/config/default/services_captcha.yml +++ b/phpBB/config/default/container/services_captcha.yml diff --git a/phpBB/config/default/services_console.yml b/phpBB/config/default/container/services_console.yml index 1e18a7dd37..1e18a7dd37 100644 --- a/phpBB/config/default/services_console.yml +++ b/phpBB/config/default/container/services_console.yml diff --git a/phpBB/config/default/services_cron_tasks.yml b/phpBB/config/default/container/services_cron_tasks.yml index acf9a48bf9..acf9a48bf9 100644 --- a/phpBB/config/default/services_cron_tasks.yml +++ b/phpBB/config/default/container/services_cron_tasks.yml diff --git a/phpBB/config/default/services_feed.yml b/phpBB/config/default/container/services_feed.yml index 48bd9fe76f..48bd9fe76f 100644 --- a/phpBB/config/default/services_feed.yml +++ b/phpBB/config/default/container/services_feed.yml diff --git a/phpBB/config/default/services_migrator.yml b/phpBB/config/default/container/services_migrator.yml index cd04eea5c2..cd04eea5c2 100644 --- a/phpBB/config/default/services_migrator.yml +++ b/phpBB/config/default/container/services_migrator.yml diff --git a/phpBB/config/default/services_mimetype_guessers.yml b/phpBB/config/default/container/services_mimetype_guessers.yml index 0115146deb..0115146deb 100644 --- a/phpBB/config/default/services_mimetype_guessers.yml +++ b/phpBB/config/default/container/services_mimetype_guessers.yml diff --git a/phpBB/config/default/services_notifications.yml b/phpBB/config/default/container/services_notifications.yml index 5675e76a99..5675e76a99 100644 --- a/phpBB/config/default/services_notifications.yml +++ b/phpBB/config/default/container/services_notifications.yml diff --git a/phpBB/config/default/services_passwords.yml b/phpBB/config/default/container/services_passwords.yml index 3dc217286f..3dc217286f 100644 --- a/phpBB/config/default/services_passwords.yml +++ b/phpBB/config/default/container/services_passwords.yml diff --git a/phpBB/config/default/services_profilefields.yml b/phpBB/config/default/container/services_profilefields.yml index ce2a84b12b..ce2a84b12b 100644 --- a/phpBB/config/default/services_profilefields.yml +++ b/phpBB/config/default/container/services_profilefields.yml diff --git a/phpBB/config/default/services_twig.yml b/phpBB/config/default/container/services_twig.yml index 06ce5bc15c..fc5f9ba6a1 100644 --- a/phpBB/config/default/services_twig.yml +++ b/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: diff --git a/phpBB/config/default/tables.yml b/phpBB/config/default/container/tables.yml index 2fe2a33be8..2fe2a33be8 100644 --- a/phpBB/config/default/tables.yml +++ b/phpBB/config/default/container/tables.yml diff --git a/phpBB/config/development/config.yml b/phpBB/config/development/config.yml new file mode 100644 index 0000000000..1c17b08931 --- /dev/null +++ b/phpBB/config/development/config.yml @@ -0,0 +1,5 @@ +imports: + - { resource: ../default/config.yml } + +core: + require_dev_dependencies: true diff --git a/phpBB/config/development/environment.yml b/phpBB/config/development/container/environment.yml index 40a3c7a683..40a3c7a683 100644 --- a/phpBB/config/development/environment.yml +++ b/phpBB/config/development/container/environment.yml diff --git a/phpBB/config/development/container/parameters.yml b/phpBB/config/development/container/parameters.yml new file mode 100644 index 0000000000..0447646806 --- /dev/null +++ b/phpBB/config/development/container/parameters.yml @@ -0,0 +1,2 @@ +imports: + - { resource: ../../default/container/parameters.yml } diff --git a/phpBB/config/development/container/services.yml b/phpBB/config/development/container/services.yml new file mode 100644 index 0000000000..b302f0f966 --- /dev/null +++ b/phpBB/config/development/container/services.yml @@ -0,0 +1,2 @@ +imports: + - { resource: ../../default/container/services.yml } diff --git a/phpBB/config/development/parameters.yml b/phpBB/config/development/parameters.yml deleted file mode 100644 index 02743729f9..0000000000 --- a/phpBB/config/development/parameters.yml +++ /dev/null @@ -1,2 +0,0 @@ -imports: - - { resource: ../default/parameters.yml } diff --git a/phpBB/config/development/services.yml b/phpBB/config/development/services.yml deleted file mode 100644 index 6342885067..0000000000 --- a/phpBB/config/development/services.yml +++ /dev/null @@ -1,2 +0,0 @@ -imports: - - { resource: ../default/services.yml } diff --git a/phpBB/config/production/config.yml b/phpBB/config/production/config.yml new file mode 100644 index 0000000000..979dbbcdd9 --- /dev/null +++ b/phpBB/config/production/config.yml @@ -0,0 +1,2 @@ +imports: + - { resource: ../default/config.yml } diff --git a/phpBB/config/production/environment.yml b/phpBB/config/production/container/environment.yml index 40a3c7a683..40a3c7a683 100644 --- a/phpBB/config/production/environment.yml +++ b/phpBB/config/production/container/environment.yml diff --git a/phpBB/config/production/container/parameters.yml b/phpBB/config/production/container/parameters.yml new file mode 100644 index 0000000000..0447646806 --- /dev/null +++ b/phpBB/config/production/container/parameters.yml @@ -0,0 +1,2 @@ +imports: + - { resource: ../../default/container/parameters.yml } diff --git a/phpBB/config/production/container/services.yml b/phpBB/config/production/container/services.yml new file mode 100644 index 0000000000..b302f0f966 --- /dev/null +++ b/phpBB/config/production/container/services.yml @@ -0,0 +1,2 @@ +imports: + - { resource: ../../default/container/services.yml } diff --git a/phpBB/config/production/parameters.yml b/phpBB/config/production/parameters.yml deleted file mode 100644 index 02743729f9..0000000000 --- a/phpBB/config/production/parameters.yml +++ /dev/null @@ -1,2 +0,0 @@ -imports: - - { resource: ../default/parameters.yml } diff --git a/phpBB/config/production/services.yml b/phpBB/config/production/services.yml deleted file mode 100644 index 6342885067..0000000000 --- a/phpBB/config/production/services.yml +++ /dev/null @@ -1,2 +0,0 @@ -imports: - - { resource: ../default/services.yml } diff --git a/phpBB/phpbb/di/container_builder.php b/phpBB/phpbb/di/container_builder.php index b264b0182f..45dbaaf303 100644 --- a/phpBB/phpbb/di/container_builder.php +++ b/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) - { - $this->custom_parameters = array( - 'core.root_path' => $this->phpbb_root_path, - 'core.php_ext' => $this->php_ext, - ); - } - - $this->custom_parameters['environment'] = PHPBB_ENVIRONMENT; + 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() + ); + } - foreach ($this->custom_parameters as $key => $value) + /** + * 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->container->setParameter($key, $value); + if (0 === strpos($key, 'PHPBB__')) + { + $parameters[strtolower(str_replace('__', '.', substr($key, 9)))] = $value; + } } + + return $parameters; } /** diff --git a/phpBB/phpbb/di/extension/container_configuration.php b/phpBB/phpbb/di/extension/container_configuration.php new file mode 100644 index 0000000000..1f1c077472 --- /dev/null +++ b/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; + } +} diff --git a/phpBB/phpbb/di/extension/core.php b/phpBB/phpbb/di/extension/core.php index 7787602aba..62fcf46ad5 100644 --- a/phpBB/phpbb/di/extension/core.php +++ b/phpBB/phpbb/di/extension/core.php @@ -13,10 +13,11 @@ namespace phpbb\di\extension; +use Symfony\Component\Config\FileLocator; +use Symfony\Component\Config\Resource\FileResource; 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\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(); } /** diff --git a/phpBB/phpbb/di/extension/ext.php b/phpBB/phpbb/di/extension/ext.php index 330303ca0c..021e862118 100644 --- a/phpBB/phpbb/di/extension/ext.php +++ b/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')) diff --git a/tests/di/fixtures/config/development/environment.yml b/tests/di/fixtures/config/development/container/environment.yml index f2a22ae109..f2a22ae109 100644 --- a/tests/di/fixtures/config/development/environment.yml +++ b/tests/di/fixtures/config/development/container/environment.yml diff --git a/tests/di/fixtures/ext/vendor/disabled/config/development/environment.yml b/tests/di/fixtures/ext/vendor/disabled/config/development/container/environment.yml index 31ada384bf..31ada384bf 100644 --- a/tests/di/fixtures/ext/vendor/disabled/config/development/environment.yml +++ b/tests/di/fixtures/ext/vendor/disabled/config/development/container/environment.yml diff --git a/tests/di/fixtures/ext/vendor/enabled-2/config/development/environment.yml b/tests/di/fixtures/ext/vendor/enabled-2/config/development/container/environment.yml index feeb5a7a2d..feeb5a7a2d 100644 --- a/tests/di/fixtures/ext/vendor/enabled-2/config/development/environment.yml +++ b/tests/di/fixtures/ext/vendor/enabled-2/config/development/container/environment.yml diff --git a/tests/di/fixtures/ext/vendor/enabled/config/default/environment.yml b/tests/di/fixtures/ext/vendor/enabled/config/default/container/environment.yml index 88a7919ed1..88a7919ed1 100644 --- a/tests/di/fixtures/ext/vendor/enabled/config/default/environment.yml +++ b/tests/di/fixtures/ext/vendor/enabled/config/default/container/environment.yml diff --git a/tests/di/fixtures/other_config/development/environment.yml b/tests/di/fixtures/other_config/development/container/environment.yml index c299bfc648..c299bfc648 100644 --- a/tests/di/fixtures/other_config/development/environment.yml +++ b/tests/di/fixtures/other_config/development/container/environment.yml |