MailTemplateService.php 18.4 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
38
use TYPO3\CMS\Core\Mail\MailMessage;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManager;
39
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
40
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
41
42
use TYPO3\CMS\Fluid\View\StandaloneView;

43
44
45
/**
 * MailTemplateService
 */
46
class MailTemplateService {
47
	const MARKER_TYPE_STRING = 'String';
48
49
50
	const MARKER_TYPE_ARRAY = 'Array';
	const MARKER_TYPE_OBJECT = 'Object';

51
	/**
52
	 * @var array $registerArray
53
	 */
54
	private static $registerArray = [];
55

56
	/**
57
	 * @var array $toAddresses
58
	 */
59
	private $toAddresses = [];
60
61

	/**
62
	 * @var string $fromAddress
63
	 */
64
	private $fromAddress;
65
66

	/**
67
	 * @var array $ccAddresses
68
	 */
Paul Ilea's avatar
Paul Ilea committed
69
	private $ccAddresses;
70
71

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

	/**
77
	 * @var string $language
78
	 */
79
	private $language;
80
81

	/**
82
	 * @var boolean $ignoreMailQueue
83
	 */
84
	private $ignoreMailQueue = FALSE;
85
86
87
88
89
90
91

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

	/**
92
	 * @var string $templateName
93
94
95
96
	 */
	private $templateName;

	/**
97
	 * @var string $extensionKey
98
99
100
101
	 */
	private $extensionKey;

