MailTemplateService.php 38.9 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
use SGalinski\SgMail\Domain\Model\Layout;
31
32
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
Paul Ilea's avatar
Paul Ilea committed
33
use SGalinski\SgMail\Domain\Repository\LayoutRepository;
34
use SGalinski\SgMail\Domain\Repository\MailRepository;
35
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
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;
Paul Ilea's avatar
Paul Ilea committed
40
use TYPO3\CMS\Core\Routing\SiteMatcher;
41
use TYPO3\CMS\Core\Utility\GeneralUtility;
42
use TYPO3\CMS\Core\Utility\VersionNumberUtility;
43
use TYPO3\CMS\Extbase\Domain\Model\FileReference;
44
use TYPO3\CMS\Extbase\Object\ObjectManager;
45
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
46
47
use TYPO3\CMS\Fluid\View\StandaloneView;

48
49
50
/**
 * MailTemplateService
 */
51
class MailTemplateService {
52
53
54
55
56
57
58
59
60
61
	const MARKER_TYPE_STRING = 'String';
	const MARKER_TYPE_ARRAY = 'Array';
	const MARKER_TYPE_OBJECT = 'Object';
	const MARKER_TYPE_FILE = 'File';
	const DEFAULT_LANGUAGE = 'default';
	const DEFAULT_TEMPLATE_PATH = 'Resources/Private/Templates/SgMail/';
	const CACHE_NAME = 'sg_mail_registerArrayCache';
	const CACHE_LIFETIME_IN_SECONDS = 86400;
	const REGISTER_FILE = 'Register.php';
	const CONFIG_PATH = 'Configuration/MailTemplates';
62

63
	/**
64
	 * @var array
65
	 */
66
	private static $templateObjectCache = [];
67
68
69
70
71

	/**
	 * @var array
	 */
	private static $mailObjectCache = [];
72
73
74
75
76
77
78
79
80
81
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
	protected $templateRepository;
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\LayoutRepository
	 */
	protected $layoutRepository;
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
82
	 * @deprecated Not used since TYPO3 10
83
84
85
	 */
	protected $objectManager;
	/**
86
	 * @var \TYPO3\CMS\Core\Resource\ResourceFactory
87
88
	 */
	protected $resourceFactory;
89
	/**
90
	 * @var string $toAddresses
91
	 */
92
	private $toAddresses = '';
93
	/**
94
	 * @var string $fromAddress
95
	 */
96
	private $fromAddress = '';
97
	/**
98
	 * @var string $ccAddresses
99
	 */
Paul Ilea's avatar
Paul Ilea committed
100
	private $ccAddresses;
101
	/**
102
	 * @var string $replyToAddress
103
	 */
104
	private $replyToAddress = '';
105
	/**
106
	 * @var string $language
107
	 */
108
	private $language = 'default';
109
	/**
110
	 * @var boolean $ignoreMailQueue
111
	 */
112
	private $ignoreMailQueue = TRUE;
113
114
115
116
117
	/**
	 * @var \TYPO3\CMS\Core\Mail\MailMessage $mailMessage
	 */
	private $mailMessage;
	/**
118
	 * @var string $templateName
119
120
	 */
	private $templateName;
121
122
123
124
	/**
	 * @var string $subject
	 */
	private $subject;
125
126
127
128
	/**
	 * @var string $overwrittenEmailBody
	 */
	private $overwrittenEmailBody = '';
129
	/**
130
	 * @var string $extensionKey
131
132
133
	 */
	private $extensionKey;
	/**
134
	 * @var array $markers
135
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
136
	private $markers;
137
138
139
140
	/**
	 * @var array $markerLabels
	 */
	private $markerLabels;
141
	/**
142
	 * @var string $bccAddresses
143
	 */
Paul Ilea's avatar
Paul Ilea committed
144
	private $bccAddresses;
145
146
147
148
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;
149
150
151
152
	/**
	 * @var int
	 */
	private $pid;
153
154
155
156
	/**
	 * @var string
	 */
	private $fromName = '';
157
158
159
160
	/**
	 * @var string
	 */
	private $mailBodyToSend;
161

162
163
164
165
	/**
	 * @var string
	 */
	private $subjectToSend;
166

167
	/**
168
169
170
171
172
173
174
175
176
	 * @var string
	 */
	private $defaultFromAddress;

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

177
178
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
179
	 *
180
181
	 * @param string $templateName
	 * @param string $extensionKey
182
	 * @param array $markers
183
	 * @param array $markerLabels
Paul Ilea's avatar
Paul Ilea committed
184
	 * @throws \InvalidArgumentException
185
	 */
186
	public function __construct($templateName = '', $extensionKey = '', $markers = [], $markerLabels = []) {
187
188
189
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;
190
		$this->markerLabels = $markerLabels;
191

192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
		$this->resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class);
		$this->mailMessage = GeneralUtility::makeInstance(MailMessage::class);

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

209
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
210
		// use defaultMailFromAddress if it is provided in LocalConfiguration.php; use the sg_mail TS setting as fallback
211
		if (\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
212
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
213
			$this->defaultFromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
214
		} else {
215
216
217
218
219
220
221
			if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
				$this->fromAddress = 'noreply@example.org';
				$this->defaultFromAddress = 'noreply@example.org';
			} else {
				$this->fromAddress = $tsSettings['mail']['default']['from'];
				$this->defaultFromAddress = $tsSettings['mail']['default']['from'];
			}
222
223
		}

