EmailFinisher.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Form\Domain\Finishers;
 
use Psr\Http\Message\ServerRequestInterface;
use Symfony\Component\Mime\Address;
use ‪TYPO3\CMS\Core\Mail\FluidEmail;
use ‪TYPO3\CMS\Core\Mail\Mailer;
use ‪TYPO3\CMS\Core\Mail\MailMessage;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\MathUtility;
use ‪TYPO3\CMS\Extbase\Domain\Model\FileReference;
use ‪TYPO3\CMS\Fluid\View\StandaloneView;
use ‪TYPO3\CMS\Fluid\View\TemplatePaths;
use ‪TYPO3\CMS\Form\Domain\Finishers\Exception\FinisherException;
use ‪TYPO3\CMS\Form\Domain\Model\FormElements\FileUpload;
use ‪TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
use ‪TYPO3\CMS\Form\Service\TranslationService;
use ‪TYPO3\CMS\Form\ViewHelpers\RenderRenderableViewHelper;
 
class ‪EmailFinisher extends ‪AbstractFinisher
{
    const ‪FORMAT_PLAINTEXT = 'plaintext';
    const ‪FORMAT_HTML = 'html';
 
    protected ‪$defaultOptions = [
        'recipientName' => '',
        'senderName' => '',
        'addHtmlPart' => true,
        'attachUploads' => true,
    ];
 
    protected function ‪executeInternal()
    {
        $languageBackup = null;
        // Flexform overrides write strings instead of integers so
        // we need to cast the string '0' to false.
        if (
            isset($this->options['addHtmlPart'])
            && $this->options['addHtmlPart'] === '0'
        ) {
            $this->options['addHtmlPart'] = false;
        }
 
        $subject = $this->‪parseOption('subject');
        $recipients = $this->‪getRecipients('recipients', 'recipientAddress', 'recipientName');
        $senderAddress = $this->‪parseOption('senderAddress');
        $senderAddress = is_string($senderAddress) ? $senderAddress : '';
        $senderName = $this->‪parseOption('senderName');
        $senderName = is_string($senderName) ? $senderName : '';
        $replyToRecipients = $this->‪getRecipients('replyToRecipients', 'replyToAddress');
        $carbonCopyRecipients = $this->‪getRecipients('carbonCopyRecipients', 'carbonCopyAddress');
        $blindCarbonCopyRecipients = $this->‪getRecipients('blindCarbonCopyRecipients', 'blindCarbonCopyAddress');
        $addHtmlPart = $this->‪isHtmlPartAdded();
        $attachUploads = $this->‪parseOption('attachUploads');
        $useFluidEmail = $this->‪parseOption('useFluidEmail');
        $title = $this->‪parseOption('title');
        $title = is_string($title) && $title !== '' ? $title : $subject;
 
        if (empty($subject)) {
            throw new ‪FinisherException('The option "subject" must be set for the EmailFinisher.', 1327060320);
        }
        if (empty($recipients)) {
            throw new ‪FinisherException('The option "recipients" must be set for the EmailFinisher.', 1327060200);
        }
        if (empty($senderAddress)) {
            throw new ‪FinisherException('The option "senderAddress" must be set for the EmailFinisher.', 1327060210);
        }
 
        $formRuntime = $this->finisherContext->getFormRuntime();
 
        $translationService = ‪TranslationService::getInstance();
        if (is_string($this->options['translation']['language'] ?? null) && $this->options['translation']['language'] !== '') {
            $languageBackup = $translationService->getLanguage();
            $translationService->setLanguage($this->options['translation']['language']);
        }
 
        $mail = $useFluidEmail
            ? $this
                ->initializeFluidEmail($formRuntime)
                ->format($addHtmlPart ? ‪FluidEmail::FORMAT_BOTH : ‪FluidEmail::FORMAT_PLAIN)
                ->assign('title', $title)
            : GeneralUtility::makeInstance(MailMessage::class);
 
        $mail
            ->from(new Address($senderAddress, $senderName))
            ->to(...$recipients)
            ->subject($subject);
 
        if (!empty($replyToRecipients)) {
            $mail->replyTo(...$replyToRecipients);
        }
 
        if (!empty($carbonCopyRecipients)) {
            $mail->cc(...$carbonCopyRecipients);
        }
 
        if (!empty($blindCarbonCopyRecipients)) {
            $mail->bcc(...$blindCarbonCopyRecipients);
        }
 
        if (!$useFluidEmail) {
            $parts = [
                [
                    'format' => 'Plaintext',
                    'contentType' => 'text/plain',
                ],
            ];
 
            if ($addHtmlPart) {
                $parts[] = [
                    'format' => 'Html',
                    'contentType' => 'text/html',
                ];
            }
 
            foreach ($parts as $i => $part) {
                $standaloneView = $this->‪initializeStandaloneView($formRuntime, $part['format']);
                $message = $standaloneView->render();
 
                if ($part['contentType'] === 'text/plain') {
                    $mail->text($message);
                } else {
                    $mail->html($message);
                }
            }
        }
 
        if (!empty($languageBackup)) {
            $translationService->setLanguage($languageBackup);
        }
 
        $elements = $formRuntime->getFormDefinition()->getRenderablesRecursively();
 
        if ($attachUploads) {
            foreach ($elements as $element) {
                if (!$element instanceof ‪FileUpload) {
                    continue;
                }
                $file = $formRuntime[$element->getIdentifier()];
                if ($file) {
                    if ($file instanceof ‪FileReference) {
                        $file = $file->getOriginalResource();
                    }
 
                    $mail->attach($file->getContents(), $file->getName(), $file->getMimeType());
                }
            }
        }
 
        $useFluidEmail ? GeneralUtility::makeInstance(Mailer::class)->send($mail) : $mail->send();
    }
 
