MailTemplateService.php 27.2 KB
Newer Older
1
2
3
4
<?php

namespace SGalinski\SgMail\Service;

5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/***************************************************************
 *  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!
 ***************************************************************/
28

29
use DateTime;
30
31
32
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
use SGalinski\SgMail\Domain\Repository\MailRepository;
33
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
34
35
use Swift_Attachment;
use Swift_OutputByteStream;
36
use TYPO3\CMS\Core\Database\ConnectionPool;
37
use TYPO3\CMS\Core\Mail\MailMessage;
38
use TYPO3\CMS\Core\Resource\File;
39
use TYPO3\CMS\Core\Resource\ResourceFactory;
40
use TYPO3\CMS\Core\Utility\GeneralUtility;
41
use TYPO3\CMS\Extbase\Domain\Model\FileReference;
42
use TYPO3\CMS\Extbase\Object\ObjectManager;
43
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
44
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
45
use TYPO3\CMS\Fluid\View\StandaloneView;
46
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
47

48
49
50
/**
 * MailTemplateService
 */
51
class MailTemplateService {
Torsten Oppermann's avatar
Torsten Oppermann committed
52
53
54
55
56
57
58
59
60
61
	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';
62

63
	/**
64
	 * @var string $toAddresses
65
	 */
66
	private $toAddresses = '';
67
68

	/**
69
	 * @var string $fromAddress
70
	 */
71
	private $fromAddress = '';
72
73

	/**
74
	 * @var string $ccAddresses
75
	 */
Paul Ilea's avatar
Paul Ilea committed
76
	private $ccAddresses;
77
78

	/**
79
	 * @var string $replyToAddress
80
	 */
81
	private $replyToAddress = '';
82
83

	/**
84
	 * @var string $language
85
	 */
86
	private $language = 'default';
87
88

	/**
89
	 * @var boolean $ignoreMailQueue
90
	 */
91
	private $ignoreMailQueue = FALSE;
92
93
94
95
96
97
98

	/**
	 * @var \TYPO3\CMS\Core\Mail\MailMessage $mailMessage
	 */
	private $mailMessage;

	/**
99
	 * @var string $templateName
100
101
102
	 */
	private $templateName;

103
104
105
106
107
	/**
	 * @var string $subject
	 */
	private $subject;

108
109
110
111
112
	/**
	 * @var string $overwrittenEmailBody
	 */
	private $overwrittenEmailBody = '';

113
	/**
114
	 * @var string $extensionKey
115
116
117
118
	 */
	private $extensionKey;

	/**
119
	 * @var array $markers
120
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
121
	private $markers;
122

123
124
125
126
127
	/**
	 * @var array $markerLabels
	 */
	private $markerLabels;

128
	/**
129
	 * @var string $bccAddresses
130
	 */
Paul Ilea's avatar
Paul Ilea committed
131
	private $bccAddresses;
132

133
134
135
136
137
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

138
139
140
141
142
	/**
	 * @var int
	 */
	private $pid;

143
144
145
146
147
	/**
	 * @var string
	 */
	private $fromName = '';

148
149
150
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
151
152
153
154
155
156
	protected $templateRepository;

	/**
	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager
	 */
	protected $persistenceManager;
157

158
159
160
161
162
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

163
164
165
166
167
	/**
	 * @var TYPO3\CMS\Core\Resource\ResourceFactory
	 */
	protected $resourceFactory;

168
169
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
170
	 *
171
172
	 * @param string $templateName
	 * @param string $extensionKey
173
	 * @param array $markers
174
	 * @param array $markerLabels
Paul Ilea's avatar
Paul Ilea committed
175
	 * @throws \InvalidArgumentException
176
	 */
177
	public function __construct($templateName = '', $extensionKey = '', $markers = [], $markerLabels = []) {
178
179
180
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;
181
		$this->markerLabels = $markerLabels;
182

183
184
185
186
		/** @var ObjectManager objectManager */
		$this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
		$this->mailMessage = $this->objectManager->get(MailMessage::class);
		$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
Torsten Oppermann's avatar
Torsten Oppermann committed
187
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
188
189
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
190
		$this->resourceFactory = $this->objectManager->get(ResourceFactory::class);
191

192
		// use defaultMailFromAddress if it is provided in LocalConfiguration.php; use the sg_mail TS setting as fallback
193
		if (\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
194
195
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
		} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
196
			$this->fromAddress = $tsSettings['mail']['default']['from'];
197

198
			if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
199
200
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
201
				$this->fromAddress = $tsSettings['mail']['default']['from'];
202
			}
203
204
		}

