MailTemplateService.php 29.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
	 * @var string $extensionKey
118
119
120
121
	 */
	private $extensionKey;

	/**
122
	 * @var array $markers
123
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
124
	private $markers;
125

126
127
128
129
130
	/**
	 * @var array $markerLabels
	 */
	private $markerLabels;

131
	/**
132
	 * @var string $bccAddresses
133
	 */
Paul Ilea's avatar
Paul Ilea committed
134
	private $bccAddresses;
135

136
137
138
139
140
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

141
142
143
144
145
	/**
	 * @var int
	 */
	private $pid;

146
147
148
149
150
	/**
	 * @var string
	 */
	private $fromName = '';

151
152
153
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
154
155
	protected $templateRepository;

Paul Ilea's avatar
Paul Ilea committed
156
157
158
159
160
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\LayoutRepository
	 */
	protected $layoutRepository;

161
162
163
164
	/**
	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager
	 */
	protected $persistenceManager;
165

166
167
168
169
170
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

171
172
173
174
175
	/**
	 * @var TYPO3\CMS\Core\Resource\ResourceFactory
	 */
	protected $resourceFactory;

176
177
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
178
	 *
179
180
	 * @param string $templateName
	 * @param string $extensionKey
181
	 * @param array $markers
182
	 * @param array $markerLabels
Paul Ilea's avatar
Paul Ilea committed
183
	 * @throws \InvalidArgumentException
184
	 */
185
	public function __construct($templateName = '', $extensionKey = '', $markers = [], $markerLabels = []) {
186
187
188
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;
189
		$this->markerLabels = $markerLabels;
190

191
192
193
194
		/** @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
195
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
196
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
Paul Ilea's avatar
Paul Ilea committed
197
		$this->layoutRepository = $this->objectManager->get(LayoutRepository::class);
198
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
199
		$this->resourceFactory = $this->objectManager->get(ResourceFactory::class);
200

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

207
			if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
208
209
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
210
				$this->fromAddress = $tsSettings['mail']['default']['from'];
211
			}
212
213
		}

214
215
216
217
218
		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
219
220
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
221
222

		foreach ($this->bccAddresses as $index => $email) {
223
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
224
225
226
227
228
229
230
231
232
233
				unset($this->bccAddresses[$index]);
			}
		}

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

234
		if (\count($this->bccAddresses) > 0) {
235
236
237
			$this->mailMessage->setBcc($this->bccAddresses);
		}

238
		if (\count($this->ccAddresses) > 0) {
239
240
			$this->mailMessage->setCc($this->ccAddresses);
		}
241
242
	}

243
244
245
	/**
	 * @param string $fromName
	 */
246
	public function setFromName($fromName) {
247
248
249
250
251
252
253
254
		$this->fromName = $fromName;
	}

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
255
	public static function getReadableMarkerType($markerType) {
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
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
		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;
	}

366
367
368
369
370
371
372
373
374
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

375
376
377
378
379
380
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function setMarkers(array $markers): MailTemplateService {
		$this->markers = $markers;
381
		foreach ($markers as $key => $currentMarker) {
382
			if (!\is_array($currentMarker) || !isset($currentMarker['markerLabel'])) {
383
384
385
386
387
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
		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;
	}

	/**
429
430
	 * Adds a file resource as attachment
	 *
431
432
	 * @param FileReference $fileReference
	 * @param File $file
433
434
	 *
	 * @return MailTemplateService
435
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
436
	 */
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
	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;
			}
454
455
456
457
		}

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
458
				'uid_local' => $file->getUid(),
459
460
461
462
463
464
465
466
467
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
		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
	 */
519
	public function setSubject(string $subject) {
520
521
522
		$this->subject = $subject;
	}

523
524
525
526
527
528
529
530
531
532
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}

	/**
	 * @param string $overwrittenEmailBody
	 */
533
	public function setOverwrittenEmailBody(string $overwrittenEmailBody) {
534
535
536
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}

537
538
539
540
541
542
543
544
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
545
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail'): array {
546
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
547
		// Need the key for translations
548
		if (\trim($extensionKey) === '') {
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
			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;
	}

566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
	/**
	 * 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);
	}

605
	/**
606
	 * Send the Email
607
	 *
608
609
	 * @param bool $isPreview
	 * @return bool email was sent or added to mail queue successfully?
610
611
612
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
613
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
614
	 * @throws \Exception
615
	 */
616
	public function sendEmail($isPreview = FALSE): bool {
617
		$success = FALSE;
618
		if (TYPO3_MODE === 'FE') {
619
620
621
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
622
623
624
625
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

626
		if ($this->pid) {
627
			$pageUid = $this->pid;
628
		}
629

630
		if ($pageUid === 0) {
631
632
			$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(
				'pages'
633
			);
634
			$rootPageRows = $queryBuilder->select('*')
635
				->from('pages')
636
637
638
639
640
641
642
643
644
645
646
647
				->where(
					$queryBuilder->expr()->eq(
						'is_siteroot', 1
					)
				)
				->andWhere(
					$queryBuilder->expr()->eq(
						'hidden', 0
					)
				)
				->execute()->fetchAll();

648
649
650
			if ($rootPageRows && \count($rootPageRows)) {
				$pageUid = (int) $rootPageRows[0]['uid'];
			}
651
		}
652
		$siteRootId = BackendService::getSiteRoot($pageUid);
653

654
655
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
656
657
			// @TODO throw error or log ?
			return FALSE;
658
659
		}

660
		/** @var Template $template */
661
		$template = $this->templateRepository->findOneByTemplate(
662
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
663
		);
664

665
666
667
668
669
670
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

671
672
673
674
675
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

676
		// get default template content from register array
677
		$registerService = GeneralUtility::makeInstance(RegisterService::class);
678
679
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
680

681
682
		// If there is no template for this language, use the default template
		if ($template === NULL) {
683
			if ($defaultTemplateContent === NULL) {
684
685
				$templatePath =
					$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];
686

687
688
				// only standard template file is considered since version 4.1
				$defaultTemplateFile = $templatePath . 'template.html';
689
690
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
691
				} else {
692
693
694
695
696
697
698
699
					// 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']
					);

700
701
					if (\file_exists($defaultTemplateFile)) {
						$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
702
					} else {
703
						return FALSE;
704
					}
705
				}
