MailTemplateService.php 36.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 array
68
	 */
69
	private static $templateObjectCache = [];
70
71
72
73
74
75

	/**
	 * @var array
	 */
	private static $mailObjectCache = [];

76
	/**
77
	 * @var string $toAddresses
78
	 */
79
	private $toAddresses = '';
80
81

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

	/**
87
	 * @var string $ccAddresses
88
	 */
Paul Ilea's avatar
Paul Ilea committed
89
	private $ccAddresses;
90
91

	/**
92
	 * @var string $replyToAddress
93
	 */
94
	private $replyToAddress = '';
95
96

	/**
97
	 * @var string $language
98
	 */
99
	private $language = 'default';
100
101

	/**
102
	 * @var boolean $ignoreMailQueue
103
	 */
104
	private $ignoreMailQueue = FALSE;
105
106
107
108
109
110
111

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

	/**
112
	 * @var string $templateName
113
114
115
	 */
	private $templateName;

116
117
118
119
120
	/**
	 * @var string $subject
	 */
	private $subject;

121
122
123
124
125
	/**
	 * @var string $overwrittenEmailBody
	 */
	private $overwrittenEmailBody = '';

126
	/**
127
	 * @var string $extensionKey
128
129
130
131
	 */
	private $extensionKey;

	/**
132
	 * @var array $markers
133
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
134
	private $markers;
135

136
137
138
139
140
	/**
	 * @var array $markerLabels
	 */
	private $markerLabels;

141
	/**
142
	 * @var string $bccAddresses
143
	 */
Paul Ilea's avatar
Paul Ilea committed
144
	private $bccAddresses;
145

146
147
148
149
150
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

151
152
153
154
155
	/**
	 * @var int
	 */
	private $pid;

156
157
158
159
160
	/**
	 * @var string
	 */
	private $fromName = '';

161
162
163
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
164
165
	protected $templateRepository;

Paul Ilea's avatar
Paul Ilea committed
166
167
168
169
170
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\LayoutRepository
	 */
	protected $layoutRepository;

171
172
173
174
	/**
	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager
	 */
	protected $persistenceManager;
175

176
177
178
179
180
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

181
182
183
184
185
	/**
	 * @var TYPO3\CMS\Core\Resource\ResourceFactory
	 */
	protected $resourceFactory;

186
187
188
189
	/**
	 * @var string
	 */
	private $mailBodyToSend;
190

191
192
193
194
	/**
	 * @var string
	 */
	private $subjectToSend;
195

196
	/**
197
198
199
200
201
202
203
204
205
	 * @var string
	 */
	private $defaultFromAddress;

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

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
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
234
			$this->defaultFromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
235
		} else {
236
237
238
239
240
241
242
			if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
				$this->fromAddress = 'noreply@example.org';
				$this->defaultFromAddress = 'noreply@example.org';
			} else {
				$this->fromAddress = $tsSettings['mail']['default']['from'];
				$this->defaultFromAddress = $tsSettings['mail']['default']['from'];
			}
243
244
		}

245
246
		if ($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$this->fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
247
			$this->defaultFromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
248
249
250
		}

		$this->mailMessage->setFrom($this->fromAddress, $this->fromName);
Torsten Oppermann's avatar
Torsten Oppermann committed
251
252
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
253
254

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

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

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

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

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

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

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

426
427
428
429
430
431
432
433
434
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

435
436
437
438
439
440
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function setMarkers(array $markers): MailTemplateService {
		$this->markers = $markers;
441
		foreach ($markers as $key => $currentMarker) {
442
			if (!\is_array($currentMarker) || !isset($currentMarker['markerLabel'])) {
443
444
445
446
447
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
		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;
	}

	/**
474
475
	 * IMPORTANT: make sure to set $this->>ignoreMailQueue(TRUE), if you're using this method to add an attachment!
	 * Otherwise the attachment is ignored when sending the mail via mail queue.
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
	 * @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;
	}

	/**
491
492
	 * Adds a file resource as attachment
	 *
493
494
	 * @param FileReference $fileReference
	 * @param File $file
495
496
	 *
	 * @return MailTemplateService
497
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
498
	 */
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
	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;
			}
516
517
518
519
		}

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
520
				'uid_local' => $file->getUid(),
