MailTemplateService.php

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) sgalinski Internet Services (https://www.sgalinski.de)
 *
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
namespace SGalinski\SgMail\Service;

use DateTime;
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
use SGalinski\SgMail\Domain\Repository\LayoutRepository;
use SGalinski\SgMail\Domain\Repository\MailRepository;
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
use Swift_Attachment;
use Symfony\Component\Mailer\Exception\TransportException;
use TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException;
use TYPO3\CMS\Core\Mail\MailMessage;
use TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException;
use TYPO3\CMS\Core\Resource\File;
use TYPO3\CMS\Core\Resource\FileInterface;
use TYPO3\CMS\Core\Resource\FileReference as CoreFileReference;
use TYPO3\CMS\Core\Resource\ResourceFactory;
use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
use TYPO3\CMS\Core\Site\SiteFinder;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\VersionNumberUtility;
use TYPO3\CMS\Extbase\Domain\Model\FileReference;
use TYPO3\CMS\Extbase\Object\Exception;
use TYPO3\CMS\Extbase\Object\ObjectManager;
use TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException;
use TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException;
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
use TYPO3\CMS\Fluid\View\StandaloneView;
use function array_key_exists;
use function array_merge;
use function array_merge_recursive;
use function array_reverse;
use function count;
use function file_exists;
use function file_get_contents;
use function filter_var;
use function is_array;
use function is_bool;
use function is_object;
use function is_string;
use function method_exists;
use function nl2br;
use function preg_replace;
use function str_replace;
use function trim;

/**
 * MailTemplateService
 */
class MailTemplateService {
	public const MARKER_TYPE_STRING = 'String';
	public const MARKER_TYPE_ARRAY = 'Array';
	public const MARKER_TYPE_OBJECT = 'Object';
	public const MARKER_TYPE_FILE = 'File';
	public const DEFAULT_LANGUAGE = 'default';
	public const DEFAULT_TEMPLATE_PATH = 'Resources/Private/Templates/SgMail/';
	public const CACHE_NAME = 'sg_mail_registerArrayCache';
	public const CACHE_LIFETIME_IN_SECONDS = 86400;
	public const REGISTER_FILE = 'Register.php';
	public const CONFIG_PATH = 'Configuration/MailTemplates';

	/**
	 * @var array
	 */
	private static $templateObjectCache = [];

	/**
	 * @var array
	 */
	private static $mailObjectCache = [];

	/**
	 * @var TemplateRepository
	 */
	protected $templateRepository;

	/**
	 * @var LayoutRepository
	 */
	protected $layoutRepository;

	/**
	 * @var MailRepository
	 */
	protected $mailRepository;

	/**
	 * @var ObjectManager
	 * @deprecated Not used since TYPO3 10
	 */
	protected $objectManager;

	/**
	 * @var RegisterService
	 */
	protected $registerService;

	/**
	 * @var string $toAddresses
	 */
	private $toAddresses = '';

	/**
	 * @var string $fromAddress
	 */
	private $fromAddress = '';

	/**
	 * @var string $ccAddresses
	 */
	private $ccAddresses;

	/**
	 * @var string $replyToAddress
	 */
	private $replyToAddress = '';

	/**
	 * @var SiteLanguage
	 */
	private $siteLanguage;

	/**
	 * @var boolean $ignoreMailQueue
	 */
	private $ignoreMailQueue = TRUE;

	/**
	 * @var string $templateName
	 */
	private $templateName;

	/**
	 * @var string $subject
	 */
	private $subject;

	/**
	 * @var string $overwrittenEmailBody
	 */
	private $overwrittenEmailBody = '';

	/**
	 * @var string $extensionKey
	 */
	private $extensionKey;

	/**
	 * @var array $markers
	 */
	private $markers;

	/**
	 * @var array $markerLabels
	 */
	private $markerLabels;

	/**
	 * @var string $bccAddresses
	 */
	private $bccAddresses;

	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

	/**
	 * @var int
	 */
	private $pid;

	/**
	 * @var string
	 */
	private $fromName = '';

	/**
	 * @var string
	 */
	private $mailBodyToSend = '';

	/**
	 * @var string
	 */
	private $subjectToSend;

	/**
	 * MailTemplateService constructor.
	 *
	 * @param string $templateName
	 * @param string $extensionKey
	 * @param array $markers
	 * @param array $markerLabels
	 * @throws Exception
	 */
	public function __construct(string $templateName = '', string $extensionKey = '', array $markers = [], array $markerLabels = []) {
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;
		$this->markerLabels = $markerLabels;

		$this->registerService = GeneralUtility::makeInstance(RegisterService::class);
		if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0')) {
			$this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
			/** @var TypoScriptSettingsService $typoScriptSettingsService */
			$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
		} else {
			$typoScriptSettingsService = GeneralUtility::makeInstance(TypoScriptSettingsService::class);
		}

		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
		// use defaultMailFromAddress if it is provided in LocalConfiguration.php; use the sg_mail TS setting as fallback
		if (filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
		} else if (!filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
			$this->fromAddress = 'noreply@example.org';
		} else {
			$this->fromAddress = $tsSettings['mail']['default']['from'];
		}

		if ($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$this->fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
		foreach ($this->bccAddresses as $index => $email) {
			if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
				unset($this->bccAddresses[$index]);
			}
		}

		foreach ($this->ccAddresses as $index => $email) {
			if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
				unset($this->ccAddresses[$index]);
			}
		}
	}

	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
	public static function getDefaultTemplateMarker(string $translationKey, array $marker, $extensionKey = 'sg_mail'): array {
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
		// Need the key for translations
		if (trim($extensionKey) === '') {
			return [];
		}

		$generatedMarker = [];
		foreach ($marker as $markerName) {
			$generatedMarker[] = [
				'marker' => $markerName,
				'value' => $languagePath . '.example.' . $markerName,
				'description' => $languagePath . '.description.' . $markerName,
				'backend_translation_key' => $translationKey . '.example.' . $markerName,
				'extension_key' => $extensionKey
			];
		}

		return $generatedMarker;
	}

	/**
	 * Adds a file resource as attachment
	 *
	 * @param FileReference|null $fileReference
	 * @param File|null $file
	 *
	 * @return MailTemplateService
	 */
	public function addFileResourceAttachment(
		FileReference $fileReference = NULL, FileInterface $file = NULL
	): MailTemplateService {
		if (!$file) {
			if (!$fileReference) {
				return $this;
			}

			$originalResource = $fileReference->getOriginalResource();
			if (!$originalResource) {
				return $this;
			}

			$file = $originalResource->getOriginalFile();
			if (!$file) {
				return $this;
			}
		}

		$coreFileReferenceMailFile = GeneralUtility::makeInstance(ResourceFactory::class)
			->createFileReferenceObject(
			[
				'uid_local' => $file->getUid(),
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

		$newFileReference = GeneralUtility::makeInstance(FileReference::class);
		$newFileReference->setOriginalResource($coreFileReferenceMailFile);

		$this->markers[] = $newFileReference;
		return $this;
	}

	/**
	 * Set preview markers for the template editor
	 *
	 * @throws NoSuchCacheException
	 */
	public function setPreviewMarkers(): void {
		$previewMarkers = [];

		/** @var array $markerArray */
		$markerArray = $this->registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
		foreach ($markerArray as $marker) {
			$markerPath = GeneralUtility::trimExplode('.', $marker['marker']);
			$temporaryMarkerArray = [];
			foreach (array_reverse($markerPath) as $index => $markerPathSegment) {
				if ($index === 0) {
					if ($marker['markerLabel']) {
						$markerPathSegment = $marker['markerLabel'];
					}

					if ($marker['backend_translation_key']) {
						$temporaryMarkerArray[$markerPathSegment] = LocalizationUtility::translate(
							$marker['backend_translation_key'], $marker['extension_key']
						);
					} else {
						$temporaryMarkerArray[$markerPathSegment] = $marker['value'];
					}
				} else {
					$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
				}
			}

			$previewMarkers[] = $temporaryMarkerArray;
		}

		$this->setMarkers(array_merge_recursive(...$previewMarkers));
	}

	/**
	 * Send the Email
	 *
	 * @param bool $isPreview
	 * @param bool $isNewsletter
	 * @return bool email was sent or added to mail queue successfully?
	 * @throws NoSuchCacheException
	 * @throws ResourceDoesNotExistException
	 * @throws IllegalObjectTypeException
	 * @throws UnknownObjectException
	 */
	public function sendEmail(bool $isPreview = FALSE, bool $isNewsletter = FALSE): bool {
		try {
			$template = $this->getTemplate();
		} catch (\Exception $e) {
			return FALSE;
		}

		// Load the values from the template if they are set
		if (!$isNewsletter && $template !== NULL) {
			$this->loadTemplateValues($template);
		}

		// get default template content from register array
		$defaultTemplateContent = $this->getDefaultTemplateContent($template);

		// set the ToAddress if there are no placeholders in it
		// TODO: does this belong here?
		if ($template !== NULL && filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
			$this->setToAddresses(trim($template->getToAddress()));
		}

		$this->parseValuesForMail($template, $defaultTemplateContent);

		$mail = $this->addMailToMailQueue();
		self::$mailObjectCache[$mail->getUid()] = $mail; // add it to cache to avoid extra DB queries
		$success = FALSE;
		if ($this->ignoreMailQueue) {
			$success = $this->sendMailFromQueue($mail->getUid());
		}

		return $success;
	}

	/**
	 * Get the template object
	 *
	 * @return null|Template
	 * @throws \Exception
	 */
	private function getTemplate(): ?Template {
		$isTemplateBlacklisted = $this->registerService->isTemplateBlacklisted(
			$this->extensionKey,
			$this->templateName,
			$this->pid
		);
		if ($isTemplateBlacklisted) {
			throw new \Exception('The template is blacklisted');
		}

		$templateHash = $this->getTemplateHash();
		if (
			isset(self::$templateObjectCache[$templateHash])
			&& self::$templateObjectCache[$templateHash] instanceof Template
		) {
			return self::$templateObjectCache[$templateHash];
		}

		/** @var Template $template */
		$template = $this->getTemplateRepository()->findByTemplateProperties(
			$this->extensionKey, $this->templateName, [$this->siteLanguage], $this->pid
		)->getFirst();

		if ($template === NULL) {
			$site = GeneralUtility::makeInstance(SiteFinder::class)->getSiteByPageId($this->pid);
			$fallbackLanguages = [];
			foreach ($this->siteLanguage->getFallbackLanguageIds() as $fallbackLanguageId) {
				$fallbackLanguages[] = $site->getLanguageById($fallbackLanguageId);
			}

			$template = $this->getTemplateRepository()->findByTemplateProperties(
				$this->extensionKey, $this->templateName, $fallbackLanguages, $this->pid
			)->getFirst();
		}

		self::$templateObjectCache[$templateHash] = $template;
		return $template;
	}

	/**
	 * Get the hash for the object cache
	 *
	 * @return string
	 */
	private function getTemplateHash(): string {
		return md5(
			$this->extensionKey . '_' .
			$this->templateName . '_' .
			$this->pid . '_' .
			$this->siteLanguage->getLanguageId()
		);
	}

	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
	private function loadTemplateValues(Template $template): void {
		$this->resetTemplate();
		$this->extensionKey = $template->getExtensionKey();
		$this->templateName = $template->getTemplateName();

		$fromName = trim($template->getFromName());
		if ($fromName === '') {
			$fromName = $this->fromName;
		}

		if ($fromName === '' && $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

		$fromMail = $this->getValidFromMail(trim($template->getFromMail()));
		// The setters check if the value is empty or not
		$this->setFromAddress($fromMail, $fromName);
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
		$this->setFromName($fromName);
	}

	/**
	 * Sets the fromMail property of the mailTemplateService.
	 * Checks validity and uses all available fallbacks
	 *
	 * @param string $fromMail
	 * @return string
	 */
	private function getValidFromMail(string $fromMail): string {
		$fromMail = trim($fromMail);
		if (!filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
			$fromMail = $this->fromAddress;
		}

		if (!filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
			$fromMail = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
			if (!filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
				$fromMail = 'noreply@example.com';
			}
		}

		return $fromMail;
	}



	/**
	 * Get the default content for this template
	 *
	 * @param Template|null $template
	 * @return bool|string
	 * @throws Exception
	 * @throws NoSuchCacheException
	 */
	protected function getDefaultTemplateContent(Template $template = NULL) {
		$defaultTemplateContent =
			$this->registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];

		// If there is no template for this language, use the default template
		if ($template === NULL && $defaultTemplateContent === NULL) {
			$templatePath =
				$this->registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];

			// only standard template file is considered since version 4.1
			$defaultTemplateFile = $templatePath . 'template.html';
			if (file_exists($defaultTemplateFile)) {
				$defaultTemplateContent = file_get_contents($defaultTemplateFile);
			} else {
				// use configured default html template
				if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
					/** @var TypoScriptSettingsService $typoScriptSettingsService */
					$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
				} else {
					$typoScriptSettingsService = GeneralUtility::makeInstance(TypoScriptSettingsService::class);
				}

				$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
				$defaultTemplateFile = GeneralUtility::getFileAbsFileName(
					$tsSettings['mail']['defaultHtmlTemplate']
				);

				if (file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = file_get_contents($defaultTemplateFile);
				} else {
					return FALSE;
				}
			}
		}

		return $defaultTemplateContent;
	}

	/**
	 * @param string $toAddresses
	 * @return MailTemplateService
	 */
	public function setToAddresses(string $toAddresses): MailTemplateService {
		$normalizedToAddresses = trim(preg_replace('~\x{00a0}~iu', ' ', $toAddresses));
		$this->toAddresses = $normalizedToAddresses;
		return $this;
	}

	/**
	 * Sets the values to send the mail with from the template or register service
	 *
	 * @param Template|null $template
	 * @param string $defaultTemplateContent
	 * @throws Exception
	 * @throws NoSuchCacheException
	 */
	protected function parseValuesForMail(
		Template $template = NULL, string $defaultTemplateContent = ''
	): void {
		if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
			/** @var StandaloneView $emailView */
			$emailView = $this->objectManager->get(StandaloneView::class);
		} else {
			$emailView = GeneralUtility::makeInstance(StandaloneView::class);
		}

		$emailView->assignMultiple($this->markers);
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
		$emailView->assign('all_fields_html', $this->getAllMarkerHTML($this->markers));

		//TODO: make this as the lines below the next block
		$overwrittenEmailBody = $this->getOverwrittenEmailBody();
		$overwrittenSubject = '';
		if ($this->subject !== '' && $this->subject !== NULL) {
			$overwrittenSubject = $this->subject;
		}

		// parse markers
		if ($template !== NULL) {
			$subject = $this->parseMarkers(
				trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject),
				$emailView
			);
			$layoutId = $template->getLayout();
			$templateContent = $template->getContent();
			$this->setSubjectToSend($subject);
		} else {
			$subject = $this->registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
			if (is_array($subject)) {
				$subject = trim(
					$this->registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->siteLanguage->getTypo3Language()]
				);
			}

			$subject = $this->parseMarkers(
				(empty($overwrittenSubject) ? $subject : $overwrittenSubject),
				$emailView
			);

			$layoutId = 0;
			$templateContent = $defaultTemplateContent;
		}

		$this->setSubjectToSend($subject);

		// Parse the markers
		if ($this->fromName) {
			$this->setFromName($this->parseMarkers($this->fromName, $emailView));
		}

		if ($this->fromAddress) {
			$this->setFromAddress($this->parseMarkers($this->fromAddress, $emailView));
		}

		if ($this->replyToAddress) {
			$this->setReplyToAddress($this->parseMarkers($this->replyToAddress, $emailView));
		}

		if ($this->ccAddresses) {
			$this->setCcAddresses($this->parseMarkers($this->ccAddresses, $emailView));
		}

		if ($this->bccAddresses) {
			$this->setBccAddresses($this->parseMarkers($this->bccAddresses, $emailView));
		}

		if ($this->toAddresses) {
			$this->setToAddresses($this->parseMarkers($this->toAddresses, $emailView));
		}

		// reset template source back to default
		$emailView->setTemplateSource(
			empty($overwrittenEmailBody) ? $templateContent : $overwrittenEmailBody
		);

		// insert <br> tags, but replace every instance of three or more successive breaks with just two.
		$emailBody = $emailView->render();
		$emailBody = nl2br($emailBody);
		$emailBody = preg_replace('/(<br[\s]?[\/]?>[\s]*){3,}/', '<br><br>', $emailBody);

		$layout = $this->getLayoutRepository()->findByUidOrDefault(
			$layoutId,
			$this->pid,
			$this->siteLanguage->getLanguageId()
		);
		$emailHTMLHead = '';
		if ($layout) {
			$emailHTMLHead = $layout->getHeadContent();
			$emailBody = str_replace('###CONTENT###', $emailBody, $layout->getContent());
		}

		$this->mailBodyToSend = '<html><head>' . $emailHTMLHead . '</head><body>' . $emailBody . '</body></html>';
	}

	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
	private function getAllMarker(array $markers): string {
		$allMarker = '';
		foreach ($markers as $key => $value) {
			if (array_key_exists($key, $this->markerLabels) && $this->markerLabels[$key] !== NULL) {
				$key = $this->markerLabels[$key];
			}

			if (is_string($value)) {
				$allMarker .= $key . ': ' . $value . PHP_EOL;
			} elseif (is_array($value)) {
				foreach ($value as $innerKey => $innerValue) {
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
				}
			} elseif (is_bool($value)) {
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
			} elseif (is_object($value)) {
				if (method_exists($value, '__toString')) {
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
			}
		}

		return $allMarker;
	}

	/**
	 * Get a single variable containing a list of all markers in table markup
	 *
	 * @param array $markers
	 * @return string
	 */
	private function getAllMarkerHTML(array $markers): string {
		$allMarker = '<table>';
		$allMarker .= '<style> table { text-align: left; } table tr th, table tr td { border-bottom: 1px solid rgba(0,0,0,0.2); padding: 2px 6px 4px;} </style>';
		foreach ($markers as $key => $value) {
			if (array_key_exists($key, $this->markerLabels) && $this->markerLabels[$key] !== NULL) {
				$key = $this->markerLabels[$key];
			}

			if (is_string($value)) {
				$allMarker .= '<tr><th>' . $key . ' </th><td> ' . $value . '</td></tr>';
			} elseif (is_array($value)) {
				foreach ($value as $innerKey => $innerValue) {
					$allMarker .= '<tr><th>' . $key . '.' . $innerKey . ' </th><td> ' . $innerValue . '</td></tr>';
				}
			} elseif (is_bool($value)) {
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= '<tr><th>' . $key . ' </th><td> ' . $valueAsString . '</td></tr>';
			} elseif (is_object($value)) {
				if (method_exists($value, '__toString')) {
					$allMarker .= '<tr><th>' . $key . ' </th><td> ' . $value->__toString() . '</td></tr>';
				}
			}
		}

		return $allMarker . '</table>';
	}

	/**
	 * Parses markers in an email View.
	 * !!! CHANGES THE SOURCE PATH AND IT SHOULD BE RESET BACK TO THE ORIGINAL!!!
	 *
	 * @param string $text
	 * @param StandaloneView $emailView
	 * @return string
	 */
	protected function parseMarkers(string $text, StandaloneView $emailView): string {
		if (strpos($text, '{') !== FALSE) {
			$emailView->setTemplateSource($text);
			return $emailView->render();
		}

		return $text;
	}

	/**
	 * Adds a new mail to the mail queue.
	 *
	 * @return Mail
	 * @throws Exception
	 * @throws IllegalObjectTypeException
	 * @throws NoSuchCacheException
	 */
	private function addMailToMailQueue(): Mail {
		$mail = GeneralUtility::makeInstance(Mail::class);
		$mail->setPid($this->pid);
		$mail->setExtensionKey($this->extensionKey);
		$mail->setTemplateName($this->templateName);
		$mail->setLanguage(explode('.', $this->siteLanguage->getLocale())[0]);
		$mail->setBlacklisted(
			$this->registerService->isTemplateBlacklisted(
				$this->extensionKey,
				$this->templateName,
				$this->pid
			)
		);
		$mail->setFromAddress($this->fromAddress);
		$mail->setFromName($this->fromName);
		$mail->setToAddress($this->toAddresses);
		$mail->setMailSubject($this->getSubjectToSend());
		$mail->setMailBody($this->getMailBodyToSend());
		$mail->setPriority($this->priority);
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
		$mail->setSendingTime(0);
		$mail->setLastSendingTime(0);
		$mail->setReplyTo($this->replyToAddress);
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				// we need to create proper copies of the attachment so that the original file reference does not get
				// moved over to the mail model and worst case, the original model loses the reference because of this
				$originalResource = $marker->getOriginalResource();
				if ($originalResource instanceof CoreFileReference) {
					$coreFileReferenceMailFile = GeneralUtility::makeInstance(ResourceFactory::class)
						->createFileReferenceObject(
						[
							'uid_local' => $originalResource->getOriginalFile()->getUid(),
							'table_local' => 'sys_file',
							'uid' => uniqid('NEW_MAIL', TRUE)
						]
					);
					$newFileReference = GeneralUtility::makeInstance(FileReference::class);
					$newFileReference->setOriginalResource($coreFileReferenceMailFile);
					$mail->addAttachment($newFileReference);
				}
			}
		}

		$mailRepository = $this->getMailRepository();
		$mailRepository->add($mail);
		$mailRepository->persist();
		return $mail;
	}

	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
	 * @return bool
	 * @throws Exception
	 */
	public function sendMailFromQueue(int $uid): bool {
		if (!isset(self::$mailObjectCache[$uid]) || !self::$mailObjectCache[$uid] instanceof Mail) {
			$mailToSend = $this->getMailObjectByUid($uid);
			if ($mailToSend === FALSE) {
				return FALSE;
			}
		} else {
			$mailToSend = self::$mailObjectCache[$uid];
		}

		$this->sendMailsFromQueue([$mailToSend]);
		$success = FALSE;
		if ($mailToSend->getStatus() === Mail::STATUS_SENT) {
			$success = TRUE;
		}

		unset(self::$mailObjectCache[$uid]); // free the memory
		return $success;
	}

	/**
	 * Get the mail object by uid and check if it's blacklisted
	 *
	 * @param int $uid
	 * @return bool|object
	 * @throws Exception
	 */
	protected function getMailObjectByUid(int $uid): ?Mail {
		if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
			/** @var MailRepository $mailRepository */
			$mailRepository = $this->objectManager->get(MailRepository::class);
		} else {
			$mailRepository = GeneralUtility::makeInstance(MailRepository::class);
		}

		$mailObject = $mailRepository->findOneByUid($uid);
		if (!$mailObject || $mailObject->getBlacklisted()) {
			return NULL;
		}

		return $mailObject;
	}

	/**
	 * Add html and plain body text to the mail message object
	 *
	 * @param MailMessage $mailMessage
	 * @param string $htmlBody
	 * @param string $plainBody
	 */
	protected static function addBodyToMailMessage(MailMessage $mailMessage, string $htmlBody = '', string $plainBody = ''): void {
		if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
			$mailMessage->setBody($htmlBody, 'text/html');
			$mailMessage->addPart($plainBody, 'text/plain');
		} else {
			$mailMessage->html($htmlBody);
			$mailMessage->text($plainBody);
		}
	}

	/**
	 * Attach a file
	 * @param MailMessage $mailMessage
	 * @param FileInterface $file
	 */
	protected static function attachToMailMessage(MailMessage $mailMessage, FileInterface $file): void {
		if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
			$mailMessage->attach(
				Swift_Attachment::newInstance($file->getContents(), $file->getName(), $file->getMimeType())
			);
		} else {
			$mailMessage->attach(
				$file->getContents(), $file->getName(), $file->getMimeType()
			);
		}
	}

	/**
	 *
	 * @param Mail[] $mails
	 * @throws Exception
	 * @throws IllegalObjectTypeException
	 * @throws UnknownObjectException
	 */
	public function sendMailsFromQueue(array $mails): void {
		foreach ($mails as $mail) {
			$mailMessage = GeneralUtility::makeInstance(MailMessage::class);
			$toAddresses = trim($mail->getToAddress());
			$addressesArray = GeneralUtility::trimExplode(',', $mail->getToAddress(), TRUE);
			if (count($addressesArray) > 1) {
				$toAddresses = $addressesArray;
			}

			$mailMessage->setTo($toAddresses);
			$mailMessage->setFrom($mail->getFromAddress(), $mail->getFromName());
			$mailMessage->setCc(
				GeneralUtility::trimExplode(',', $mail->getCcAddresses(), TRUE)
			);
			$mailMessage->setBcc(
				GeneralUtility::trimExplode(',', $mail->getBccAddresses(), TRUE)
			);
			$mailMessage->setSubject($mail->getMailSubject());
			$plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
			$plaintextBody = $plaintextService->makePlain($mail->getMailBody());
			self::addBodyToMailMessage($mailMessage, $mail->getMailBody(), $plaintextBody);

			if ($mail->getBccAddresses()) {
				$mailMessage->setBcc(GeneralUtility::trimExplode(',', $mail->getBccAddresses()));
			}

			if ($mail->getCcAddresses()) {
				$mailMessage->setCc(GeneralUtility::trimExplode(',', $mail->getCcAddresses()));
			}

			if ($mail->getReplyTo()) {
				$mailMessage->setReplyTo($mail->getReplyTo());
			}

			$attachments = $mail->getAttachments();
			if ($attachments->count() > 0) {
				foreach ($attachments as $attachment) {
					/**
					 * @var FileReference $attachment
					 */
					$originalResource = $attachment->getOriginalResource();
					if ($originalResource === NULL) {
						continue;
					}

					$file = $originalResource->getOriginalFile();
					self::attachToMailMessage($mailMessage, $file);
				}
			}

			$dateTime = new DateTime();
			if ($mail->getSendingTime() === 0) {
				$mail->setSendingTime($dateTime->getTimestamp());
			}

			$mail->setLastSendingTime($dateTime->getTimestamp());
			try {
				$success = $mailMessage->send();
				if (!$success) {
					$mail->setStatus(Mail::STATUS_ERROR);
					$mail->setErrorMessage(LocalizationUtility::translate('backend.success_mail_queue', 'sg_mail'));
				}
				$mail->setStatus(Mail::STATUS_SENT);
			} catch (TransportException $exception) {
				$mail->setStatus(Mail::STATUS_ERROR);
				$mail->setErrorMessage($exception->getMessage());
			}

			$this->getMailRepository()->update($mail);
		}

		$this->getMailRepository()->persist();
	}

	/**
	 * @param SiteLanguage $siteLanguage
	 * @return $this
	 */
	public function setSiteLanguage(SiteLanguage $siteLanguage): MailTemplateService {
		$this->siteLanguage = $siteLanguage;
		return $this;
	}

	/**
	 * @param string $templateName
	 * @return MailTemplateService
	 */
	public function setTemplateName(string $templateName): MailTemplateService {
		$this->templateName = $templateName;
		return $this;
	}

	/**
	 * @param string $extensionKey
	 * @return MailTemplateService
	 */
	public function setExtensionKey(string $extensionKey): MailTemplateService {
		$this->extensionKey = $extensionKey;
		return $this;
	}

	/**