    protected function ‪initializeStandaloneView(‪FormRuntime $formRuntime, string $format): ‪StandaloneView
    {
        $standaloneView = $this->objectManager->get(StandaloneView::class);
 
        if (isset($this->options['templatePathAndFilename'])) {
            // Use local variable instead of augmenting the options to
            // keep the format intact when sending multi-format mails
            $templatePathAndFilename = strtr($this->options['templatePathAndFilename'], [
                '{@format}' => $format
            ]);
            $standaloneView->setTemplatePathAndFilename($templatePathAndFilename);
        } else {
            if (!isset($this->options['templateName'])) {
                throw new FinisherException('The option "templateName" must be set for the EmailFinisher.', 1327058829);
            }
            // Use local variable instead of augmenting the options to
            // keep the format intact when sending multi-format mails
            $templateName = strtr($this->options['templateName'], [
                '{@format}' => $format
            ]);
            $standaloneView->setTemplate($templateName);
        }
 
        $standaloneView->assign('finisherVariableProvider', $this->finisherContext->getFinisherVariableProvider());
 
        if (isset($this->options['templateRootPaths']) && is_array($this->options['templateRootPaths'])) {
            $standaloneView->setTemplateRootPaths($this->options['templateRootPaths']);
        }
 
        if (isset($this->options['partialRootPaths']) && is_array($this->options['partialRootPaths'])) {
            $standaloneView->setPartialRootPaths($this->options['partialRootPaths']);
        }
 
        if (isset($this->options['layoutRootPaths']) && is_array($this->options['layoutRootPaths'])) {
            $standaloneView->setLayoutRootPaths($this->options['layoutRootPaths']);
        }
 
        if (isset($this->options['variables'])) {
            $standaloneView->assignMultiple($this->options['variables']);
        }
 
        $standaloneView->assign('form', $formRuntime);
        $standaloneView->getRenderingContext()
                       ->getViewHelperVariableContainer()
                       ->addOrUpdate(RenderRenderableViewHelper::class, 'formRuntime', $formRuntime);
 
        return $standaloneView;
    }
 