205
206
207
208
209
		if ($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$this->fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

		$this->mailMessage->setFrom($this->fromAddress, $this->fromName);
Torsten Oppermann's avatar
Torsten Oppermann committed
210
211
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
212
213

		foreach ($this->bccAddresses as $index => $email) {
214
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
215
216
217
218
219
220
221
222
223
224
				unset($this->bccAddresses[$index]);
			}
		}

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

225
		if (\count($this->bccAddresses) > 0) {
226
227
228
			$this->mailMessage->setBcc($this->bccAddresses);
		}

229
		if (\count($this->ccAddresses) > 0) {
230
231
			$this->mailMessage->setCc($this->ccAddresses);
		}
232
233
	}

234
235
236
	/**
	 * @param string $fromName
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
237
	public function setFromName($fromName): void {
238
239
240
241
242
243
244
245
		$this->fromName = $fromName;
	}

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
246
	public static function getReadableMarkerType($markerType): void {
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
		switch ($markerType) {
			case self::MARKER_TYPE_STRING :
				LocalizationUtility::translate('backend.marker.type.string', 'sg_mail');
				break;
			case self::MARKER_TYPE_ARRAY :
				LocalizationUtility::translate('backend.marker.type.array', 'sg_mail');
				break;
			case self::MARKER_TYPE_OBJECT :
				LocalizationUtility::translate('backend.marker.type.object', 'sg_mail');
				break;
			case self::MARKER_TYPE_FILE:
				LocalizationUtility::translate('backend.marker.type.file', 'sg_mail');
				break;
			default:
				LocalizationUtility::translate('backend.marker.type.mixed', 'sg_mail');
		}
	}

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

		$addressesArray = GeneralUtility::trimExplode(',', $normalizedToAddresses, TRUE);
		if (\count($addressesArray) > 1) {
			$normalizedToAddresses = $addressesArray;
		}
		$this->mailMessage->setTo($normalizedToAddresses);
		return $this;
	}

	/**
	 * @param string $fromAddress
	 * @param string $fromName
	 * @return MailTemplateService
	 */
	public function setFromAddress($fromAddress, $fromName = ''): MailTemplateService {
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

		return $this;
	}

	/**
	 * @param string $ccAddresses
	 * @return MailTemplateService
	 */
	public function setCcAddresses($ccAddresses): MailTemplateService {
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
		}

		return $this;
	}

	/**
	 * @param string $replyToAddress
	 * @return MailTemplateService
	 */
	public function setReplyToAddress($replyToAddress): MailTemplateService {
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

		return $this;
	}

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

	/**
	 * @param boolean $ignoreMailQueue
	 * @return MailTemplateService
	 */
	public function setIgnoreMailQueue($ignoreMailQueue): MailTemplateService {
		$this->ignoreMailQueue = $ignoreMailQueue;
		return $this;
	}

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

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

357
358
359
360
361
362
363
364
365
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

