MailTemplateService.php 24.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
37
use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
38
use TYPO3\CMS\Core\Mail\MailMessage;
39
use TYPO3\CMS\Core\Resource\FileInterface;
40
use TYPO3\CMS\Core\Resource\ResourceFactory;
41
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
42
use TYPO3\CMS\Core\Utility\GeneralUtility;
43
use TYPO3\CMS\Extbase\Domain\Model\FileReference;
44
use TYPO3\CMS\Extbase\Object\ObjectManager;
45
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
46
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
47
use TYPO3\CMS\Fluid\View\StandaloneView;
48
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
49

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

63
	/**
64
	 * @var array $toAddresses
65
	 */
66
	private $toAddresses = [];
67
68

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

	/**
74
	 * @var array $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
	/**
	 * @var array $bccAddresses
	 */
Paul Ilea's avatar
Paul Ilea committed
121
	private $bccAddresses;
122

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

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

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

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

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

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

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

166
167
168
169
170
171
		/** @var ObjectManager objectManager */
		$this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
		/** @var MailMessage mailMessage */
		$this->mailMessage = $this->objectManager->get(MailMessage::class);
		/** @var TypoScriptSettingsService $typoScriptSettingsService */
		$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
Torsten Oppermann's avatar
Torsten Oppermann committed
172
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
173
174
175
176
		/** @var TemplateRepository templateRepository */
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		/** @var PersistenceManager persistenceManager */
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
177

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

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

191
		$this->mailMessage->setFrom($this->fromAddress);
192

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

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

208
		if (count($this->bccAddresses) > 0) {
209
210
211
			$this->mailMessage->setBcc($this->bccAddresses);
		}

212
		if (count($this->ccAddresses) > 0) {
213
214
			$this->mailMessage->setCc($this->ccAddresses);
		}
215
216
	}

217
218
219
220
221
222
223
224
225
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail') {
226
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246

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

247
	/**
248
	 * Send the Email
249
	 *
Torsten Oppermann's avatar
Torsten Oppermann committed
250
	 * @param boolean $isPreview
251
	 * @return boolean email was sent or added to mail queue successfully?
252
253
254
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
255
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
256
	 */
