MailTemplateService.php 35.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
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\Extbase\Domain\Model\FileReference;
43
use TYPO3\CMS\Extbase\Object\ObjectManager;
44
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
45
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
46
use TYPO3\CMS\Fluid\View\StandaloneView;
47
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
48

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

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

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

166
167
168
169
	/**
	 * @var string
	 */
	private $subjectToSend;
170

171
	/**
172
173
174
175
176
177
178
179
180
	 * @var string
	 */
	private $defaultFromAddress;

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

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

196
197
198
199
		/** @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
200
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
201
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
Paul Ilea's avatar
Paul Ilea committed
202
		$this->layoutRepository = $this->objectManager->get(LayoutRepository::class);
203
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
204
		$this->resourceFactory = $this->objectManager->get(ResourceFactory::class);
205

206
		// use defaultMailFromAddress if it is provided in LocalConfiguration.php; use the sg_mail TS setting as fallback
207
		if (\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
208
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
209
			$this->defaultFromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
210
		} else {
211
212
213
214
215
216
217
			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'];
			}
218
219
		}

220
221
		if ($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$this->fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
222
			$this->defaultFromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
223
224
225
		}

		$this->mailMessage->setFrom($this->fromAddress, $this->fromName);
Torsten Oppermann's avatar
Torsten Oppermann committed
226
227
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
228
229

		foreach ($this->bccAddresses as $index => $email) {
230
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
231
232
233
234
235
236
237
238
239
240
				unset($this->bccAddresses[$index]);
			}
		}

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

241
		if (\count($this->bccAddresses) > 0) {
242
243
244
			$this->mailMessage->setBcc($this->bccAddresses);
		}

245
		if (\count($this->ccAddresses) > 0) {
246
247
			$this->mailMessage->setCc($this->ccAddresses);
		}
248
249
	}

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

	/**
275
276
277
278
279
280
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
281
	 */
282
283
284
285
286
	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 [];
287
288
		}

289
290
291
292
293
294
295
296
297
		$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
			];
298
299
		}

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

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

330
331
332
333
334
335
336
337
338
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

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

352
353
354
355
356
357
358
359
360
361
362
363
364
		return $this;
	}

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

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

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
394
				'uid_local' => $file->getUid(),
395
396
397
398
399
400
401
402
403
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
404
405
406
407
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
		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
	 */
435
	public function setSubject(string $subject) {
436
437
438
		$this->subject = $subject;
	}

439
440
441
442
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
	/**
	 * 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);
	}

478
	/**
479
	 * Send the Email
480
	 *
481
482
483
484
485
486
487
	 * @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
488
	 */
489
490
491
	public function sendEmail($isPreview = FALSE, $isNewsletter = FALSE): bool {
		if ($isPreview) { //TODO: remove this from here
			$this->setIgnoreMailQueue(TRUE);
492
		}
493
		$success = FALSE;
494

495
496
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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
		// 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) {
			$mailRepository = $this->objectManager->get(MailRepository::class);
			$mailRepository->remove($mail);
			$this->persistenceManager->persistAll();
		}

		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);
559
560
	}

561
	/**
562
	 * Gets the current PageUid
563
	 *
564
	 * @return int
565
	 */
566
	protected function getPageUid(): int {
567
		if (TYPO3_MODE === 'FE') {
568
569
570
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
571
572
573
574
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

575
		if ($this->pid) {
576
			$pageUid = $this->pid;
577
		}
578

579
		if ($pageUid === 0) {
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
			$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
599
				)
600
601
602
603
			)
			->andWhere(
				$queryBuilder->expr()->eq(
					'hidden', 0
604
				)
605
606
			)
			->execute()->fetchAll();
607

608
609
		if ($rootPageRows && \count($rootPageRows)) {
			$pageUid = (int) $rootPageRows[0]['uid'];
610
		}
611
612
		return $pageUid;
	}
613

614
615
616
617
618
619
620
	/**
	 * Get the template object
	 *
	 * @param int $siteRootId
	 * @return null|object|Template|FALSE
	 * @throws \Exception
	 */
621
	private function getTemplate($siteRootId) {
622
623
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
624
			throw new \Exception('The template is blacklisted');
625
626
		}

627
628
629
630
631
		$templateHash = $this->getTemplateHash($this->extensionKey, $this->templateName, $siteRootId, $this->language);
		if (isset(self::$templateObjectCache[$templateHash])
			&& self::$templateObjectCache[$templateHash] instanceof Template) {
			return self::$templateObjectCache[$templateHash];
		}
632
		/** @var Template $template */
633
		$template = $this->templateRepository->findOneByTemplate(
634
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
635
		);
636

637
638
639
640
641
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}
642
		self::$templateObjectCache[$templateHash] = $template;
643
644
		return $template;
	}
645

646
647
648
649
650
651
652
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
	/**
	 * 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
	 */
