MailTemplateService.php 21.4 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
37
use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
38
use TYPO3\CMS\Core\Mail\MailMessage;
39
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
40
41
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManager;
42
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
43
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
44
use TYPO3\CMS\Fluid\View\StandaloneView;
45
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
46

47
48
49
/**
 * MailTemplateService
 */
50
class MailTemplateService {
51
	const MARKER_TYPE_STRING = 'String';
52
53
	const MARKER_TYPE_ARRAY = 'Array';
	const MARKER_TYPE_OBJECT = 'Object';
54
	const DEFAULT_LANGUAGE = 'default';
55
	const DEFAULT_TEMPLATE_PATH = 'Resources/Private/Templates/SgMail/';
56
57
	const CACHE_NAME = 'sg_mail_registerArrayCache';
	const CACHE_LIFETIME_IN_SECONDS = 86400;
58

59
	/**
60
	 * @var array $toAddresses
61
	 */
62
	private $toAddresses = [];
63
64

	/**
65
	 * @var string $fromAddress
66
	 */
67
	private $fromAddress;
68
69

	/**
70
	 * @var array $ccAddresses
71
	 */
Paul Ilea's avatar
Paul Ilea committed
72
	private $ccAddresses;
73
74

	/**
75
	 * @var string $replyToAddress
76
	 */
77
	private $replyToAddress;
78
79

	/**
80
	 * @var string $language
81
	 */
82
	private $language = 'default';
83
84

	/**
85
	 * @var boolean $ignoreMailQueue
86
	 */
87
	private $ignoreMailQueue = FALSE;
88
89
90
91
92
93
94

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

	/**
95
	 * @var string $templateName
96
97
98
99
	 */
	private $templateName;

	/**
100
	 * @var string $extensionKey
101
102
103
104
	 */
	private $extensionKey;

	/**
105
	 * @var array $markers
106
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
107
	private $markers;
108

109
110
111
	/**
	 * @var array $bccAddresses
	 */
Paul Ilea's avatar
Paul Ilea committed
112
	private $bccAddresses;
113

114
115
116
117
118
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

119
120
121
122
123
	/**
	 * @var int
	 */
	private $pid;

124
125
126
127
128
	/**
	 * @var string
	 */
	private $fromName = '';

129
130
131
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
132
133
134
135
136
137
	protected $templateRepository;

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

139
140
141
142
143
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

144
145
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
146
	 *
147
148
149
	 * @param string $templateName
	 * @param string $extensionKey
	 * @param string $markers
Paul Ilea's avatar
Paul Ilea committed
150
	 * @throws \InvalidArgumentException
151
	 */
152
153
154
155
156
	public function __construct($templateName = '', $extensionKey = '', $markers = '') {
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;

157
158
159
160
161
162
		/** @var ObjectManager objectManager */
		$this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
		/** @var MailMessage mailMessage */
		$this->mailMessage = $this->objectManager->get(MailMessage::class);
		/** @var TypoScriptSettingsService $typoScriptSettingsService */
		$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
Torsten Oppermann's avatar
Torsten Oppermann committed
163
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
164
165
166
167
		/** @var TemplateRepository templateRepository */
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		/** @var PersistenceManager persistenceManager */
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
168

169
		// use defaultMailFromAddress if it is provided in LocalConfiguration.php; use the sg_mail TS setting as fallback
170
		if (!filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
171
172
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
		} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
173
			$this->fromAddress = $tsSettings['mail']['default']['from'];
174

Torsten Oppermann's avatar
Torsten Oppermann committed
175
			if (!filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
176
177
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
178
				$this->fromAddress = $tsSettings['mail']['default']['from'];
179
			}
180
181
		}

182
		$this->mailMessage->setFrom($this->fromAddress);
183

Torsten Oppermann's avatar
Torsten Oppermann committed
184
185
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
186
187
188
189
190
191
192
193
194
195
196
197
198

		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]);
			}
		}

199
		if (count($this->bccAddresses) > 0) {
200
201
202
			$this->mailMessage->setBcc($this->bccAddresses);
		}

203
		if (count($this->ccAddresses) > 0) {
204
205
			$this->mailMessage->setCc($this->ccAddresses);
		}
206
207
	}

208
209
210
211
212
213
214
215
216
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail') {
217
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237

		// 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;
	}

