MailTemplateService.php 38 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
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
Paul Ilea's avatar
Paul Ilea committed
32
use SGalinski\SgMail\Domain\Repository\LayoutRepository;
33
use SGalinski\SgMail\Domain\Repository\MailRepository;
34
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
35
36
use Swift_Attachment;
use Swift_OutputByteStream;
37
use TYPO3\CMS\Core\Database\ConnectionPool;
38
use TYPO3\CMS\Core\Mail\MailMessage;
39
use TYPO3\CMS\Core\Resource\File;
40
use TYPO3\CMS\Core\Resource\ResourceFactory;
Paul Ilea's avatar
Paul Ilea committed
41
use TYPO3\CMS\Core\Routing\SiteMatcher;
42
use TYPO3\CMS\Core\Utility\GeneralUtility;
Paul Ilea's avatar
Paul Ilea committed
43
use TYPO3\CMS\Core\Utility\VersionNumberUtility;
44
use TYPO3\CMS\Extbase\Domain\Model\FileReference;
45
use TYPO3\CMS\Extbase\Object\ObjectManager;
46
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
47
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
48
use TYPO3\CMS\Fluid\View\StandaloneView;
49
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
50

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

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

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

76
	/**
77
	 * @var string $toAddresses
78
	 */
79
	private $toAddresses = '';
80
81

	/**
82
	 * @var string $fromAddress
83
	 */
84
	private $fromAddress = '';
85
86

	/**
87
	 * @var string $ccAddresses
88
	 */
Paul Ilea's avatar
Paul Ilea committed
89
	private $ccAddresses;
90
91

	/**
92
	 * @var string $replyToAddress
93
	 */
94
	private $replyToAddress = '';
95
96

	/**
97
	 * @var string $language
98
	 */
99
	private $language = 'default';
100
101

	/**
102
	 * @var boolean $ignoreMailQueue
103
	 */
104
	private $ignoreMailQueue = FALSE;
105
106
107
108
109
110
111

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

	/**
112
	 * @var string $templateName
113
114
115
	 */
	private $templateName;

116
117
118
119
120
	/**
	 * @var string $subject
	 */
	private $subject;

121
122
123
124
125
	/**
	 * @var string $overwrittenEmailBody
	 */
	private $overwrittenEmailBody = '';

126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
	/**
	 * @var string $overwrittenBcc
	 */
	private $overwrittenBcc;

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

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

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

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

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

156
	/**
157
	 * @var string $extensionKey
158
159
160
161
	 */
	private $extensionKey;

	/**
162
	 * @var array $markers
163
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
164
	private $markers;
165

166
167
168
169
170
	/**
	 * @var array $markerLabels
	 */
	private $markerLabels;

171
	/**
172
	 * @var string $bccAddresses
173
	 */
Paul Ilea's avatar
Paul Ilea committed
174
	private $bccAddresses;
175

176
177
178
179
180
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

181
182
183
184
185
	/**
	 * @var int
	 */
	private $pid;

186
187
188
189
190
	/**
	 * @var string
	 */
	private $fromName = '';

191
192
193
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
194
195
	protected $templateRepository;

Paul Ilea's avatar
Paul Ilea committed
196
197
198
199
200
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\LayoutRepository
	 */
	protected $layoutRepository;

201
202
203
204
	/**
	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager
	 */
	protected $persistenceManager;
205

206
207
208
209
210
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

211
212
213
214
215
	/**
	 * @var TYPO3\CMS\Core\Resource\ResourceFactory
	 */
	protected $resourceFactory;

216
217
218
219
	/**
	 * @var string
	 */
	private $mailBodyToSend;
220

221
222
223
224
	/**
	 * @var string
	 */
	private $subjectToSend;
225

226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
	/**
	 * @return string
	 */
	public function getOverwrittenBcc(): string {
		return $this->overwrittenBcc;
	}

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

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

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

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

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

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

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

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

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

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

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

310
311
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
312
	 *
313
314
	 * @param string $templateName
	 * @param string $extensionKey
315
	 * @param array $markers
316
	 * @param array $markerLabels
Paul Ilea's avatar
Paul Ilea committed
317
	 * @throws \InvalidArgumentException
318
	 */
