MailTemplateService.php 33.2 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 string $toAddresses
68
	 */
69
	private $toAddresses = '';
70
71

	/**
72
	 * @var string $fromAddress
73
	 */
74
	private $fromAddress = '';
75
76

	/**
77
	 * @var string $ccAddresses
78
	 */
Paul Ilea's avatar
Paul Ilea committed
79
	private $ccAddresses;
80
81

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

	/**
87
	 * @var string $language
88
	 */
89
	private $language = 'default';
90
91

	/**
92
	 * @var boolean $ignoreMailQueue
93
	 */
94
	private $ignoreMailQueue = FALSE;
95
96
97
98
99
100
101

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

	/**
102
	 * @var string $templateName
103
104
105
	 */
	private $templateName;

106
107
108
109
110
	/**
	 * @var string $subject
	 */
	private $subject;

111
112
113
114
115
	/**
	 * @var string $overwrittenEmailBody
	 */
	private $overwrittenEmailBody = '';

116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
	/**
	 * @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;

146
	/**
147
	 * @var string $extensionKey
148
149
150
151
	 */
	private $extensionKey;

	/**
152
	 * @var array $markers
153
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
154
	private $markers;
155

156
157
158
159
160
	/**
	 * @var array $markerLabels
	 */
	private $markerLabels;

161
	/**
162
	 * @var string $bccAddresses
163
	 */
Paul Ilea's avatar
Paul Ilea committed
164
	private $bccAddresses;
165

166
167
168
169
170
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

171
172
173
174
175
	/**
	 * @var int
	 */
	private $pid;

176
177
178
179
180
	/**
	 * @var string
	 */
	private $fromName = '';

181
182
183
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
184
185
	protected $templateRepository;

Paul Ilea's avatar
Paul Ilea committed
186
187
188
189
190
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\LayoutRepository
	 */
	protected $layoutRepository;

191
192
193
194
	/**
	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager
	 */
	protected $persistenceManager;
195

196
197
198
199
200
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

201
202
203
204
205
	/**
	 * @var TYPO3\CMS\Core\Resource\ResourceFactory
	 */
	protected $resourceFactory;

206
207
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
208
	 *
209
210
	 * @param string $templateName
	 * @param string $extensionKey
211
	 * @param array $markers
212
	 * @param array $markerLabels
Paul Ilea's avatar
Paul Ilea committed
213
	 * @throws \InvalidArgumentException
214
	 */
215
	public function __construct($templateName = '', $extensionKey = '', $markers = [], $markerLabels = []) {
216
217
218
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;
219
		$this->markerLabels = $markerLabels;
220

221
222
223
224
		/** @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
225
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
226
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
Paul Ilea's avatar
Paul Ilea committed
227
		$this->layoutRepository = $this->objectManager->get(LayoutRepository::class);
228
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
229
		$this->resourceFactory = $this->objectManager->get(ResourceFactory::class);
230

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

237
			if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
238
239
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
240
				$this->fromAddress = $tsSettings['mail']['default']['from'];
241
			}
242
243
		}

244
245
246
247
248
		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
249
250
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
251
252

		foreach ($this->bccAddresses as $index => $email) {
253
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
254
255
256
257
258
259
260
261
262
263
				unset($this->bccAddresses[$index]);
			}
		}

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

264
		if (\count($this->bccAddresses) > 0) {
265
266
267
			$this->mailMessage->setBcc($this->bccAddresses);
		}

268
		if (\count($this->ccAddresses) > 0) {
269
270
			$this->mailMessage->setCc($this->ccAddresses);
		}
271
272
	}

273
274
275
	/**
	 * @param string $fromName
	 */
276
	public function setFromName($fromName) {
277
278
279
280
281
282
283
284
		$this->fromName = $fromName;
	}

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
285
	public static function getReadableMarkerType($markerType) {
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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
		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;
	}

396
397
398
399
400
401
402
403
404
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

405
406
407
408
409
410
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function setMarkers(array $markers): MailTemplateService {
		$this->markers = $markers;
411
		foreach ($markers as $key => $currentMarker) {
412
			if (!\is_array($currentMarker) || !isset($currentMarker['markerLabel'])) {
413
414
415
416
417
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

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

	/**
459
460
	 * Adds a file resource as attachment
	 *
461
462
	 * @param FileReference $fileReference
	 * @param File $file
463
464
	 *
	 * @return MailTemplateService
465
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
466
	 */
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
	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;
			}
484
485
486
487
		}

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
488
				'uid_local' => $file->getUid(),
489
490
491
492
493
494
495
496
497
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
		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
	 */
549
	public function setSubject(string $subject) {
550
551
552
		$this->subject = $subject;
	}

553
554
555
556
557
558
559
560
561
562
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}

	/**
	 * @param string $overwrittenEmailBody
	 */
563
	public function setOverwrittenEmailBody(string $overwrittenEmailBody) {
564
565
566
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}

567
568
569
570
571
572
573
574
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
575
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail'): array {
576
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
577
		// Need the key for translations
578
		if (\trim($extensionKey) === '') {
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
			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;
	}

596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
	/**
	 * 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);
	}

635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
	/**
	 * 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;
	}

651
	/**
652
	 * Send the Email
653
	 *
654
655
	 * @param bool $isPreview
	 * @return bool email was sent or added to mail queue successfully?
656
657
658
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
659
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
660
	 * @throws \Exception
661
	 */
662
	public function sendEmail($isPreview = FALSE): bool {
663
		$success = FALSE;
664
		if (TYPO3_MODE === 'FE') {
665
666
667
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
668
669
670
671
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

672
		if ($this->pid) {
673
			$pageUid = $this->pid;
674
		}
675

676
		if ($pageUid === 0) {
677
678
			$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(
				'pages'
679
			);
680
			$rootPageRows = $queryBuilder->select('*')
681
				->from('pages')
682
683
684
685
686
687
688
689
690
691
692
693
				->where(
					$queryBuilder->expr()->eq(
						'is_siteroot', 1
					)
				)
				->andWhere(
					$queryBuilder->expr()->eq(
						'hidden', 0
					)
				)
				->execute()->fetchAll();

694
695
696
			if ($rootPageRows && \count($rootPageRows)) {
				$pageUid = (int) $rootPageRows[0]['uid'];
			}
697
		}
698
		$siteRootId = BackendService::getSiteRoot($pageUid);
699

700
701
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
702
703
			// @TODO throw error or log ?
			return FALSE;
704
705
		}

706
		/** @var Template $template */
707
		$template = $this->templateRepository->findOneByTemplate(
708
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
709
		);
710

711
712
713
714
715
716
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

717
		// get default template content from register array
718
		$registerService = GeneralUtility::makeInstance(RegisterService::class);
719
720
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
721

722
723
		// If there is no template for this language, use the default template
		if ($template === NULL) {
724
			if ($defaultTemplateContent === NULL) {
725
726
				$templatePath =
					$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];
727

728
729
				// only standard template file is considered since version 4.1
				$defaultTemplateFile = $templatePath . 'template.html';
730
731
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
732
				} else {
733
734
735
736
737
738
739
740
					// 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']
					);

741
742
					if (\file_exists($defaultTemplateFile)) {
						$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
743
					} else {
744
						return FALSE;
745
					}
746
				}
747
			}
