MailTemplateService.php 16.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

48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
	/**
	 * @var string
	 */
	const MARKER_TYPE_STRING = 'String';

	/**
	 * @var string
	 */
	const MARKER_TYPE_DATE = 'Date';

	/**
	 * @var string
	 */
	const MARKER_TYPE_INTEGER = 'Integer';

63
64
65
66
67
68
69
70
71
72
	/**
	 * @var string
	 */
	const MARKER_TYPE_ARRAY = 'Array';

	/**
	 * @var string
	 */
	const MARKER_TYPE_OBJECT = 'Object';

73
	/**
74
	 * @var array $registerArray
75
	 */
76
	private static $registerArray = [];
77

78
	/**
79
	 * @var array $toAddresses
80
	 */
81
	private $toAddresses = [];
82
83

	/**
84
	 * @var string $fromAddress
85
	 */
86
	private $fromAddress;
87
88

	/**
89
	 * @var array $ccAddresses
90
	 */
91
	private $ccAddresses = [];
92
93

	/**
94
	 * @var string $replyToAddress
95
	 */
96
	private $replyToAddress;
97
98

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

	/**
104
	 * @var boolean $ignoreMailQueue
105
	 */
106
	private $ignoreMailQueue = FALSE;
107
108
109
110
111
112
113

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

	/**
114
	 * @var string $templateName
115
116
117
118
	 */
	private $templateName;

	/**
119
	 * @var string $extensionKey
120
121
122
123
	 */
	private $extensionKey;

	/**
124
	 * @var array $markers
125
	 */
126
	private $markers = [];
127

128
129
130
	/**
	 * holds the TypoScript configuration for sg_mail
	 *
131
	 * @var array $tsSettings
132
133
134
	 */
	private $tsSettings = [];

135
136
137
138
139
	/**
	 * @var array $bccAddresses
	 */
	private $bccAddresses = [];

140
141
142
143
144
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

145
146
147
148
149
	/**
	 * @var string
	 */
	private $fromName = '';

150
151
152
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
153
154
155
156
157
158
	protected $templateRepository;

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

160
161
162
163
164
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

165
166
167
168
169
	/**
	 * @var array
	 */
	private $attachments = [];

170
171
172
173
	/**
	 * MailTemplateService constructor.
	 */
	public function __construct() {
174
175
176
177
178
179
		/** @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);
180
181
		$this->tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
		$this->language = $this->tsSettings['templateDefaultLanguage'];
182
183
184
185
		/** @var TemplateRepository templateRepository */
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		/** @var PersistenceManager persistenceManager */
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
186
187
188

		$this->fromAddress = $this->tsSettings['mail']['default']['from'];
		$this->mailMessage->setFrom($this->fromAddress);
189
		$this->bccAddresses = GeneralUtility::trimExplode(',', $this->tsSettings['mail']['default']['bcc']);
190
191
192
193
194
195
196
197
198
199
200
201
202
203
		$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]);
			}
		}

204
		$this->mailMessage->setFrom($this->fromAddress);
205
		if (count($this->bccAddresses) > 0) {
206
207
208
			$this->mailMessage->setBcc($this->bccAddresses);
		}

209
		if (count($this->ccAddresses) > 0) {
210
211
			$this->mailMessage->setCc($this->ccAddresses);
		}
212
213
	}

Torsten Oppermann's avatar
Torsten Oppermann committed
214
	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
215
	 * register a template with sg_mail
Fabian Galinski's avatar
Fabian Galinski committed
216
	 *
217
218
219
	 * 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
	 *
220
	 * @param string $extension
Torsten Oppermann's avatar
Torsten Oppermann committed
221
222
	 * @param string $templateName
	 * @param string $templatePath
223
	 * @param mixed $description
224
	 * @param array $markers
225
	 * @param mixed $subject
Torsten Oppermann's avatar
Torsten Oppermann committed
226
	 */
227
	public static function registerTemplate(
228
		$extension, $templateName, $templatePath, $description, array $markers, $subject
229
	) {
230
		MailTemplateService::$registerArray[$extension][$templateName] = [
231
			'templatePath' => $templatePath,
232
			'description' => $description,
233
			'marker' => $markers,
234
			'extension' => $extension,
235
			'templateName' => $templateName,
236
			'subject' => $subject
237
238
		];
	}
239

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

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

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

279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
	/**
	 * 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());
299
			return TRUE;
300
301
		}

302
		return FALSE;
303
304
	}

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

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

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

				return FALSE;
338
			}
339
340
		}

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

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

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

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

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

381
382
383
384
		// 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) {
385

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


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

		return TRUE;
399
400
401
	}

	/**
402
	 * Adds a new mail to the mail queue.
403
	 *
404
405
	 * @param string $extensionKey
	 * @param string $templateName
406
	 * @param string $subject
407
	 * @param string $emailBody
408
	 * @param int $sendingTime
409
	 * @param int $priority
410
	 * @param bool $sent
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
490
		$this->ccAddresses = $ccAddresses;
		$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
}