	/**
102
	 * @var array $markers
103
	 */
104
	private $markers = [];
105

106
107
108
	/**
	 * holds the TypoScript configuration for sg_mail
	 *
109
	 * @var array $tsSettings
110
	 */
Paul Ilea's avatar
Paul Ilea committed
111
	private $tsSettings;
112

113
114
115
	/**
	 * @var array $bccAddresses
	 */
Paul Ilea's avatar
Paul Ilea committed
116
	private $bccAddresses;
117

118
119
120
121
122
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

123
124
125
126
127
	/**
	 * @var string
	 */
	private $fromName = '';

128
129
130
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
131
132
133
134
135
136
	protected $templateRepository;

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

138
139
140
141
142
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

143
144
145
146
147
	/**
	 * @var array
	 */
	private $attachments = [];

148
149
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
150
151
	 *
	 * @throws \InvalidArgumentException
152
153
	 */
	public function __construct() {
154
155
156
157
158
159
		/** @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);
160
161
		$this->tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
		$this->language = $this->tsSettings['templateDefaultLanguage'];
162
163
164
165
		/** @var TemplateRepository templateRepository */
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		/** @var PersistenceManager persistenceManager */
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
166
167
168

		$this->fromAddress = $this->tsSettings['mail']['default']['from'];
		$this->mailMessage->setFrom($this->fromAddress);
169
		$this->bccAddresses = GeneralUtility::trimExplode(',', $this->tsSettings['mail']['default']['bcc']);
170
171
172
173
174
175
176
177
178
179
180
181
182
183
		$this->ccAddresses = GeneralUtility::trimExplode(',', $this->tsSettings['mail']['default']['cc']);

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

184
		if (count($this->bccAddresses) > 0) {
185
186
187
			$this->mailMessage->setBcc($this->bccAddresses);
		}

188
		if (count($this->ccAddresses) > 0) {
189
190
			$this->mailMessage->setCc($this->ccAddresses);
		}
191
192
	}

Torsten Oppermann's avatar
Torsten Oppermann committed
193
	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
194
	 * register a template with sg_mail
Fabian Galinski's avatar
Fabian Galinski committed
195
	 *
196
197
198
	 * description and subject can now be an array i.e. with elements such as 'en' => 'english description'
	 * or an translation string used in locallang.xml
	 *
199
	 * @deprecated public usage of this function is deprecated. use registerByFile instead
200
	 * @param string $extension
Torsten Oppermann's avatar
Torsten Oppermann committed
201
202
	 * @param string $templateName
	 * @param string $templatePath
203
	 * @param mixed $description
204
	 * @param array $markers
205
	 * @param mixed $subject
206
	 * @param string $usage
Torsten Oppermann's avatar
Torsten Oppermann committed
207
	 */
208
	public static function registerTemplate(
209
		$extension, $templateName, $templatePath, $description, array $markers, $subject, $usage = ''
210
	) {
211
		MailTemplateService::$registerArray[$extension][$templateName] = [
212
			'templatePath' => $templatePath,
213
			'description' => $description,
214
			'marker' => $markers,
215
			'extension' => $extension,
216
			'templateName' => $templateName,
217
218
			'subject' => $subject,
			'usage' => $usage
219
220
		];
	}
221

222
223
224
	/**
	 * call in extlocalconf of an extension if you have a custom register class
	 *
Paul Ilea's avatar
Paul Ilea committed
225
226
	 * @param RegisterInterface $fileNameWithNamespace
	 * @param boolean $initObject Should the object initialize itself ?
227
228
	 *
	 * @return bool
Paul Ilea's avatar
Paul Ilea committed
229
	 * @throws \InvalidArgumentException
230
	 */
231
	public static function registerByFile($fileNameWithNamespace, $initObject = TRUE) {
232
233
234
235
236
237
		$registerObject = GeneralUtility::makeInstance($fileNameWithNamespace);
		// check instance of interface
		if (!($registerObject instanceof RegisterInterface)) {
			return FALSE;
		}

238
239
240
241
		// object calls registerTemplate, alternative way instead of localconf call
		if ($initObject) {
			$registerObject->init();
		}
242
243
244
245
		$registerObject->registerTemplate();
		return TRUE;
	}

246
247
248
249
250
251
252
253
254
	/**
	 * 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') {
255
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275

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

276
	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
277
	 * Get all registered templates
Fabian Galinski's avatar
Fabian Galinski committed
278
	 *
279
	 * @return array
280
	 */
281
282
	public static function getRegisterArray() {
		return self::$registerArray;
283
	}
284

285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
	/**
	 * Sets the predefined values for this template, supplied by the Editor, if possible
	 * values for cc, bcc, replyTo, fromMail and fromName
	 *
	 * @param string $extensionKey
	 * @param string $templateName
	 * @param string $language
	 * @return bool
	 */
	public function loadPredefinedValuesForTemplate($extensionKey, $templateName, $language) {
		/** @var Template $template */
		$template = $this->templateRepository->findOneByTemplate(
			$this->extensionKey, $this->templateName, $this->language
		);

		if ($template !== NULL) {
301
302
			$this->setCcAddresses(GeneralUtility::trimExplode(',', $template->getCc()));
			$this->setBccAddresses(GeneralUtility::trimExplode(',', $template->getBcc()));
303
304
			$this->setReplyToAddress($template->getReplyTo());
			$this->setFromAddress($template->getFromMail(), $template->getFromName());
305
			return TRUE;
306
307
		}

308
		return FALSE;
309
310
	}

311
	/**
312
	 * Send the Email
313
	 *
Torsten Oppermann's avatar
Torsten Oppermann committed
314
	 * @param boolean $isPreview
315
	 * @return boolean email was sent or added to mail queue successfully?
316
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
317
	 */
318
	public function sendEmail($isPreview = FALSE) {
319
		/** @var Template $template */
320
		$template = $this->templateRepository->findOneByTemplate(
321
			$this->extensionKey, $this->templateName, $this->language
322
		);
323

324
325
326
327
328
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

329
330
331
332
333
334
335
336
		// If there is no template for this language, use the default template
		if ($template === NULL) {
			$templatePath = self::$registerArray[$this->extensionKey][$this->templateName]['templatePath'];
			$templateFile = $templatePath . $this->language . '.template.html';
			if (file_exists($templateFile)) {
				$defaultTemplateContent = file_get_contents($templatePath . $this->language . '.template.html');
			} else {
				// no language found and no default template
Paul Ilea's avatar
Paul Ilea committed
337
				$this->setLanguage($this->tsSettings['templateDefaultLanguage'] ?: 'en');
338
339
340
341
342
343
344
				// does an english default template exist ?
				if (file_exists($templatePath . $this->language . '.template.html')) {
					$this->sendEmail();
					return TRUE;
				}

				return FALSE;
345
			}
346
347
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
348
349
		if ($isPreview) {
			$previewMarker = [];
Paul Ilea's avatar
Paul Ilea committed
350
			/** @var array $markerArray */
Torsten Oppermann's avatar
Torsten Oppermann committed
351
352
			$markerArray = self::$registerArray[$this->extensionKey][$this->templateName]['marker'];
			foreach ($markerArray as $marker) {
353
354
355
356
357
358
359
				if ($marker['backend_translation_key']) {
					$previewMarker[$marker['marker']] = LocalizationUtility::translate(
						$marker['backend_translation_key'], $marker['extension_key']
					);
				} else {
					$previewMarker[$marker['marker']] = $marker['value'];
				}
Torsten Oppermann's avatar
Torsten Oppermann committed
360
			}
361
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
362
363
364
			$this->setMarkers($previewMarker);
		}

365
		/** @var StandaloneView $emailView */
366
		$emailView = $this->objectManager->get(StandaloneView::class);
367

Paul Ilea's avatar
Paul Ilea committed
368
		if (null === $defaultTemplateContent) {
369
			$emailView->setTemplateSource($template->getContent());
370
			$subject = $template->getSubject();
371
372
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
373
374
375
376
377
378
379
380
381
382

			$subject = self::$registerArray[$this->extensionKey][$this->templateName]['subject'];
			if (is_array($subject)) {
				$subject = self::$registerArray[$this->extensionKey][$this->templateName]['subject'][$this->language];
			} else {
				$subject = LocalizationUtility::translate(
					self::$registerArray[$this->extensionKey][$this->templateName]['subject'],
					$this->extensionKey
				);
			}
383
		}
384
		$this->mailMessage->setSubject($subject);
385

386
		$emailView->assignMultiple($this->markers);
387
		$emailBody = $emailView->render();
388

389
390
391
392
		// 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);
		if ($this->ignoreMailQueue) {
393

394
			$this->mailMessage->setBody($emailBody, 'text/html');
395
			$this->mailMessage->send();
396
397
			$dateTime = new DateTime();
			$this->addMailToMailQueue(
398
399
				$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
				$dateTime->getTimestamp(), TRUE
400
401
			);

402
		} else {
403
			$this->addMailToMailQueue($this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority);
404
		}
405
406

		return TRUE;
407
408
409
	}

	/**
410
	 * Adds a new mail to the mail queue.
411
	 *
412
413
	 * @param string $extensionKey
	 * @param string $templateName
414
	 * @param string $subject
415
	 * @param string $emailBody
416
	 * @param int $sendingTime
417
	 * @param int $priority
418
	 * @param bool $sent
Paul Ilea's avatar
Paul Ilea committed
419
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
420
	 */
421
422
423
	private function addMailToMailQueue(
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0, $sent = FALSE
	) {
424
		$mail = $this->objectManager->get(Mail::class);
425
426
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
427
		$mail->setFromAddress($this->fromAddress);
428
		$mail->setFromName($this->fromName);
429
		$mail->setToAddress($this->toAddresses);
430
		$mail->setMailSubject($subject);
431
		$mail->setMailBody($emailBody);
432
		$mail->setPriority($priority);
433
434
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
435
		$mail->setSent($sent);
436
		$mail->setSendingTime($sendingTime);
437
		$mail->setReplyTo($this->replyToAddress);
438

439
440
441
		$pageUid = (int) GeneralUtility::_GP('id');
		$siteRootId = BackendService::getSiteRoot($pageUid)['uid'];
		$mail->setSiteRootId($siteRootId);
442

443
		$mailRepository = $this->objectManager->get(MailRepository::class);
444
		$mailRepository->add($mail);
445
		$this->persistenceManager->persistAll();
446
	}
447

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

		if ($mailToSend) {
461

462
463
464
465
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
			$this->mailMessage->setTo($mailToSend->getToAddress());
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
466

467
			if ($mailToSend->getBccAddresses()) {
468
469
470
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

471
			if ($mailToSend->getCcAddresses()) {
472
473
474
475
476
477
478
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

			if ($mailToSend->getReplyTo()) {
				$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
			}

479
			$this->mailMessage->send();
480
481
482
483
484

			if (!$mailToSend->getSent()) {
				$mailToSend->setSent(TRUE);
				$mailRepository->update($mailToSend);
			}
485
486
487
		}
	}

488
489
	/**
	 * @param array $registerArray
490
	 * @return void
491
	 */
492
	public static function setRegisterArray(array $registerArray) {
493
494
495
496
		self::$registerArray = $registerArray;
	}

	/**
497
	 * @param string $toAddresses
498
499
	 * @return MailTemplateService
	 */
500
501
502
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
503
504
505
506
		return $this;
	}

	/**
507
	 * @param string $fromAddress
508
	 * @param string $fromName
509
510
	 * @return MailTemplateService
	 */
511
	public function setFromAddress($fromAddress, $fromName = '') {
512
513
514
515
516
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

517
518
519
520
		return $this;
	}

	/**
521
	 * @param string $ccAddresses
522
523
	 * @return MailTemplateService
	 */
524
	public function setCcAddresses($ccAddresses) {
525
526
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
527
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
528
529
		}

530
531
532
533
		return $this;
	}

