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

namespace SGalinski\SgMail\Service;

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

29
use DateTime;
30
31
32
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
use SGalinski\SgMail\Domain\Repository\MailRepository;
33
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
34
35
use Swift_Attachment;
use Swift_OutputByteStream;
36
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
use TYPO3\CMS\Frontend\Page\PageRepository;
50

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

269
		if ($this->pid) {
270
271
272
273
274
275
276
277
278
279
			$pageUid = (int) $this->pid;
		}
		if ($pageUid === 0) {
			$pageRepository = $this->objectManager->get(PageRepository::class);
			$rootPageRows = $pageRepository->getRecordsByField(
				'pages', 'is_siteroot', 1, 'hidden = 0', '', 'sorting', 1
			);
			if ($rootPageRows && \count($rootPageRows)) {
				$pageUid = (int) $rootPageRows[0]['uid'];
			}
280
		}
281
		$siteRootId = BackendService::getSiteRoot($pageUid);
282

283
		/** @var Template $template */
284
		$template = $this->templateRepository->findOneByTemplate(
285
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
286
		);
287

288
289
290
291
292
293
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

294
295
296
297
298
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
299
		$defaultTemplateContent = NULL;
300
301
		// If there is no template for this language, use the default template
		if ($template === NULL) {
302

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

305
306
307
308
309
			// 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
310
311
312
313
				// use configured default html template
				$defaultTemplateFile = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultHtmlTemplate'];
				if (file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = file_get_contents($defaultTemplateFile);
314
				} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
315
					return FALSE;
316
				}
317
			}
318
		} elseif (filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
319
			$this->setToAddresses(trim($template->getToAddress()));
320
321
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
322
323
		if ($isPreview) {
			$previewMarker = [];
Paul Ilea's avatar
Paul Ilea committed
324
			/** @var array $markerArray */
325
			$markerArray = self::getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
Torsten Oppermann's avatar
Torsten Oppermann committed
326
			foreach ($markerArray as $marker) {
327
328
329
330
331
332
333
334
335
336
337
338
				$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 {
339
						$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
340
					}
341
				}
342
				$previewMarker = array_merge_recursive($previewMarker, $temporaryMarkerArray);
Torsten Oppermann's avatar
Torsten Oppermann committed
343
			}
344
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
345
346
347
			$this->setMarkers($previewMarker);
		}

348
		/** @var StandaloneView $emailView */
349
		$emailView = $this->objectManager->get(StandaloneView::class);
350
		$emailView->assignMultiple($this->markers);
Torsten Oppermann's avatar
Torsten Oppermann committed
351
		$emailView->assign('all_fields', $this->getAllMarker($this->markers));
352

353
		if (NULL === $defaultTemplateContent) {
354
355
356
			$emailView->setTemplateSource(\trim($template->getSubject()));
			$subject = $emailView->render();

357
358
			$emailView->setTemplateSource($template->getContent());
		} else {
359
			$subject = self::getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
360
361
			if (\is_array($subject)) {
				$subject = \trim(
362
363
					self::getRegisterArray()[$this->extensionKey][$this->templateName]['subject'][$this->language]
				);
364
			}
365
366
367
368
369
370
371
			if ($subject === NULL && $this->subject !== NULL) {
				$subject = $this->subject;
			}
			if ($subject !== NULL) {
				$emailView->setTemplateSource($subject);
				$subject = $emailView->render();
			}
372
			$emailView->setTemplateSource($defaultTemplateContent);
373
		}
374

Paul Ilea's avatar
Paul Ilea committed
375
		if ($this->subject !== '' && $this->subject !== NULL) {
376
377
378
			$subject = $this->subject;
		}

379
		$this->mailMessage->setSubject($subject);
380

381
		$emailBody = $emailView->render();
382

383
384
385
		// 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);
386

387
388
389
		$isTemplateBlacklisted = self::isTemplateBlacklisted(
			$this->extensionKey, $this->templateName, $siteRootId
		);
390
		if ($this->ignoreMailQueue && !$isTemplateBlacklisted) {
391
			$this->mailMessage->setBody($emailBody, 'text/html');
392
393
394
			$plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
			$plainTextBody = $plaintextService->makePlain($emailBody);
			$this->mailMessage->addPart($plainTextBody, 'text/plain');
395
			$this->mailMessage->send();
396
			$dateTime = new DateTime();
397
			$currentTimestamp = $dateTime->getTimestamp();
398
399
400
401

			if (!$isPreview) {
				$this->addMailToMailQueue(
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
402
					$currentTimestamp, $currentTimestamp, $this->language, $siteRootId
403
404
				);
			}
405

406
		} else {
407
408
			if (!$isPreview) {
				$this->addMailToMailQueue(
409
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority, 0, 0,
410
411
412
					$this->language, $siteRootId
				);
			}
413
		}
414
415

		return TRUE;
416
417
418
	}

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