319
	public function __construct($templateName = '', $extensionKey = '', $markers = [], $markerLabels = []) {
320
321
322
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;
323
		$this->markerLabels = $markerLabels;
324

325
326
327
328
		/** @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
329
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
330
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
Paul Ilea's avatar
Paul Ilea committed
331
		$this->layoutRepository = $this->objectManager->get(LayoutRepository::class);
332
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
333
		$this->resourceFactory = $this->objectManager->get(ResourceFactory::class);
334

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

341
			if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
342
343
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
344
				$this->fromAddress = $tsSettings['mail']['default']['from'];
345
			}
346
347
		}

348
349
350
351
352
		if ($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$this->fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

		$this->mailMessage->setFrom($this->fromAddress, $this->fromName);
Torsten Oppermann's avatar
Torsten Oppermann committed
353
354
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
355
356

		foreach ($this->bccAddresses as $index => $email) {
357
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
358
359
360
361
362
363
364
365
366
367
				unset($this->bccAddresses[$index]);
			}
		}

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

368
		if (\count($this->bccAddresses) > 0) {
369
370
371
			$this->mailMessage->setBcc($this->bccAddresses);
		}

372
		if (\count($this->ccAddresses) > 0) {
373
374
			$this->mailMessage->setCc($this->ccAddresses);
		}
375
376
	}

377
378
379
	/**
	 * @param string $fromName
	 */
380
	public function setFromName($fromName) {
381
382
383
384
385
386
387
388
		$this->fromName = $fromName;
	}

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
389
	public static function getReadableMarkerType($markerType) {
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
		switch ($markerType) {
			case self::MARKER_TYPE_STRING :
				LocalizationUtility::translate('backend.marker.type.string', 'sg_mail');
				break;
			case self::MARKER_TYPE_ARRAY :
				LocalizationUtility::translate('backend.marker.type.array', 'sg_mail');
				break;
			case self::MARKER_TYPE_OBJECT :
				LocalizationUtility::translate('backend.marker.type.object', 'sg_mail');
				break;
			case self::MARKER_TYPE_FILE:
				LocalizationUtility::translate('backend.marker.type.file', 'sg_mail');
				break;
			default:
				LocalizationUtility::translate('backend.marker.type.mixed', 'sg_mail');
		}
	}

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

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

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

		return $this;
	}

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

		return $this;
	}

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

		return $this;
	}

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

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

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

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

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

	/**
	 * @param string|string[]|null $mailBodyToSend
	 */
	public function setMailBodyToSend($mailBodyToSend): void {
		$this->mailBodyToSend = $mailBodyToSend;
	}

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

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

528
529
530
531
532
533
534
535
536
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

537
538
539
540
541
542
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function setMarkers(array $markers): MailTemplateService {
		$this->markers = $markers;
543
		foreach ($markers as $key => $currentMarker) {
544
			if (!\is_array($currentMarker) || !isset($currentMarker['markerLabel'])) {
545
546
547
548
549
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
		return $this;
	}

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

		return $this;
	}

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

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

	/**
591
592
	 * Adds a file resource as attachment
	 *
593
594
	 * @param FileReference $fileReference
	 * @param File $file
595
596
	 *
	 * @return MailTemplateService
597
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
598
	 */
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
	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;
			}
616
617
618
619
		}

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
620
				'uid_local' => $file->getUid(),
621
622
623
624
625
626
627
628
629
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
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
		return $this;
	}

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

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

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

		return TRUE;
	}

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

	/**
	 * @param string $subject
	 */
681
	public function setSubject(string $subject) {
682
683
684
		$this->subject = $subject;
	}

685
686
687
688
689
690
691
692
693
694
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}

	/**
	 * @param string $overwrittenEmailBody
	 */
695
	public function setOverwrittenEmailBody(string $overwrittenEmailBody) {
696
697
698
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}

699
700
701
702
703
704
705
706
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
707
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail'): array {
708
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
709
		// Need the key for translations
710
		if (\trim($extensionKey) === '') {
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
			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;
	}

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

767
	/**
768
769
	 * Parses markers in an email View.
	 * !!! CHANGES THE SOURCE PATH AND IT SHOULD BE RESET BACK TO THE ORIGINAL!!!
770
	 *
771
772
773
	 * @param string $text
	 * @param StandaloneView $emailView
	 * @return mixed
774
	 */