238
	/**
239
	 * Send the Email
240
	 *
Torsten Oppermann's avatar
Torsten Oppermann committed
241
	 * @param boolean $isPreview
242
	 * @return boolean email was sent or added to mail queue successfully?
243
244
245
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
246
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
247
	 */
248
	public function sendEmail($isPreview = FALSE): bool {
249
250
251
252
253
254
255
256
		if (TYPO3_MODE === 'FE') {
			/** @var TypoScriptFrontendController $tsfe */
			$tsfe = $GLOBALS['TSFE'];
			$pageUid = $tsfe->id;
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

257
258
259
		if ($this->pid) {
			$pageUid = $this->pid;
		}
260
		$siteRootId = BackendService::getSiteRoot($pageUid);
261

262
		/** @var Template $template */
263
		$template = $this->templateRepository->findOneByTemplate(
264
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
265
		);
266

267
268
269
270
271
272
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

273
274
275
276
277
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
278
		$defaultTemplateContent = NULL;
279
280
		// If there is no template for this language, use the default template
		if ($template === NULL) {
281

282
			$templatePath = self::getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];
283

284
285
286
287
288
289
			// only standard template file is considered since version 4.1
			$defaultTemplateFile = $templatePath . 'template.html';
			if (file_exists($defaultTemplateFile)) {
				$defaultTemplateContent = file_get_contents($defaultTemplateFile);
			} else {
				return FALSE;
290
			}
291
		} elseif (filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
292
			$this->setToAddresses(trim($template->getToAddress()));
293
294
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
295
296
		if ($isPreview) {
			$previewMarker = [];
Paul Ilea's avatar
Paul Ilea committed
297
			/** @var array $markerArray */
298
			$markerArray = self::getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
Torsten Oppermann's avatar
Torsten Oppermann committed
299
			foreach ($markerArray as $marker) {
300
301
302
303
304
305
306
307
308
309
310
311
				$markerPath = GeneralUtility::trimExplode('.', $marker['marker']);
				$temporaryMarkerArray = [];
				foreach (array_reverse($markerPath) as $index => $markerPathSegment) {
					if ($index === 0) {
						if ($marker['backend_translation_key']) {
							$temporaryMarkerArray[$markerPathSegment] = LocalizationUtility::translate(
								$marker['backend_translation_key'], $marker['extension_key']
							);
						} else {
							$temporaryMarkerArray[$markerPathSegment] = $marker['value'];
						}
					} else {
312
						$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
313
					}
314
				}
315
				$previewMarker = array_merge_recursive($previewMarker, $temporaryMarkerArray);
Torsten Oppermann's avatar
Torsten Oppermann committed
316
			}
317
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
318
319
320
			$this->setMarkers($previewMarker);
		}

321
		/** @var StandaloneView $emailView */
322
		$emailView = $this->objectManager->get(StandaloneView::class);
323

324
		if (NULL === $defaultTemplateContent) {
325
			$emailView->setTemplateSource($template->getContent());
326
			$subject = $template->getSubject();
327
328
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
329

330
			$subject = self::getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
331
			if (is_array($subject)) {
332
333
				$subject = self::getRegisterArray(
				)[$this->extensionKey][$this->templateName]['subject'][$this->language];
334
			}
335
		}
336
		$this->mailMessage->setSubject($subject);
337

338
		$emailView->assignMultiple($this->markers);
339
		$emailBody = $emailView->render();
340

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

346
			$this->mailMessage->setBody($emailBody, 'text/html');
347
			$this->mailMessage->send();
348
			$dateTime = new DateTime();
349
			$currentTimestamp = $dateTime->getTimestamp();
350
351
352
353

			if (!$isPreview) {
				$this->addMailToMailQueue(
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
354
					$currentTimestamp, $currentTimestamp, $this->language, $siteRootId
355
356
				);
			}
357

358
		} else {
359
360
			if (!$isPreview) {
				$this->addMailToMailQueue(
361
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority, 0, 0,
362
363
364
					$this->language, $siteRootId
				);
			}
365
		}
366
367

		return TRUE;
368
369
370
	}

	/**
371
	 * Adds a new mail to the mail queue.
372
	 *
373
374
	 * @param string $extensionKey
	 * @param string $templateName
375
	 * @param string $subject
376
	 * @param string $emailBody
377
	 * @param int $sendingTime
378
	 * @param int $priority
379
	 * @param int $lastSendingTime
380
	 * @param string $language
381
	 * @param int $pid
Paul Ilea's avatar
Paul Ilea committed
382
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
383
	 */
