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\Mail\MailMessage;
37
use TYPO3\CMS\Core\Resource\FileInterface;
38
use TYPO3\CMS\Core\Resource\ResourceFactory;
39
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
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
use TYPO3\CMS\Frontend\Page\PageRepository;
48

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

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

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

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

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

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

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

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

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

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

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

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

119
	/**
120
	 * @var string $bccAddresses
121
	 */
Paul Ilea's avatar
Paul Ilea committed
122
	private $bccAddresses;
123

124
125
126
127
128
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

129
130
131
132
133
	/**
	 * @var int
	 */
	private $pid;

134
135
136
137
138
	/**
	 * @var string
	 */
	private $fromName = '';

139
140
141
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
142
143
144
145
146
147
	protected $templateRepository;

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

149
150
151
152
153
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

154
155
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
156
	 *
157
158
159
	 * @param string $templateName
	 * @param string $extensionKey
	 * @param string $markers
Paul Ilea's avatar
Paul Ilea committed
160
	 * @throws \InvalidArgumentException
161
	 */
162
163
164
165
166
	public function __construct($templateName = '', $extensionKey = '', $markers = '') {
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;

167
168
169
170
		/** @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
171
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
172
173
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
174

175
		// use defaultMailFromAddress if it is provided in LocalConfiguration.php; use the sg_mail TS setting as fallback
176
		if (filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
177
178
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
		} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
179
			$this->fromAddress = $tsSettings['mail']['default']['from'];
180

Torsten Oppermann's avatar
Torsten Oppermann committed
181
			if (!filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
182
183
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
184
				$this->fromAddress = $tsSettings['mail']['default']['from'];
185
			}
186
187
		}

188
		$this->mailMessage->setFrom($this->fromAddress);
189

Torsten Oppermann's avatar
Torsten Oppermann committed
190
191
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
192
193
194
195
196
197
198
199
200
201
202
203
204

		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]);
			}
		}

205
		if (\count($this->bccAddresses) > 0) {
206
207
208
			$this->mailMessage->setBcc($this->bccAddresses);
		}

209
		if (\count($this->ccAddresses) > 0) {
210
211
			$this->mailMessage->setCc($this->ccAddresses);
		}
212
213
	}

214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
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
	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
	}

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

462
463
464
465
466
467
468
469
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
470
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail'): array {
471
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491

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

492
	/**
493
	 * Send the Email
494
	 *
Torsten Oppermann's avatar
Torsten Oppermann committed
495
	 * @param boolean $isPreview
496
	 * @return boolean email was sent or added to mail queue successfully?
497
498
499
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
500
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
501
	 * @throws \Exception
502
	 */
503
	public function sendEmail($isPreview = FALSE): bool {
504
		if (TYPO3_MODE === 'FE') {
505
506
507
			/** @var TypoScriptFrontendController $typoscriptFrontendController */
			$typoscriptFrontendController = $GLOBALS['TSFE'];
			$pageUid = (int) $typoscriptFrontendController->id;
508
509
510
511
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

512
		if ($this->pid) {
513
			$pageUid = $this->pid;
514
		}
515

516
517
518
519
520
521
522
523
		if ($pageUid === 0) {
			$pageRepository = $this->objectManager->get(PageRepository::class);
			$rootPageRows = $pageRepository->getRecordsByField(
				'pages', 'is_siteroot', 1, 'hidden = 0', '', 'sorting', 1
			);
			if ($rootPageRows && \count($rootPageRows)) {
				$pageUid = (int) $rootPageRows[0]['uid'];
			}
524
		}
525
		$siteRootId = BackendService::getSiteRoot($pageUid);
526

527
528
529
530
531
		$isTemplateBlacklisted = self::isTemplateBlacklisted($this->extensionKey, $this->templateName, $siteRootId);
		if ($isTemplateBlacklisted) {
			return TRUE;
		}

532
		/** @var Template $template */
533
		$template = $this->templateRepository->findOneByTemplate(
534
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
535
		);
536

537
538
539
540
541
542
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

543
544
545
546
547
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

548
		// get default template content from register array
549
		$registerService = GeneralUtility::makeInstance(RegisterService::class);
550
551
		$defaultTemplateContent =
			$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templateContent'];
552

553
554
		// If there is no template for this language, use the default template
		if ($template === NULL) {
555
			if ($defaultTemplateContent === NULL) {
556
557
				$templatePath =
					$registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];
558

559
560
				// only standard template file is considered since version 4.1
				$defaultTemplateFile = $templatePath . 'template.html';
Torsten Oppermann's avatar
Torsten Oppermann committed
561
562
				if (file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = file_get_contents($defaultTemplateFile);
563
				} else {
564
565
566
567
568
569
570
571
572
573
574
575
576
					// 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 {
						return FALSE;
					}
577
				}
578
			}
579

580
		} elseif (filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
581
			$this->setToAddresses(trim($template->getToAddress()));
582
583
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
584
585
		if ($isPreview) {
			$previewMarker = [];
586

587
			/** @var array $markerArray */
588
			$markerArray = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
Torsten Oppermann's avatar
Torsten Oppermann committed
589
			foreach ($markerArray as $marker) {
590
591
592
593
594
595
596
597
598
599
600
601
				$markerPath = GeneralUtility::trimExplode('.', $marker['marker']);
				$temporaryMarkerArray = [];
				foreach (array_reverse($markerPath) as $index => $markerPathSegment) {
					if ($index === 0) {
						if ($marker['backend_translation_key']) {
							$temporaryMarkerArray[$markerPathSegment] = LocalizationUtility::translate(
								$marker['backend_translation_key'], $marker['extension_key']
							);
						} else {
							$temporaryMarkerArray[$markerPathSegment] = $marker['value'];
						}
					} else {
602
						$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
603
					}
604
				}
605
				/** @noinspection SlowArrayOperationsInLoopInspection */
606
				$previewMarker = array_merge_recursive($previewMarker, $temporaryMarkerArray);
Torsten Oppermann's avatar
Torsten Oppermann committed
607
			}
608
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
609
610
611
			$this->setMarkers($previewMarker);
		}

612
		/** @var StandaloneView $emailView */
613
		$emailView = $this->objectManager->get(StandaloneView::class);
614
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
615
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
616

Paul Ilea's avatar
Paul Ilea committed
617
		if ($template !== NULL) {
618
619
620
			$emailView->setTemplateSource(\trim($template->getSubject()));
			$subject = $emailView->render();

621
622
			$emailView->setTemplateSource($template->getContent());
		} else {
623
			$subject = $registerService->getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
624
625
			if (\is_array($subject)) {
				$subject = \trim(
626
627
					$registerService->getRegisterArray()
					[$this->extensionKey][$this->templateName]['subject'][$this->language]
628
				);
629
			}
630
631
632
633
634
635
636
			if ($subject === NULL && $this->subject !== NULL) {
				$subject = $this->subject;
			}
			if ($subject !== NULL) {
				$emailView->setTemplateSource($subject);
				$subject = $emailView->render();
			}
637
			$emailView->setTemplateSource($defaultTemplateContent);
638
		}
639

Paul Ilea's avatar
Paul Ilea committed
640
		if ($this->subject !== '' && $this->subject !== NULL) {
641
642
643
			$subject = $this->subject;
		}

644
		$this->mailMessage->setSubject($subject);
645

646
647
648
649
650
651
		// 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);

		$currentTimestamp = 0;
652
		if ($this->ignoreMailQueue) {
653
			// @TODO arghh... why is this not sharing the code with sendMailFromQueue????
654
			$this->mailMessage->setBody($emailBody, 'text/html');
655
656
657
			$plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
			$plainTextBody = $plaintextService->makePlain($emailBody);
			$this->mailMessage->addPart($plainTextBody, 'text/plain');
658
			$this->mailMessage->send();
659
			$dateTime = new DateTime();
660
			$currentTimestamp = $dateTime->getTimestamp();
661
		}
662

663
664
665
666
667
		if (!$isPreview) {
			$this->addMailToMailQueue(
				$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
				$currentTimestamp, $currentTimestamp, $this->language, $siteRootId
			);
668
		}
669
670

		return TRUE;
671
672
673
	}

	/**
674
	 * Adds a new mail to the mail queue.
675
	 *
676
677
	 * @param string $extensionKey
	 * @param string $templateName
678
	 * @param string $subject
679
	 * @param string $emailBody
680
	 * @param int $sendingTime
681
	 * @param int $priority
682
	 * @param int $lastSendingTime
683
	 * @param string $language
684
	 * @param int $pid
685
686
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
687
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
688
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
689
	 */
690
	private function addMailToMailQueue(
691
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
692
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
693
	) {
694
		$mail = $this->objectManager->get(Mail::class);
695
		$mail->setPid($pid);
696
697
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
698
		$mail->setLanguage($language);
699
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
700

701
		$mail->setFromAddress($this->fromAddress);
702
		$mail->setFromName($this->fromName);
703

704
		$mail->setToAddress($this->toAddresses);
705
		$mail->setMailSubject($subject);
706
		$mail->setMailBody($emailBody);
707
		$mail->setPriority($priority);
708
709
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
710
		$mail->setSendingTime($sendingTime);
711
		$mail->setLastSendingTime($lastSendingTime);
712
		$mail->setReplyTo($this->replyToAddress);
713
714
715
716
717
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
718

719
		$mailRepository = $this->objectManager->get(MailRepository::class);
720
		$mailRepository->add($mail);
721
		$this->persistenceManager->persistAll();
722
	}
723

724
725
726
727
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
Paul Ilea's avatar
Paul Ilea committed
728
729
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
730
	 * @throws \Exception
731
732
733
734
	 */
	public function sendMailFromQueue($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
735
		$mailToSend = $mailRepository->findOneByUid($uid);
736

737
		if ($mailToSend && !$mailToSend->getBlacklisted()) {
738
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
739
740
741
			$plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
			$plaintextBody = $plaintextService->makePlain($mailToSend->getMailBody());
			$this->mailMessage->addPart($plaintextBody, 'text/plain');
742
743
744
745
746
747
			$toAddresses = trim($mailToSend->getToAddress());
			$addressesArray = GeneralUtility::trimExplode(',', $toAddresses, TRUE);
			if (\count($addressesArray) > 1) {
				$toAddresses = $addressesArray;
			}
			$this->mailMessage->setTo($toAddresses);
748
749
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
750

751
			if ($mailToSend->getBccAddresses()) {
752
753
754
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

755
			if ($mailToSend->getCcAddresses()) {
756
757
758
759
760
761
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

			if ($mailToSend->getReplyTo()) {
				$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
			}
762
763
764
765
766
767
768
769
770
771
772
773
			$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())
					);
				}
			}
774
			$dateTime = new DateTime();
775
776
777
			if ((int) $mailToSend->getSendingTime() === 0) {
				$mailToSend->setSendingTime($dateTime->getTimestamp());
			}
778
			$mailToSend->setLastSendingTime($dateTime->getTimestamp());
779
			$this->mailMessage->send();
780
			$mailRepository->update($mailToSend);
781
782
783
		}
	}

