MailTemplateService.php 36.6 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
68
69
70
71
72
73
74
75
	/**
	 * @var Template
	 */
	private static $template;

	/**
	 * @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
	/**
	 * @var TYPO3\CMS\Core\Resource\ResourceFactory
	 */
	protected $resourceFactory;
215
216
217
218
219
220
221
222
	/**
	 * @var string
	 */
	private $mailBodyToSend;
	/**
	 * @var string
	 */
	private $subjectToSend;
223

224
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
310
311
312
313
314
	/**
	 * @param Template $template
	 */
	public static function setTemplate(Template $template): void {
		self::$template = $template;
	}

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

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

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

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

346
			if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
347
348
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
349
				$this->fromAddress = $tsSettings['mail']['default']['from'];
350
			}
351
352
		}

353
354
355
356
357
		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
358
359
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
360
361

		foreach ($this->bccAddresses as $index => $email) {
362
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
363
364
365
366
367
368
369
370
371
372
				unset($this->bccAddresses[$index]);
			}
		}

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

373
		if (\count($this->bccAddresses) > 0) {
374
375
376
			$this->mailMessage->setBcc($this->bccAddresses);
		}

377
		if (\count($this->ccAddresses) > 0) {
378
379
			$this->mailMessage->setCc($this->ccAddresses);
		}
380
381
	}

382
383
384
	/**
	 * @param string $fromName
	 */
385
	public function setFromName($fromName) {
386
387
388
389
390
391
392
393
		$this->fromName = $fromName;
	}

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
394
	public static function getReadableMarkerType($markerType) {
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
500
501
502
503
504
		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;
	}

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

533
534
535
536
537
538
539
540
541
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

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

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
591
592
593
594
595
		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;
	}

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

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
625
				'uid_local' => $file->getUid(),
626
627
628
629
630
631
632
633
634
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
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
681
682
683
684
685
		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
	 */
686
	public function setSubject(string $subject) {
687
688
689
		$this->subject = $subject;
	}

690
691
692
693
694
695
696
697
698
699
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}

	/**
	 * @param string $overwrittenEmailBody
	 */
700
	public function setOverwrittenEmailBody(string $overwrittenEmailBody) {
701
702
703
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}

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

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

772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
	/**
	 * 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) {
		if (strpos($text, '{') !== FALSE) {
			$emailView->setTemplateSource($text);
			return $emailView->render();
		}
		return $text;
	}

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

802
		if ($this->pid) {
803
			$pageUid = $this->pid;
804
		}
805

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

835
836
		if ($rootPageRows && \count($rootPageRows)) {
			$pageUid = (int) $rootPageRows[0]['uid'];
837
		}
838
839
		return $pageUid;
	}
840

841
842
843
844
845
846
847
	/**
	 * Get the template object
	 *
	 * @param int $siteRootId
	 * @return null|object|Template|FALSE
	 * @throws \Exception
	 */
848
	public function getTemplate($siteRootId) {
849
850
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
851
			throw new \Exception('The template is blacklisted');
852
		}
853
		/** @var Template $template */
854
		$template = $this->templateRepository->findOneByTemplate(
855
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
856
		);
857

858
859
860
861
862
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}
863
864
		return $template;
	}
865

866
867
868
869
870
871
872
873
	/**
	 * Get the default content for this template
	 *
	 * @param $template
	 * @param $registerService
	 * @return bool|false|string
	 */
	protected function getDefaultTemplateContent($template, $registerService) {
874
875
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
876

877
		// If there is no template for this language, use the default template
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
		if (($template === NULL) && $defaultTemplateContent === NULL) {
			$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']
				);
894

895
896
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
897
				} else {
898
					return FALSE;
899
				}
900
			}
Torsten Oppermann's avatar
Torsten Oppermann committed
901
		}
902
903
		return $defaultTemplateContent;
	}
Torsten Oppermann's avatar
Torsten Oppermann committed
904

905
	/**
906
907
908
	 * Sets the values to send the mail with from the template or register service
	 *
	 * @param Template|null $template
909
910
911
912
	 * @param $registerService
	 * @param $defaultTemplateContent
	 * @param $siteRootId
	 */