224
225
		if ($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$this->fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
226
			$this->defaultFromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
227
228
229
		}

		$this->mailMessage->setFrom($this->fromAddress, $this->fromName);
Torsten Oppermann's avatar
Torsten Oppermann committed
230
231
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
232
233

		foreach ($this->bccAddresses as $index => $email) {
234
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
235
236
237
238
239
240
241
242
243
244
				unset($this->bccAddresses[$index]);
			}
		}

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

245
		if (\count($this->bccAddresses) > 0) {
246
247
248
			$this->mailMessage->setBcc($this->bccAddresses);
		}

249
		if (\count($this->ccAddresses) > 0) {
250
251
			$this->mailMessage->setCc($this->ccAddresses);
		}
252
253
	}

254
255
256
257
258
	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
259
	public static function getReadableMarkerType($markerType) {
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
		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');
		}
	}

	/**
279
280
281
282
283
284
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
285
	 */
286
287
288
289
290
	public static function getDefaultTemplateMarker($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 [];
291
292
		}

293
294
295
296
297
298
299
300
301
		$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
			];
302
303
		}

304
		return $generatedMarker;
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
	}

	/**
	 * @param string $language
	 * @return MailTemplateService
	 */
	public function setLanguage($language): MailTemplateService {
		$this->language = $language;
		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;
	}

334
335
336
337
338
339
340
341
342
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

343
344
345
346
347
348
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function setMarkers(array $markers): MailTemplateService {
		$this->markers = $markers;
349
		foreach ($markers as $key => $currentMarker) {
350
			if (!\is_array($currentMarker) || !isset($currentMarker['markerLabel'])) {
351
352
353
354
355
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

356
357
358
359
360
361
362
363
364
365
366
367
368
		return $this;
	}

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

	/**
369
370
	 * Adds a file resource as attachment
	 *
371
372
	 * @param FileReference $fileReference
	 * @param File $file
373
374
	 *
	 * @return MailTemplateService
375
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
376
	 */
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
	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;
			}
394
395
396
397
		}

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
398
				'uid_local' => $file->getUid(),
399
400
401
402
403
404
405
406
407
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
		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;
	}

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

	/**
	 * @param string $subject
	 */
439
	public function setSubject(string $subject) {
440
441
442
		$this->subject = $subject;
	}

443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
	/**
	 * Set preview markers for the template editor
	 *
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 */
	public function setPreviewMarkers() {
		$previewMarker = [];

		// get default template content from register array
		$registerService = GeneralUtility::makeInstance(RegisterService::class);
		/** @var array $markerArray */
		$markerArray = $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];
				}
			}
			/** @noinspection SlowArrayOperationsInLoopInspection */
			$previewMarker = \array_merge_recursive($previewMarker, $temporaryMarkerArray);
		}
		$this->setMarkers($previewMarker);
	}