775
776
777
778
779
780
781
782
	protected function parseMarkers($text, $emailView) {
		if (strpos($text, '{') !== FALSE) {
			$emailView->setTemplateSource($text);
			return $emailView->render();
		}
		return $text;
	}

783
	/**
784
	 * Gets the current PageUid
785
	 *
786
	 * @return int
787
	 */
788
	protected function getPageUid(): int {
789
		if (TYPO3_MODE === 'FE') {
790
791
792
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
793
794
795
796
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

797
		if ($this->pid) {
798
			$pageUid = $this->pid;
799
		}
800

801
		if ($pageUid === 0) {
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
			$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
821
				)
822
823
824
825
			)
			->andWhere(
				$queryBuilder->expr()->eq(
					'hidden', 0
826
				)
827
828
			)
			->execute()->fetchAll();
829

830
831
		if ($rootPageRows && \count($rootPageRows)) {
			$pageUid = (int) $rootPageRows[0]['uid'];
832
		}
833
834
		return $pageUid;
	}
835

836
837
838
839
840
841
842
843
844
845
846
847
	/**
	 * 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);
	}
848

849
850
851
852
853
854
855
	/**
	 * Get the template object
	 *
	 * @param int $siteRootId
	 * @return null|object|Template|FALSE
	 * @throws \Exception
	 */
856
	private function getTemplate($siteRootId) {
857
858
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
859
			throw new \Exception('The template is blacklisted');
860
861
		}

862
863
864
865
866
		$templateHash = $this->getTemplateHash($this->extensionKey, $this->templateName, $siteRootId, $this->language);
		if (isset(self::$templateObjectCache[$templateHash])
			&& self::$templateObjectCache[$templateHash] instanceof Template) {
			return self::$templateObjectCache[$templateHash];
		}
867
		/** @var Template $template */
868
		$template = $this->templateRepository->findOneByTemplate(
869
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
870
		);
871

872
873
874
875
876
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}
877
		self::$templateObjectCache[$templateHash] = $template;
878
879
		return $template;
	}
880

881
882
883
	/**
	 * Get the default content for this template
	 *
884
885
	 * @param Template|null $template
	 * @param RegisterService $registerService
886
	 * @return bool|false|string
887
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
888
889
	 */
	protected function getDefaultTemplateContent($template, $registerService) {
890
891
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
892

893
		// If there is no template for this language, use the default template
894
		if ($template === NULL && $defaultTemplateContent === NULL) {
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
			$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']
				);
910

911
912
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
913
				} else {
914
					return FALSE;
915
				}
916
			}
Torsten Oppermann's avatar
Torsten Oppermann committed
917
		}
918
919
		return $defaultTemplateContent;
	}
Torsten Oppermann's avatar
Torsten Oppermann committed
920

921
	/**
922
923
924
	 * Sets the values to send the mail with from the template or register service
	 *
	 * @param Template|null $template
925
926
927
928
	 * @param RegisterService $registerService
	 * @param string $defaultTemplateContent
	 * @param int $siteRootId
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
929
	 */
930
	protected function extractValuesForMail($template, RegisterService $registerService, $defaultTemplateContent, $siteRootId): void {
931
		/** @var StandaloneView $emailView */
932
		$emailView = $this->objectManager->get(StandaloneView::class);
933
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
934
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
935

936
937
938
939
940
941
		$overwrittenEmailBody = $this->getOverwrittenEmailBody();
		$overwrittenSubject = '';
		if ($this->subject !== '' && $this->subject !== NULL) {
			$overwrittenSubject = $this->subject;
		}

942
		// parse markers
Paul Ilea's avatar
Paul Ilea committed
943
		if ($template !== NULL) {
944
945
946
			$subject = $this->parseMarkers(
				trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject),
				$emailView
947
			);
948

949
950
			$layoutId = $template->getLayout();
			$templateContent = $template->getContent();
951
			$this->setSubjectToSend($subject);
952
		} else {
953
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
954
955
			if (\is_array($subject)) {
				$subject = \trim(
956
957
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
958
				);
959
			}
960
961
962
963
			$subject = $this->parseMarkers(
				(empty($overwrittenSubject) ? $subject : $overwrittenSubject),
				$emailView
			);
964

965
966
967
			$layoutId = 0;
			$templateContent = $defaultTemplateContent;
		}
