MailTemplateService.php 36.5 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
use SGalinski\SgMail\Domain\Model\Layout;
31
32
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
Paul Ilea's avatar
Paul Ilea committed
33
use SGalinski\SgMail\Domain\Repository\LayoutRepository;
34
use SGalinski\SgMail\Domain\Repository\MailRepository;
35
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
36
37
use Swift_Attachment;
use Swift_OutputByteStream;
38
use TYPO3\CMS\Core\Database\ConnectionPool;
39
use TYPO3\CMS\Core\Mail\MailMessage;
40
use TYPO3\CMS\Core\Resource\File;
41
use TYPO3\CMS\Core\Resource\ResourceFactory;
Paul Ilea's avatar
Paul Ilea committed
42
use TYPO3\CMS\Core\Routing\SiteMatcher;
43
use TYPO3\CMS\Core\Utility\GeneralUtility;
Paul Ilea's avatar
Paul Ilea committed
44
use TYPO3\CMS\Core\Utility\VersionNumberUtility;
45
use TYPO3\CMS\Extbase\Domain\Model\FileReference;
46
use TYPO3\CMS\Extbase\Object\ObjectManager;
47
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
48
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
49
use TYPO3\CMS\Fluid\View\StandaloneView;
50
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
51

52
53
54
/**
 * MailTemplateService
 */
55
class MailTemplateService {
56
57
58
59
60
61
62
63
64
65
	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';
66

67
	/**
68
	 * @var array
69
	 */
70
	private static $templateObjectCache = [];
71
72
73
74
75

	/**
	 * @var array
	 */
	private static $mailObjectCache = [];
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
	protected $templateRepository;
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\LayoutRepository
	 */
	protected $layoutRepository;
	/**
	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager
	 */
	protected $persistenceManager;
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;
	/**
	 * @var TYPO3\CMS\Core\Resource\ResourceFactory
	 */
	protected $resourceFactory;
96
	/**
97
	 * @var string $toAddresses
98
	 */
99
	private $toAddresses = '';
100
	/**
101
	 * @var string $fromAddress
102
	 */
103
	private $fromAddress = '';
104
	/**
105
	 * @var string $ccAddresses
106
	 */
Paul Ilea's avatar
Paul Ilea committed
107
	private $ccAddresses;
108
	/**
109
	 * @var string $replyToAddress
110
	 */
111
	private $replyToAddress = '';
112
	/**
113
	 * @var string $language
114
	 */
115
	private $language = 'default';
116
	/**
117
	 * @var boolean $ignoreMailQueue
118
	 */
119
	private $ignoreMailQueue = FALSE;
120
121
122
123
124
	/**
	 * @var \TYPO3\CMS\Core\Mail\MailMessage $mailMessage
	 */
	private $mailMessage;
	/**
125
	 * @var string $templateName
126
127
	 */
	private $templateName;
128
129
130
131
	/**
	 * @var string $subject
	 */
	private $subject;
132
133
134
135
	/**
	 * @var string $overwrittenEmailBody
	 */
	private $overwrittenEmailBody = '';
136
	/**
137
	 * @var string $extensionKey
138
139
140
	 */
	private $extensionKey;
	/**
141
	 * @var array $markers
142
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
143
	private $markers;
144
145
146
147
	/**
	 * @var array $markerLabels
	 */
	private $markerLabels;
148
	/**
149
	 * @var string $bccAddresses
150
	 */
Paul Ilea's avatar
Paul Ilea committed
151
	private $bccAddresses;
152
153
154
155
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;
156
157
158
159
	/**
	 * @var int
	 */
	private $pid;
160
161
162
163
	/**
	 * @var string
	 */
	private $fromName = '';
164
165
166
167
	/**
	 * @var string
	 */
	private $mailBodyToSend;
168

169
170
171
172
	/**
	 * @var string
	 */
	private $subjectToSend;
173

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

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

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

199
200
201
202
		/** @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
203
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
204
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
Paul Ilea's avatar
Paul Ilea committed
205
		$this->layoutRepository = $this->objectManager->get(LayoutRepository::class);
206
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
207
		$this->resourceFactory = $this->objectManager->get(ResourceFactory::class);
208

209
		// use defaultMailFromAddress if it is provided in LocalConfiguration.php; use the sg_mail TS setting as fallback
210
		if (\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
211
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
212
			$this->defaultFromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
213
		} else {
214
215
216
217
218
219
220
			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'];
			}
221
222
		}

223
224
		if ($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$this->fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
225
			$this->defaultFromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
226
227
228
		}

		$this->mailMessage->setFrom($this->fromAddress, $this->fromName);
Torsten Oppermann's avatar
Torsten Oppermann committed
229
230
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
231
232

		foreach ($this->bccAddresses as $index => $email) {
233
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
234
235
236
237
238
239
240
241
242
243
				unset($this->bccAddresses[$index]);
			}
		}

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

244
		if (\count($this->bccAddresses) > 0) {
245
246
247
			$this->mailMessage->setBcc($this->bccAddresses);
		}

248
		if (\count($this->ccAddresses) > 0) {
249
250
			$this->mailMessage->setCc($this->ccAddresses);
		}
251
252
	}

253
254
255
256
257
	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
258
	public static function getReadableMarkerType($markerType) {
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
		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');
		}
	}

	/**
278
279
280
281
282
283
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
284
	 */
285
286
287
288
289
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail'): array {
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
		// Need the key for translations
		if (\trim($extensionKey) === '') {
			return [];
290
291
		}

292
293
294
295
296
297
298
299
300
		$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
			];