748
749
		} elseif (\filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
			$this->setToAddresses(\trim($template->getToAddress()));
750
751
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
752
		if ($isPreview) {
753
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
754
755
		}

756
		/** @var StandaloneView $emailView */
757
		$emailView = $this->objectManager->get(StandaloneView::class);
758
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
759
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
760

761
762
763
764
765
766
		$overwrittenEmailBody = $this->getOverwrittenEmailBody();
		$overwrittenSubject = '';
		if ($this->subject !== '' && $this->subject !== NULL) {
			$overwrittenSubject = $this->subject;
		}

767
		// parse markers
Paul Ilea's avatar
Paul Ilea committed
768
		if ($template !== NULL) {
769
770
771
			$subject = $this->parseMarkers(
				trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject),
				$emailView
772
			);
773

774
775
			$layoutId = $template->getLayout();
			$templateContent = $template->getContent();
776
		} else {
777
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
778
779
			if (\is_array($subject)) {
				$subject = \trim(
780
781
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
782
				);
783
			}
784
785
786
787
788
789
790
791
			$subject = $this->parseMarkers(
				(empty($overwrittenSubject) ? $subject : $overwrittenSubject),
				$emailView
			);

			$layoutId = 0;
			$templateContent = $defaultTemplateContent;
		}
792

793
		$this->mailMessage->setSubject($subject);
794

795
796
		if ($this->fromAddress === '') {
			$fromMail = $this->parseMarkers(
797
				$this->getTemplateSource(
798
799
800
801
					(empty($this->overwrittenFromMail) ? $template->getFromMail() : $this->overwrittenFromMail),
					$layoutId, $siteRootId
				),
				$emailView
802
			);
803
804
			$this->setFromAddress($fromMail);
		}
805

806
807
		if ($this->fromName === '') {
			$fromName = $this->parseMarkers(
Paul Ilea's avatar
Paul Ilea committed
808
				$this->getTemplateSource(
809
810
811
812
					(empty($this->overwrittenFromName) ? $template->getFromName() : $this->overwrittenFromName),
					$layoutId, $siteRootId
				),
				$emailView
813
			);
814
			$this->setFromName($fromName);
815
816
		}

