Mail Feature: Scheduled Sending of Mails #10243
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,177 @@ | ||||||||
| <?php | ||||||||
|
|
||||||||
| /** | ||||||||
| * This file is part of ILIAS, a powerful learning management system | ||||||||
| * published by ILIAS open source e-Learning e.V. | ||||||||
| * | ||||||||
| * ILIAS is licensed with the GPL-3.0, | ||||||||
| * see https://www.gnu.org/licenses/gpl-3.0.en.html | ||||||||
| * You should have received a copy of said license along with the | ||||||||
| * source code, too. | ||||||||
| * | ||||||||
| * If this is not the case or you just want to try ILIAS, you'll find | ||||||||
| * us at: | ||||||||
| * https://www.ilias.de | ||||||||
| * https://github.com/ILIAS-eLearning | ||||||||
| * | ||||||||
| *********************************************************************/ | ||||||||
|
|
||||||||
| declare(strict_types=1); | ||||||||
|
|
||||||||
| namespace ILIAS\Mail; | ||||||||
|
|
||||||||
| use ilMail; | ||||||||
| use ilContext; | ||||||||
| use ilObjUser; | ||||||||
| use ilSetting; | ||||||||
| use ilLanguage; | ||||||||
| use DateTimeZone; | ||||||||
| use ilFormatMail; | ||||||||
| use ilDBInterface; | ||||||||
| use DateTimeImmutable; | ||||||||
| use ILIAS\Cron\CronJob; | ||||||||
| use ILIAS\Cron\Job\JobResult; | ||||||||
| use ILIAS\Cron\Job\JobManager; | ||||||||
| use ILIAS\HTTP\GlobalHttpState; | ||||||||
| use ILIAS\Cron\Job\Schedule\JobScheduleType; | ||||||||
| use ilLoggerFactory; | ||||||||
| use Generator; | ||||||||
|
|
||||||||
| class ilMailCronTerminatedMails extends CronJob | ||||||||
| { | ||||||||
| private GlobalHttpState $http; | ||||||||
| private ilLanguage $lng; | ||||||||
| private ilSetting $settings; | ||||||||
| private ilDBInterface $db; | ||||||||
| private ilObjUser $user; | ||||||||
| private bool $init_done = false; | ||||||||
| private JobManager $cron_manager; | ||||||||
| private ilMail $mail; | ||||||||
| private ilFormatMail $umail; | ||||||||
|
Comment on lines
+42
to
+50
There was a problem hiding this comment. Could we make them |
||||||||
|
|
||||||||
| private function init(): void | ||||||||
| { | ||||||||
| global $DIC; | ||||||||
|
|
||||||||
| if (!$this->init_done) { | ||||||||
| $this->settings = $DIC->settings(); | ||||||||
| $this->lng = $DIC->language(); | ||||||||
| $this->db = $DIC->database(); | ||||||||
| $this->user = $DIC->user(); | ||||||||
| $this->http = $DIC->http(); | ||||||||
| $this->cron_manager = $DIC->cron()->manager(); | ||||||||
| $this->mail = new ilMail($this->user->getId()); | ||||||||
| $this->umail = new ilFormatMail($this->user->getId()); | ||||||||
|
|
||||||||
| $this->lng->loadLanguageModule('mail'); | ||||||||
| $this->init_done = true; | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| public function getId(): string | ||||||||
| { | ||||||||
| return 'mail_terminated_mails'; | ||||||||
| } | ||||||||
|
|
||||||||
| public function getTitle(): string | ||||||||
| { | ||||||||
| $this->init(); | ||||||||
|
|
||||||||
| return $this->lng->txt('mail_cron_terminated_mails'); | ||||||||
| } | ||||||||
|
|
||||||||
| public function getDescription(): string | ||||||||
| { | ||||||||
| $this->init(); | ||||||||
|
|
||||||||
| return $this->lng->txt('mail_cron_terminated_mails_desc'); | ||||||||
| } | ||||||||
|
|
||||||||
| public function hasAutoActivation(): bool | ||||||||
| { | ||||||||
| return true; | ||||||||
| } | ||||||||
|
|
||||||||
| public function hasFlexibleSchedule(): bool | ||||||||
| { | ||||||||
| return true; | ||||||||
| } | ||||||||
|
|
||||||||
| public function getDefaultScheduleType(): JobScheduleType | ||||||||
| { | ||||||||
| return JobScheduleType::DAILY; | ||||||||
| } | ||||||||
|
|
||||||||
| public function getDefaultScheduleValue(): ?int | ||||||||
| { | ||||||||
| return 1; | ||||||||
| } | ||||||||
|
|
||||||||
| public function run(): JobResult | ||||||||
| { | ||||||||
| $this->init(); | ||||||||
|
|
||||||||
| $job_result = new JobResult(); | ||||||||
| $job_result->setStatus(JobResult::STATUS_OK); | ||||||||
|
|
||||||||
| ilLoggerFactory::getLogger('mail')->info('Start sending terminated mails from all users.'); | ||||||||
|
|
||||||||
| $mails = $this->getOutboxMails(); | ||||||||
| $sent_mail_ids = []; | ||||||||
| foreach ($mails as $mail) { | ||||||||
| try { | ||||||||
| $mailer = $this->umail | ||||||||
| ->withContextId(ilContext::CONTEXT_CRON); | ||||||||
|
|
||||||||
| $mailer->setSaveInSentbox(true); | ||||||||
|
|
||||||||
| $mailer->autoresponder()->enableAutoresponder(); | ||||||||
| $errors = $mailer->enqueue( | ||||||||
| $mail['rcp_to'], | ||||||||
| $mail['rcp_cc'], | ||||||||
| $mail['rcp_bcc'], | ||||||||
| $mail['m_subject'], | ||||||||
| $mail['m_message'], | ||||||||
| unserialize($mail['attachments'], ['allowed_classes' => false]), | ||||||||
| (bool) ($mail['use_placeholders'] ?? false) | ||||||||
| ); | ||||||||
|
|
||||||||
| if (empty($errors)) { | ||||||||
| $sent_mail_ids[] = (int) ($mail['mail_id'] ?? 0); | ||||||||
| } | ||||||||
| } catch (\Exception $e) { | ||||||||
| $job_result->setStatus(JobResult::STATUS_FAIL); | ||||||||
| ilLoggerFactory::getLogger('mail')->error( | ||||||||
| 'Error sending terminated mail with id ' . ($mail['mail_id'] ?? 'unknown') . ': ' . $e->getMessage() | ||||||||
| ); | ||||||||
| $job_result->setMessage($e->getMessage()); | ||||||||
| return $job_result; | ||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||
| } | ||||||||
| } | ||||||||
| $this->mail->deleteMails($sent_mail_ids); | ||||||||
| ilLoggerFactory::getLogger('mail')->info( | ||||||||
| 'Sent ' . count($sent_mail_ids) . ' terminated mails and removed them from outbox.' | ||||||||
| ); | ||||||||
| $job_result->setMessage('Processed ' . count($sent_mail_ids) . ' mails.'); | ||||||||
| return $job_result; | ||||||||
| } | ||||||||
|
|
||||||||
| public function getOutboxMails(): Generator | ||||||||
|
There was a problem hiding this comment. It would be good if we could describe the shape of the array and use this type in the Genertor. ...
/**
* @phpstan-type MailWithFolderDatabaseRecordType array{
* obj_id: int,
* }
*/
class ilMail
{
...AI could really help to define such record types. You could then use ...
/**
* @phpstan-import-type MailWithFolderDatabaseRecordType from \ilMail
*/
class MailConsumer
{
... |
||||||||
| { | ||||||||
| $res = $this->db->queryF( | ||||||||
| <<<'SQL' | ||||||||
| SELECT * FROM mail | ||||||||
| JOIN mail_obj_data ON mail.folder_id = mail_obj_data.obj_id | ||||||||
| WHERE mail_obj_data.m_type = %s | ||||||||
| AND send_time IS NOT NULL | ||||||||
| AND send_time <= %s | ||||||||
| SQL, | ||||||||
| ['text', 'timestamp'], | ||||||||
|
There was a problem hiding this comment. Please use |
||||||||
| ['outbox', (new DateTimeImmutable('NOW', new DateTimeZone('UTC')))->format('Y-m-d H:i:s')] | ||||||||
| ); | ||||||||
|
|
||||||||
| while ($row = $this->db->fetchAssoc($res)) { | ||||||||
| yield $row; | ||||||||
| } | ||||||||
| } | ||||||||
| } | ||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use a
DateTimeImmutablehere.Since the "Schedule Date/Time" is a future date/time, we MUST NOT store this a UTC.
We MUST use the user timezone and the corresponding date/time string. Storing this as UTC can lead to issues like described here: https://andreas.heigl.org/2016/12/22/why-not-to-convert-a-datetime-to-timestamp/ / https://heiglandreas.github.io/slidedeck/time_is_an_illusion/20191113_aachen/index.html#/
So I recommend introducing two new explicit database fields in a database update objective.