	/**
534
	 * @param string $replyToAddress
535
536
	 * @return MailTemplateService
	 */
537
	public function setReplyToAddress($replyToAddress) {
538
539
540
541
542
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
		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;
	}

582
	/**
583
	 * @param array $markers
584
585
	 * @return MailTemplateService
	 */
586
587
	public function setMarkers(array $markers) {
		$this->markers = $markers;
588
589
		return $this;
	}
590
591

	/**
592
	 * @param string $bccAddresses
593
594
	 * @return MailTemplateService
	 */
595
	public function setBccAddresses($bccAddresses) {
596
597
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
598
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
599
600
		}

601
602
603
		return $this;
	}

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

	/**
	 * @param Swift_OutputByteStream $data
Paul Ilea's avatar
Paul Ilea committed
615
	 * @param string $filename
616
617
618
619
620
621
622
623
624
625
626
	 * @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;
	}
627
628
629
630
631
632
633
634

	/**
	 * @return MailMessage
	 */
	public function getMailMessage() {
		return $this->mailMessage;
	}

635
636
637
638
639
640
641
642
643
644
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
	private function loadTemplateValues($template) {
		$this->setFromAddress($template->getFromMail(), $template->getFromName());
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
645
646
647
648
649
650
651
652
653
		$this->setFromName($template->getFromName());
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
654
	}
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675

	/**
	 * 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;
			default:
				LocalizationUtility::translate('backend.marker.type.mixed', 'sg_mail');
		}
	}
676
}