MailTemplateService.php 10.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
30
31
32
33
34
35
36
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
use SGalinski\SgMail\Domain\Repository\MailRepository;
use TYPO3\CMS\Core\Mail\MailMessage;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManager;
use TYPO3\CMS\Fluid\View\StandaloneView;

37
38
39
/**
 * MailTemplateService
 */
40
class MailTemplateService {
41

42
	/**
43
	 * @var array $registerArray
44
	 */
45
	private static $registerArray = [];
46

47
	/**
48
	 * @var array $toAddresses
49
	 */
50
	private $toAddresses = [];
51
52

	/**
53
	 * @var string $fromAddress
54
	 */
55
	private $fromAddress;
56
57

	/**
58
	 * @var array $ccAddresses
59
	 */
60
	private $ccAddresses = [];
61
62

	/**
63
	 * @var string $replyToAddress
64
	 */
65
	private $replyToAddress;
66
67

	/**
68
	 * @var string $language
69
	 */
70
	private $language;
71
72

	/**
73
	 * @var boolean $ignoreMailQueue
74
	 */
75
	private $ignoreMailQueue = FALSE;
76
77
78
79
80
81
82

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

	/**
83
	 * @var string $templateName
84
85
86
87
	 */
	private $templateName;

	/**
88
	 * @var string $extensionKey
89
90
91
92
	 */
	private $extensionKey;

	/**
93
	 * @var array $markers
94
	 */
95
	private $markers = [];
96

97
98
99
	/**
	 * holds the TypoScript configuration for sg_mail
	 *
100
	 * @var array $tsSettings
101
102
103
	 */
	private $tsSettings = [];

104
105
106
107
108
	/**
	 * @var array $bccAddresses
	 */
	private $bccAddresses = [];

109
110
111
112
113
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

114
115
116
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
117
118
119
120
121
122
	protected $templateRepository;

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

124
125
126
127
128
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

129
130
131
132
	/**
	 * MailTemplateService constructor.
	 */
	public function __construct() {
133
134
135
136
137
138
		/** @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);
139
140
		$this->tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
		$this->language = $this->tsSettings['templateDefaultLanguage'];
141
142
143
144
		/** @var TemplateRepository templateRepository */
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		/** @var PersistenceManager persistenceManager */
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
145
146
147

		$this->fromAddress = $this->tsSettings['mail']['default']['from'];
		$this->mailMessage->setFrom($this->fromAddress);
148
		$this->bccAddresses = GeneralUtility::trimExplode(',', $this->tsSettings['mail']['default']['bcc']);
149
150
151
152
153
154
155
156
157
158
159
160
161
162
		$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]);
			}
		}

163
		if (count($this->bccAddresses) > 0) {
164
165
166
			$this->mailMessage->setBcc($this->bccAddresses);
		}

167
		if (count($this->ccAddresses) > 0) {
168
169
			$this->mailMessage->setCc($this->ccAddresses);
		}
170
171
	}

Torsten Oppermann's avatar
Torsten Oppermann committed
172
	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
173
	 * register a template with sg_mail
Fabian Galinski's avatar
Fabian Galinski committed
174
	 *
175
	 * @param string $extension
Torsten Oppermann's avatar
Torsten Oppermann committed
176
177
178
	 * @param string $templateName
	 * @param string $templatePath
	 * @param string $description
179
	 * @param array $markers
180
	 * @param array $subjects
Torsten Oppermann's avatar
Torsten Oppermann committed
181
	 */
182
183
184
	public static function registerTemplate(
		$extension, $templateName, $templatePath, $description, array $markers, array $subjects
	) {
185
		MailTemplateService::$registerArray[$extension][$templateName] = [
186
			'templatePath' => $templatePath,
187
			'description' => $description,
188
			'marker' => $markers,
189
			'extension' => $extension,
190
191
			'templateName' => $templateName,
			'subjects' => $subjects
192
193
		];
	}
194
195

	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
196
	 * Get all registered templates
Fabian Galinski's avatar
Fabian Galinski committed
197
	 *
198
	 * @return array
199
	 */
200
201
	public static function getRegisterArray() {
		return self::$registerArray;
202
	}
203
204

	/**
205
	 * Send the Email
206
	 *
Torsten Oppermann's avatar
Torsten Oppermann committed
207
	 * @param boolean $isPreview
208
	 * @return boolean email was sent or added to mail queue successfully?
209
	 */
