MailTemplateService.php 25.7 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\FileInterface;
39
use TYPO3\CMS\Core\Resource\ResourceFactory;
40
use TYPO3\CMS\Core\Utility\GeneralUtility;
41
use TYPO3\CMS\Extbase\Domain\Model\FileReference;
42
use TYPO3\CMS\Extbase\Object\ObjectManager;
43
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
44
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
45
use TYPO3\CMS\Fluid\View\StandaloneView;
46
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
47

48
49
50
/**
 * MailTemplateService
 */
51
class MailTemplateService {
Torsten Oppermann's avatar
Torsten Oppermann committed
52
53
54
55
56
57
58
59
60
61
	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';
62

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

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

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

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

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

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

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

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

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

108
	/**
109
	 * @var string $extensionKey
110
111
112
113
	 */
	private $extensionKey;

	/**
114
	 * @var array $markers
115
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
116
	private $markers;
117

118
119
120
121
122
	/**
	 * @var array $markerLabels
	 */
	private $markerLabels;

123
	/**
124
	 * @var string $bccAddresses
125
	 */
Paul Ilea's avatar
Paul Ilea committed
126
	private $bccAddresses;
127

128
129
130
131
132
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

133
134
135
136
137
	/**
	 * @var int
	 */
	private $pid;

138
139
140
141
142
	/**
	 * @var string
	 */
	private $fromName = '';

143
144
145
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
146
147
148
149
150
151
	protected $templateRepository;

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

153
154
155
156
157
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

158
159
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
160
	 *
161
162
	 * @param string $templateName
	 * @param string $extensionKey
163
	 * @param array $markers
164
	 * @param array $markerLabels
Paul Ilea's avatar
Paul Ilea committed
165
	 * @throws \InvalidArgumentException
166
	 */
167
	public function __construct($templateName = '', $extensionKey = '', $markers = [], $markerLabels = []) {
168
169
170
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;
171
		$this->markerLabels = $markerLabels;
172

173
174
175
176
		/** @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
177
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
178
179
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
180

181
		// use defaultMailFromAddress if it is provided in LocalConfiguration.php; use the sg_mail TS setting as fallback
182
		if (filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
183
184
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
		} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
185
			$this->fromAddress = $tsSettings['mail']['default']['from'];
186

Torsten Oppermann's avatar
Torsten Oppermann committed
187
			if (!filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
188
189
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
190
				$this->fromAddress = $tsSettings['mail']['default']['from'];
191
			}
192
193
		}

194
		$this->mailMessage->setFrom($this->fromAddress);
195

Torsten Oppermann's avatar
Torsten Oppermann committed
196
197
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
198
199
200
201
202
203
204
205
206
207
208
209
210

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

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

211
		if (\count($this->bccAddresses) > 0) {
212
213
214
			$this->mailMessage->setBcc($this->bccAddresses);
		}

215
		if (\count($this->ccAddresses) > 0) {
216
217
			$this->mailMessage->setCc($this->ccAddresses);
		}
218
219
	}

220
221
222
	/**
	 * @param string $fromName
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
223
	public function setFromName($fromName): void {
224
225
226
227
228
229
230
231
		$this->fromName = $fromName;
	}

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
232
	public static function getReadableMarkerType($markerType): void {
233
234
235
236
237
238
239
240
241
242
243
244
245
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
		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;
349
350
351
352
353
354
355
		foreach($markers as $key => $currentMarker) {
			if (!isset($currentMarker['markerLabel'])) {
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
		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;
	}

	/**
	 * Add a file resource as attachment
	 *
	 * @param FileInterface|FileReference $file
	 * @return MailTemplateService
Torsten Oppermann's avatar
Torsten Oppermann committed
401
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
	 */
	public function addFileResourceAttachment($file): MailTemplateService {
		if ($file instanceof FileReference) {
			$file = $file->getOriginalResource()->getOriginalFile();
		}
		$fileReference = $this->objectManager->get(FileReference::class);
		$resourceFactory = $this->objectManager->get(ResourceFactory::class);
		$falFileReference = $resourceFactory->createFileReferenceObject(
			[
				'uid_local' => $file->getUid(),
				'uid_foreign' => uniqid('NEW_', TRUE),
				'uid' => uniqid('NEW_', TRUE),
				'crop' => NULL,
			]
		);
		$fileReference->setOriginalResource($falFileReference);
		$this->markers[] = $fileReference;
		/** @noinspection PhpParamsInspection */
		$this->addAttachment($file->getContents(), $file->getName(), $file->getMimeType());
		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
472
	public function setSubject(string $subject): void {
473
474
475
		$this->subject = $subject;
	}

476
477
478
479
480
481
482
483
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
484
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail'): array {
485
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505

		// Need the key for translations
		if (trim($extensionKey) === '') {
			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;
	}

506
	/**
507
	 * Send the Email
508
	 *
509
510
	 * @param bool $isPreview
	 * @return bool email was sent or added to mail queue successfully?
511
512
513
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
514
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
515
	 * @throws \Exception
516
	 */
517
	public function sendEmail($isPreview = FALSE): bool {
518
		$success = FALSE;
519
		if (TYPO3_MODE === 'FE') {
520
521
522
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
523
524
525
526
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

527
		if ($this->pid) {
528
			$pageUid = $this->pid;
529
		}
530

531
		if ($pageUid === 0) {
532
533
			$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(
				'pages'
534
			);
535
			$rootPageRows = $queryBuilder->select('*')
536
				->from('pages')
537
538
539
540
541
542
543
544
545
546
547
548
				->where(
					$queryBuilder->expr()->eq(
						'is_siteroot', 1
					)
				)
				->andWhere(
					$queryBuilder->expr()->eq(
						'hidden', 0
					)
				)
				->execute()->fetchAll();

549
550
551
			if ($rootPageRows && \count($rootPageRows)) {
				$pageUid = (int) $rootPageRows[0]['uid'];
			}
552
		}
553
		$siteRootId = BackendService::getSiteRoot($pageUid);
554

555
556
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
557
558
559
			// @TODO: This needs to be changed, because if the template is blacklisted, the email can not be sent
			$success = TRUE;
			return $success;
560
561
		}

562
		/** @var Template $template */
563
		$template = $this->templateRepository->findOneByTemplate(
564
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
565
		);
566

567
568
569
570
571
572
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

573
574
575
576
577
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

578
		// get default template content from register array
579
		$registerService = GeneralUtility::makeInstance(RegisterService::class);
580
581
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
582

583
584
		// If there is no template for this language, use the default template
		if ($template === NULL) {
585
			if ($defaultTemplateContent === NULL) {
586
587
				$templatePath =
					$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];
588

589
590
				// only standard template file is considered since version 4.1
				$defaultTemplateFile = $templatePath . 'template.html';
Torsten Oppermann's avatar
Torsten Oppermann committed
591
592
				if (file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = file_get_contents($defaultTemplateFile);
593
				} else {
594
595
596
597
598
599
600
601
602
603
604
					// 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']
					);

					if (file_exists($defaultTemplateFile)) {
						$defaultTemplateContent = file_get_contents($defaultTemplateFile);
					} else {
605
						return $success;
606
					}
607
				}
608
			}
609

610
		} elseif (filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
611
			$this->setToAddresses(trim($template->getToAddress()));
612
613
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
614
615
		if ($isPreview) {
			$previewMarker = [];
616

617
			/** @var array $markerArray */
618
			$markerArray = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
Torsten Oppermann's avatar
Torsten Oppermann committed
619
			foreach ($markerArray as $marker) {
620
621
622
623
				$markerPath = GeneralUtility::trimExplode('.', $marker['marker']);
				$temporaryMarkerArray = [];
				foreach (array_reverse($markerPath) as $index => $markerPathSegment) {
					if ($index === 0) {
624
625
626
627
						if ($marker['markerLabel']) {
							$markerPathSegment = $marker['markerLabel'];
						}

628
629
630
631
632
633
634
635
						if ($marker['backend_translation_key']) {
							$temporaryMarkerArray[$markerPathSegment] = LocalizationUtility::translate(
								$marker['backend_translation_key'], $marker['extension_key']
							);
						} else {
							$temporaryMarkerArray[$markerPathSegment] = $marker['value'];
						}
					} else {
636
						$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
637
					}
638
				}
639
				/** @noinspection SlowArrayOperationsInLoopInspection */
640
				$previewMarker = array_merge_recursive($previewMarker, $temporaryMarkerArray);
Torsten Oppermann's avatar
Torsten Oppermann committed
641
			}
642
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
643
644
645
			$this->setMarkers($previewMarker);
		}

646
		/** @var StandaloneView $emailView */
647
		$emailView = $this->objectManager->get(StandaloneView::class);
648
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
649
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
650

Paul Ilea's avatar
Paul Ilea committed
651
		if ($template !== NULL) {
652
653
654
			$emailView->setTemplateSource(\trim($template->getSubject()));
			$subject = $emailView->render();

655
656
			$emailView->setTemplateSource($template->getContent());
		} else {
657
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
658
659
			if (\is_array($subject)) {
				$subject = \trim(
660
661
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
662
				);
663
			}
664
665
666
667
668
669
670
			if ($subject === NULL && $this->subject !== NULL) {
				$subject = $this->subject;
			}
			if ($subject !== NULL) {
				$emailView->setTemplateSource($subject);
				$subject = $emailView->render();
			}
671
			$emailView->setTemplateSource($defaultTemplateContent);
672
		}
673

Paul Ilea's avatar
Paul Ilea committed
674
		if ($this->subject !== '' && $this->subject !== NULL) {
675
676
677
			$subject = $this->subject;
		}

678
		$this->mailMessage->setSubject($subject);
679

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

685
686
687
688
689
690
691
692
693
694
695
696
		$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();
697
		}
698

699
		return $success;
700
701
702
	}

