vendor/symfony/framework-bundle/DependencyInjection/FrameworkExtension.php line 1134

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Symfony\Bundle\FrameworkBundle\DependencyInjection;
  14. use Composer\InstalledVersions;
  15. use Doctrine\Common\Annotations\AnnotationRegistry;
  16. use Doctrine\Common\Annotations\Reader;
  17. use Http\Client\HttpClient;
  18. use phpDocumentor\Reflection\DocBlockFactoryInterface;
  19. use phpDocumentor\Reflection\Types\ContextFactory;
  20. use PHPStan\PhpDocParser\Parser\PhpDocParser;
  21. use Psr\Cache\CacheItemPoolInterface;
  22. use Psr\Container\ContainerInterface as PsrContainerInterface;
  23. use Psr\EventDispatcher\EventDispatcherInterface as PsrEventDispatcherInterface;
  24. use Psr\Http\Client\ClientInterface;
  25. use Psr\Log\LoggerAwareInterface;
  26. use Symfony\Bridge\Monolog\Processor\DebugProcessor;
  27. use Symfony\Bridge\Twig\Extension\CsrfExtension;
  28. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  29. use Symfony\Bundle\FrameworkBundle\Routing\AnnotatedRouteControllerLoader;
  30. use Symfony\Bundle\FrameworkBundle\Routing\RouteLoaderInterface;
  31. use Symfony\Bundle\FullStack;
  32. use Symfony\Bundle\MercureBundle\MercureBundle;
  33. use Symfony\Component\Asset\PackageInterface;
  34. use Symfony\Component\BrowserKit\AbstractBrowser;
  35. use Symfony\Component\Cache\Adapter\AdapterInterface;
  36. use Symfony\Component\Cache\Adapter\ArrayAdapter;
  37. use Symfony\Component\Cache\Adapter\ChainAdapter;
  38. use Symfony\Component\Cache\Adapter\DoctrineAdapter;
  39. use Symfony\Component\Cache\Adapter\DoctrineDbalAdapter;
  40. use Symfony\Component\Cache\Adapter\TagAwareAdapter;
  41. use Symfony\Component\Cache\DependencyInjection\CachePoolPass;
  42. use Symfony\Component\Cache\Marshaller\DefaultMarshaller;
  43. use Symfony\Component\Cache\Marshaller\MarshallerInterface;
  44. use Symfony\Component\Cache\ResettableInterface;
  45. use Symfony\Component\Config\FileLocator;
  46. use Symfony\Component\Config\Loader\LoaderInterface;
  47. use Symfony\Component\Config\Resource\DirectoryResource;
  48. use Symfony\Component\Config\ResourceCheckerInterface;
  49. use Symfony\Component\Console\Application;
  50. use Symfony\Component\Console\Command\Command;
  51. use Symfony\Component\DependencyInjection\Alias;
  52. use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
  53. use Symfony\Component\DependencyInjection\ChildDefinition;
  54. use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
  55. use Symfony\Component\DependencyInjection\ContainerBuilder;
  56. use Symfony\Component\DependencyInjection\ContainerInterface;
  57. use Symfony\Component\DependencyInjection\Definition;
  58. use Symfony\Component\DependencyInjection\EnvVarLoaderInterface;
  59. use Symfony\Component\DependencyInjection\EnvVarProcessorInterface;
  60. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  61. use Symfony\Component\DependencyInjection\Exception\LogicException;
  62. use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
  63. use Symfony\Component\DependencyInjection\Parameter;
  64. use Symfony\Component\DependencyInjection\Reference;
  65. use Symfony\Component\DependencyInjection\ServiceLocator;
  66. use Symfony\Component\Dotenv\Command\DebugCommand;
  67. use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
  68. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  69. use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
  70. use Symfony\Component\Finder\Finder;
  71. use Symfony\Component\Form\ChoiceList\Factory\CachingFactoryDecorator;
  72. use Symfony\Component\Form\Form;
  73. use Symfony\Component\Form\FormTypeExtensionInterface;
  74. use Symfony\Component\Form\FormTypeGuesserInterface;
  75. use Symfony\Component\Form\FormTypeInterface;
  76. use Symfony\Component\HttpClient\MockHttpClient;
  77. use Symfony\Component\HttpClient\Retry\GenericRetryStrategy;
  78. use Symfony\Component\HttpClient\RetryableHttpClient;
  79. use Symfony\Component\HttpClient\ScopingHttpClient;
  80. use Symfony\Component\HttpFoundation\Request;
  81. use Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface;
  82. use Symfony\Component\HttpKernel\Attribute\AsController;
  83. use Symfony\Component\HttpKernel\CacheClearer\CacheClearerInterface;
  84. use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
  85. use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
  86. use Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface;
  87. use Symfony\Component\HttpKernel\DependencyInjection\Extension;
  88. use Symfony\Component\Lock\Lock;
  89. use Symfony\Component\Lock\LockFactory;
  90. use Symfony\Component\Lock\LockInterface;
  91. use Symfony\Component\Lock\PersistingStoreInterface;
  92. use Symfony\Component\Lock\Store\StoreFactory;
  93. use Symfony\Component\Lock\StoreInterface;
  94. use Symfony\Component\Mailer\Bridge\Amazon\Transport\SesTransportFactory;
  95. use Symfony\Component\Mailer\Bridge\Google\Transport\GmailTransportFactory;
  96. use Symfony\Component\Mailer\Bridge\Mailchimp\Transport\MandrillTransportFactory;
  97. use Symfony\Component\Mailer\Bridge\Mailgun\Transport\MailgunTransportFactory;
  98. use Symfony\Component\Mailer\Bridge\Mailjet\Transport\MailjetTransportFactory;
  99. use Symfony\Component\Mailer\Bridge\OhMySmtp\Transport\OhMySmtpTransportFactory;
  100. use Symfony\Component\Mailer\Bridge\Postmark\Transport\PostmarkTransportFactory;
  101. use Symfony\Component\Mailer\Bridge\Sendgrid\Transport\SendgridTransportFactory;
  102. use Symfony\Component\Mailer\Bridge\Sendinblue\Transport\SendinblueTransportFactory;
  103. use Symfony\Component\Mailer\Mailer;
  104. use Symfony\Component\Mercure\HubRegistry;
  105. use Symfony\Component\Messenger\Attribute\AsMessageHandler;
  106. use Symfony\Component\Messenger\Bridge\AmazonSqs\Transport\AmazonSqsTransportFactory;
  107. use Symfony\Component\Messenger\Bridge\Amqp\Transport\AmqpTransportFactory;
  108. use Symfony\Component\Messenger\Bridge\Beanstalkd\Transport\BeanstalkdTransportFactory;
  109. use Symfony\Component\Messenger\Bridge\Redis\Transport\RedisTransportFactory;
  110. use Symfony\Component\Messenger\Handler\BatchHandlerInterface;
  111. use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
  112. use Symfony\Component\Messenger\MessageBus;
  113. use Symfony\Component\Messenger\MessageBusInterface;
  114. use Symfony\Component\Messenger\Middleware\RouterContextMiddleware;
  115. use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;
  116. use Symfony\Component\Messenger\Transport\TransportFactoryInterface;
  117. use Symfony\Component\Messenger\Transport\TransportInterface;
  118. use Symfony\Component\Mime\Header\Headers;
  119. use Symfony\Component\Mime\MimeTypeGuesserInterface;
  120. use Symfony\Component\Mime\MimeTypes;
  121. use Symfony\Component\Notifier\Bridge\AllMySms\AllMySmsTransportFactory;
  122. use Symfony\Component\Notifier\Bridge\AmazonSns\AmazonSnsTransportFactory;
  123. use Symfony\Component\Notifier\Bridge\Clickatell\ClickatellTransportFactory;
  124. use Symfony\Component\Notifier\Bridge\Discord\DiscordTransportFactory;
  125. use Symfony\Component\Notifier\Bridge\Esendex\EsendexTransportFactory;
  126. use Symfony\Component\Notifier\Bridge\Expo\ExpoTransportFactory;
  127. use Symfony\Component\Notifier\Bridge\FakeChat\FakeChatTransportFactory;
  128. use Symfony\Component\Notifier\Bridge\FakeSms\FakeSmsTransportFactory;
  129. use Symfony\Component\Notifier\Bridge\Firebase\FirebaseTransportFactory;
  130. use Symfony\Component\Notifier\Bridge\FreeMobile\FreeMobileTransportFactory;
  131. use Symfony\Component\Notifier\Bridge\GatewayApi\GatewayApiTransportFactory;
  132. use Symfony\Component\Notifier\Bridge\Gitter\GitterTransportFactory;
  133. use Symfony\Component\Notifier\Bridge\GoogleChat\GoogleChatTransportFactory;
  134. use Symfony\Component\Notifier\Bridge\Infobip\InfobipTransportFactory;
  135. use Symfony\Component\Notifier\Bridge\Iqsms\IqsmsTransportFactory;
  136. use Symfony\Component\Notifier\Bridge\LightSms\LightSmsTransportFactory;
  137. use Symfony\Component\Notifier\Bridge\LinkedIn\LinkedInTransportFactory;
  138. use Symfony\Component\Notifier\Bridge\Mailjet\MailjetTransportFactory as MailjetNotifierTransportFactory;
  139. use Symfony\Component\Notifier\Bridge\Mattermost\MattermostTransportFactory;
  140. use Symfony\Component\Notifier\Bridge\Mercure\MercureTransportFactory;
  141. use Symfony\Component\Notifier\Bridge\MessageBird\MessageBirdTransport;
  142. use Symfony\Component\Notifier\Bridge\MessageMedia\MessageMediaTransportFactory;
  143. use Symfony\Component\Notifier\Bridge\MicrosoftTeams\MicrosoftTeamsTransportFactory;
  144. use Symfony\Component\Notifier\Bridge\Mobyt\MobytTransportFactory;
  145. use Symfony\Component\Notifier\Bridge\Nexmo\NexmoTransportFactory;
  146. use Symfony\Component\Notifier\Bridge\Octopush\OctopushTransportFactory;
  147. use Symfony\Component\Notifier\Bridge\OneSignal\OneSignalTransportFactory;
  148. use Symfony\Component\Notifier\Bridge\OvhCloud\OvhCloudTransportFactory;
  149. use Symfony\Component\Notifier\Bridge\RocketChat\RocketChatTransportFactory;
  150. use Symfony\Component\Notifier\Bridge\Sendinblue\SendinblueTransportFactory as SendinblueNotifierTransportFactory;
  151. use Symfony\Component\Notifier\Bridge\Sinch\SinchTransportFactory;
  152. use Symfony\Component\Notifier\Bridge\Slack\SlackTransportFactory;
  153. use Symfony\Component\Notifier\Bridge\Sms77\Sms77TransportFactory;
  154. use Symfony\Component\Notifier\Bridge\Smsapi\SmsapiTransportFactory;
  155. use Symfony\Component\Notifier\Bridge\SmsBiuras\SmsBiurasTransportFactory;
  156. use Symfony\Component\Notifier\Bridge\Smsc\SmscTransportFactory;
  157. use Symfony\Component\Notifier\Bridge\SpotHit\SpotHitTransportFactory;
  158. use Symfony\Component\Notifier\Bridge\Telegram\TelegramTransportFactory;
  159. use Symfony\Component\Notifier\Bridge\Telnyx\TelnyxTransportFactory;
  160. use Symfony\Component\Notifier\Bridge\TurboSms\TurboSmsTransport;
  161. use Symfony\Component\Notifier\Bridge\Twilio\TwilioTransportFactory;
  162. use Symfony\Component\Notifier\Bridge\Vonage\VonageTransportFactory;
  163. use Symfony\Component\Notifier\Bridge\Yunpian\YunpianTransportFactory;
  164. use Symfony\Component\Notifier\Bridge\Zulip\ZulipTransportFactory;
  165. use Symfony\Component\Notifier\Notifier;
  166. use Symfony\Component\Notifier\Recipient\Recipient;
  167. use Symfony\Component\Notifier\Transport\TransportFactoryInterface as NotifierTransportFactoryInterface;
  168. use Symfony\Component\PropertyAccess\PropertyAccessor;
  169. use Symfony\Component\PropertyInfo\Extractor\PhpStanExtractor;
  170. use Symfony\Component\PropertyInfo\PropertyAccessExtractorInterface;
  171. use Symfony\Component\PropertyInfo\PropertyDescriptionExtractorInterface;
  172. use Symfony\Component\PropertyInfo\PropertyInfoExtractorInterface;
  173. use Symfony\Component\PropertyInfo\PropertyInitializableExtractorInterface;
  174. use Symfony\Component\PropertyInfo\PropertyListExtractorInterface;
  175. use Symfony\Component\PropertyInfo\PropertyReadInfoExtractorInterface;
  176. use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
  177. use Symfony\Component\PropertyInfo\PropertyWriteInfoExtractorInterface;
  178. use Symfony\Component\RateLimiter\LimiterInterface;
  179. use Symfony\Component\RateLimiter\RateLimiterFactory;
  180. use Symfony\Component\RateLimiter\Storage\CacheStorage;
  181. use Symfony\Component\Routing\Loader\AnnotationDirectoryLoader;
  182. use Symfony\Component\Routing\Loader\AnnotationFileLoader;
  183. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  184. use Symfony\Component\Security\Core\Security;
  185. use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
  186. use Symfony\Component\Serializer\Encoder\DecoderInterface;
  187. use Symfony\Component\Serializer\Encoder\EncoderInterface;
  188. use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
  189. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  190. use Symfony\Component\Serializer\Normalizer\UnwrappingDenormalizer;
  191. use Symfony\Component\Stopwatch\Stopwatch;
  192. use Symfony\Component\String\LazyString;
  193. use Symfony\Component\String\Slugger\SluggerInterface;
  194. use Symfony\Component\Translation\Bridge\Crowdin\CrowdinProviderFactory;
  195. use Symfony\Component\Translation\Bridge\Loco\LocoProviderFactory;
  196. use Symfony\Component\Translation\Bridge\Lokalise\LokaliseProviderFactory;
  197. use Symfony\Component\Translation\Command\XliffLintCommand as BaseXliffLintCommand;
  198. use Symfony\Component\Translation\PseudoLocalizationTranslator;
  199. use Symfony\Component\Translation\Translator;
  200. use Symfony\Component\Uid\Factory\UuidFactory;
  201. use Symfony\Component\Uid\UuidV4;
  202. use Symfony\Component\Validator\ConstraintValidatorInterface;
  203. use Symfony\Component\Validator\Mapping\Loader\PropertyInfoLoader;
  204. use Symfony\Component\Validator\ObjectInitializerInterface;
  205. use Symfony\Component\Validator\Validation;
  206. use Symfony\Component\WebLink\HttpHeaderSerializer;
  207. use Symfony\Component\Workflow;
  208. use Symfony\Component\Workflow\WorkflowInterface;
  209. use Symfony\Component\Yaml\Command\LintCommand as BaseYamlLintCommand;
  210. use Symfony\Component\Yaml\Yaml;
  211. use Symfony\Contracts\Cache\CacheInterface;
  212. use Symfony\Contracts\Cache\CallbackInterface;
  213. use Symfony\Contracts\Cache\TagAwareCacheInterface;
  214. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  215. use Symfony\Contracts\HttpClient\HttpClientInterface;
  216. use Symfony\Contracts\Service\ResetInterface;
  217. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  218. use Symfony\Contracts\Translation\LocaleAwareInterface;
  220. /**
  221. * Process the configuration and prepare the dependency injection container with
  222. * parameters and services.
  223. */
  224. class FrameworkExtension extends Extension
  225. {
  226. private $formConfigEnabled = false;
  227. private $translationConfigEnabled = false;
  228. private $sessionConfigEnabled = false;
  229. private $annotationsConfigEnabled = false;
  230. private $validatorConfigEnabled = false;
  231. private $messengerConfigEnabled = false;
  232. private $mailerConfigEnabled = false;
  233. private $httpClientConfigEnabled = false;
  234. private $notifierConfigEnabled = false;
  235. private $propertyAccessConfigEnabled = false;
  236. private static $lockConfigEnabled = false;
  238. /**
  239. * Responds to the app.config configuration parameter.
  240. *
  241. * @throws LogicException
  242. */
  243. public function load(array $configs, ContainerBuilder $container)
  244. {
  245. if (!class_exists(InstalledVersions::class)) {
  246. trigger_deprecation('symfony/framework-bundle', '5.4', 'Configuring Symfony without the Composer Runtime API is deprecated. Consider upgrading to Composer 2.1 or later.');
  247. }
  249. $loader = new PhpFileLoader($container, new FileLocator(\dirname(__DIR__).'/Resources/config'));
  251. $loader->load('web.php');
  252. $loader->load('services.php');
  253. $loader->load('fragment_renderer.php');
  254. $loader->load('error_renderer.php');
  256. if (ContainerBuilder::willBeAvailable('psr/event-dispatcher', PsrEventDispatcherInterface::class, ['symfony/framework-bundle'], true)) {
  257. $container->setAlias(PsrEventDispatcherInterface::class, 'event_dispatcher');
  258. }
  260. $container->registerAliasForArgument('parameter_bag', PsrContainerInterface::class);
  262. if ($this->hasConsole()) {
  263. $loader->load('console.php');
  265. if (!class_exists(BaseXliffLintCommand::class)) {
  266. $container->removeDefinition('console.command.xliff_lint');
  267. }
  268. if (!class_exists(BaseYamlLintCommand::class)) {
  269. $container->removeDefinition('console.command.yaml_lint');
  270. }
  272. if (!class_exists(DebugCommand::class)) {
  273. $container->removeDefinition('console.command.dotenv_debug');
  274. }
  275. }
  277. // Load Cache configuration first as it is used by other components
  278. $loader->load('cache.php');
  280. $configuration = $this->getConfiguration($configs, $container);
  281. $config = $this->processConfiguration($configuration, $configs);
  283. $this->annotationsConfigEnabled = $this->isConfigEnabled($container, $config['annotations']);
  284. $this->translationConfigEnabled = $this->isConfigEnabled($container, $config['translator']);
  286. // A translator must always be registered (as support is included by
  287. // default in the Form and Validator component). If disabled, an identity
  288. // translator will be used and everything will still work as expected.
  289. if ($this->isConfigEnabled($container, $config['translator']) || $this->isConfigEnabled($container, $config['form']) || $this->isConfigEnabled($container, $config['validation'])) {
  290. if (!class_exists(Translator::class) && $this->isConfigEnabled($container, $config['translator'])) {
  291. throw new LogicException('Translation support cannot be enabled as the Translation component is not installed. Try running "composer require symfony/translation".');
  292. }
  294. if (class_exists(Translator::class)) {
  295. $loader->load('identity_translator.php');
  296. }
  297. }
  299. $container->getDefinition('locale_listener')->replaceArgument(3, $config['set_locale_from_accept_language']);
  300. $container->getDefinition('response_listener')->replaceArgument(1, $config['set_content_language_from_locale']);
  302. // If the slugger is used but the String component is not available, we should throw an error
  303. if (!ContainerBuilder::willBeAvailable('symfony/string', SluggerInterface::class, ['symfony/framework-bundle'], true)) {
  304. $container->register('slugger', 'stdClass')
  305. ->addError('You cannot use the "slugger" service since the String component is not installed. Try running "composer require symfony/string".');
  306. } else {
  307. if (!ContainerBuilder::willBeAvailable('symfony/translation', LocaleAwareInterface::class, ['symfony/framework-bundle'], true)) {
  308. $container->register('slugger', 'stdClass')
  309. ->addError('You cannot use the "slugger" service since the Translation contracts are not installed. Try running "composer require symfony/translation".');
  310. }
  312. if (!\extension_loaded('intl') && !\defined('PHPUNIT_COMPOSER_INSTALL')) {
  313. trigger_deprecation('', '', 'Please install the "intl" PHP extension for best performance.');
  314. }
  315. }
  317. if (isset($config['secret'])) {
  318. $container->setParameter('kernel.secret', $config['secret']);
  319. }
  321. $container->setParameter('kernel.http_method_override', $config['http_method_override']);
  322. $container->setParameter('kernel.trusted_hosts', $config['trusted_hosts']);
  323. $container->setParameter('kernel.default_locale', $config['default_locale']);
  324. $container->setParameter('kernel.enabled_locales', $config['enabled_locales']);
  325. $container->setParameter('kernel.error_controller', $config['error_controller']);
  327. if (($config['trusted_proxies'] ?? false) && ($config['trusted_headers'] ?? false)) {
  328. $container->setParameter('kernel.trusted_proxies', $config['trusted_proxies']);
  329. $container->setParameter('kernel.trusted_headers', $this->resolveTrustedHeaders($config['trusted_headers']));
  330. }
  332. if (!$container->hasParameter('debug.file_link_format')) {
  333. $container->setParameter('debug.file_link_format', $config['ide']);
  334. }
  336. if (!empty($config['test'])) {
  337. $loader->load('test.php');
  339. if (!class_exists(AbstractBrowser::class)) {
  340. $container->removeDefinition('test.client');
  341. }
  342. }
  344. if ($this->isConfigEnabled($container, $config['request'])) {
  345. $this->registerRequestConfiguration($config['request'], $container, $loader);
  346. }
  348. if ($this->isConfigEnabled($container, $config['assets'])) {
  349. if (!class_exists(\Symfony\Component\Asset\Package::class)) {
  350. throw new LogicException('Asset support cannot be enabled as the Asset component is not installed. Try running "composer require symfony/asset".');
  351. }
  353. $this->registerAssetsConfiguration($config['assets'], $container, $loader);
  354. }
  356. if ($this->httpClientConfigEnabled = $this->isConfigEnabled($container, $config['http_client'])) {
  357. $this->registerHttpClientConfiguration($config['http_client'], $container, $loader, $config['profiler']);
  358. }
  360. if ($this->mailerConfigEnabled = $this->isConfigEnabled($container, $config['mailer'])) {
  361. $this->registerMailerConfiguration($config['mailer'], $container, $loader);
  362. }
  364. $propertyInfoEnabled = $this->isConfigEnabled($container, $config['property_info']);
  365. $this->registerHttpCacheConfiguration($config['http_cache'], $container, $config['http_method_override']);
  366. $this->registerEsiConfiguration($config['esi'], $container, $loader);
  367. $this->registerSsiConfiguration($config['ssi'], $container, $loader);
  368. $this->registerFragmentsConfiguration($config['fragments'], $container, $loader);
  369. $this->registerTranslatorConfiguration($config['translator'], $container, $loader, $config['default_locale'], $config['enabled_locales']);
  370. $this->registerWorkflowConfiguration($config['workflows'], $container, $loader);
  371. $this->registerDebugConfiguration($config['php_errors'], $container, $loader);
  372. // @deprecated since Symfony 5.4, in 6.0 change to:
  373. // $this->registerRouterConfiguration($config['router'], $container, $loader, $config['enabled_locales']);
  374. $this->registerRouterConfiguration($config['router'], $container, $loader, $config['translator']['enabled_locales'] ?: $config['enabled_locales']);
  375. $this->registerAnnotationsConfiguration($config['annotations'], $container, $loader);
  376. $this->registerPropertyAccessConfiguration($config['property_access'], $container, $loader);
  377. $this->registerSecretsConfiguration($config['secrets'], $container, $loader);
  379. $container->getDefinition('exception_listener')->replaceArgument(3, $config['exceptions']);
  381. if ($this->isConfigEnabled($container, $config['serializer'])) {
  382. if (!class_exists(\Symfony\Component\Serializer\Serializer::class)) {
  383. throw new LogicException('Serializer support cannot be enabled as the Serializer component is not installed. Try running "composer require symfony/serializer-pack".');
  384. }
  386. $this->registerSerializerConfiguration($config['serializer'], $container, $loader);
  387. }
  389. if ($propertyInfoEnabled) {
  390. $this->registerPropertyInfoConfiguration($container, $loader);
  391. }
  393. if (self::$lockConfigEnabled = $this->isConfigEnabled($container, $config['lock'])) {
  394. $this->registerLockConfiguration($config['lock'], $container, $loader);
  395. }
  397. if ($this->isConfigEnabled($container, $config['rate_limiter'])) {
  398. if (!interface_exists(LimiterInterface::class)) {
  399. throw new LogicException('Rate limiter support cannot be enabled as the RateLimiter component is not installed. Try running "composer require symfony/rate-limiter".');
  400. }
  402. $this->registerRateLimiterConfiguration($config['rate_limiter'], $container, $loader);
  403. }
  405. if ($this->isConfigEnabled($container, $config['web_link'])) {
  406. if (!class_exists(HttpHeaderSerializer::class)) {
  407. throw new LogicException('WebLink support cannot be enabled as the WebLink component is not installed. Try running "composer require symfony/weblink".');
  408. }
  410. $loader->load('web_link.php');
  411. }
  413. if ($this->isConfigEnabled($container, $config['uid'])) {
  414. if (!class_exists(UuidFactory::class)) {
  415. throw new LogicException('Uid support cannot be enabled as the Uid component is not installed. Try running "composer require symfony/uid".');
  416. }
  418. $this->registerUidConfiguration($config['uid'], $container, $loader);
  419. }
  421. // register cache before session so both can share the connection services
  422. $this->registerCacheConfiguration($config['cache'], $container);
  424. if ($this->isConfigEnabled($container, $config['session'])) {
  425. if (!\extension_loaded('session')) {
  426. throw new LogicException('Session support cannot be enabled as the session extension is not installed. See https://php.net/session.installation for instructions.');
  427. }
  429. $this->sessionConfigEnabled = true;
  430. $this->registerSessionConfiguration($config['session'], $container, $loader);
  431. if (!empty($config['test'])) {
  432. // test listener will replace the existing session listener
  433. // as we are aliasing to avoid duplicated registered events
  434. $container->setAlias('session_listener', 'test.session.listener');
  435. }
  436. } elseif (!empty($config['test'])) {
  437. $container->removeDefinition('test.session.listener');
  438. }
  440. // csrf depends on session being registered
  441. if (null === $config['csrf_protection']['enabled']) {
  442. $config['csrf_protection']['enabled'] = $this->sessionConfigEnabled && !class_exists(FullStack::class) && ContainerBuilder::willBeAvailable('symfony/security-csrf', CsrfTokenManagerInterface::class, ['symfony/framework-bundle'], true);
  443. }
  444. $this->registerSecurityCsrfConfiguration($config['csrf_protection'], $container, $loader);
  446. // form depends on csrf being registered
  447. if ($this->isConfigEnabled($container, $config['form'])) {
  448. if (!class_exists(Form::class)) {
  449. throw new LogicException('Form support cannot be enabled as the Form component is not installed. Try running "composer require symfony/form".');
  450. }
  452. $this->formConfigEnabled = true;
  453. $this->registerFormConfiguration($config, $container, $loader);
  455. if (ContainerBuilder::willBeAvailable('symfony/validator', Validation::class, ['symfony/framework-bundle', 'symfony/form'], true)) {
  456. $config['validation']['enabled'] = true;
  457. } else {
  458. $container->setParameter('validator.translation_domain', 'validators');
  460. $container->removeDefinition('form.type_extension.form.validator');
  461. $container->removeDefinition('form.type_guesser.validator');
  462. }
  463. } else {
  464. $container->removeDefinition('console.command.form_debug');
  465. }
  467. // validation depends on form, annotations being registered
  468. $this->registerValidationConfiguration($config['validation'], $container, $loader, $propertyInfoEnabled);
  470. // messenger depends on validation being registered
  471. if ($this->messengerConfigEnabled = $this->isConfigEnabled($container, $config['messenger'])) {
  472. $this->registerMessengerConfiguration($config['messenger'], $container, $loader, $config['validation']);
  473. } else {
  474. $container->removeDefinition('console.command.messenger_consume_messages');
  475. $container->removeDefinition('console.command.messenger_debug');
  476. $container->removeDefinition('console.command.messenger_stop_workers');
  477. $container->removeDefinition('console.command.messenger_setup_transports');
  478. $container->removeDefinition('console.command.messenger_failed_messages_retry');
  479. $container->removeDefinition('console.command.messenger_failed_messages_show');
  480. $container->removeDefinition('console.command.messenger_failed_messages_remove');
  481. $container->removeDefinition('cache.messenger.restart_workers_signal');
  483. if ($container->hasDefinition('messenger.transport.amqp.factory') && !class_exists(AmqpTransportFactory::class)) {
  484. if (class_exists(\Symfony\Component\Messenger\Transport\AmqpExt\AmqpTransportFactory::class)) {
  485. $container->getDefinition('messenger.transport.amqp.factory')
  486. ->setClass(\Symfony\Component\Messenger\Transport\AmqpExt\AmqpTransportFactory::class)
  487. ->addTag('messenger.transport_factory');
  488. } else {
  489. $container->removeDefinition('messenger.transport.amqp.factory');
  490. }
  491. }
  493. if ($container->hasDefinition('messenger.transport.redis.factory') && !class_exists(RedisTransportFactory::class)) {
  494. if (class_exists(\Symfony\Component\Messenger\Transport\RedisExt\RedisTransportFactory::class)) {
  495. $container->getDefinition('messenger.transport.redis.factory')
  496. ->setClass(\Symfony\Component\Messenger\Transport\RedisExt\RedisTransportFactory::class)
  497. ->addTag('messenger.transport_factory');
  498. } else {
  499. $container->removeDefinition('messenger.transport.redis.factory');
  500. }
  501. }
  502. }
  504. // notifier depends on messenger, mailer being registered
  505. if ($this->notifierConfigEnabled = $this->isConfigEnabled($container, $config['notifier'])) {
  506. $this->registerNotifierConfiguration($config['notifier'], $container, $loader);
  507. }
  509. // profiler depends on form, validation, translation, messenger, mailer, http-client, notifier being registered
  510. $this->registerProfilerConfiguration($config['profiler'], $container, $loader);
  512. $this->addAnnotatedClassesToCompile([
  513. '**\\Controller\\',
  514. '**\\Entity\\',
  516. // Added explicitly so that we don't rely on the class map being dumped to make it work
  517. 'Symfony\\Bundle\\FrameworkBundle\\Controller\\AbstractController',
  518. ]);
  520. if (ContainerBuilder::willBeAvailable('symfony/mime', MimeTypes::class, ['symfony/framework-bundle'], true)) {
  521. $loader->load('mime_type.php');
  522. }
  524. $container->registerForAutoconfiguration(PackageInterface::class)
  525. ->addTag('assets.package');
  526. $container->registerForAutoconfiguration(Command::class)
  527. ->addTag('console.command');
  528. $container->registerForAutoconfiguration(ResourceCheckerInterface::class)
  529. ->addTag('config_cache.resource_checker');
  530. $container->registerForAutoconfiguration(EnvVarLoaderInterface::class)
  531. ->addTag('container.env_var_loader');
  532. $container->registerForAutoconfiguration(EnvVarProcessorInterface::class)
  533. ->addTag('container.env_var_processor');
  534. $container->registerForAutoconfiguration(CallbackInterface::class)
  535. ->addTag('container.reversible');
  536. $container->registerForAutoconfiguration(ServiceLocator::class)
  537. ->addTag('container.service_locator');
  538. $container->registerForAutoconfiguration(ServiceSubscriberInterface::class)
  539. ->addTag('container.service_subscriber');
  540. $container->registerForAutoconfiguration(ArgumentValueResolverInterface::class)
  541. ->addTag('controller.argument_value_resolver');
  542. $container->registerForAutoconfiguration(AbstractController::class)
  543. ->addTag('controller.service_arguments');
  544. $container->registerForAutoconfiguration(DataCollectorInterface::class)
  545. ->addTag('data_collector');
  546. $container->registerForAutoconfiguration(FormTypeInterface::class)
  547. ->addTag('form.type');
  548. $container->registerForAutoconfiguration(FormTypeGuesserInterface::class)
  549. ->addTag('form.type_guesser');
  550. $container->registerForAutoconfiguration(FormTypeExtensionInterface::class)
  551. ->addTag('form.type_extension');
  552. $container->registerForAutoconfiguration(CacheClearerInterface::class)
  553. ->addTag('kernel.cache_clearer');
  554. $container->registerForAutoconfiguration(CacheWarmerInterface::class)
  555. ->addTag('kernel.cache_warmer');
  556. $container->registerForAutoconfiguration(EventDispatcherInterface::class)
  557. ->addTag('event_dispatcher.dispatcher');
  558. $container->registerForAutoconfiguration(EventSubscriberInterface::class)
  559. ->addTag('kernel.event_subscriber');
  560. $container->registerForAutoconfiguration(LocaleAwareInterface::class)
  561. ->addTag('kernel.locale_aware');
  562. $container->registerForAutoconfiguration(ResetInterface::class)
  563. ->addTag('kernel.reset', ['method' => 'reset']);
  565. if (!interface_exists(MarshallerInterface::class)) {
  566. $container->registerForAutoconfiguration(ResettableInterface::class)
  567. ->addTag('kernel.reset', ['method' => 'reset']);
  568. }
  570. $container->registerForAutoconfiguration(PropertyListExtractorInterface::class)
  571. ->addTag('property_info.list_extractor');
  572. $container->registerForAutoconfiguration(PropertyTypeExtractorInterface::class)
  573. ->addTag('property_info.type_extractor');
  574. $container->registerForAutoconfiguration(PropertyDescriptionExtractorInterface::class)
  575. ->addTag('property_info.description_extractor');
  576. $container->registerForAutoconfiguration(PropertyAccessExtractorInterface::class)
  577. ->addTag('property_info.access_extractor');
  578. $container->registerForAutoconfiguration(PropertyInitializableExtractorInterface::class)
  579. ->addTag('property_info.initializable_extractor');
  580. $container->registerForAutoconfiguration(EncoderInterface::class)
  581. ->addTag('serializer.encoder');
  582. $container->registerForAutoconfiguration(DecoderInterface::class)
  583. ->addTag('serializer.encoder');
  584. $container->registerForAutoconfiguration(NormalizerInterface::class)
  585. ->addTag('serializer.normalizer');
  586. $container->registerForAutoconfiguration(DenormalizerInterface::class)
  587. ->addTag('serializer.normalizer');
  588. $container->registerForAutoconfiguration(ConstraintValidatorInterface::class)
  589. ->addTag('validator.constraint_validator');
  590. $container->registerForAutoconfiguration(ObjectInitializerInterface::class)
  591. ->addTag('validator.initializer');
  592. $container->registerForAutoconfiguration(MessageHandlerInterface::class)
  593. ->addTag('messenger.message_handler');
  594. $container->registerForAutoconfiguration(BatchHandlerInterface::class)
  595. ->addTag('messenger.message_handler');
  596. $container->registerForAutoconfiguration(TransportFactoryInterface::class)
  597. ->addTag('messenger.transport_factory');
  598. $container->registerForAutoconfiguration(MimeTypeGuesserInterface::class)
  599. ->addTag('mime.mime_type_guesser');
  600. $container->registerForAutoconfiguration(LoggerAwareInterface::class)
  601. ->addMethodCall('setLogger', [new Reference('logger')]);
  603. $container->registerAttributeForAutoconfiguration(AsEventListener::class, static function (ChildDefinition $definition, AsEventListener $attribute, \Reflector $reflector) {
  604. $tagAttributes = get_object_vars($attribute);
  605. if ($reflector instanceof \ReflectionMethod) {
  606. if (isset($tagAttributes['method'])) {
  607. throw new LogicException(sprintf('AsEventListener attribute cannot declare a method on "%s::%s()".', $reflector->class, $reflector->name));
  608. }
  609. $tagAttributes['method'] = $reflector->getName();
  610. }
  611. $definition->addTag('kernel.event_listener', $tagAttributes);
  612. });
  613. $container->registerAttributeForAutoconfiguration(AsController::class, static function (ChildDefinition $definition, AsController $attribute): void {
  614. $definition->addTag('controller.service_arguments');
  615. });
  616. $container->registerAttributeForAutoconfiguration(AsMessageHandler::class, static function (ChildDefinition $definition, AsMessageHandler $attribute): void {
  617. $tagAttributes = get_object_vars($attribute);
  618. $tagAttributes['from_transport'] = $tagAttributes['fromTransport'];
  619. unset($tagAttributes['fromTransport']);
  621. $definition->addTag('messenger.message_handler', $tagAttributes);
  622. });
  624. if (!$container->getParameter('kernel.debug')) {
  625. // remove tagged iterator argument for resource checkers
  626. $container->getDefinition('config_cache_factory')->setArguments([]);
  627. }
  629. if (!$config['disallow_search_engine_index'] ?? false) {
  630. $container->removeDefinition('disallow_search_engine_index_response_listener');
  631. }
  633. $container->registerForAutoconfiguration(RouteLoaderInterface::class)
  634. ->addTag('routing.route_loader');
  636. $container->setParameter('container.behavior_describing_tags', [
  637. 'container.service_locator',
  638. 'container.service_subscriber',
  639. 'kernel.event_subscriber',
  640. 'kernel.locale_aware',
  641. 'kernel.reset',
  642. ]);
  643. }
  645. /**
  646. * {@inheritdoc}
  647. */
  648. public function getConfiguration(array $config, ContainerBuilder $container)
  649. {
  650. return new Configuration($container->getParameter('kernel.debug'));
  651. }
  653. protected function hasConsole(): bool
  654. {
  655. return class_exists(Application::class);
  656. }
  658. private function registerFormConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  659. {
  660. $loader->load('form.php');
  662. $container->getDefinition('form.type_extension.form.validator')->setArgument(1, $config['form']['legacy_error_messages']);
  664. if (null === $config['form']['csrf_protection']['enabled']) {
  665. $config['form']['csrf_protection']['enabled'] = $config['csrf_protection']['enabled'];
  666. }
  668. if ($this->isConfigEnabled($container, $config['form']['csrf_protection'])) {
  669. $loader->load('form_csrf.php');
  671. $container->setParameter('form.type_extension.csrf.enabled', true);
  672. $container->setParameter('form.type_extension.csrf.field_name', $config['form']['csrf_protection']['field_name']);
  673. } else {
  674. $container->setParameter('form.type_extension.csrf.enabled', false);
  675. }
  677. if (!ContainerBuilder::willBeAvailable('symfony/translation', Translator::class, ['symfony/framework-bundle', 'symfony/form'], true)) {
  678. $container->removeDefinition('form.type_extension.upload.validator');
  679. }
  680. if (!method_exists(CachingFactoryDecorator::class, 'reset')) {
  681. $container->getDefinition('form.choice_list_factory.cached')
  682. ->clearTag('kernel.reset')
  683. ;
  684. }
  685. }
  687. private function registerHttpCacheConfiguration(array $config, ContainerBuilder $container, bool $httpMethodOverride)
  688. {
  689. $options = $config;
  690. unset($options['enabled']);
  692. if (!$options['private_headers']) {
  693. unset($options['private_headers']);
  694. }
  696. $container->getDefinition('http_cache')
  697. ->setPublic($config['enabled'])
  698. ->replaceArgument(3, $options);
  700. if ($httpMethodOverride) {
  701. $container->getDefinition('http_cache')
  702. ->addArgument((new Definition('void'))
  703. ->setFactory([Request::class, 'enableHttpMethodParameterOverride'])
  704. );
  705. }
  706. }
  708. private function registerEsiConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  709. {
  710. if (!$this->isConfigEnabled($container, $config)) {
  711. $container->removeDefinition('fragment.renderer.esi');
  713. return;
  714. }
  716. $loader->load('esi.php');
  717. }
  719. private function registerSsiConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  720. {
  721. if (!$this->isConfigEnabled($container, $config)) {
  722. $container->removeDefinition('fragment.renderer.ssi');
  724. return;
  725. }
  727. $loader->load('ssi.php');
  728. }
  730. private function registerFragmentsConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  731. {
  732. if (!$this->isConfigEnabled($container, $config)) {
  733. $container->removeDefinition('fragment.renderer.hinclude');
  735. return;
  736. }
  738. $container->setParameter('fragment.renderer.hinclude.global_template', $config['hinclude_default_template']);
  740. $loader->load('fragment_listener.php');
  741. $container->setParameter('fragment.path', $config['path']);
  742. }
  744. private function registerProfilerConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  745. {
  746. if (!$this->isConfigEnabled($container, $config)) {
  747. // this is needed for the WebProfiler to work even if the profiler is disabled
  748. $container->setParameter('data_collector.templates', []);
  750. return;
  751. }
  753. $loader->load('profiling.php');
  754. $loader->load('collectors.php');
  755. $loader->load('cache_debug.php');
  757. if ($this->formConfigEnabled) {
  758. $loader->load('form_debug.php');
  759. }
  761. if ($this->validatorConfigEnabled) {
  762. $loader->load('validator_debug.php');
  763. }
  765. if ($this->translationConfigEnabled) {
  766. $loader->load('translation_debug.php');
  768. $container->getDefinition('translator.data_collector')->setDecoratedService('translator');
  769. }
  771. if ($this->messengerConfigEnabled) {
  772. $loader->load('messenger_debug.php');
  773. }
  775. if ($this->mailerConfigEnabled) {
  776. $loader->load('mailer_debug.php');
  777. }
  779. if ($this->httpClientConfigEnabled) {
  780. $loader->load('http_client_debug.php');
  781. }
  783. if ($this->notifierConfigEnabled) {
  784. $loader->load('notifier_debug.php');
  785. }
  787. $container->setParameter('profiler_listener.only_exceptions', $config['only_exceptions']);
  788. $container->setParameter('profiler_listener.only_main_requests', $config['only_main_requests'] || $config['only_master_requests']);
  790. // Choose storage class based on the DSN
  791. [$class] = explode(':', $config['dsn'], 2);
  792. if ('file' !== $class) {
  793. throw new \LogicException(sprintf('Driver "%s" is not supported for the profiler.', $class));
  794. }
  796. $container->setParameter('profiler.storage.dsn', $config['dsn']);
  798. $container->getDefinition('profiler')
  799. ->addArgument($config['collect'])
  800. ->addTag('kernel.reset', ['method' => 'reset']);
  802. $container->getDefinition('profiler_listener')
  803. ->addArgument($config['collect_parameter']);
  804. }
  806. private function registerWorkflowConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  807. {
  808. if (!$config['enabled']) {
  809. $container->removeDefinition('console.command.workflow_dump');
  811. return;
  812. }
  814. if (!class_exists(Workflow\Workflow::class)) {
  815. throw new LogicException('Workflow support cannot be enabled as the Workflow component is not installed. Try running "composer require symfony/workflow".');
  816. }
  818. $loader->load('workflow.php');
  820. $registryDefinition = $container->getDefinition('workflow.registry');
  822. $workflows = [];
  824. foreach ($config['workflows'] as $name => $workflow) {
  825. $type = $workflow['type'];
  826. $workflowId = sprintf('%s.%s', $type, $name);
  828. // Process Metadata (workflow + places (transition is done in the "create transition" block))
  829. $metadataStoreDefinition = new Definition(Workflow\Metadata\InMemoryMetadataStore::class, [[], [], null]);
  830. if ($workflow['metadata']) {
  831. $metadataStoreDefinition->replaceArgument(0, $workflow['metadata']);
  832. }
  833. $placesMetadata = [];
  834. foreach ($workflow['places'] as $place) {
  835. if ($place['metadata']) {
  836. $placesMetadata[$place['name']] = $place['metadata'];
  837. }
  838. }
  839. if ($placesMetadata) {
  840. $metadataStoreDefinition->replaceArgument(1, $placesMetadata);
  841. }
  843. // Create transitions
  844. $transitions = [];
  845. $guardsConfiguration = [];
  846. $transitionsMetadataDefinition = new Definition(\SplObjectStorage::class);
  847. // Global transition counter per workflow
  848. $transitionCounter = 0;
  849. foreach ($workflow['transitions'] as $transition) {
  850. if ('workflow' === $type) {
  851. $transitionDefinition = new Definition(Workflow\Transition::class, [$transition['name'], $transition['from'], $transition['to']]);
  852. $transitionDefinition->setPublic(false);
  853. $transitionId = sprintf('.%s.transition.%s', $workflowId, $transitionCounter++);
  854. $container->setDefinition($transitionId, $transitionDefinition);
  855. $transitions[] = new Reference($transitionId);
  856. if (isset($transition['guard'])) {
  857. $configuration = new Definition(Workflow\EventListener\GuardExpression::class);
  858. $configuration->addArgument(new Reference($transitionId));
  859. $configuration->addArgument($transition['guard']);
  860. $configuration->setPublic(false);
  861. $eventName = sprintf('workflow.%s.guard.%s', $name, $transition['name']);
  862. $guardsConfiguration[$eventName][] = $configuration;
  863. }
  864. if ($transition['metadata']) {
  865. $transitionsMetadataDefinition->addMethodCall('attach', [
  866. new Reference($transitionId),
  867. $transition['metadata'],
  868. ]);
  869. }
  870. } elseif ('state_machine' === $type) {
  871. foreach ($transition['from'] as $from) {
  872. foreach ($transition['to'] as $to) {
  873. $transitionDefinition = new Definition(Workflow\Transition::class, [$transition['name'], $from, $to]);
  874. $transitionDefinition->setPublic(false);
  875. $transitionId = sprintf('.%s.transition.%s', $workflowId, $transitionCounter++);
  876. $container->setDefinition($transitionId, $transitionDefinition);
  877. $transitions[] = new Reference($transitionId);
  878. if (isset($transition['guard'])) {
  879. $configuration = new Definition(Workflow\EventListener\GuardExpression::class);
  880. $configuration->addArgument(new Reference($transitionId));
  881. $configuration->addArgument($transition['guard']);
  882. $configuration->setPublic(false);
  883. $eventName = sprintf('workflow.%s.guard.%s', $name, $transition['name']);
  884. $guardsConfiguration[$eventName][] = $configuration;
  885. }
  886. if ($transition['metadata']) {
  887. $transitionsMetadataDefinition->addMethodCall('attach', [
  888. new Reference($transitionId),
  889. $transition['metadata'],
  890. ]);
  891. }
  892. }
  893. }
  894. }
  895. }
  896. $metadataStoreDefinition->replaceArgument(2, $transitionsMetadataDefinition);
  897. $container->setDefinition(sprintf('%s.metadata_store', $workflowId), $metadataStoreDefinition);
  899. // Create places
  900. $places = array_column($workflow['places'], 'name');
  901. $initialMarking = $workflow['initial_marking'] ?? [];
  903. // Create a Definition
  904. $definitionDefinition = new Definition(Workflow\Definition::class);
  905. $definitionDefinition->setPublic(false);
  906. $definitionDefinition->addArgument($places);
  907. $definitionDefinition->addArgument($transitions);
  908. $definitionDefinition->addArgument($initialMarking);
  909. $definitionDefinition->addArgument(new Reference(sprintf('%s.metadata_store', $workflowId)));
  911. $workflows[$workflowId] = $definitionDefinition;
  913. // Create MarkingStore
  914. if (isset($workflow['marking_store']['type'])) {
  915. $markingStoreDefinition = new ChildDefinition('workflow.marking_store.method');
  916. $markingStoreDefinition->setArguments([
  917. 'state_machine' === $type, //single state
  918. $workflow['marking_store']['property'],
  919. ]);
  920. } elseif (isset($workflow['marking_store']['service'])) {
  921. $markingStoreDefinition = new Reference($workflow['marking_store']['service']);
  922. }
  924. // Create Workflow
  925. $workflowDefinition = new ChildDefinition(sprintf('%s.abstract', $type));
  926. $workflowDefinition->replaceArgument(0, new Reference(sprintf('%s.definition', $workflowId)));
  927. $workflowDefinition->replaceArgument(1, $markingStoreDefinition ?? null);
  928. $workflowDefinition->replaceArgument(3, $name);
  929. $workflowDefinition->replaceArgument(4, $workflow['events_to_dispatch']);
  930. $workflowDefinition->addTag('container.private', [
  931. 'package' => 'symfony/framework-bundle',
  932. 'version' => '5.3',
  933. ]);
  935. // Store to container
  936. $container->setDefinition($workflowId, $workflowDefinition);
  937. $container->setDefinition(sprintf('%s.definition', $workflowId), $definitionDefinition);
  938. $container->registerAliasForArgument($workflowId, WorkflowInterface::class, $name.'.'.$type);
  940. // Validate Workflow
  941. if ('state_machine' === $workflow['type']) {
  942. $validator = new Workflow\Validator\StateMachineValidator();
  943. } else {
  944. $validator = new Workflow\Validator\WorkflowValidator();
  945. }
  947. $trs = array_map(function (Reference $ref) use ($container): Workflow\Transition {
  948. return $container->get((string) $ref);
  949. }, $transitions);
  950. $realDefinition = new Workflow\Definition($places, $trs, $initialMarking);
  951. $validator->validate($realDefinition, $name);
  953. // Add workflow to Registry
  954. if ($workflow['supports']) {
  955. foreach ($workflow['supports'] as $supportedClassName) {
  956. $strategyDefinition = new Definition(Workflow\SupportStrategy\InstanceOfSupportStrategy::class, [$supportedClassName]);
  957. $strategyDefinition->setPublic(false);
  958. $registryDefinition->addMethodCall('addWorkflow', [new Reference($workflowId), $strategyDefinition]);
  959. }
  960. } elseif (isset($workflow['support_strategy'])) {
  961. $registryDefinition->addMethodCall('addWorkflow', [new Reference($workflowId), new Reference($workflow['support_strategy'])]);
  962. }
  964. // Enable the AuditTrail
  965. if ($workflow['audit_trail']['enabled']) {
  966. $listener = new Definition(Workflow\EventListener\AuditTrailListener::class);
  967. $listener->addTag('monolog.logger', ['channel' => 'workflow']);
  968. $listener->addTag('kernel.event_listener', ['event' => sprintf('workflow.%s.leave', $name), 'method' => 'onLeave']);
  969. $listener->addTag('kernel.event_listener', ['event' => sprintf('workflow.%s.transition', $name), 'method' => 'onTransition']);
  970. $listener->addTag('kernel.event_listener', ['event' => sprintf('workflow.%s.enter', $name), 'method' => 'onEnter']);
  971. $listener->addArgument(new Reference('logger'));
  972. $container->setDefinition(sprintf('.%s.listener.audit_trail', $workflowId), $listener);
  973. }
  975. // Add Guard Listener
  976. if ($guardsConfiguration) {
  977. if (!class_exists(ExpressionLanguage::class)) {
  978. throw new LogicException('Cannot guard workflows as the ExpressionLanguage component is not installed. Try running "composer require symfony/expression-language".');
  979. }
  981. if (!class_exists(Security::class)) {
  982. throw new LogicException('Cannot guard workflows as the Security component is not installed. Try running "composer require symfony/security-core".');
  983. }
  985. $guard = new Definition(Workflow\EventListener\GuardListener::class);
  987. $guard->setArguments([
  988. $guardsConfiguration,
  989. new Reference('workflow.security.expression_language'),
  990. new Reference('security.token_storage'),
  991. new Reference('security.authorization_checker'),
  992. new Reference('security.authentication.trust_resolver'),
  993. new Reference('security.role_hierarchy'),
  994. new Reference('validator', ContainerInterface::NULL_ON_INVALID_REFERENCE),
  995. ]);
  996. foreach ($guardsConfiguration as $eventName => $config) {
  997. $guard->addTag('kernel.event_listener', ['event' => $eventName, 'method' => 'onTransition']);
  998. }
  1000. $container->setDefinition(sprintf('.%s.listener.guard', $workflowId), $guard);
  1001. $container->setParameter('workflow.has_guard_listeners', true);
  1002. }
  1003. }
  1005. $commandDumpDefinition = $container->getDefinition('console.command.workflow_dump');
  1006. $commandDumpDefinition->setArgument(0, $workflows);
  1007. }
  1009. private function registerDebugConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  1010. {
  1011. $loader->load('debug_prod.php');
  1013. if (class_exists(Stopwatch::class)) {
  1014. $container->register('debug.stopwatch', Stopwatch::class)
  1015. ->addArgument(true)
  1016. ->addTag('kernel.reset', ['method' => 'reset']);
  1017. $container->setAlias(Stopwatch::class, new Alias('debug.stopwatch', false));
  1018. }
  1020. $debug = $container->getParameter('kernel.debug');
  1022. if ($debug) {
  1023. $container->setParameter('debug.container.dump', '%kernel.build_dir%/%kernel.container_class%.xml');
  1024. }
  1026. if ($debug && class_exists(Stopwatch::class)) {
  1027. $loader->load('debug.php');
  1028. }
  1030. $definition = $container->findDefinition('debug.debug_handlers_listener');
  1032. if (false === $config['log']) {
  1033. $definition->replaceArgument(1, null);
  1034. } elseif (true !== $config['log']) {
  1035. $definition->replaceArgument(2, $config['log']);
  1036. }
  1038. if (!$config['throw']) {
  1039. $container->setParameter('debug.error_handler.throw_at', 0);
  1040. }
  1042. if ($debug && class_exists(DebugProcessor::class)) {
  1043. $definition = new Definition(DebugProcessor::class);
  1044. $definition->setPublic(false);
  1045. $definition->addArgument(new Reference('request_stack'));
  1046. $container->setDefinition('debug.log_processor', $definition);
  1047. }
  1048. }
  1050. private function registerRouterConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader, array $enabledLocales = [])
  1051. {
  1052. if (!$this->isConfigEnabled($container, $config)) {
  1053. $container->removeDefinition('console.command.router_debug');
  1054. $container->removeDefinition('console.command.router_match');
  1055. $container->removeDefinition('messenger.middleware.router_context');
  1057. return;
  1058. }
  1059. if (!class_exists(RouterContextMiddleware::class)) {
  1060. $container->removeDefinition('messenger.middleware.router_context');
  1061. }
  1063. $loader->load('routing.php');
  1065. if (null === $config['utf8']) {
  1066. trigger_deprecation('symfony/framework-bundle', '5.1', 'Not setting the "framework.router.utf8" configuration option is deprecated, it will default to "true" in version 6.0.');
  1067. }
  1069. if ($config['utf8']) {
  1070. $container->getDefinition('routing.loader')->replaceArgument(1, ['utf8' => true]);
  1071. }
  1073. if ($enabledLocales) {
  1074. $enabledLocales = implode('|', array_map('preg_quote', $enabledLocales));
  1075. $container->getDefinition('routing.loader')->replaceArgument(2, ['_locale' => $enabledLocales]);
  1076. }
  1078. if (!ContainerBuilder::willBeAvailable('symfony/expression-language', ExpressionLanguage::class, ['symfony/framework-bundle', 'symfony/routing'], true)) {
  1079. $container->removeDefinition('router.expression_language_provider');
  1080. }
  1082. $container->setParameter('router.resource', $config['resource']);
  1083. $router = $container->findDefinition('router.default');
  1084. $argument = $router->getArgument(2);
  1085. $argument['strict_requirements'] = $config['strict_requirements'];
  1086. if (isset($config['type'])) {
  1087. $argument['resource_type'] = $config['type'];
  1088. }
  1089. $router->replaceArgument(2, $argument);
  1091. $container->setParameter('request_listener.http_port', $config['http_port']);
  1092. $container->setParameter('request_listener.https_port', $config['https_port']);
  1094. if (null !== $config['default_uri']) {
  1095. $container->getDefinition('router.request_context')
  1096. ->replaceArgument(0, $config['default_uri']);
  1097. }
  1099. if (\PHP_VERSION_ID < 80000 && !$this->annotationsConfigEnabled) {
  1100. return;
  1101. }
  1103. $container->register('routing.loader.annotation', AnnotatedRouteControllerLoader::class)
  1104. ->setPublic(false)
  1105. ->addTag('routing.loader', ['priority' => -10])
  1106. ->setArguments([
  1107. new Reference('annotation_reader', ContainerInterface::NULL_ON_INVALID_REFERENCE),
  1108. '%kernel.environment%',
  1109. ]);
  1111. $container->register('routing.loader.annotation.directory', AnnotationDirectoryLoader::class)
  1112. ->setPublic(false)
  1113. ->addTag('routing.loader', ['priority' => -10])
  1114. ->setArguments([
  1115. new Reference('file_locator'),
  1116. new Reference('routing.loader.annotation'),
  1117. ]);
  1119. $container->register('routing.loader.annotation.file', AnnotationFileLoader::class)
  1120. ->setPublic(false)
  1121. ->addTag('routing.loader', ['priority' => -10])
  1122. ->setArguments([
  1123. new Reference('file_locator'),
  1124. new Reference('routing.loader.annotation'),
  1125. ]);
  1126. }
  1128. private function registerSessionConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  1129. {
  1130. $loader->load('session.php');
  1132. // session storage
  1133. if (null === $config['storage_factory_id']) {
  1134. trigger_deprecation('symfony/framework-bundle', '5.3', 'Not setting the "framework.session.storage_factory_id" configuration option is deprecated, it will default to "session.storage.factory.native" and will replace the "framework.session.storage_id" configuration option in version 6.0.');
  1135. $container->setAlias('session.storage', $config['storage_id']);
  1136. $container->setAlias('session.storage.factory', 'session.storage.factory.service');
  1137. } else {
  1138. $container->setAlias('session.storage.factory', $config['storage_factory_id']);
  1140. $container->removeAlias(SessionStorageInterface::class);
  1141. $container->removeDefinition('session.storage.metadata_bag');
  1142. $container->removeDefinition('session.storage.native');
  1143. $container->removeDefinition('session.storage.php_bridge');
  1144. $container->removeDefinition('session.storage.mock_file');
  1145. $container->removeAlias('session.storage.filesystem');
  1146. }
  1148. $options = ['cache_limiter' => '0'];
  1149. foreach (['name', 'cookie_lifetime', 'cookie_path', 'cookie_domain', 'cookie_secure', 'cookie_httponly', 'cookie_samesite', 'use_cookies', 'gc_maxlifetime', 'gc_probability', 'gc_divisor', 'sid_length', 'sid_bits_per_character'] as $key) {
  1150. if (isset($config[$key])) {
  1151. $options[$key] = $config[$key];
  1152. }
  1153. }
  1155. if ('auto' === ($options['cookie_secure'] ?? null)) {
  1156. if (null === $config['storage_factory_id']) {
  1157. $locator = $container->getDefinition('session_listener')->getArgument(0);
  1158. $locator->setValues($locator->getValues() + [
  1159. 'session_storage' => new Reference('session.storage', ContainerInterface::IGNORE_ON_INVALID_REFERENCE),
  1160. 'request_stack' => new Reference('request_stack'),
  1161. ]);
  1162. } else {
  1163. $container->getDefinition('session.storage.factory.native')->replaceArgument(3, true);
  1164. $container->getDefinition('session.storage.factory.php_bridge')->replaceArgument(2, true);
  1165. }
  1166. }
  1168. $container->setParameter('session.storage.options', $options);
  1170. // session handler (the internal callback registered with PHP session management)
  1171. if (null === $config['handler_id']) {
  1172. // Set the handler class to be null
  1173. if ($container->hasDefinition('session.storage.native')) {
  1174. $container->getDefinition('session.storage.native')->replaceArgument(1, null);
  1175. $container->getDefinition('session.storage.php_bridge')->replaceArgument(0, null);
  1176. } else {
  1177. $container->getDefinition('session.storage.factory.native')->replaceArgument(1, null);
  1178. $container->getDefinition('session.storage.factory.php_bridge')->replaceArgument(0, null);
  1179. }
  1181. $container->setAlias('session.handler', 'session.handler.native_file');
  1182. } else {
  1183. $container->resolveEnvPlaceholders($config['handler_id'], null, $usedEnvs);
  1185. if ($usedEnvs || preg_match('#^[a-z]++://#', $config['handler_id'])) {
  1186. $id = '.cache_connection.'.ContainerBuilder::hash($config['handler_id']);
  1188. $container->getDefinition('session.abstract_handler')
  1189. ->replaceArgument(0, $container->hasDefinition($id) ? new Reference($id) : $config['handler_id']);
  1191. $container->setAlias('session.handler', 'session.abstract_handler');
  1192. } else {
  1193. $container->setAlias('session.handler', $config['handler_id']);
  1194. }
  1195. }
  1197. $container->setParameter('session.save_path', $config['save_path']);
  1199. $container->setParameter('session.metadata.update_threshold', $config['metadata_update_threshold']);
  1200. }
  1202. private function registerRequestConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  1203. {
  1204. if ($config['formats']) {
  1205. $loader->load('request.php');
  1207. $listener = $container->getDefinition('request.add_request_formats_listener');
  1208. $listener->replaceArgument(0, $config['formats']);
  1209. }
  1210. }
  1212. private function registerAssetsConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  1213. {
  1214. $loader->load('assets.php');
  1216. if ($config['version_strategy']) {
  1217. $defaultVersion = new Reference($config['version_strategy']);
  1218. } else {
  1219. $defaultVersion = $this->createVersion($container, $config['version'], $config['version_format'], $config['json_manifest_path'], '_default', $config['strict_mode']);
  1220. }
  1222. $defaultPackage = $this->createPackageDefinition($config['base_path'], $config['base_urls'], $defaultVersion);
  1223. $container->setDefinition('assets._default_package', $defaultPackage);
  1225. foreach ($config['packages'] as $name => $package) {
  1226. if (null !== $package['version_strategy']) {
  1227. $version = new Reference($package['version_strategy']);
  1228. } elseif (!\array_key_exists('version', $package) && null === $package['json_manifest_path']) {
  1229. // if neither version nor json_manifest_path are specified, use the default
  1230. $version = $defaultVersion;
  1231. } else {
  1232. // let format fallback to main version_format
  1233. $format = $package['version_format'] ?: $config['version_format'];
  1234. $version = $package['version'] ?? null;
  1235. $version = $this->createVersion($container, $version, $format, $package['json_manifest_path'], $name, $package['strict_mode']);
  1236. }
  1238. $packageDefinition = $this->createPackageDefinition($package['base_path'], $package['base_urls'], $version)
  1239. ->addTag('assets.package', ['package' => $name]);
  1240. $container->setDefinition('assets._package_'.$name, $packageDefinition);
  1241. $container->registerAliasForArgument('assets._package_'.$name, PackageInterface::class, $name.'.package');
  1242. }
  1243. }
  1245. /**
  1246. * Returns a definition for an asset package.
  1247. */
  1248. private function createPackageDefinition(?string $basePath, array $baseUrls, Reference $version): Definition
  1249. {
  1250. if ($basePath && $baseUrls) {
  1251. throw new \LogicException('An asset package cannot have base URLs and base paths.');
  1252. }
  1254. $package = new ChildDefinition($baseUrls ? 'assets.url_package' : 'assets.path_package');
  1255. $package
  1256. ->setPublic(false)
  1257. ->replaceArgument(0, $baseUrls ?: $basePath)
  1258. ->replaceArgument(1, $version)
  1259. ;
  1261. return $package;
  1262. }
  1264. private function createVersion(ContainerBuilder $container, ?string $version, ?string $format, ?string $jsonManifestPath, string $name, bool $strictMode): Reference
  1265. {
  1266. // Configuration prevents $version and $jsonManifestPath from being set
  1267. if (null !== $version) {
  1268. $def = new ChildDefinition('assets.static_version_strategy');
  1269. $def
  1270. ->replaceArgument(0, $version)
  1271. ->replaceArgument(1, $format)
  1272. ;
  1273. $container->setDefinition('assets._version_'.$name, $def);
  1275. return new Reference('assets._version_'.$name);
  1276. }
  1278. if (null !== $jsonManifestPath) {
  1279. $def = new ChildDefinition('assets.json_manifest_version_strategy');
  1280. $def->replaceArgument(0, $jsonManifestPath);
  1281. $def->replaceArgument(2, $strictMode);
  1282. $container->setDefinition('assets._version_'.$name, $def);
  1284. return new Reference('assets._version_'.$name);
  1285. }
  1287. return new Reference('assets.empty_version_strategy');
  1288. }
  1290. private function registerTranslatorConfiguration(array $config, ContainerBuilder $container, LoaderInterface $loader, string $defaultLocale, array $enabledLocales)
  1291. {
  1292. if (!$this->isConfigEnabled($container, $config)) {
  1293. $container->removeDefinition('console.command.translation_debug');
  1294. $container->removeDefinition('console.command.translation_extract');
  1295. $container->removeDefinition('console.command.translation_pull');
  1296. $container->removeDefinition('console.command.translation_push');
  1298. return;
  1299. }
  1301. $loader->load('translation.php');
  1302. $loader->load('translation_providers.php');
  1304. // Use the "real" translator instead of the identity default
  1305. $container->setAlias('translator', 'translator.default')->setPublic(true);
  1306. $container->setAlias('translator.formatter', new Alias($config['formatter'], false));
  1307. $translator = $container->findDefinition('translator.default');
  1308. $translator->addMethodCall('setFallbackLocales', [$config['fallbacks'] ?: [$defaultLocale]]);
  1310. $defaultOptions = $translator->getArgument(4);
  1311. $defaultOptions['cache_dir'] = $config['cache_dir'];
  1312. $translator->setArgument(4, $defaultOptions);
  1314. // @deprecated since Symfony 5.4, in 6.0 change to:
  1315. // $translator->setArgument(5, $enabledLocales);
  1316. $translator->setArgument(5, $config['enabled_locales'] ?: $enabledLocales);
  1318. $container->setParameter('translator.logging', $config['logging']);
  1319. $container->setParameter('translator.default_path', $config['default_path']);
  1321. // Discover translation directories
  1322. $dirs = [];
  1323. $transPaths = [];
  1324. $nonExistingDirs = [];
  1325. if (ContainerBuilder::willBeAvailable('symfony/validator', Validation::class, ['symfony/framework-bundle', 'symfony/translation'], true)) {
  1326. $r = new \ReflectionClass(Validation::class);
  1328. $dirs[] = $transPaths[] = \dirname($r->getFileName()).'/Resources/translations';
  1329. }
  1330. if (ContainerBuilder::willBeAvailable('symfony/form', Form::class, ['symfony/framework-bundle', 'symfony/translation'], true)) {
  1331. $r = new \ReflectionClass(Form::class);
  1333. $dirs[] = $transPaths[] = \dirname($r->getFileName()).'/Resources/translations';
  1334. }
  1335. if (ContainerBuilder::willBeAvailable('symfony/security-core', AuthenticationException::class, ['symfony/framework-bundle', 'symfony/translation'], true)) {
  1336. $r = new \ReflectionClass(AuthenticationException::class);
  1338. $dirs[] = $transPaths[] = \dirname($r->getFileName(), 2).'/Resources/translations';
  1339. }
  1340. $defaultDir = $container->getParameterBag()->resolveValue($config['default_path']);
  1341. foreach ($container->getParameter('kernel.bundles_metadata') as $name => $bundle) {
  1342. if ($container->fileExists($dir = $bundle['path'].'/Resources/translations') || $container->fileExists($dir = $bundle['path'].'/translations')) {
  1343. $dirs[] = $dir;
  1344. } else {
  1345. $nonExistingDirs[] = $dir;
  1346. }
  1347. }
  1349. foreach ($config['paths'] as $dir) {
  1350. if ($container->fileExists($dir)) {
  1351. $dirs[] = $transPaths[] = $dir;
  1352. } else {
  1353. throw new \UnexpectedValueException(sprintf('"%s" defined in translator.paths does not exist or is not a directory.', $dir));
  1354. }
  1355. }
  1357. if ($container->hasDefinition('console.command.translation_debug')) {
  1358. $container->getDefinition('console.command.translation_debug')->replaceArgument(5, $transPaths);
  1359. }
  1361. if ($container->hasDefinition('console.command.translation_extract')) {
  1362. $container->getDefinition('console.command.translation_extract')->replaceArgument(6, $transPaths);
  1363. }
  1365. if (null === $defaultDir) {
  1366. // allow null
  1367. } elseif ($container->fileExists($defaultDir)) {
  1368. $dirs[] = $defaultDir;
  1369. } else {
  1370. $nonExistingDirs[] = $defaultDir;
  1371. }
  1373. // Register translation resources
  1374. if ($dirs) {
  1375. $files = [];
  1377. foreach ($dirs as $dir) {
  1378. $finder = Finder::create()
  1379. ->followLinks()
  1380. ->files()
  1381. ->filter(function (\SplFileInfo $file) {
  1382. return 2 <= substr_count($file->getBasename(), '.') && preg_match('/\.\w+$/', $file->getBasename());
  1383. })
  1384. ->in($dir)
  1385. ->sortByName()
  1386. ;
  1387. foreach ($finder as $file) {
  1388. $fileNameParts = explode('.', basename($file));
  1389. $locale = $fileNameParts[\count($fileNameParts) - 2];
  1390. if (!isset($files[$locale])) {
  1391. $files[$locale] = [];
  1392. }
  1394. $files[$locale][] = (string) $file;
  1395. }
  1396. }
  1398. $projectDir = $container->getParameter('kernel.project_dir');
  1400. $options = array_merge(
  1401. $translator->getArgument(4),
  1402. [
  1403. 'resource_files' => $files,
  1404. 'scanned_directories' => $scannedDirectories = array_merge($dirs, $nonExistingDirs),
  1405. 'cache_vary' => [
  1406. 'scanned_directories' => array_map(static function (string $dir) use ($projectDir): string {
  1407. return str_starts_with($dir, $projectDir.'/') ? substr($dir, 1 + \strlen($projectDir)) : $dir;
  1408. }, $scannedDirectories),
  1409. ],
  1410. ]
  1411. );
  1413. $translator->replaceArgument(4, $options);
  1414. }
  1416. if ($config['pseudo_localization']['enabled']) {
  1417. $options = $config['pseudo_localization'];
  1418. unset($options['enabled']);
  1420. $container
  1421. ->register('translator.pseudo', PseudoLocalizationTranslator::class)
  1422. ->setDecoratedService('translator', null, -1) // Lower priority than "translator.data_collector"
  1423. ->setArguments([
  1424. new Reference('translator.pseudo.inner'),
  1425. $options,
  1426. ]);
  1427. }
  1429. $classToServices = [
  1430. CrowdinProviderFactory::class => 'translation.provider_factory.crowdin',
  1431. LocoProviderFactory::class => 'translation.provider_factory.loco',
  1432. LokaliseProviderFactory::class => 'translation.provider_factory.lokalise',
  1433. ];
  1435. $parentPackages = ['symfony/framework-bundle', 'symfony/translation', 'symfony/http-client'];
  1437. foreach ($classToServices as $class => $service) {
  1438. $package = substr($service, \strlen('translation.provider_factory.'));
  1440. if (!$container->hasDefinition('http_client') || !ContainerBuilder::willBeAvailable(sprintf('symfony/%s-translation-provider', $package), $class, $parentPackages, true)) {
  1441. $container->removeDefinition($service);
  1442. }
  1443. }
  1445. if (!$config['providers']) {
  1446. return;
  1447. }
  1449. // @deprecated since Symfony 5.4, in 6.0 change to:
  1450. // $locales = $enabledLocales;
  1451. $locales = $config['enabled_locales'] ?: $enabledLocales;
  1453. foreach ($config['providers'] as $provider) {
  1454. if ($provider['locales']) {
  1455. $locales += $provider['locales'];
  1456. }
  1457. }
  1459. $locales = array_unique($locales);
  1461. $container->getDefinition('console.command.translation_pull')
  1462. ->replaceArgument(4, array_merge($transPaths, [$config['default_path']]))
  1463. ->replaceArgument(5, $locales)
  1464. ;
  1466. $container->getDefinition('console.command.translation_push')
  1467. ->replaceArgument(2, array_merge($transPaths, [$config['default_path']]))
  1468. ->replaceArgument(3, $locales)
  1469. ;
  1471. $container->getDefinition('translation.provider_collection_factory')
  1472. ->replaceArgument(1, $locales)
  1473. ;
  1475. $container->getDefinition('translation.provider_collection')->setArgument(0, $config['providers']);
  1476. }
  1478. private function registerValidationConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader, bool $propertyInfoEnabled)
  1479. {
  1480. if (!$this->validatorConfigEnabled = $this->isConfigEnabled($container, $config)) {
  1481. $container->removeDefinition('console.command.validator_debug');
  1483. return;
  1484. }
  1486. if (!class_exists(Validation::class)) {
  1487. throw new LogicException('Validation support cannot be enabled as the Validator component is not installed. Try running "composer require symfony/validator".');
  1488. }
  1490. if (!isset($config['email_validation_mode'])) {
  1491. $config['email_validation_mode'] = 'loose';
  1492. }
  1494. $loader->load('validator.php');
  1496. $validatorBuilder = $container->getDefinition('validator.builder');
  1498. $container->setParameter('validator.translation_domain', $config['translation_domain']);
  1500. $files = ['xml' => [], 'yml' => []];
  1501. $this->registerValidatorMapping($container, $config, $files);
  1503. if (!empty($files['xml'])) {
  1504. $validatorBuilder->addMethodCall('addXmlMappings', [$files['xml']]);
  1505. }
  1507. if (!empty($files['yml'])) {
  1508. $validatorBuilder->addMethodCall('addYamlMappings', [$files['yml']]);
  1509. }
  1511. $definition = $container->findDefinition('validator.email');
  1512. $definition->replaceArgument(0, $config['email_validation_mode']);
  1514. if (\array_key_exists('enable_annotations', $config) && $config['enable_annotations']) {
  1515. if (!$this->annotationsConfigEnabled && \PHP_VERSION_ID < 80000) {
  1516. throw new \LogicException('"enable_annotations" on the validator cannot be set as the PHP version is lower than 8 and Doctrine Annotations support is disabled. Consider upgrading PHP.');
  1517. }
  1519. $validatorBuilder->addMethodCall('enableAnnotationMapping', [true]);
  1520. if ($this->annotationsConfigEnabled) {
  1521. $validatorBuilder->addMethodCall('setDoctrineAnnotationReader', [new Reference('annotation_reader')]);
  1522. }
  1523. }
  1525. if (\array_key_exists('static_method', $config) && $config['static_method']) {
  1526. foreach ($config['static_method'] as $methodName) {
  1527. $validatorBuilder->addMethodCall('addMethodMapping', [$methodName]);
  1528. }
  1529. }
  1531. if (!$container->getParameter('kernel.debug')) {
  1532. $validatorBuilder->addMethodCall('setMappingCache', [new Reference('validator.mapping.cache.adapter')]);
  1533. }
  1535. $container->setParameter('validator.auto_mapping', $config['auto_mapping']);
  1536. if (!$propertyInfoEnabled || !class_exists(PropertyInfoLoader::class)) {
  1537. $container->removeDefinition('validator.property_info_loader');
  1538. }
  1540. $container
  1541. ->getDefinition('validator.not_compromised_password')
  1542. ->setArgument(2, $config['not_compromised_password']['enabled'])
  1543. ->setArgument(3, $config['not_compromised_password']['endpoint'])
  1544. ;
  1546. if (!class_exists(ExpressionLanguage::class)) {
  1547. $container->removeDefinition('validator.expression_language');
  1548. }
  1549. }
  1551. private function registerValidatorMapping(ContainerBuilder $container, array $config, array &$files)
  1552. {
  1553. $fileRecorder = function ($extension, $path) use (&$files) {
  1554. $files['yaml' === $extension ? 'yml' : $extension][] = $path;
  1555. };
  1557. if (ContainerBuilder::willBeAvailable('symfony/form', Form::class, ['symfony/framework-bundle', 'symfony/validator'], true)) {
  1558. $reflClass = new \ReflectionClass(Form::class);
  1559. $fileRecorder('xml', \dirname($reflClass->getFileName()).'/Resources/config/validation.xml');
  1560. }
  1562. foreach ($container->getParameter('kernel.bundles_metadata') as $bundle) {
  1563. $configDir = is_dir($bundle['path'].'/Resources/config') ? $bundle['path'].'/Resources/config' : $bundle['path'].'/config';
  1565. if (
  1566. $container->fileExists($file = $configDir.'/validation.yaml', false) ||
  1567. $container->fileExists($file = $configDir.'/validation.yml', false)
  1568. ) {
  1569. $fileRecorder('yml', $file);
  1570. }
  1572. if ($container->fileExists($file = $configDir.'/validation.xml', false)) {
  1573. $fileRecorder('xml', $file);
  1574. }
  1576. if ($container->fileExists($dir = $configDir.'/validation', '/^$/')) {
  1577. $this->registerMappingFilesFromDir($dir, $fileRecorder);
  1578. }
  1579. }
  1581. $projectDir = $container->getParameter('kernel.project_dir');
  1582. if ($container->fileExists($dir = $projectDir.'/config/validator', '/^$/')) {
  1583. $this->registerMappingFilesFromDir($dir, $fileRecorder);
  1584. }
  1586. $this->registerMappingFilesFromConfig($container, $config, $fileRecorder);
  1587. }
  1589. private function registerMappingFilesFromDir(string $dir, callable $fileRecorder)
  1590. {
  1591. foreach (Finder::create()->followLinks()->files()->in($dir)->name('/\.(xml|ya?ml)$/')->sortByName() as $file) {
  1592. $fileRecorder($file->getExtension(), $file->getRealPath());
  1593. }
  1594. }
  1596. private function registerMappingFilesFromConfig(ContainerBuilder $container, array $config, callable $fileRecorder)
  1597. {
  1598. foreach ($config['mapping']['paths'] as $path) {
  1599. if (is_dir($path)) {
  1600. $this->registerMappingFilesFromDir($path, $fileRecorder);
  1601. $container->addResource(new DirectoryResource($path, '/^$/'));
  1602. } elseif ($container->fileExists($path, false)) {
  1603. if (!preg_match('/\.(xml|ya?ml)$/', $path, $matches)) {
  1604. throw new \RuntimeException(sprintf('Unsupported mapping type in "%s", supported types are XML & Yaml.', $path));
  1605. }
  1606. $fileRecorder($matches[1], $path);
  1607. } else {
  1608. throw new \RuntimeException(sprintf('Could not open file or directory "%s".', $path));
  1609. }
  1610. }
  1611. }
  1613. private function registerAnnotationsConfiguration(array $config, ContainerBuilder $container, LoaderInterface $loader)
  1614. {
  1615. if (!$this->annotationsConfigEnabled) {
  1616. return;
  1617. }
  1619. if (!class_exists(\Doctrine\Common\Annotations\Annotation::class)) {
  1620. throw new LogicException('Annotations cannot be enabled as the Doctrine Annotation library is not installed. Try running "composer require doctrine/annotations".');
  1621. }
  1623. $loader->load('annotations.php');
  1625. if (!method_exists(AnnotationRegistry::class, 'registerUniqueLoader')) {
  1626. $container->getDefinition('annotations.dummy_registry')
  1627. ->setMethodCalls([['registerLoader', ['class_exists']]]);
  1628. }
  1630. if ('none' === $config['cache']) {
  1631. $container->removeDefinition('annotations.cached_reader');
  1633. return;
  1634. }
  1636. $cacheService = $config['cache'];
  1637. if (\in_array($config['cache'], ['php_array', 'file'])) {
  1638. if ('php_array' === $config['cache']) {
  1639. $cacheService = 'annotations.cache_adapter';
  1641. // Enable warmer only if PHP array is used for cache
  1642. $definition = $container->findDefinition('annotations.cache_warmer');
  1643. $definition->addTag('kernel.cache_warmer');
  1644. } elseif ('file' === $config['cache']) {
  1645. $cacheService = 'annotations.filesystem_cache_adapter';
  1646. $cacheDir = $container->getParameterBag()->resolveValue($config['file_cache_dir']);
  1648. if (!is_dir($cacheDir) && false === @mkdir($cacheDir, 0777, true) && !is_dir($cacheDir)) {
  1649. throw new \RuntimeException(sprintf('Could not create cache directory "%s".', $cacheDir));
  1650. }
  1652. $container
  1653. ->getDefinition('annotations.filesystem_cache_adapter')
  1654. ->replaceArgument(2, $cacheDir)
  1655. ;
  1656. }
  1657. } else {
  1658. trigger_deprecation('symfony/framework-bundle', '5.3', 'Using a custom service for "framework.annotation.cache" is deprecated, only values "none", "php_array" and "file" are valid in version 6.0.');
  1659. }
  1661. $container
  1662. ->getDefinition('annotations.cached_reader')
  1663. ->replaceArgument(2, $config['debug'])
  1664. // temporary property to lazy-reference the cache provider without using it until AddAnnotationsCachedReaderPass runs
  1665. ->setProperty('cacheProviderBackup', new ServiceClosureArgument(new Reference($cacheService)))
  1666. ->addTag('annotations.cached_reader')
  1667. ;
  1669. $container->setAlias('annotation_reader', 'annotations.cached_reader');
  1670. $container->setAlias(Reader::class, new Alias('annotations.cached_reader', false));
  1671. $container->removeDefinition('annotations.psr_cached_reader');
  1672. }
  1674. private function registerPropertyAccessConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  1675. {
  1676. if (!$this->propertyAccessConfigEnabled = $this->isConfigEnabled($container, $config)) {
  1677. return;
  1678. }
  1680. $loader->load('property_access.php');
  1682. $magicMethods = PropertyAccessor::DISALLOW_MAGIC_METHODS;
  1683. $magicMethods |= $config['magic_call'] ? PropertyAccessor::MAGIC_CALL : 0;
  1684. $magicMethods |= $config['magic_get'] ? PropertyAccessor::MAGIC_GET : 0;
  1685. $magicMethods |= $config['magic_set'] ? PropertyAccessor::MAGIC_SET : 0;
  1687. $throw = PropertyAccessor::DO_NOT_THROW;
  1688. $throw |= $config['throw_exception_on_invalid_index'] ? PropertyAccessor::THROW_ON_INVALID_INDEX : 0;
  1689. $throw |= $config['throw_exception_on_invalid_property_path'] ? PropertyAccessor::THROW_ON_INVALID_PROPERTY_PATH : 0;
  1691. $container
  1692. ->getDefinition('property_accessor')
  1693. ->replaceArgument(0, $magicMethods)
  1694. ->replaceArgument(1, $throw)
  1695. ->replaceArgument(3, new Reference(PropertyReadInfoExtractorInterface::class, ContainerInterface::NULL_ON_INVALID_REFERENCE))
  1696. ->replaceArgument(4, new Reference(PropertyWriteInfoExtractorInterface::class, ContainerInterface::NULL_ON_INVALID_REFERENCE))
  1697. ;
  1698. }
  1700. private function registerSecretsConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  1701. {
  1702. if (!$this->isConfigEnabled($container, $config)) {
  1703. $container->removeDefinition('console.command.secrets_set');
  1704. $container->removeDefinition('console.command.secrets_list');
  1705. $container->removeDefinition('console.command.secrets_remove');
  1706. $container->removeDefinition('console.command.secrets_generate_key');
  1707. $container->removeDefinition('console.command.secrets_decrypt_to_local');
  1708. $container->removeDefinition('console.command.secrets_encrypt_from_local');
  1710. return;
  1711. }
  1713. $loader->load('secrets.php');
  1715. $container->getDefinition('secrets.vault')->replaceArgument(0, $config['vault_directory']);
  1717. if ($config['local_dotenv_file']) {
  1718. $container->getDefinition('secrets.local_vault')->replaceArgument(0, $config['local_dotenv_file']);
  1719. } else {
  1720. $container->removeDefinition('secrets.local_vault');
  1721. }
  1723. if ($config['decryption_env_var']) {
  1724. if (!preg_match('/^(?:[-.\w]*+:)*+\w++$/', $config['decryption_env_var'])) {
  1725. throw new InvalidArgumentException(sprintf('Invalid value "%s" set as "decryption_env_var": only "word" characters are allowed.', $config['decryption_env_var']));
  1726. }
  1728. if (ContainerBuilder::willBeAvailable('symfony/string', LazyString::class, ['symfony/framework-bundle'], true)) {
  1729. $container->getDefinition('secrets.decryption_key')->replaceArgument(1, $config['decryption_env_var']);
  1730. } else {
  1731. $container->getDefinition('secrets.vault')->replaceArgument(1, "%env({$config['decryption_env_var']})%");
  1732. $container->removeDefinition('secrets.decryption_key');
  1733. }
  1734. } else {
  1735. $container->getDefinition('secrets.vault')->replaceArgument(1, null);
  1736. $container->removeDefinition('secrets.decryption_key');
  1737. }
  1738. }
  1740. private function registerSecurityCsrfConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  1741. {
  1742. if (!$this->isConfigEnabled($container, $config)) {
  1743. return;
  1744. }
  1746. if (!class_exists(\Symfony\Component\Security\Csrf\CsrfToken::class)) {
  1747. throw new LogicException('CSRF support cannot be enabled as the Security CSRF component is not installed. Try running "composer require symfony/security-csrf".');
  1748. }
  1750. if (!$this->sessionConfigEnabled) {
  1751. throw new \LogicException('CSRF protection needs sessions to be enabled.');
  1752. }
  1754. // Enable services for CSRF protection (even without forms)
  1755. $loader->load('security_csrf.php');
  1757. if (!class_exists(CsrfExtension::class)) {
  1758. $container->removeDefinition('twig.extension.security_csrf');
  1759. }
  1760. }
  1762. private function registerSerializerConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  1763. {
  1764. $loader->load('serializer.php');
  1765. if ($container->getParameter('kernel.debug')) {
  1766. $container->removeDefinition('serializer.mapping.cache_class_metadata_factory');
  1767. }
  1769. $chainLoader = $container->getDefinition('serializer.mapping.chain_loader');
  1771. if (!$this->propertyAccessConfigEnabled) {
  1772. $container->removeAlias('serializer.property_accessor');
  1773. $container->removeDefinition('serializer.normalizer.object');
  1774. }
  1776. if (!class_exists(Yaml::class)) {
  1777. $container->removeDefinition('serializer.encoder.yaml');
  1778. }
  1780. if (!class_exists(UnwrappingDenormalizer::class) || !$this->propertyAccessConfigEnabled) {
  1781. $container->removeDefinition('serializer.denormalizer.unwrapping');
  1782. }
  1784. if (!class_exists(Headers::class)) {
  1785. $container->removeDefinition('serializer.normalizer.mime_message');
  1786. }
  1788. $serializerLoaders = [];
  1789. if (isset($config['enable_annotations']) && $config['enable_annotations']) {
  1790. if (\PHP_VERSION_ID < 80000 && !$this->annotationsConfigEnabled) {
  1791. throw new \LogicException('"enable_annotations" on the serializer cannot be set as the PHP version is lower than 8 and Annotations support is disabled. Consider upgrading PHP.');
  1792. }
  1794. $annotationLoader = new Definition(
  1795. 'Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader',
  1796. [new Reference('annotation_reader', ContainerInterface::NULL_ON_INVALID_REFERENCE)]
  1797. );
  1798. $annotationLoader->setPublic(false);
  1800. $serializerLoaders[] = $annotationLoader;
  1801. }
  1803. $fileRecorder = function ($extension, $path) use (&$serializerLoaders) {
  1804. $definition = new Definition(\in_array($extension, ['yaml', 'yml']) ? 'Symfony\Component\Serializer\Mapping\Loader\YamlFileLoader' : 'Symfony\Component\Serializer\Mapping\Loader\XmlFileLoader', [$path]);
  1805. $definition->setPublic(false);
  1806. $serializerLoaders[] = $definition;
  1807. };
  1809. foreach ($container->getParameter('kernel.bundles_metadata') as $bundle) {
  1810. $configDir = is_dir($bundle['path'].'/Resources/config') ? $bundle['path'].'/Resources/config' : $bundle['path'].'/config';
  1812. if ($container->fileExists($file = $configDir.'/serialization.xml', false)) {
  1813. $fileRecorder('xml', $file);
  1814. }
  1816. if (
  1817. $container->fileExists($file = $configDir.'/serialization.yaml', false) ||
  1818. $container->fileExists($file = $configDir.'/serialization.yml', false)
  1819. ) {
  1820. $fileRecorder('yml', $file);
  1821. }
  1823. if ($container->fileExists($dir = $configDir.'/serialization', '/^$/')) {
  1824. $this->registerMappingFilesFromDir($dir, $fileRecorder);
  1825. }
  1826. }
  1828. $projectDir = $container->getParameter('kernel.project_dir');
  1829. if ($container->fileExists($dir = $projectDir.'/config/serializer', '/^$/')) {
  1830. $this->registerMappingFilesFromDir($dir, $fileRecorder);
  1831. }
  1833. $this->registerMappingFilesFromConfig($container, $config, $fileRecorder);
  1835. $chainLoader->replaceArgument(0, $serializerLoaders);
  1836. $container->getDefinition('serializer.mapping.cache_warmer')->replaceArgument(0, $serializerLoaders);
  1838. if (isset($config['name_converter']) && $config['name_converter']) {
  1839. $container->getDefinition('serializer.name_converter.metadata_aware')->setArgument(1, new Reference($config['name_converter']));
  1840. }
  1842. if (isset($config['circular_reference_handler']) && $config['circular_reference_handler']) {
  1843. $arguments = $container->getDefinition('serializer.normalizer.object')->getArguments();
  1844. $context = ($arguments[6] ?? []) + ['circular_reference_handler' => new Reference($config['circular_reference_handler'])];
  1845. $container->getDefinition('serializer.normalizer.object')->setArgument(5, null);
  1846. $container->getDefinition('serializer.normalizer.object')->setArgument(6, $context);
  1847. }
  1849. if ($config['max_depth_handler'] ?? false) {
  1850. $defaultContext = $container->getDefinition('serializer.normalizer.object')->getArgument(6);
  1851. $defaultContext += ['max_depth_handler' => new Reference($config['max_depth_handler'])];
  1852. $container->getDefinition('serializer.normalizer.object')->replaceArgument(6, $defaultContext);
  1853. }
  1855. if (isset($config['default_context']) && $config['default_context']) {
  1856. $container->setParameter('serializer.default_context', $config['default_context']);
  1857. }
  1858. }
  1860. private function registerPropertyInfoConfiguration(ContainerBuilder $container, PhpFileLoader $loader)
  1861. {
  1862. if (!interface_exists(PropertyInfoExtractorInterface::class)) {
  1863. throw new LogicException('PropertyInfo support cannot be enabled as the PropertyInfo component is not installed. Try running "composer require symfony/property-info".');
  1864. }
  1866. $loader->load('property_info.php');
  1868. if (
  1869. ContainerBuilder::willBeAvailable('phpstan/phpdoc-parser', PhpDocParser::class, ['symfony/framework-bundle', 'symfony/property-info'], true)
  1870. && ContainerBuilder::willBeAvailable('phpdocumentor/type-resolver', ContextFactory::class, ['symfony/framework-bundle', 'symfony/property-info'], true)
  1871. ) {
  1872. $definition = $container->register('property_info.phpstan_extractor', PhpStanExtractor::class);
  1873. $definition->addTag('property_info.type_extractor', ['priority' => -1000]);
  1874. }
  1876. if (ContainerBuilder::willBeAvailable('phpdocumentor/reflection-docblock', DocBlockFactoryInterface::class, ['symfony/framework-bundle', 'symfony/property-info'], true)) {
  1877. $definition = $container->register('property_info.php_doc_extractor', 'Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor');
  1878. $definition->addTag('property_info.description_extractor', ['priority' => -1000]);
  1879. $definition->addTag('property_info.type_extractor', ['priority' => -1001]);
  1880. }
  1882. if ($container->getParameter('kernel.debug')) {
  1883. $container->removeDefinition('property_info.cache');
  1884. }
  1885. }
  1887. private function registerLockConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  1888. {
  1889. $loader->load('lock.php');
  1891. foreach ($config['resources'] as $resourceName => $resourceStores) {
  1892. if (0 === \count($resourceStores)) {
  1893. continue;
  1894. }
  1896. // Generate stores
  1897. $storeDefinitions = [];
  1898. foreach ($resourceStores as $storeDsn) {
  1899. $storeDsn = $container->resolveEnvPlaceholders($storeDsn, null, $usedEnvs);
  1900. $storeDefinition = new Definition(interface_exists(StoreInterface::class) ? StoreInterface::class : PersistingStoreInterface::class);
  1901. $storeDefinition->setFactory([StoreFactory::class, 'createStore']);
  1902. $storeDefinition->setArguments([$storeDsn]);
  1904. $container->setDefinition($storeDefinitionId = '.lock.'.$resourceName.'.store.'.$container->hash($storeDsn), $storeDefinition);
  1906. $storeDefinition = new Reference($storeDefinitionId);
  1908. $storeDefinitions[] = $storeDefinition;
  1909. }
  1911. // Wrap array of stores with CombinedStore
  1912. if (\count($storeDefinitions) > 1) {
  1913. $combinedDefinition = new ChildDefinition('lock.store.combined.abstract');
  1914. $combinedDefinition->replaceArgument(0, $storeDefinitions);
  1915. $container->setDefinition('lock.'.$resourceName.'.store', $combinedDefinition)->setDeprecated('symfony/framework-bundle', '5.2', 'The "%service_id%" service is deprecated, use "lock.'.$resourceName.'.factory" instead.');
  1916. $container->setDefinition($storeDefinitionId = '.lock.'.$resourceName.'.store.'.$container->hash($resourceStores), $combinedDefinition);
  1917. } else {
  1918. $container->setAlias('lock.'.$resourceName.'.store', (new Alias($storeDefinitionId, false))->setDeprecated('symfony/framework-bundle', '5.2', 'The "%alias_id%" alias is deprecated, use "lock.'.$resourceName.'.factory" instead.'));
  1919. }
  1921. // Generate factories for each resource
  1922. $factoryDefinition = new ChildDefinition('lock.factory.abstract');
  1923. $factoryDefinition->replaceArgument(0, new Reference($storeDefinitionId));
  1924. $container->setDefinition('lock.'.$resourceName.'.factory', $factoryDefinition);
  1926. // Generate services for lock instances
  1927. $lockDefinition = new Definition(Lock::class);
  1928. $lockDefinition->setPublic(false);
  1929. $lockDefinition->setFactory([new Reference('lock.'.$resourceName.'.factory'), 'createLock']);
  1930. $lockDefinition->setArguments([$resourceName]);
  1931. $container->setDefinition('lock.'.$resourceName, $lockDefinition)->setDeprecated('symfony/framework-bundle', '5.2', 'The "%service_id%" service is deprecated, use "lock.'.$resourceName.'.factory" instead.');
  1933. // provide alias for default resource
  1934. if ('default' === $resourceName) {
  1935. $container->setAlias('lock.store', (new Alias($storeDefinitionId, false))->setDeprecated('symfony/framework-bundle', '5.2', 'The "%alias_id%" alias is deprecated, use "lock.factory" instead.'));
  1936. $container->setAlias('lock.factory', new Alias('lock.'.$resourceName.'.factory', false));
  1937. $container->setAlias('lock', (new Alias('lock.'.$resourceName, false))->setDeprecated('symfony/framework-bundle', '5.2', 'The "%alias_id%" alias is deprecated, use "lock.factory" instead.'));
  1938. $container->setAlias(PersistingStoreInterface::class, (new Alias($storeDefinitionId, false))->setDeprecated('symfony/framework-bundle', '5.2', 'The "%alias_id%" alias is deprecated, use "'.LockFactory::class.'" instead.'));
  1939. $container->setAlias(LockFactory::class, new Alias('lock.factory', false));
  1940. $container->setAlias(LockInterface::class, (new Alias('lock.'.$resourceName, false))->setDeprecated('symfony/framework-bundle', '5.2', 'The "%alias_id%" alias is deprecated, use "'.LockFactory::class.'" instead.'));
  1941. } else {
  1942. $container->registerAliasForArgument($storeDefinitionId, PersistingStoreInterface::class, $resourceName.'.lock.store')->setDeprecated('symfony/framework-bundle', '5.2', 'The "%alias_id%" alias is deprecated, use "'.LockFactory::class.' '.$resourceName.'LockFactory" instead.');
  1943. $container->registerAliasForArgument('lock.'.$resourceName.'.factory', LockFactory::class, $resourceName.'.lock.factory');
  1944. $container->registerAliasForArgument('lock.'.$resourceName, LockInterface::class, $resourceName.'.lock')->setDeprecated('symfony/framework-bundle', '5.2', 'The "%alias_id%" alias is deprecated, use "'.LockFactory::class.' $'.$resourceName.'LockFactory" instead.');
  1945. }
  1946. }
  1947. }
  1949. private function registerMessengerConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader, array $validationConfig)
  1950. {
  1951. if (!interface_exists(MessageBusInterface::class)) {
  1952. throw new LogicException('Messenger support cannot be enabled as the Messenger component is not installed. Try running "composer require symfony/messenger".');
  1953. }
  1955. $loader->load('messenger.php');
  1957. if (!interface_exists(DenormalizerInterface::class)) {
  1958. $container->removeDefinition('serializer.normalizer.flatten_exception');
  1959. }
  1961. if (ContainerBuilder::willBeAvailable('symfony/amqp-messenger', AmqpTransportFactory::class, ['symfony/framework-bundle', 'symfony/messenger'], true)) {
  1962. $container->getDefinition('messenger.transport.amqp.factory')->addTag('messenger.transport_factory');
  1963. }
  1965. if (ContainerBuilder::willBeAvailable('symfony/redis-messenger', RedisTransportFactory::class, ['symfony/framework-bundle', 'symfony/messenger'], true)) {
  1966. $container->getDefinition('messenger.transport.redis.factory')->addTag('messenger.transport_factory');
  1967. }
  1969. if (ContainerBuilder::willBeAvailable('symfony/amazon-sqs-messenger', AmazonSqsTransportFactory::class, ['symfony/framework-bundle', 'symfony/messenger'], true)) {
  1970. $container->getDefinition('messenger.transport.sqs.factory')->addTag('messenger.transport_factory');
  1971. }
  1973. if (ContainerBuilder::willBeAvailable('symfony/beanstalkd-messenger', BeanstalkdTransportFactory::class, ['symfony/framework-bundle', 'symfony/messenger'], true)) {
  1974. $container->getDefinition('messenger.transport.beanstalkd.factory')->addTag('messenger.transport_factory');
  1975. }
  1977. if (null === $config['default_bus'] && 1 === \count($config['buses'])) {
  1978. $config['default_bus'] = key($config['buses']);
  1979. }
  1981. $defaultMiddleware = [
  1982. 'before' => [
  1983. ['id' => 'add_bus_name_stamp_middleware'],
  1984. ['id' => 'reject_redelivered_message_middleware'],
  1985. ['id' => 'dispatch_after_current_bus'],
  1986. ['id' => 'failed_message_processing_middleware'],
  1987. ],
  1988. 'after' => [
  1989. ['id' => 'send_message'],
  1990. ['id' => 'handle_message'],
  1991. ],
  1992. ];
  1993. foreach ($config['buses'] as $busId => $bus) {
  1994. $middleware = $bus['middleware'];
  1996. if ($bus['default_middleware']) {
  1997. if ('allow_no_handlers' === $bus['default_middleware']) {
  1998. $defaultMiddleware['after'][1]['arguments'] = [true];
  1999. } else {
  2000. unset($defaultMiddleware['after'][1]['arguments']);
  2001. }
  2003. // argument to add_bus_name_stamp_middleware
  2004. $defaultMiddleware['before'][0]['arguments'] = [$busId];
  2006. $middleware = array_merge($defaultMiddleware['before'], $middleware, $defaultMiddleware['after']);
  2007. }
  2009. foreach ($middleware as $middlewareItem) {
  2010. if (!$validationConfig['enabled'] && \in_array($middlewareItem['id'], ['validation', 'messenger.middleware.validation'], true)) {
  2011. throw new LogicException('The Validation middleware is only available when the Validator component is installed and enabled. Try running "composer require symfony/validator".');
  2012. }
  2013. }
  2015. if ($container->getParameter('kernel.debug') && class_exists(Stopwatch::class)) {
  2016. array_unshift($middleware, ['id' => 'traceable', 'arguments' => [$busId]]);
  2017. }
  2019. $container->setParameter($busId.'.middleware', $middleware);
  2020. $container->register($busId, MessageBus::class)->addArgument([])->addTag('messenger.bus');
  2022. if ($busId === $config['default_bus']) {
  2023. $container->setAlias('messenger.default_bus', $busId)->setPublic(true);
  2024. $container->setAlias(MessageBusInterface::class, $busId);
  2025. } else {
  2026. $container->registerAliasForArgument($busId, MessageBusInterface::class);
  2027. }
  2028. }
  2030. if (empty($config['transports'])) {
  2031. $container->removeDefinition('messenger.transport.symfony_serializer');
  2032. $container->removeDefinition('messenger.transport.amqp.factory');
  2033. $container->removeDefinition('messenger.transport.redis.factory');
  2034. $container->removeDefinition('messenger.transport.sqs.factory');
  2035. $container->removeDefinition('messenger.transport.beanstalkd.factory');
  2036. $container->removeAlias(SerializerInterface::class);
  2037. } else {
  2038. $container->getDefinition('messenger.transport.symfony_serializer')
  2039. ->replaceArgument(1, $config['serializer']['symfony_serializer']['format'])
  2040. ->replaceArgument(2, $config['serializer']['symfony_serializer']['context']);
  2041. $container->setAlias('messenger.default_serializer', $config['serializer']['default_serializer']);
  2042. }
  2044. $failureTransports = [];
  2045. if ($config['failure_transport']) {
  2046. if (!isset($config['transports'][$config['failure_transport']])) {
  2047. throw new LogicException(sprintf('Invalid Messenger configuration: the failure transport "%s" is not a valid transport or service id.', $config['failure_transport']));
  2048. }
  2050. $container->setAlias('messenger.failure_transports.default', 'messenger.transport.'.$config['failure_transport']);
  2051. $failureTransports[] = $config['failure_transport'];
  2052. }
  2054. $failureTransportsByName = [];
  2055. foreach ($config['transports'] as $name => $transport) {
  2056. if ($transport['failure_transport']) {
  2057. $failureTransports[] = $transport['failure_transport'];
  2058. $failureTransportsByName[$name] = $transport['failure_transport'];
  2059. } elseif ($config['failure_transport']) {
  2060. $failureTransportsByName[$name] = $config['failure_transport'];
  2061. }
  2062. }
  2064. $senderAliases = [];
  2065. $transportRetryReferences = [];
  2066. foreach ($config['transports'] as $name => $transport) {
  2067. $serializerId = $transport['serializer'] ?? 'messenger.default_serializer';
  2068. $transportDefinition = (new Definition(TransportInterface::class))
  2069. ->setFactory([new Reference('messenger.transport_factory'), 'createTransport'])
  2070. ->setArguments([$transport['dsn'], $transport['options'] + ['transport_name' => $name], new Reference($serializerId)])
  2071. ->addTag('messenger.receiver', [
  2072. 'alias' => $name,
  2073. 'is_failure_transport' => \in_array($name, $failureTransports),
  2074. ]
  2075. )
  2076. ;
  2077. $container->setDefinition($transportId = 'messenger.transport.'.$name, $transportDefinition);
  2078. $senderAliases[$name] = $transportId;
  2080. if (null !== $transport['retry_strategy']['service']) {
  2081. $transportRetryReferences[$name] = new Reference($transport['retry_strategy']['service']);
  2082. } else {
  2083. $retryServiceId = sprintf('messenger.retry.multiplier_retry_strategy.%s', $name);
  2084. $retryDefinition = new ChildDefinition('messenger.retry.abstract_multiplier_retry_strategy');
  2085. $retryDefinition
  2086. ->replaceArgument(0, $transport['retry_strategy']['max_retries'])
  2087. ->replaceArgument(1, $transport['retry_strategy']['delay'])
  2088. ->replaceArgument(2, $transport['retry_strategy']['multiplier'])
  2089. ->replaceArgument(3, $transport['retry_strategy']['max_delay']);
  2090. $container->setDefinition($retryServiceId, $retryDefinition);
  2092. $transportRetryReferences[$name] = new Reference($retryServiceId);
  2093. }
  2094. }
  2096. $senderReferences = [];
  2097. // alias => service_id
  2098. foreach ($senderAliases as $alias => $serviceId) {
  2099. $senderReferences[$alias] = new Reference($serviceId);
  2100. }
  2101. // service_id => service_id
  2102. foreach ($senderAliases as $serviceId) {
  2103. $senderReferences[$serviceId] = new Reference($serviceId);
  2104. }
  2106. foreach ($config['transports'] as $name => $transport) {
  2107. if ($transport['failure_transport']) {
  2108. if (!isset($senderReferences[$transport['failure_transport']])) {
  2109. throw new LogicException(sprintf('Invalid Messenger configuration: the failure transport "%s" is not a valid transport or service id.', $transport['failure_transport']));
  2110. }
  2111. }
  2112. }
  2114. $failureTransportReferencesByTransportName = array_map(function ($failureTransportName) use ($senderReferences) {
  2115. return $senderReferences[$failureTransportName];
  2116. }, $failureTransportsByName);
  2118. $messageToSendersMapping = [];
  2119. foreach ($config['routing'] as $message => $messageConfiguration) {
  2120. if ('*' !== $message && !class_exists($message) && !interface_exists($message, false)) {
  2121. throw new LogicException(sprintf('Invalid Messenger routing configuration: class or interface "%s" not found.', $message));
  2122. }
  2124. // make sure senderAliases contains all senders
  2125. foreach ($messageConfiguration['senders'] as $sender) {
  2126. if (!isset($senderReferences[$sender])) {
  2127. throw new LogicException(sprintf('Invalid Messenger routing configuration: the "%s" class is being routed to a sender called "%s". This is not a valid transport or service id.', $message, $sender));
  2128. }
  2129. }
  2131. $messageToSendersMapping[$message] = $messageConfiguration['senders'];
  2132. }
  2134. $sendersServiceLocator = ServiceLocatorTagPass::register($container, $senderReferences);
  2136. $container->getDefinition('messenger.senders_locator')
  2137. ->replaceArgument(0, $messageToSendersMapping)
  2138. ->replaceArgument(1, $sendersServiceLocator)
  2139. ;
  2141. $container->getDefinition('messenger.retry.send_failed_message_for_retry_listener')
  2142. ->replaceArgument(0, $sendersServiceLocator)
  2143. ;
  2145. $container->getDefinition('messenger.retry_strategy_locator')
  2146. ->replaceArgument(0, $transportRetryReferences);
  2148. if (\count($failureTransports) > 0) {
  2149. $container->getDefinition('console.command.messenger_failed_messages_retry')
  2150. ->replaceArgument(0, $config['failure_transport']);
  2151. $container->getDefinition('console.command.messenger_failed_messages_show')
  2152. ->replaceArgument(0, $config['failure_transport']);
  2153. $container->getDefinition('console.command.messenger_failed_messages_remove')
  2154. ->replaceArgument(0, $config['failure_transport']);
  2156. $failureTransportsByTransportNameServiceLocator = ServiceLocatorTagPass::register($container, $failureTransportReferencesByTransportName);
  2157. $container->getDefinition('messenger.failure.send_failed_message_to_failure_transport_listener')
  2158. ->replaceArgument(0, $failureTransportsByTransportNameServiceLocator);
  2159. } else {
  2160. $container->removeDefinition('messenger.failure.send_failed_message_to_failure_transport_listener');
  2161. $container->removeDefinition('console.command.messenger_failed_messages_retry');
  2162. $container->removeDefinition('console.command.messenger_failed_messages_show');
  2163. $container->removeDefinition('console.command.messenger_failed_messages_remove');
  2164. }
  2166. if (false === $config['reset_on_message']) {
  2167. throw new LogicException('The "framework.messenger.reset_on_message" configuration option can be set to "true" only. To prevent services resetting after each message you can set the "--no-reset" option in "messenger:consume" command.');
  2168. }
  2170. if (!$container->hasDefinition('console.command.messenger_consume_messages')) {
  2171. $container->removeDefinition('messenger.listener.reset_services');
  2172. } elseif (null === $config['reset_on_message']) {
  2173. trigger_deprecation('symfony/framework-bundle', '5.4', 'Not setting the "framework.messenger.reset_on_message" configuration option is deprecated, it will default to "true" in version 6.0.');
  2175. $container->getDefinition('console.command.messenger_consume_messages')->replaceArgument(5, null);
  2176. $container->removeDefinition('messenger.listener.reset_services');
  2177. }
  2178. }
  2180. private function registerCacheConfiguration(array $config, ContainerBuilder $container)
  2181. {
  2182. if (!class_exists(DefaultMarshaller::class)) {
  2183. $container->removeDefinition('cache.default_marshaller');
  2184. }
  2186. if (!class_exists(DoctrineAdapter::class)) {
  2187. $container->removeDefinition('cache.adapter.doctrine');
  2188. }
  2190. if (!class_exists(DoctrineDbalAdapter::class)) {
  2191. $container->removeDefinition('cache.adapter.doctrine_dbal');
  2192. }
  2194. $version = new Parameter('container.build_id');
  2195. $container->getDefinition('cache.adapter.apcu')->replaceArgument(2, $version);
  2196. $container->getDefinition('cache.adapter.system')->replaceArgument(2, $version);
  2197. $container->getDefinition('cache.adapter.filesystem')->replaceArgument(2, $config['directory']);
  2199. if (isset($config['prefix_seed'])) {
  2200. $container->setParameter('cache.prefix.seed', $config['prefix_seed']);
  2201. }
  2202. if ($container->hasParameter('cache.prefix.seed')) {
  2203. // Inline any env vars referenced in the parameter
  2204. $container->setParameter('cache.prefix.seed', $container->resolveEnvPlaceholders($container->getParameter('cache.prefix.seed'), true));
  2205. }
  2206. foreach (['doctrine', 'psr6', 'redis', 'memcached', 'doctrine_dbal', 'pdo'] as $name) {
  2207. if (isset($config[$name = 'default_'.$name.'_provider'])) {
  2208. $container->setAlias('cache.'.$name, new Alias(CachePoolPass::getServiceProvider($container, $config[$name]), false));
  2209. }
  2210. }
  2211. foreach (['app', 'system'] as $name) {
  2212. $config['pools']['cache.'.$name] = [
  2213. 'adapters' => [$config[$name]],
  2214. 'public' => true,
  2215. 'tags' => false,
  2216. ];
  2217. }
  2218. foreach ($config['pools'] as $name => $pool) {
  2219. $pool['adapters'] = $pool['adapters'] ?: ['cache.app'];
  2221. $isRedisTagAware = ['cache.adapter.redis_tag_aware'] === $pool['adapters'];
  2222. foreach ($pool['adapters'] as $provider => $adapter) {
  2223. if (($config['pools'][$adapter]['adapters'] ?? null) === ['cache.adapter.redis_tag_aware']) {
  2224. $isRedisTagAware = true;
  2225. } elseif ($config['pools'][$adapter]['tags'] ?? false) {
  2226. $pool['adapters'][$provider] = $adapter = '.'.$adapter.'.inner';
  2227. }
  2228. }
  2230. if (1 === \count($pool['adapters'])) {
  2231. if (!isset($pool['provider']) && !\is_int($provider)) {
  2232. $pool['provider'] = $provider;
  2233. }
  2234. $definition = new ChildDefinition($adapter);
  2235. } else {
  2236. $definition = new Definition(ChainAdapter::class, [$pool['adapters'], 0]);
  2237. $pool['reset'] = 'reset';
  2238. }
  2240. if ($isRedisTagAware && 'cache.app' === $name) {
  2241. $container->setAlias('cache.app.taggable', $name);
  2242. } elseif ($isRedisTagAware) {
  2243. $tagAwareId = $name;
  2244. $container->setAlias('.'.$name.'.inner', $name);
  2245. } elseif ($pool['tags']) {
  2246. if (true !== $pool['tags'] && ($config['pools'][$pool['tags']]['tags'] ?? false)) {
  2247. $pool['tags'] = '.'.$pool['tags'].'.inner';
  2248. }
  2249. $container->register($name, TagAwareAdapter::class)
  2250. ->addArgument(new Reference('.'.$name.'.inner'))
  2251. ->addArgument(true !== $pool['tags'] ? new Reference($pool['tags']) : null)
  2252. ->setPublic($pool['public'])
  2253. ;
  2255. if (method_exists(TagAwareAdapter::class, 'setLogger')) {
  2256. $container
  2257. ->getDefinition($name)
  2258. ->addMethodCall('setLogger', [new Reference('logger', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)]);
  2259. }
  2261. $pool['name'] = $tagAwareId = $name;
  2262. $pool['public'] = false;
  2263. $name = '.'.$name.'.inner';
  2264. } elseif (!\in_array($name, ['cache.app', 'cache.system'], true)) {
  2265. $tagAwareId = '.'.$name.'.taggable';
  2266. $container->register($tagAwareId, TagAwareAdapter::class)
  2267. ->addArgument(new Reference($name))
  2268. ;
  2269. }
  2271. if (!\in_array($name, ['cache.app', 'cache.system'], true)) {
  2272. $container->registerAliasForArgument($tagAwareId, TagAwareCacheInterface::class, $pool['name'] ?? $name);
  2273. $container->registerAliasForArgument($name, CacheInterface::class, $pool['name'] ?? $name);
  2274. $container->registerAliasForArgument($name, CacheItemPoolInterface::class, $pool['name'] ?? $name);
  2275. }
  2277. $definition->setPublic($pool['public']);
  2278. unset($pool['adapters'], $pool['public'], $pool['tags']);
  2280. $definition->addTag('cache.pool', $pool);
  2281. $container->setDefinition($name, $definition);
  2282. }
  2284. if (method_exists(PropertyAccessor::class, 'createCache')) {
  2285. $propertyAccessDefinition = $container->register('cache.property_access', AdapterInterface::class);
  2286. $propertyAccessDefinition->setPublic(false);
  2288. if (!$container->getParameter('kernel.debug')) {
  2289. $propertyAccessDefinition->setFactory([PropertyAccessor::class, 'createCache']);
  2290. $propertyAccessDefinition->setArguments(['', 0, $version, new Reference('logger', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)]);
  2291. $propertyAccessDefinition->addTag('cache.pool', ['clearer' => 'cache.system_clearer']);
  2292. $propertyAccessDefinition->addTag('monolog.logger', ['channel' => 'cache']);
  2293. } else {
  2294. $propertyAccessDefinition->setClass(ArrayAdapter::class);
  2295. $propertyAccessDefinition->setArguments([0, false]);
  2296. }
  2297. }
  2298. }
  2300. private function registerHttpClientConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader, array $profilerConfig)
  2301. {
  2302. $loader->load('http_client.php');
  2304. $options = $config['default_options'] ?? [];
  2305. $retryOptions = $options['retry_failed'] ?? ['enabled' => false];
  2306. unset($options['retry_failed']);
  2307. $container->getDefinition('http_client')->setArguments([$options, $config['max_host_connections'] ?? 6]);
  2309. if (!$hasPsr18 = ContainerBuilder::willBeAvailable('psr/http-client', ClientInterface::class, ['symfony/framework-bundle', 'symfony/http-client'], true)) {
  2310. $container->removeDefinition('psr18.http_client');
  2311. $container->removeAlias(ClientInterface::class);
  2312. }
  2314. if (!ContainerBuilder::willBeAvailable('php-http/httplug', HttpClient::class, ['symfony/framework-bundle', 'symfony/http-client'], true)) {
  2315. $container->removeDefinition(HttpClient::class);
  2316. }
  2318. if ($this->isConfigEnabled($container, $retryOptions)) {
  2319. $this->registerRetryableHttpClient($retryOptions, 'http_client', $container);
  2320. }
  2322. $httpClientId = ($retryOptions['enabled'] ?? false) ? 'http_client.retryable.inner' : ($this->isConfigEnabled($container, $profilerConfig) ? '.debug.http_client.inner' : 'http_client');
  2323. foreach ($config['scoped_clients'] as $name => $scopeConfig) {
  2324. if ('http_client' === $name) {
  2325. throw new InvalidArgumentException(sprintf('Invalid scope name: "%s" is reserved.', $name));
  2326. }
  2328. $scope = $scopeConfig['scope'] ?? null;
  2329. unset($scopeConfig['scope']);
  2330. $retryOptions = $scopeConfig['retry_failed'] ?? ['enabled' => false];
  2331. unset($scopeConfig['retry_failed']);
  2333. if (null === $scope) {
  2334. $baseUri = $scopeConfig['base_uri'];
  2335. unset($scopeConfig['base_uri']);
  2337. $container->register($name, ScopingHttpClient::class)
  2338. ->setFactory([ScopingHttpClient::class, 'forBaseUri'])
  2339. ->setArguments([new Reference($httpClientId), $baseUri, $scopeConfig])
  2340. ->addTag('http_client.client')
  2341. ;
  2342. } else {
  2343. $container->register($name, ScopingHttpClient::class)
  2344. ->setArguments([new Reference($httpClientId), [$scope => $scopeConfig], $scope])
  2345. ->addTag('http_client.client')
  2346. ;
  2347. }
  2349. if ($this->isConfigEnabled($container, $retryOptions)) {
  2350. $this->registerRetryableHttpClient($retryOptions, $name, $container);
  2351. }
  2353. $container->registerAliasForArgument($name, HttpClientInterface::class);
  2355. if ($hasPsr18) {
  2356. $container->setDefinition('psr18.'.$name, new ChildDefinition('psr18.http_client'))
  2357. ->replaceArgument(0, new Reference($name));
  2359. $container->registerAliasForArgument('psr18.'.$name, ClientInterface::class, $name);
  2360. }
  2361. }
  2363. if ($responseFactoryId = $config['mock_response_factory'] ?? null) {
  2364. $container->register($httpClientId.'.mock_client', MockHttpClient::class)
  2365. ->setDecoratedService($httpClientId, null, -10) // lower priority than TraceableHttpClient
  2366. ->setArguments([new Reference($responseFactoryId)]);
  2367. }
  2368. }
  2370. private function registerRetryableHttpClient(array $options, string $name, ContainerBuilder $container)
  2371. {
  2372. if (!class_exists(RetryableHttpClient::class)) {
  2373. throw new LogicException('Support for retrying failed requests requires symfony/http-client 5.2 or higher, try upgrading.');
  2374. }
  2376. if (null !== $options['retry_strategy']) {
  2377. $retryStrategy = new Reference($options['retry_strategy']);
  2378. } else {
  2379. $retryStrategy = new ChildDefinition('http_client.abstract_retry_strategy');
  2380. $codes = [];
  2381. foreach ($options['http_codes'] as $code => $codeOptions) {
  2382. if ($codeOptions['methods']) {
  2383. $codes[$code] = $codeOptions['methods'];
  2384. } else {
  2385. $codes[] = $code;
  2386. }
  2387. }
  2389. $retryStrategy
  2390. ->replaceArgument(0, $codes ?: GenericRetryStrategy::DEFAULT_RETRY_STATUS_CODES)
  2391. ->replaceArgument(1, $options['delay'])
  2392. ->replaceArgument(2, $options['multiplier'])
  2393. ->replaceArgument(3, $options['max_delay'])
  2394. ->replaceArgument(4, $options['jitter']);
  2395. $container->setDefinition($name.'.retry_strategy', $retryStrategy);
  2397. $retryStrategy = new Reference($name.'.retry_strategy');
  2398. }
  2400. $container
  2401. ->register($name.'.retryable', RetryableHttpClient::class)
  2402. ->setDecoratedService($name, null, 10) // higher priority than TraceableHttpClient
  2403. ->setArguments([new Reference($name.'.retryable.inner'), $retryStrategy, $options['max_retries'], new Reference('logger')])
  2404. ->addTag('monolog.logger', ['channel' => 'http_client']);
  2405. }
  2407. private function registerMailerConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  2408. {
  2409. if (!class_exists(Mailer::class)) {
  2410. throw new LogicException('Mailer support cannot be enabled as the component is not installed. Try running "composer require symfony/mailer".');
  2411. }
  2413. $loader->load('mailer.php');
  2414. $loader->load('mailer_transports.php');
  2415. if (!\count($config['transports']) && null === $config['dsn']) {
  2416. $config['dsn'] = 'smtp://null';
  2417. }
  2418. $transports = $config['dsn'] ? ['main' => $config['dsn']] : $config['transports'];
  2419. $container->getDefinition('mailer.transports')->setArgument(0, $transports);
  2420. $container->getDefinition('mailer.default_transport')->setArgument(0, current($transports));
  2422. $container->removeDefinition('mailer.logger_message_listener');
  2423. $container->setAlias('mailer.logger_message_listener', (new Alias('mailer.message_logger_listener'))->setDeprecated('symfony/framework-bundle', '5.2', 'The "%alias_id%" alias is deprecated, use "mailer.message_logger_listener" instead.'));
  2425. $mailer = $container->getDefinition('mailer.mailer');
  2426. if (false === $messageBus = $config['message_bus']) {
  2427. $mailer->replaceArgument(1, null);
  2428. } else {
  2429. $mailer->replaceArgument(1, $messageBus ? new Reference($messageBus) : new Reference('messenger.default_bus', ContainerInterface::NULL_ON_INVALID_REFERENCE));
  2430. }
  2432. $classToServices = [
  2433. GmailTransportFactory::class => 'mailer.transport_factory.gmail',
  2434. MailgunTransportFactory::class => 'mailer.transport_factory.mailgun',
  2435. MailjetTransportFactory::class => 'mailer.transport_factory.mailjet',
  2436. MandrillTransportFactory::class => 'mailer.transport_factory.mailchimp',
  2437. PostmarkTransportFactory::class => 'mailer.transport_factory.postmark',
  2438. SendgridTransportFactory::class => 'mailer.transport_factory.sendgrid',
  2439. SendinblueTransportFactory::class => 'mailer.transport_factory.sendinblue',
  2440. SesTransportFactory::class => 'mailer.transport_factory.amazon',
  2441. OhMySmtpTransportFactory::class => 'mailer.transport_factory.ohmysmtp',
  2442. ];
  2444. foreach ($classToServices as $class => $service) {
  2445. $package = substr($service, \strlen('mailer.transport_factory.'));
  2447. if (!ContainerBuilder::willBeAvailable(sprintf('symfony/%s-mailer', 'gmail' === $package ? 'google' : $package), $class, ['symfony/framework-bundle', 'symfony/mailer'], true)) {
  2448. $container->removeDefinition($service);
  2449. }
  2450. }
  2452. $envelopeListener = $container->getDefinition('mailer.envelope_listener');
  2453. $envelopeListener->setArgument(0, $config['envelope']['sender'] ?? null);
  2454. $envelopeListener->setArgument(1, $config['envelope']['recipients'] ?? null);
  2456. if ($config['headers']) {
  2457. $headers = new Definition(Headers::class);
  2458. foreach ($config['headers'] as $name => $data) {
  2459. $value = $data['value'];
  2460. if (\in_array(strtolower($name), ['from', 'to', 'cc', 'bcc', 'reply-to'])) {
  2461. $value = (array) $value;
  2462. }
  2463. $headers->addMethodCall('addHeader', [$name, $value]);
  2464. }
  2465. $messageListener = $container->getDefinition('mailer.message_listener');
  2466. $messageListener->setArgument(0, $headers);
  2467. } else {
  2468. $container->removeDefinition('mailer.message_listener');
  2469. }
  2470. }
  2472. private function registerNotifierConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  2473. {
  2474. if (!class_exists(Notifier::class)) {
  2475. throw new LogicException('Notifier support cannot be enabled as the component is not installed. Try running "composer require symfony/notifier".');
  2476. }
  2478. $loader->load('notifier.php');
  2479. $loader->load('notifier_transports.php');
  2481. if ($config['chatter_transports']) {
  2482. $container->getDefinition('chatter.transports')->setArgument(0, $config['chatter_transports']);
  2483. } else {
  2484. $container->removeDefinition('chatter');
  2485. }
  2486. if ($config['texter_transports']) {
  2487. $container->getDefinition('texter.transports')->setArgument(0, $config['texter_transports']);
  2488. } else {
  2489. $container->removeDefinition('texter');
  2490. }
  2492. if ($this->mailerConfigEnabled) {
  2493. $sender = $container->getDefinition('mailer.envelope_listener')->getArgument(0);
  2494. $container->getDefinition('notifier.channel.email')->setArgument(2, $sender);
  2495. } else {
  2496. $container->removeDefinition('notifier.channel.email');
  2497. }
  2499. if ($this->messengerConfigEnabled) {
  2500. if ($config['notification_on_failed_messages']) {
  2501. $container->getDefinition('notifier.failed_message_listener')->addTag('kernel.event_subscriber');
  2502. }
  2504. // as we have a bus, the channels don't need the transports
  2505. $container->getDefinition('notifier.channel.chat')->setArgument(0, null);
  2506. if ($container->hasDefinition('notifier.channel.email')) {
  2507. $container->getDefinition('notifier.channel.email')->setArgument(0, null);
  2508. }
  2509. $container->getDefinition('notifier.channel.sms')->setArgument(0, null);
  2510. $container->getDefinition('notifier.channel.push')->setArgument(0, null);
  2511. }
  2513. $container->getDefinition('notifier.channel_policy')->setArgument(0, $config['channel_policy']);
  2515. $container->registerForAutoconfiguration(NotifierTransportFactoryInterface::class)
  2516. ->addTag('chatter.transport_factory');
  2518. $container->registerForAutoconfiguration(NotifierTransportFactoryInterface::class)
  2519. ->addTag('texter.transport_factory');
  2521. $classToServices = [
  2522. AllMySmsTransportFactory::class => 'notifier.transport_factory.all-my-sms',
  2523. AmazonSnsTransportFactory::class => 'notifier.transport_factory.amazon-sns',
  2524. ClickatellTransportFactory::class => 'notifier.transport_factory.clickatell',
  2525. DiscordTransportFactory::class => 'notifier.transport_factory.discord',
  2526. EsendexTransportFactory::class => 'notifier.transport_factory.esendex',
  2527. ExpoTransportFactory::class => 'notifier.transport_factory.expo',
  2528. FakeChatTransportFactory::class => 'notifier.transport_factory.fake-chat',
  2529. FakeSmsTransportFactory::class => 'notifier.transport_factory.fake-sms',
  2530. FirebaseTransportFactory::class => 'notifier.transport_factory.firebase',
  2531. FreeMobileTransportFactory::class => 'notifier.transport_factory.free-mobile',
  2532. GatewayApiTransportFactory::class => 'notifier.transport_factory.gateway-api',
  2533. GitterTransportFactory::class => 'notifier.transport_factory.gitter',
  2534. GoogleChatTransportFactory::class => 'notifier.transport_factory.google-chat',
  2535. InfobipTransportFactory::class => 'notifier.transport_factory.infobip',
  2536. IqsmsTransportFactory::class => 'notifier.transport_factory.iqsms',
  2537. LightSmsTransportFactory::class => 'notifier.transport_factory.light-sms',
  2538. LinkedInTransportFactory::class => 'notifier.transport_factory.linked-in',
  2539. MailjetNotifierTransportFactory::class => 'notifier.transport_factory.mailjet',
  2540. MattermostTransportFactory::class => 'notifier.transport_factory.mattermost',
  2541. MercureTransportFactory::class => 'notifier.transport_factory.mercure',
  2542. MessageBirdTransport::class => 'notifier.transport_factory.message-bird',
  2543. MessageMediaTransportFactory::class => 'notifier.transport_factory.message-media',
  2544. MicrosoftTeamsTransportFactory::class => 'notifier.transport_factory.microsoft-teams',
  2545. MobytTransportFactory::class => 'notifier.transport_factory.mobyt',
  2546. NexmoTransportFactory::class => 'notifier.transport_factory.nexmo',
  2547. OctopushTransportFactory::class => 'notifier.transport_factory.octopush',
  2548. OneSignalTransportFactory::class => 'notifier.transport_factory.one-signal',
  2549. OvhCloudTransportFactory::class => 'notifier.transport_factory.ovh-cloud',
  2550. RocketChatTransportFactory::class => 'notifier.transport_factory.rocket-chat',
  2551. SendinblueNotifierTransportFactory::class => 'notifier.transport_factory.sendinblue',
  2552. SinchTransportFactory::class => 'notifier.transport_factory.sinch',
  2553. SlackTransportFactory::class => 'notifier.transport_factory.slack',
  2554. Sms77TransportFactory::class => 'notifier.transport_factory.sms77',
  2555. SmsapiTransportFactory::class => 'notifier.transport_factory.smsapi',
  2556. SmsBiurasTransportFactory::class => 'notifier.transport_factory.sms-biuras',
  2557. SmscTransportFactory::class => 'notifier.transport_factory.smsc',
  2558. SpotHitTransportFactory::class => 'notifier.transport_factory.spot-hit',
  2559. TelegramTransportFactory::class => 'notifier.transport_factory.telegram',
  2560. TelnyxTransportFactory::class => 'notifier.transport_factory.telnyx',
  2561. TurboSmsTransport::class => 'notifier.transport_factory.turbo-sms',
  2562. TwilioTransportFactory::class => 'notifier.transport_factory.twilio',
  2563. VonageTransportFactory::class => 'notifier.transport_factory.vonage',
  2564. YunpianTransportFactory::class => 'notifier.transport_factory.yunpian',
  2565. ZulipTransportFactory::class => 'notifier.transport_factory.zulip',
  2566. ];
  2568. $parentPackages = ['symfony/framework-bundle', 'symfony/notifier'];
  2570. foreach ($classToServices as $class => $service) {
  2571. $package = substr($service, \strlen('notifier.transport_factory.'));
  2573. if (!ContainerBuilder::willBeAvailable(sprintf('symfony/%s-notifier', $package), $class, $parentPackages, true)) {
  2574. $container->removeDefinition($service);
  2575. $container->removeAlias(str_replace('-', '', $service)); // @deprecated to be removed in 6.0
  2576. }
  2577. }
  2579. if (ContainerBuilder::willBeAvailable('symfony/mercure-notifier', MercureTransportFactory::class, $parentPackages, true) && ContainerBuilder::willBeAvailable('symfony/mercure-bundle', MercureBundle::class, $parentPackages, true)) {
  2580. $container->getDefinition($classToServices[MercureTransportFactory::class])
  2581. ->replaceArgument('$registry', new Reference(HubRegistry::class));
  2582. } elseif (ContainerBuilder::willBeAvailable('symfony/mercure-notifier', MercureTransportFactory::class, $parentPackages, true)) {
  2583. $container->removeDefinition($classToServices[MercureTransportFactory::class]);
  2584. }
  2586. if (ContainerBuilder::willBeAvailable('symfony/fake-chat-notifier', FakeChatTransportFactory::class, ['symfony/framework-bundle', 'symfony/notifier', 'symfony/mailer'], true)) {
  2587. $container->getDefinition($classToServices[FakeChatTransportFactory::class])
  2588. ->replaceArgument('$mailer', new Reference('mailer'))
  2589. ->replaceArgument('$logger', new Reference('logger'));
  2590. }
  2592. if (ContainerBuilder::willBeAvailable('symfony/fake-sms-notifier', FakeSmsTransportFactory::class, ['symfony/framework-bundle', 'symfony/notifier', 'symfony/mailer'], true)) {
  2593. $container->getDefinition($classToServices[FakeSmsTransportFactory::class])
  2594. ->replaceArgument('$mailer', new Reference('mailer'))
  2595. ->replaceArgument('$logger', new Reference('logger'));
  2596. }
  2598. if (isset($config['admin_recipients'])) {
  2599. $notifier = $container->getDefinition('notifier');
  2600. foreach ($config['admin_recipients'] as $i => $recipient) {
  2601. $id = 'notifier.admin_recipient.'.$i;
  2602. $container->setDefinition($id, new Definition(Recipient::class, [$recipient['email'], $recipient['phone']]));
  2603. $notifier->addMethodCall('addAdminRecipient', [new Reference($id)]);
  2604. }
  2605. }
  2606. }
  2608. private function registerRateLimiterConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  2609. {
  2610. $loader->load('rate_limiter.php');
  2612. foreach ($config['limiters'] as $name => $limiterConfig) {
  2613. self::registerRateLimiter($container, $name, $limiterConfig);
  2614. }
  2615. }
  2617. public static function registerRateLimiter(ContainerBuilder $container, string $name, array $limiterConfig)
  2618. {
  2619. // default configuration (when used by other DI extensions)
  2620. $limiterConfig += ['lock_factory' => 'lock.factory', 'cache_pool' => 'cache.rate_limiter'];
  2622. $limiter = $container->setDefinition($limiterId = 'limiter.'.$name, new ChildDefinition('limiter'));
  2624. if (null !== $limiterConfig['lock_factory']) {
  2625. if (!self::$lockConfigEnabled) {
  2626. throw new LogicException(sprintf('Rate limiter "%s" requires the Lock component to be installed and configured.', $name));
  2627. }
  2629. $limiter->replaceArgument(2, new Reference($limiterConfig['lock_factory']));
  2630. }
  2631. unset($limiterConfig['lock_factory']);
  2633. $storageId = $limiterConfig['storage_service'] ?? null;
  2634. if (null === $storageId) {
  2635. $container->register($storageId = 'limiter.storage.'.$name, CacheStorage::class)->addArgument(new Reference($limiterConfig['cache_pool']));
  2636. }
  2638. $limiter->replaceArgument(1, new Reference($storageId));
  2639. unset($limiterConfig['storage_service']);
  2640. unset($limiterConfig['cache_pool']);
  2642. $limiterConfig['id'] = $name;
  2643. $limiter->replaceArgument(0, $limiterConfig);
  2645. $container->registerAliasForArgument($limiterId, RateLimiterFactory::class, $name.'.limiter');
  2646. }
  2648. private function registerUidConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
  2649. {
  2650. $loader->load('uid.php');
  2652. $container->getDefinition('uuid.factory')
  2653. ->setArguments([
  2654. $config['default_uuid_version'],
  2655. $config['time_based_uuid_version'],
  2656. $config['name_based_uuid_version'],
  2657. UuidV4::class,
  2658. $config['time_based_uuid_node'] ?? null,
  2659. $config['name_based_uuid_namespace'] ?? null,
  2660. ])
  2661. ;
  2663. if (isset($config['name_based_uuid_namespace'])) {
  2664. $container->getDefinition('name_based_uuid.factory')
  2665. ->setArguments([$config['name_based_uuid_namespace']]);
  2666. }
  2667. }
  2669. private function resolveTrustedHeaders(array $headers): int
  2670. {
  2671. $trustedHeaders = 0;
  2673. foreach ($headers as $h) {
  2674. switch ($h) {
  2675. case 'forwarded': $trustedHeaders |= Request::HEADER_FORWARDED; break;
  2676. case 'x-forwarded-for': $trustedHeaders |= Request::HEADER_X_FORWARDED_FOR; break;
  2677. case 'x-forwarded-host': $trustedHeaders |= Request::HEADER_X_FORWARDED_HOST; break;
  2678. case 'x-forwarded-proto': $trustedHeaders |= Request::HEADER_X_FORWARDED_PROTO; break;
  2679. case 'x-forwarded-port': $trustedHeaders |= Request::HEADER_X_FORWARDED_PORT; break;
  2680. case 'x-forwarded-prefix': $trustedHeaders |= Request::HEADER_X_FORWARDED_PREFIX; break;
  2681. }
  2682. }
  2684. return $trustedHeaders;
  2685. }
  2687. /**
  2688. * {@inheritdoc}
  2689. */
  2690. public function getXsdValidationBasePath()
  2691. {
  2692. return \dirname(__DIR__).'/Resources/config/schema';
  2693. }
  2695. public function getNamespace()
  2696. {
  2697. return 'http://symfony.com/schema/dic/symfony';
  2698. }
  2699. }