MailTemplateService.php 37.7 KB
Newer Older
1
<?php
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/***************************************************************
 *  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!
 ***************************************************************/
25
namespace SGalinski\SgMail\Service;
26

27
use DateTime;
28
use SGalinski\SgMail\Domain\Model\Layout;
29
30
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
Paul Ilea's avatar
Paul Ilea committed
31
use SGalinski\SgMail\Domain\Repository\LayoutRepository;
32
use SGalinski\SgMail\Domain\Repository\MailRepository;
33
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
34
use Symfony\Component\Mailer\Exception\TransportException;
35
use TYPO3\CMS\Core\Database\ConnectionPool;
36
use TYPO3\CMS\Core\Mail\MailMessage;
37
use TYPO3\CMS\Core\Resource\File;
38
use TYPO3\CMS\Core\Resource\ResourceFactory;
Paul Ilea's avatar
Paul Ilea committed
39
use TYPO3\CMS\Core\Routing\SiteMatcher;
40
use TYPO3\CMS\Core\Utility\GeneralUtility;
41
use TYPO3\CMS\Core\Utility\VersionNumberUtility;
42
use TYPO3\CMS\Extbase\Domain\Model\FileReference;
43
use TYPO3\CMS\Extbase\Object\ObjectManager;
44
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
45
46
use TYPO3\CMS\Fluid\View\StandaloneView;

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

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

	/**
	 * @var array
	 */
	private static $mailObjectCache = [];
71
72
73
74
75
76
77
78
79
80
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
	protected $templateRepository;
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\LayoutRepository
	 */
	protected $layoutRepository;
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
81
	 * @deprecated Not used since TYPO3 10
82
83
	 */
	protected $objectManager;
84
85
86
87
88
89

	/**
	 * @var RegisterService
	 */
	protected $registerService;

90
	/**
91
	 * @var \TYPO3\CMS\Core\Resource\ResourceFactory
92
93
	 */
	protected $resourceFactory;
94
	/**
95
	 * @var string $toAddresses
96
	 */
97
	private $toAddresses = '';
98
	/**
99
	 * @var string $fromAddress
100
	 */
101
	private $fromAddress = '';
102
	/**
103
	 * @var string $ccAddresses
104
	 */
Paul Ilea's avatar
Paul Ilea committed
105
	private $ccAddresses;
106
	/**
107
	 * @var string $replyToAddress
108
	 */
109
	private $replyToAddress = '';
110
	/**
111
	 * @var string $language
112
	 */
113
	private $language = 'default';
114
	/**
115
	 * @var boolean $ignoreMailQueue
116
	 */
117
	private $ignoreMailQueue = TRUE;
118
119
120
121
122
	/**
	 * @var \TYPO3\CMS\Core\Mail\MailMessage $mailMessage
	 */
	private $mailMessage;
	/**
123
	 * @var string $templateName
124
125
	 */
	private $templateName;
126
127
128
129
	/**
	 * @var string $subject
	 */
	private $subject;
130
131
132
133
	/**
	 * @var string $overwrittenEmailBody
	 */
	private $overwrittenEmailBody = '';
134
	/**
135
	 * @var string $extensionKey
136
137
138
	 */
	private $extensionKey;
	/**
139
	 * @var array $markers
140
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
141
	private $markers;
142
143
144
145
	/**
	 * @var array $markerLabels
	 */
	private $markerLabels;
146
	/**
147
	 * @var string $bccAddresses
148
	 */
Paul Ilea's avatar
Paul Ilea committed
149
	private $bccAddresses;
150
151
152
153
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;
154
155
156
157
	/**
	 * @var int
	 */
	private $pid;
158
159
160
161
	/**
	 * @var string
	 */
	private $fromName = '';
162
163
164
165
	/**
	 * @var string
	 */
	private $mailBodyToSend;
166

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

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

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

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

197
		$this->registerService = GeneralUtility::makeInstance(RegisterService::class);
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
		$this->resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class);
		$this->mailMessage = GeneralUtility::makeInstance(MailMessage::class);

		if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0')) {
			$this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
			/** @var TypoScriptSettingsService $typoScriptSettingsService */
			$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
			/** @var TemplateRepository templateRepository */
			$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
			/** @var LayoutRepository layoutRepository */
			$this->layoutRepository = $this->objectManager->get(LayoutRepository::class);
		} else {
			$typoScriptSettingsService = GeneralUtility::makeInstance(TypoScriptSettingsService::class);
			$this->templateRepository = GeneralUtility::makeInstance(TemplateRepository::class);
			$this->layoutRepository = GeneralUtility::makeInstance(LayoutRepository::class);
		}
