ExpiredOrOrphanedMailsCollector.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Mail\Cron\ExpiredOrOrphanedMails;

use ILIAS\Data\Clock\ClockInterface;
use ILIAS\Data\Factory;
use ilSetting;
use ilDBConstants;
use ilMailCronOrphanedMails;
use ilDBInterface;

class ExpiredOrOrphanedMailsCollector
{
    private const PING_THRESHOLD = 500;

    private readonly ilDBInterface $db;
    private readonly ilSetting $settings;
    private readonly ClockInterface $clock;
    private array $mail_ids = [];

    public function __construct(
        private readonly ilMailCronOrphanedMails $job,
        ?ilDBInterface $db = null,
        ?ilSetting $setting = null,
        ?ClockInterface $clock = null
    ) {
        global $DIC;

        $this->db = $db ?? $DIC->database();
        $this->settings = $setting ?? $DIC->settings();
        $this->clock = $clock ?? (new Factory())->clock()->system();

        $this->collect();
    }

    private function collect(): void
    {
        $mail_only_inbox_trash = (bool) $this->settings->get('mail_only_inbox_trash', '0');
        $mail_expiration_warning_days = (int) $this->settings->get('mail_notify_orphaned', '0');

        if ($mail_expiration_warning_days > 0) {
            if ($mail_only_inbox_trash) {
                // Only select determine mails which are now located in the inbox or trash folder
                $res = $this->db->queryF(
                    "
                        SELECT mail_id FROM mail_cron_orphaned 
                        LEFT JOIN mail_obj_data mdata ON mdata.obj_id = folder_id
                        WHERE ts_do_delete <= %s AND ((mdata.m_type = %s OR mdata.m_type = %s) OR mdata.obj_id IS NULL)
                    ",
                    [ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
                    [$this->clock->now()->getTimestamp(), 'inbox', 'trash']
                );
            } else {
                // Select all determined emails independently of the folder
                $res = $this->db->queryF(
                    "SELECT mail_id FROM mail_cron_orphaned WHERE ts_do_delete <= %s",
                    [ilDBConstants::T_INTEGER],
                    [$this->clock->now()->getTimestamp()]
                );
            }
        } else {
            // Mails should be deleted without notification
            $mail_expiration_days = (int) $this->settings->get('mail_threshold', '0');
            $left_interval_datetime = $this->clock->now()->modify('- ' . $mail_expiration_days . ' days');

            $types = [ilDBConstants::T_TIMESTAMP];
            $data = [$left_interval_datetime->format('Y-m-d 23:59:59')];

            $mails_query = "
                                SELECT          m.mail_id
                                FROM            mail m
                                LEFT JOIN       mail_obj_data mdata ON mdata.obj_id = m.folder_id
                                WHERE           m.send_time <= %s
            ";

            if ($mail_only_inbox_trash) {
                $mails_query .= " AND ((mdata.m_type = %s OR mdata.m_type = %s) OR mdata.obj_id IS NULL)";
                $types[] = ilDBConstants::T_TEXT;
                $types[] = ilDBConstants::T_TEXT;
                $data[] = 'inbox';
                $data[] = 'trash';
            }

            $res = $this->db->queryF($mails_query, $types, $data);
        }

        $i = 0;
        while ($row = $this->db->fetchAssoc($res)) {
            if ($i > 0 && $i % self::PING_THRESHOLD) {
                $this->job->ping();
            }

            $this->addMailIdToDelete((int) $row['mail_id']);

            ++$i;
        }
    }

    private function addMailIdToDelete(int $mail_id): void
    {
        $this->mail_ids[] = $mail_id;
    }

    public function mailIdsToDelete(): array
    {
        return $this->mail_ids;
    }
}