MailTemplateService.php 26.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
32
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
use SGalinski\SgMail\Domain\Repository\MailRepository;
33
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
34
35
use Swift_Attachment;
use Swift_OutputByteStream;
36
use TYPO3\CMS\Core\Database\ConnectionPool;
37
use TYPO3\CMS\Core\Mail\MailMessage;
38
use TYPO3\CMS\Core\Resource\ResourceFactory;
39
use TYPO3\CMS\Core\Utility\GeneralUtility;
40
use TYPO3\CMS\Extbase\Domain\Model\FileReference;
41
use TYPO3\CMS\Extbase\Object\ObjectManager;
42
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
43
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
44
use TYPO3\CMS\Fluid\View\StandaloneView;
45
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
46

47
48
49
/**
 * MailTemplateService
 */
50
class MailTemplateService {
Torsten Oppermann's avatar
Torsten Oppermann committed
51
52
53
54
55
56
57
58
59
60
	public const MARKER_TYPE_STRING = 'String';
	public const MARKER_TYPE_ARRAY = 'Array';
	public const MARKER_TYPE_OBJECT = 'Object';
	public const MARKER_TYPE_FILE = 'File';
	public const DEFAULT_LANGUAGE = 'default';
	public const DEFAULT_TEMPLATE_PATH = 'Resources/Private/Templates/SgMail/';
	public const CACHE_NAME = 'sg_mail_registerArrayCache';
	public const CACHE_LIFETIME_IN_SECONDS = 86400;
	public const REGISTER_FILE = 'Register.php';
	public const CONFIG_PATH = 'Configuration/MailTemplates';
61

62
	/**
63
	 * @var string $toAddresses
64
	 */
65
	private $toAddresses = '';
66
67

	/**
68
	 * @var string $fromAddress
69
	 */
70
	private $fromAddress = '';
71
72

	/**
73
	 * @var string $ccAddresses
74
	 */
Paul Ilea's avatar
Paul Ilea committed
75
	private $ccAddresses;
76
77

	/**
78
	 * @var string $replyToAddress
79
	 */
80
	private $replyToAddress = '';
81
82

	/**
83
	 * @var string $language
84
	 */
85
	private $language = 'default';
86
87

	/**
88
	 * @var boolean $ignoreMailQueue
89
	 */
90
	private $ignoreMailQueue = FALSE;
91
92
93
94
95
96
97

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

	/**
98
	 * @var string $templateName
99
100
101
	 */
	private $templateName;

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

107
108
109
110
111
	/**
	 * @var string $overwrittenEmailBody
	 */
	private $overwrittenEmailBody = '';

112
	/**
113
	 * @var string $extensionKey
114
115
116
117
	 */
	private $extensionKey;

	/**
118
	 * @var array $markers
119
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
120
	private $markers;
121

122
123
124
125
126
	/**
	 * @var array $markerLabels
	 */
	private $markerLabels;

127
	/**
128
	 * @var string $bccAddresses
129
	 */
Paul Ilea's avatar
Paul Ilea committed
130
	private $bccAddresses;
131

132
133
134
135
136
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

137
138
139
140
141
	/**
	 * @var int
	 */
	private $pid;

142
143
144
145
146
	/**
	 * @var string
	 */
	private $fromName = '';

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