	/**
703
	 * Adds a new mail to the mail queue.
704
	 *
705
706
	 * @param string $extensionKey
	 * @param string $templateName
707
	 * @param string $subject
708
	 * @param string $emailBody
709
	 * @param int $sendingTime
710
	 * @param int $priority
711
	 * @param int $lastSendingTime
712
	 * @param string $language
713
	 * @param int $pid
714
	 * @return Mail
715
716
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
717
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
718
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
719
	 */
720
	private function addMailToMailQueue(
721
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
722
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
Torsten Oppermann's avatar
Torsten Oppermann committed
723
	): Mail {
724
		$mail = $this->objectManager->get(Mail::class);
725
		$mail->setPid($pid);
726
727
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
728
		$mail->setLanguage($language);
729
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
730

731
		$mail->setFromAddress($this->fromAddress);
732
		$mail->setFromName($this->fromName);
733

734
		$mail->setToAddress($this->toAddresses);
735
		$mail->setMailSubject($subject);
736
		$mail->setMailBody($emailBody);
737
		$mail->setPriority($priority);
738
739
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
740
		$mail->setSendingTime($sendingTime);
741
		$mail->setLastSendingTime($lastSendingTime);
742
		$mail->setReplyTo($this->replyToAddress);
743
744
745
746
747
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
748

749
		$mailRepository = $this->objectManager->get(MailRepository::class);
750
		$mailRepository->add($mail);
751
		$this->persistenceManager->persistAll();
752
		return $mail;
753
	}
754

755
756
757
758
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
759
	 * @return bool
Paul Ilea's avatar
Paul Ilea committed
760
761
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
762
	 * @throws \Exception
763
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
764
	public function sendMailFromQueue($uid): ?bool {
765
766
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
767
		$mailToSend = $mailRepository->findOneByUid($uid);
768

769
		if ($mailToSend && !$mailToSend->getBlacklisted()) {
770
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
771
772
773
			$plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
			$plaintextBody = $plaintextService->makePlain($mailToSend->getMailBody());
			$this->mailMessage->addPart($plaintextBody, 'text/plain');
774
775
776
777
778
779
			$toAddresses = trim($mailToSend->getToAddress());
			$addressesArray = GeneralUtility::trimExplode(',', $toAddresses, TRUE);
			if (\count($addressesArray) > 1) {
				$toAddresses = $addressesArray;
			}
			$this->mailMessage->setTo($toAddresses);
780
781
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
782

783
			if ($mailToSend->getBccAddresses()) {
784
785
786
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

787
			if ($mailToSend->getCcAddresses()) {
788
789
790
791
792
793
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

			if ($mailToSend->getReplyTo()) {
				$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
			}
794
795
796
797
798
799
800
801
802
803
804
805
			$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())
					);
				}
			}
806
			$dateTime = new DateTime();
807
808
809
			if ((int) $mailToSend->getSendingTime() === 0) {
				$mailToSend->setSendingTime($dateTime->getTimestamp());
			}
810
			$mailToSend->setLastSendingTime($dateTime->getTimestamp());
811
812
813
814
815
816
817
			$success = $this->mailMessage->send();
			if ($success) {
				$mailRepository->update($mailToSend);
			} else {
				$this->mailMessage->getFailedRecipients();
			}
			return $success;
818
		}