706
			}
707
708
		} elseif (\filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
			$this->setToAddresses(\trim($template->getToAddress()));
709
710
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
711
		if ($isPreview) {
712

713
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
714
715
		}

716
		/** @var StandaloneView $emailView */
717
		$emailView = $this->objectManager->get(StandaloneView::class);
718
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
719
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
720

721
722
723
724
725
726
		$overwrittenEmailBody = $this->getOverwrittenEmailBody();
		$overwrittenSubject = '';
		if ($this->subject !== '' && $this->subject !== NULL) {
			$overwrittenSubject = $this->subject;
		}

Paul Ilea's avatar
Paul Ilea committed
727
		if ($template !== NULL) {
728
729
730
			$emailView->setTemplateSource(
				\trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject)
			);
731
732
			$subject = $emailView->render();

733
			$emailView->setTemplateSource(
Paul Ilea's avatar
Paul Ilea committed
734
735
736
737
				$this->getTemplateSource(
					empty($overwrittenEmailBody) ? $template->getContent() : $overwrittenEmailBody,
					$template->getLayout(), $siteRootId
				)
738
			);
739
		} else {
740
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
741
742
			if (\is_array($subject)) {
				$subject = \trim(
743
744
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
745
				);
746
			}
747

748
749
750
751
			$emailView->setTemplateSource(empty($overwrittenSubject) ? $subject : $overwrittenSubject);
			$subject = $emailView->render();

			$emailView->setTemplateSource(
Paul Ilea's avatar
Paul Ilea committed
752
753
754
755
				$this->getTemplateSource(
					empty($overwrittenEmailBody) ? $defaultTemplateContent : $overwrittenEmailBody,
					0, $siteRootId
				)
756
			);
757
758
		}

759
		$this->mailMessage->setSubject($subject);
760

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

766
767
768
769
770
771
772
773
774
775
776
777
		$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();
778
		}
779

780
		return $success;
781
782
	}

Paul Ilea's avatar
Paul Ilea committed
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
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
	/**
	 * 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;
	}

855
	/**
856
	 * Adds a new mail to the mail queue.
857
	 *
858
859
	 * @param string $extensionKey
	 * @param string $templateName
860
	 * @param string $subject
861
	 * @param string $emailBody
862
	 * @param int $sendingTime
863
	 * @param int $priority
864
	 * @param int $lastSendingTime
865
	 * @param string $language
866
	 * @param int $pid
867
	 * @return Mail
868
869
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
870
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
871
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
872
	 */
873
	private function addMailToMailQueue(
874
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
875
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
876
	): Mail {
877
		$mail = $this->objectManager->get(Mail::class);
878
		$mail->setPid($pid);
879
880
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
881
		$mail->setLanguage($language);
882
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
883

884
		$mail->setFromAddress($this->fromAddress);
885
		$mail->setFromName($this->fromName);
886

887
		$mail->setToAddress($this->toAddresses);
888
		$mail->setMailSubject($subject);
889
		$mail->setMailBody($emailBody);
890
		$mail->setPriority($priority);
891
892
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
893
		$mail->setSendingTime($sendingTime);
894
		$mail->setLastSendingTime($lastSendingTime);
895
		$mail->setReplyTo($this->replyToAddress);
896
897
898
899
900
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
901

902
		$mailRepository = $this->objectManager->get(MailRepository::class);
903
		$mailRepository->add($mail);
904
		$this->persistenceManager->persistAll();
905
		return $mail;
906
	}
907

908
909
910
911
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
912
	 * @return bool|NULL
Paul Ilea's avatar
Paul Ilea committed
913
914
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
915
	 * @throws \Exception
916
	 */
917
	public function sendMailFromQueue($uid): bool {
918
919
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
920
		$mailToSend = $mailRepository->findOneByUid($uid);
921
922
923
		if (!$mailToSend || $mailToSend->getBlacklisted()) {
			return FALSE;
		}
924

925
926
927
928
929
930
931
932
933
934
935
936
		$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());
937

938
939
940
		if ($mailToSend->getBccAddresses()) {
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
		}
941

942
943
944
		if ($mailToSend->getCcAddresses()) {
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
		}
945

946
947
948
949
950
951
952
953
954
955
956
957
958
		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())
				);
959
			}
960
		}
961
962
963
964
965
966
967
968
969
970
971
972
		$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);
		} else {
			$this->mailMessage->getFailedRecipients();
		}
		return $success;
973
974
	}

975
976
977
978
979
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
980
	private function loadTemplateValues($template) {
981
		$fromName = \trim($template->getFromName());
982
983
984
		if ($fromName === '') {
			$fromName = $this->fromName;
		}
985
986
987
988
		if ($fromName === '' && $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

989
990
991
992
993
994
995
996
997
998
999
1000
		$fromMail = $this->getValidFromMail(\trim($template->getFromMail()));
		$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
	 *