301
302
		}

303
		return $generatedMarker;
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
	}

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

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

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

333
334
335
336
337
338
339
340
341
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function addMarkers(array $markers): MailTemplateService {
		$this->setMarkers(\array_merge($this->markers, $markers));
		return $this;
	}

342
343
344
345
346
347
	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function setMarkers(array $markers): MailTemplateService {
		$this->markers = $markers;
348
		foreach ($markers as $key => $currentMarker) {
349
			if (!\is_array($currentMarker) || !isset($currentMarker['markerLabel'])) {
350
351
352
353
354
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

355
356
357
358
359
360
361
362
363
364
365
366
367
		return $this;
	}

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

	/**
368
369
	 * 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.
370
	 *
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
	 * @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;
	}

	/**
386
387
	 * Adds a file resource as attachment
	 *
388
389
	 * @param FileReference $fileReference
	 * @param File $file
390
391
	 *
	 * @return MailTemplateService
392
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
393
	 */
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
	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;
			}
411
412
413
414
		}

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
415
				'uid_local' => $file->getUid(),
416
417
418
419
420
421
422
423
424
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
		return $this;
	}

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

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

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

	/**
	 * @param string $subject
	 */
456
	public function setSubject(string $subject) {
457
458
459
		$this->subject = $subject;
	}

460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
	/**
	 * 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);
	}

499
	/**
500
	 * Send the Email
501
	 *
502
503
504
505
506
507
508
	 * @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
509
	 */
510
511
512
	public function sendEmail($isPreview = FALSE, $isNewsletter = FALSE): bool {
		if ($isPreview) { //TODO: remove this from here
			$this->setIgnoreMailQueue(TRUE);
513
		}
514
		$success = FALSE;
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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
		// Get page ID
		// TODO: this doesn't belong here. The API user needs to provide the UID
		$siteRootId = $this->getSiteRootId();
		try {
			$template = $this->getTemplate($siteRootId);
		} catch (\Exception $e) {
			return FALSE;
		}

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

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

		// 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->parseValuesForMail($template, $registerService, $defaultTemplateContent, $siteRootId);

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

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

		return $success;
	}

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

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

582
	/**
583
	 * Gets the current PageUid
584
	 *
585
	 * @return int
586
	 */
587
	protected function getPageUid(): int {
588
		if (TYPO3_MODE === 'FE') {
589
590
591
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
592
593
594
595
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

596
		if ($this->pid) {
597
			$pageUid = $this->pid;
598
		}
599

600
		if ($pageUid === 0) {
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
			$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
620
				)
621
622
623
624
			)
			->andWhere(
				$queryBuilder->expr()->eq(
					'hidden', 0
625
				)
626
627
			)
			->execute()->fetchAll();
628

629
630
		if ($rootPageRows && \count($rootPageRows)) {
			$pageUid = (int) $rootPageRows[0]['uid'];
631
		}
632
633
		return $pageUid;
	}
634

635
636
637
638
639
640
641
	/**
	 * Get the template object
	 *
	 * @param int $siteRootId
	 * @return null|object|Template|FALSE
	 * @throws \Exception
	 */
642
	private function getTemplate($siteRootId) {
643
644
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
645
			throw new \Exception('The template is blacklisted');
646
647
		}

648
649
650
651
652
		$templateHash = $this->getTemplateHash($this->extensionKey, $this->templateName, $siteRootId, $this->language);
		if (isset(self::$templateObjectCache[$templateHash])
			&& self::$templateObjectCache[$templateHash] instanceof Template) {
			return self::$templateObjectCache[$templateHash];
		}
653
		/** @var Template $template */
654
		$template = $this->templateRepository->findOneByTemplate(
655
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
656
		);
657

658
659
660
661
662
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}
663
		self::$templateObjectCache[$templateHash] = $template;
664
665
		return $template;
	}
666