    protected function ‪initializeFluidEmail(‪FormRuntime $formRuntime): ‪FluidEmail
    {
        $templateConfiguration = ‪$GLOBALS['TYPO3_CONF_VARS']['MAIL'];
 
        if (is_array($this->options['templateRootPaths'] ?? null)) {
            $templateConfiguration['templateRootPaths'] = array_replace_recursive(
                $templateConfiguration['templateRootPaths'],
                $this->options['templateRootPaths']
            );
            ksort($templateConfiguration['templateRootPaths']);
        }
 
        if (is_array($this->options['partialRootPaths'] ?? null)) {
            $templateConfiguration['partialRootPaths'] = array_replace_recursive(
                $templateConfiguration['partialRootPaths'],
                $this->options['partialRootPaths']
            );
            ksort($templateConfiguration['partialRootPaths']);
        }
 
        if (is_array($this->options['layoutRootPaths'] ?? null)) {
            $templateConfiguration['layoutRootPaths'] = array_replace_recursive(
                $templateConfiguration['layoutRootPaths'],
                $this->options['layoutRootPaths']
            );
            ksort($templateConfiguration['layoutRootPaths']);
        }
 
        $fluidEmail = GeneralUtility::makeInstance(
            FluidEmail::class,
            GeneralUtility::makeInstance(TemplatePaths::class, $templateConfiguration)
        );
 
        if (!isset($this->options['templateName']) || $this->options['templateName'] === '') {
            throw new ‪FinisherException('The option "templateName" must be set to use FluidEmail.', 1599834020);
        }
 
        // Migrate old template name to default FluidEmail name
        if ($this->options['templateName'] === '{@format}.html') {
            $this->options['templateName'] = 'Default';
        }
 
        // Set the PSR-7 request object if available
        if ((‪$GLOBALS['TYPO3_REQUEST'] ?? null) instanceof ServerRequestInterface) {
            $fluidEmail->setRequest(‪$GLOBALS['TYPO3_REQUEST']);
        }
 
        $fluidEmail
            ->setTemplate($this->options['templateName'])
            ->assignMultiple([
                'finisherVariableProvider' => $this->finisherContext->getFinisherVariableProvider(),
                'form' => $formRuntime
            ]);
 
        if (is_array($this->options['variables'] ?? null)) {
            $fluidEmail->assignMultiple($this->options['variables']);
        }
 
        $fluidEmail
            ->getViewHelperVariableContainer()
            ->addOrUpdate(RenderRenderableViewHelper::class, 'formRuntime', $formRuntime);
 
        return $fluidEmail;
    }
 
    protected function ‪getRecipients(
        string $listOption,
        string $singleAddressOption,
        string $singleAddressNameOption = null
    ): array {
        $recipients = $this->‪parseOption($listOption);
        $singleAddress = $this->‪parseOption($singleAddressOption);
        $singleAddressName = '';
 
        $recipients = $recipients ?? [];
 
        if (!empty($singleAddress)) {
            trigger_error(sprintf(
                'EmailFinisher option "%s" is deprecated and will be removed in TYPO3 v11.0. Use "%s" instead.',
                $singleAddressOption,
                $listOption
            ), E_USER_DEPRECATED);
 
            if (!empty($singleAddressNameOption)) {
                trigger_error(sprintf(
                    'EmailFinisher option "%s" is deprecated and will be removed in TYPO3 v11.0. Use "%s" instead.',
                    $singleAddressNameOption,
                    $listOption
                ), E_USER_DEPRECATED);
                $singleAddressName = $this->‪parseOption($singleAddressNameOption);
            }
 
            $recipients[$singleAddress] = $singleAddressName ?: '';
        }
 
        $addresses = [];
        foreach ($recipients as $address => $name) {
            if (‪MathUtility::canBeInterpretedAsInteger($address)) {
                $address = $name;
                $name = '';
            }
            // Drop entries without mail address
            if (empty($address)) {
                continue;
            }
            $addresses[] = new Address($address, $name);
        }
        return $addresses;
    }
 
    protected function ‪isHtmlPartAdded(): bool
    {
        $format = $this->‪parseOption('format');
 
        if ($format !== null) {
            trigger_error(
                'Usage of format option in form email finisher is deprecated - use addHtmlPart instead.',
                E_USER_DEPRECATED
            );
        }
 
        // FORMAT_HTML was the default value for "format", so
        // FORMAT_PLAINTEXT must have been set intentionally
        if ($format === self::FORMAT_PLAINTEXT) {
            return false;
        }
 
        return $this->‪parseOption('addHtmlPart') ? true : false;
    }
}