257
	public function sendEmail($isPreview = FALSE): bool {
258
259
260
261
262
263
264
265
		if (TYPO3_MODE === 'FE') {
			/** @var TypoScriptFrontendController $tsfe */
			$tsfe = $GLOBALS['TSFE'];
			$pageUid = $tsfe->id;
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

266
267
268
		if ($this->pid) {
			$pageUid = $this->pid;
		}
269
		$siteRootId = BackendService::getSiteRoot($pageUid);
270

271
		/** @var Template $template */
272
		$template = $this->templateRepository->findOneByTemplate(
273
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
274
		);
275

276
277
278
279
280
281
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

282
283
284
285
286
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
287
		$defaultTemplateContent = NULL;
288
289
		// If there is no template for this language, use the default template
		if ($template === NULL) {
290

291
			$templatePath = self::getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];
292

293
294
295
296
297
298
			// only standard template file is considered since version 4.1
			$defaultTemplateFile = $templatePath . 'template.html';
			if (file_exists($defaultTemplateFile)) {
				$defaultTemplateContent = file_get_contents($defaultTemplateFile);
			} else {
				return FALSE;
299
			}
300
		} elseif (filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
301
			$this->setToAddresses(trim($template->getToAddress()));
302
303
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
304
305
		if ($isPreview) {
			$previewMarker = [];
Paul Ilea's avatar
Paul Ilea committed
306
			/** @var array $markerArray */
307
			$markerArray = self::getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
Torsten Oppermann's avatar
Torsten Oppermann committed
308
			foreach ($markerArray as $marker) {
309
310
311
312
313
314
315
316
317
318
319
320
				$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 {
321
						$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
322
					}
323
				}
324
				$previewMarker = array_merge_recursive($previewMarker, $temporaryMarkerArray);
Torsten Oppermann's avatar
Torsten Oppermann committed
325
			}
326
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
327
328
329
			$this->setMarkers($previewMarker);
		}

330
		/** @var StandaloneView $emailView */
331
		$emailView = $this->objectManager->get(StandaloneView::class);
332
		$emailView->assignMultiple($this->markers);
333
		if (NULL === $defaultTemplateContent) {
334
335
336
			$emailView->setTemplateSource(\trim($template->getSubject()));
			$subject = $emailView->render();

337
338
			$emailView->setTemplateSource($template->getContent());
		} else {
339
			$subject = self::getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
340
341
			if (\is_array($subject)) {
				$subject = \trim(
342
343
					self::getRegisterArray()[$this->extensionKey][$this->templateName]['subject'][$this->language]
				);
344
			}
345
346
347
348
349
350
351
			if ($subject === NULL && $this->subject !== NULL) {
				$subject = $this->subject;
			}
			if ($subject !== NULL) {
				$emailView->setTemplateSource($subject);
				$subject = $emailView->render();
			}
352
			$emailView->setTemplateSource($defaultTemplateContent);
353
		}
354

Paul Ilea's avatar
Paul Ilea committed
355
		if ($this->subject !== '' && $this->subject !== NULL) {
356
357
358
			$subject = $this->subject;
		}

359
		$this->mailMessage->setSubject($subject);
360

361
		$emailBody = $emailView->render();
362

363
364
365
		// insert <br /> tags, but replace every instance of three or more successive breaks with just two.
		$emailBody = nl2br($emailBody);
		$emailBody = preg_replace('/(<br[\s]?[\/]?>[\s]*){3,}/', '<br /><br />', $emailBody);
366

367
368
369
		$isTemplateBlacklisted = self::isTemplateBlacklisted(
			$this->extensionKey, $this->templateName, $siteRootId
		);
370
		if ($this->ignoreMailQueue && !$isTemplateBlacklisted) {
371
			$this->mailMessage->setBody($emailBody, 'text/html');
372
373
374
            $plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
            $plainTextBody = $plaintextService->makePlain($emailBody);
            $this->mailMessage->addPart($plainTextBody, 'text/plain');
375
			$this->mailMessage->send();
376
			$dateTime = new DateTime();
377
			$currentTimestamp = $dateTime->getTimestamp();
378
379
380
381

			if (!$isPreview) {
				$this->addMailToMailQueue(
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
382
					$currentTimestamp, $currentTimestamp, $this->language, $siteRootId
383
384
				);
			}
385

386
		} else {
387
388
			if (!$isPreview) {
				$this->addMailToMailQueue(
389
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority, 0, 0,
390
391
392
					$this->language, $siteRootId
				);
			}
393
		}
394
395

		return TRUE;
396
397
398
	}

	/**
399
	 * Adds a new mail to the mail queue.
400
	 *
401
402
	 * @param string $extensionKey
	 * @param string $templateName
403
	 * @param string $subject
404
	 * @param string $emailBody
405
	 * @param int $sendingTime
406
	 * @param int $priority
407
	 * @param int $lastSendingTime
408
	 * @param string $language
409
	 * @param int $pid
410
411
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
412
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
413
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
414
	 */
415
	private function addMailToMailQueue(
416
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
417
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
418
	) {
419
		$mail = $this->objectManager->get(Mail::class);
420
		$mail->setPid($pid);
421
422
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
423
		$mail->setLanguage($language);
424
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
425

426
		$mail->setFromAddress($this->fromAddress);
427
		$mail->setFromName($this->fromName);
428

429
		$mail->setToAddress($this->toAddresses);
430
		$mail->setMailSubject($subject);
431
		$mail->setMailBody($emailBody);
432
		$mail->setPriority($priority);
433
434
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
435
		$mail->setSendingTime($sendingTime);
436
		$mail->setLastSendingTime($lastSendingTime);
437
		$mail->setReplyTo($this->replyToAddress);
438
439
440
441
442
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
443

444
		$mailRepository = $this->objectManager->get(MailRepository::class);
445
		$mailRepository->add($mail);
446
		$this->persistenceManager->persistAll();
447
	}
448