482
	/**
483
	 * Send the Email
484
	 *
485
486
487
488
489
490
491
	 * @param bool $isPreview
	 * @param Template|null $template
	 * @return bool email was sent or added to mail queue successfully?
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
492
	 */
493
494
495
	public function sendEmail($isPreview = FALSE, $isNewsletter = FALSE): bool {
		if ($isPreview) { //TODO: remove this from here
			$this->setIgnoreMailQueue(TRUE);
496
		}
497
		$success = FALSE;
498

499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
		// Get page ID
		// TODO: this doesn't belong here. The API user needs to provide the UID
		$siteRootId = $this->getSiteRootId();
		try {
			$template = $this->getTemplate($siteRootId);
		} catch (\Exception $e) {
			return FALSE;
		}

		$registerService = GeneralUtility::makeInstance(RegisterService::class);

		// 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, $registerService);

		// 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, $registerService, $defaultTemplateContent, $siteRootId);

		$mail = $this->addMailToMailQueue(
			$this->extensionKey, $this->templateName, $this->getSubjectToSend(), $this->getMailBodyToSend(),
			$this->priority,
			0, 0, $this->language, $siteRootId
		);
		self::$mailObjectCache[$mail->getUid()] = $mail; // add it to cache to avoid extra DB queries
		if ($this->ignoreMailQueue) {
			$success = $this->sendMailFromQueue($mail->getUid());
		}

		//TODO: this can be avoided if the sending logic is decoupled from this function
		if ($isPreview) {
538
539
540
541
542
543
544
			if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
				/** @var MailRepository $mailRepository */
				$mailRepository = $this->objectManager->get(MailRepository::class);
			} else {
				$mailRepository = GeneralUtility::makeInstance(MailRepository::class);
			}

545
			$mailRepository->remove($mail);
546
			$mailRepository->persist();
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
		}

		return $success;
	}

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

	/**
	 * Get site root ID
	 *
	 * @return int
	 */
	public function getSiteRootId(): int {
		$pageUid = $this->getPageUid();
		return BackendService::getSiteRoot($pageUid);
569
570
	}

571
	/**
572
	 * Gets the current PageUid
573
	 *
574
	 * @return int
575
	 */
576
	protected function getPageUid(): int {
577
		if (TYPO3_MODE === 'FE') {
578
			$pageUid = (int) $GLOBALS['TSFE']->id;
579
580
581
582
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

583
		if ($this->pid) {
584
			$pageUid = $this->pid;
585
		}
586

587
		if ($pageUid === 0) {
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
			$pageUid = $this->getAnyRootPageUid();
		}
		return $pageUid;
	}

	/**
	 * Gets the page uid of any root page in the page tree
	 *
	 * @return int
	 */
	private function getAnyRootPageUid() {
		$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(
			'pages'
		);
		$rootPageRows = $queryBuilder->select('*')
			->from('pages')
			->where(
				$queryBuilder->expr()->eq(
					'is_siteroot', 1
607
				)
608
609
610
611
			)
			->andWhere(
				$queryBuilder->expr()->eq(
					'hidden', 0
612
				)
613
614
			)
			->execute()->fetchAll();
615

616
617
		if ($rootPageRows && \count($rootPageRows)) {
			$pageUid = (int) $rootPageRows[0]['uid'];
618
		}
619
620
		return $pageUid;
	}
621

622
623
624
625
626
627
628
	/**
	 * Get the template object
	 *
	 * @param int $siteRootId
	 * @return null|object|Template|FALSE
	 * @throws \Exception
	 */
629
	private function getTemplate($siteRootId) {
630
631
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
632
			throw new \Exception('The template is blacklisted');
633
634
		}

635
636
637
638
639
		$templateHash = $this->getTemplateHash($this->extensionKey, $this->templateName, $siteRootId, $this->language);
		if (isset(self::$templateObjectCache[$templateHash])
			&& self::$templateObjectCache[$templateHash] instanceof Template) {
			return self::$templateObjectCache[$templateHash];
		}
640
		/** @var Template $template */
641
		$template = $this->templateRepository->findOneByTemplate(
642
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
643
		);
644

645
646
647
648
649
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}
650
		self::$templateObjectCache[$templateHash] = $template;
