MailTemplateService.php 26.2 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
	 * @var string $extensionKey
109
110
111
112
	 */
	private $extensionKey;

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

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

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

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

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

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

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

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

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

157
158
159
160
161
	/**
	 * @var TYPO3\CMS\Core\Resource\ResourceFactory
	 */
	protected $resourceFactory;

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

177
178
179
180
		/** @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
181
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
182
183
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
184
		$this->resourceFactory = $this->objectManager->get(ResourceFactory::class);
185

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

192
			if (!\filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
193
194
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
195
				$this->fromAddress = $tsSettings['mail']['default']['from'];
196
			}
197
198
		}

199
200
201
202
203
		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
204
205
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
206
207

		foreach ($this->bccAddresses as $index => $email) {
208
			if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
209
210
211
212
213
214
215
216
217
218
				unset($this->bccAddresses[$index]);
			}
		}

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

219
		if (\count($this->bccAddresses) > 0) {
220
221
222
			$this->mailMessage->setBcc($this->bccAddresses);
		}

223
		if (\count($this->ccAddresses) > 0) {
224
225
			$this->mailMessage->setCc($this->ccAddresses);
		}
226
227
	}

228
229
230
	/**
	 * @param string $fromName
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
231
	public function setFromName($fromName): void {
232
233
234
235
236
237
238
239
		$this->fromName = $fromName;
	}

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
240
	public static function getReadableMarkerType($markerType): void {
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
349
350
351
352
353
354
355
356
		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;
357
		foreach ($markers as $key => $currentMarker) {
358
			if (!\is_array($currentMarker) || !isset($currentMarker['markerLabel'])) {
359
360
361
362
363
				continue;
			}
			$this->markerLabels[$key] = $currentMarker['markerLabel'];
		}

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
401
402
403
404
		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;
	}

	/**
405
406
407
	 * Adds a file resource as attachment
	 *
	 * @param FileReference $file
408
409
	 *
	 * @return MailTemplateService
410
	 * @throws \TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException
411
	 */
412
	public function addFileResourceAttachment(FileReference $file): MailTemplateService {
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
		$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;
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
472
473
474
475
476
477
478
479
480
481
482
483
484
		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
485
	public function setSubject(string $subject): void {
486
487
488
		$this->subject = $subject;
	}

489
490
491
492
493
494
495
496
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
497
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail'): array {
498
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
499
		// Need the key for translations
500
		if (\trim($extensionKey) === '') {
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
			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;
	}

518
	/**
519
	 * Send the Email
520
	 *
521
522
	 * @param bool $isPreview
	 * @return bool email was sent or added to mail queue successfully?
523
524
525
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
526
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
527
	 * @throws \Exception
528
	 */
529
	public function sendEmail($isPreview = FALSE): bool {
530
		$success = FALSE;
531
		if (TYPO3_MODE === 'FE') {
532
533
534
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
535
536
537
538
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

539
		if ($this->pid) {
540
			$pageUid = $this->pid;
541
		}
542

543
		if ($pageUid === 0) {
544
545
			$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(
				'pages'
546
			);
547
			$rootPageRows = $queryBuilder->select('*')
548
				->from('pages')
549
550
551
552
553
554
555
556
557
558
559
560
				->where(
					$queryBuilder->expr()->eq(
						'is_siteroot', 1
					)
				)
				->andWhere(
					$queryBuilder->expr()->eq(
						'hidden', 0
					)
				)
				->execute()->fetchAll();

561
562
563
			if ($rootPageRows && \count($rootPageRows)) {
				$pageUid = (int) $rootPageRows[0]['uid'];
			}
564
		}
565
		$siteRootId = BackendService::getSiteRoot($pageUid);
566

567
568
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
569
570
			// @TODO throw error or log ?
			return FALSE;
571
572
		}

573
		/** @var Template $template */
574
		$template = $this->templateRepository->findOneByTemplate(
575
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
576
		);
577

578
579
580
581
582
583
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

584
585
586
587
588
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

589
		// get default template content from register array
590
		$registerService = GeneralUtility::makeInstance(RegisterService::class);
591
592
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
593

594
595
		// If there is no template for this language, use the default template
		if ($template === NULL) {
596
			if ($defaultTemplateContent === NULL) {
597
598
				$templatePath =
					$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];
599

600
601
				// only standard template file is considered since version 4.1
				$defaultTemplateFile = $templatePath . 'template.html';
602
603
				if (\file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
604
				} else {
605
606
607
608
609
610
611
612
					// 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']
					);

613
614
					if (\file_exists($defaultTemplateFile)) {
						$defaultTemplateContent = \file_get_contents($defaultTemplateFile);
615
					} else {
616
						return FALSE;
617
					}
618
				}
619
			}
620
621
		} elseif (\filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
			$this->setToAddresses(\trim($template->getToAddress()));
622
623
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
624
625
		if ($isPreview) {
			$previewMarker = [];
626

627
			/** @var array $markerArray */
628
			$markerArray = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
Torsten Oppermann's avatar
Torsten Oppermann committed
629
			foreach ($markerArray as $marker) {
630
631
				$markerPath = GeneralUtility::trimExplode('.', $marker['marker']);
				$temporaryMarkerArray = [];
632
				foreach (\array_reverse($markerPath) as $index => $markerPathSegment) {
633
					if ($index === 0) {
634
635
636
637
						if ($marker['markerLabel']) {
							$markerPathSegment = $marker['markerLabel'];
						}

638
639
640
641
642
643
644
645
						if ($marker['backend_translation_key']) {
							$temporaryMarkerArray[$markerPathSegment] = LocalizationUtility::translate(
								$marker['backend_translation_key'], $marker['extension_key']
							);
						} else {
							$temporaryMarkerArray[$markerPathSegment] = $marker['value'];
						}
					} else {
646
						$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
647
					}
648
				}
649
				/** @noinspection SlowArrayOperationsInLoopInspection */
650
				$previewMarker = \array_merge_recursive($previewMarker, $temporaryMarkerArray);
Torsten Oppermann's avatar
Torsten Oppermann committed
651
			}
652
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
653
654
655
			$this->setMarkers($previewMarker);
		}

656
		/** @var StandaloneView $emailView */
657
		$emailView = $this->objectManager->get(StandaloneView::class);
658
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
659
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
660

Paul Ilea's avatar
Paul Ilea committed
661
		if ($template !== NULL) {
662
663
664
			$emailView->setTemplateSource(\trim($template->getSubject()));
			$subject = $emailView->render();

665
666
			$emailView->setTemplateSource($template->getContent());
		} else {
667
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
668
669
			if (\is_array($subject)) {
				$subject = \trim(
670
671
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
672
				);
673
			}
674
675
676
677
678
679
680
			if ($subject === NULL && $this->subject !== NULL) {
				$subject = $this->subject;
			}
			if ($subject !== NULL) {
				$emailView->setTemplateSource($subject);
				$subject = $emailView->render();
			}
681
			$emailView->setTemplateSource($defaultTemplateContent);
682
		}
683

Paul Ilea's avatar
Paul Ilea committed
684
		if ($this->subject !== '' && $this->subject !== NULL) {
685
686
687
			$subject = $this->subject;
		}

688
		$this->mailMessage->setSubject($subject);
689

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

695
696
697
698
699
700
701
702
703
704
705
706
		$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();
707
		}