684
	private function loadTemplateValues(Template $template) {
685
686
687
688
689
690
691
692
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
		$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;
	}

784
785
786
	/**
	 * Get the default content for this template
	 *
787
788
	 * @param Template|null $template
	 * @param RegisterService $registerService
789
	 * @return bool|false|string
790
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
791
792
	 */
	protected function getDefaultTemplateContent($template, $registerService) {
793
794
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
795

796
		// If there is no template for this language, use the default template
797
		if ($template === NULL && $defaultTemplateContent === NULL) {
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
			$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
				/** @var TypoScriptSettingsService $typoScriptSettingsService */
				$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
				$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
				$defaultTemplateFile = GeneralUtility::getFileAbsFileName(
					$tsSettings['mail']['defaultHtmlTemplate']
				);
813

814
815
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
816
				} else {
817
					return FALSE;
818
				}
819
			}
Torsten Oppermann's avatar
Torsten Oppermann committed
820
		}
821
822
		return $defaultTemplateContent;
	}
Torsten Oppermann's avatar
Torsten Oppermann committed
823

824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
	/**
	 * @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;
	}

840
	/**
841
842
843
	 * Sets the values to send the mail with from the template or register service
	 *
	 * @param Template|null $template
844
845
846
	 * @param RegisterService $registerService
	 * @param string $defaultTemplateContent
	 * @param int $siteRootId
847
	 * @param boolean $isNewsletter
848
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
849
	 */
850
	protected function parseValuesForMail(
851
		$template, RegisterService $registerService, $defaultTemplateContent,
852
		$siteRootId
853
	) {
854
		/** @var StandaloneView $emailView */
855
		$emailView = $this->objectManager->get(StandaloneView::class);
856
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
857
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
858

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

866
		// parse markers
Paul Ilea's avatar
Paul Ilea committed
867
		if ($template !== NULL) {
868
869
870
			$subject = $this->parseMarkers(
				trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject),
				$emailView
871
			);
872

873
874
			$layoutId = $template->getLayout();
			$templateContent = $template->getContent();
875
			$this->setSubjectToSend($subject);
876
		} else {
877
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
878
879
			if (\is_array($subject)) {
				$subject = \trim(
880
881
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
882
				);
883
			}
884
885
886
887
			$subject = $this->parseMarkers(
				(empty($overwrittenSubject) ? $subject : $overwrittenSubject),
				$emailView
			);
888

889
890
891
			$layoutId = 0;
			$templateContent = $defaultTemplateContent;
		}
892

893
		$this->setSubjectToSend($subject);
894
		$this->mailMessage->setSubject($subject);
895

896
897
		// Parse the markers
		if ($this->fromName) {
898
			$this->setFromName($this->parseMarkers($this->fromName, $emailView));
899
900
		}

901
		if ($this->fromAddress) {
902
			$this->setFromAddress($this->parseMarkers($this->fromAddress, $emailView));
903
904
		}

905
		if ($this->replyToAddress) {
906
			$this->setReplyToAddress($this->parseMarkers($this->replyToAddress, $emailView));
907
908
		}

909
910
		if ($this->ccAddresses) {
			$this->setCcAddresses($this->parseMarkers($this->ccAddresses, $emailView));
911
912
		}

913
		if ($this->bccAddresses) {
914
			$this->setBccAddresses($this->parseMarkers($this->bccAddresses, $emailView));
915
916
		}

917
		if ($this->toAddresses) {
918
			$this->setToAddresses($this->parseMarkers($this->toAddresses, $emailView));
919
920
921
922
		}

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

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

931
932
933
934
935
936
937
		$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>';
938
939
940
	}

	/**
941
	 * Get a single variable containing a list of all markers
942
	 *
943
944
	 * @param array $markers
	 * @return string
945
	 */
946
947
	private function getAllMarker(array $markers): string {
		$allMarker = '';
948

949
950
951
952
		foreach ($markers as $key => $value) {
			if (\array_key_exists($key, $this->markerLabels) && $this->markerLabels[$key] !== NULL) {
				$key = $this->markerLabels[$key];
			}
953

954
955
956
957
958
959
960
961
962
963
964
965
966
967
			if (\is_string($value)) {
				$allMarker .= $key . ': ' . $value . PHP_EOL;
			} elseif (\is_array($value)) {
				foreach ($value as $innerKey => $innerValue) {
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
				}
			} elseif (\is_bool($value)) {
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
			} elseif (\is_object($value)) {
				if (\method_exists($value, '__toString')) {
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
			}
968
969
		}

970
971
		return $allMarker;
	}
972

973
974
975
976
977
978
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}
979

980
981
982
983
984
985
	/**
	 * @param string $overwrittenEmailBody
	 */
	public function setOverwrittenEmailBody(string $overwrittenEmailBody) {
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}
986