651
652
		return $template;
	}
653

654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
	/**
	 * 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;
	}

	/**
	 * Get the hash for the object cache
	 *
	 * @param $extensionKey
	 * @param $templateName
	 * @param $siteRootId
	 * @param $languageId
	 * @return string
	 */
	private function getTemplateHash($extensionKey, $templateName, $siteRootId, $languageId) {
		return md5($extensionKey . '_' . $templateName . '_' . $siteRootId . '_' . $languageId);
	}

	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
692
	private function loadTemplateValues(Template $template) {
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
		$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($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;
	}

	/**
	 * @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 $bccAddresses
	 * @return MailTemplateService
	 */
	public function setBccAddresses($bccAddresses): MailTemplateService {
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
		}

		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 $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
	}

792
793
794
	/**
	 * Get the default content for this template
	 *
795
796
	 * @param Template|null $template
	 * @param RegisterService $registerService
797
	 * @return bool|false|string
798
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
799
800
	 */
	protected function getDefaultTemplateContent($template, $registerService) {
801
802
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
803

804
		// If there is no template for this language, use the default template
805
		if ($template === NULL && $defaultTemplateContent === NULL) {
806
807
808
809
810
811
812
813
814
			$templatePath =
				$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
815
816
817
818
819
820
821
				if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
					/** @var TypoScriptSettingsService $typoScriptSettingsService */
					$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
				} else {
					$typoScriptSettingsService = GeneralUtility::makeInstance(TypoScriptSettingsService::class);
				}

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

827
828
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
829
				} else {
830
					return FALSE;
831
				}
832
			}
Torsten Oppermann's avatar
Torsten Oppermann committed
833
		}
834
835
		return $defaultTemplateContent;
	}
Torsten Oppermann's avatar
Torsten Oppermann committed
836

837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
	/**
	 * @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;
	}

853
	/**
854
855
856
	 * Sets the values to send the mail with from the template or register service
	 *
	 * @param Template|null $template
857
858
859
	 * @param RegisterService $registerService
	 * @param string $defaultTemplateContent
	 * @param int $siteRootId
860
	 * @param boolean $isNewsletter
861
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
862
	 */
863
	protected function parseValuesForMail(
864
		$template, RegisterService $registerService, $defaultTemplateContent,
865
		$siteRootId
866
	) {
867
868
869
870
871
872
873
		if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
			/** @var StandaloneView $emailView */
			$emailView = $this->objectManager->get(StandaloneView::class);
		} else {
			$emailView = GeneralUtility::makeInstance(StandaloneView::class);
		}

874
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
875
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
876
		$emailView->assign('all_fields_html', $this->getAllMarkerHTML($this->markers));
877

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

885
		// parse markers
Paul Ilea's avatar
Paul Ilea committed
886
		if ($template !== NULL) {
887
888
889
			$subject = $this->parseMarkers(
				trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject),
				$emailView
890
			);
891

892
893
			$layoutId = $template->getLayout();
			$templateContent = $template->getContent();
894
			$this->setSubjectToSend($subject);
895
		} else {
896
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
897
898
			if (\is_array($subject)) {
				$subject = \trim(
899
900
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
901
				);
902
			}
903
904
905
906
			$subject = $this->parseMarkers(
				(empty($overwrittenSubject) ? $subject : $overwrittenSubject),
				$emailView
			);
907

908
909
910
			$layoutId = 0;
			$templateContent = $defaultTemplateContent;
		}
911

912
		$this->setSubjectToSend($subject);
913
		$this->mailMessage->setSubject($subject);
914

915
916
		// Parse the markers
		if ($this->fromName) {
917
			$this->setFromName($this->parseMarkers($this->fromName, $emailView));
918
919
		}

920
		if ($this->fromAddress) {
921
			$this->setFromAddress($this->parseMarkers($this->fromAddress, $emailView));
922
923
		}

