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
	 */
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
111
112
	 */
	private $tsSettings = [];

113
114
115
116
117
	/**
	 * @var array $bccAddresses
	 */
	private $bccAddresses = [];

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

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

182
		$this->mailMessage->setFrom($this->fromAddress);
183
		if (count($this->bccAddresses) > 0) {
184
185
186
			$this->mailMessage->setBcc($this->bccAddresses);
		}

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

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

218
219
220
221
	/**
	 * call in extlocalconf of an extension if you have a custom register class
	 *
	 * @param RegisterInterface
222
	 * @param boolean Should the object initialize itself ?
223
224
225
	 *
	 * @return bool
	 */
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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
	/**
	 * 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) {
296
297
			$this->setCcAddresses(GeneralUtility::trimExplode(',', $template->getCc()));
			$this->setBccAddresses(GeneralUtility::trimExplode(',', $template->getBcc()));
298
299
			$this->setReplyToAddress($template->getReplyTo());
			$this->setFromAddress($template->getFromMail(), $template->getFromName());
300
			return TRUE;
301
302
		}

303
		return FALSE;
304
305
	}

306
	/**
307
	 * Send the Email
308
	 *
Torsten Oppermann's avatar
Torsten Oppermann committed
309
	 * @param boolean $isPreview
310
	 * @return boolean email was sent or added to mail queue successfully?
311
	 */
312
	public function sendEmail($isPreview = FALSE) {
313
		/** @var Template $template */
314
		$template = $this->templateRepository->findOneByTemplate(
315
			$this->extensionKey, $this->templateName, $this->language
316
		);
317

318
319
320
321
322
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

323
324
325
326
327
328
329
330
		// 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
Torsten Oppermann's avatar
Torsten Oppermann committed
331
				$this->setLanguage('en');
332
333
334
335
336
337
338
				// does an english default template exist ?
				if (file_exists($templatePath . $this->language . '.template.html')) {
					$this->sendEmail();
					return TRUE;
				}

				return FALSE;
339
			}
340
341
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
342
343
344
345
		if ($isPreview) {
			$previewMarker = [];
			$markerArray = self::$registerArray[$this->extensionKey][$this->templateName]['marker'];
			foreach ($markerArray as $marker) {
346
347
348
349
350
351
352
				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
353
			}
354
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
355
356
357
			$this->setMarkers($previewMarker);
		}

358
		/** @var StandaloneView $emailView */
359
		$emailView = $this->objectManager->get(StandaloneView::class);
360

361
362
		if (!isset($defaultTemplateContent)) {
			$emailView->setTemplateSource($template->getContent());
363
			$subject = $template->getSubject();
364
365
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
366
367
368
369
370
371
372
373
374
375

			$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
				);
			}
376
		}
377
		$this->mailMessage->setSubject($subject);
378

379
		$emailView->assignMultiple($this->markers);
380
		$emailBody = $emailView->render();
381

382
383
384
385
		// insert <br /> tags, but replace every instance of three or more successive breaks with just two.
		$emailBody = nl2br($emailBody);
		$emailBody = preg_replace('/(<br[\s]?[\/]?>[\s]*){3,}/', '<br /><br />', $emailBody);
		if ($this->ignoreMailQueue) {
386

387
			$this->mailMessage->setBody($emailBody, 'text/html');
388
			$this->mailMessage->send();
389
390
			$dateTime = new DateTime();
			$this->addMailToMailQueue(
391
392
				$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
				$dateTime->getTimestamp(), TRUE
393
394
			);

395
		} else {
396
			$this->addMailToMailQueue($this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority);
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 bool $sent
412
	 */
413
414
415
	private function addMailToMailQueue(
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0, $sent = FALSE
	) {
416
		$mail = $this->objectManager->get(Mail::class);
417
418
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
419
		$mail->setFromAddress($this->fromAddress);
420
		$mail->setFromName($this->fromName);
421
		$mail->setToAddress($this->toAddresses);
422
		$mail->setMailSubject($subject);
423
		$mail->setMailBody($emailBody);
424
		$mail->setPriority($priority);
425
426
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
427
		$mail->setSent($sent);
428
		$mail->setSendingTime($sendingTime);
429
		$mail->setReplyTo($this->replyToAddress);
430

431
		$mailRepository = $this->objectManager->get(MailRepository::class);
432
		$mailRepository->add($mail);
433
		$this->persistenceManager->persistAll();
434
	}
435

436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
	 */
	public function sendMailFromQueue($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
		$mailToSend = $mailRepository->findByUid($uid)->getFirst();

		if ($mailToSend) {
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
			$this->mailMessage->setTo($mailToSend->getToAddress());
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
451
452
453
454
455
456
457
458
459
460
461
462
463

			if ($mailToSend->getCcAddresses()) {
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

			if ($mailToSend->getBccAddresses()) {
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

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

464
			$this->mailMessage->send();
465
466
467
468
469

			if (!$mailToSend->getSent()) {
				$mailToSend->setSent(TRUE);
				$mailRepository->update($mailToSend);
			}
470
471
472
		}
	}

473
474
	/**
	 * @param array $registerArray
475
	 * @return void
476
	 */
477
	public static function setRegisterArray(array $registerArray) {
478
479
480
481
		self::$registerArray = $registerArray;
	}

	/**
482
	 * @param string $toAddresses
483
484
	 * @return MailTemplateService
	 */
485
486
487
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
488
489
490
491
		return $this;
	}

	/**
492
	 * @param string $fromAddress
493
	 * @param string $fromName
494
495
	 * @return MailTemplateService
	 */
496
	public function setFromAddress($fromAddress, $fromName = '') {
497
498
499
500
501
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

502
503
504
505
		return $this;
	}

	/**
506
	 * @param string $ccAddresses
507
508
	 * @return MailTemplateService
	 */
509
	public function setCcAddresses($ccAddresses) {
510
511
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
512
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
513
514
		}

515
516
517
518
		return $this;
	}

	/**
519
	 * @param string $replyToAddress
520
521
	 * @return MailTemplateService
	 */
522
	public function setReplyToAddress($replyToAddress) {
523
524
525
526
527
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

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
554
555
556
557
558
559
560
561
562
563
564
565
566
		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;
	}

567
	/**
568
	 * @param array $markers
569
570
	 * @return MailTemplateService
	 */
571
572
	public function setMarkers(array $markers) {
		$this->markers = $markers;
573
574
		return $this;
	}
575
576

	/**
577
	 * @param string $bccAddresses
578
579
	 * @return MailTemplateService
	 */
580
	public function setBccAddresses($bccAddresses) {
581
582
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
583
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
584
585
		}

586
587
588
		return $this;
	}

589
590
591
592
593
594
595
596
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611

	/**
	 * @param Swift_OutputByteStream $data
	 * @param string $path
	 * @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;
	}
612
613
614
615
616
617
618
619

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

620
621
622
623
624
625
626
627
628
629
	/**
	 * 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());
630
631
632
633
634
635
636
637
638
		$this->setFromName($template->getFromName());
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
639
	}
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660

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