214

215
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
216
		// use defaultMailFromAddress if it is provided in LocalConfiguration.php; use the sg_mail TS setting as fallback
217
		if (\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
218
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
219
			$this->defaultFromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
220
		} else {
221
222
223
224
225
226
227
			if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
				$this->fromAddress = 'noreply@example.org';
				$this->defaultFromAddress = 'noreply@example.org';
			} else {
				$this->fromAddress = $tsSettings['mail']['default']['from'];
				$this->defaultFromAddress = $tsSettings['mail']['default']['from'];
			}
228
229
		}

230
231
		if ($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$this->fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
232
			$this->defaultFromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
233
234
235
		}

		$this->mailMessage->setFrom($this->fromAddress, $this->fromName);
Torsten Oppermann's avatar
Torsten Oppermann committed
236
237
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
238
239

		foreach ($this->bccAddresses as $index => $email) {
240
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
241
242
243
244
245
246
247
248
249
250
				unset($this->bccAddresses[$index]);
			}
		}

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

251
		if (\count($this->bccAddresses) > 0) {
252
253
254
			$this->mailMessage->setBcc($this->bccAddresses);
		}

255
		if (\count($this->ccAddresses) > 0) {
256
257
			$this->mailMessage->setCc($this->ccAddresses);
		}
258
259
	}

260
261
262
263
264
	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
265
	public static function getReadableMarkerType($markerType) {
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
		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');
		}
	}

	/**
285
286
287
288
289
290
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
291
	 */
292
293
294
295
296
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail'): array {
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
		// Need the key for translations
		if (\trim($extensionKey) === '') {
			return [];
297
298
		}

299
300
301
302
303
304
305
306
307
		$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
			];
308
309
		}

310
		return $generatedMarker;
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
	}

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

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

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

340
341
342
343
344
345
346
347
348
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

349
350
351
352
353
354
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function setMarkers(array $markers): MailTemplateService {
		$this->markers = $markers;
355
		foreach ($markers as $key => $currentMarker) {
356
			if (!\is_array($currentMarker) || !isset($currentMarker['markerLabel'])) {
357
358
359
360
361
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

362
363
364
365
366
367
368
369
370
371
372
373
374
		return $this;
	}

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

	/**
375
376
	 * Adds a file resource as attachment
	 *
377
378
	 * @param FileReference $fileReference
	 * @param File $file
379
380
	 *
	 * @return MailTemplateService
381
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
382
	 */
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
	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;
			}
400
401
402
403
		}

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
404
				'uid_local' => $file->getUid(),
405
406
407
408
409
410
411
412
413
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
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
		return $this;
	}

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

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

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

	/**
	 * @param string $subject
	 */
445
	public function setSubject(string $subject) {
446
447
448
		$this->subject = $subject;
	}

449
450
451
452
453
454
455
456
457
	/**
	 * Set preview markers for the template editor
	 *
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 */
	public function setPreviewMarkers() {
		$previewMarker = [];

		/** @var array $markerArray */
458
		$markerArray = $this->registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
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

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

486
	/**
487
	 * Send the Email
488
	 *
489
490
491
492
493
494
495
	 * @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
496
	 */
497
498
499
	public function sendEmail($isPreview = FALSE, $isNewsletter = FALSE): bool {
		if ($isPreview) { //TODO: remove this from here
			$this->setIgnoreMailQueue(TRUE);
500
		}
501
		$success = FALSE;
502

503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
		// Get page ID
		// TODO: this doesn't belong here. The API user needs to provide the UID
		$siteRootId = $this->getSiteRootId();
		try {
			$template = $this->getTemplate($siteRootId);
		} catch (\Exception $e) {
			return FALSE;
		}

		// Load the values from the template if they are set
		if (!$isNewsletter && $template !== NULL) {
			$this->loadTemplateValues($template);
		}

		// get default template content from register array
518
		$defaultTemplateContent = $this->getDefaultTemplateContent($template);
519
520
521
522
523
524
525

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

526
		$this->parseValuesForMail($template, $defaultTemplateContent, $siteRootId);
527
528
529
530
531
532
533
534
535
536
537
538
539

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

		//TODO: this can be avoided if the sending logic is decoupled from this function
		if ($isPreview) {
540
541
542
543
544
545
546
			if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
				/** @var MailRepository $mailRepository */
				$mailRepository = $this->objectManager->get(MailRepository::class);
			} else {
				$mailRepository = GeneralUtility::makeInstance(MailRepository::class);
			}

547
			$mailRepository->remove($mail);
548
			$mailRepository->persist();
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
		}

		return $success;
	}

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

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

