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

		$this->fromAddress = $this->tsSettings['mail']['default']['from'];
		$this->mailMessage->setFrom($this->fromAddress);
164
		$this->bccAddresses = GeneralUtility::trimExplode(',', $this->tsSettings['mail']['default']['bcc']);
165
166
167
168
169
170
171
172
173
174
175
176
177
178
		$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]);
			}
		}

179
		if (count($this->bccAddresses) > 0) {
180
181
182
			$this->mailMessage->setBcc($this->bccAddresses);
		}

183
		if (count($this->ccAddresses) > 0) {
184
185
			$this->mailMessage->setCc($this->ccAddresses);
		}
186
187
	}

Torsten Oppermann's avatar
Torsten Oppermann committed
188
	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
189
	 * register a template with sg_mail
Fabian Galinski's avatar
Fabian Galinski committed
190
	 *
191
192
193
	 * 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
	 *
194
	 * @deprecated public usage of this function is deprecated. use registerByFile instead
195
	 * @param string $extension
Torsten Oppermann's avatar
Torsten Oppermann committed
196
197
	 * @param string $templateName
	 * @param string $templatePath
198
	 * @param mixed $description
199
	 * @param array $markers
200
	 * @param mixed $subject
201
	 * @param string $usage
Torsten Oppermann's avatar
Torsten Oppermann committed
202
	 */
203
	public static function registerTemplate(
204
		$extension, $templateName, $templatePath, $description, array $markers, $subject, $usage = ''
205
	) {
206
		MailTemplateService::$registerArray[$extension][$templateName] = [
207
			'templatePath' => $templatePath,
208
			'description' => $description,
209
			'marker' => $markers,
210
			'extension' => $extension,
211
			'templateName' => $templateName,
212
213
			'subject' => $subject,
			'usage' => $usage
214
215
		];
	}
216

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

233
234
235
236
		// object calls registerTemplate, alternative way instead of localconf call
		if ($initObject) {
			$registerObject->init();
		}
237
238
239
240
		$registerObject->registerTemplate();
		return TRUE;
	}

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

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

271
	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
272
	 * Get all registered templates
Fabian Galinski's avatar
Fabian Galinski committed
273
	 *
274
	 * @return array
275
	 */
276
277
	public static function getRegisterArray() {
		return self::$registerArray;
278
	}
279
280

	/**
281
	 * Send the Email
282
	 *
Torsten Oppermann's avatar
Torsten Oppermann committed
283
	 * @param boolean $isPreview
284
	 * @return boolean email was sent or added to mail queue successfully?
285
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
286
	 */
287
	public function sendEmail($isPreview = FALSE) {
288
289
290
		$pageUid = (int) GeneralUtility::_GP('id');
		$siteRootId = BackendService::getSiteRoot($pageUid);

291
		/** @var Template $template */
292
		$template = $this->templateRepository->findOneByTemplate(
293
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
294
		);
295

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

301
302
303
304
305
306
307
308
		// 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
309
				$this->setLanguage($this->tsSettings['templateDefaultLanguage'] ?: 'en');
310
311
312
313
314
315
316
				// does an english default template exist ?
				if (file_exists($templatePath . $this->language . '.template.html')) {
					$this->sendEmail();
					return TRUE;
				}

				return FALSE;
317
			}
318
319
		}

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

337
		/** @var StandaloneView $emailView */
338
		$emailView = $this->objectManager->get(StandaloneView::class);
339

340
		if (NULL === $defaultTemplateContent) {
341
			$emailView->setTemplateSource($template->getContent());
342
			$subject = $template->getSubject();
343
344
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
345
346
347
348
349
350
351
352
353
354

			$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
				);
			}
355
		}
356
		$this->mailMessage->setSubject($subject);
357

358
		$emailView->assignMultiple($this->markers);
359
		$emailBody = $emailView->render();
360

361
362
363
364
		// 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) {
365

366
			$this->mailMessage->setBody($emailBody, 'text/html');
367
			$this->mailMessage->send();
368
369
			$dateTime = new DateTime();
			$this->addMailToMailQueue(
370
371
				$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
				$dateTime->getTimestamp(), TRUE
372
373
			);

374
		} else {
375
			$this->addMailToMailQueue($this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority);
376
		}
377
378

		return TRUE;
