MailPostProcessor.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Form\PostProcess;

/*
 * 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!
 */

use TYPO3\CMS\Core\Mail\Rfc822AddressesParser;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MailUtility;
use TYPO3\CMS\Core\Utility\MathUtility;
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
use TYPO3\CMS\Form\Utility\FormUtility;

class MailPostProcessor extends AbstractPostProcessor implements PostProcessorInterface
{
    const LOCALISATION_OBJECT_NAME = 'tx_form_view_mail';

    protected $objectManager;

    protected $sessionUtility;

    protected $formUtility;

    protected $form;

    protected $typoScript;

    protected $mailMessage;

    protected $htmlMailTemplatePath = 'Html';

    protected $plaintextMailTemplatePath = 'Plain';

    protected $dirtyHeaders = [];

    public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManager $objectManager)
    {
        $this->objectManager = $objectManager;
    }

    public function injectSessionUtility(\TYPO3\CMS\Form\Utility\SessionUtility $sessionUtility)
    {
        $this->sessionUtility = $sessionUtility;
    }

    public function __construct(\TYPO3\CMS\Form\Domain\Model\Element $form, array $typoScript)
    {
        $this->form = $form;
        $this->typoScript = $typoScript;
        $this->mailMessage = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Mail\MailMessage::class);
        $this->setTemplatePaths();
    }

    public function process()
    {
        $this->formUtility = FormUtility::create($this->controllerContext->getConfiguration());
        $this->setSubject();
        $this->setFrom();
        $this->setTo();
        $this->setCc();
        $this->setReplyTo();
        $this->setPriority();
        $this->setOrganization();
        $this->setHtmlContent();
        $this->setPlainContent();
        $this->addAttachmentsFromSession();
        $this->send();
        return $this->render();
    }

    protected function setSubject()
    {
        if (isset($this->typoScript['subject'])) {
            $subject = $this->formUtility->renderItem(
                $this->typoScript['subject.'],
                $this->typoScript['subject']
            );
        } elseif ($this->getTypoScriptValueFromIncomingData('subjectField') !== null) {
            $subject = $this->getTypoScriptValueFromIncomingData('subjectField');
        } else {
            $subject = 'Formmail on ' . GeneralUtility::getIndpEnv('HTTP_HOST');
        }

        $subject = $this->sanitizeHeaderString($subject);
        $this->mailMessage->setSubject($subject);
    }

    protected function setFrom()
    {
        if (isset($this->typoScript['senderEmail'])) {
            $fromEmail = $this->formUtility->renderItem(
                $this->typoScript['senderEmail.'],
                $this->typoScript['senderEmail']
            );
        } elseif ($this->getTypoScriptValueFromIncomingData('senderEmailField') !== null) {
            $fromEmail = $this->getTypoScriptValueFromIncomingData('senderEmailField');
        } else {
            $fromEmail = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
        }
        if (!GeneralUtility::validEmail($fromEmail)) {
            $fromEmail = MailUtility::getSystemFromAddress();
        }
        if (isset($this->typoScript['senderName'])) {
            $fromName = $this->formUtility->renderItem(
                $this->typoScript['senderName.'],
                $this->typoScript['senderName']
            );
        } elseif ($this->getTypoScriptValueFromIncomingData('senderNameField') !== null) {
            $fromName = $this->getTypoScriptValueFromIncomingData('senderNameField');
        } else {
            $fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
        }
        $fromName = $this->sanitizeHeaderString($fromName);
        if (!empty($fromName)) {
            $from = [$fromEmail => $fromName];
        } else {
            $from = $fromEmail;
        }
        $this->mailMessage->setFrom($from);
    }

    protected function filterValidEmails($emails)
    {
        if (!is_string($emails)) {
            // No valid addresses - empty list
            return [];
        }

        $addressParser = GeneralUtility::makeInstance(Rfc822AddressesParser::class, $emails);
        $addresses = $addressParser->parseAddressList();

        $validEmails = [];
        foreach ($addresses as $address) {
            $fullAddress = $address->mailbox . '@' . $address->host;
            if (GeneralUtility::validEmail($fullAddress)) {
                if ($address->personal) {
                    $validEmails[$fullAddress] = $address->personal;
                } else {
                    $validEmails[] = $fullAddress;
                }
            }
        }
        return $validEmails;
    }

    protected function setTo()
    {
        $emails = $this->formUtility->renderItem(
            $this->typoScript['recipientEmail.'],
            $this->typoScript['recipientEmail']
        );
        $validEmails = $this->filterValidEmails($emails);
        if (!empty($validEmails)) {
            $this->mailMessage->setTo($validEmails);
        }
    }

    protected function setCc()
    {
        $emails = $this->formUtility->renderItem(
            $this->typoScript['ccEmail.'],
            $this->typoScript['ccEmail']
        );
        $validEmails = $this->filterValidEmails($emails);
        if (!empty($validEmails)) {
            $this->mailMessage->setCc($validEmails);
        }
    }

    protected function setReplyTo()
    {
        if (isset($this->typoScript['replyToEmail'])) {
            $emails = $this->formUtility->renderItem(
                $this->typoScript['replyToEmail.'],
                $this->typoScript['replyToEmail']
            );
        } elseif ($this->getTypoScriptValueFromIncomingData('replyToEmailField') !== null) {
            $emails = $this->getTypoScriptValueFromIncomingData('replyToEmailField');
        }
        $validEmails = $this->filterValidEmails($emails);
        if (!empty($validEmails)) {
            $this->mailMessage->setReplyTo($validEmails);
        }
    }

    protected function setPriority()
    {
        $priority = 3;
        if (isset($this->typoScript['priority'])) {
            $priorityFromTs = $this->formUtility->renderItem(
                $this->typoScript['priority.'],
                $this->typoScript['priority']
            );
        }
        if (!empty($priorityFromTs)) {
            $priority = MathUtility::forceIntegerInRange($priorityFromTs, 1, 5);
        }
        $this->mailMessage->setPriority($priority);
    }

    protected function setOrganization()
    {
        if (isset($this->typoScript['organization'])) {
            $organization = $this->formUtility->renderItem(
                $this->typoScript['organization.'],
                $this->typoScript['organization']
            );
        }
        if (!empty($organization)) {
            $organization = $this->sanitizeHeaderString($organization);
            $this->mailMessage->getHeaders()->addTextHeader('Organization', $organization);
        }
    }

    protected function setCharacterSet()
    {
        $characterSet = null;
        if ($GLOBALS['TSFE']->config['config']['formMailCharset']) {
            $characterSet = $GLOBALS['TSFE']->csConvObj->parse_charset($GLOBALS['TSFE']->config['config']['formMailCharset']);
        } elseif ($GLOBALS['TSFE']->metaCharset != $GLOBALS['TSFE']->renderCharset) {
            $characterSet = $GLOBALS['TSFE']->metaCharset;
        }
        if ($characterSet) {
            $this->mailMessage->setCharset($characterSet);
        }
    }

    protected function setHtmlContent()
    {
        $htmlContent = $this->getView($this->htmlMailTemplatePath)->render();
        $this->mailMessage->setBody($htmlContent, 'text/html');
    }

    protected function setPlainContent()
    {
        $plainContent = $this->getView($this->plaintextMailTemplatePath, 'Plain')->render();
        $this->mailMessage->addPart($plainContent, 'text/plain');
    }

    protected function send()
    {
        if ($this->mailMessage->getTo() && $this->mailMessage->getBody()) {
            $this->mailMessage->send();
        }
    }

    protected function render()
    {
        if ($this->mailMessage->isSent()) {
            $output = $this->renderMessage('success');
        } else {
            $output = $this->renderMessage('error');
        }
        return $output;
    }

    protected function sanitizeHeaderString($string)
    {
        $pattern = '/[\\r\\n\\f\\e]/';
        if (preg_match($pattern, $string) > 0) {
            $this->dirtyHeaders[] = $string;
            $string = '';
        }
        return $string;
    }

    protected function addAttachmentsFromSession()
    {
        $sessionData = $this->sessionUtility->getSessionData();
        if (is_array($sessionData)) {
            foreach ($sessionData as $fieldName => $values) {
                if (is_array($values)) {
                    foreach ($values as $file) {
                        if (isset($file['tempFilename'])) {
                            if (
                                is_file($file['tempFilename'])
                                && GeneralUtility::isAllowedAbsPath($file['tempFilename'])
                            ) {
                                $this->mailMessage->attach(\Swift_Attachment::fromPath($file['tempFilename'])->setFilename($file['name']));
                            }
                        }
                    }
                }
            }
        }
    }

    protected function setTemplatePaths()
    {
        if (
            isset($this->typoScript['htmlMailTemplatePath'])
            && $this->typoScript['htmlMailTemplatePath'] !== ''
        ) {
            $this->htmlMailTemplatePath = $this->typoScript['htmlMailTemplatePath'];
        }

        if (
            isset($this->typoScript['plaintextMailTemplatePath'])
            && $this->typoScript['plaintextMailTemplatePath'] !== ''
        ) {
            $this->plaintextMailTemplatePath = $this->typoScript['plaintextMailTemplatePath'];
        }
    }

    protected function getView($templateName, $scope = 'Html')
    {
        $configurationManager = $this->objectManager->get(\TYPO3\CMS\Extbase\Configuration\ConfigurationManager::class);
        $typoScript = $configurationManager->getConfiguration(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
        $view = $this->objectManager->get(\TYPO3\CMS\Fluid\View\StandaloneView::class);

        $viewParts = [
            'templateRootPaths' => $typoScript['view']['templateRootPaths'],
            'partialRootPaths' => $typoScript['view']['partialRootPaths'],
        ];
        /* Extend all template root paths to $templateRootPaths/PostProcessor/Mail/$themeName  */
        foreach ($typoScript['view']['templateRootPaths'] as &$path) {
            if (substr($path, -1) !== '/') {
                $path .= '/';
            }
            $path .= 'PostProcessor/Mail/' . $this->controllerContext->getConfiguration()->getThemeName();
        }
        /* Extend all partial root paths to $partialRootPaths/$themeName/PostProcessor/Mail/$scope/  */
        foreach ($typoScript['view']['partialRootPaths'] as &$path) {
            if (substr($path, -1) !== '/') {
                $path .= '/';
            }
            $path .=  $this->controllerContext->getConfiguration()->getThemeName() . '/PostProcessor/Mail/' . $scope . '/';
        }
        $view->setLayoutRootPaths($typoScript['view']['layoutRootPaths']);
        $view->setTemplateRootPaths($typoScript['view']['templateRootPaths']);
        $view->setPartialRootPaths($typoScript['view']['partialRootPaths']);
        $view->setTemplate($templateName);
        $view->assignMultiple([
            'model' => $this->form
        ]);
        return $view;
    }

    protected function renderMessage($messageType)
    {
        return $this->formUtility->renderItem(
            $this->typoScript['messages.'][$messageType . '.'],
            $this->typoScript['messages.'][$messageType],
            $this->getLocalLanguageLabel($messageType)
        );
    }

    protected function getLocalLanguageLabel($type = '')
    {
        $label = static::LOCALISATION_OBJECT_NAME . '.' . $type;
        $message = LocalizationUtility::translate($label, 'form');
        return $message;
    }

    protected function getTypoScriptValueFromIncomingData($propertyName)
    {
        if (empty($this->typoScript[$propertyName])) {
            return null;
        }

        $propertyValue = $this->typoScript[$propertyName];
        $incomingData = $this->controllerContext->getValidationElement();
        if (!$incomingData->hasIncomingField($propertyValue)) {
            return null;
        }

        return $incomingData->getIncomingField($propertyValue);
    }
}