521
522
523
524
525
526
527
528
529
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
		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
	 */
581
	public function setSubject(string $subject) {
582
583
584
		$this->subject = $subject;
	}

585
586
587
588
589
590
591
592
593
594
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}

	/**
	 * @param string $overwrittenEmailBody
	 */
595
	public function setOverwrittenEmailBody(string $overwrittenEmailBody) {
596
597
598
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}

599
600
601
602
603
604
605
606
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
607
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail'): array {
608
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
609
		// Need the key for translations
610
		if (\trim($extensionKey) === '') {
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
			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;
	}

628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
	/**
	 * 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);
	}

667
	/**
668
669
	 * Parses markers in an email View.
	 * !!! CHANGES THE SOURCE PATH AND IT SHOULD BE RESET BACK TO THE ORIGINAL!!!
670
	 *
671
672
673
	 * @param string $text
	 * @param StandaloneView $emailView
	 * @return mixed
674
	 */
675
	protected function parseMarkers($text, $emailView) {
676
		$text = (string) $text;
677
678
679
680
		if (strpos($text, '{') !== FALSE) {
			$emailView->setTemplateSource($text);
			return $emailView->render();
		}
681

682
683
684
		return $text;
	}

685
	/**
686
	 * Gets the current PageUid
687
	 *
688
	 * @return int
689
	 */
690
	protected function getPageUid(): int {
691
		if (TYPO3_MODE === 'FE') {
692
693
694
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
695
696
697
698
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

699
		if ($this->pid) {
700
			$pageUid = $this->pid;
701
		}
702

703
		if ($pageUid === 0) {
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
			$pageUid = $this->getAnyRootPageUid();
		}
		return $pageUid;
	}

	/**
	 * Gets the page uid of any root page in the page tree
	 *
	 * @return int
	 */
	private function getAnyRootPageUid() {
		$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(
			'pages'
		);
		$rootPageRows = $queryBuilder->select('*')
			->from('pages')
			->where(
				$queryBuilder->expr()->eq(
					'is_siteroot', 1
723
				)
724
725
726
727
			)
			->andWhere(
				$queryBuilder->expr()->eq(
					'hidden', 0
728
				)
729
730
			)
			->execute()->fetchAll();
731

732
733
		if ($rootPageRows && \count($rootPageRows)) {
			$pageUid = (int) $rootPageRows[0]['uid'];
734
		}
735
736
		return $pageUid;
	}
737

738
739
740
741
742
743
744
745
746
747
748
749
	/**
	 * Get the hash for the object cache
	 *
	 * @param $extensionKey
	 * @param $templateName
	 * @param $siteRootId
	 * @param $languageId
	 * @return string
	 */
	private function getTemplateHash($extensionKey, $templateName, $siteRootId, $languageId) {
		return md5($extensionKey . '_' . $templateName . '_' . $siteRootId . '_' . $languageId);
	}
750

751
752
753
754
755
756
757
	/**
	 * Get the template object
	 *
	 * @param int $siteRootId
	 * @return null|object|Template|FALSE
	 * @throws \Exception
	 */
758
	private function getTemplate($siteRootId) {
759
760
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
761
			throw new \Exception('The template is blacklisted');
762
763
		}

764
765
766
767
768
		$templateHash = $this->getTemplateHash($this->extensionKey, $this->templateName, $siteRootId, $this->language);
		if (isset(self::$templateObjectCache[$templateHash])
			&& self::$templateObjectCache[$templateHash] instanceof Template) {
			return self::$templateObjectCache[$templateHash];
		}
769
		/** @var Template $template */
770
		$template = $this->templateRepository->findOneByTemplate(
771
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
772
		);
773

774
775
776
777
778
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}
779
		self::$templateObjectCache[$templateHash] = $template;
780
781
		return $template;
	}
782

