MailTemplateService.php 27.2 KB
Newer Older
1
2
3
4
<?php

namespace SGalinski\SgMail\Service;

5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/***************************************************************
 *  Copyright notice
 *
 *  (c) sgalinski Internet Services (https://www.sgalinski.de)
 *
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
28

29
use DateTime;
30
31
32
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
use SGalinski\SgMail\Domain\Repository\MailRepository;
33
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
34
35
use Swift_Attachment;
use Swift_OutputByteStream;
36
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
			// only standard template file is considered since version 4.1
			$defaultTemplateFile = $templatePath . 'template.html';
			if (file_exists($defaultTemplateFile)) {
				$defaultTemplateContent = file_get_contents($defaultTemplateFile);
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
300
301
302
303
				// use configured default html template
				$defaultTemplateFile = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultHtmlTemplate'];
				if (file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = file_get_contents($defaultTemplateFile);
304
				} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
305
					return FALSE;
306
				}
307
			}
308
		} elseif (filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
309
			$this->setToAddresses(trim($template->getToAddress()));
310
311
		}

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

338
		/** @var StandaloneView $emailView */
339
		$emailView = $this->objectManager->get(StandaloneView::class);
340
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
341
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
342

343
		if (NULL === $defaultTemplateContent) {
344
345
346
			$emailView->setTemplateSource(\trim($template->getSubject()));
			$subject = $emailView->render();

347
348
			$emailView->setTemplateSource($template->getContent());
		} else {
349
			$subject = self::getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
350
351
			if (\is_array($subject)) {
				$subject = \trim(
352
353
					self::getRegisterArray()[$this->extensionKey][$this->templateName]['subject'][$this->language]
				);
354
			}
355
356
357
358
359
360
361
			if ($subject === NULL && $this->subject !== NULL) {
				$subject = $this->subject;
			}
			if ($subject !== NULL) {
				$emailView->setTemplateSource($subject);
				$subject = $emailView->render();
			}
362
			$emailView->setTemplateSource($defaultTemplateContent);
363
		}
364

Paul Ilea's avatar
Paul Ilea committed
365
		if ($this->subject !== '' && $this->subject !== NULL) {
366
367
368
			$subject = $this->subject;
		}

369
		$this->mailMessage->setSubject($subject);
370

371
		$emailBody = $emailView->render();
372

373
374
375
		// 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);
376

377
378
379
		$isTemplateBlacklisted = self::isTemplateBlacklisted(
			$this->extensionKey, $this->templateName, $siteRootId
		);
380
		if ($this->ignoreMailQueue && !$isTemplateBlacklisted) {
381
			$this->mailMessage->setBody($emailBody, 'text/html');
382
383
384
			$plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
			$plainTextBody = $plaintextService->makePlain($emailBody);
			$this->mailMessage->addPart($plainTextBody, 'text/plain');
385
			$this->mailMessage->send();
386
			$dateTime = new DateTime();
387
			$currentTimestamp = $dateTime->getTimestamp();
388
389
390
391

			if (!$isPreview) {
				$this->addMailToMailQueue(
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
392
					$currentTimestamp, $currentTimestamp, $this->language, $siteRootId
393
394
				);
			}
395

396
		} else {
397
398
			if (!$isPreview) {
				$this->addMailToMailQueue(
399
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority, 0, 0,
400
401
402
					$this->language, $siteRootId
				);
			}
403
		}
404
405

		return TRUE;
406
407
408
	}

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

436
		$mail->setFromAddress($this->fromAddress);
437
		$mail->setFromName($this->fromName);
438

439
		$mail->setToAddress($this->toAddresses);
440
		$mail->setMailSubject($subject);
441
		$mail->setMailBody($emailBody);
442
		$mail->setPriority($priority);
443
444
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
445
		$mail->setSendingTime($sendingTime);
446
		$mail->setLastSendingTime($lastSendingTime);
447
		$mail->setReplyTo($this->replyToAddress);
448
449
450
451
452
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
453

454
		$mailRepository = $this->objectManager->get(MailRepository::class);
455
		$mailRepository->add($mail);
456
		$this->persistenceManager->persistAll();
457
	}
458