384
	private function addMailToMailQueue(
385
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
386
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
387
	) {
388
		$mail = $this->objectManager->get(Mail::class);
389
		$mail->setPid($pid);
390
391
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
392
		$mail->setLanguage($language);
393

394
		$mail->setFromAddress($this->fromAddress);
395
		$mail->setFromName($this->fromName);
396

397
		$mail->setToAddress($this->toAddresses);
398
		$mail->setMailSubject($subject);
399
		$mail->setMailBody($emailBody);
400
		$mail->setPriority($priority);
401
402
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
403
		$mail->setSendingTime($sendingTime);
404
		$mail->setLastSendingTime($lastSendingTime);
405
		$mail->setReplyTo($this->replyToAddress);
406

407
		$mailRepository = $this->objectManager->get(MailRepository::class);
408
		$mailRepository->add($mail);
409
		$this->persistenceManager->persistAll();
410
	}
411

412
413
414
415
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
Paul Ilea's avatar
Paul Ilea committed
416
417
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
418
419
420
421
	 */
	public function sendMailFromQueue($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
422
		$mailToSend = $mailRepository->findOneByUid($uid);
423
424
425

		if ($mailToSend) {
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
426
			$this->mailMessage->setTo(trim($mailToSend->getToAddress()));
427
428
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
429

430
			if ($mailToSend->getBccAddresses()) {
431
432
433
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

434
			if ($mailToSend->getCcAddresses()) {
435
436
437
438
439
440
441
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

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

442
443
			$dateTime = new DateTime();
			$mailToSend->setLastSendingTime($dateTime->getTimestamp());
444
			$this->mailMessage->send();
445
			$mailRepository->update($mailToSend);
446
447
448
		}
	}

449
	/**
450
	 * @param string $toAddresses
451
452
	 * @return MailTemplateService
	 */
453
	public function setToAddresses($toAddresses) {
454
		$toAddresses = preg_replace('~\x{00a0}~siu', ' ', $toAddresses);
455
456
		$this->toAddresses = trim($toAddresses);
		$this->mailMessage->setTo(trim($toAddresses));
457
458
459
460
		return $this;
	}

	/**
461
	 * @param string $fromAddress
462
	 * @param string $fromName
463
464
	 * @return MailTemplateService
	 */
465
	public function setFromAddress($fromAddress, $fromName = '') {
466
467
468
469
470
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

471
472
473
474
		return $this;
	}

	/**
475
	 * @param string $ccAddresses
476
477
	 * @return MailTemplateService
	 */
478
	public function setCcAddresses($ccAddresses) {
479
480
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
481
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
482
483
		}

484
485
486
487
		return $this;
	}

	/**
488
	 * @param string $replyToAddress
489
490
	 * @return MailTemplateService
	 */
491
	public function setReplyToAddress($replyToAddress) {
492
493
494
495
496
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

497
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
		return $this;
	}

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

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

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

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

536
	/**
537
	 * @param array $markers
538
539
	 * @return MailTemplateService
	 */
540
541
	public function setMarkers(array $markers) {
		$this->markers = $markers;
542
543
		return $this;
	}
544
545

	/**
546
	 * @param string $bccAddresses
547
548
	 * @return MailTemplateService
	 */
549
	public function setBccAddresses($bccAddresses) {
550
551
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
552
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
553
554
		}

555
556
557
		return $this;
	}

558
559
560
561
562
563
564
565
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
566
567
568

	/**
	 * @param Swift_OutputByteStream $data
Paul Ilea's avatar
Paul Ilea committed
569
	 * @param string $filename
570
571
572
573
574
575
576
577
578
579
580
	 * @param string $contentType
	 * @return MailTemplateService
	 */
	public function addAttachment($data, $filename, $contentType) {
		$attachment = Swift_Attachment::newInstance()
			->setFilename($filename)
			->setContentType($contentType)
			->setBody($data);
		$this->mailMessage->attach($attachment);
		return $this;
	}
