MailTemplateService.php 26.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
	const REGISTER_FILE = 'Register.php';
	const CONFIG_PATH = 'Configuration/MailTemplates';
64

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

	/**
71
	 * @var string $fromAddress
72
	 */
73
	private $fromAddress;
74
75

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

	/**
81
	 * @var string $replyToAddress
82
	 */
83
	private $replyToAddress;
84
85

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

219
220
221
222
223
224
225
226
227
	/**
	 * 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') {
228
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248

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

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

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

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

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

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

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

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

295
296
297
298
299
300
			// 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;
301
			}
302
		} elseif (filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
303
			$this->setToAddresses(trim($template->getToAddress()));
304
305
		}

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

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

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

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

361
		$this->mailMessage->setSubject($subject);
362

363
		$emailBody = $emailView->render();
364

365
366
367
		// 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);
368

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

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

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

		return TRUE;
398
399
400
	}

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

428
		$mail->setFromAddress($this->fromAddress);
429
		$mail->setFromName($this->fromName);
430

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

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

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

463
		if ($mailToSend && !$mailToSend->getBlacklisted()) {
464
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
465
466
467
			$plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
			$plaintextBody = $plaintextService->makePlain($mailToSend->getMailBody());
			$this->mailMessage->addPart($plaintextBody, 'text/plain');
468
469
470
471
472
473
			$toAddresses = trim($mailToSend->getToAddress());
			$addressesArray = GeneralUtility::trimExplode(',', $toAddresses, TRUE);
			if (\count($addressesArray) > 1) {
				$toAddresses = $addressesArray;
			}
			$this->mailMessage->setTo($toAddresses);
474
475
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
476

477
			if ($mailToSend->getBccAddresses()) {
478
479
480
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

481
			if ($mailToSend->getCcAddresses()) {
482
483
484
485
486
487
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

			if ($mailToSend->getReplyTo()) {
				$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
			}
488
489
490
491
492
493
494
495
496
497
498
499
			$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())
					);
				}
			}
500
			$dateTime = new DateTime();
501
502
503
			if ((int) $mailToSend->getSendingTime() === 0) {
				$mailToSend->setSendingTime($dateTime->getTimestamp());
			}
504
			$mailToSend->setLastSendingTime($dateTime->getTimestamp());
505
			$this->mailMessage->send();
506
			$mailRepository->update($mailToSend);
507
508
509
		}
	}

510
	/**
511
	 * @param string $toAddresses
512
513
	 * @return MailTemplateService
	 */
514
	public function setToAddresses($toAddresses) {
515
516
517
518
519
520
521
522
		$toAddresses = trim(preg_replace('~\x{00a0}~siu', ' ', $toAddresses));
		$this->toAddresses = $toAddresses;

		$addressesArray = GeneralUtility::trimExplode(',', $toAddresses, TRUE);
		if (\count($addressesArray) > 1) {
			$toAddresses = $addressesArray;
		}
		$this->mailMessage->setTo($toAddresses);
523
524
525
526
		return $this;
	}

	/**
527
	 * @param string $fromAddress
528
	 * @param string $fromName
529
530
	 * @return MailTemplateService
	 */
531
	public function setFromAddress($fromAddress, $fromName = '') {
532
533
534
535
536
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

537
538
539
540
		return $this;
	}

	/**
541
	 * @param string $ccAddresses
542
543
	 * @return MailTemplateService
	 */
544
	public function setCcAddresses($ccAddresses) {
545
546
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
547
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
548
549
		}

550
551
552
553
		return $this;
	}

	/**
554
	 * @param string $replyToAddress
555
556
	 * @return MailTemplateService
	 */
557
	public function setReplyToAddress($replyToAddress) {
558
559
560
561
562
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

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
590
591
592
593
594
595
596
597
598
599
600
601
		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;
	}

602
	/**
603
	 * @param array $markers
604
605
	 * @return MailTemplateService
	 */
606
607
	public function setMarkers(array $markers) {
		$this->markers = $markers;
608
609
		return $this;
	}
610
611

	/**
612
	 * @param string $bccAddresses
613
614
	 * @return MailTemplateService
	 */
615
	public function setBccAddresses($bccAddresses) {
616
617
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
618
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
619
620
		}

621
622
623
		return $this;
	}

624
625
626
627
628
629
630
631
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
632
633
634

	/**
	 * @param Swift_OutputByteStream $data
Paul Ilea's avatar
Paul Ilea committed
635
	 * @param string $filename
636
637
638
639
640
641
642
643
644
645
646
	 * @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;
	}
647

648
649
650
	/**
	 * Add a file resource as attachment
	 *
651
	 * @param FileInterface|FileReference $file
652
653
	 * @return MailTemplateService
	 */