968
969
		$this->setSubjectToSend($subject);
		//TODO: is this object even in use somewhere?
970
		$this->mailMessage->setSubject($subject);
971

972
973
		if ($this->fromAddress === '') {
			$fromMail = $this->parseMarkers(
974
				empty($this->overwrittenFromMail) ? $template->getFromMail() : $this->overwrittenFromMail,
975
				$emailView
976
			);
977
			$this->setFromAddress($fromMail);
978
979
		}

980
981
		if ($this->fromName === '') {
			$fromName = $this->parseMarkers(
982
				(empty($this->overwrittenFromName) ? $template->getFromName() : $this->overwrittenFromName),
983
				$emailView
984
			);
985
			$this->setFromName($fromName);
986
987
		}

988
989
		if ($this->replyToAddress === '') {
			$replyTo = $this->parseMarkers(
990
				(empty($this->overwrittenReplyTo) ? $template->getReplyTo() : $this->overwrittenReplyTo),
991
992
993
994
995
996
997
				$emailView
			);
			$this->setReplyToAddress($replyTo);
		}

		if (empty($this->ccAddresses)) {
			$cc = $this->parseMarkers(
998
				(empty($this->overwrittenCc) ? $template->getCc() : $this->overwrittenCc),
999
1000
1001
1002
1003
1004
1005
				$emailView
			);
			$this->setCcAddresses($cc);
		}

		if (empty($this->bccAddresses)) {
			$bcc = $this->parseMarkers(
1006
				(empty($this->overwrittenBcc) ? $template->getBcc() : $this->overwrittenBcc),
1007
1008
1009
1010
1011
1012
1013
				$emailView
			);
			$this->setBccAddresses($bcc);
		}

		if ($this->toAddresses === '') {
			$toAddress = $this->parseMarkers(
1014
				(empty($this->overwrittenToAddresses) ? $template->getToAddress() : $this->overwrittenToAddresses),
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
				$emailView
			);
			$this->setToAddresses($toAddress);
		}

		// reset template source back to default
		$emailView->setTemplateSource(
			$this->getTemplateSource(
				empty($overwrittenEmailBody) ? $templateContent : $overwrittenEmailBody,
				$layoutId, $siteRootId
			)
		);
1027

1028
1029
		// insert <br> tags, but replace every instance of three or more successive breaks with just two.
		$emailBody = $emailView->render();
1030
		$emailBody = \nl2br($emailBody);
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
		$this->mailBodyToSend = \preg_replace('/(<br[\s]?[\/]?>[\s]*){3,}/', '<br><br>', $emailBody);
	}

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

	/**
	 * Send the Email
	 *
	 * @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
	 */
1055
	public function sendEmail($isPreview = FALSE): bool {
1056
1057
1058
1059
1060
1061
		if ($isPreview) { //TODO: remove this from here
			$this->setIgnoreMailQueue(TRUE);
		}
		$success = FALSE;

		// Get page ID
1062
		// TODO: this doesn't belong here. The API user needs to provide the UID
1063
		$siteRootId = $this->getSiteRootId();
1064
1065
1066
1067
		try {
			$template = $this->getTemplate($siteRootId);
		} catch (\Exception $e) {
			return FALSE;
1068
		}
1069

1070
1071
1072
		$registerService = GeneralUtility::makeInstance(RegisterService::class);

		// get default template content from register array
1073
		$defaultTemplateContent = $this->getDefaultTemplateContent($template, $registerService);
1074
1075
1076

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

1081
		$this->extractValuesForMail($template, $registerService, $defaultTemplateContent, $siteRootId);
1082

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

1093
		//TODO: this can be avoided if the sending logic is decoupled from this function
1094
1095
1096
1097
		if ($isPreview) {
			$mailRepository = $this->objectManager->get(MailRepository::class);
			$mailRepository->remove($mail);
			$this->persistenceManager->persistAll();
1098
		}
1099

1100
		return $success;
1101
1102
	}

