MailTemplateService.php 35.8 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
	/**
	 * @var TYPO3\CMS\Core\Resource\ResourceFactory
	 */
	protected $resourceFactory;
205
206
207
208
209
210
211
212
	/**
	 * @var string
	 */
	private $mailBodyToSend;
	/**
	 * @var string
	 */
	private $subjectToSend;
213

214
215
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
216
	 *
217
218
	 * @param string $templateName
	 * @param string $extensionKey
219
	 * @param array $markers
220
	 * @param array $markerLabels
Paul Ilea's avatar
Paul Ilea committed
221
	 * @throws \InvalidArgumentException
222
	 */
223
	public function __construct($templateName = '', $extensionKey = '', $markers = [], $markerLabels = []) {
224
225
226
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;
227
		$this->markerLabels = $markerLabels;
228

229
230
231
232
		/** @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
233
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
234
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
Paul Ilea's avatar
Paul Ilea committed
235
		$this->layoutRepository = $this->objectManager->get(LayoutRepository::class);
236
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
237
		$this->resourceFactory = $this->objectManager->get(ResourceFactory::class);
238

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

245
			if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
246
247
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
248
				$this->fromAddress = $tsSettings['mail']['default']['from'];
249
			}
250
251
		}

252
253
254
255
256
		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
257
258
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
259
260

		foreach ($this->bccAddresses as $index => $email) {
261
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
262
263
264
265
266
267
268
269
270
271
				unset($this->bccAddresses[$index]);
			}
		}

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

272
		if (\count($this->bccAddresses) > 0) {
273
274
275
			$this->mailMessage->setBcc($this->bccAddresses);
		}

276
		if (\count($this->ccAddresses) > 0) {
277
278
			$this->mailMessage->setCc($this->ccAddresses);
		}
279
280
	}

281
282
283
	/**
	 * @param string $fromName
	 */
284
	public function setFromName($fromName) {
285
286
287
288
289
290
291
292
		$this->fromName = $fromName;
	}

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
293
	public static function getReadableMarkerType($markerType) {
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
396
397
398
399
400
401
402
403
		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;
	}

404
405
406
407
408
409
410
411
412
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

413
414
415
416
417
418
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function setMarkers(array $markers): MailTemplateService {
		$this->markers = $markers;
419
		foreach ($markers as $key => $currentMarker) {
420
			if (!\is_array($currentMarker) || !isset($currentMarker['markerLabel'])) {
421
422
423
424
425
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

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

	/**
467
468
	 * Adds a file resource as attachment
	 *
469
470
	 * @param FileReference $fileReference
	 * @param File $file
471
472
	 *
	 * @return MailTemplateService
473
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
474
	 */
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
	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;
			}
492
493
494
495
		}

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
496
				'uid_local' => $file->getUid(),
497
498
499
500
501
502
503
504
505
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
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
549
550
551
552
553
554
555
556
		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
	 */
557
	public function setSubject(string $subject) {
558
559
560
		$this->subject = $subject;
	}

561
562
563
564
565
566
567
568
569
570
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}

	/**
	 * @param string $overwrittenEmailBody
	 */
571
	public function setOverwrittenEmailBody(string $overwrittenEmailBody) {
572
573
574
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}

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

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
635
636
637
638
639
640
641
642
	/**
	 * 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);
	}

643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
	/**
	 * 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;
	}

659
	/**
660
	 * Gets the current PageUid
661
	 *
662
	 * @return int
663
	 */
664
	protected function getPageUid(): int {
665
		if (TYPO3_MODE === 'FE') {
666
667
668
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
669
670
671
672
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

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

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

696
697
698
			if ($rootPageRows && \count($rootPageRows)) {
				$pageUid = (int) $rootPageRows[0]['uid'];
			}
699
		}
700
701
		return $pageUid;
	}
702

703
704
705
706
707
708
709
710
	/**
	 * Get the template object
	 *
	 * @param int $siteRootId
	 * @return null|object|Template|FALSE
	 * @throws \Exception
	 */
	public function getTemplate(int $siteRootId) {
711
712
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
713
			throw new \Exception('The template is blacklisted');
714
		}
715
		/** @var Template $template */
716
		$template = $this->templateRepository->findOneByTemplate(
717
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
718
		);
719

720
721
722
723
724
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}
725
726
		return $template;
	}
727

