vendor/symfony/swiftmailer-bundle/DependencyInjection/SwiftmailerExtension.php line 62

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\SwiftmailerBundle\DependencyInjection;
  14. use Symfony\Component\Config\FileLocator;
  15. use Symfony\Component\Console\Application;
  16. use Symfony\Component\DependencyInjection\Alias;
  17. use Symfony\Component\DependencyInjection\ChildDefinition;
  18. use Symfony\Component\DependencyInjection\ContainerBuilder;
  19. use Symfony\Component\DependencyInjection\ContainerInterface;
  20. use Symfony\Component\DependencyInjection\Definition;
  21. use Symfony\Component\DependencyInjection\DefinitionDecorator;
  22. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  23. use Symfony\Component\DependencyInjection\Reference;
  24. use Symfony\Component\HttpKernel\DependencyInjection\Extension;
  26. /**
  27. * SwiftmailerExtension is an extension for the SwiftMailer library.
  28. *
  29. * @author Fabien Potencier <fabien@symfony.com>
  30. */
  31. class SwiftmailerExtension extends Extension
  32. {
  33. /**
  34. * Loads the Swift Mailer configuration.
  35. *
  36. * Usage example:
  37. *
  38. * <swiftmailer:config transport="gmail">
  39. * <swiftmailer:username>fabien</swift:username>
  40. * <swiftmailer:password>xxxxx</swift:password>
  41. * <swiftmailer:spool path="/path/to/spool/" />
  42. * </swiftmailer:config>
  43. *
  44. * @param array $configs An array of configuration settings
  45. * @param ContainerBuilder $container A ContainerBuilder instance
  46. */
  47. public function load(array $configs, ContainerBuilder $container)
  48. {
  49. $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
  50. $loader->load('swiftmailer.xml');
  52. if (class_exists(Application::class)) {
  53. $loader->load('console.xml');
  54. }
  56. $configuration = $this->getConfiguration($configs, $container);
  57. $config = $this->processConfiguration($configuration, $configs);
  59. $mailers = [];
  60. foreach ($config['mailers'] as $name => $mailer) {
  61. $isDefaultMailer = $config['default_mailer'] === $name;
  62. $this->configureMailer($name, $mailer, $container, $isDefaultMailer);
  63. $mailers[$name] = sprintf('swiftmailer.mailer.%s', $name);
  64. }
  65. ksort($mailers);
  66. $container->setParameter('swiftmailer.mailers', $mailers);
  67. $container->setParameter('swiftmailer.default_mailer', $config['default_mailer']);
  69. $container->findDefinition('swiftmailer.data_collector')->addTag('data_collector', ['template' => '@Swiftmailer/Collector/swiftmailer.html.twig', 'id' => 'swiftmailer', 'priority' => 245]);
  71. $container->setAlias('mailer', 'swiftmailer.mailer');
  72. $container->getAlias('mailer')->setPublic(true);
  73. }
  75. protected function configureMailer($name, array $mailer, ContainerBuilder $container, $isDefaultMailer = false)
  76. {
  77. $definitionDecorator = $this->createChildDefinition('swiftmailer.transport.eventdispatcher.abstract');
  78. $container
  79. ->setDefinition(sprintf('swiftmailer.mailer.%s.transport.eventdispatcher', $name), $definitionDecorator)
  80. ;
  82. $usedEnvs = null;
  83. $disableDelivery = isset($mailer['disable_delivery']) && $mailer['disable_delivery'];
  85. if (method_exists($container, 'resolveEnvPlaceholders')) {
  86. $options = [];
  87. $envVariablesAllowed = ['transport', 'url', 'username', 'password', 'host', 'port', 'timeout', 'source_ip', 'local_domain', 'encryption', 'auth_mode', 'command', 'stream_options'];
  88. foreach ($envVariablesAllowed as $key) {
  89. $container->resolveEnvPlaceholders($mailer[$key], null, $usedEnvs);
  90. $options[$key] = $mailer[$key];
  91. }
  92. }
  93. if (!$usedEnvs) {
  94. SwiftmailerTransportFactory::validateConfig($mailer);
  95. }
  96. if ($usedEnvs && !$disableDelivery) {
  97. $transportId = sprintf('swiftmailer.mailer.%s.transport.dynamic', $name);
  98. $definitionDecorator = new Definition('\Swift_Transport');
  99. $definitionDecorator->setFactory(['Symfony\Bundle\SwiftmailerBundle\DependencyInjection\SwiftmailerTransportFactory', 'createTransport']);
  100. $definitionDecorator->setArguments([
  101. $options,
  102. new Reference('router.request_context', ContainerInterface::NULL_ON_INVALID_REFERENCE),
  103. new Reference(sprintf('swiftmailer.mailer.%s.transport.eventdispatcher', $name)),
  104. ]);
  105. $container->setDefinition(sprintf('swiftmailer.mailer.%s.transport.dynamic', $name), $definitionDecorator);
  106. $container->setAlias(sprintf('swiftmailer.mailer.%s.transport', $name), $transportId);
  108. $definitionDecorator = $this->createChildDefinition('swiftmailer.mailer.abstract');
  109. $container
  110. ->setDefinition(sprintf('swiftmailer.mailer.%s', $name), $definitionDecorator)
  111. ->replaceArgument(0, new Reference(sprintf('swiftmailer.mailer.%s.transport', $name)))
  112. ;
  114. $container->setParameter(sprintf('swiftmailer.mailer.%s.transport.name', $name), 'dynamic');
  115. } else {
  116. $mailer = SwiftmailerTransportFactory::resolveOptions($mailer);
  117. $transport = $disableDelivery ? 'null' : $mailer['transport'];
  119. $container->setParameter(sprintf('swiftmailer.mailer.%s.transport.name', $name), $transport);
  121. $transportId = \in_array($transport, ['smtp', 'sendmail', 'null'])
  122. ? sprintf('swiftmailer.mailer.%s.transport.%s', $name, $transport)
  123. : $transport;
  125. $this->configureMailerTransport($name, $mailer, $container, $transport, $isDefaultMailer);
  126. }
  127. $this->configureMailerSpool($name, $mailer, $container, $transportId, $isDefaultMailer);
  128. $this->configureMailerSenderAddress($name, $mailer, $container, $isDefaultMailer);
  129. $this->configureMailerAntiFlood($name, $mailer, $container, $isDefaultMailer);
  130. $this->configureMailerDeliveryAddress($name, $mailer, $container, $isDefaultMailer);
  131. $this->configureMailerLogging($name, $mailer, $container, $isDefaultMailer);
  133. $container->setParameter(sprintf('swiftmailer.mailer.%s.delivery.enabled', $name), !$disableDelivery);
  135. // alias
  136. if ($isDefaultMailer) {
  137. $container->setAlias('swiftmailer.mailer', sprintf('swiftmailer.mailer.%s', $name));
  138. $container->setAlias('swiftmailer.transport', new Alias(sprintf('swiftmailer.mailer.%s.transport', $name), true));
  139. $container->setParameter('swiftmailer.spool.enabled', $container->getParameter(sprintf('swiftmailer.mailer.%s.spool.enabled', $name)));
  140. $container->setParameter('swiftmailer.delivery.enabled', $container->getParameter(sprintf('swiftmailer.mailer.%s.delivery.enabled', $name)));
  141. $container->setParameter('swiftmailer.single_address', $container->getParameter(sprintf('swiftmailer.mailer.%s.single_address', $name)));
  142. $container->setAlias('Swift_Mailer', new Alias('swiftmailer.mailer', false));
  143. $container->setAlias('Swift_Transport', new Alias('swiftmailer.transport', false));
  144. }
  145. }
  147. protected function configureMailerTransport($name, array $mailer, ContainerBuilder $container, $transport, $isDefaultMailer = false)
  148. {
  149. foreach (['encryption', 'port', 'host', 'username', 'password', 'auth_mode', 'timeout', 'source_ip', 'local_domain', 'stream_options'] as $key) {
  150. $container->setParameter(sprintf('swiftmailer.mailer.%s.transport.smtp.%s', $name, $key), $mailer[$key]);
  151. }
  153. if ('smtp' === $transport) {
  154. $authDecorator = $this->createChildDefinition('swiftmailer.transport.authhandler.abstract');
  155. $container
  156. ->setDefinition(sprintf('swiftmailer.mailer.%s.transport.authhandler', $name), $authDecorator)
  157. ->addMethodCall('setUsername', [sprintf('%%swiftmailer.mailer.%s.transport.smtp.username%%', $name)])
  158. ->addMethodCall('setPassword', [sprintf('%%swiftmailer.mailer.%s.transport.smtp.password%%', $name)])
  159. ->addMethodCall('setAuthMode', [sprintf('%%swiftmailer.mailer.%s.transport.smtp.auth_mode%%', $name)]);
  161. $bufferDecorator = $this->createChildDefinition('swiftmailer.transport.buffer.abstract');
  162. $container
  163. ->setDefinition(sprintf('swiftmailer.mailer.%s.transport.buffer', $name), $bufferDecorator);
  165. $configuratorDecorator = $this->createChildDefinition('swiftmailer.transport.smtp.configurator.abstract');
  166. $container
  167. ->setDefinition(sprintf('swiftmailer.transport.configurator.%s', $name), $configuratorDecorator)
  168. ->setArguments([
  169. sprintf('%%swiftmailer.mailer.%s.transport.smtp.local_domain%%', $name),
  170. new Reference('router.request_context', ContainerInterface::NULL_ON_INVALID_REFERENCE),
  171. ])
  172. ;
  174. $definitionDecorator = $this->createChildDefinition('swiftmailer.transport.smtp.abstract');
  175. $container
  176. ->setDefinition(sprintf('swiftmailer.mailer.%s.transport.smtp', $name), $definitionDecorator)
  177. ->setArguments([
  178. new Reference(sprintf('swiftmailer.mailer.%s.transport.buffer', $name)),
  179. [new Reference(sprintf('swiftmailer.mailer.%s.transport.authhandler', $name))],
  180. new Reference(sprintf('swiftmailer.mailer.%s.transport.eventdispatcher', $name)),
  181. ])
  182. ->addMethodCall('setHost', [sprintf('%%swiftmailer.mailer.%s.transport.smtp.host%%', $name)])
  183. ->addMethodCall('setPort', [sprintf('%%swiftmailer.mailer.%s.transport.smtp.port%%', $name)])
  184. ->addMethodCall('setEncryption', [sprintf('%%swiftmailer.mailer.%s.transport.smtp.encryption%%', $name)])
  185. ->addMethodCall('setTimeout', [sprintf('%%swiftmailer.mailer.%s.transport.smtp.timeout%%', $name)])
  186. ->addMethodCall('setSourceIp', [sprintf('%%swiftmailer.mailer.%s.transport.smtp.source_ip%%', $name)])
  187. ->setConfigurator([new Reference(sprintf('swiftmailer.transport.configurator.%s', $name)), 'configure'])
  188. ;
  190. if ($mailer['stream_options']) {
  191. $container->setParameter(sprintf('swiftmailer.mailer.%s.transport.smtp.stream_options', $name), $mailer['stream_options']);
  192. $definitionDecorator->addMethodCall('setStreamOptions', [sprintf('%%swiftmailer.mailer.%s.transport.smtp.stream_options%%', $name)]);
  193. }
  195. $container->setAlias(sprintf('swiftmailer.mailer.%s.transport', $name), sprintf('swiftmailer.mailer.%s.transport.%s', $name, $transport));
  196. } elseif ('sendmail' === $transport) {
  197. $bufferDecorator = $this->createChildDefinition('swiftmailer.transport.buffer.abstract');
  198. $container
  199. ->setDefinition(sprintf('swiftmailer.mailer.%s.transport.buffer', $name), $bufferDecorator);
  201. $configuratorDecorator = $this->createChildDefinition('swiftmailer.transport.smtp.configurator.abstract');
  202. $container
  203. ->setDefinition(sprintf('swiftmailer.transport.configurator.%s', $name), $configuratorDecorator)
  204. ->setArguments([
  205. sprintf('%%swiftmailer.mailer.%s.transport.smtp.local_domain%%', $name),
  206. new Reference('router.request_context', ContainerInterface::NULL_ON_INVALID_REFERENCE),
  207. ])
  208. ;
  210. $definitionDecorator = $this->createChildDefinition(sprintf('swiftmailer.transport.%s.abstract', $transport));
  211. $container
  212. ->setDefinition(sprintf('swiftmailer.mailer.%s.transport.%s', $name, $transport), $definitionDecorator)
  213. ->setArguments([
  214. new Reference(sprintf('swiftmailer.mailer.%s.transport.buffer', $name)),
  215. new Reference(sprintf('swiftmailer.mailer.%s.transport.eventdispatcher', $name)),
  216. ])
  217. ->addMethodCall('setCommand', [$mailer['command']])
  218. ->setConfigurator([new Reference(sprintf('swiftmailer.transport.configurator.%s', $name)), 'configure'])
  219. ;
  221. $container->setAlias(sprintf('swiftmailer.mailer.%s.transport', $name), sprintf('swiftmailer.mailer.%s.transport.%s', $name, $transport));
  222. } elseif ('null' === $transport) {
  223. $definitionDecorator = $this->createChildDefinition('swiftmailer.transport.null.abstract');
  224. $container
  225. ->setDefinition(sprintf('swiftmailer.mailer.%s.transport.null', $name), $definitionDecorator)
  226. ->setArguments([
  227. new Reference(sprintf('swiftmailer.mailer.%s.transport.eventdispatcher', $name)),
  228. ])
  229. ;
  230. $container->setAlias(sprintf('swiftmailer.mailer.%s.transport', $name), sprintf('swiftmailer.mailer.%s.transport.%s', $name, $transport));
  231. } else {
  232. $container->setAlias(sprintf('swiftmailer.mailer.%s.transport', $name), sprintf('swiftmailer.mailer.transport.%s', $transport));
  233. }
  235. $container->getAlias(sprintf('swiftmailer.mailer.%s.transport', $name))->setPublic(true);
  237. $definitionDecorator = $this->createChildDefinition('swiftmailer.mailer.abstract');
  238. $container
  239. ->setDefinition(sprintf('swiftmailer.mailer.%s', $name), $definitionDecorator)
  240. ->replaceArgument(0, new Reference(sprintf('swiftmailer.mailer.%s.transport', $name)))
  241. ;
  242. }
  244. protected function configureMailerSpool($name, array $mailer, ContainerBuilder $container, $transport, $isDefaultMailer = false)
  245. {
  246. if (isset($mailer['spool'])) {
  247. $type = $mailer['spool']['type'];
  248. if ('service' === $type) {
  249. $container->setAlias(sprintf('swiftmailer.mailer.%s.spool.service', $name), $mailer['spool']['id']);
  250. } else {
  251. foreach (['path'] as $key) {
  252. $container->setParameter(sprintf('swiftmailer.spool.%s.%s.%s', $name, $type, $key), $mailer['spool'][$key].'/'.$name);
  253. }
  254. }
  256. $definitionDecorator = $this->createChildDefinition(sprintf('swiftmailer.spool.%s.abstract', $type));
  257. if ('file' === $type) {
  258. $container
  259. ->setDefinition(sprintf('swiftmailer.mailer.%s.spool.file', $name), $definitionDecorator)
  260. ->replaceArgument(0, sprintf('%%swiftmailer.spool.%s.file.path%%', $name))
  261. ;
  262. } elseif ('memory' === $type) {
  263. $container
  264. ->setDefinition(sprintf('swiftmailer.mailer.%s.spool.memory', $name), $definitionDecorator)
  265. ;
  266. }
  267. $container->setAlias(sprintf('swiftmailer.mailer.%s.spool', $name), sprintf('swiftmailer.mailer.%s.spool.%s', $name, $type));
  269. $definitionDecorator = $this->createChildDefinition('swiftmailer.transport.spool.abstract');
  270. $container
  271. ->setDefinition(sprintf('swiftmailer.mailer.%s.transport.spool', $name), $definitionDecorator)
  272. ->setArguments([
  273. new Reference(sprintf('swiftmailer.mailer.%s.transport.eventdispatcher', $name)),
  274. new Reference(sprintf('swiftmailer.mailer.%s.spool', $name)),
  275. ])
  276. ;
  278. $container->setAlias(sprintf('swiftmailer.mailer.%s.transport.real', $name), $transport);
  279. $container->getAlias(sprintf('swiftmailer.mailer.%s.transport.real', $name))->setPublic(true);
  280. $container->setAlias(sprintf('swiftmailer.mailer.%s.transport', $name), sprintf('swiftmailer.mailer.%s.transport.spool', $name));
  281. $container->setParameter(sprintf('swiftmailer.mailer.%s.spool.enabled', $name), true);
  282. if (true === $isDefaultMailer) {
  283. $container->setAlias('swiftmailer.spool', sprintf('swiftmailer.mailer.%s.spool', $name));
  284. $container->setAlias('swiftmailer.transport.real', sprintf('swiftmailer.mailer.%s.transport.real', $name));
  285. $container->setAlias('Swift_Spool', new Alias('swiftmailer.spool', false));
  286. }
  287. } else {
  288. $container->setParameter(sprintf('swiftmailer.mailer.%s.spool.enabled', $name), false);
  289. }
  290. }
  292. protected function configureMailerSenderAddress($name, array $mailer, ContainerBuilder $container, $isDefaultMailer = false)
  293. {
  294. if (isset($mailer['sender_address']) && $mailer['sender_address']) {
  295. $container->setParameter(sprintf('swiftmailer.mailer.%s.sender_address', $name), $mailer['sender_address']);
  296. $definitionDecorator = $this->createChildDefinition('swiftmailer.plugin.impersonate.abstract');
  297. $container
  298. ->setDefinition(sprintf('swiftmailer.mailer.%s.plugin.impersonate', $name), $definitionDecorator)
  299. ->setArguments([
  300. sprintf('%%swiftmailer.mailer.%s.sender_address%%', $name),
  301. ])
  302. ;
  303. $container->getDefinition(sprintf('swiftmailer.mailer.%s.plugin.impersonate', $name))->addTag(sprintf('swiftmailer.%s.plugin', $name));
  304. if (true === $isDefaultMailer) {
  305. $container->setAlias('swiftmailer.plugin.impersonate', sprintf('swiftmailer.mailer.%s.plugin.impersonate', $name));
  306. $container->setParameter('swiftmailer.sender_address', $container->getParameter(sprintf('swiftmailer.mailer.%s.sender_address', $name)));
  307. }
  308. } else {
  309. $container->setParameter(sprintf('swiftmailer.mailer.%s.plugin.impersonate', $name), null);
  310. }
  311. }
  313. protected function configureMailerAntiFlood($name, array $mailer, ContainerBuilder $container, $isDefaultMailer = false)
  314. {
  315. if (isset($mailer['antiflood'])) {
  316. $container->setParameter(sprintf('swiftmailer.mailer.%s.antiflood.threshold', $name), $mailer['antiflood']['threshold']);
  317. $container->setParameter(sprintf('swiftmailer.mailer.%s.antiflood.sleep', $name), $mailer['antiflood']['sleep']);
  318. $definitionDecorator = $this->createChildDefinition('swiftmailer.plugin.antiflood.abstract');
  319. $container
  320. ->setDefinition(sprintf('swiftmailer.mailer.%s.plugin.antiflood', $name), $definitionDecorator)
  321. ->setArguments([
  322. sprintf('%%swiftmailer.mailer.%s.antiflood.threshold%%', $name),
  323. sprintf('%%swiftmailer.mailer.%s.antiflood.sleep%%', $name),
  324. ])
  325. ;
  326. $container->getDefinition(sprintf('swiftmailer.mailer.%s.plugin.antiflood', $name))->addTag(sprintf('swiftmailer.%s.plugin', $name));
  327. if (true === $isDefaultMailer) {
  328. $container->setAlias('swiftmailer.mailer.plugin.antiflood', sprintf('swiftmailer.mailer.%s.plugin.antiflood', $name));
  329. }
  330. }
  331. }
  333. protected function configureMailerDeliveryAddress($name, array $mailer, ContainerBuilder $container, $isDefaultMailer = false)
  334. {
  335. if (\count($mailer['delivery_addresses']) > 0) {
  336. $container->setParameter(sprintf('swiftmailer.mailer.%s.single_address', $name), $mailer['delivery_addresses'][0]);
  337. $container->setParameter(sprintf('swiftmailer.mailer.%s.delivery_addresses', $name), $mailer['delivery_addresses']);
  338. $container->setParameter(sprintf('swiftmailer.mailer.%s.delivery_whitelist', $name), $mailer['delivery_whitelist']);
  339. $definitionDecorator = $this->createChildDefinition('swiftmailer.plugin.redirecting.abstract');
  340. $container
  341. ->setDefinition(sprintf('swiftmailer.mailer.%s.plugin.redirecting', $name), $definitionDecorator)
  342. ->setArguments([
  343. sprintf('%%swiftmailer.mailer.%s.delivery_addresses%%', $name),
  344. sprintf('%%swiftmailer.mailer.%s.delivery_whitelist%%', $name),
  345. ])
  346. ;
  347. $container->getDefinition(sprintf('swiftmailer.mailer.%s.plugin.redirecting', $name))->addTag(sprintf('swiftmailer.%s.plugin', $name));
  348. if (true === $isDefaultMailer) {
  349. $container->setAlias('swiftmailer.plugin.redirecting', sprintf('swiftmailer.mailer.%s.plugin.redirecting', $name));
  350. }
  351. } else {
  352. $container->setParameter(sprintf('swiftmailer.mailer.%s.single_address', $name), null);
  353. }
  354. }
  356. protected function configureMailerLogging($name, array $mailer, ContainerBuilder $container, $isDefaultMailer = false)
  357. {
  358. if ($mailer['logging']) {
  359. $container->getDefinition('swiftmailer.plugin.messagelogger.abstract');
  360. $definitionDecorator = $this->createChildDefinition('swiftmailer.plugin.messagelogger.abstract');
  361. $container
  362. ->setDefinition(sprintf('swiftmailer.mailer.%s.plugin.messagelogger', $name), $definitionDecorator)
  363. ;
  364. $container->getDefinition(sprintf('swiftmailer.mailer.%s.plugin.messagelogger', $name))
  365. ->setPublic(true)
  366. ->addTag(sprintf('swiftmailer.%s.plugin', $name));
  367. if (true === $isDefaultMailer) {
  368. $container->setAlias('swiftmailer.plugin.messagelogger', sprintf('swiftmailer.mailer.%s.plugin.messagelogger', $name));
  369. }
  370. }
  371. }
  373. /**
  374. * Returns the base path for the XSD files.
  375. *
  376. * @return string The XSD base path
  377. */
  378. public function getXsdValidationBasePath()
  379. {
  380. return __DIR__.'/../Resources/config/schema';
  381. }
  383. /**
  384. * Returns the namespace to be used for this extension (XML namespace).
  385. *
  386. * @return string The XML namespace
  387. */
  388. public function getNamespace()
  389. {
  390. return 'http://symfony.com/schema/dic/swiftmailer';
  391. }
  393. public function getConfiguration(array $config, ContainerBuilder $container)
  394. {
  395. return new Configuration($container->getParameter('kernel.debug'));
  396. }
  398. private function createChildDefinition($id)
  399. {
  400. if (class_exists('Symfony\Component\DependencyInjection\ChildDefinition')) {
  401. return new ChildDefinition($id);
  402. }
  404. return new DefinitionDecorator($id);
  405. }
  406. }