Paul Ilea's avatar
Paul Ilea committed
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
	/**
	 * Combines the template content with the layout and returns the result
	 *
	 * @param string $content
	 * @param int $layoutUid
	 * @param int $siteRootId
	 * @return string
	 */
	private function getTemplateSource(string $content, int $layoutUid, int $siteRootId): string {
		if ($layoutUid === -1) {
			return $content;
		}

		$languageUid = 0;
		if ($this->language !== self::DEFAULT_LANGUAGE) {
			$languageUid = (int) array_search($this->language, $this->getAvailableLanguages(), TRUE);
		}

		$frontendSimulated = FALSE;
		if (!isset($GLOBALS['TSFE'])) {
			$frontendSimulated = TRUE;
			$GLOBALS['TSFE'] = new TypoScriptFrontendController(NULL, $siteRootId, 0);
		}
		/** @var array $layout */
		$layout = $this->layoutRepository->findByUidOrDefault($layoutUid, $siteRootId, $languageUid);
		if ($frontendSimulated) {
			unset($GLOBALS['TSFE']);
		}

		if ($layout === NULL) {
			return $content;
		}

		return str_replace('###CONTENT###', $content, $layout['content']);
	}

	/**
	 * Returns the list of avalilable translation languages
	 *
	 * @return array
	 */
	private function getAvailableLanguages(): array {
		$out = [0 => ''];
		if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '9.0.0', '<')) {
			$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(
				'sys_language'
			);
			$rows = $queryBuilder->select('*')
				->from('sys_language')->execute()->fetchAll();

			foreach ($rows as $row) {
				$out[(int) $row['uid']] = $row['language_isocode'];
			}
		} else {
			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;
				}
				$out[$language->getLanguageId()] = strtolower($language->getTwoLetterIsoCode());
			}
		}
		return $out;
	}

1175
	/**
1176
	 * Adds a new mail to the mail queue.
1177
	 *
1178
1179
	 * @param string $extensionKey
	 * @param string $templateName
1180
	 * @param string $subject
1181
	 * @param string $emailBody
1182
	 * @param int $sendingTime
1183
	 * @param int $priority
1184
	 * @param int $lastSendingTime
1185
	 * @param string $language
1186
	 * @param int $pid
1187
	 * @return Mail
1188
1189
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
1190
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
1191
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
1192
	 */
1193
	private function addMailToMailQueue(
1194
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
1195
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
1196
	): Mail {
1197
		$mail = $this->objectManager->get(Mail::class);
1198
		$mail->setPid($pid);
1199
1200
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
1201
		$mail->setLanguage($language);
1202
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
1203

1204
		$mail->setFromAddress($this->fromAddress);
1205
		$mail->setFromName($this->fromName);
1206

1207
		$mail->setToAddress($this->toAddresses);
1208
		$mail->setMailSubject($subject);
1209
		$mail->setMailBody($emailBody);
1210
		$mail->setPriority($priority);
1211
1212
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
1213
		$mail->setSendingTime($sendingTime);
1214
		$mail->setLastSendingTime($lastSendingTime);
1215
		$mail->setReplyTo($this->replyToAddress);
1216
1217
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
				// 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);
				}
1233
1234
			}
		}
1235

1236
		$mailRepository = $this->objectManager->get(MailRepository::class);
1237
		$mailRepository->add($mail);
1238
		$this->persistenceManager->persistAll();
1239
		return $mail;
1240
	}
1241

1242
1243
	/**
	 * Get the mail object by uid and check if it's blacklisted
1244
1245
1246
	 *
	 * @param int $uid
	 * @return bool|object
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
	 */
	private function getMailObjectByUid($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		$mailObject = $mailRepository->findOneByUid($uid);
		if (!$mailObject || $mailObject->getBlacklisted()) {
			return FALSE;
		}
		return $mailObject;
	}

1257
1258
1259
1260
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
1261
	 * @return bool|NULL
1262
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
Paul Ilea's avatar
Paul Ilea committed
1263
1264
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
1265
	 */
1266
	public function sendMailFromQueue($uid): bool {
1267
1268
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
1269
1270
1271
		if (!isset(self::$mailObjectCache[$uid]) || !self::$mailObjectCache[$uid] instanceof Mail) {
			$mailToSend = $this->getMailObjectByUid($uid);
			if ($mailToSend === FALSE) {
1272
1273
				return FALSE;
			}
1274
1275
		} else {
			$mailToSend = self::$mailObjectCache[$uid];
1276
		}
1277

1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
		$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());
1290

1291
1292
1293
		if ($mailToSend->getBccAddresses()) {
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(','