449
450
451
452
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
Paul Ilea's avatar
Paul Ilea committed
453
454
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
455
456
457
458
	 */
	public function sendMailFromQueue($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
459
		$mailToSend = $mailRepository->findOneByUid($uid);
460

461
		if ($mailToSend && !$mailToSend->getBlacklisted()) {
462
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
463
464
465
			$plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
			$plaintextBody = $plaintextService->makePlain($mailToSend->getMailBody());
			$this->mailMessage->addPart($plaintextBody, 'text/plain');
466
			$this->mailMessage->setTo(trim($mailToSend->getToAddress()));
467
468
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
469

470
			if ($mailToSend->getBccAddresses()) {
471
472
473
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

474
			if ($mailToSend->getCcAddresses()) {
475
476
477
478
479
480
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

			if ($mailToSend->getReplyTo()) {
				$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
			}
481
482
483
484
485
486
487
488
489
490
491
492
			$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())
					);
				}
			}
493
			$dateTime = new DateTime();
494
495
496
			if ((int)$mailToSend->getSendingTime() === 0) {
			    $mailToSend->setSendingTime($dateTime->getTimestamp());
            }
497
			$mailToSend->setLastSendingTime($dateTime->getTimestamp());
498
			$this->mailMessage->send();
499
			$mailRepository->update($mailToSend);
500
501
502
		}
	}

503
	/**
504
	 * @param string $toAddresses
505
506
	 * @return MailTemplateService
	 */
507
	public function setToAddresses($toAddresses) {
508
		$toAddresses = preg_replace('~\x{00a0}~siu', ' ', $toAddresses);
509
510
		$this->toAddresses = trim($toAddresses);
		$this->mailMessage->setTo(trim($toAddresses));
511
512
513
514
		return $this;
	}

	/**
515
	 * @param string $fromAddress
516
	 * @param string $fromName
517
518
	 * @return MailTemplateService
	 */
519
	public function setFromAddress($fromAddress, $fromName = '') {
520
521
522
523
524
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

525
526
527
528
		return $this;
	}

	/**
529
	 * @param string $ccAddresses
530
531
	 * @return MailTemplateService
	 */
532
	public function setCcAddresses($ccAddresses) {
533
534
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
535
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
536
537
		}

538
539
540
541
		return $this;
	}

	/**
542
	 * @param string $replyToAddress
543
544
	 * @return MailTemplateService
	 */
545
	public function setReplyToAddress($replyToAddress) {
546
547
548
549
550
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
		return $this;
	}

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

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

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

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

590
	/**
591
	 * @param array $markers
592
593
	 * @return MailTemplateService
	 */
594
595
	public function setMarkers(array $markers) {
		$this->markers = $markers;
596
597
		return $this;
	}
598
599

	/**
600
	 * @param string $bccAddresses
601
602
	 * @return MailTemplateService
	 */
603
	public function setBccAddresses($bccAddresses) {
604
605
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
606
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
607
608
		}

609
610
611
		return $this;
	}

612
613
614
615
616
617
618
619
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
620
621
622

	/**
	 * @param Swift_OutputByteStream $data
Paul Ilea's avatar
Paul Ilea committed
623
	 * @param string $filename
624
625
626
627
628
629
630
631
632
633
634
	 * @param string $contentType
	 * @return MailTemplateService
	 */
	public function addAttachment($data, $filename, $contentType) {
		$attachment = Swift_Attachment::newInstance()
			->setFilename($filename)
			->setContentType($contentType)
			->setBody($data);
		$this->mailMessage->attach($attachment);
		return $this;
	}
635

636
637
638
	/**
	 * Add a file resource as attachment
	 *
639
	 * @param FileInterface|FileReference $file
640
641
	 * @return MailTemplateService
	 */
642
643
644
645
	public function addFileResourceAttachment($file) {
		if ($file instanceof FileReference) {
			$file = $file->getOriginalResource()->getOriginalFile();
		}
646
647
648
649
650
651
652
653
654
655
656
657
		$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;
658
659
		$this->addAttachment($file->getContents(), $file->getName(), $file->getMimeType());
		return $this;
660
661
	}

662
663
664
665
666
667
668
	/**
	 * @return MailMessage
	 */
	public function getMailMessage() {
		return $this->mailMessage;
	}

669
670
671
672
673
674
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
	private function loadTemplateValues($template) {
675
676
677
678
679
680
681
682
683
684
685
686
687
688
		$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);