446
		$mail->setFromAddress($this->fromAddress);
447
		$mail->setFromName($this->fromName);
448

449
		$mail->setToAddress($this->toAddresses);
450
		$mail->setMailSubject($subject);
451
		$mail->setMailBody($emailBody);
452
		$mail->setPriority($priority);
453
454
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
455
		$mail->setSendingTime($sendingTime);
456
		$mail->setLastSendingTime($lastSendingTime);
457
		$mail->setReplyTo($this->replyToAddress);
458
459
460
461
462
		foreach ($this->markers as $marker) {
			if ($marker instanceof FileReference) {
				$mail->addAttachment($marker);
			}
		}
463

464
		$mailRepository = $this->objectManager->get(MailRepository::class);
465
		$mailRepository->add($mail);
466
		$this->persistenceManager->persistAll();
467
	}
468

469
470
471
472
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
Paul Ilea's avatar
Paul Ilea committed
473
474
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
475
476
477
478
	 */
	public function sendMailFromQueue($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
479
		$mailToSend = $mailRepository->findOneByUid($uid);
480

481
		if ($mailToSend && !$mailToSend->getBlacklisted()) {
482
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
483
484
485
			$plaintextService = GeneralUtility::makeInstance(PlaintextService::class);
			$plaintextBody = $plaintextService->makePlain($mailToSend->getMailBody());
			$this->mailMessage->addPart($plaintextBody, 'text/plain');
486
487
488
489
490
491
			$toAddresses = trim($mailToSend->getToAddress());
			$addressesArray = GeneralUtility::trimExplode(',', $toAddresses, TRUE);
			if (\count($addressesArray) > 1) {
				$toAddresses = $addressesArray;
			}
			$this->mailMessage->setTo($toAddresses);
492
493
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
494

495
			if ($mailToSend->getBccAddresses()) {
496
497
498
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

499
			if ($mailToSend->getCcAddresses()) {
500
501
502
503
504
505
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

			if ($mailToSend->getReplyTo()) {
				$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
			}
506
507
508
509
510
511
512
513
514
515
516
517
			$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())
					);
				}
			}
518
			$dateTime = new DateTime();
519
520
521
			if ((int) $mailToSend->getSendingTime() === 0) {
				$mailToSend->setSendingTime($dateTime->getTimestamp());
			}
522
			$mailToSend->setLastSendingTime($dateTime->getTimestamp());
523
			$this->mailMessage->send();
524
			$mailRepository->update($mailToSend);
525
526
527
		}
	}

528
	/**
529
	 * @param string $toAddresses
530
531
	 * @return MailTemplateService
	 */
532
	public function setToAddresses($toAddresses) {
533
534
535
536
537
538
539
540
		$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);
541
542
543
544
		return $this;
	}

	/**
545
	 * @param string $fromAddress
546
	 * @param string $fromName
547
548
	 * @return MailTemplateService
	 */
549
	public function setFromAddress($fromAddress, $fromName = '') {
550
551
552
553
554
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

555
556
557
558
		return $this;
	}

	/**
559
	 * @param string $ccAddresses
560
561
	 * @return MailTemplateService
	 */
562
	public function setCcAddresses($ccAddresses) {
563
564
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
565
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
566
567
		}

568
569
570
571
		return $this;
	}

	/**
572
	 * @param string $replyToAddress
573
574
	 * @return MailTemplateService
	 */
575
	public function setReplyToAddress($replyToAddress) {
576
577
578
579
580
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

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
610
611
612
613
614
615
616
617
618
619
		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;
	}

620
	/**
621
	 * @param array $markers
622
623
	 * @return MailTemplateService
	 */
624
625
	public function setMarkers(array $markers) {
		$this->markers = $markers;
626
627
		return $this;
	}
628
629

	/**
630
	 * @param string $bccAddresses
631
632
	 * @return MailTemplateService
	 */
633
	public function setBccAddresses($bccAddresses) {
634
635
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
636
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
637
638
		}

639
640
641
		return $this;
	}

642
643
644
645
646
647
648
649
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
650
651
652

	/**
	 * @param Swift_OutputByteStream $data
Paul Ilea's avatar
Paul Ilea committed
653
	 * @param string $filename
654
655
656
657
658
659
660
661
662
663
664
	 * @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;
	}
665

666
667
668
	/**
	 * Add a file resource as attachment
	 *
669
	 * @param FileInterface|FileReference $file
670
671
	 * @return MailTemplateService
	 */
672
673
674
675
	public function addFileResourceAttachment($file) {
		if ($file instanceof FileReference) {
			$file = $file->getOriginalResource()->getOriginalFile();
		}
676
677
678
679
680
681
682
683
684
685
686
687
		$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;
688
689
		$this->addAttachment($file->getContents(), $file->getName(), $file->getMimeType());
		return $this;
690
691
	}

692
693
694
695
696
697
698
	/**
	 * @return MailMessage
	 */
	public function getMailMessage() {
		return $this->mailMessage;
	}