581
582
583
584
585
586
587
588

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

589
590
591
592
593
594
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
	private function loadTemplateValues($template) {
595
596
597
598
599
600
601
602
603
604
605
606
607
608
		$fromName = $template->getFromName();
		if ($fromName === '' && $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

		$fromMail = $template->getFromMail();
		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';
			}
		}

		$this->setFromAddress($fromMail, $fromName);
609
610
611
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
612
		$this->setFromName($fromName);
613
614
615
616
617
618
619
620
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
621
	}
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
	public static function getReadableMarkerType($markerType) {
		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;
			default:
				LocalizationUtility::translate('backend.marker.type.mixed', 'sg_mail');
		}
	}
643
644
645
646
647
648
649
650
651
652
653

	/**
	 * set the page id from which this was called
	 *
	 * @param int $pid
	 * @return MailTemplateService
	 */
	public function setPid($pid) {
		$this->pid = (int) $pid;
		return $this;
	}
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
	/**
	 * Get all registered templates
	 *
	 * @return array
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \BadFunctionCallException
	 * @throws \InvalidArgumentException
	 */
	public static function getRegisterArray() {
		/** @var CacheManager $cacheManager */
		$cacheManager = GeneralUtility::makeInstance(CacheManager::class);
		/** @var FrontendInterface $cache */
		$cache = $cacheManager->getCache(self::CACHE_NAME);
		$cacheId = md5('sg_mail');
		/** @var array entry */
		if (($entry = $cache->get($cacheId)) === FALSE) {
			$entry = self::registerExtensions();

			if ($entry === NULL) {
				$entry = [];
			}

			$cache->set($cacheId, $entry, [], self::CACHE_LIFETIME_IN_SECONDS);
		}

		return $entry;
	}

683
684
685
686
687
	/**
	 * Iterate over all installed extensions and look for sg_mail configuration files
	 * If found, register the template(s)
	 *
	 * @throws \BadFunctionCallException
688
	 * @return array
689
	 */
690
	public static function registerExtensions(): array {
691
		// clear registerArray
692
		$registerArray = [];
693
694
695
696
697
698
699
700
701
702

		$extensionList = ExtensionManagementUtility::getLoadedExtensionListArray();

		foreach ($extensionList as $extensionName) {
			$extensionConfigDirectory = ExtensionManagementUtility::extPath($extensionName);
			$extensionConfigDirectory .= '/Configuration/MailTemplates';
			$configFiles = GeneralUtility::getFilesInDir($extensionConfigDirectory);

			foreach ($configFiles as $configFile) {
				$configArray = (include $extensionConfigDirectory . '/' . $configFile);
703
704
705
706
707
708
709
710
711
712
713
714
715
				$extensionKey = $configArray['extension_key'];
				$templateKey = $configArray['template_key'];

				// transform template directory name: your_templates => YourTemplates/
				$templateDirectoryParts = GeneralUtility::trimExplode('_', $configArray['template_key']);
				$templateDirectory = '';
				foreach ($templateDirectoryParts as $part) {
					$templateDirectory .= ucfirst($part);
				}
				$templateDirectory .= '/';
				$templatePath = ExtensionManagementUtility::extPath(
						$extensionName
					) . self::DEFAULT_TEMPLATE_PATH . $templateDirectory;
716

717
718
719
				if ($configArray['template_path']) {
					$templatePath = $configArray['template_key'];
				}
720

721
722
723
724
725
726
727
728
729
730
731
732
733
				$description = $configArray['description'];
				$subject = $configArray['subject'];
				$marker = $configArray['markers'];

				$registerArray[$extensionKey][$templateKey] = [
					'templatePath' => $templatePath,
					'description' => $description,
					'marker' => $marker,
					'extension' => $extensionKey,
					'templateName' => $templateKey,
					'subject' => $subject
				];
			}
734
735
		}

736
		return $registerArray;
737
	}
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758

	/**
	 * Checks if a template is blacklisted for a given siterootId
	 *
	 * @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 {
		$whitelistedTemplates = BackendService::getWhitelistedTemplates($siteRootId);

		if ($whitelistedTemplates[$extensionKey]) {
			return $whitelistedTemplates[$extensionKey][$templateName] ? FALSE : TRUE;
		}

		return TRUE;
	}
759
}