708

709
		return $success;
710
711
712
	}

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

741
		$mail->setFromAddress($this->fromAddress);
742
		$mail->setFromName($this->fromName);
743

744
		$mail->setToAddress($this->toAddresses);
745
		$mail->setMailSubject($subject);
746
		$mail->setMailBody($emailBody);
747
		$mail->setPriority($priority);
748
749
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
750
		$mail->setSendingTime($sendingTime);
751
		$mail->setLastSendingTime($lastSendingTime);
752
		$mail->setReplyTo($this->replyToAddress);
753
754
755
756
757
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
758

759
		$mailRepository = $this->objectManager->get(MailRepository::class);
760
		$mailRepository->add($mail);
761
		$this->persistenceManager->persistAll();
762
		return $mail;
763
	}
764

765
766
767
768
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
769
	 * @return bool
Paul Ilea's avatar
Paul Ilea committed
770
771
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
772
	 * @throws \Exception
773
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
774
	public function sendMailFromQueue($uid): ?bool {
775
776
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
777
		$mailToSend = $mailRepository->findOneByUid($uid);
778
779
780
		if (!$mailToSend || $mailToSend->getBlacklisted()) {
			return FALSE;
		}
781

782
783
784
785
786
787
788
789
790
791
792
793
		$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());
794

795
796
797
		if ($mailToSend->getBccAddresses()) {
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
		}
798

799
800
801
		if ($mailToSend->getCcAddresses()) {
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
		}
802

803
804
805
806
807
808
809
810
811
812
813
814
815
		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())
				);
816
			}
817
		}
818
819
820
821
822
823
824
825
826
827
828
829
		$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;
830
831
	}

832
833
834
835
836
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
837
	private function loadTemplateValues($template): void {
838
		$fromName = \trim($template->getFromName());
839
840
841
		if ($fromName === '') {
			$fromName = $this->fromName;
		}
842
843
844
845
		if ($fromName === '' && $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
		$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)) {
864
865
			$fromMail = $this->fromAddress;
		}
866
		if (!\filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
867
			$fromMail = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
868
			if (!\filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
869
870
871
872
				$fromMail = 'noreply@example.com';
			}
		}

873
		return $fromMail;
874
875
	}

876
877
878
879
880
881
	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
882
	private function getAllMarker(array $markers): string {
883
884
885
		$allMarker = '';

		foreach ($markers as $key => $value) {
886
			if (\array_key_exists($key, $this->markerLabels) && $this->markerLabels[$key] !== NULL) {
887
888
				$key = $this->markerLabels[$key];
			}
889

890
			if (\is_string($value)) {
891
				$allMarker .= $key . ': ' . $value . PHP_EOL;
892
			} elseif (\is_array($value)) {
893
				foreach ($value as $innerKey => $innerValue) {
Torsten Oppermann's avatar
Torsten Oppermann committed
894
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
895
				}
896
			} elseif (\is_bool($value)) {
Torsten Oppermann's avatar
Torsten Oppermann committed
897
898
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
899
			} elseif (\is_object($value)) {
900
				if (\method_exists($value, '__toString')) {
901
902
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
903
904
905
906
907
			}
		}

		return $allMarker;
	}
908
}