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