210
	public function sendEmail($isPreview = FALSE) {
211
		/** @var Template $template */
212
		$template = $this->templateRepository->findOneByTemplate(
213
			$this->extensionKey, $this->templateName, $this->language
214
		);
215

216
217
218
219
220
221
222
223
		// 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
224
225
				$this->setLanguage('en');
				$this->sendEmail();
226
				return TRUE;
227
			}
228
229
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
230
231
232
233
234
235
		if ($isPreview) {
			$previewMarker = [];
			$markerArray = self::$registerArray[$this->extensionKey][$this->templateName]['marker'];
			foreach ($markerArray as $marker) {
				$previewMarker[$marker['marker']] = $marker['value'];
			}
236
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
237
238
239
			$this->setMarkers($previewMarker);
		}

240
		/** @var StandaloneView $emailView */
241
		$emailView = $this->objectManager->get(StandaloneView::class);
242

243
244
		if (!isset($defaultTemplateContent)) {
			$emailView->setTemplateSource($template->getContent());
245
			$subject = $template->getSubject();
246
247
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
248
			$subject = self::$registerArray[$this->extensionKey][$this->templateName]['subjects'][$this->language];
249
		}
250
		$this->mailMessage->setSubject($subject);
251

252
		$emailView->assignMultiple($this->markers);
253
		$emailBody = $emailView->render();
254

255
256
257
		// 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);
258

259
		if ($this->ignoreMailQueue) {
260
			$this->addMailToMailQueue($subject, $emailBody, $this->priority, TRUE);
261
			$this->mailMessage->setBody($emailBody, 'text/html');
262
			$this->mailMessage->send();
263
		} else {
264
			$this->addMailToMailQueue($subject, $emailBody, $this->priority);
265
		}
266
267

		return TRUE;
268
269
270
	}

	/**
271
	 * Adds a new mail to the mail queue.
272
	 *
273
	 * @param string $subject
274
	 * @param string $emailBody
275
	 * @param int $priority
276
	 * @param bool $sent
277
	 */
278
	private function addMailToMailQueue($subject, $emailBody, $priority, $sent = FALSE) {
279
		$mail = $this->objectManager->get(Mail::class);
280
281
		$mail->setFromAddress($this->fromAddress);
		$mail->setToAddress($this->toAddresses);
282
		$mail->setMailSubject($subject);
283
		$mail->setMailBody($emailBody);
284
		$mail->setPriority($priority);
285
286
		$mail->setBccAddresses(implode(',', $this->bccAddresses));
		$mail->setCcAddresses(implode(',', $this->ccAddresses));
287
		$mail->setSent($sent);
288

289
		$mailRepository = $this->objectManager->get(MailRepository::class);
290
		$mailRepository->add($mail);
291
		$this->persistenceManager->persistAll();
292
	}
293
294
295

	/**
	 * @param array $registerArray
296
	 * @return void
297
	 */
298
	public static function setRegisterArray(array $registerArray) {
299
300
301
302
		self::$registerArray = $registerArray;
	}

	/**
303
	 * @param string $toAddresses
304
305
	 * @return MailTemplateService
	 */
306
307
308
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
309
310
311
312
		return $this;
	}

	/**
313
	 * @param string $fromAddress
314
315
	 * @return MailTemplateService
	 */
316
	public function setFromAddress($fromAddress) {
317
318
		$this->fromAddress = $fromAddress;
		$this->mailMessage->setFrom($fromAddress);
319
320
321
322
		return $this;
	}

	/**
323
	 * @param array|string $ccAddresses
324
325
	 * @return MailTemplateService
	 */
326
	public function setCcAddresses($ccAddresses) {
327
328
		$this->ccAddresses[] = $ccAddresses;
		$this->mailMessage->setCc($this->ccAddresses);
329
330
331
332
		return $this;
	}

	/**
333
	 * @param string $replyToAddress
334
335
	 * @return MailTemplateService
	 */
336
	public function setReplyToAddress($replyToAddress) {
337
		$this->replyToAddress = $replyToAddress;
338
		$this->mailMessage->setReplyTo($replyToAddress);
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
		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;
	}

378
	/**
379
	 * @param array $markers
380
381
	 * @return MailTemplateService
	 */
382
383
	public function setMarkers(array $markers) {
		$this->markers = $markers;
384
385
		return $this;
	}
386
387
388
389
390
391

	/**
	 * @param array $bccAddresses
	 * @return MailTemplateService
	 */
	public function setBccAddresses(array $bccAddresses) {
392
393
		$this->bccAddresses[] = $bccAddresses;
		$this->mailMessage->setBcc($this->bccAddresses);
394
395
396
		return $this;
	}

397
398
399
400
401
402
403
404
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
405
}