MailTemplateService.php 40.1 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
	/*
	 * @var string
	 */
	private $defaultFromAddress;

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

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
315
316
317
318
319
	/**
	 * @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;
	}

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

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

345
		// use defaultMailFromAddress if it is provided in LocalConfiguration.php; use the sg_mail TS setting as fallback
346
		if (\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
347
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
348
349
350
351
			$this->defaultFromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
		} else if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
			$this->fromAddress = 'noreply@example.org';
			$this->defaultFromAddress = 'noreply@example.org';
352
		} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
353
			$this->fromAddress = $tsSettings['mail']['default']['from'];
354
			$this->defaultFromAddress = $tsSettings['mail']['default']['from'];
355
356
		}

357
358
		if ($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$this->fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
359
			$this->defaultFromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
360
361
362
		}

		$this->mailMessage->setFrom($this->fromAddress, $this->fromName);
Torsten Oppermann's avatar
Torsten Oppermann committed
363
364
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
365
366

		foreach ($this->bccAddresses as $index => $email) {
367
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
368
369
370
371
372
373
374
375
376
377
				unset($this->bccAddresses[$index]);
			}
		}

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

378
		if (\count($this->bccAddresses) > 0) {
379
380
381
			$this->mailMessage->setBcc($this->bccAddresses);
		}

382
		if (\count($this->ccAddresses) > 0) {
383
384
			$this->mailMessage->setCc($this->ccAddresses);
		}
385
386
	}

387
388
389
	/**
	 * @param string $fromName
	 */
390
	public function setFromName($fromName) {
391
392
393
394
395
396
397
398
		$this->fromName = $fromName;
	}

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
399
	public static function getReadableMarkerType($markerType) {
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
505
506
507
508
509
		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;
	}

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

538
539
540
541
542
543
544
545
546
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

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

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
596
597
598
599
600
		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;
	}

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

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
630
				'uid_local' => $file->getUid(),
631
632
633
634
635
636
637
638
639
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
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
686
687
688
689
690
		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
	 */
691
	public function setSubject(string $subject) {
692
693
694
		$this->subject = $subject;
	}

695
696
697
698
699
700
701
702
703
704
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}

	/**
	 * @param string $overwrittenEmailBody
	 */
705
	public function setOverwrittenEmailBody(string $overwrittenEmailBody) {
706
707
708
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}

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

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

777
	/**
778
779
	 * Parses markers in an email View.
	 * !!! CHANGES THE SOURCE PATH AND IT SHOULD BE RESET BACK TO THE ORIGINAL!!!
780
	 *
781
782
783
	 * @param string $text
	 * @param StandaloneView $emailView
	 * @return mixed
784
	 */
785
786
787
788
789
	protected function parseMarkers($text, $emailView) {
		if (strpos($text, '{') !== FALSE) {
			$emailView->setTemplateSource($text);
			return $emailView->render();
		}
790

791
792
793
		return $text;
	}

794
	/**
795
	 * Gets the current PageUid
796
	 *
797
	 * @return int
798
	 */
799
	protected function getPageUid(): int {
800
		if (TYPO3_MODE === 'FE') {
801
802
803
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
804
805
806
807
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

808
		if ($this->pid) {
809
			$pageUid = $this->pid;
810
		}
811

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

841
842
		if ($rootPageRows && \count($rootPageRows)) {
			$pageUid = (int) $rootPageRows[0]['uid'];
843
		}
844
845
		return $pageUid;
	}
846

847
848
849
850
851
852
853
854
855
856
857
858
	/**
	 * 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);
	}
859

860
861
862
863
864
865
866
	/**
	 * Get the template object
	 *
	 * @param int $siteRootId
	 * @return null|object|Template|FALSE
	 * @throws \Exception
	 */
867
	private function getTemplate($siteRootId) {
868
869
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
870
			throw new \Exception('The template is blacklisted');
871
872
		}

873
874
875
876
877
		$templateHash = $this->getTemplateHash($this->extensionKey, $this->templateName, $siteRootId, $this->language);
		if (isset(self::$templateObjectCache[$templateHash])
			&& self::$templateObjectCache[$templateHash] instanceof Template) {
			return self::$templateObjectCache[$templateHash];
		}
878
		/** @var Template $template */
879
		$template = $this->templateRepository->findOneByTemplate(
880
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
881
		);
882

883
884
885
886
887
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}
888
		self::$templateObjectCache[$templateHash] = $template;
889
890
		return $template;
	}
891

892
893
894
	/**
	 * Get the default content for this template
	 *
895
896
	 * @param Template|null $template
	 * @param RegisterService $registerService
897
	 * @return bool|false|string
898
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
899
900
	 */
	protected function getDefaultTemplateContent($template, $registerService) {
901
902
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
903

904
		// If there is no template for this language, use the default template
905
		if ($template === NULL && $defaultTemplateContent === NULL) {
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
			$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']
				);
921

922
923
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
924
				} else {
925
					return FALSE;
926
				}