783
784
785
	/**
	 * Get the default content for this template
	 *
786
787
	 * @param Template|null $template
	 * @param RegisterService $registerService
788
	 * @return bool|false|string
789
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
790
791
	 */
	protected function getDefaultTemplateContent($template, $registerService) {
792
793
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
794

795
		// If there is no template for this language, use the default template
796
		if ($template === NULL && $defaultTemplateContent === NULL) {
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
			$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']
				);
812

813
814
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
815
				} else {
816
					return FALSE;
817
				}
818
			}
Torsten Oppermann's avatar
Torsten Oppermann committed
819
		}
820
821
		return $defaultTemplateContent;
	}
Torsten Oppermann's avatar
Torsten Oppermann committed
822

823
	/**
824
825
826
	 * Sets the values to send the mail with from the template or register service
	 *
	 * @param Template|null $template
827
828
829
	 * @param RegisterService $registerService
	 * @param string $defaultTemplateContent
	 * @param int $siteRootId
830
	 * @param boolean $isNewsletter
831
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
832
	 */
833
	protected function parseValuesForMail(
834
		$template, RegisterService $registerService, $defaultTemplateContent,
835
		$siteRootId
836
	): void {
837
		/** @var StandaloneView $emailView */
838
		$emailView = $this->objectManager->get(StandaloneView::class);
839
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
840
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
841

842
		//TODO: make this as the lines below the next block
843
844
845
846
847
848
		$overwrittenEmailBody = $this->getOverwrittenEmailBody();
		$overwrittenSubject = '';
		if ($this->subject !== '' && $this->subject !== NULL) {
			$overwrittenSubject = $this->subject;
		}

849
		// parse markers
Paul Ilea's avatar
Paul Ilea committed
850
		if ($template !== NULL) {
851
852
853
			$subject = $this->parseMarkers(
				trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject),
				$emailView
854
			);
855

856
857
			$layoutId = $template->getLayout();
			$templateContent = $template->getContent();
858
			$this->setSubjectToSend($subject);
859
		} else {
860
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
861
862
			if (\is_array($subject)) {
				$subject = \trim(
863
864
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
865
				);
866
			}
867
868
869
870
			$subject = $this->parseMarkers(
				(empty($overwrittenSubject) ? $subject : $overwrittenSubject),
				$emailView
			);
871

872
873
874
			$layoutId = 0;
			$templateContent = $defaultTemplateContent;
		}
875

876
		$this->setSubjectToSend($subject);
877
		$this->mailMessage->setSubject($subject);
878

879
880
		// Parse the markers
		if ($this->fromName) {
881
			$this->setFromName($this->parseMarkers($this->fromName, $emailView));
882
883
		}

884
		if ($this->fromAddress) {
885
			$this->setFromAddress($this->parseMarkers($this->fromAddress, $emailView));
886
887
		}

888
		if ($this->replyToAddress) {
889
			$this->setReplyToAddress($this->parseMarkers($this->replyToAddress, $emailView));
890
891
		}

892
893
		if ($this->ccAddresses) {
			$this->setCcAddresses($this->parseMarkers($this->ccAddresses, $emailView));
894
895
		}

896
		if ($this->bccAddresses) {
897
			$this->setBccAddresses($this->parseMarkers($this->bccAddresses, $emailView));
898
899
		}

900
		if ($this->toAddresses) {
901
			$this->setToAddresses($this->parseMarkers($this->toAddresses, $emailView));
902
903
904
905
906
907
908
909
910
		}

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

912
913
		// insert <br> tags, but replace every instance of three or more successive breaks with just two.
		$emailBody = $emailView->render();
914
		$emailBody = \nl2br($emailBody);
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
		$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
	 */
939
	public function sendEmail($isPreview = FALSE, $isNewsletter = FALSE): bool {
940
941
942
943
944
945
		if ($isPreview) { //TODO: remove this from here
			$this->setIgnoreMailQueue(TRUE);
		}
		$success = FALSE;

		// Get page ID
946
		// TODO: this doesn't belong here. The API user needs to provide the UID
947
		$siteRootId = $this->getSiteRootId();
948
949
950
951
		try {
			$template = $this->getTemplate($siteRootId);
		} catch (\Exception $e) {
			return FALSE;
952
		}
953

954
955
		$registerService = GeneralUtility::makeInstance(RegisterService::class);

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

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

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

970
		$this->parseValuesForMail($template, $registerService, $defaultTemplateContent, $siteRootId);
971

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

982
		//TODO: this can be avoided if the sending logic is decoupled from this function
983
984
985
986
		if ($isPreview) {
			$mailRepository = $this->objectManager->get(MailRepository::class);
			$mailRepository->remove($mail);
			$this->persistenceManager->persistAll();
987
		}
988

989
		return $success;
990
991
	}