459
460
461
462
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
Paul Ilea's avatar
Paul Ilea committed
463
464
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
465
466
467
468
	 */
	public function sendMailFromQueue($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
469
		$mailToSend = $mailRepository->findOneByUid($uid);
470

471
		if ($mailToSend && !$mailToSend->getBlacklisted()) {
472
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
473
474
475
			$plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
			$plaintextBody = $plaintextService->makePlain($mailToSend->getMailBody());
			$this->mailMessage->addPart($plaintextBody, 'text/plain');
476
477
478
479
480
481
			$toAddresses = trim($mailToSend->getToAddress());
			$addressesArray = GeneralUtility::trimExplode(',', $toAddresses, TRUE);
			if (\count($addressesArray) > 1) {
				$toAddresses = $addressesArray;
			}
			$this->mailMessage->setTo($toAddresses);
482
483
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
484

485
			if ($mailToSend->getBccAddresses()) {
486
487
488
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

489
			if ($mailToSend->getCcAddresses()) {
490
491
492
493
494
495
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

			if ($mailToSend->getReplyTo()) {
				$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
			}
496
497
498
499
500
501
502
503
504
505
506
507
			$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())
					);
				}
			}
508
			$dateTime = new DateTime();
509
510
511
			if ((int) $mailToSend->getSendingTime() === 0) {
				$mailToSend->setSendingTime($dateTime->getTimestamp());
			}
512
			$mailToSend->setLastSendingTime($dateTime->getTimestamp());
513
			$this->mailMessage->send();
514
			$mailRepository->update($mailToSend);
515
516
517
		}
	}

518
	/**
519
	 * @param string $toAddresses
520
521
	 * @return MailTemplateService
	 */
522
	public function setToAddresses($toAddresses) {
523
524
525
526
527
528
529
530
		$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);
531
532
533
534
		return $this;
	}

	/**
535
	 * @param string $fromAddress
536
	 * @param string $fromName
537
538
	 * @return MailTemplateService
	 */
539
	public function setFromAddress($fromAddress, $fromName = '') {
540
541
542
543
544
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

545
546
547
548
		return $this;
	}

	/**
549
	 * @param string $ccAddresses
550
551
	 * @return MailTemplateService
	 */
552
	public function setCcAddresses($ccAddresses) {
553
554
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
555
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
556
557
		}

558
559
560
561
		return $this;
	}

	/**
562
	 * @param string $replyToAddress
563
564
	 * @return MailTemplateService
	 */
565
	public function setReplyToAddress($replyToAddress) {
566
567
568
569
570
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

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
602
603
604
605
606
607
608
609
		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;
	}

610
	/**
611
	 * @param array $markers
612
613
	 * @return MailTemplateService
	 */
614
615
	public function setMarkers(array $markers) {
		$this->markers = $markers;
616
617
		return $this;
	}
618
619

	/**
620
	 * @param string $bccAddresses
621
622
	 * @return MailTemplateService
	 */
623
	public function setBccAddresses($bccAddresses) {
624
625
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
626
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
627
628
		}

629
630
631
		return $this;
	}

632
633
634
635
636
637
638
639
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
640
641
642

	/**
	 * @param Swift_OutputByteStream $data
Paul Ilea's avatar
Paul Ilea committed
643
	 * @param string $filename
644
645
646
647
648
649
650
651
652
653
654
	 * @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;
	}
655

656
657
658
	/**
	 * Add a file resource as attachment
	 *
659
	 * @param FileInterface|FileReference $file
660
661
	 * @return MailTemplateService
	 */
662
663
664
665
	public function addFileResourceAttachment($file) {
		if ($file instanceof FileReference) {
			$file = $file->getOriginalResource()->getOriginalFile();
		}
666
667
668
669
670
671
672
673
674
675
676
677
		$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;
678
679
		$this->addAttachment($file->getContents(), $file->getName(), $file->getMimeType());
		return $this;
680
681
	}

682
683
684
685
686
687
688
	/**
	 * @return MailMessage
	 */
	public function getMailMessage() {
		return $this->mailMessage;
	}

689
690
691
692
693
694
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
	private function loadTemplateValues($template) {
695
696
697
698
699
700
701
702
703
704
705
706
707
708
		$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);
709
710
711
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
712
		$this->setFromName($fromName);
713
714
715
716
717
718
719
720
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
721
	}
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738

	/**
	 * 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;
739
740
741
			case self::MARKER_TYPE_FILE:
				LocalizationUtility::translate('backend.marker.type.file', 'sg_mail');
				break;
742
743
744
745
			default:
				LocalizationUtility::translate('backend.marker.type.mixed', 'sg_mail');
		}
	}
746
747
748
749
750
751
752
753
754
755
756

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

758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
	/**
	 * 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;
	}

786
787
788
789
790
	/**
	 * Iterate over all installed extensions and look for sg_mail configuration files
	 * If found, register the template(s)
	 *
	 * @throws \BadFunctionCallException
791
	 * @return array
792
	 */