913
	protected function extractValuesForMail($template, $registerService, $defaultTemplateContent, $siteRootId): void {
914
		/** @var StandaloneView $emailView */
915
		$emailView = $this->objectManager->get(StandaloneView::class);
916
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
917
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
918

919
920
921
922
923
924
		$overwrittenEmailBody = $this->getOverwrittenEmailBody();
		$overwrittenSubject = '';
		if ($this->subject !== '' && $this->subject !== NULL) {
			$overwrittenSubject = $this->subject;
		}

925
		// parse markers
Paul Ilea's avatar
Paul Ilea committed
926
		if ($template !== NULL) {
927
928
929
			$subject = $this->parseMarkers(
				trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject),
				$emailView
930
			);
931

932
933
			$layoutId = $template->getLayout();
			$templateContent = $template->getContent();
934
			$this->setSubjectToSend($subject);
935
		} else {
936
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
937
938
			if (\is_array($subject)) {
				$subject = \trim(
939
940
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
941
				);
942
			}
943
944
945
946
947
948
949
950
			$subject = $this->parseMarkers(
				(empty($overwrittenSubject) ? $subject : $overwrittenSubject),
				$emailView
			);

			$layoutId = 0;
			$templateContent = $defaultTemplateContent;
		}
951
952
		$this->setSubjectToSend($subject);
		//TODO: is this object even in use somewhere?
953
		$this->mailMessage->setSubject($subject);
954

955
956
		if ($this->fromAddress === '') {
			$fromMail = $this->parseMarkers(
957
				empty($this->overwrittenFromMail) ? $template->getFromMail() : $this->overwrittenFromMail,
958
				$emailView
959
			);
960
961
			$this->setFromAddress($fromMail);
		}
962

963
964
		if ($this->fromName === '') {
			$fromName = $this->parseMarkers(
965
				(empty($this->overwrittenFromName) ? $template->getFromName() : $this->overwrittenFromName),
966
				$emailView
967
			);
968
			$this->setFromName($fromName);
969
970
		}

971
972
		if ($this->replyToAddress === '') {
			$replyTo = $this->parseMarkers(
973
				(empty($this->overwrittenReplyTo) ? $template->getReplyTo() : $this->overwrittenReplyTo),
974
975
976
977
978
979
980
				$emailView
			);
			$this->setReplyToAddress($replyTo);
		}

		if (empty($this->ccAddresses)) {
			$cc = $this->parseMarkers(
981
				(empty($this->overwrittenCc) ? $template->getCc() : $this->overwrittenCc),
982
983
984
985
986
987
988
				$emailView
			);
			$this->setCcAddresses($cc);
		}

		if (empty($this->bccAddresses)) {
			$bcc = $this->parseMarkers(
989
				(empty($this->overwrittenBcc) ? $template->getBcc() : $this->overwrittenBcc),
990
991
992
993
994
995
996
				$emailView
			);
			$this->setBccAddresses($bcc);
		}

		if ($this->toAddresses === '') {
			$toAddress = $this->parseMarkers(
997
				(empty($this->overwrittenToAddresses) ? $template->getToAddress() : $this->overwrittenToAddresses),
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
				$emailView
			);
			$this->setToAddresses($toAddress);
		}

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

1011
1012
		// insert <br> tags, but replace every instance of three or more successive breaks with just two.
		$emailBody = $emailView->render();
1013
		$emailBody = \nl2br($emailBody);
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
		$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
	 */
1038
	public function sendEmail($isPreview = FALSE): bool {
1039
1040
1041
1042
1043
1044
		if ($isPreview) { //TODO: remove this from here
			$this->setIgnoreMailQueue(TRUE);
		}
		$success = FALSE;

		// Get page ID
1045
		// TODO: this doesn't belong here. The API user needs to provide the UID
1046
		$siteRootId = $this->getSiteRootId();
1047
		if (self::$template === NULL) {
1048
1049
			// Get template
			try {
1050
				self::$template = $this->getTemplate($siteRootId);
1051
1052
1053
1054
1055
1056
1057
			} catch (\Exception $e) {
				return FALSE;
			}
		}
		$registerService = GeneralUtility::makeInstance(RegisterService::class);

		// get default template content from register array
1058
		$defaultTemplateContent = $this->getDefaultTemplateContent(self::$template, $registerService);
1059
1060
1061

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

1066
		$this->extractValuesForMail(self::$template, $registerService, $defaultTemplateContent, $siteRootId);
1067

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

1077
		//TODO: this can be avoided if the sending logic is decoupled from this function
1078
1079
1080
1081
		if ($isPreview) {
			$mailRepository = $this->objectManager->get(MailRepository::class);
			$mailRepository->remove($mail);
			$this->persistenceManager->persistAll();
1082
		}
1083

1084
		return $success;
1085
1086
	}