784
785
786
787
788
789
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
	private function loadTemplateValues($template) {
790
791
792
793
794
795
796
797
798
799
800
801
802
803
		$fromName = $template->getFromName();
		if ($fromName === '' && $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

		$fromMail = $template->getFromMail();
		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);
804
805
806
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
807
		$this->setFromName($fromName);
808
809
810
		$this->setReplyToAddress($template->getReplyTo());
	}

811
812
813
814
815
816
817
	/**
	 * Get all registered templates
	 *
	 * @return array
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \BadFunctionCallException
	 * @throws \InvalidArgumentException
818
	 * @deprecated since 4.7.0 will be removed in 5.0.0. Use the RegistrationService class instead
819
	 */
820
821
822
	public static function getRegisterArray(): array {
		// @TODO remove this deprecated function in version 5.0.0
		self::logDeprecation('registerExtensions');
823

824
		$registrationService = GeneralUtility::makeInstance(RegisterService::class);
825
		// write entries for old extensions into the file list
826
		self::registerExtensions();
827

828
		return $registrationService->getRegisterArray();
829
830
	}

831
832
833
834
835
	/**
	 * Iterate over all installed extensions and look for sg_mail configuration files
	 * If found, register the template(s)
	 *
	 * @throws \BadFunctionCallException
836
	 * @deprecated since 4.7.0 will be removed in 5.0.0. Use the RegistrationService class instead
837
	 */