699
700
701
702
703
704
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
	private function loadTemplateValues($template) {
705
706
707
708
709
710
711
712
713
714
715
716
717
718
		$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);
719
720
721
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
722
		$this->setFromName($fromName);
723
724
725
726
727
728
729
730
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
731
	}
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748

	/**
	 * 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;
749
750
751
			case self::MARKER_TYPE_FILE:
				LocalizationUtility::translate('backend.marker.type.file', 'sg_mail');
				break;
752
753
754
755
			default:
				LocalizationUtility::translate('backend.marker.type.mixed', 'sg_mail');
		}
	}
756
757
758
759
760
761
762
763
764
765
766

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

768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
	/**
	 * 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;
	}

796
797
798
799
800
	/**
	 * Iterate over all installed extensions and look for sg_mail configuration files
	 * If found, register the template(s)
	 *
	 * @throws \BadFunctionCallException
801
	 * @return array
802
	 */
803
	public static function registerExtensions(): array {
804
		// clear registerArray
805
		$registerArray = [];
806
807
808
809
810

		$extensionList = ExtensionManagementUtility::getLoadedExtensionListArray();

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

Torsten Oppermann's avatar
Torsten Oppermann committed
813
814
			if (\is_dir($extensionConfigDirectory)) {
				$configFiles = GeneralUtility::getFilesInDir($extensionConfigDirectory);
815

Torsten Oppermann's avatar
Torsten Oppermann committed
816
817
818
819
				foreach ($configFiles as $configFile) {
					if (!\file_exists($extensionConfigDirectory . '/' . $configFile)) {
						continue;
					}
820

Torsten Oppermann's avatar
Torsten Oppermann committed
821
822
823
824
825
826
827
828
829
830
831
832
					$configArray = (include $extensionConfigDirectory . '/' . $configFile);
					$extensionKey = $configArray['extension_key'];
					$templateKey = $configArray['template_key'];

					if ($extensionKey === NULL || $templateKey === NULL) {
						continue;
					}

					$registerArray = self::writeRegisterArrayEntry(
						$registerArray, $extensionKey, $templateKey, $configArray
					);
				}
833
			}
Torsten Oppermann's avatar
Torsten Oppermann committed
834

835
		}
836

837
838
839
840
841
842
843
844
845
846
		return $registerArray;
	}

	/**
	 * writes a single entry into the register array
	 *
	 * @param array $registerArray
	 * @param string $extensionKey
	 * @param string $templateKey
	 * @param array $configArray
847
848
	 * @param bool $transformTemplateFolder
	 * @param string $storeTemplateExtension
849
850
851
	 * @return array
	 */
	private static function writeRegisterArrayEntry(
852
		array $registerArray, $extensionKey, $templateKey, array $configArray,
853
		$transformTemplateFolder = TRUE, $storeTemplateExtension = ''
854
	) {
855
856
857
858
859
860
861
		// 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;
862

863
864
865
866
867
868
869
		// 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);
870
			}
871
872
		}

873
		$templateDirectory .= '/';
Torsten Oppermann's avatar
Torsten Oppermann committed
874
875
		$templatePath = ExtensionManagementUtility::extPath($storeTemplateExtension) . self::DEFAULT_TEMPLATE_PATH
			. $templateDirectory;
876
877

		if ($configArray['template_path']) {
878
			$templatePath = $configArray[$templateKey];
879
880
		}

881
882
883
884
885
886
887
888
889
890
		$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
891
			'subject' => $subject
892
893
		];

894
		return $registerArray;
895
	}
896
897
898
899
900
901
902
903
904
905
906
907
908

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

911
912
		if ($nonBlacklistedTemplates[$extensionKey]) {
			return $nonBlacklistedTemplates[$extensionKey][$templateName] ? FALSE : TRUE;
913
914
915
916
		}

		return TRUE;
	}
917
918
919
920
921
922
923
924
925
926
927
928
929
930

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

	/**
	 * @param string $subject
	 */
	public function setSubject(string $subject) {
		$this->subject = $subject;
	}
931
932
933
934
935
936
937

	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
938
	private function getAllMarker(array $markers): string {
939
940
941
		$allMarker = '';

		foreach ($markers as $key => $value) {
942
			if (\is_string($value)) {
943
				$allMarker .= $key . ': ' . $value . PHP_EOL;
944
			} elseif (\is_array($value)) {
945
				foreach ($value as $innerKey => $innerValue) {
Torsten Oppermann's avatar
Torsten Oppermann committed
946
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
947
				}
948
			} elseif (\is_bool($value)) {
Torsten Oppermann's avatar
Torsten Oppermann committed
949
950
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
951
952
953
954
			} elseif (\is_object($value)) {
				if (method_exists($value, '__toString')) {
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
955
956
957
958
959
			}
		}

		return $allMarker;
	}
960
}