Paul Ilea's avatar
Paul Ilea committed
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
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
	/**
	 * 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;
	}

1159
	/**
1160
	 * Adds a new mail to the mail queue.
1161
	 *
1162
1163
	 * @param string $extensionKey
	 * @param string $templateName
1164
	 * @param string $subject
1165
	 * @param string $emailBody
1166
	 * @param int $sendingTime
1167
	 * @param int $priority
1168
	 * @param int $lastSendingTime
1169
	 * @param string $language
1170
	 * @param int $pid
1171
	 * @return Mail
1172
1173
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
1174
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
1175
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
1176
	 */
1177
	private function addMailToMailQueue(
1178
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
1179
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
1180
	): Mail {
1181
		$mail = $this->objectManager->get(Mail::class);
1182
		$mail->setPid($pid);
1183
1184
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
1185
		$mail->setLanguage($language);
1186
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
1187

1188
		$mail->setFromAddress($this->fromAddress);
1189
		$mail->setFromName($this->fromName);
1190

1191
		$mail->setToAddress($this->toAddresses);
1192
		$mail->setMailSubject($subject);
1193
		$mail->setMailBody($emailBody);
1194
		$mail->setPriority($priority);
1195
1196
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
1197
		$mail->setSendingTime($sendingTime);
1198
		$mail->setLastSendingTime($lastSendingTime);
1199
		$mail->setReplyTo($this->replyToAddress);
1200
1201
1202
1203
1204
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
1205

1206
		$mailRepository = $this->objectManager->get(MailRepository::class);
1207
		$mailRepository->add($mail);
1208
		$this->persistenceManager->persistAll();
1209
		return $mail;
1210
	}
1211

1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
	/**
	 * Get the mail object by uid and check if it's blacklisted
	 * @param $uid
	 */
	private function getMailObjectByUid($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		$mailObject = $mailRepository->findOneByUid($uid);
		if (!$mailObject || $mailObject->getBlacklisted()) {
			return FALSE;
		}
		return $mailObject;
	}

1225
1226
1227
1228
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
1229
	 * @return bool|NULL
1230
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
Paul Ilea's avatar
Paul Ilea committed
1231
1232
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
1233
	 */
1234
	public function sendMailFromQueue($uid): bool {
1235
1236
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
1237
1238
1239
		if (!isset(self::$mailObjectCache[$uid]) || !self::$mailObjectCache[$uid] instanceof Mail) {
			$mailToSend = $this->getMailObjectByUid($uid);
			if ($mailToSend === FALSE) {
1240
1241
				return FALSE;
			}
1242
1243
		} else {
			$mailToSend = self::$mailObjectCache[$uid];
1244
		}
1245

1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
		$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());
1258

1259
1260
1261
		if ($mailToSend->getBccAddresses()) {
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
		}
1262

1263
1264
1265
		if ($mailToSend->getCcAddresses()) {
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
		}
1266

1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
		if ($mailToSend->getReplyTo()) {
			$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
		}
		$attachments = $mailToSend->getAttachments();
		if ($attachments->count() > 0) {
			foreach ($attachments as $attachment) {
				/**
				 * @var FileReference $attachment
				 */
				$file = $attachment->getOriginalResource()->getOriginalFile();
				$this->mailMessage->attach(
					\Swift_Attachment::newInstance($file->getContents(), $file->getName(), $file->getMimeType())
				);
1280
			}
1281
		}
1282
1283
1284
1285
1286
1287
1288
1289
		$dateTime = new DateTime();
		if ((int) $mailToSend->getSendingTime() === 0) {
			$mailToSend->setSendingTime($dateTime->getTimestamp());
		}
		$mailToSend->setLastSendingTime($dateTime->getTimestamp());
		$success = $this->mailMessage->send();
		if ($success) {
			$mailRepository->update($mailToSend);
1290
			$this->persistenceManager->persistAll();
1291
1292
1293
		} else {
			$this->mailMessage->getFailedRecipients();
		}
1294
		unset(self::$mailObjectCache[$uid]); // free the memory
1295
		return $success;
1296
1297
	}

1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
	/**
	 * 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)) {
1308
1309
			$fromMail = $this->fromAddress;
		}
1310
		if (!\filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
1311
			$fromMail = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
1312
			if (!\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
1313
1314
1315
1316
				$fromMail = 'noreply@example.com';
			}
		}