927
			}
Torsten Oppermann's avatar
Torsten Oppermann committed
928
		}
929
930
		return $defaultTemplateContent;
	}
Torsten Oppermann's avatar
Torsten Oppermann committed
931

932
	/**
933
934
935
	 * Sets the values to send the mail with from the template or register service
	 *
	 * @param Template|null $template
936
937
938
	 * @param RegisterService $registerService
	 * @param string $defaultTemplateContent
	 * @param int $siteRootId
939
	 * @param boolean $isNewsletter
940
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
941
	 */
942
943
	protected function extractValuesForMail($template, RegisterService $registerService, $defaultTemplateContent,
		$siteRootId, $isNewsletter): void {
944
		/** @var StandaloneView $emailView */
945
		$emailView = $this->objectManager->get(StandaloneView::class);
946
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
947
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
948

949
950
951
952
953
954
		$overwrittenEmailBody = $this->getOverwrittenEmailBody();
		$overwrittenSubject = '';
		if ($this->subject !== '' && $this->subject !== NULL) {
			$overwrittenSubject = $this->subject;
		}

955
		// parse markers
Paul Ilea's avatar
Paul Ilea committed
956
		if ($template !== NULL) {
957
958
959
			$subject = $this->parseMarkers(
				trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject),
				$emailView
960
			);
961

962
963
			$layoutId = $template->getLayout();
			$templateContent = $template->getContent();
964
			$this->setSubjectToSend($subject);
965
		} else {
966
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
967
968
			if (\is_array($subject)) {
				$subject = \trim(
969
970
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
971
				);
972
			}
973
974
975
976
			$subject = $this->parseMarkers(
				(empty($overwrittenSubject) ? $subject : $overwrittenSubject),
				$emailView
			);
977

978
979
980
			$layoutId = 0;
			$templateContent = $defaultTemplateContent;
		}
981

982
983
		$this->setSubjectToSend($subject);
		//TODO: is this object even in use somewhere?
984
		$this->mailMessage->setSubject($subject);
985

986
987
988
989
990
991
992
		$fromMail = '';
		if (!$isNewsletter && $template !== NULL) {
			// if it's a non-newsletter email with a template:
			// get the values explicitly from the template and parse the markers
			$fromMail = $this->parseMarkers($template->getFromMail(), $emailView);
		} elseif ($this->fromAddress === $this->defaultFromAddress) {
			// in other cases (newsletter or no template) - check for overwritten values
993
			$fromMail = $this->parseMarkers(
994
				empty($this->overwrittenFromMail) && $template ? $template->getFromMail() : $this->overwrittenFromMail,
995
				$emailView
996
			);
997
998
999
		}
		if ($fromMail) { // we don't want to override the default in that case
			$this->setFromAddress($fromMail);
1000
1001
		}

1002
1003
1004
1005
		$fromName = '';
		if (!$isNewsletter && $template !== NULL) {
			$fromName = $this->parseMarkers($template->getFromName(), $emailView);
		} else if ($this->fromName === $this->defaultFromName) {
1006
			$fromName = $this->parseMarkers(
1007
1008
				(empty($this->overwrittenFromName) && $template ? $template->getFromName(
				) : $this->overwrittenFromName),
1009
				$emailView
1010
			);
1011
1012
1013
		}
		if ($fromName) { // we don't want to override the default if this value is empty here
			$this->setFromName($fromName);
1014
1015
		}

1016
1017
1018
1019
		if (!$isNewsletter && $template !== NULL) {
			$replyTo = $this->parseMarkers($template->getReplyTo(), $emailView);
			$this->setReplyToAddress($replyTo);
		} else if ($this->replyToAddress === '') {
1020
			$replyTo = $this->parseMarkers(
1021
1022
				(empty($this->overwrittenReplyTo) && $template ? $template->getReplyTo(
				) : $this->overwrittenReplyTo),
1023
1024
1025
1026
1027
				$emailView
			);
			$this->setReplyToAddress($replyTo);
		}

1028
1029
1030
1031
1032
1033
		if (!$isNewsletter && $template !== NULL) {
			$cc = $this->parseMarkers($template->getCc(), $emailView);
			if ($cc) {
				$this->setCcAddresses($cc);
			}
		} else if (empty($this->ccAddresses)) {
1034
			$cc = $this->parseMarkers(
1035
				(empty($this->overwrittenCc) && $template ? $template->getCc() : $this->overwrittenCc),
1036
1037
1038
1039
1040
				$emailView
			);
			$this->setCcAddresses($cc);
		}