728
729
730
731
732
733
734
735
	/**
	 * Get the default content for this template
	 *
	 * @param $template
	 * @param $registerService
	 * @return bool|false|string
	 */
	protected function getDefaultTemplateContent($template, $registerService) {
736
737
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
738

739
		// If there is no template for this language, use the default template
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
		if (($template === NULL) && $defaultTemplateContent === NULL) {
			$templatePath =
				$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];

			// only standard template file is considered since version 4.1
			$defaultTemplateFile = $templatePath . 'template.html';
			if (\file_exists($defaultTemplateFile)) {
				$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
			} else {
				// use configured default html template
				/** @var TypoScriptSettingsService $typoScriptSettingsService */
				$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
				$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
				$defaultTemplateFile = GeneralUtility::getFileAbsFileName(
					$tsSettings['mail']['defaultHtmlTemplate']
				);
756

757
758
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
759
				} else {
760
					return FALSE;
761
				}
762
			}
Torsten Oppermann's avatar
Torsten Oppermann committed
763
		}
764
765
		return $defaultTemplateContent;
	}
Torsten Oppermann's avatar
Torsten Oppermann committed
766

767
768
769
770
771
772
773
	/**
	 * @param $template
	 * @param $registerService
	 * @param $defaultTemplateContent
	 * @param $siteRootId
	 */
	protected function setMailValuesFromObjects($template, $registerService, $defaultTemplateContent, $siteRootId): void {
774
		/** @var StandaloneView $emailView */
775
		$emailView = $this->objectManager->get(StandaloneView::class);
776
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
777
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
778

779
780
781
782
783
784
		$overwrittenEmailBody = $this->getOverwrittenEmailBody();
		$overwrittenSubject = '';
		if ($this->subject !== '' && $this->subject !== NULL) {
			$overwrittenSubject = $this->subject;
		}

785
		// parse markers
Paul Ilea's avatar
Paul Ilea committed
786
		if ($template !== NULL) {
787
788
789
			$subject = $this->parseMarkers(
				trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject),
				$emailView
790
			);
791

792
793
			$layoutId = $template->getLayout();
			$templateContent = $template->getContent();
794
			$this->setSubjectToSend($subject);
795
		} else {
796
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
797
798
			if (\is_array($subject)) {
				$subject = \trim(
799
800
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
801
				);
802
			}
803
804
805
806
807
808
809
810
			$subject = $this->parseMarkers(
				(empty($overwrittenSubject) ? $subject : $overwrittenSubject),
				$emailView
			);

			$layoutId = 0;
			$templateContent = $defaultTemplateContent;
		}
811
812
		$this->setSubjectToSend($subject);
		//TODO: is this object even in use somewhere?
813
		$this->mailMessage->setSubject($subject);
814

815
816
		if ($this->fromAddress === '') {
			$fromMail = $this->parseMarkers(
817
				$this->getTemplateSource(
818
819
820
821
					(empty($this->overwrittenFromMail) ? $template->getFromMail() : $this->overwrittenFromMail),
					$layoutId, $siteRootId
				),
				$emailView
822
			);
823
824
			$this->setFromAddress($fromMail);
		}
825

826
827
		if ($this->fromName === '') {
			$fromName = $this->parseMarkers(
Paul Ilea's avatar
Paul Ilea committed
828
				$this->getTemplateSource(
829
830
831
832
					(empty($this->overwrittenFromName) ? $template->getFromName() : $this->overwrittenFromName),
					$layoutId, $siteRootId
				),
				$emailView
833
			);
834
			$this->setFromName($fromName);
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
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
		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
			)
		);
888

889
890
		// insert <br> tags, but replace every instance of three or more successive breaks with just two.
		$emailBody = $emailView->render();
891
		$emailBody = \nl2br($emailBody);
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
		$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
	 */
	public function sendEmail($isPreview = FALSE, Template $template = NULL): bool {
		if ($isPreview) { //TODO: remove this from here
			$this->setIgnoreMailQueue(TRUE);
		}
		$success = FALSE;

		// Get page ID
		$siteRootId = $this->getSiteRootId();
		if ($template === NULL) {
			// Get template
			try {
				$template = $this->getTemplate($siteRootId);
			} catch (\Exception $e) {
				return FALSE;
			}
		}
		$registerService = GeneralUtility::makeInstance(RegisterService::class);

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

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

		$this->setMailValuesFromObjects($template, $registerService, $defaultTemplateContent, $siteRootId);
944

945
		$mail = $this->addMailToMailQueue(
946
			$this->extensionKey, $this->templateName, $this->getSubjectToSend(), $this->getMailBodyToSend(), $this->priority,
947
948
949
			0, 0, $this->language, $siteRootId
		);
		if ($this->ignoreMailQueue) {
950
			$success = $this->sendMailFromQueue($mail->getUid(), $mail);
951
952
		}

953
		//TODO: this can be avoided if the sending logic is decoupled from this function
954
955
956
957
		if ($isPreview) {
			$mailRepository = $this->objectManager->get(MailRepository::class);
			$mailRepository->remove($mail);
			$this->persistenceManager->persistAll();
958
		}
959

960
		return $success;
961
962
	}