	/**
	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager
	 */
	protected $persistenceManager;
156

157
158
159
160
161
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

162
163
164
165
166
	/**
	 * @var TYPO3\CMS\Core\Resource\ResourceFactory
	 */
	protected $resourceFactory;

167
168
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
169
	 *
170
171
	 * @param string $templateName
	 * @param string $extensionKey
172
	 * @param array $markers
173
	 * @param array $markerLabels
Paul Ilea's avatar
Paul Ilea committed
174
	 * @throws \InvalidArgumentException
175
	 */
176
	public function __construct($templateName = '', $extensionKey = '', $markers = [], $markerLabels = []) {
177
178
179
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;
180
		$this->markerLabels = $markerLabels;
181

182
183
184
185
		/** @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
186
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
187
188
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
189
		$this->resourceFactory = $this->objectManager->get(ResourceFactory::class);
190

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

197
			if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
198
199
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
200
				$this->fromAddress = $tsSettings['mail']['default']['from'];
201
			}
202
203
		}

204
205
206
207
208
		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
209
210
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
211
212

		foreach ($this->bccAddresses as $index => $email) {
213
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
214
215
216
217
218
219
220
221
222
223
				unset($this->bccAddresses[$index]);
			}
		}

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

224
		if (\count($this->bccAddresses) > 0) {
225
226
227
			$this->mailMessage->setBcc($this->bccAddresses);
		}

228
		if (\count($this->ccAddresses) > 0) {
229
230
			$this->mailMessage->setCc($this->ccAddresses);
		}
231
232
	}

233
234
235
	/**
	 * @param string $fromName
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
236
	public function setFromName($fromName): void {
237
238
239
240
241
242
243
244
		$this->fromName = $fromName;
	}

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
245
	public static function getReadableMarkerType($markerType): void {
246
247
248
249
250
251
252
253
254
255
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
		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;
	}

	/**
	 * @param array $markers
	 * @return MailTemplateService
	 */
	public function setMarkers(array $markers): MailTemplateService {
		$this->markers = $markers;
362
		foreach ($markers as $key => $currentMarker) {
363
			if (!\is_array($currentMarker) || !isset($currentMarker['markerLabel'])) {
364
365
366
367
368
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
		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;
	}

	/**
410
411
412
	 * Adds a file resource as attachment
	 *
	 * @param FileReference $file
413
414
	 *
	 * @return MailTemplateService
415
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
416
	 */
417
	public function addFileResourceAttachment(FileReference $file): MailTemplateService {
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
		$originalResource = $file->getOriginalResource();
		if (!$originalResource) {
			return $this;
		}
		$originalFile = $originalResource->getOriginalFile();
		if (!$originalFile) {
			return $this;
		}

		$coreFileReferenceMailFile = $this->resourceFactory->createFileReferenceObject(
			[
				'uid_local' => $originalFile->getUid(),
				'table_local' => 'sys_file',
				'uid' => uniqid('NEW_MAIL', TRUE)
			]
		);

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

		$this->markers[] = $newFileReference;
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
		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
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
490
	public function setSubject(string $subject): void {
491
492
493
		$this->subject = $subject;
	}

494
495
496
497
498
499
500
501
502
503
504
505
506
507
	/**
	 * @return string
	 */
	public function getOverwrittenEmailBody(): string {
		return $this->overwrittenEmailBody;
	}

	/**
	 * @param string $overwrittenEmailBody
	 */
	public function setOverwrittenEmailBody(string $overwrittenEmailBody): void {
		$this->overwrittenEmailBody = $overwrittenEmailBody;
	}

508
509
510
511
512
513
514
515
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
516
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail'): array {
517
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
518
		// Need the key for translations
519
		if (\trim($extensionKey) === '') {
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
			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;
	}

537
	/**
538
	 * Send the Email
539
	 *
540
541
	 * @param bool $isPreview
	 * @return bool email was sent or added to mail queue successfully?
542
543
544
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
545
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
546
	 * @throws \Exception
547
	 */
548
	public function sendEmail($isPreview = FALSE): bool {
549
		$success = FALSE;
550
		if (TYPO3_MODE === 'FE') {
551
552
553
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
554
555
556
557
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

558
		if ($this->pid) {
559
			$pageUid = $this->pid;
560
		}
561

562
		if ($pageUid === 0) {
563
564
			$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(
				'pages'
565
			);
566
			$rootPageRows = $queryBuilder->select('*')
567
				->from('pages')
568
569
570
571
572
573
574
575
576
577
578
579
				->where(
					$queryBuilder->expr()->eq(
						'is_siteroot', 1
					)
				)
				->andWhere(
					$queryBuilder->expr()->eq(
						'hidden', 0
					)
				)
				->execute()->fetchAll();

580
581
582
			if ($rootPageRows && \count($rootPageRows)) {
				$pageUid = (int) $rootPageRows[0]['uid'];
			}
583
		}
584
		$siteRootId = BackendService::getSiteRoot($pageUid);
585

586
587
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
588
589
			// @TODO throw error or log ?
			return FALSE;
590
591
		}

592
		/** @var Template $template */
593
		$template = $this->templateRepository->findOneByTemplate(
594
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
595
		);
596

597
598
599
600
601
602
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

603
604
605
606
607
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

608
		// get default template content from register array
609
		$registerService = GeneralUtility::makeInstance(RegisterService::class);
610
611
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
612

613
614
		// If there is no template for this language, use the default template
		if ($template === NULL) {
615
			if ($defaultTemplateContent === NULL) {
616
617
				$templatePath =
					$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];
618

619
620
				// only standard template file is considered since version 4.1
				$defaultTemplateFile = $templatePath . 'template.html';
621
622
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
623
				} else {
624
625
626
627
628
629
630
631
					// 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']
					);

632
633
					if (\file_exists($defaultTemplateFile)) {
						$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
634
					} else {
635
						return FALSE;
636
					}
637
				}
638
			}
639
640
		} elseif (\filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
			$this->setToAddresses(\trim($template->getToAddress()));
641
642
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
643
644
		if ($isPreview) {
			$previewMarker = [];
645

646
			/** @var array $markerArray */
647
			$markerArray = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
Torsten Oppermann's avatar
Torsten Oppermann committed
648
			foreach ($markerArray as $marker) {
649
650
				$markerPath = GeneralUtility::trimExplode('.', $marker['marker']);
				$temporaryMarkerArray = [];
651
				foreach (\array_reverse($markerPath) as $index => $markerPathSegment) {
652
					if ($index === 0) {
653
654
655
656
						if ($marker['markerLabel']) {
							$markerPathSegment = $marker['markerLabel'];
						}

657
658
659
660
661
662
663
664
						if ($marker['backend_translation_key']) {
							$temporaryMarkerArray[$markerPathSegment] = LocalizationUtility::translate(
								$marker['backend_translation_key'], $marker['extension_key']
							);
						} else {
							$temporaryMarkerArray[$markerPathSegment] = $marker['value'];
						}
					} else {
665
						$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
666
					}
667
				}
668
				/** @noinspection SlowArrayOperationsInLoopInspection */
669
				$previewMarker = \array_merge_recursive($previewMarker, $temporaryMarkerArray);
Torsten Oppermann's avatar
Torsten Oppermann committed
670
			}
671
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
672
673
674
			$this->setMarkers($previewMarker);
		}

675
		/** @var StandaloneView $emailView */
676
		$emailView = $this->objectManager->get(StandaloneView::class);
677
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
678
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
679

Paul Ilea's avatar
Paul Ilea committed
680
		if ($template !== NULL) {
681
682
683
			$emailView->setTemplateSource(\trim($template->getSubject()));
			$subject = $emailView->render();

684
685
			$overwrittenEmailBody = $this->getOverwrittenEmailBody();
			$emailView->setTemplateSource(empty($overwrittenEmailBody) ? $template->getContent() : $overwrittenEmailBody);
686
		} else {
687
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
688
689
			if (\is_array($subject)) {
				$subject = \trim(
690
691
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
692
				);
693
			}
694
695
696
697
698
699
700
			if ($subject === NULL && $this->subject !== NULL) {
				$subject = $this->subject;
			}
			if ($subject !== NULL) {
				$emailView->setTemplateSource($subject);
				$subject = $emailView->render();
			}
701
			$emailView->setTemplateSource(empty($overwrittenEmailBody) ? $defaultTemplateContent : $overwrittenEmailBody);
702
		}
703

Paul Ilea's avatar
Paul Ilea committed
704
		if ($this->subject !== '' && $this->subject !== NULL) {
705
706
707
			$subject = $this->subject;
		}

708
		$this->mailMessage->setSubject($subject);
709

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

715
716
717
718
719
720
721
722
723
724
725
726
		$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();
727
		}
728

729
		return $success;
730
731
732
	}

	/**
733
	 * Adds a new mail to the mail queue.
734
	 *
735
736
	 * @param string $extensionKey
	 * @param string $templateName
737
	 * @param string $subject
738
	 * @param string $emailBody
739
	 * @param int $sendingTime
740
	 * @param int $priority
741
	 * @param int $lastSendingTime
742
	 * @param string $language
743
	 * @param int $pid
744
	 * @return Mail
745
746
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
747
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
748
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
749
	 */
750
	private function addMailToMailQueue(
751
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
752
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
753
	): Mail {
754
		$mail = $this->objectManager->get(Mail::class);
755
		$mail->setPid($pid);
756
757
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
758
		$mail->setLanguage($language);
759
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
760

761
		$mail->setFromAddress($this->fromAddress);
762
		$mail->setFromName($this->fromName);
763

764
		$mail->setToAddress($this->toAddresses);
765
		$mail->setMailSubject($subject);
766
		$mail->setMailBody($emailBody);
767
		$mail->setPriority($priority);
768
769
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
770
		$mail->setSendingTime($sendingTime);
771
		$mail->setLastSendingTime($lastSendingTime);
772
		$mail->setReplyTo($this->replyToAddress);
773
774
775
776
777
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
778

779
		$mailRepository = $this->objectManager->get(MailRepository::class);
780
		$mailRepository->add($mail);
781
		$this->persistenceManager->persistAll();
782
		return $mail;
783
	}
784

785
786
787
788
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
789
	 * @return bool
Paul Ilea's avatar
Paul Ilea committed
790
791
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
792
	 * @throws \Exception
793
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
794
	public function sendMailFromQueue($uid): ?bool {
795
796
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
797
		$mailToSend = $mailRepository->findOneByUid($uid);
798
799
800
		if (!$mailToSend || $mailToSend->getBlacklisted()) {
			return FALSE;
		}
801

802
803
804
805
806
807
808
809
810
811
812
813
		$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());
814

815
816
817
		if ($mailToSend->getBccAddresses()) {
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
		}
818

819
820
821
		if ($mailToSend->getCcAddresses()) {
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
		}
822

823
824
825
826
827
828
829
830
831
832
833
834
835
		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())
				);
