vendor/shopware/core/Content/Flow/Dispatching/Action/SendMailAction.php line 124

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Flow\Dispatching\Action;
  5. use Doctrine\DBAL\Connection;
  6. use Psr\Log\LoggerInterface;
  7. use Shopware\Core\Content\ContactForm\Event\ContactFormEvent;
  8. use Shopware\Core\Content\Flow\Dispatching\DelayableAction;
  9. use Shopware\Core\Content\Flow\Dispatching\StorableFlow;
  10. use Shopware\Core\Content\Flow\Events\FlowSendMailActionEvent;
  11. use Shopware\Core\Content\Mail\Service\AbstractMailService;
  12. use Shopware\Core\Content\Mail\Service\MailAttachmentsConfig;
  13. use Shopware\Core\Content\MailTemplate\Exception\MailEventConfigurationException;
  14. use Shopware\Core\Content\MailTemplate\Exception\SalesChannelNotFoundException;
  15. use Shopware\Core\Content\MailTemplate\MailTemplateActions;
  16. use Shopware\Core\Content\MailTemplate\MailTemplateEntity;
  17. use Shopware\Core\Content\MailTemplate\Subscriber\MailSendSubscriberConfig;
  18. use Shopware\Core\Framework\Adapter\Translation\Translator;
  19. use Shopware\Core\Framework\Context;
  20. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  21. use Shopware\Core\Framework\DataAbstractionLayer\Exception\InconsistentCriteriaIdsException;
  22. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  23. use Shopware\Core\Framework\Event\FlowEvent;
  24. use Shopware\Core\Framework\Event\MailAware;
  25. use Shopware\Core\Framework\Event\OrderAware;
  26. use Shopware\Core\Framework\Feature;
  27. use Shopware\Core\Framework\Log\Package;
  28. use Shopware\Core\Framework\Uuid\Uuid;
  29. use Shopware\Core\Framework\Validation\DataBag\DataBag;
  30. use Shopware\Core\System\Locale\LanguageLocaleCodeProvider;
  31. use Symfony\Contracts\EventDispatcher\Event;
  32. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  34. /**
  35. * @deprecated tag:v6.5.0 - reason:remove-subscriber - FlowActions won't be executed over the event system anymore,
  36. * therefore the actions won't implement the EventSubscriberInterface anymore.
  37. */
  38. #[Package('business-ops')]
  39. class SendMailAction extends FlowAction implements DelayableAction
  40. {
  41. public const ACTION_NAME = MailTemplateActions::MAIL_TEMPLATE_MAIL_SEND_ACTION;
  42. public const MAIL_CONFIG_EXTENSION = 'mail-attachments';
  43. private const RECIPIENT_CONFIG_ADMIN = 'admin';
  44. private const RECIPIENT_CONFIG_CUSTOM = 'custom';
  45. private const RECIPIENT_CONFIG_CONTACT_FORM_MAIL = 'contactFormMail';
  47. private EntityRepositoryInterface $mailTemplateRepository;
  49. private LoggerInterface $logger;
  51. private AbstractMailService $emailService;
  53. private EventDispatcherInterface $eventDispatcher;
  55. private EntityRepositoryInterface $mailTemplateTypeRepository;
  57. private Translator $translator;
  59. private Connection $connection;
  61. private LanguageLocaleCodeProvider $languageLocaleProvider;
  63. private bool $updateMailTemplate;
  65. /**
  66. * @internal
  67. */
  68. public function __construct(
  69. AbstractMailService $emailService,
  70. EntityRepositoryInterface $mailTemplateRepository,
  71. LoggerInterface $logger,
  72. EventDispatcherInterface $eventDispatcher,
  73. EntityRepositoryInterface $mailTemplateTypeRepository,
  74. Translator $translator,
  75. Connection $connection,
  76. LanguageLocaleCodeProvider $languageLocaleProvider,
  77. bool $updateMailTemplate
  78. ) {
  79. $this->mailTemplateRepository = $mailTemplateRepository;
  80. $this->logger = $logger;
  81. $this->emailService = $emailService;
  82. $this->eventDispatcher = $eventDispatcher;
  83. $this->mailTemplateTypeRepository = $mailTemplateTypeRepository;
  84. $this->translator = $translator;
  85. $this->connection = $connection;
  86. $this->languageLocaleProvider = $languageLocaleProvider;
  87. $this->updateMailTemplate = $updateMailTemplate;
  88. }
  90. public static function getName(): string
  91. {
  92. return 'action.mail.send';
  93. }
  95. /**
  96. * @deprecated tag:v6.5.0 - reason:remove-subscriber - Will be removed
  97. */
  98. public static function getSubscribedEvents(): array
  99. {
  100. if (Feature::isActive('v6.5.0.0')) {
  101. return [];
  102. }
  104. return [
  105. self::getName() => 'handle',
  106. ];
  107. }
  109. /**
  110. * @return array<string>
  111. */
  112. public function requirements(): array
  113. {
  114. return [MailAware::class];
  115. }
  117. /**
  118. * @deprecated tag:v6.5.0 Will be removed, implement handleFlow instead
  119. *
  120. * @throws MailEventConfigurationException
  121. * @throws SalesChannelNotFoundException
  122. * @throws InconsistentCriteriaIdsException
  123. */
  124. public function handle(Event $event): void
  125. {
  126. Feature::triggerDeprecationOrThrow(
  127. 'v6.5.0.0',
  128. Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0')
  129. );
  131. if (!$event instanceof FlowEvent) {
  132. return;
  133. }
  135. $mailEvent = $event->getEvent();
  137. $extension = $event->getContext()->getExtension(self::MAIL_CONFIG_EXTENSION);
  138. if (!$extension instanceof MailSendSubscriberConfig) {
  139. $extension = new MailSendSubscriberConfig(false, [], []);
  140. }
  142. if ($extension->skip()) {
  143. return;
  144. }
  146. if (!$mailEvent instanceof MailAware) {
  147. throw new MailEventConfigurationException('Not an instance of MailAware', \get_class($mailEvent));
  148. }
  150. $eventConfig = $event->getConfig();
  152. if (empty($eventConfig['recipient'])) {
  153. throw new MailEventConfigurationException('The recipient value in the flow action configuration is missing.', \get_class($mailEvent));
  154. }
  156. if (!isset($eventConfig['mailTemplateId'])) {
  157. return;
  158. }
  160. $mailTemplate = $this->getMailTemplate($eventConfig['mailTemplateId'], $event->getContext());
  162. if ($mailTemplate === null) {
  163. return;
  164. }
  166. $injectedTranslator = $this->injectTranslator($mailEvent->getContext(), $mailEvent->getSalesChannelId());
  168. $data = new DataBag();
  170. $contactFormData = [];
  171. if ($mailEvent instanceof ContactFormEvent) {
  172. $contactFormData = $mailEvent->getContactFormData();
  173. }
  175. $recipients = $this->getRecipients($eventConfig['recipient'], $mailEvent->getMailStruct()->getRecipients(), $contactFormData);
  177. if (empty($recipients)) {
  178. return;
  179. }
  181. $data->set('recipients', $recipients);
  182. $data->set('senderName', $mailTemplate->getTranslation('senderName'));
  183. $data->set('salesChannelId', $mailEvent->getSalesChannelId());
  185. $data->set('templateId', $mailTemplate->getId());
  186. $data->set('customFields', $mailTemplate->getCustomFields());
  187. $data->set('contentHtml', $mailTemplate->getTranslation('contentHtml'));
  188. $data->set('contentPlain', $mailTemplate->getTranslation('contentPlain'));
  189. $data->set('subject', $mailTemplate->getTranslation('subject'));
  190. $data->set('mediaIds', []);
  192. $data->set('attachmentsConfig', new MailAttachmentsConfig(
  193. $event->getContext(),
  194. $mailTemplate,
  195. $extension,
  196. $eventConfig,
  197. $mailEvent instanceof OrderAware ? $mailEvent->getOrderId() : null,
  198. ));
  200. $this->setReplyTo($data, $eventConfig, $contactFormData);
  202. $this->eventDispatcher->dispatch(new FlowSendMailActionEvent($data, $mailTemplate, $event));
  204. if ($data->has('templateId')) {
  205. $this->updateMailTemplateType(
  206. $event->getContext(),
  207. $event,
  208. $this->getTemplateData($mailEvent),
  209. $mailTemplate
  210. );
  211. }
  213. $templateData = array_merge([
  214. 'eventName' => $mailEvent->getName(),
  215. ], $this->getTemplateData($mailEvent));
  217. $this->send($data, $event->getContext(), $templateData, $extension, $injectedTranslator);
  218. }
  220. /**
  221. * @throws MailEventConfigurationException
  222. * @throws SalesChannelNotFoundException
  223. * @throws InconsistentCriteriaIdsException
  224. */
  225. public function handleFlow(StorableFlow $flow): void
  226. {
  227. $extension = $flow->getContext()->getExtension(self::MAIL_CONFIG_EXTENSION);
  228. if (!$extension instanceof MailSendSubscriberConfig) {
  229. $extension = new MailSendSubscriberConfig(false, [], []);
  230. }
  232. if ($extension->skip()) {
  233. return;
  234. }
  236. if (!$flow->hasStore(MailAware::MAIL_STRUCT) || !$flow->hasStore(MailAware::SALES_CHANNEL_ID)) {
  237. throw new MailEventConfigurationException('Not have data from MailAware', \get_class($flow));
  238. }
  240. $eventConfig = $flow->getConfig();
  241. if (empty($eventConfig['recipient'])) {
  242. throw new MailEventConfigurationException('The recipient value in the flow action configuration is missing.', \get_class($flow));
  243. }
  245. if (!isset($eventConfig['mailTemplateId'])) {
  246. return;
  247. }
  249. $mailTemplate = $this->getMailTemplate($eventConfig['mailTemplateId'], $flow->getContext());
  251. if ($mailTemplate === null) {
  252. return;
  253. }
  255. $injectedTranslator = $this->injectTranslator($flow->getContext(), $flow->getStore(MailAware::SALES_CHANNEL_ID));
  257. $data = new DataBag();
  259. $recipients = $this->getRecipients(
  260. $eventConfig['recipient'],
  261. $flow->getStore(MailAware::MAIL_STRUCT)['recipients'],
  262. $flow->getStore('contactFormData', []),
  263. );
  265. if (empty($recipients)) {
  266. return;
  267. }
  269. $data->set('recipients', $recipients);
  270. $data->set('senderName', $mailTemplate->getTranslation('senderName'));
  271. $data->set('salesChannelId', $flow->getStore(MailAware::SALES_CHANNEL_ID));
  273. $data->set('templateId', $mailTemplate->getId());
  274. $data->set('customFields', $mailTemplate->getCustomFields());
  275. $data->set('contentHtml', $mailTemplate->getTranslation('contentHtml'));
  276. $data->set('contentPlain', $mailTemplate->getTranslation('contentPlain'));
  277. $data->set('subject', $mailTemplate->getTranslation('subject'));
  278. $data->set('mediaIds', []);
  280. $data->set('attachmentsConfig', new MailAttachmentsConfig(
  281. $flow->getContext(),
  282. $mailTemplate,
  283. $extension,
  284. $eventConfig,
  285. $flow->getStore(OrderAware::ORDER_ID),
  286. ));
  288. $this->setReplyTo($data, $eventConfig, $flow->getStore('contactFormData', []));
  290. $this->eventDispatcher->dispatch(new FlowSendMailActionEvent($data, $mailTemplate, $flow));
  292. if ($data->has('templateId')) {
  293. $this->updateMailTemplateType(
  294. $flow->getContext(),
  295. $flow,
  296. $flow->data(),
  297. $mailTemplate
  298. );
  299. }
  301. $templateData = array_merge([
  302. 'eventName' => $flow->getName(),
  303. ], $flow->data());
  305. $this->send($data, $flow->getContext(), $templateData, $extension, $injectedTranslator);
  306. }
  308. /**
  309. * @param array<string, mixed> $templateData
  310. */
  311. private function send(DataBag $data, Context $context, array $templateData, MailSendSubscriberConfig $extension, bool $injectedTranslator): void
  312. {
  313. try {
  314. $this->emailService->send(
  315. $data->all(),
  316. $context,
  317. $templateData
  318. );
  319. } catch (\Exception $e) {
  320. $this->logger->error(
  321. "Could not send mail:\n"
  322. . $e->getMessage() . "\n"
  323. . 'Error Code:' . $e->getCode() . "\n"
  324. . "Template data: \n"
  325. . json_encode($data->all()) . "\n"
  326. );
  327. }
  329. if ($injectedTranslator) {
  330. $this->translator->resetInjection();
  331. }
  332. }
  334. /**
  335. * @param FlowEvent|StorableFlow $event
  336. * @param array<string, mixed> $templateData
  337. */
  338. private function updateMailTemplateType(
  339. Context $context,
  340. $event,
  341. array $templateData,
  342. MailTemplateEntity $mailTemplate
  343. ): void {
  344. if (!$mailTemplate->getMailTemplateTypeId()) {
  345. return;
  346. }
  348. if (!$this->updateMailTemplate) {
  349. return;
  350. }
  352. $mailTemplateTypeTranslation = $this->connection->fetchOne(
  353. 'SELECT 1 FROM mail_template_type_translation WHERE language_id = :languageId AND mail_template_type_id =:mailTemplateTypeId',
  354. [
  355. 'languageId' => Uuid::fromHexToBytes($context->getLanguageId()),
  356. 'mailTemplateTypeId' => Uuid::fromHexToBytes($mailTemplate->getMailTemplateTypeId()),
  357. ]
  358. );
  360. if (!$mailTemplateTypeTranslation) {
  361. // Don't throw errors if this fails // Fix with NEXT-15475
  362. $this->logger->error(
  363. "Could not update mail template type, because translation for this language does not exits:\n"
  364. . 'Flow id: ' . $event->getFlowState()->flowId . "\n"
  365. . 'Sequence id: ' . $event->getFlowState()->getSequenceId()
  366. );
  368. return;
  369. }
  371. $this->mailTemplateTypeRepository->update([[
  372. 'id' => $mailTemplate->getMailTemplateTypeId(),
  373. 'templateData' => $templateData,
  374. ]], $context);
  375. }
  377. private function getMailTemplate(string $id, Context $context): ?MailTemplateEntity
  378. {
  379. $criteria = new Criteria([$id]);
  380. $criteria->setTitle('send-mail::load-mail-template');
  381. $criteria->addAssociation('media.media');
  382. $criteria->setLimit(1);
  384. return $this->mailTemplateRepository
  385. ->search($criteria, $context)
  386. ->first();
  387. }
  389. /**
  390. * @throws MailEventConfigurationException
  391. *
  392. * @return array<string, mixed>
  393. */
  394. private function getTemplateData(MailAware $event): array
  395. {
  396. $data = [];
  398. foreach (array_keys($event::getAvailableData()->toArray()) as $key) {
  399. $getter = 'get' . ucfirst($key);
  400. if (!method_exists($event, $getter)) {
  401. throw new MailEventConfigurationException('Data for ' . $key . ' not available.', \get_class($event));
  402. }
  403. $data[$key] = $event->$getter();
  404. }
  406. return $data;
  407. }
  409. private function injectTranslator(Context $context, ?string $salesChannelId): bool
  410. {
  411. if ($salesChannelId === null) {
  412. return false;
  413. }
  415. if ($this->translator->getSnippetSetId() !== null) {
  416. return false;
  417. }
  419. $this->translator->injectSettings(
  420. $salesChannelId,
  421. $context->getLanguageId(),
  422. $this->languageLocaleProvider->getLocaleForLanguageId($context->getLanguageId()),
  423. $context
  424. );
  426. return true;
  427. }
  429. /**
  430. * @param array<string, mixed> $recipients
  431. * @param array<string, mixed> $mailStructRecipients
  432. * @param array<int|string, mixed> $contactFormData
  433. *
  434. * @return array<int|string, string>
  435. */
  436. private function getRecipients(array $recipients, array $mailStructRecipients, array $contactFormData): array
  437. {
  438. switch ($recipients['type']) {
  439. case self::RECIPIENT_CONFIG_CUSTOM:
  440. return $recipients['data'];
  441. case self::RECIPIENT_CONFIG_ADMIN:
  442. $admins = $this->connection->fetchAllAssociative(
  443. 'SELECT first_name, last_name, email FROM user WHERE admin = true'
  444. );
  445. $emails = [];
  446. foreach ($admins as $admin) {
  447. $emails[$admin['email']] = $admin['first_name'] . ' ' . $admin['last_name'];
  448. }
  450. return $emails;
  451. case self::RECIPIENT_CONFIG_CONTACT_FORM_MAIL:
  452. if (empty($contactFormData)) {
  453. return [];
  454. }
  456. if (!\array_key_exists('email', $contactFormData)) {
  457. return [];
  458. }
  460. return [$contactFormData['email'] => ($contactFormData['firstName'] ?? '') . ' ' . ($contactFormData['lastName'] ?? '')];
  461. default:
  462. return $mailStructRecipients;
  463. }
  464. }
  466. /**
  467. * @param array<string, mixed> $eventConfig
  468. * @param array<int|string, mixed> $contactFormData
  469. */
  470. private function setReplyTo(DataBag $data, array $eventConfig, array $contactFormData): void
  471. {
  472. if (empty($eventConfig['replyTo']) || !\is_string($eventConfig['replyTo'])) {
  473. return;
  474. }
  476. if ($eventConfig['replyTo'] !== self::RECIPIENT_CONFIG_CONTACT_FORM_MAIL) {
  477. $data->set('senderMail', $eventConfig['replyTo']);
  479. return;
  480. }
  482. if (empty($contactFormData['email']) || !\is_string($contactFormData['email'])) {
  483. return;
  484. }
  486. $data->set(
  487. 'senderName',
  488. '{% if contactFormData.firstName is defined %}{{ contactFormData.firstName }}{% endif %} '
  489. . '{% if contactFormData.lastName is defined %}{{ contactFormData.lastName }}{% endif %}'
  490. );
  491. $data->set('senderMail', $contactFormData['email']);
  492. }
  493. }