838
	public static function registerExtensions() {
839
840
841
		// @TODO remove this deprecated function in version 5.0.0
		self::logDeprecation('registerExtensions');

842
843
844
		$extensionList = ExtensionManagementUtility::getLoadedExtensionListArray();
		foreach ($extensionList as $extensionName) {
			$extensionConfigDirectory = ExtensionManagementUtility::extPath($extensionName);
845
			$extensionConfigDirectory .= self::CONFIG_PATH;
846
847
848
			if (!\is_dir($extensionConfigDirectory)) {
				continue;
			}
849

850
851
852
853
854
			$configFiles = GeneralUtility::getFilesInDir($extensionConfigDirectory);
			foreach ($configFiles as $configFile) {
				$pathToRegistrationFile = $extensionConfigDirectory . '/' . $configFile;
				if (!\is_file($pathToRegistrationFile)) {
					continue;
Torsten Oppermann's avatar
Torsten Oppermann committed
855
				}
856
857

				$GLOBALS['sg_mail'][$extensionName][$configFile] = $pathToRegistrationFile;
858
859
			}
		}
860
	}
861

862
863
864
865
866
867
	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
868
	private function getAllMarker(array $markers): string {
869
870
871
		$allMarker = '';

		foreach ($markers as $key => $value) {
872
			if (\is_string($value)) {
873
				$allMarker .= $key . ': ' . $value . PHP_EOL;
874
			} elseif (\is_array($value)) {
875
				foreach ($value as $innerKey => $innerValue) {
Torsten Oppermann's avatar
Torsten Oppermann committed
876
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
877
				}
878
			} elseif (\is_bool($value)) {
Torsten Oppermann's avatar
Torsten Oppermann committed
879
880
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
881
882
883
884
			} elseif (\is_object($value)) {
				if (method_exists($value, '__toString')) {
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
885
886
887
888
889
			}
		}

		return $allMarker;
	}
890
891
892
893
894
895
896
897
898
899
900

	/**
	 * function to call a deprecation log entry (but only once per request / class)
	 *
	 * @param $function
	 */
	private static function logDeprecation($function) {
		GeneralUtility::deprecationLog(
			'The function ' . $function . ' is deprecated since version 4.7.0 and will be removed in version 5.0.0'
		);
	}
901
}