366
367
368
369
370
371
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function setMarkers(array $markers): MailTemplateService {
		$this->markers = $markers;
372
		foreach ($markers as $key => $currentMarker) {
373
			if (!\is_array($currentMarker) || !isset($currentMarker['markerLabel'])) {
374
375
376
377
378
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
		return $this;
	}

	/**
	 * @param string $bccAddresses
	 * @return MailTemplateService
	 */
	public function setBccAddresses($bccAddresses): MailTemplateService {
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
		}

		return $this;
	}

	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority): MailTemplateService {
		$this->priority = $priority;
		return $this;
	}

	/**
	 * @param Swift_OutputByteStream $data
	 * @param string $filename
	 * @param string $contentType
	 * @return MailTemplateService
	 */
	public function addAttachment($data, $filename, $contentType): MailTemplateService {
		$attachment = Swift_Attachment::newInstance()
			->setFilename($filename)
			->setContentType($contentType)
			->setBody($data);
		$this->mailMessage->attach($attachment);
		return $this;
	}

	/**
420
421
	 * Adds a file resource as attachment
	 *
422
423
	 * @param FileReference $fileReference
	 * @param File $file
424
425
	 *
	 * @return MailTemplateService
426
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
427
	 */
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
	public function addFileResourceAttachment(
		FileReference $fileReference = NULL, File $file = NULL
	): MailTemplateService {
		if (!$file) {
			if (!$fileReference) {
				return $this;
			}

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

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

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
449
				'uid_local' => $file->getUid(),
450
451
452
453
454
455
456
457
458
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
		return $this;
	}

	/**
	 * @return MailMessage
	 */
	public function getMailMessage(): MailMessage {
		return $this->mailMessage;
	}

	/**
	 * set the page id from which this was called
	 *
	 * @param int $pid
	 * @return MailTemplateService
	 */
	public function setPid($pid): MailTemplateService {
		$this->pid = (int) $pid;
		return $this;
	}

	/**
	 * Checks if a template is blacklisted for a given siteroot id
	 *
	 * @param string $extensionKey
	 * @param string $templateName
	 * @param int $siteRootId
	 * @return boolean
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 */
	public static function isTemplateBlacklisted($extensionKey, $templateName, $siteRootId): bool {
		$nonBlacklistedTemplates = BackendService::getNonBlacklistedTemplates($siteRootId);
		if ($nonBlacklistedTemplates[$extensionKey]) {
			return $nonBlacklistedTemplates[$extensionKey][$templateName] ? FALSE : TRUE;
		}

		return TRUE;
	}

	/**
	 * @return string
	 */
	public function getSubject(): string {
		return $this->subject;
	}

	/**
	 * @param string $subject
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
510
	public function setSubject(string $subject): void {
511
512
513
		$this->subject = $subject;
	}

514
515
516
517
518
519
520
521
522
523
524
525
526
527
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}

	/**
	 * @param string $overwrittenEmailBody
	 */
	public function setOverwrittenEmailBody(string $overwrittenEmailBody): void {
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}

528
529
530
531
532
533
534
535
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
536
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail'): array {
537
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
538
		// Need the key for translations
539
		if (\trim($extensionKey) === '') {
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
			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;
	}

557
	/**
558
	 * Send the Email
559
	 *
560
561
	 * @param bool $isPreview
	 * @return bool email was sent or added to mail queue successfully?
562
563
564
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
565
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
566
	 * @throws \Exception
567
	 */
568
	public function sendEmail($isPreview = FALSE): bool {
569
		$success = FALSE;
570
		if (TYPO3_MODE === 'FE') {
571
572
573
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
574
575
576
577
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

578
		if ($this->pid) {
579
			$pageUid = $this->pid;
580
		}
581

582
		if ($pageUid === 0) {
583
584
			$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(
				'pages'
585
			);
586
			$rootPageRows = $queryBuilder->select('*')
587
				->from('pages')
588
589
590
591
592
593
594
595
596
597
598
599
				->where(
					$queryBuilder->expr()->eq(
						'is_siteroot', 1
					)
				)
				->andWhere(
					$queryBuilder->expr()->eq(
						'hidden', 0
					)
				)
				->execute()->fetchAll();

600
601
602
			if ($rootPageRows && \count($rootPageRows)) {
				$pageUid = (int) $rootPageRows[0]['uid'];
			}
603
		}
604
		$siteRootId = BackendService::getSiteRoot($pageUid);
605

606
607
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
608
609
			// @TODO throw error or log ?
			return FALSE;
610
611
		}

612
		/** @var Template $template */
613
		$template = $this->templateRepository->findOneByTemplate(
614
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
615
		);
616

617
618
619
620
621
622
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

623
624
625
626
627
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

628
		// get default template content from register array
629
		$registerService = GeneralUtility::makeInstance(RegisterService::class);
630
631
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
632

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

639
640
				// only standard template file is considered since version 4.1
				$defaultTemplateFile = $templatePath . 'template.html';
641
642
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
643
				} else {
644
645
646
647
648
649
650
651
					// use configured default html template
					/** @var TypoScriptSettingsService $typoScriptSettingsService */
					$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
					$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
					$defaultTemplateFile = GeneralUtility::getFileAbsFileName(
						$tsSettings['mail']['defaultHtmlTemplate']
					);

652
653
					if (\file_exists($defaultTemplateFile)) {
						$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
654
					} else {
655
						return FALSE;
656
					}
657
				}
658
			}