924
		if ($this->replyToAddress) {
925
			$this->setReplyToAddress($this->parseMarkers($this->replyToAddress, $emailView));
926
927
		}

928
929
		if ($this->ccAddresses) {
			$this->setCcAddresses($this->parseMarkers($this->ccAddresses, $emailView));
930
931
		}

932
		if ($this->bccAddresses) {
933
			$this->setBccAddresses($this->parseMarkers($this->bccAddresses, $emailView));
934
935
		}

936
		if ($this->toAddresses) {
937
			$this->setToAddresses($this->parseMarkers($this->toAddresses, $emailView));
938
939
940
941
		}

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

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

950
951
952
953
954
955
956
		$layout = $this->getLayoutSource($layoutId, $siteRootId);
		$emailHTMLHead = '';
		if ($layout) {
			$emailHTMLHead = $layout->getHeadContent();
			$emailBody = \str_replace('###CONTENT###', $emailBody, $layout->getContent());
		}
		$this->mailBodyToSend = '<html><head>' . $emailHTMLHead . '</head><body>' . $emailBody . '</body></html>';
957
958
959
	}

	/**
960
	 * Get a single variable containing a list of all markers
961
	 *
962
963
	 * @param array $markers
	 * @return string
964
	 */
965
966
	private function getAllMarker(array $markers): string {
		$allMarker = '';
967

968
969
970
971
		foreach ($markers as $key => $value) {
			if (\array_key_exists($key, $this->markerLabels) && $this->markerLabels[$key] !== NULL) {
				$key = $this->markerLabels[$key];
			}
972

973
974
975
976
977
978
979
980
981
			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;
982
983
			} elseif ($value instanceof DateTime) {
				$allMarker .= $key . ': ' . $value->format('d.m.Y') . PHP_EOL;
984
985
986
987
988
			} elseif (\is_object($value)) {
				if (\method_exists($value, '__toString')) {
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
			}
989
990
		}

991
992
		return $allMarker;
	}
993

994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
	/**
	 * 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)) {
1010
				$allMarker .= '<tr><th>' . $key . ' </th><td> ' . $value . '</td></tr>';
1011
1012
			} elseif (\is_array($value)) {
				foreach ($value as $innerKey => $innerValue) {
1013
					$allMarker .= '<tr><th>' . $key . '.' . $innerKey . ' </th><td> ' . $innerValue . '</td></tr>';
1014
1015
1016
				}
			} elseif (\is_bool($value)) {
				$valueAsString = $value ? 'true' : 'false';
1017
				$allMarker .= '<tr><th>' . $key . ' </th><td> ' . $valueAsString . '</td></tr>';
1018
1019
			} elseif ($value instanceof DateTime) {
				$allMarker .= '<tr><th>' . $key . ' </th><td> ' . $value->format('d.m.Y') . '</td></tr>';
1020
1021
			} elseif (\is_object($value)) {
				if (\method_exists($value, '__toString')) {
1022
					$allMarker .= '<tr><th>' . $key . ' </th><td> ' . $value->__toString() . '</td></tr>';
1023
1024
1025
1026
1027
1028
1029
1030
1031
				}
			}
		}

		$allMarker .= '</table>';

		return $allMarker;
	}

1032
1033
1034
1035
1036
1037
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}
1038

1039
1040
1041
1042
1043
1044
	/**
	 * @param string $overwrittenEmailBody
	 */
	public function setOverwrittenEmailBody(string $overwrittenEmailBody) {
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}
1045

1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
	/**
	 * 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 mixed
	 */
	protected function parseMarkers($text, $emailView) {
		$text = (string) $text;
		if (strpos($text, '{') !== FALSE) {
			$emailView->setTemplateSource($text);
			return $emailView->render();
1059
		}
1060

1061
		return $text;
1062
1063
	}

Paul Ilea's avatar
Paul Ilea committed
1064
	/**
1065
	 * Returns the layout.
Paul Ilea's avatar
Paul Ilea committed
1066
1067
1068
	 *
	 * @param int $layoutUid
	 * @param int $siteRootId
1069
	 * @return Layout|NULL
Paul Ilea's avatar
Paul Ilea committed
1070
	 */