573
	/**
574
	 * Gets the current PageUid
575
	 *
576
	 * @return int
577
	 */
578
	protected function getPageUid(): int {
579
		if (TYPO3_MODE === 'FE') {
580
			$pageUid = (int) $GLOBALS['TSFE']->id;
581
582
583
584
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

585
		if ($this->pid) {
586
			$pageUid = $this->pid;
587
		}
588

589
		if ($pageUid === 0) {
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
			$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
609
				)
610
611
612
613
			)
			->andWhere(
				$queryBuilder->expr()->eq(
					'hidden', 0
614
				)
615
616
			)
			->execute()->fetchAll();
617

618
619
		if ($rootPageRows && \count($rootPageRows)) {
			$pageUid = (int) $rootPageRows[0]['uid'];
620
		}
621
622
		return $pageUid;
	}
623

624
625
626
627
628
629
630
	/**
	 * Get the template object
	 *
	 * @param int $siteRootId
	 * @return null|object|Template|FALSE
	 * @throws \Exception
	 */
631
	private function getTemplate($siteRootId) {
632
		$isTemplateBlacklisted = $this->registerService->isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
633
		if ($isTemplateBlacklisted) {
634
			throw new \Exception('The template is blacklisted');
635
636
		}

637
638
639
640
641
		$templateHash = $this->getTemplateHash($this->extensionKey, $this->templateName, $siteRootId, $this->language);
		if (isset(self::$templateObjectCache[$templateHash])
			&& self::$templateObjectCache[$templateHash] instanceof Template) {
			return self::$templateObjectCache[$templateHash];
		}
642
		/** @var Template $template */
643
		$template = $this->templateRepository->findOneByTemplate(
644
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
645
		);
646

647
648
649
650
651
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}
652
		self::$templateObjectCache[$templateHash] = $template;
653
654
		return $template;
	}
655

656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
	/**
	 * Get the hash for the object cache
	 *
	 * @param $extensionKey
	 * @param $templateName
	 * @param $siteRootId
	 * @param $languageId
	 * @return string
	 */
	private function getTemplateHash($extensionKey, $templateName, $siteRootId, $languageId) {
		return md5($extensionKey . '_' . $templateName . '_' . $siteRootId . '_' . $languageId);
	}

	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
674
	private function loadTemplateValues(Template $template) {
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
		$fromName = \trim($template->getFromName());
		if ($fromName === '') {
			$fromName = $this->fromName;
		}
		if ($fromName === '' && $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

		$fromMail = $this->getValidFromMail(\trim($template->getFromMail()));
		// The setters check if the value is empty or not
		$this->setFromAddress($fromMail, $fromName);
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
		$this->setFromName($fromName);
	}

	/**
	 * Sets the fromMail property of the mailTemplateService.
	 * Checks validity and uses all available fallbacks
	 *
	 * @param string $fromMail
	 * @return string
	 */
	private function getValidFromMail($fromMail): string {
		$fromMail = \trim($fromMail);
		if (!\filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
			$fromMail = $this->fromAddress;
		}
		if (!\filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
			$fromMail = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
			if (!\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
				$fromMail = 'noreply@example.com';
			}
		}

		return $fromMail;
	}

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

		return $this;
	}

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

		return $this;
	}

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

		return $this;
	}

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

		return $this;
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
	}

774
775
776
	/**
	 * Get the default content for this template
	 *
777
	 * @param Template|null $template
778
	 * @return bool|false|string
779
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
780
	 */