793
	public static function registerExtensions(): array {
794
		// clear registerArray
795
		$registerArray = [];
796
797
798
799
800

		$extensionList = ExtensionManagementUtility::getLoadedExtensionListArray();

		foreach ($extensionList as $extensionName) {
			$extensionConfigDirectory = ExtensionManagementUtility::extPath($extensionName);
801
			$extensionConfigDirectory .= self::CONFIG_PATH;
802
803
804
805
			$configFiles = GeneralUtility::getFilesInDir($extensionConfigDirectory);

			foreach ($configFiles as $configFile) {
				$configArray = (include $extensionConfigDirectory . '/' . $configFile);
806
807
808
				$extensionKey = $configArray['extension_key'];
				$templateKey = $configArray['template_key'];

809
810
				if ($extensionKey === NULL || $templateKey === NULL) {
					continue;
811
				}
812

813
				$registerArray = self::writeRegisterArrayEntry(
814
					$registerArray, $extensionKey, $templateKey, $configArray
815
816
817
				);
			}
		}
818

819
820
821
822
823
824
825
826
827
828
		return $registerArray;
	}

	/**
	 * writes a single entry into the register array
	 *
	 * @param array $registerArray
	 * @param string $extensionKey
	 * @param string $templateKey
	 * @param array $configArray
829
830
	 * @param bool $transformTemplateFolder
	 * @param string $storeTemplateExtension
831
832
833
	 * @return array
	 */
	private static function writeRegisterArrayEntry(
834
		array $registerArray, $extensionKey, $templateKey, array $configArray,
835
		$transformTemplateFolder = TRUE, $storeTemplateExtension = ''
836
	) {
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
		// If it is not explicitly set in which extension the html should be located, use the extension set in the template settings
		if ($storeTemplateExtension === '') {
			$storeTemplateExtension = $extensionKey;
		}

		// give the option to use the template key as folder name. this is used mainly with auto registering
		$templateDirectory = $templateKey;

		// by default folders with underscore will be transformed to upper camelcase
		if ($transformTemplateFolder) {
			// transform template directory name: your_templates => YourTemplates/
			$templateDirectoryParts = GeneralUtility::trimExplode('_', $templateKey);
			$templateDirectory = '';
			foreach ($templateDirectoryParts as $part) {
				$templateDirectory .= ucfirst($part);
			}
853
		}
854

855
		$templateDirectory .= '/';
Torsten Oppermann's avatar
Torsten Oppermann committed
856
857
		$templatePath = ExtensionManagementUtility::extPath($storeTemplateExtension) . self::DEFAULT_TEMPLATE_PATH
			. $templateDirectory;
858
859

		if ($configArray['template_path']) {
860
			$templatePath = $configArray[$templateKey];
861
862
		}

863
864
865
866
867
868
869
870
871
872
		$description = $configArray['description'];
		$subject = $configArray['subject'];
		$marker = $configArray['markers'];

		$registerArray[$extensionKey][$templateKey] = [
			'templatePath' => $templatePath,
			'description' => $description,
			'marker' => $marker,
			'extension' => $extensionKey,
			'templateName' => $templateKey,
Torsten Oppermann's avatar
Torsten Oppermann committed
873
			'subject' => $subject
874
875
		];

876
		return $registerArray;
877
	}
878
879
880
881
882
883
884
885
886
887
888
889
890

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

893
894
		if ($nonBlacklistedTemplates[$extensionKey]) {
			return $nonBlacklistedTemplates[$extensionKey][$templateName] ? FALSE : TRUE;
895
896
897
898
		}

		return TRUE;
	}
899
900
901
902
903
904
905
906
907
908
909
910
911
912

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

	/**
	 * @param string $subject
	 */
	public function setSubject(string $subject) {
		$this->subject = $subject;
	}
913
914
915
916
917
918
919

	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
920
	private function getAllMarker(array $markers): string {
921
922
923
		$allMarker = '';

		foreach ($markers as $key => $value) {
924
			if (\is_string($value)) {
925
				$allMarker .= $key . ': ' . $value . PHP_EOL;
926
			} elseif (\is_array($value)) {
927
				foreach ($value as $innerKey => $innerValue) {
Torsten Oppermann's avatar
Torsten Oppermann committed
928
					$allMarker .= $innerKey . ': ' . $innerValue . PHP_EOL;
929
				}
930
			} elseif (\is_bool($value)) {
Torsten Oppermann's avatar
Torsten Oppermann committed
931
932
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
933
934
935
936
			} elseif (\is_object($value)) {
				if (method_exists($value, '__toString')) {
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
937
938
939
940
941
			}
		}

		return $allMarker;
	}
942
}