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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

267
		if ($this->pid) {
268
269
270
271
272
273
274
275
276
277
			$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'];
			}
278
		}
279
		$siteRootId = BackendService::getSiteRoot($pageUid);
280

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

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

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

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

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

303
304
305
306
307
			// 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
308
				// use configured default html template
309
310
311
312
313
				/** @var TypoScriptSettingsService $typoScriptSettingsService */
				$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
				$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
				$defaultTemplateFile = GeneralUtility::getFileAbsFileName($tsSettings['mail']['defaultHtmlTemplate']);

Torsten Oppermann's avatar
Torsten Oppermann committed
314
315
				if (file_exists($defaultTemplateFile)) {
					$defaultTemplateContent = file_get_contents($defaultTemplateFile);
316
				} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
317
					return FALSE;
318
				}
319
			}
320
		} elseif (filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
321
			$this->setToAddresses(trim($template->getToAddress()));
322
323
		}

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

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

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

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

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

381
		$this->mailMessage->setSubject($subject);
382

383
		$emailBody = $emailView->render();
384

385
386
387
		// 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);
388

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

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

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

		return TRUE;
418
419
420
	}

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

448
		$mail->setFromAddress($this->fromAddress);
449
		$mail->setFromName($this->fromName);
450

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

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

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

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

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

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

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

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

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

557
558
559
560
		return $this;
	}

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

570
571
572
573
		return $this;
	}

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

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
620
621
		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;
	}

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

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

641
642
643
		return $this;
	}

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

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

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

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

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

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

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

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

770
771
772
773
774
775
776
	/**
	 * Get all registered templates
	 *
	 * @return array
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \BadFunctionCallException
	 * @throws \InvalidArgumentException
777
	 * @deprecated since 4.7.0 will be removed in 5.0.0. Use the RegistrationService class instead
778
	 */
779
780
781
	public static function getRegisterArray(): array {
		// @TODO remove this deprecated function in version 5.0.0
		self::logDeprecation('registerExtensions');
782

783
784
785
		$registrationService = GeneralUtility::makeInstance(RegisterService::class);
		// write entries for old extensions intto the file list
		self::registerExtensions();
786

787
		return $registrationService->getRegisterArray();
788
789
	}

790
791
792
793
794
	/**
	 * Iterate over all installed extensions and look for sg_mail configuration files
	 * If found, register the template(s)
	 *
	 * @throws \BadFunctionCallException
795
	 * @deprecated since 4.7.0 will be removed in 5.0.0. Use the RegistrationService class instead
796
	 */
797
	public static function registerExtensions() {
798
799
800
		// @TODO remove this deprecated function in version 5.0.0
		self::logDeprecation('registerExtensions');

801
802
803
804
		$extensionList = ExtensionManagementUtility::getLoadedExtensionListArray();

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

Torsten Oppermann's avatar
Torsten Oppermann committed
807
808
809
			if (\is_dir($extensionConfigDirectory)) {
				$configFiles = GeneralUtility::getFilesInDir($extensionConfigDirectory);
				foreach ($configFiles as $configFile) {
810
					$pathToRegistrationFile = $extensionConfigDirectory . '/' . $configFile;
811

812
					if (!\file_exists($pathToRegistrationFile)) {
Torsten Oppermann's avatar
Torsten Oppermann committed
813
814
						continue;
					}
815
					$GLOBALS['sgmail']['sg_mail'][$configFile] = $pathToRegistrationFile;
Torsten Oppermann's avatar
Torsten Oppermann committed
816
				}
817
818
			}
		}
819
	}
820
821
822
823
824
825
826
827
828
829
830
831
832

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

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

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

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

	/**
	 * @param string $subject
	 */
	public function setSubject(string $subject) {
		$this->subject = $subject;
	}
855
856
857
858
859
860
861

	/**
	 * Get a single variable containing a list of all markers
	 *
	 * @param array $markers
	 * @return string
	 */
862
	private function getAllMarker(array $markers): string {
863
864
865
		$allMarker = '';

		foreach ($markers as $key => $value) {
866
			if (\is_string($value)) {
867
				$allMarker .= $key . ': ' . $value . PHP_EOL;
868
			} elseif (\is_array($value)) {
869
				foreach ($value as $innerKey => $innerValue) {
Torsten Oppermann's avatar
Torsten Oppermann committed
870
					$allMarker .= $key . '.' . $innerKey . ': ' . $innerValue . PHP_EOL;
871
				}
872
			} elseif (\is_bool($value)) {
Torsten Oppermann's avatar
Torsten Oppermann committed
873
874
				$valueAsString = $value ? 'true' : 'false';
				$allMarker .= $key . ': ' . $valueAsString . PHP_EOL;
875
876
877
878
			} elseif (\is_object($value)) {
				if (method_exists($value, '__toString')) {
					$allMarker .= $key . ': ' . $value->__toString() . PHP_EOL;
				}
879
880
881
882
883
			}
		}

		return $allMarker;
	}
884
885
886
887
888
889
890
891
892
893
894

	/**
	 * function to call a deprecation log entry (but only once per request / class)
	 *
	 * @param $function
	 */
	private static function logDeprecation($function) {
		GeneralUtility::deprecationLog(
			'The function ' . $function . ' is deprecated since version 4.7.0 and will be removed in version 5.0.0'
		);
	}
895
}