836
			}
837
		}
838
839
840
841
842
843
844
845
846
847
848
849
		$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;
850
851
	}

852
853
854
855
856
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
857
	private function loadTemplateValues($template): void {
858
		$fromName = \trim($template->getFromName());
859
860
861
		if ($fromName === '') {
			$fromName = $this->fromName;
		}
862
863
864
865
		if ($fromName === '' && $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
		$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
	 *
	 * @param string $fromMail
	 * @return string
	 */
	private function getValidFromMail($fromMail): string {
		$fromMail = \trim($fromMail);
		if (!\filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
884
885
			$fromMail = $this->fromAddress;
		}
886
		if (!\filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
887
			$fromMail = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
888
			if (!\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
889
890
891
892
				$fromMail = 'noreply@example.com';
			}
		}

893
		return $fromMail;
894
895
	}

896
897
898
899
900
901
	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
902
	private function getAllMarker(array $markers): string {
903
904
905
		$allMarker = '';

		foreach ($markers as $key => $value) {
906
			if (\array_key_exists($key, $this->markerLabels) && $this->markerLabels[$key] !== NULL) {
907
908
				$key = $this->markerLabels[$key];
			}
909

910
			if (\is_string($value)) {
911
				$allMarker .= $key . ': ' . $value . PHP_EOL;
912
			} elseif (\is_array($value)) {
913
				foreach ($value as $innerKey => $innerValue) {
Torsten Oppermann's avatar
Torsten Oppermann committed
914
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
915
				}
916
			} elseif (\is_bool($value)) {
Torsten Oppermann's avatar
Torsten Oppermann committed
917
918
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
919
			} elseif (\is_object($value)) {
920
				if (\method_exists($value, '__toString')) {
921
922
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
923
924
925
926
927
			}
		}

		return $allMarker;
	}
928
}