987
988
989
990
991
992
993
994
995
996
997
998
999
	/**
	 * 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();
1000
		}
1001

1002
		return $text;
1003
1004
	}

Paul Ilea's avatar
Paul Ilea committed
1005
	/**
1006
	 * Returns the layout.
Paul Ilea's avatar
Paul Ilea committed
1007
1008
1009
	 *
	 * @param int $layoutUid
	 * @param int $siteRootId
1010
	 * @return Layout|NULL
Paul Ilea's avatar
Paul Ilea committed
1011
	 */
1012
	private function getLayoutSource(int $layoutUid, int $siteRootId) {
Paul Ilea's avatar
Paul Ilea committed
1013
1014
1015
1016
1017
		$languageUid = 0;
		if ($this->language !== self::DEFAULT_LANGUAGE) {
			$languageUid = (int) array_search($this->language, $this->getAvailableLanguages(), TRUE);
		}

1018
		return $this->layoutRepository->findByUidOrDefault($layoutUid, $siteRootId, $languageUid);
Paul Ilea's avatar
Paul Ilea committed
1019
1020
1021
	}

	/**
1022
	 * Returns the list of available translation languages
Paul Ilea's avatar
Paul Ilea committed
1023
1024
1025
1026
1027
	 *
	 * @return array
	 */
	private function getAvailableLanguages(): array {
		$out = [0 => ''];
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
		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
1039
			}
1040
			$out[$language->getLanguageId()] = strtolower($language->getTwoLetterIsoCode());
Paul Ilea's avatar
Paul Ilea committed
1041
1042
1043
1044
		}
		return $out;
	}

1045
	/**
1046
	 * Adds a new mail to the mail queue.
1047
	 *
1048
1049
	 * @param string $extensionKey
	 * @param string $templateName
1050
	 * @param string $subject
1051
	 * @param string $emailBody
1052
	 * @param int $sendingTime
1053
	 * @param int $priority
1054
	 * @param int $lastSendingTime
1055
	 * @param string $language
1056
	 * @param int $pid
1057
	 * @return Mail
1058
1059
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
1060
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
1061
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
1062
	 */
1063
	private function addMailToMailQueue(
1064
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
1065
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
1066
	): Mail {
1067
		$mail = $this->objectManager->get(Mail::class);
1068
		$mail->setPid($pid);
1069
1070
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
1071
		$mail->setLanguage($language);
1072
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
1073

1074
		$mail->setFromAddress($this->fromAddress);
1075
		$mail->setFromName($this->fromName);
1076

1077
		$mail->setToAddress($this->toAddresses);
1078
		$mail->setMailSubject($subject);
1079
		$mail->setMailBody($emailBody);
1080
		$mail->setPriority($priority);
1081
1082
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
1083
		$mail->setSendingTime($sendingTime);
1084
		$mail->setLastSendingTime($lastSendingTime);
1085
		$mail->setReplyTo($this->replyToAddress);
1086
1087
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
				// 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)
						]
					);
					$newFileReference = GeneralUtility::makeInstance(FileReference::class);
					$newFileReference->setOriginalResource($coreFileReferenceMailFile);
					$mail->addAttachment($newFileReference);
				}
1103
1104
			}
		}
1105

1106
		$mailRepository = $this->objectManager->get(MailRepository::class);
1107
		$mailRepository->add($mail);
1108
		$this->persistenceManager->persistAll();
1109
		return $mail;
1110
	}
1111

1112
	/**
1113
	 * @return string
1114
	 */
1115
1116
1117
1118
1119
1120
1121
	public function getSubjectToSend(): string {
		return $this->subjectToSend;
	}

	/**
	 * @param string $subjectToSend
	 */
1122
	public function setSubjectToSend(string $subjectToSend) {
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
		$this->subjectToSend = $subjectToSend;
	}

	/**
	 * @return string|string[]|null
	 */
	public function getMailBodyToSend() {
		return $this->mailBodyToSend;
	}

	/**
	 * @param string|string[]|null $mailBodyToSend
	 */
1136
	public function setMailBodyToSend($mailBodyToSend) {
1137
		$this->mailBodyToSend = $mailBodyToSend;
1138
1139
	}

1140
1141
1142
1143
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
1144
	 * @return bool|NULL
1145
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
Paul Ilea's avatar
Paul Ilea committed
1146
1147
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
1148
	 */
1149
	public function sendMailFromQueue($uid): bool {
1150
1151
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
1152
1153
1154
		if (!isset(self::$mailObjectCache[$uid]) || !self::$mailObjectCache[$uid] instanceof Mail) {
			$mailToSend = $this->getMailObjectByUid($uid);
			if ($mailToSend === FALSE) {
1155
1156
				return FALSE;
			}
1157
1158
		} else {
			$mailToSend = self::$mailObjectCache[$uid];
1159
		}
1160

1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
		$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());
1173

1174
1175
1176
		if ($mailToSend->getBccAddresses