MailTemplateService.php 17.1 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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
	/**
	 * call in extlocalconf of an extension if you have a custom register class
	 *
	 * @param RegisterInterface
	 *
	 * @return bool
	 */
	public static function registerByFile($fileNameWithNamespace) {
		$registerObject = GeneralUtility::makeInstance($fileNameWithNamespace);
		// check instance of interface
		if (!($registerObject instanceof RegisterInterface)) {
			return FALSE;
		}

		// object ruft registerTemplate auf, beinhaltet alles aus extlocalconf
		$registerObject->init();
		$registerObject->registerTemplate();
		return TRUE;
	}

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

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

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

277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
	/**
	 * 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) {
			$this->setCcAddresses(explode(',', $template->getCc()));
			$this->setBccAddresses(explode(',', $template->getBcc()));
			$this->setReplyToAddress($template->getReplyTo());
			$this->setFromAddress($template->getFromMail(), $template->getFromName());
297
			return TRUE;
298
299
		}

300
		return FALSE;
301
302
	}

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

315
316
317
318
319
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

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

				return FALSE;
336
			}
337
338
		}

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

355
		/** @var StandaloneView $emailView */
356
		$emailView = $this->objectManager->get(StandaloneView::class);
357

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

			$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
				);
			}
373
		}
374
		$this->mailMessage->setSubject($subject);
375

376
		$emailView->assignMultiple($this->markers);
377
		$emailBody = $emailView->render();
378

379
380
381
382
		// 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) {
383

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

392
		} else {
393
			$this->addMailToMailQueue($this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority);
394
		}
395
396

		return TRUE;
397
398
399
	}

	/**
400
	 * Adds a new mail to the mail queue.
401
	 *
402
403
	 * @param string $extensionKey
	 * @param string $templateName
404
	 * @param string $subject
405
	 * @param string $emailBody
406
	 * @param int $sendingTime
407
	 * @param int $priority
408
	 * @param bool $sent
409
	 */
410
411
412
	private function addMailToMailQueue(
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0, $sent = FALSE
	) {
413
		$mail = $this->objectManager->get(Mail::class);
414
415
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
416
		$mail->setFromAddress($this->fromAddress);
417
		$mail->setFromName($this->fromName);
418
		$mail->setToAddress($this->toAddresses);
419
		$mail->setMailSubject($subject);
420
		$mail->setMailBody($emailBody);
421
		$mail->setPriority($priority);
422
423
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
424
		$mail->setSent($sent);
425
		$mail->setSendingTime($sendingTime);
426
		$mail->setReplyTo($this->replyToAddress);
427

428
		$mailRepository = $this->objectManager->get(MailRepository::class);
429
		$mailRepository->add($mail);
430
		$this->persistenceManager->persistAll();
431
	}
432

433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
	/**
	 * 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());
448
449
450
			$this->mailMessage->setBcc(explode(',', $mailToSend->getBccAddresses()));
			$this->mailMessage->setCc(explode(',', $mailToSend->getCcAddresses()));
			$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
451
452
453
454
			$this->mailMessage->send();
		}
	}

455
456
	/**
	 * @param array $registerArray
457
	 * @return void
458
	 */
459
	public static function setRegisterArray(array $registerArray) {
460
461
462
463
		self::$registerArray = $registerArray;
	}

	/**
464
	 * @param string $toAddresses
465
466
	 * @return MailTemplateService
	 */
467
468
469
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
470
471
472
473
		return $this;
	}

	/**
474
	 * @param string $fromAddress
475
	 * @param string $fromName
476
477
	 * @return MailTemplateService
	 */
478
	public function setFromAddress($fromAddress, $fromName = '') {
479
		$this->fromAddress = $fromAddress;
480
		$this->mailMessage->setFrom($fromAddress, $fromName);
481
482
483
484
		return $this;
	}

	/**
485
	 * @param string $ccAddresses
486
487
	 * @return MailTemplateService
	 */
488
	public function setCcAddresses($ccAddresses) {
489
		$this->ccAddresses = $ccAddresses;
490
		$this->mailMessage->setCc(explode(',', $this->ccAddresses));
491
492
493
494
		return $this;
	}

	/**
495
	 * @param string $replyToAddress
496
497
	 * @return MailTemplateService
	 */
498
	public function setReplyToAddress($replyToAddress) {
499
		$this->replyToAddress = $replyToAddress;
500
		$this->mailMessage->setReplyTo($replyToAddress);
501
502
503
504
505
506
507
508
509
510
511
512
513
514
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
		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;
	}

540
	/**
541
	 * @param array $markers
542
543
	 * @return MailTemplateService
	 */
544
545
	public function setMarkers(array $markers) {
		$this->markers = $markers;
546
547
		return $this;
	}
548
549

	/**
550
	 * @param string $bccAddresses
551
552
	 * @return MailTemplateService
	 */
553
554
555
	public function setBccAddresses($bccAddresses) {
		$this->bccAddresses = $bccAddresses;
		$this->mailMessage->setBcc(explode(',', $this->bccAddresses));
556
557
558
		return $this;
	}

559
560
561
562
563
564
565
566
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581

	/**
	 * @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;
	}
582
583
584
585
586
587
588
589

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

590
591
592
593
594
595
596
597
598
599
	/**
	 * 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());
600
601
602
603
604
605
606
607
608
		$this->setFromName($template->getFromName());
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
609
	}
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630

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