1041
1042
1043
1044
1045
1046
		if (!$isNewsletter && $template !== NULL) {
			$bcc = $this->parseMarkers($template->getBcc(), $emailView);
			if ($bcc) {
				$this->setBccAddresses($bcc);
			}
		} else if (empty($this->bccAddresses)) {
1047
			$bcc = $this->parseMarkers(
1048
				(empty($this->overwrittenBcc) && $template ? $template->getBcc() : $this->overwrittenBcc),
1049
1050
1051
1052
1053
				$emailView
			);
			$this->setBccAddresses($bcc);
		}

1054
1055
1056
1057
1058
1059
		if (!$isNewsletter && $template !== NULL) {
			$toAddress = $this->parseMarkers($template->getToAddress(), $emailView);
			if ($toAddress) {
				$this->setToAddresses($toAddress);
			}
		} else if ($this->toAddresses === '') {
1060
			$toAddress = $this->parseMarkers(
1061
				(empty($this->overwrittenToAddresses) && $template ? $template->getToAddress() : $this->overwrittenToAddresses),
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
				$emailView
			);
			$this->setToAddresses($toAddress);
		}

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

1075
1076
		// insert <br> tags, but replace every instance of three or more successive breaks with just two.
		$emailBody = $emailView->render();
1077
		$emailBody = \nl2br($emailBody);
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
		$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
	 */
1102
	public function sendEmail($isPreview = FALSE, $isNewsletter = FALSE): bool {
1103
1104
1105
1106
1107
1108
		if ($isPreview) { //TODO: remove this from here
			$this->setIgnoreMailQueue(TRUE);
		}
		$success = FALSE;

		// Get page ID
1109
		// TODO: this doesn't belong here. The API user needs to provide the UID
1110
		$siteRootId = $this->getSiteRootId();
1111
1112
1113
1114
		try {
			$template = $this->getTemplate($siteRootId);
		} catch (\Exception $e) {
			return FALSE;
1115
		}
1116

1117
1118
1119
		$registerService = GeneralUtility::makeInstance(RegisterService::class);

		// get default template content from register array
1120
		$defaultTemplateContent = $this->getDefaultTemplateContent($template, $registerService);
1121
1122
1123

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

1128
1129
1130
1131
1132
1133
		$this->extractValuesForMail($template, $registerService, $defaultTemplateContent, $siteRootId, $isNewsletter);

		// Fallback empty recipient address to the default sender address
		if (!$this->mailMessage->getTo()) {
			$this->mailMessage->setTo($this->defaultFromAddress);
		}
1134

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

1145
		//TODO: this can be avoided if the sending logic is decoupled from this function
1146
1147
1148
1149
		if ($isPreview) {
			$mailRepository = $this->objectManager->get(MailRepository::class);
			$mailRepository->remove($mail);
			$this->persistenceManager->persistAll();
1150
		}
1151

1152
		return $success;
1153
1154
	}

Paul Ilea's avatar
Paul Ilea committed
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
	/**
	 * 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;
	}

1227
	/**
1228
	 * Adds a new mail to the mail queue.
1229
	 *
1230
1231
	 * @param string $extensionKey
	 * @param string $templateName
1232
	 * @param string $subject
1233
	 * @param string $emailBody
1234
	 * @param int $sendingTime
1235
	 * @param int $priority
1236
	 * @param int $lastSendingTime
1237
	 * @param string $language
1238
	 * @param int $pid
1239
	 * @return Mail
1240
1241
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
1242
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
1243
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
1244
	 */
1245
	private function addMailToMailQueue(
1246
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
1247
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
1248
	): Mail {
1249
		$mail = $this->objectManager->get(Mail::class);
1250
		$mail->setPid($pid);
1251
1252
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
1253
		$mail->setLanguage($language);
1254
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
1255

1256
		$mail->setFromAddress($this->fromAddress);
1257
		$mail->setFromName($this->fromName);
1258

1259
		$mail->setToAddress($this->toAddresses);
1260
		$mail->setMailSubject($subject);
1261
		$mail->setMailBody($emailBody);
1262
		$mail->setPriority($priority);
1263
1264
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
1265
		$mail->setSendingTime($sendingTime);
1266
		$mail->setLastSendingTime($lastSendingTime);
1267
		$mail->setReplyTo($this->replyToAddress);
1268
1269
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
				// 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);
				}
1285
1286
			}
		}
1287

1288
		$mailRepository = $this->objectManager->get(MailRepository::class);
1289
		$mailRepository->add($mail);
1290
		$this->persistenceManager->persistAll();
1291
		return $mail;
1292
	}
1293

1294
1295
	/**
	 * Get the mail object by uid and check if it's blacklisted
1296