Torsten Oppermann's avatar
Torsten Oppermann committed
819
820

		return NULL;
821
822
	}

823
824
825
826
827
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
828
	private function loadTemplateValues($template): void {
829
		$fromName = \trim($template->getFromName());
830
831
832
833
		if ($fromName === '' && $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

834
		$fromMail = \trim($template->getFromMail());
835
836
837
838
839
840
841
842
		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';
			}
		}

		$this->setFromAddress($fromMail, $fromName);
843
844
845
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
846
		$this->setFromName($fromName);
847
848
849
		$this->setReplyToAddress($template->getReplyTo());
	}

850
851
852
853
854
855
	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
856
	private function getAllMarker(array $markers): string {
857
858
859
		$allMarker = '';

		foreach ($markers as $key => $value) {
860
			if (\array_key_exists($key, $this->markerLabels) && $this->markerLabels[$key] !== NULL) {
861
862
				$key = $this->markerLabels[$key];
			}
863

864
			if (\is_string($value)) {
865
				$allMarker .= $key . ': ' . $value . PHP_EOL;
866
			} elseif (\is_array($value)) {
867
				foreach ($value as $innerKey => $innerValue) {
Torsten Oppermann's avatar
Torsten Oppermann committed
868
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
869
				}
870
			} elseif (\is_bool($value)) {
Torsten Oppermann's avatar
Torsten Oppermann committed
871
872
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
873
874
875
876
			} elseif (\is_object($value)) {
				if (method_exists($value, '__toString')) {
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
877
878
879
880
881
			}
		}

		return $allMarker;
	}
882
}