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

namespace SGalinski\SgMail\Service;

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

29
use DateTime;
30
31
32
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
use SGalinski\SgMail\Domain\Repository\MailRepository;
33
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
34
35
use Swift_Attachment;
use Swift_OutputByteStream;
36
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
336
		$emailView->assign('all_marker', $this->getAllMarker($this->markers));

337
		if (NULL === $defaultTemplateContent) {
338
339
340
			$emailView->setTemplateSource(\trim($template->getSubject()));
			$subject = $emailView->render();

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

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

363
		$this->mailMessage->setSubject($subject);
364

365
		$emailBody = $emailView->render();
366

367
368
369
		// 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);
370

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

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

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

		return TRUE;
400
401
402
	}

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

430
		$mail->setFromAddress($this->fromAddress);
431
		$mail->setFromName($this->fromName);
432

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

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

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

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

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

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

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

512
	/**
513
	 * @param string $toAddresses
514
515
	 * @return MailTemplateService
	 */
516
	public function setToAddresses($toAddresses) {
517
518
519
520
521
522
523
524
		$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);
525
526
527
528
		return $this;
	}

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

539
540
541
542
		return $this;
	}

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

552
553
554
555
		return $this;
	}

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

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
602
603
		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;
	}

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

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

623
624
625
		return $this;
	}

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

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

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

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

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

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

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

	/**
	 * set the page id from which this was called
	 *
	 * @param int $pid
	 * @return MailTemplateService
	 */
	public function setPid($pid) {
		$this->pid = (int) $pid;
		return $this;
	}
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
778
779
	/**
	 * 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;
	}

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

		$extensionList = ExtensionManagementUtility::getLoadedExtensionListArray();

		foreach ($extensionList as $extensionName) {
			$extensionConfigDirectory = ExtensionManagementUtility::extPath($extensionName);
795
			$extensionConfigDirectory .= self::CONFIG_PATH;
796
797
798
799
			$configFiles = GeneralUtility::getFilesInDir($extensionConfigDirectory);

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

803
804
				if ($extensionKey === NULL || $templateKey === NULL) {
					continue;
805
				}
806

807
				$registerArray = self::writeRegisterArrayEntry(
808
					$registerArray, $extensionKey, $templateKey, $configArray
809
810
811
				);
			}
		}
812

813
814
815
816
817
818
819
820
821
822
		return $registerArray;
	}

	/**
	 * writes a single entry into the register array
	 *
	 * @param array $registerArray
	 * @param string $extensionKey
	 * @param string $templateKey
	 * @param array $configArray
823
824
	 * @param bool $transformTemplateFolder
	 * @param string $storeTemplateExtension
825
826
827
	 * @return array
	 */
	private static function writeRegisterArrayEntry(
828
		array $registerArray, $extensionKey, $templateKey, array $configArray,
829
		$transformTemplateFolder = TRUE, $storeTemplateExtension = ''
830
	) {
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
		// 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);
			}
847
		}
848

849
850
		$templateDirectory .= '/';
		$templatePath = ExtensionManagementUtility::extPath(
851
				$storeTemplateExtension
852
853
854
			) . self::DEFAULT_TEMPLATE_PATH . $templateDirectory;

		if ($configArray['template_path']) {
855
			$templatePath = $configArray[$templateKey];
856
857
		}

858
859
860
861
862
863
864
865
866
867
868
869
870
		$description = $configArray['description'];
		$subject = $configArray['subject'];
		$marker = $configArray['markers'];

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

871
		return $registerArray;
872
	}
873
874
875
876
877
878
879
880
881
882
883
884
885

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

888
889
		if ($nonBlacklistedTemplates[$extensionKey]) {
			return $nonBlacklistedTemplates[$extensionKey][$templateName] ? FALSE : TRUE;
890
891
892
893
		}

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

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

	/**
	 * @param string $subject
	 */
	public function setSubject(string $subject) {
		$this->subject = $subject;
	}
908
909
910
911
912
913
914

	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
915
	private function getAllMarker(array $markers): string {
916
917
918
		$allMarker = '';

		foreach ($markers as $key => $value) {
919
920
921
			if (\is_string($value)) {
				$allMarker .= $key  . ': ' . $value . PHP_EOL;
			} elseif (\is_array($value)) {
922
				foreach ($value as $innerKey => $innerValue) {
923
					$allMarker .= $key  . ': ' . $innerValue . PHP_EOL;
924
				}
925
926
			} elseif (\is_bool($value)) {
				$allMarker .= $key  . ': ' . $value . PHP_EOL;
927
928
929
930
931
			}
		}

		return $allMarker;
	}
932
}