diff options
Diffstat (limited to 'phpBB/phpbb/di/container_builder.php')
| -rw-r--r-- | phpBB/phpbb/di/container_builder.php | 611 | 
1 files changed, 379 insertions, 232 deletions
| diff --git a/phpBB/phpbb/di/container_builder.php b/phpBB/phpbb/di/container_builder.php index a214356ac3..8f175c966c 100644 --- a/phpBB/phpbb/di/container_builder.php +++ b/phpBB/phpbb/di/container_builder.php @@ -13,392 +13,539 @@  namespace phpbb\di; +use phpbb\filesystem\filesystem; +use Symfony\Component\Config\ConfigCache; +use Symfony\Component\Config\FileLocator;  use Symfony\Component\DependencyInjection\ContainerBuilder;  use Symfony\Component\DependencyInjection\Dumper\PhpDumper; -use Symfony\Component\HttpKernel\DependencyInjection\RegisterListenersPass; +use Symfony\Component\DependencyInjection\Loader\YamlFileLoader; +use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag; +use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass; +use Symfony\Component\Filesystem\Exception\IOException; +use Symfony\Component\Finder\Finder; +use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;  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 string The environment to use. +	 */ +	protected $environment;  	/** -	* @var \phpbb\db\driver\driver_interface -	*/ -	protected $dbal_connection = null; +	 * @var string phpBB Root Path +	 */ +	protected $phpbb_root_path;  	/** -	* @var array the installed extensions -	*/ -	protected $installed_exts = null; +	 * @var string php file extension +	 */ +	protected $php_ext;  	/** -	* Indicates whether the php config file should be injected into the container (default to true). -	* -	* @var bool -	*/ -	protected $inject_config = true; +	 * The container under construction +	 * +	 * @var ContainerBuilder +	 */ +	protected $container;  	/** -	* Indicates whether extensions should be used (default to true). -	* -	* @var bool -	*/ +	 * 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 -	*/ +	 * 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 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 $use_cache = true;  	/** -	* Indicates whether the kernel compile pass should be used (default to true). -	* -	* @var bool -	*/ -	protected $use_kernel_pass = true; +	 * Indicates if the container should be compiled automatically (default to true). +	 * +	 * @var bool +	 */ +	protected $compile_container = 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; +	 * Custom parameters to inject into the container. +	 * +	 * Default to: +	 * 	array( +	 * 		'core.root_path', $this->phpbb_root_path, +	 * 		'core.php_ext', $this->php_ext, +	 * ); +	 * +	 * @var array +	 */ +	protected $custom_parameters = null;  	/** -	* Indicates if the container should be compiled automatically (default to true). -	* -	* @var bool -	*/ -	protected $compile_container = true; +	 * @var \phpbb\config_php_file +	 */ +	protected $config_php_file;  	/** -	* 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 string +	 */ +	protected $cache_dir;  	/** -	* @var \phpbb\config_php_file -	*/ -	protected $config_php_file; +	 * @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) +	 * 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->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 -	*/ +	 * 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)) +		$config_cache = new ConfigCache($container_filename, defined('DEBUG')); +		if ($this->use_cache && $config_cache->isFresh())  		{ -			require($container_filename); +			require($config_cache->getPath());  			$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)); +			$this->container_extensions = array(new extension\core($this->get_config_path()));  			if ($this->use_extensions)  			{ -				$installed_exts = $this->get_installed_extensions(); -				$container_extensions[] = new \phpbb\di\extension\ext($installed_exts); +				$this->load_extensions();  			} -			if ($this->inject_config) +			// Inject the config +			if ($this->config_php_file)  			{ -				$container_extensions[] = new \phpbb\di\extension\config($this->config_php_file); +				$this->container_extensions[] = new extension\config($this->config_php_file);  			} -			$this->container = $this->create_container($container_extensions); +			$this->container = $this->create_container($this->container_extensions); -			if ($this->use_custom_pass) -			{ -				// Symfony Kernel Listeners -				$this->container->addCompilerPass(new \phpbb\di\pass\collection_pass()); -				$this->container->addCompilerPass(new RegisterListenersPass('dispatcher', 'event.listener_listener', 'event.listener')); +			// Easy collections through tags +			$this->container->addCompilerPass(new pass\collection_pass()); -				if ($this->use_kernel_pass) -				{ -					$this->container->addCompilerPass(new RegisterListenersPass('dispatcher')); -				} +			// Event listeners "phpBB style" +			$this->container->addCompilerPass(new RegisterListenersPass('dispatcher', 'event.listener_listener', 'event.listener')); + +			// Event listeners "Symfony style" +			$this->container->addCompilerPass(new RegisterListenersPass('dispatcher')); + +			if ($this->use_extensions) +			{ +				$this->register_ext_compiler_pass();  			} +			$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'); +  			$this->inject_custom_parameters();  			if ($this->compile_container)  			{  				$this->container->compile(); -			} -			if ($this->dump_container && !defined('DEBUG_CONTAINER')) -			{ -				$this->dump_container($container_filename); +				if ($this->use_cache) +				{ +					$this->dump_container($config_cache); +				}  			}  		} -		$this->container->set('config.php', $this->config_php_file); - -		if ($this->compile_container) +		if ($this->compile_container && $this->config_php_file)  		{ -			$this->inject_dbal(); +			$this->container->set('config.php', $this->config_php_file);  		}  		return $this->container;  	}  	/** -	* Set if the extensions should be used. -	* -	* @param bool $use_extensions -	*/ -	public function set_use_extensions($use_extensions) +	 * Enable the extensions. +	 * +	 * @param string $environment The environment to use +	 * @return $this +	 */ +	public function with_environment($environment) +	{ +		$this->environment = $environment; + +		return $this; +	} + +	/** +	 * Enable the extensions. +	 * +	 * @return $this +	 */ +	public function with_extensions() +	{ +		$this->use_extensions = true; + +		return $this; +	} + +	/** +	 * Disable the extensions. +	 * +	 * @return $this +	 */ +	public function without_extensions()  	{ -		$this->use_extensions = $use_extensions; +		$this->use_extensions = false; + +		return $this;  	}  	/** -	* Set if the phpBB compile pass have to be used. -	* -	* @param bool $use_custom_pass -	*/ -	public function set_use_custom_pass($use_custom_pass) +	 * Enable the caching of the container. +	 * +	 * If DEBUG_CONTAINER is set this option is ignored and a new container is build. +	 * +	 * @return $this +	 */ +	public function with_cache()  	{ -		$this->use_custom_pass = $use_custom_pass; +		$this->use_cache = true; + +		return $this;  	}  	/** -	* Set if the kernel compile pass have to be used. -	* -	* @param bool $use_kernel_pass -	*/ -	public function set_use_kernel_pass($use_kernel_pass) +	 * Disable the caching of the container. +	 * +	 * @return $this +	 */ +	public function without_cache()  	{ -		$this->use_kernel_pass = $use_kernel_pass; +		$this->use_cache = false; + +		return $this;  	}  	/** -	* Set if the php config file should be injecting into the container. -	* -	* @param bool $inject_config -	*/ -	public function set_inject_config($inject_config) +	 * Set the cache directory. +	 * +	 * @param string $cache_dir The cache directory. +	 * @return $this +	 */ +	public function with_cache_dir($cache_dir)  	{ -		$this->inject_config = $inject_config; +		$this->cache_dir = $cache_dir; + +		return $this;  	}  	/** -	* 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) +	 * Enable the compilation of the container. +	 * +	 * @return $this +	 */ +	public function with_compiled_container()  	{ -		$this->dump_container = $dump_container; +		$this->compile_container = true; + +		return $this;  	}  	/** -	* Set if the container should be compiled automatically (default to true). -	* -	* @var bool $dump_container -	*/ -	public function set_compile_container($compile_container) +	 * Disable the compilation of the container. +	 * +	 * @return $this +	 */ +	public function without_compiled_container()  	{ -		$this->compile_container = $compile_container; +		$this->compile_container = false; + +		return $this;  	}  	/** -	* Set a custom path to find the configuration of the container -	* -	* @param string $config_path -	*/ -	public function set_config_path($config_path) +	 * Set a custom path to find the configuration of the container. +	 * +	 * @param string $config_path +	 * @return $this +	 */ +	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 -	*/ -	public function set_custom_parameters($custom_parameters) +	 * 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;  	}  	/** -	* Dump the container to the disk. -	* -	* @param string $container_filename The name of the file. -	*/ -	protected function dump_container($container_filename) +	 * 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)  	{ -		$dumper = new PhpDumper($this->container); -		$cached_container_dump = $dumper->dump(array( -			'class'         => 'phpbb_cache_container', -			'base_class'    => 'Symfony\\Component\\DependencyInjection\\ContainerBuilder', -		)); +		$this->config_php_file = $config_php_file; -		file_put_contents($container_filename, $cached_container_dump); +		return $this;  	}  	/** -	* Inject the connection into the container if one was opened. -	*/ -	protected function inject_dbal() +	 * Returns the path to the container configuration (default: root_path/config) +	 * +	 * @return string +	 */ +	protected function get_config_path()  	{ -		if ($this->dbal_connection !== null) -		{ -			$this->container->get('dbal.conn')->set_driver($this->dbal_connection); -		} +		return $this->config_path ?: $this->phpbb_root_path . 'config';  	}  	/** -	* Get DB connection. -	* -	* @return \phpbb\db\driver\driver_interface -	*/ -	protected function get_dbal_connection() +	 * Returns the path to the cache directory (default: root_path/cache/environment). +	 * +	 * @return string Path to the cache directory. +	 */ +	protected function get_cache_dir()  	{ -		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; +		return $this->cache_dir ?: $this->phpbb_root_path . 'cache/' . $this->get_environment() . '/';  	}  	/** -	* Get enabled extensions. -	* -	* @return array enabled extensions -	*/ -	protected function get_installed_extensions() +	 * Load the enabled extensions. +	 */ +	protected function load_extensions()  	{ -		$db = $this->get_dbal_connection(); -		$extension_table = $this->config_php_file->get('table_prefix') . 'ext'; +		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_config_path($this->get_config_path()) +				->with_environment('production') +				->without_compiled_container() +				->get_container() +			; + +			$ext_container->register('cache.driver', '\\phpbb\\cache\\driver\\dummy'); +			$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'; -		$sql = 'SELECT * -			FROM ' . $extension_table . ' -			WHERE ext_active = 1'; +				if (!class_exists($extension_class)) +				{ +					$extension_class = '\\phpbb\\extension\\di\\extension_base'; +				} -		$result = $db->sql_query($sql); -		$rows = $db->sql_fetchrowset($result); -		$db->sql_freeresult($result); +				$this->container_extensions[] = new $extension_class($ext_name, $path); -		$exts = array(); -		foreach ($rows as $row) +				// Load extension autoloader +				$filename = $path . 'vendor/autoload.php'; +				if (file_exists($filename)) +				{ +					require $filename; +				} +			} +		} +		else  		{ -			$exts[$row['ext_name']] = $this->phpbb_root_path . 'ext/' . $row['ext_name'] . '/'; +			// 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. +	 * +	 * @param ConfigCache $cache The config cache +	 */ +	protected function dump_container($cache) +	{ +		try +		{ +			$dumper                = new PhpDumper($this->container); +			$cached_container_dump = $dumper->dump(array( +				'class'      => 'phpbb_cache_container', +				'base_class' => 'Symfony\\Component\\DependencyInjection\\ContainerBuilder', +			)); -		return $exts; +			$cache->write($cached_container_dump, $this->container->getResources()); +		} +		catch (IOException $e) +		{ +			// Don't fail if the cache isn't writeable +		}  	}  	/** -	* Create the ContainerBuilder object -	* -	* @param array $extensions Array of Container extension objects -	* @return ContainerBuilder object -	*/ +	 * Create the ContainerBuilder object +	 * +	 * @param array $extensions Array of Container extension objects +	 * @return ContainerBuilder object +	 */  	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->getCompilerPassConfig()->setMergePass(new MergeExtensionConfigurationPass($extensions_alias)); +  		return $container;  	}  	/** -	* Inject the customs parameters into the container -	*/ +	 * Inject the customs parameters into the container +	 */  	protected function inject_custom_parameters()  	{ -		if ($this->custom_parameters === null) +		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); +			}  		} +	} + +	/** +	 * Returns the core parameters. +	 * +	 * @return array An array of core parameters +	 */ +	protected function get_core_parameters() +	{ +		return array_merge( +			array( +				'core.root_path'     => $this->phpbb_root_path, +				'core.php_ext'       => $this->php_ext, +				'core.environment'   => $this->get_environment(), +				'core.debug'         => defined('DEBUG') ? DEBUG : false, +			), +			$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;  	}  	/** -	* Get the filename under which the dumped container will be stored. -	* -	* @return string Path for dumped container -	*/ +	 * Get the filename under which the dumped container will be stored. +	 * +	 * @return string Path for dumped container +	 */  	protected function get_container_filename()  	{ -		return $this->phpbb_root_path . 'cache/container_' . md5($this->phpbb_root_path) . '.' . $this->php_ext; +		return $this->get_cache_dir() . 'container_' . md5($this->phpbb_root_path) . '.' . $this->php_ext; +	} + +	/** +	 * Return the name of the current environment. +	 * +	 * @return string +	 */ +	protected function get_environment() +	{ +		return $this->environment ?: PHPBB_ENVIRONMENT; +	} + +	private function register_ext_compiler_pass() +	{ +		$finder = new Finder(); +		$finder +			->name('*_pass.php') +			->path('di/pass') +			->files() +			->ignoreDotFiles(true) +			->ignoreUnreadableDirs(true) +			->ignoreVCS(true) +			->followLinks() +			->in($this->phpbb_root_path . 'ext/') +		; + +		/** @var \SplFileInfo $pass */ +		foreach ($finder as $pass) +		{ +			$filename = $pass->getPathname(); +			$filename = substr($filename, 0, -strlen('.' . $pass->getExtension())); +			$filename = str_replace(DIRECTORY_SEPARATOR, '/', $filename); +			$className = preg_replace('#^.*ext/#', '', $filename); +			$className = '\\' . str_replace('/', '\\', $className); + +			if (class_exists($className) && in_array('Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface', class_implements($className), true)) +			{ +				$this->container->addCompilerPass(new $className()); +			} +		}  	}  } | 