1071
	private function getLayoutSource(int $layoutUid, int $siteRootId) {
Paul Ilea's avatar
Paul Ilea committed
1072
1073
1074
1075
1076
		$languageUid = 0;
		if ($this->language !== self::DEFAULT_LANGUAGE) {
			$languageUid = (int) array_search($this->language, $this->getAvailableLanguages(), TRUE);
		}

1077
		return $this->layoutRepository->findByUidOrDefault($layoutUid, $siteRootId, $languageUid);
Paul Ilea's avatar
Paul Ilea committed
1078
1079
1080
	}

	/**
1081
	 * Returns the list of available translation languages
Paul Ilea's avatar
Paul Ilea committed
1082
1083
1084
1085
1086
	 *
	 * @return array
	 */
	private function getAvailableLanguages(): array {
		$out = [0 => ''];
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
		try {
			$site = GeneralUtility::makeInstance(SiteMatcher::class)->matchByPageId(0);
		} catch (\Exception $exception) {
			return [0 => ''];
		}
		$availableLanguages = $site->getLanguages();
		$out = [];
		foreach ($availableLanguages as $language) {
			$languageId = $language->getLanguageId();
			if ($languageId < 0) {
				continue;
Paul Ilea's avatar
Paul Ilea committed
1098
			}
1099
			$out[$language->getLanguageId()] = strtolower($language->getTwoLetterIsoCode());
Paul Ilea's avatar
Paul Ilea committed
1100
1101
1102
1103
		}
		return $out;
	}

1104
	/**
1105
	 * Adds a new mail to the mail queue.
1106
	 *
1107
1108
	 * @param string $extensionKey
	 * @param string $templateName
1109
	 * @param string $subject
1110
	 * @param string $emailBody
1111
	 * @param int $sendingTime
1112
	 * @param int $priority
1113
	 * @param int $lastSendingTime
1114
	 * @param string $language
1115
	 * @param int $pid
1116
	 * @return Mail
1117
1118
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
1119
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
1120
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
1121
	 */
1122
	private function addMailToMailQueue(
1123
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
1124
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
1125
	): Mail {
1126
		$mail = new Mail();
1127
		$mail->setPid($pid);
1128
1129
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
1130
		$mail->setLanguage($language);
1131
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
1132

1133
		$mail->setFromAddress($this->fromAddress);
1134
		$mail->setFromName($this->fromName);
1135

1136
		$mail->setToAddress($this->toAddresses);
1137
		$mail->setMailSubject($subject);
1138
		$mail->setMailBody($emailBody);
1139
		$mail->setPriority($priority);
1140
1141
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
1142
		$mail->setSendingTime($sendingTime);
1143
		$mail->setLastSendingTime($lastSendingTime);
1144
		$mail->setReplyTo($this->replyToAddress);
1145
1146
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
				// 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 \TYPO3\CMS\Core\Resource\FileReference) {
					$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
						[
							'uid_local' => $originalResource->getOriginalFile()->getUid(),
							'table_local' => 'sys_file',
							'uid' => uniqid('NEW_MAIL', TRUE)
						]
					);
1158
					$newFileReference = new FileReference();
1159
1160
1161
					$newFileReference->setOriginalResource($coreFileReferenceMailFile);
					$mail->addAttachment($newFileReference);
				}
1162
1163
			}
		}
1164

1165
1166
1167
1168
1169
1170
1171
		if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
			/** @var MailRepository $mailRepository */
			$mailRepository = $this->objectManager->get(MailRepository::class);
		} else {
			$mailRepository = GeneralUtility::makeInstance(MailRepository::class);
		}

1172
		$mailRepository->add($mail);
1173
		$mailRepository->persist();
1174
		return $mail;
1175
	}
1176

1177
	/**
1178
	 * @return string
1179
	 */
1180
1181
1182
1183
1184
1185
1186
	public function getSubjectToSend(): string {
		return $this->subjectToSend;
	}