817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
		if ($this->replyToAddress === '') {
			$replyTo = $this->parseMarkers(
				$this->getTemplateSource(
					(empty($this->overwrittenReplyTo) ? $template->getReplyTo() : $this->overwrittenReplyTo),
					$layoutId, $siteRootId
				),
				$emailView
			);
			$this->setReplyToAddress($replyTo);
		}

		if (empty($this->ccAddresses)) {
			$cc = $this->parseMarkers(
				$this->getTemplateSource(
					(empty($this->overwrittenCc) ? $template->getCc() : $this->overwrittenCc),
					$layoutId, $siteRootId
				),
				$emailView
			);
			$this->setCcAddresses($cc);
		}

		if (empty($this->bccAddresses)) {
			$bcc = $this->parseMarkers(
				$this->getTemplateSource(
					(empty($this->overwrittenBcc) ? $template->getBcc() : $this->overwrittenBcc),
					$layoutId, $siteRootId
				),
				$emailView
			);
			$this->setBccAddresses($bcc);
		}

		if ($this->toAddresses === '') {
			$toAddress = $this->parseMarkers(
				$this->getTemplateSource(
					(empty($this->overwrittenToAddresses) ? $template->getToAddress() : $this->overwrittenToAddresses),
					$layoutId, $siteRootId
				),
				$emailView
			);
			$this->setToAddresses($toAddress);
		}

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

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

874
875
876
877
878
879
880
881
882
883
884
885
		$mail = $this->addMailToMailQueue(
			$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
			0, 0, $this->language, $siteRootId
		);
		if ($this->ignoreMailQueue) {
			$success = $this->sendMailFromQueue($mail->getUid());
		}

		if ($isPreview) {
			$mailRepository = $this->objectManager->get(MailRepository::class);
			$mailRepository->remove($mail);
			$this->persistenceManager->persistAll();
886
		}
887

888
		return $success;
889
890
	}

Paul Ilea's avatar
Paul Ilea committed
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
	/**
	 * 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;
	}

963
	/**
964
	 * Adds a new mail to the mail queue.
965
	 *
966
967
	 * @param string $extensionKey
	 * @param string $templateName
968
	 * @param string $subject
969
	 * @param string $emailBody
970
	 * @param int $sendingTime
971
	 * @param int $priority
972
	 * @param int $lastSendingTime
973
	 * @param string $language
974
	 * @param int $pid
975
	 * @return Mail
976
977
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
978
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
979
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
980
	 */
981
	private function addMailToMailQueue(
982
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
983
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
984
	): Mail {
985
		$mail = $this->objectManager->get(Mail::class);
986
		$mail->setPid($pid);
987
988
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
989
		$mail->setLanguage($language);
990
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
991

992
		$mail->setFromAddress($this->fromAddress);
993
		$mail->setFromName($this->fromName);
994

995
		$mail->setToAddress($this->toAddresses);
996
		$mail->setMailSubject($subject);
997
		$mail->setMailBody($emailBody);
998
		$mail->setPriority($priority);
999
1000
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
1001
		$mail->setSendingTime($sendingTime);
1002
		$mail->setLastSendingTime($lastSendingTime);
1003
		$mail->setReplyTo($this->replyToAddress);
1004
1005
1006
1007
1008
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
1009

1010
		$mailRepository = $this->objectManager->get(MailRepository::class);
1011
		$mailRepository->add($mail);
1012
		$this->persistenceManager->persistAll();
1013
		return $mail;
1014
	}
1015

1016
1017
1018
1019
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
1020
	 * @return bool|NULL
Paul Ilea's avatar
Paul Ilea committed
1021
1022
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
1023
	 * @throws \Exception
1024
	 */
1025
	public function sendMailFromQueue($uid): bool {
1026
1027
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
1028
		$mailToSend = $mailRepository->findOneByUid($uid);
1029
1030
1031
		if (!$mailToSend || $mailToSend->getBlacklisted()) {
			return FALSE;
		}
1032

1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
		$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());
1045

1046
1047
1048
		if ($mailToSend->getBccAddresses()) {
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
		}
1049

1050
1051
1052
		if ($mailToSend->getCcAddresses()) {
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
		}
1053

1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
		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())
				);
1067
			}
1068
		}
1069
1070
1071
1072
1073
1074
1075
1076
		$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);
1077
			$this->persistenceManager->persistAll();
1078
1079
1080
1081
		} else {
			$this->mailMessage->getFailedRecipients();
		}
		return $success;
1082
1083
	}

1084
	/**
1085
	 * @return string
1086
	 */
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
	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;
	}
1111

1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
	/**
	 * @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;
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
	}

	/**
	 * 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)) {
1178
1179
			$fromMail = $this->fromAddress;
		}
1180
		if (!\filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
1181
			$fromMail = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
1182
			if (!\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
1183
1184
1185
1186
				$fromMail = 'noreply@example.com';
			}
		}

1187
		return $fromMail;
1188
1189
	}

1190
1191
1192
1193
1194
1195
	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
1196
	private function getAllMarker(array $markers): string {
1197
1198
1199
		$allMarker = '';

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

1204
			if (\is_string($value)) {
1205
				$allMarker .= $key . ': ' . $value . PHP_EOL;
1206
			} elseif (\is_array($value)) {
1207
				foreach ($value as $innerKey => $innerValue) {
Torsten Oppermann's avatar
Torsten Oppermann committed
1208
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
1209
				}
1210
			} elseif (\is_bool($value)) {
Torsten Oppermann's avatar
Torsten Oppermann committed
1211
1212
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
1213
			} elseif (\is_object($value)) {
1214
				if (\method_exists($value, '__toString')) {
1215
1216
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
1217
1218
1219
1220
1221
			}
		}

		return $allMarker;
	}
1222
}