123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\DependencyInjection\Compiler;
- use Symfony\Component\Config\Definition\BaseNode;
- use Symfony\Component\DependencyInjection\ContainerBuilder;
- use Symfony\Component\DependencyInjection\Exception\LogicException;
- use Symfony\Component\DependencyInjection\Exception\RuntimeException;
- use Symfony\Component\DependencyInjection\Extension\ConfigurationExtensionInterface;
- use Symfony\Component\DependencyInjection\Extension\Extension;
- use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
- use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
- use Symfony\Component\DependencyInjection\ParameterBag\EnvPlaceholderParameterBag;
- use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
- /**
- * Merges extension configs into the container builder.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- */
- class MergeExtensionConfigurationPass implements CompilerPassInterface
- {
- /**
- * {@inheritdoc}
- */
- public function process(ContainerBuilder $container)
- {
- $parameters = $container->getParameterBag()->all();
- $definitions = $container->getDefinitions();
- $aliases = $container->getAliases();
- $exprLangProviders = $container->getExpressionLanguageProviders();
- $configAvailable = class_exists(BaseNode::class);
- foreach ($container->getExtensions() as $extension) {
- if ($extension instanceof PrependExtensionInterface) {
- $extension->prepend($container);
- }
- }
- foreach ($container->getExtensions() as $name => $extension) {
- if (!$config = $container->getExtensionConfig($name)) {
- // this extension was not called
- continue;
- }
- $resolvingBag = $container->getParameterBag();
- if ($resolvingBag instanceof EnvPlaceholderParameterBag && $extension instanceof Extension) {
- // create a dedicated bag so that we can track env vars per-extension
- $resolvingBag = new MergeExtensionConfigurationParameterBag($resolvingBag);
- if ($configAvailable) {
- BaseNode::setPlaceholderUniquePrefix($resolvingBag->getEnvPlaceholderUniquePrefix());
- }
- }
- $config = $resolvingBag->resolveValue($config);
- try {
- $tmpContainer = new MergeExtensionConfigurationContainerBuilder($extension, $resolvingBag);
- $tmpContainer->setResourceTracking($container->isTrackingResources());
- $tmpContainer->addObjectResource($extension);
- if ($extension instanceof ConfigurationExtensionInterface && null !== $configuration = $extension->getConfiguration($config, $tmpContainer)) {
- $tmpContainer->addObjectResource($configuration);
- }
- foreach ($exprLangProviders as $provider) {
- $tmpContainer->addExpressionLanguageProvider($provider);
- }
- $extension->load($config, $tmpContainer);
- } catch (\Exception $e) {
- if ($resolvingBag instanceof MergeExtensionConfigurationParameterBag) {
- $container->getParameterBag()->mergeEnvPlaceholders($resolvingBag);
- }
- if ($configAvailable) {
- BaseNode::resetPlaceholders();
- }
- throw $e;
- }
- if ($resolvingBag instanceof MergeExtensionConfigurationParameterBag) {
- // don't keep track of env vars that are *overridden* when configs are merged
- $resolvingBag->freezeAfterProcessing($extension, $tmpContainer);
- }
- $container->merge($tmpContainer);
- $container->getParameterBag()->add($parameters);
- }
- if ($configAvailable) {
- BaseNode::resetPlaceholders();
- }
- $container->addDefinitions($definitions);
- $container->addAliases($aliases);
- }
- }
- /**
- * @internal
- */
- class MergeExtensionConfigurationParameterBag extends EnvPlaceholderParameterBag
- {
- private $processedEnvPlaceholders;
- public function __construct(parent $parameterBag)
- {
- parent::__construct($parameterBag->all());
- $this->mergeEnvPlaceholders($parameterBag);
- }
- public function freezeAfterProcessing(Extension $extension, ContainerBuilder $container)
- {
- if (!$config = $extension->getProcessedConfigs()) {
- // Extension::processConfiguration() wasn't called, we cannot know how configs were merged
- return;
- }
- $this->processedEnvPlaceholders = [];
- // serialize config and container to catch env vars nested in object graphs
- $config = serialize($config).serialize($container->getDefinitions()).serialize($container->getAliases()).serialize($container->getParameterBag()->all());
- foreach (parent::getEnvPlaceholders() as $env => $placeholders) {
- foreach ($placeholders as $placeholder) {
- if (false !== stripos($config, $placeholder)) {
- $this->processedEnvPlaceholders[$env] = $placeholders;
- break;
- }
- }
- }
- }
- /**
- * {@inheritdoc}
- */
- public function getEnvPlaceholders(): array
- {
- return null !== $this->processedEnvPlaceholders ? $this->processedEnvPlaceholders : parent::getEnvPlaceholders();
- }
- public function getUnusedEnvPlaceholders(): array
- {
- return null === $this->processedEnvPlaceholders ? [] : array_diff_key(parent::getEnvPlaceholders(), $this->processedEnvPlaceholders);
- }
- }
- /**
- * A container builder preventing using methods that wouldn't have any effect from extensions.
- *
- * @internal
- */
- class MergeExtensionConfigurationContainerBuilder extends ContainerBuilder
- {
- private $extensionClass;
- public function __construct(ExtensionInterface $extension, ParameterBagInterface $parameterBag = null)
- {
- parent::__construct($parameterBag);
- $this->extensionClass = \get_class($extension);
- }
- /**
- * {@inheritdoc}
- */
- public function addCompilerPass(CompilerPassInterface $pass, string $type = PassConfig::TYPE_BEFORE_OPTIMIZATION, int $priority = 0): self
- {
- throw new LogicException(sprintf('You cannot add compiler pass "%s" from extension "%s". Compiler passes must be registered before the container is compiled.', get_debug_type($pass), $this->extensionClass));
- }
- /**
- * {@inheritdoc}
- */
- public function registerExtension(ExtensionInterface $extension)
- {
- throw new LogicException(sprintf('You cannot register extension "%s" from "%s". Extensions must be registered before the container is compiled.', get_debug_type($extension), $this->extensionClass));
- }
- /**
- * {@inheritdoc}
- */
- public function compile(bool $resolveEnvPlaceholders = false)
- {
- throw new LogicException(sprintf('Cannot compile the container in extension "%s".', $this->extensionClass));
- }
- /**
- * {@inheritdoc}
- */
- public function resolveEnvPlaceholders($value, $format = null, array &$usedEnvs = null)
- {
- if (true !== $format || !\is_string($value)) {
- return parent::resolveEnvPlaceholders($value, $format, $usedEnvs);
- }
- $bag = $this->getParameterBag();
- $value = $bag->resolveValue($value);
- if (!$bag instanceof EnvPlaceholderParameterBag) {
- return parent::resolveEnvPlaceholders($value, $format, $usedEnvs);
- }
- foreach ($bag->getEnvPlaceholders() as $env => $placeholders) {
- if (false === strpos($env, ':')) {
- continue;
- }
- foreach ($placeholders as $placeholder) {
- if (false !== stripos($value, $placeholder)) {
- throw new RuntimeException(sprintf('Using a cast in "env(%s)" is incompatible with resolution at compile time in "%s". The logic in the extension should be moved to a compiler pass, or an env parameter with no cast should be used instead.', $env, $this->extensionClass));
- }
- }
- }
- return parent::resolveEnvPlaceholders($value, $format, $usedEnvs);
- }
- }
|