Paul Ilea's avatar
Paul Ilea committed
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
	/**
	 * 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;
	}

1035
	/**
1036
	 * Adds a new mail to the mail queue.
1037
	 *
1038
1039
	 * @param string $extensionKey
	 * @param string $templateName
1040
	 * @param string $subject
1041
	 * @param string $emailBody
1042
	 * @param int $sendingTime
1043
	 * @param int $priority
1044
	 * @param int $lastSendingTime
1045
	 * @param string $language
1046
	 * @param int $pid
1047
	 * @return Mail
1048
1049
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
1050
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
1051
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
1052
	 */
1053
	private function addMailToMailQueue(
1054
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
1055
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
1056
	): Mail {
1057
		$mail = $this->objectManager->get(Mail::class);
1058
		$mail->setPid($pid);
1059
1060
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
1061
		$mail->setLanguage($language);
1062
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
1063

1064
		$mail->setFromAddress($this->fromAddress);
1065
		$mail->setFromName($this->fromName);
1066

1067
		$mail->setToAddress($this->toAddresses);
1068
		$mail->setMailSubject($subject);
1069
		$mail->setMailBody($emailBody);
1070
		$mail->setPriority($priority);
1071
1072
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
1073
		$mail->setSendingTime($sendingTime);
1074
		$mail->setLastSendingTime($lastSendingTime);
1075
		$mail->setReplyTo($this->replyToAddress);
1076
1077
1078
1079
1080
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
1081

1082
		$mailRepository = $this->objectManager->get(MailRepository::class);
1083
		$mailRepository->add($mail);
1084
		$this->persistenceManager->persistAll();
1085
		return $mail;
1086
	}
1087

1088
1089
1090
1091
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
1092
	 * @param null $mailToSend
1093
	 * @return bool|NULL
1094
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
Paul Ilea's avatar
Paul Ilea committed
1095
1096
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
1097
	 */
1098
	public function sendMailFromQueue($uid, $mailToSend = NULL): bool {
1099
1100
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
1101
1102
1103
1104
1105
		if ($mailToSend === NULL) {
			$mailToSend = $mailRepository->findOneByUid($uid);
			if (!$mailToSend || $mailToSend->getBlacklisted()) {
				return FALSE;
			}
1106
		}
1107

1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
		$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());
1120

1121
1122
1123
		if ($mailToSend->getBccAddresses()) {
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
		}
1124

1125
1126
1127
		if ($mailToSend->getCcAddresses()) {
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
		}
1128

1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
		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())
				);
1142
			}
1143
		}
1144
1145
1146
1147
1148
1149
1150
1151
		$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);
1152
			$this->persistenceManager->persistAll();
1153
1154
1155
1156
		} else {
			$this->mailMessage->getFailedRecipients();
		}
		return $success;
1157
1158
	}

1159
	/**
1160
	 * @return string
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
	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;
	}
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
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
	/**
	 * @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;
1241
1242
	}

1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
	/**
	 * @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;
	}

1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
	/**
	 * 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)) {
1281
1282
			$fromMail = $this->fromAddress;
		}
1283
		if (!\filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
1284
			$fromMail = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
1285
			if (!\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
1286
1287
1288
1289
				$fromMail = 'noreply@example.com';
			}
		}

1290
		return $fromMail;
1291
1292
	}

1293
1294
1295
1296
1297
1298
	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
1299
	private function getAllMarker(array $markers): string {
1300
1301
1302
		$allMarker = '';

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

1307
			if (\is_string($value)) {
1308
				$allMarker .= $key . ': ' . $value . PHP_EOL;
1309
			} elseif (\is_array($value)) {
1310
				foreach ($value as $innerKey => $innerValue) {
Torsten Oppermann's avatar
Torsten Oppermann committed
1311
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
1312
				}
1313
			} elseif (\is_bool($value)) {
Torsten Oppermann's avatar
Torsten Oppermann committed
1314
1315
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
1316
			} elseif (\is_object($value)) {
1317
				if (\method_exists($value, '__toString')) {
1318
1319
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
1320
1321
1322
1323
1324
			}
		}

		return $allMarker;
	}
1325
}