667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
	/**
	 * 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;
	}

	/**
	 * Get the hash for the object cache
	 *
	 * @param $extensionKey
	 * @param $templateName
	 * @param $siteRootId
	 * @param $languageId
	 * @return string
	 */
	private function getTemplateHash($extensionKey, $templateName, $siteRootId, $languageId) {
		return md5($extensionKey . '_' . $templateName . '_' . $siteRootId . '_' . $languageId);
	}

	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
705
	private function loadTemplateValues(Template $template) {
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
		$fromName = \trim($template->getFromName());
		if ($fromName === '') {
			$fromName = $this->fromName;
		}
		if ($fromName === '' && $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

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

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

		return $fromMail;
	}

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

		return $this;
	}

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

		return $this;
	}

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

		return $this;
	}

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

		return $this;
	}

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

805
806
807
	/**
	 * Get the default content for this template
	 *
808
809
	 * @param Template|null $template
	 * @param RegisterService $registerService
810
	 * @return bool|false|string
811
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
812
813
	 */
	protected function getDefaultTemplateContent($template, $registerService) {
814
815
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
816

817
		// If there is no template for this language, use the default template
818
		if ($template === NULL && $defaultTemplateContent === NULL) {
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
			$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']
				);
834

835
836
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
837
				} else {
838
					return FALSE;
839
				}
840
			}
Torsten Oppermann's avatar
Torsten Oppermann committed
841
		}
842
843
		return $defaultTemplateContent;
	}
Torsten Oppermann's avatar
Torsten Oppermann committed
844

845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
	/**
	 * @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;
	}

861
	/**
862
863
864
	 * Sets the values to send the mail with from the template or register service
	 *
	 * @param Template|null $template
865
866
867
	 * @param RegisterService $registerService
	 * @param string $defaultTemplateContent
	 * @param int $siteRootId
868
	 * @param boolean $isNewsletter
869
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
870
	 */
871
	protected function parseValuesForMail(
872
		$template, RegisterService $registerService, $defaultTemplateContent,
873
		$siteRootId
874
	) {
875
		/** @var StandaloneView $emailView */
876
		$emailView = $this->objectManager->get(StandaloneView::class);
877
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
878
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
879

880
		//TODO: make this as the lines below the next block
881
882
883
884
885
886
		$overwrittenEmailBody = $this->getOverwrittenEmailBody();
		$overwrittenSubject = '';
		if ($this->subject !== '' && $this->subject !== NULL) {
			$overwrittenSubject = $this->subject;
		}

887
		// parse markers
Paul Ilea's avatar
Paul Ilea committed
888
		if ($template !== NULL) {
889
890
891
			$subject = $this->parseMarkers(
				trim(empty($overwrittenSubject) ? $template->getSubject() : $overwrittenSubject),
				$emailView
892
			);
893

894
895
			$layoutId = $template->getLayout();
			$templateContent = $template->getContent();
896
			$this->setSubjectToSend($subject);
897
		} else {
898
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
899
900
			if (\is_array($subject)) {
				$subject = \trim(
901
902
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
903
				);
904
			}
905
906
907
908
			$subject = $this->parseMarkers(
				(empty($overwrittenSubject) ? $subject : $overwrittenSubject),
				$emailView
			);
909

910
911
912
			$layoutId = 0;
			$templateContent = $defaultTemplateContent;
		}
913

914
		$this->setSubjectToSend($subject);
915
		$this->mailMessage->setSubject($subject);
916

917
918
		// Parse the markers
		if ($this->fromName) {
919
			$this->setFromName($this->parseMarkers($this->fromName, $emailView));
920
921
		}

922
		if ($this->fromAddress) {
923
			$this->setFromAddress($this->parseMarkers($this->fromAddress, $emailView));
924
925
		}

926
		if ($this->replyToAddress) {
927
			$this->setReplyToAddress($this->parseMarkers($this->replyToAddress, $emailView));
928
929
		}

930
931
		if ($this->ccAddresses) {
			$this->setCcAddresses($this->parseMarkers($this->ccAddresses, $emailView));
932
933
		}

934
		if ($this->bccAddresses) {
935
			$this->setBccAddresses($this->parseMarkers($this->bccAddresses, $emailView));
936
937
		}

938
		if ($this->toAddresses) {
939
			$this->setToAddresses($this->parseMarkers($this->toAddresses, $emailView));
940
941
942
943
		}

		// reset template source back to default
		$emailView->setTemplateSource(
944
			empty($overwrittenEmailBody) ? $templateContent : $overwrittenEmailBody
945
		);
946

947
		$emailBody = $emailView->render();
948

949
950
951
952
953
954
		$layout = $this->getLayoutSource($layoutId, $siteRootId);
		$emailHTMLHead = '';
		if ($layout) {
			$emailHTMLHead = $layout->getHeadContent();
			$emailBody = \str_replace('###CONTENT###', $emailBody, $layout->getContent());
		}
955
956
957
958

		// insert <br> tags, but replace every instance of three or more successive breaks with just two.
		$emailBody = \nl2br($emailBody);
		$emailBody = \preg_replace('/(<br[\s]?[\/]?>[\s]*){3,}/', '<br><br>', $emailBody);
959
		$this->mailBodyToSend = '<html><head>' . $emailHTMLHead . '</head><body>' . $emailBody . '</body></html>';
960
961
962
	}

	/**
963
	 * Get a single variable containing a list of all markers
964
	 *
965
966
	 * @param array $markers
	 * @return string
967
	 */