781
	protected function getDefaultTemplateContent($template) {
782
		$defaultTemplateContent =
783
			$this->registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
784

785
		// If there is no template for this language, use the default template
786
		if ($template === NULL && $defaultTemplateContent === NULL) {
787
			$templatePath =
788
				$this->registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];
789
790
791
792
793
794
795

			// 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
796
797
798
799
800
801
802
				if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
					/** @var TypoScriptSettingsService $typoScriptSettingsService */
					$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
				} else {
					$typoScriptSettingsService = GeneralUtility::makeInstance(TypoScriptSettingsService::class);
				}

803
804
805
806
				$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
				$defaultTemplateFile = GeneralUtility::getFileAbsFileName(
					$tsSettings['mail']['defaultHtmlTemplate']
				);
807

808
809
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
810
				} else {
811
					return FALSE;
812
				}
813
			}
Torsten Oppermann's avatar
Torsten Oppermann committed
814
		}
815
816
		return $defaultTemplateContent;
	}
Torsten Oppermann's avatar
Torsten Oppermann committed
817

818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
	/**
	 * @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;
	}

834
	/**
835
836
837
	 * Sets the values to send the mail with from the template or register service
	 *
	 * @param Template|null $template
838
839
	 * @param string $defaultTemplateContent
	 * @param int $siteRootId
840
	 * @param boolean $isNewsletter
841
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
842
	 */
843
	protected function parseValuesForMail(
844
		$template, $defaultTemplateContent,
845
		$siteRootId
846
	) {
847
848
849
850
851
852
853
		if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
			/** @var StandaloneView $emailView */
			$emailView = $this->objectManager->get(StandaloneView::class);
		} else {
			$emailView = GeneralUtility::makeInstance(StandaloneView::class);
		}

854
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
855
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
856
		$emailView->assign('all_fields_html', $this->getAllMarkerHTML($this->markers));
857

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

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

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

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

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

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

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

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

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

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

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

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

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

930
931
932
933
934
935
936
		$layout = $this->getLayoutSource($layoutId, $siteRootId);
		$emailHTMLHead = '';
		if ($layout) {
			$emailHTMLHead = $layout->getHeadContent();
			$emailBody = \str_replace('###CONTENT###', $emailBody, $layout->getContent());
		}
		$this->mailBodyToSend = '<html><head>' . $emailHTMLHead . '</head><body>' . $emailBody . '</body></html>';
937
938
939
	}

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

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

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

969
970
		return $allMarker;
	}
971

972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
	/**
	 * Get a single variable containing a list of all markers in table markup
	 *
	 * @param array $markers
	 * @return string
	 */
	private function getAllMarkerHTML(array $markers): string {
		$allMarker = '<table>';
		$allMarker .= '<style> table { text-align: left; } table tr th, table tr td { border-bottom: 1px solid rgba(0,0,0,0.2); padding: 2px 6px 4px;} </style>';

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

			if (\is_string($value)) {
988
				$allMarker .= '<tr><th>' . $key . ' </th><td> ' . $value . '</td></tr>';
989
990
			} elseif (\is_array($value)) {
				foreach ($value as $innerKey => $innerValue) {
991
					$allMarker .= '<tr><th>' . $key . '.' . $innerKey . ' </th><td> ' . $innerValue . '</td></tr>';
992
993
994
				}
			} elseif (\is_bool($value)) {
				$valueAsString = $value ? 'true' : 'false';
995
				$allMarker .= '<tr><th>' . $key . ' </th><td> ' . $valueAsString . '</td></tr>';
996
997
			} elseif (\is_object($value)) {
				if (\method_exists($value, '__toString')) {
998
					$allMarker .= '<tr><th>' . $key . ' </th><td> ' . $value->__toString() . '</td></tr>';
999
1000
1001
1002
1003
1004
1005
1006
1007
				}
			}
		}

		$allMarker .= '</table>';

		return $allMarker;
	}

1008
1009
1010
1011
1012
1013
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}
1014

1015
1016
1017
1018
1019
1020
	/**
	 * @param string $overwrittenEmailBody
	 */
	public function setOverwrittenEmailBody(string $overwrittenEmailBody) {
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}
1021

