MergeExtensionConfigurationPass.php 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\DependencyInjection\Compiler;
  11. use Symfony\Component\DependencyInjection\ContainerBuilder;
  12. use Symfony\Component\DependencyInjection\Extension\ConfigurationExtensionInterface;
  13. use Symfony\Component\DependencyInjection\Extension\Extension;
  14. use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
  15. use Symfony\Component\DependencyInjection\ParameterBag\EnvPlaceholderParameterBag;
  16. /**
  17. * Merges extension configs into the container builder.
  18. *
  19. * @author Fabien Potencier <fabien@symfony.com>
  20. */
  21. class MergeExtensionConfigurationPass implements CompilerPassInterface
  22. {
  23. /**
  24. * {@inheritdoc}
  25. */
  26. public function process(ContainerBuilder $container)
  27. {
  28. $parameters = $container->getParameterBag()->all();
  29. $definitions = $container->getDefinitions();
  30. $aliases = $container->getAliases();
  31. $exprLangProviders = $container->getExpressionLanguageProviders();
  32. foreach ($container->getExtensions() as $extension) {
  33. if ($extension instanceof PrependExtensionInterface) {
  34. $extension->prepend($container);
  35. }
  36. }
  37. foreach ($container->getExtensions() as $name => $extension) {
  38. if (!$config = $container->getExtensionConfig($name)) {
  39. // this extension was not called
  40. continue;
  41. }
  42. $resolvingBag = $container->getParameterBag();
  43. if ($resolvingBag instanceof EnvPlaceholderParameterBag && $extension instanceof Extension) {
  44. // create a dedicated bag so that we can track env vars per-extension
  45. $resolvingBag = new MergeExtensionConfigurationParameterBag($resolvingBag);
  46. }
  47. $config = $resolvingBag->resolveValue($config);
  48. try {
  49. $tmpContainer = new ContainerBuilder($resolvingBag);
  50. $tmpContainer->setResourceTracking($container->isTrackingResources());
  51. $tmpContainer->addObjectResource($extension);
  52. if ($extension instanceof ConfigurationExtensionInterface && null !== $configuration = $extension->getConfiguration($config, $tmpContainer)) {
  53. $tmpContainer->addObjectResource($configuration);
  54. }
  55. foreach ($exprLangProviders as $provider) {
  56. $tmpContainer->addExpressionLanguageProvider($provider);
  57. }
  58. $extension->load($config, $tmpContainer);
  59. } catch (\Exception $e) {
  60. if ($resolvingBag instanceof MergeExtensionConfigurationParameterBag) {
  61. $container->getParameterBag()->mergeEnvPlaceholders($resolvingBag);
  62. }
  63. throw $e;
  64. }
  65. if ($resolvingBag instanceof MergeExtensionConfigurationParameterBag) {
  66. // don't keep track of env vars that are *overridden* when configs are merged
  67. $resolvingBag->freezeAfterProcessing($extension, $tmpContainer);
  68. }
  69. $container->merge($tmpContainer);
  70. $container->getParameterBag()->add($parameters);
  71. }
  72. $container->addDefinitions($definitions);
  73. $container->addAliases($aliases);
  74. }
  75. }
  76. /**
  77. * @internal
  78. */
  79. class MergeExtensionConfigurationParameterBag extends EnvPlaceholderParameterBag
  80. {
  81. private $processedEnvPlaceholders;
  82. public function __construct(parent $parameterBag)
  83. {
  84. parent::__construct($parameterBag->all());
  85. $this->mergeEnvPlaceholders($parameterBag);
  86. }
  87. public function freezeAfterProcessing(Extension $extension, ContainerBuilder $container)
  88. {
  89. if (!$config = $extension->getProcessedConfigs()) {
  90. // Extension::processConfiguration() wasn't called, we cannot know how configs were merged
  91. return;
  92. }
  93. $this->processedEnvPlaceholders = array();
  94. // serialize config and container to catch env vars nested in object graphs
  95. $config = serialize($config).serialize($container->getDefinitions()).serialize($container->getAliases()).serialize($container->getParameterBag()->all());
  96. foreach (parent::getEnvPlaceholders() as $env => $placeholders) {
  97. foreach ($placeholders as $placeholder) {
  98. if (false !== stripos($config, $placeholder)) {
  99. $this->processedEnvPlaceholders[$env] = $placeholders;
  100. break;
  101. }
  102. }
  103. }
  104. }
  105. /**
  106. * {@inheritdoc}
  107. */
  108. public function getEnvPlaceholders()
  109. {
  110. return null !== $this->processedEnvPlaceholders ? $this->processedEnvPlaceholders : parent::getEnvPlaceholders();
  111. }
  112. }