659
660
		} elseif (\filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
			$this->setToAddresses(\trim($template->getToAddress()));
661
662
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
663
664
		if ($isPreview) {
			$previewMarker = [];
665

666
			/** @var array $markerArray */
667
			$markerArray = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
Torsten Oppermann's avatar
Torsten Oppermann committed
668
			foreach ($markerArray as $marker) {
669
670
				$markerPath = GeneralUtility::trimExplode('.', $marker['marker']);
				$temporaryMarkerArray = [];
671
				foreach (\array_reverse($markerPath) as $index => $markerPathSegment) {
672
					if ($index === 0) {
673
674
675
676
						if ($marker['markerLabel']) {
							$markerPathSegment = $marker['markerLabel'];
						}

677
678
679
680
681
682
683
684
						if ($marker['backend_translation_key']) {
							$temporaryMarkerArray[$markerPathSegment] = LocalizationUtility::translate(
								$marker['backend_translation_key'], $marker['extension_key']
							);
						} else {
							$temporaryMarkerArray[$markerPathSegment] = $marker['value'];
						}
					} else {
685
						$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
686
					}
687
				}
688
				/** @noinspection SlowArrayOperationsInLoopInspection */
689
				$previewMarker = \array_merge_recursive($previewMarker, $temporaryMarkerArray);
Torsten Oppermann's avatar
Torsten Oppermann committed
690
			}
691
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
692
693
694
			$this->setMarkers($previewMarker);
		}

695
		/** @var StandaloneView $emailView */
696
		$emailView = $this->objectManager->get(StandaloneView::class);
697
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
698
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
699

700
701
702
703
704
705
		$overwrittenEmailBody = $this->getOverwrittenEmailBody();
		$overwrittenSubject = '';
		if ($this->subject !== '' && $this->subject !== NULL) {
			$overwrittenSubject = $this->subject;
		}

Paul Ilea's avatar
Paul Ilea committed
706
		if ($template !== NULL) {
707
708
709
			$emailView->setTemplateSource(
				\trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject)
			);
710
711
			$subject = $emailView->render();

712
713
714
			$emailView->setTemplateSource(
				empty($overwrittenEmailBody) ? $template->getContent() : $overwrittenEmailBody
			);
715
		} else {
716
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
717
718
			if (\is_array($subject)) {
				$subject = \trim(
719
720
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
721
				);
722
			}
723

724
725
726
727
728
729
			$emailView->setTemplateSource(empty($overwrittenSubject) ? $subject : $overwrittenSubject);
			$subject = $emailView->render();

			$emailView->setTemplateSource(
				empty($overwrittenEmailBody) ? $defaultTemplateContent : $overwrittenEmailBody
			);
730
731
		}

732
		$this->mailMessage->setSubject($subject);
733

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

739
740
741
742
743
744
745
746
747
748
749
750
		$mail = $this->addMailToMailQueue(
			$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
			0, 0, $this->language, $siteRootId
		);
		if ($this->ignoreMailQueue) {
			$success = $this->sendMailFromQueue($mail->getUid());
		}

		if ($isPreview) {
			$mailRepository = $this->objectManager->get(MailRepository::class);
			$mailRepository->remove($mail);
			$this->persistenceManager->persistAll();
751
		}
752

753
		return $success;
754
755
756
	}

	/**
757
	 * Adds a new mail to the mail queue.
758
	 *
759
760
	 * @param string $extensionKey
	 * @param string $templateName
761
	 * @param string $subject
762
	 * @param string $emailBody
763
	 * @param int $sendingTime
764
	 * @param int $priority
765
	 * @param int $lastSendingTime
766
	 * @param string $language
767
	 * @param int $pid
768
	 * @return Mail
769
770
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
771
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
772
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
773
	 */
774
	private function addMailToMailQueue(
775
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
776
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
777
	): Mail {
778
		$mail = $this->objectManager->get(Mail::class);
779
		$mail->setPid($pid);
780
781
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
782
		$mail->setLanguage($language);
783
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
784

785
		$mail->setFromAddress($this->fromAddress);
786
		$mail->setFromName($this->fromName);
787

788
		$mail->setToAddress($this->toAddresses);
789
		$mail->setMailSubject($subject);
790
		$mail->setMailBody($emailBody);
791
		$mail->setPriority($priority);
792
793
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
794
		$mail->setSendingTime($sendingTime);
795
		$mail->setLastSendingTime($lastSendingTime);
796
		$mail->setReplyTo($this->replyToAddress);
797
798
799
800
801
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
802

803
		$mailRepository = $this->objectManager->get(MailRepository::class);
804
		$mailRepository->add($mail);
805
		$this->persistenceManager->persistAll();
806
		return $mail;
807
	}