1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
	/**
	 * Parses markers in an email View.
	 * !!! CHANGES THE SOURCE PATH AND IT SHOULD BE RESET BACK TO THE ORIGINAL!!!
	 *
	 * @param string $text
	 * @param StandaloneView $emailView
	 * @return mixed
	 */
	protected function parseMarkers($text, $emailView) {
		$text = (string) $text;
		if (strpos($text, '{') !== FALSE) {
			$emailView->setTemplateSource($text);
			return $emailView->render();
1035
		}
1036

1037
		return $text;
1038
1039
	}

Paul Ilea's avatar
Paul Ilea committed
1040
	/**
1041
	 * Returns the layout.
Paul Ilea's avatar
Paul Ilea committed
1042
1043
1044
	 *
	 * @param int $layoutUid
	 * @param int $siteRootId
1045
	 * @return Layout|NULL
Paul Ilea's avatar
Paul Ilea committed
1046
	 */
1047
	private function getLayoutSource(int $layoutUid, int $siteRootId) {
Paul Ilea's avatar
Paul Ilea committed
1048
1049
1050
1051
1052
		$languageUid = 0;
		if ($this->language !== self::DEFAULT_LANGUAGE) {
			$languageUid = (int) array_search($this->language, $this->getAvailableLanguages(), TRUE);
		}

1053
		return $this->layoutRepository->findByUidOrDefault($layoutUid, $siteRootId, $languageUid);
Paul Ilea's avatar
Paul Ilea committed
1054
1055
1056
	}

	/**
1057
	 * Returns the list of available translation languages
Paul Ilea's avatar
Paul Ilea committed
1058
1059
1060
1061
1062
	 *
	 * @return array
	 */
	private function getAvailableLanguages(): array {
		$out = [0 => ''];
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
		try {
			$site = GeneralUtility::makeInstance(SiteMatcher::class)->matchByPageId(0);
		} catch (\Exception $exception) {
			return [0 => ''];
		}
		$availableLanguages = $site->getLanguages();
		$out = [];
		foreach ($availableLanguages as $language) {
			$languageId = $language->getLanguageId();
			if ($languageId < 0) {
				continue;
Paul Ilea's avatar
Paul Ilea committed
1074
			}
1075
			$out[$language->getLanguageId()] = strtolower($language->getTwoLetterIsoCode());
Paul Ilea's avatar
Paul Ilea committed
1076
1077
1078
1079
		}
		return $out;
	}

1080
	/**
1081
	 * Adds a new mail to the mail queue.
1082
	 *
1083
1084
	 * @param string $extensionKey
	 * @param string $templateName
1085
	 * @param string $subject
1086
	 * @param string $emailBody
1087
	 * @param int $sendingTime
1088
	 * @param int $priority
1089
	 * @param int $lastSendingTime
1090
	 * @param string $language
1091
	 * @param int $pid
1092
	 * @return Mail
1093
1094
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
1095
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
1096
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
1097
	 */
1098
	private function addMailToMailQueue(
1099
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
1100
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
1101
	): Mail {
1102
		$mail = new Mail();
1103
		$mail->setPid($pid);
1104
1105
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
1106
		$mail->setLanguage($language);
1107
		$mail->setBlacklisted($this->registerService->isTemplateBlacklisted($extensionKey, $templateName, $pid));
1108

1109
		$mail->setFromAddress($this->fromAddress);
1110
		$mail->setFromName($this->fromName);
1111

1112
		$mail->setToAddress($this->toAddresses);
1113
		$mail->setMailSubject($subject);
1114
		$mail->setMailBody($emailBody);
1115
		$mail->setPriority($priority);
1116
1117
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
1118
		$mail->setSendingTime($sendingTime);
1119
		$mail->setLastSendingTime($lastSendingTime);
1120
		$mail->setReplyTo($this->replyToAddress);
1121
1122
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
				// 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)
						]
					);
1134
					$newFileReference = new FileReference();
1135
1136
1137
					$newFileReference->setOriginalResource($coreFileReferenceMailFile);
					$mail->addAttachment($newFileReference);
				}
1138
1139
			}
		}
1140

1141
1142
1143
1144
1145
1146
1147
		if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '10.4.0', '<')) {
			/** @var MailRepository $mailRepository */
			$mailRepository = $this->objectManager->get(MailRepository::class);
		} else {
			$mailRepository = GeneralUtility::makeInstance(MailRepository::class);
		}

1148
		$mailRepository->add($mail);
1149