968
969
	private function getAllMarker(array $markers): string {
		$allMarker = '';
970

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

976
977
978
979
980
981
982
983
984
985
986
987
988
989
			if (\is_string($value)) {
				$allMarker .= $key . ': ' . $value . PHP_EOL;
			} elseif (\is_array($value)) {
				foreach ($value as $innerKey => $innerValue) {
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
				}
			} elseif (\is_bool($value)) {
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
			} elseif (\is_object($value)) {
				if (\method_exists($value, '__toString')) {
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
			}
990
991
		}

992
993
		return $allMarker;
	}
994

995
996
997
998
999
1000
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}
1001

1002
1003
1004
1005
1006
1007
	/**
	 * @param string $overwrittenEmailBody
	 */
	public function setOverwrittenEmailBody(string $overwrittenEmailBody) {
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}
1008

1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
	/**
	 * Parses markers in an email View.
	 * !!! CHANGES THE SOURCE PATH AND IT SHOULD BE RESET BACK TO THE ORIGINAL!!!
	 *
	 * @param string $text
	 * @param StandaloneView $emailView
	 * @return mixed
	 */
	protected function parseMarkers($text, $emailView) {
		$text = (string) $text;
		if (strpos($text, '{') !== FALSE) {
			$emailView->setTemplateSource($text);
			return $emailView->render();
1022
		}
1023

1024
		return $text;
1025
1026
	}

Paul Ilea's avatar
Paul Ilea committed
1027
	/**
1028
	 * Returns the layout.
Paul Ilea's avatar
Paul Ilea committed
1029
1030
1031
	 *
	 * @param int $layoutUid
	 * @param int $siteRootId
1032
	 * @return Layout|NULL
Paul Ilea's avatar
Paul Ilea committed
1033
	 */
1034
	private function getLayoutSource(int $layoutUid, int $siteRootId) {
Paul Ilea's avatar
Paul Ilea committed
1035
1036
1037
1038
1039
		$languageUid = 0;
		if ($this->language !== self::DEFAULT_LANGUAGE) {
			$languageUid = (int) array_search($this->language, $this->getAvailableLanguages(), TRUE);
		}

1040
		return $this->layoutRepository->findByUidOrDefault($layoutUid, $siteRootId, $languageUid);
Paul Ilea's avatar
Paul Ilea committed
1041
1042
1043
	}

	/**
1044
	 * Returns the list of available translation languages
Paul Ilea's avatar
Paul Ilea committed
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
	 *
	 * @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;
	}

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

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

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

1140
		$mailRepository = $this->objectManager->get(MailRepository::class);
1141
		$mailRepository->add($mail);
1142
		$this->persistenceManager->persistAll();
1143
		return $mail;
1144
	}
1145

1146
	/**
1147
	 * @return string
1148
	 */
1149
1150
1151
1152
1153
1154
1155
	public function getSubjectToSend(): string {
		return $this->subjectToSend;
	}

	/**
	 * @param string $subjectToSend
	 */
1156
	public function setSubjectToSend(string $subjectToSend) {
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
		$this->subjectToSend = $subjectToSend;
	}

	/**
	 * @return string|string[]|null
	 */
	public function getMailBodyToSend() {
		return $this->mailBodyToSend;
	}

	/**
	 * @param string|string[]|null $mailBodyToSend
	 */
1170
	public function setMailBodyToSend($mailBodyToSend) {
1171
		$this->mailBodyToSend = $mailBodyToSend;
1172
1173
	}

1174
1175
1176
1177
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
1178
	 * @return bool|NULL
1179
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
Paul Ilea's avatar
Paul Ilea committed
1180
1181
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
1182
	 */
1183
	public function sendMailFromQueue($uid): bool {
1184
1185
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
1186
1187
1188
		if (!isset(self::$mailObjectCache[$uid]) || !self::$mailObjectCache[$uid] instanceof Mail) {
			$mailToSend = $this->getMailObjectByUid($uid);
			if ($mailToSend === FALSE) {
1189
1190
				return FALSE;
			}
1191
1192
		} else {
			$mailToSend = self::$mailObjectCache[$uid];
1193
		}
1194

1195