Paul Ilea's avatar
Paul Ilea committed
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
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
	/**
	 * 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;
	}

1064
	/**
1065
	 * Adds a new mail to the mail queue.
1066
	 *
1067
1068
	 * @param string $extensionKey
	 * @param string $templateName
1069
	 * @param string $subject
1070
	 * @param string $emailBody
1071
	 * @param int $sendingTime
1072
	 * @param int $priority
1073
	 * @param int $lastSendingTime
1074
	 * @param string $language
1075
	 * @param int $pid
1076
	 * @return Mail
1077
1078
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
1079
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
1080
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
1081
	 */
1082
	private function addMailToMailQueue(
1083
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
1084
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
1085
	): Mail {
1086
		$mail = $this->objectManager->get(Mail::class);
1087
		$mail->setPid($pid);
1088
1089
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
1090
		$mail->setLanguage($language);
1091
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
1092

1093
		$mail->setFromAddress($this->fromAddress);
1094
		$mail->setFromName($this->fromName);
1095

1096
		$mail->setToAddress($this->toAddresses);
1097
		$mail->setMailSubject($subject);
1098
		$mail->setMailBody($emailBody);
1099
		$mail->setPriority($priority);
1100
1101
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
1102
		$mail->setSendingTime($sendingTime);
1103
		$mail->setLastSendingTime($lastSendingTime);
1104
		$mail->setReplyTo($this->replyToAddress);
1105
1106
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
				// we need to create proper copies of the attachment so that the original file reference does not get
				// moved over to the mail model and worst case, the original model loses the reference because of this
				$originalResource = $marker->getOriginalResource();
				if ($originalResource instanceof \TYPO3\CMS\Core\Resource\FileReference) {
					$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
						[
							'uid_local' => $originalResource->getOriginalFile()->getUid(),
							'table_local' => 'sys_file',
							'uid' => uniqid('NEW_MAIL', TRUE)
						]
					);
					$newFileReference = GeneralUtility::makeInstance(FileReference::class);
					$newFileReference->setOriginalResource($coreFileReferenceMailFile);
					$mail->addAttachment($newFileReference);
				}
1122
1123
			}
		}
1124

1125
		$mailRepository = $this->objectManager->get(MailRepository::class);
1126
		$mailRepository->add($mail);
1127
		$this->persistenceManager->persistAll();
1128
		return $mail;
1129
	}
1130

1131
1132
	/**
	 * Get the mail object by uid and check if it's blacklisted
1133
1134
1135
	 *
	 * @param int $uid
	 * @return bool|object
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
	 */
	private function getMailObjectByUid($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		$mailObject = $mailRepository->findOneByUid($uid);
		if (!$mailObject || $mailObject->getBlacklisted()) {
			return FALSE;
		}
		return $mailObject;
	}

1146
1147
1148
1149
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
1150
	 * @return bool|NULL
1151
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
Paul Ilea's avatar
Paul Ilea committed
1152
1153
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
1154
	 */
1155
	public function sendMailFromQueue($uid): bool {
1156
1157
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
1158
1159
1160
		if (!isset(self::$mailObjectCache[$uid]) || !self::$mailObjectCache[$uid] instanceof Mail) {
			$mailToSend = $this->getMailObjectByUid($uid);
			if ($mailToSend === FALSE) {
1161
1162
				return FALSE;
			}
1163
1164
		} else {
			$mailToSend = self::$mailObjectCache[$uid];
1165
		}
1166

1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
		$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());
1179

1180
1181
1182
		if ($mailToSend->getBccAddresses()) {
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
		}
1183

1184
1185
1186
		if ($mailToSend->getCcAddresses()) {
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
		}
1187

1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
		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())
				);
1201
			}
Torsten Oppermann's avatar