3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
10 * Copyright © 2009-2023 The Galette Team
12 * This file is part of Galette (http://galette.tuxfamily.org).
14 * Galette is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * Galette is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with Galette. If not, see <http://www.gnu.org/licenses/>.
30 * @author Johan Cwiklinski <johan@x-tnd.be>
31 * @copyright 2009-2023 The Galette Team
32 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
33 * @link http://galette.tuxfamily.org
34 * @since Available since 0.7dev - 2009-03-07
37 namespace Galette\Core
;
41 use Galette\Entity\Adherent
;
43 use Laminas\Db\ResultSet\ResultSet
;
51 * @author Johan Cwiklinski <johan@x-tnd.be>
52 * @copyright 2009-2023 The Galette Team
53 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
54 * @link http://galette.tuxfamily.org
55 * @since Available since 0.7dev - 2009-03-07
57 * @property string $subject
58 * @property string $message
59 * @property boolean $html
60 * @property integer $current_step
61 * @property-read integer $step
62 * @property integer|string $id
63 * @property-read string $alt_message
64 * @property-read string $wrapped_message
65 * @property-read PHPMailer\PHPMailer\PHPMailer $mail
66 * @property-read PHPMailer\PHPMailer\PHPMailer $_mail
67 * @property-read array $errors
68 * @property-read array $recipients
69 * @property-read string|false $tmp_path
70 * @property array $attachments
71 * @property-read string $sender_name
72 * @property-read string $sender_address
73 * @property integer $history_id
75 class Mailing
extends GaletteMail
77 public const STEP_START
= 0;
78 public const STEP_PREVIEW
= 1;
79 public const STEP_SEND
= 2;
80 public const STEP_SENT
= 3;
82 public const MIME_HTML
= 'text/html';
83 public const MIME_TEXT
= 'text/plain';
84 public const MIME_DEFAULT
= self
::MIME_TEXT
;
88 private $unreachables = array();
89 private $mrecipients = array();
90 private $current_step;
100 * @param Preferences $preferences Preferences instance
101 * @param array $members An array of members
102 * @param int $id Identifier, defaults to null
104 public function __construct(Preferences
$preferences, array $members = [], int $id = null)
106 parent
::__construct($preferences);
107 $this->id
= $id ??
$this->generateNewId();
109 $this->current_step
= self
::STEP_START
;
110 $this->mime_type
= self
::MIME_DEFAULT
;
111 /** TODO: add a preference that propose default mime-type to use,
113 if (count($members)) {
114 //Check which members have a valid email address and which have not
115 $this->setRecipients($members);
117 $this->loadAttachments();
121 * Generate new mailing id and temporary path
125 private function generateNewId(): string
128 $chars = 'abcdefghjkmnpqrstuvwxyz0123456789';
131 while ($i <= $size - 1) {
132 $num = mt_rand(0, strlen($chars) - 1) %
strlen($chars);
133 $id .= substr($chars, $num, 1);
138 $this->generateTmpPath($this->id
);
143 * Generate temporary path
145 * @param string $id Random id, defautls to null
149 private function generateTmpPath($id = null)
152 $id = $this->generateNewId();
154 $this->tmp_path
= GALETTE_ATTACHMENTS_PATH
. '/' . $id;
158 * Load mailing attachments
162 private function loadAttachments()
166 isset($this->tmp_path
)
167 && trim($this->tmp_path
) !== ''
169 $dir = $this->tmp_path
;
171 $dir = GALETTE_ATTACHMENTS_PATH
. $this->id
. '/';
174 $files = glob($dir . '*.*');
175 foreach ($files as $file) {
177 $f->setFileName(str_replace($dir, '', $file));
178 $this->attachments
[] = $f;
183 * Loads a mailing from history
185 * @param ArrayObject $rs Mailing entry
186 * @param boolean $new True if we create a 'new' mailing,
187 * false otherwise (from preview for example)
191 public function loadFromHistory(ArrayObject
$rs, $new = true)
195 $orig_recipients = unserialize($rs->mailing_recipients
);
197 $_recipients = array();
198 $mdeps = ['parent' => true];
199 foreach ($orig_recipients as $k => $v) {
200 $m = new Adherent($zdb, $k, $mdeps);
203 $this->setRecipients($_recipients);
204 $this->subject
= $rs->mailing_subject
;
205 $this->message
= $rs->mailing_body
;
206 if ($rs->mailing_sender_name
!== null ||
$rs->mailing_sender_address
!== null) {
208 $rs->mailing_sender_name
,
209 $rs->mailing_sender_address
212 //if mailing has already been sent, generate a new id and copy attachments
213 if ($rs->mailing_sent
&& $new) {
214 $this->generateNewId();
215 $this->copyAttachments($rs->mailing_id
);
217 $this->tmp_path
= null;
218 $this->id
= $rs->mailing_id
;
219 if (!$this->attachments
) {
220 $this->loadAttachments();
222 $this->history_id
= $rs->mailing_id
;
228 * Copy attachments from another mailing
230 * @param int $id Original mailing id
234 private function copyAttachments($id)
236 $source_dir = GALETTE_ATTACHMENTS_PATH
. $id . '/';
237 $dest_dir = GALETTE_ATTACHMENTS_PATH
. $this->id
. '/';
239 if (file_exists($source_dir)) {
240 if (file_exists($dest_dir)) {
241 throw new \
RuntimeException(
245 'Attachments directory already exists for mailing %s!'
251 //copy attachments from source mailing and populate attachments
252 $this->attachments
= array();
253 $files = glob($source_dir . '*.*');
254 foreach ($files as $file) {
255 $f = new File($source_dir);
256 $f->setFileName(str_replace($source_dir, '', $file));
257 $f->copyTo($dest_dir);
258 $this->attachments
[] = $f;
263 'No attachments in source directory',
270 * Apply final header to email and send it :-)
274 public function send()
277 foreach ($this->mrecipients
as $member) {
278 $email = $member->getEmail();
279 $m[$email] = $member->sname
;
281 parent
::setRecipients($m);
282 return parent
::send();
286 * Set mailing recipients
288 * @param array $members Array of Adherent objects
292 public function setRecipients($members)
295 $this->mrecipients
= array();
296 $this->unreachables
= array();
298 foreach ($members as $member) {
299 $email = $member->getEmail();
301 if (trim($email) != '' && self
::isValidEmail($email)) {
302 if (!in_array($member, $this->mrecipients
)) {
303 $this->mrecipients
[] = $member;
305 $m[$email] = $member->sname
;
307 if (!in_array($member, $this->unreachables
)) {
308 $this->unreachables
[] = $member;
312 return parent
::setRecipients($m);
316 * Store maling attachments
318 * @param array $files Array of uploaded files to store
320 * @return true|int error code
322 public function store($files)
324 if ($this->tmp_path
=== null) {
325 $this->generateTmpPath();
328 if (!file_exists($this->tmp_path
)) {
329 //directory does not exist, create it
330 mkdir($this->tmp_path
);
333 if (!is_dir($this->tmp_path
)) {
334 throw new \
RuntimeException(
335 $this->tmp_path
. ' should be a directory!'
340 $attachment = new File($this->tmp_path
);
341 $res = $attachment->store($files);
345 $this->attachments
[] = $attachment;
352 * Move attachments with final id once mailing has been stored
354 * @param int $id Mailing history id
358 public function moveAttachments($id)
361 isset($this->tmp_path
)
362 && trim($this->tmp_path
) !== ''
363 && count($this->attachments
) > 0
365 foreach ($this->attachments
as &$attachment) {
366 $old_path = $attachment->getDestDir() . $attachment->getFileName();
367 $new_path = GALETTE_ATTACHMENTS_PATH
. $id . '/' .
368 $attachment->getFileName();
369 if (!file_exists(GALETTE_ATTACHMENTS_PATH
. $id)) {
370 mkdir(GALETTE_ATTACHMENTS_PATH
. $id);
372 $moved = rename($old_path, $new_path);
374 $attachment->setDestDir(GALETTE_ATTACHMENTS_PATH
);
377 rmdir($this->tmp_path
);
378 $this->tmp_path
= null;
383 * Remove specified attachment
385 * @param string $name Filename
389 public function removeAttachment($name)
393 isset($this->tmp_path
)
394 && trim($this->tmp_path
) !== ''
395 && file_exists($this->tmp_path
)
397 $to_remove = $this->tmp_path
;
398 } elseif (file_exists(GALETTE_ATTACHMENTS_PATH
. $this->id
)) {
399 $to_remove = GALETTE_ATTACHMENTS_PATH
. $this->id
;
402 if ($to_remove !== null) {
403 $to_remove .= '/' . $name;
405 if (!$this->attachments
) {
406 $this->loadAttachments();
409 if (file_exists($to_remove)) {
411 foreach ($this->attachments
as $att) {
412 if ($att->getFileName() == $name) {
413 unset($this->attachments
[$i]);
424 'File %file does not exists and cannot be removed!'
430 throw new \
RuntimeException(
431 'Unable to get attachments path!'
437 * Remove mailing attachments
439 * @param boolean $temp Remove only tmporary attachments,
440 * to avoid history breaking
444 public function removeAttachments($temp = false)
448 isset($this->tmp_path
)
449 && trim($this->tmp_path
) !== ''
450 && file_exists($this->tmp_path
)
452 $to_remove = $this->tmp_path
;
453 } elseif (file_exists(GALETTE_ATTACHMENTS_PATH
. $this->id
)) {
454 if ($temp === true) {
457 $to_remove = GALETTE_ATTACHMENTS_PATH
. $this->id
;
460 if ($to_remove !== null) {
461 $rdi = new \
RecursiveDirectoryIterator(
463 \FilesystemIterator
::SKIP_DOTS
465 $contents = new \
RecursiveIteratorIterator(
467 \RecursiveIteratorIterator
::CHILD_FIRST
469 foreach ($contents as $path) {
470 if ($path->isFile()) {
471 unlink($path->getPathname());
473 rmdir($path->getPathname());
481 * Return textual error message
483 * @param int $code The error code
485 * @return string Localized message
487 public function getAttachmentErrorMessage($code)
489 $f = new File($this->tmp_path
);
490 return $f->getErrorMessage($code);
494 * Does mailing already exists in history?
498 public function existsInHistory()
500 return isset($this->history_id
);
504 * Global getter method
506 * @param string $name name of the property we want to retrive
508 * @return mixed the called property
510 public function __get($name)
512 $forbidden = array('ordered');
513 if (!in_array($name, $forbidden)) {
516 return $this->cleanedHtml();
518 return $this->current_step
;
520 return $this->getSubject();
522 return $this->getMessage();
523 case 'wrapped_message':
524 return $this->getWrappedMessage();
526 return $this->isHTML();
529 return $this->getPhpMailer();
531 return $this->getErrors();
533 return $this->mrecipients
;
535 if (isset($this->tmp_path
) && trim($this->tmp_path
) !== '') {
536 return $this->tmp_path
;
542 return $this->attachments
;
544 return $this->getSenderName();
545 case 'sender_address':
546 return $this->getSenderAddress();
551 '[' . get_class($this) . 'Trying to get ' . $name,
558 '[' . get_class($this) . 'Unable to get ' . $name,
566 * Global isset method
567 * Required for twig to access properties via __get
569 * @param string $name name of the property we want to retrive
573 public function __isset($name)
575 $forbidden = array('ordered');
576 if (!in_array($name, $forbidden)) {
582 case 'wrapped_message':
591 case 'sender_address':
594 return isset($this->$name);
601 * Global setter method
603 * @param string $name name of the property we want to assign a value to
604 * @param mixed $value a relevant value for the property
608 public function __set($name, $value)
612 $this->setSubject($value);
615 $this->setMessage($value);
618 if (is_bool($value)) {
619 $this->isHTML($value);
622 '[' . get_class($this) . '] Value for field `' . $name .
623 '` should be boolean - (' . gettype($value) . ')' .
632 && ($value == self
::STEP_START
633 ||
$value == self
::STEP_PREVIEW
634 ||
$value == self
::STEP_SEND
635 ||
$value == self
::STEP_SENT
)
637 $this->current_step
= (int)$value;
640 '[' . get_class($this) . '] Value for field `' . $name .
641 '` should be integer and know - (' . gettype($value) . ')' .
652 '[' . get_class($this) . '] Unable to set property `' . $name . '`',