689
690
691
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
692
		$this->setFromName($fromName);
693
694
695
696
697
698
699
700
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
701
	}
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718

	/**
	 * 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;
719
720
721
			case self::MARKER_TYPE_FILE:
				LocalizationUtility::translate('backend.marker.type.file', 'sg_mail');
				break;
722
723
724
725
			default:
				LocalizationUtility::translate('backend.marker.type.mixed', 'sg_mail');
		}
	}
726
727
728
729
730
731
732
733
734
735
736

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

738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
	/**
	 * Get all registered templates
	 *
	 * @return array
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \BadFunctionCallException
	 * @throws \InvalidArgumentException
	 */
	public static function getRegisterArray() {
		/** @var CacheManager $cacheManager */
		$cacheManager = GeneralUtility::makeInstance(CacheManager::class);
		/** @var FrontendInterface $cache */
		$cache = $cacheManager->getCache(self::CACHE_NAME);
		$cacheId = md5('sg_mail');
		/** @var array entry */
		if (($entry = $cache->get($cacheId)) === FALSE) {
			$entry = self::registerExtensions();

			if ($entry === NULL) {
				$entry = [];
			}

			$cache->set($cacheId, $entry, [], self::CACHE_LIFETIME_IN_SECONDS);
		}

		return $entry;
	}

766
767
768
769
770
	/**
	 * Iterate over all installed extensions and look for sg_mail configuration files
	 * If found, register the template(s)
	 *
	 * @throws \BadFunctionCallException
771
	 * @return array
772
	 */
773
	public static function registerExtensions(): array {
774
		// clear registerArray
775
		$registerArray = [];
776
777
778
779
780
781
782
783
784
785

		$extensionList = ExtensionManagementUtility::getLoadedExtensionListArray();

		foreach ($extensionList as $extensionName) {
			$extensionConfigDirectory = ExtensionManagementUtility::extPath($extensionName);
			$extensionConfigDirectory .= '/Configuration/MailTemplates';
			$configFiles = GeneralUtility::getFilesInDir($extensionConfigDirectory);

			foreach ($configFiles as $configFile) {
				$configArray = (include $extensionConfigDirectory . '/' . $configFile);
786
787
788
789
790
791
792
793
794
795
796
797
798
				$extensionKey = $configArray['extension_key'];
				$templateKey = $configArray['template_key'];

				// transform template directory name: your_templates => YourTemplates/
				$templateDirectoryParts = GeneralUtility::trimExplode('_', $configArray['template_key']);
				$templateDirectory = '';
				foreach ($templateDirectoryParts as $part) {
					$templateDirectory .= ucfirst($part);
				}
				$templateDirectory .= '/';
				$templatePath = ExtensionManagementUtility::extPath(
						$extensionName
					) . self::DEFAULT_TEMPLATE_PATH . $templateDirectory;
799

800
801
802
				if ($configArray['template_path']) {
					$templatePath = $configArray['template_key'];
				}
803

804
805
806
807
808
809
810
811
812
813
814
815
816
				$description = $configArray['description'];
				$subject = $configArray['subject'];
				$marker = $configArray['markers'];

				$registerArray[$extensionKey][$templateKey] = [
					'templatePath' => $templatePath,
					'description' => $description,
					'marker' => $marker,
					'extension' => $extensionKey,
					'templateName' => $templateKey,
					'subject' => $subject
				];
			}
817
818
		}

819
		return $registerArray;
820
	}
821
822
823
824
825
826
827
828
829
830
831
832
833

	/**
	 * Checks if a template is blacklisted for a given siterootId
	 *
	 * @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 {
834
		$nonBlacklistedTemplates = BackendService::getNonBlacklistedTemplates($siteRootId);
835

836
837
		if ($nonBlacklistedTemplates[$extensionKey]) {
			return $nonBlacklistedTemplates[$extensionKey][$templateName] ? FALSE : TRUE;
838
839
840
841
		}

		return TRUE;
	}
842
843
844
845
846
847
848
849
850
851
852
853
854
855

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

	/**
	 * @param string $subject
	 */
	public function setSubject(string $subject) {
		$this->subject = $subject;
	}
856
}