808

809
810
811
812
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
813
	 * @return bool
Paul Ilea's avatar
Paul Ilea committed
814
815
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
816
	 * @throws \Exception
817
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
818
	public function sendMailFromQueue($uid): ?bool {
819
820
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
821
		$mailToSend = $mailRepository->findOneByUid($uid);
822
823
824
		if (!$mailToSend || $mailToSend->getBlacklisted()) {
			return FALSE;
		}
825

826
827
828
829
830
831
832
833
834
835
836
837
		$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
		$plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
		$plaintextBody = $plaintextService->makePlain($mailToSend->getMailBody());
		$this->mailMessage->addPart($plaintextBody, 'text/plain');
		$toAddresses = \trim($mailToSend->getToAddress());
		$addressesArray = GeneralUtility::trimExplode(',', $toAddresses, TRUE);
		if (\count($addressesArray) > 1) {
			$toAddresses = $addressesArray;
		}
		$this->mailMessage->setTo($toAddresses);
		$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
		$this->mailMessage->setSubject($mailToSend->getMailSubject());
838

839
840
841
		if ($mailToSend->getBccAddresses()) {
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
		}
842

843
844
845
		if ($mailToSend->getCcAddresses()) {
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
		}
846

847
848
849
850
851
852
853
854
855
856
857
858
859
		if ($mailToSend->getReplyTo()) {
			$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
		}
		$attachments = $mailToSend->getAttachments();
		if ($attachments->count() > 0) {
			foreach ($attachments as $attachment) {
				/**
				 * @var FileReference $attachment
				 */
				$file = $attachment->getOriginalResource()->getOriginalFile();
				$this->mailMessage->attach(
					\Swift_Attachment::newInstance($file->getContents(), $file->getName(), $file->getMimeType())
				);
860
			}
861
		}
862
863
864
865
866
867
868
869
870
871
872
873
		$dateTime = new DateTime();
		if ((int) $mailToSend->getSendingTime() === 0) {
			$mailToSend->setSendingTime($dateTime->getTimestamp());
		}
		$mailToSend->setLastSendingTime($dateTime->getTimestamp());
		$success = $this->mailMessage->send();
		if ($success) {
			$mailRepository->update($mailToSend);
		} else {
			$this->mailMessage->getFailedRecipients();
		}
		return $success;
874
875
	}

876
877
878
879
880
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
881
	private function loadTemplateValues($template): void {
882
		$fromName = \trim($template->getFromName());
883
884
885
		if ($fromName === '') {
			$fromName = $this->fromName;
		}
886
887
888
889
		if ($fromName === '' && $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
		$fromMail = $this->getValidFromMail(\trim($template->getFromMail()));
		$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($fromMail): string {
		$fromMail = \trim($fromMail);
		if (!\filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
908
909
			$fromMail = $this->fromAddress;
		}
910
		if (!\filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
911
			$fromMail = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
912
			if (!\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
913
914
915
916
				$fromMail = 'noreply@example.com';
			}
		}

917
		return $fromMail;
918
919
	}

920
921
922
923
924
925
	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
926
	private function getAllMarker(array $markers): string {
927
928
929
		$allMarker = '';

		foreach ($markers as $key => $value) {
930
			if (\array_key_exists($key, $this->markerLabels) && $this->markerLabels[$key] !== NULL) {
931
932
				$key = $this->markerLabels[$key];
			}
933

934
			if (\is_string($value)) {
935
				$allMarker .= $key . ': ' . $value . PHP_EOL;
936
			} elseif (\is_array($value)) {
937
				foreach ($value as $innerKey => $innerValue) {
Torsten Oppermann's avatar
Torsten Oppermann committed
938
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
939
				}
940
			} elseif (\is_bool($value)) {
Torsten Oppermann's avatar
Torsten Oppermann committed
941
942
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
943
			} elseif (\is_object($value)) {
944
				if (\method_exists($value, '__toString')) {
945
946
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
947
948
949
950
951
			}
		}

		return $allMarker;
	}
952
}