654
655
656
657
	public function addFileResourceAttachment($file) {
		if ($file instanceof FileReference) {
			$file = $file->getOriginalResource()->getOriginalFile();
		}
658
659
660
661
662
663
664
665
666
667
668
669
		$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;
670
671
		$this->addAttachment($file->getContents(), $file->getName(), $file->getMimeType());
		return $this;
672
673
	}

674
675
676
677
678
679
680
	/**
	 * @return MailMessage
	 */
	public function getMailMessage() {
		return $this->mailMessage;
	}

681
682
683
684
685
686
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
	private function loadTemplateValues($template) {
687
688
689
690
691
692
693
694
695
696
697
698
699
700
		$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);
701
702
703
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
704
		$this->setFromName($fromName);
705
706
707
708
709
710
711
712
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
713
	}
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730

	/**
	 * 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;
731
732
733
			case self::MARKER_TYPE_FILE:
				LocalizationUtility::translate('backend.marker.type.file', 'sg_mail');
				break;
734
735
736
737
			default:
				LocalizationUtility::translate('backend.marker.type.mixed', 'sg_mail');
		}
	}
738
739
740
741
742
743
744
745
746
747
748

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

750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
	/**
	 * 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;
	}

778
779
780
781
782
	/**
	 * Iterate over all installed extensions and look for sg_mail configuration files
	 * If found, register the template(s)
	 *
	 * @throws \BadFunctionCallException
783
	 * @return array
784
	 */
785
	public static function registerExtensions(): array {
786
		// clear registerArray
787
		$registerArray = [];
788
789
790
791
792

		$extensionList = ExtensionManagementUtility::getLoadedExtensionListArray();

		foreach ($extensionList as $extensionName) {
			$extensionConfigDirectory = ExtensionManagementUtility::extPath($extensionName);
793
			$extensionConfigDirectory .= '/' . self::CONFIG_PATH;
794
795
796
797
			$configFiles = GeneralUtility::getFilesInDir($extensionConfigDirectory);

			foreach ($configFiles as $configFile) {
				$configArray = (include $extensionConfigDirectory . '/' . $configFile);
798
799
800
				$extensionKey = $configArray['extension_key'];
				$templateKey = $configArray['template_key'];

801
802
				if ($extensionKey === NULL || $templateKey === NULL) {
					continue;
803
				}
804

805
806
807
808
809
				$registerArray = self::writeRegisterArrayEntry(
					$registerArray, $extensionName, $extensionKey, $templateKey, $configArray
				);
			}
		}
810

811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
		//  now check for registration files with multiple templates registered
		$registerArray = self::registerFromSingleFile($registerArray);
		return $registerArray;
	}

	/**
	 * Find Register.php files in all installed extensions and register the templates
	 * These files can contain multiple template registrations and are structured as multi-dimensional arrays
	 *
	 * @param array $registerArray
	 * @return array
	 */
	private static function registerFromSingleFile(array $registerArray) {
		$extensionList = ExtensionManagementUtility::getLoadedExtensionListArray();

		foreach ($extensionList as $extension) {
			$extensionConfigDirectory = ExtensionManagementUtility::extPath($extension);
			$extensionConfigDirectory .= self::CONFIG_PATH;

830
			if (!\is_file($extensionConfigDirectory . '/' . self::REGISTER_FILE)) {
831
				continue;
832
			}
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872

			$configArray = (include $extensionConfigDirectory . '/' . self::REGISTER_FILE);

			if ($configArray) {
				foreach ($configArray as $config) {
					$registerArray = self::writeRegisterArrayEntry($registerArray, $config['extension_key'], $config['extension_key'], $config['template_key'], $config);
				}
			}

		}

		return $registerArray;
	}

	/**
	 * writes a single entry into the register array
	 *
	 * @param array $registerArray
	 * @param string $extensionName
	 * @param string $extensionKey
	 * @param string $templateKey
	 * @param array $configArray
	 * @return array
	 */
	private static function writeRegisterArrayEntry(
		array $registerArray, $extensionName, $extensionKey, $templateKey, array $configArray
	) {
		// 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;

		if ($configArray['template_path']) {
			$templatePath = $configArray['template_key'];
873
874
		}

875
876
877
878
879
880
881
882
883
884
885
886
887
		$description = $configArray['description'];
		$subject = $configArray['subject'];
		$marker = $configArray['markers'];

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

888
		return $registerArray;
889
	}
890
891
892
893
894
895
896
897
898
899
900
901
902

	/**
	 * 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 {
903
		$nonBlacklistedTemplates = BackendService::getNonBlacklistedTemplates($siteRootId);
904

905
906
		if ($nonBlacklistedTemplates[$extensionKey]) {
			return $nonBlacklistedTemplates[$extensionKey][$templateName] ? FALSE : TRUE;
907
908
909
910
		}

		return TRUE;
	}
911
912
913
914
915
916
917
918
919
920
921
922
923
924

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

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