mirror of
https://github.com/phpbb/phpbb.git
synced 2025-08-10 18:54:08 +02:00
Merge pull request #2671 from Nicofuma/ticket/12775
[ticket/12775] Replace functions_container with a container_builder class. * Nicofuma/ticket/12775: (34 commits) [ticket/12775] Set dbal.conn.driver as synthetic during installation [ticket/12775] Add the definition of dbal.conn in fixtures/config/services.yml [ticket/12775] Inject the connection when created in the container [ticket/12775] Extract the vars later in install/install_update.php [ticket/12775] Rename config_php_handler to config_php_file container_builder [ticket/12775] Set defined_vars as a property of config_php_file [ticket/12775] Fix doc blocks in the container builder [ticket/12775] Remove useless includes of config.php [ticket/12775] Move phpbb_convert_30_dbms_to_31 into the config file class [ticket/12775] Fix comments [ticket/12775] Update doc blocks [ticket/12775] Fix container_builder [ticket/12775] Rename config_php to config_php_file [ticket/12775] Renamed to \phpbb\di\container_builder [ticket/12775] Remove the last include of functions_container [ticket/12775] Fix unit tests [ticket/12775] Add tests for \phpbb\config_php [ticket/12775] Add tests for the container factory [ticket/12775] Use a field instead of a local var in load_config_var() [ticket/12775] Update container and config in install/ ...
This commit is contained in:
Andreas Fischer
175
phpBB/phpbb/config_php_file.php
Normal file
175
phpBB/phpbb/config_php_file.php
Normal file
@@ -0,0 +1,175 @@
|
||||
<?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;
|
||||
|
||||
class config_php_file
|
||||
{
|
||||
/** @var string phpBB Root Path */
|
||||
protected $phpbb_root_path;
|
||||
|
||||
/** @var string php file extension */
|
||||
protected $php_ext;
|
||||
|
||||
/**
|
||||
* Indicates whether 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();
|
||||
|
||||
/**
|
||||
* The path to the config file. (Default: $phpbb_root_path . 'config.' . $php_ext)
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $config_file;
|
||||
|
||||
private $defined_vars;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param string $phpbb_root_path phpBB Root Path
|
||||
* @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;
|
||||
$this->config_file = $this->phpbb_root_path . 'config.' . $this->php_ext;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the path to the config file.
|
||||
*
|
||||
* @param string $config_file
|
||||
*/
|
||||
public function set_config_file($config_file)
|
||||
{
|
||||
$this->config_file = $config_file;
|
||||
$this->config_loaded = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an associative array containing the variables defined by the config file.
|
||||
*
|
||||
* @return bool|array Return the content of the config file or false if the file does not exists.
|
||||
*/
|
||||
public function get_all()
|
||||
{
|
||||
if (!$this->load_config_file())
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
return $this->config_data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the value of a variable defined into the config.php file and false if the variable does not exist.
|
||||
*
|
||||
* @param string $variable The name of the variable
|
||||
* @return mixed
|
||||
*/
|
||||
public function get($variable)
|
||||
{
|
||||
if (!$this->load_config_file())
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
return isset($this->config_data[$variable]) ? $this->config_data[$variable] : false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the config file and store the information.
|
||||
*
|
||||
* @return bool True if the file was correctly loaded, false otherwise.
|
||||
*/
|
||||
protected function load_config_file()
|
||||
{
|
||||
if (!$this->config_loaded)
|
||||
{
|
||||
if (file_exists($this->config_file))
|
||||
{
|
||||
$this->defined_vars = get_defined_vars();
|
||||
|
||||
require($this->config_file);
|
||||
$this->config_data = array_diff_key(get_defined_vars(), $this->defined_vars);
|
||||
|
||||
$this->config_loaded = true;
|
||||
}
|
||||
else
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert either 3.0 dbms or 3.1 db driver class name to 3.1 db driver class name.
|
||||
*
|
||||
* If $dbms is a valid 3.1 db driver class name, returns it unchanged.
|
||||
* Otherwise prepends phpbb\db\driver\ to the dbms to convert a 3.0 dbms
|
||||
* to 3.1 db driver class name.
|
||||
*
|
||||
* @param string $dbms dbms parameter
|
||||
* @return string driver class
|
||||
* @throws \RuntimeException
|
||||
*/
|
||||
public function convert_30_dbms_to_31($dbms)
|
||||
{
|
||||
// Note: this check is done first because mysqli extension
|
||||
// supplies a mysqli class, and class_exists($dbms) would return
|
||||
// true for mysqli class.
|
||||
// However, per the docblock any valid 3.1 driver name should be
|
||||
// recognized by this function, and have priority over 3.0 dbms.
|
||||
if (strpos($dbms, 'phpbb\db\driver') === false && class_exists('phpbb\db\driver\\' . $dbms))
|
||||
{
|
||||
return 'phpbb\db\driver\\' . $dbms;
|
||||
}
|
||||
|
||||
if (class_exists($dbms))
|
||||
{
|
||||
// Additionally we could check that $dbms extends phpbb\db\driver\driver.
|
||||
// http://php.net/manual/en/class.reflectionclass.php
|
||||
// Beware of possible performance issues:
|
||||
// http://stackoverflow.com/questions/294582/php-5-reflection-api-performance
|
||||
// We could check for interface implementation in all paths or
|
||||
// only when we do not prepend phpbb\db\driver\.
|
||||
|
||||
/*
|
||||
$reflection = new \ReflectionClass($dbms);
|
||||
|
||||
if ($reflection->isSubclassOf('phpbb\db\driver\driver'))
|
||||
{
|
||||
return $dbms;
|
||||
}
|
||||
*/
|
||||
|
||||
return $dbms;
|
||||
}
|
||||
|
||||
throw new \RuntimeException("You have specified an invalid dbms driver: $dbms");
|
||||
}
|
||||
}
|
||||
402
phpBB/phpbb/di/container_builder.php
Normal file
402
phpBB/phpbb/di/container_builder.php
Normal file
@@ -0,0 +1,402 @@
|
||||
<?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;
|
||||
|
||||
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)
|
||||
{
|
||||
$this->container->addCompilerPass(new \phpbb\di\pass\collection_pass());
|
||||
|
||||
if ($this->use_kernel_pass)
|
||||
{
|
||||
$this->container->addCompilerPass(new \phpbb\di\pass\kernel_pass());
|
||||
}
|
||||
}
|
||||
|
||||
$this->inject_custom_parameters();
|
||||
|
||||
if ($this->compile_container)
|
||||
{
|
||||
$this->container->compile();
|
||||
}
|
||||
|
||||
if ($this->dump_container && !defined('DEBUG'))
|
||||
{
|
||||
$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;
|
||||
}
|
||||
}
|
||||
@@ -21,9 +21,12 @@ use Symfony\Component\HttpKernel\DependencyInjection\Extension;
|
||||
*/
|
||||
class config extends Extension
|
||||
{
|
||||
public function __construct($config_file)
|
||||
/** @var array */
|
||||
protected $config_php;
|
||||
|
||||
public function __construct(\phpbb\config_php_file $config_php)
|
||||
{
|
||||
$this->config_file = $config_file;
|
||||
$this->config_php = $config_php;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -36,17 +39,15 @@ class config extends Extension
|
||||
*/
|
||||
public function load(array $config, ContainerBuilder $container)
|
||||
{
|
||||
require($this->config_file);
|
||||
|
||||
$container->setParameter('core.adm_relative_path', (isset($phpbb_adm_relative_path) ? $phpbb_adm_relative_path : 'adm/'));
|
||||
$container->setParameter('core.table_prefix', $table_prefix);
|
||||
$container->setParameter('cache.driver.class', $this->convert_30_acm_type($acm_type));
|
||||
$container->setParameter('dbal.driver.class', phpbb_convert_30_dbms_to_31($dbms));
|
||||
$container->setParameter('dbal.dbhost', $dbhost);
|
||||
$container->setParameter('dbal.dbuser', $dbuser);
|
||||
$container->setParameter('dbal.dbpasswd', $dbpasswd);
|
||||
$container->setParameter('dbal.dbname', $dbname);
|
||||
$container->setParameter('dbal.dbport', $dbport);
|
||||
$container->setParameter('core.adm_relative_path', ($this->config_php->get('phpbb_adm_relative_path') ? $this->config_php->get('phpbb_adm_relative_path') : 'adm/'));
|
||||
$container->setParameter('core.table_prefix', $this->config_php->get('table_prefix'));
|
||||
$container->setParameter('cache.driver.class', $this->convert_30_acm_type($this->config_php->get('acm_type')));
|
||||
$container->setParameter('dbal.driver.class', $this->config_php->convert_30_dbms_to_31($this->config_php->get('dbms')));
|
||||
$container->setParameter('dbal.dbhost', $this->config_php->get('dbhost'));
|
||||
$container->setParameter('dbal.dbuser', $this->config_php->get('dbuser'));
|
||||
$container->setParameter('dbal.dbpasswd', $this->config_php->get('dbpasswd'));
|
||||
$container->setParameter('dbal.dbname', $this->config_php->get('dbname'));
|
||||
$container->setParameter('dbal.dbport', $this->config_php->get('dbport'));
|
||||
$container->setParameter('dbal.new_link', defined('PHPBB_DB_NEW_LINK') && PHPBB_DB_NEW_LINK);
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user