379
380
381
	}

	/**
382
	 * Adds a new mail to the mail queue.
383
	 *
384
385
	 * @param string $extensionKey
	 * @param string $templateName
386
	 * @param string $subject
387
	 * @param string $emailBody
388
	 * @param int $sendingTime
389
	 * @param int $priority
390
	 * @param bool $sent
Paul Ilea's avatar
Paul Ilea committed
391
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
392
	 */
393
394
395
	private function addMailToMailQueue(
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0, $sent = FALSE
	) {
396
		$mail = $this->objectManager->get(Mail::class);
397
398
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
399
		$mail->setFromAddress($this->fromAddress);
400
		$mail->setFromName($this->fromName);
401
		$mail->setToAddress($this->toAddresses);
402
		$mail->setMailSubject($subject);
403
		$mail->setMailBody($emailBody);
404
		$mail->setPriority($priority);
405
406
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
407
		$mail->setSent($sent);
408
		$mail->setSendingTime($sendingTime);
409
		$mail->setReplyTo($this->replyToAddress);
410

411
		$pageUid = (int) GeneralUtility::_GP('id');
412
		$siteRootId = BackendService::getSiteRoot($pageUid);
413
		$mail->setSiteRootId($siteRootId);
414

415
		$mailRepository = $this->objectManager->get(MailRepository::class);
416
		$mailRepository->add($mail);
417
		$this->persistenceManager->persistAll();
418
	}
419

420
421
422
423
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
Paul Ilea's avatar
Paul Ilea committed
424
425
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
426
427
428
429
	 */
	public function sendMailFromQueue($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
430
		$mailToSend = $mailRepository->findOneByUid($uid);
431
432

		if ($mailToSend) {
433

434
435
436
437
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
			$this->mailMessage->setTo($mailToSend->getToAddress());
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
438

439
			if ($mailToSend->getBccAddresses()) {
440
441
442
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

443
			if ($mailToSend->getCcAddresses()) {
444
445
446
447
448
449
450
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

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

451
			$this->mailMessage->send();
452
453
454
455
456

			if (!$mailToSend->getSent()) {
				$mailToSend->setSent(TRUE);
				$mailRepository->update($mailToSend);
			}
457
458
459
		}
	}

460
461
	/**
	 * @param array $registerArray
462
	 * @return void
463
	 */
464
	public static function setRegisterArray(array $registerArray) {
465
466
467
468
		self::$registerArray = $registerArray;
	}

	/**
469
	 * @param string $toAddresses
470
471
	 * @return MailTemplateService
	 */
472
473
474
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
475
476
477
478
		return $this;
	}

	/**
479
	 * @param string $fromAddress
480
	 * @param string $fromName
481
482
	 * @return MailTemplateService
	 */
483
	public function setFromAddress($fromAddress, $fromName = '') {
484
485
486
487
488
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

489
490
491
492
		return $this;
	}

	/**
493
	 * @param string $ccAddresses
494
495
	 * @return MailTemplateService
	 */
496
	public function setCcAddresses($ccAddresses) {
497
498
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
499
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
500
501
		}

502
503
504
505
		return $this;
	}

	/**
506
	 * @param string $replyToAddress
507
508
	 * @return MailTemplateService
	 */
509
	public function setReplyToAddress($replyToAddress) {
510
511
512
513
514
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
		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;
	}

554
	/**
555
	 * @param array $markers
556
557
	 * @return MailTemplateService
	 */
558
559
	public function setMarkers(array $markers) {
		$this->markers = $markers;
560
561
		return $this;
	}
562
563

	/**
564
	 * @param string $bccAddresses
565
566
	 * @return MailTemplateService
	 */
567
	public function setBccAddresses($bccAddresses) {
568
569
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
570
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
571
572
		}

573
574
575
		return $this;
	}

576
577
578
579
580
581
582
583
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
584
585
586

	/**
	 * @param Swift_OutputByteStream $data
Paul Ilea's avatar
Paul Ilea committed
587
	 * @param string $filename
588
589
590
591
592
593
594
595
596
597
598
	 * @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;
	}
599
600
601
602
603
604
605
606

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

607
608
609
610
611
612
613
614
615
616
	/**
	 * 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());
617
618
619
620
621
622
623
624
625
		$this->setFromName($template->getFromName());
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
626
	}
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647

	/**
	 * 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');
		}
	}
648
}