ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler Class Reference

Collaboration diagram for ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler:

Public Member Functions
	__construct (private readonly ilMailCronOrphanedMails $job, private readonly ExpiredOrOrphanedMailsCollector $collector, ?ilDBInterface $db=null, ?ilSetting $setting=null, ?ilLogger $logger=null, ?callable $delete_directory_callback=null)
	delete ()

Private Member Functions
	determineDeletableAttachmentPaths ()
	deleteDirectory (string $directory)
	deleteMails ()
	deleteMarkedAsNotified ()

Private Attributes
const int	PING_THRESHOLD = 250
readonly ilDBInterface	$db
readonly ilSetting	$settings
readonly ilLogger	$logger
readonly ilDBStatement	$mail_ids_for_path_stmt
	$delete_directory_callback

Detailed Description

Definition at line 36 of file MailDeletionHandler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::__construct	(	private readonly ilMailCronOrphanedMails	$job,
		private readonly ExpiredOrOrphanedMailsCollector	$collector,
		?ilDBInterface	$db = null,
		?ilSetting	$setting = null,
		?ilLogger	$logger = null,
		?callable	$delete_directory_callback = null
	)

Parameters

callable(string)

void|null $delete_directory_callback

Definition at line 50 of file MailDeletionHandler.php.

References ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\$delete_directory_callback, $DIC, ILIAS\$setting, ilLoggerFactory\getLogger(), ILIAS\Repository\logger(), ILIAS\Repository\settings(), and ilDBConstants\T_TEXT.

      {
        global $DIC;

        $this->db = $db ?? $DIC->database();
        $this->settings = $setting ?? $DIC->settings();
        $this->logger = $logger ?? ilLoggerFactory::getLogger('mail');
        $this->delete_directory_callback = $delete_directory_callback;

        $this->mail_ids_for_path_stmt = $this->db->prepare(
            'SELECT COUNT(*) cnt FROM mail_attachment WHERE path = ?',
            [ilDBConstants::T_TEXT]
        );
    }

Here is the call graph for this function:

Member Function Documentation

delete()

ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::delete

(

)

Definition at line 210 of file MailDeletionHandler.php.

References ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\deleteMails(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\deleteMarkedAsNotified(), and ILIAS\Repository\logger().

                            : void
    {
        if ($this->collector->mailIdsToDelete() !== []) {
            $this->deleteAttachments();

            $this->deleteMails();

            $this->logger->info(
                \sprintf(
                    'Deleted mail_ids: %s',
                    implode(', ', $this->collector->mailIdsToDelete())
                )
            );

            $this->deleteMarkedAsNotified();
            $this->logger->info(
                \sprintf(
                    'Deleted mail_cron_orphaned mail_ids: %s',
                    implode(', ', $this->collector->mailIdsToDelete())
                )
            );
        }
    }

Here is the call graph for this function:

deleteDirectory()

ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::deleteDirectory ( string  $directory )

private

Definition at line 114 of file MailDeletionHandler.php.

References Vendor\Package\$e, $path, CLIENT_DATA_DIR, ilFileUtils\delDir(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\determineDeletableAttachmentPaths(), ILIAS\Repository\logger(), null, and ilDBConstants\T_INTEGER.

                                                       : void
    {
        if ($this->delete_directory_callback !== null) {
            \call_user_func($this->delete_directory_callback, $directory);
        } else {
            ilFileUtils::delDir($directory);
        }
    }

Here is the call graph for this function:

deleteMails()

ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::deleteMails ( )

private

Definition at line 190 of file MailDeletionHandler.php.

References ilDBConstants\T_INTEGER.

Referenced by ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\delete().

                                  : void
    {
        $this->db->manipulate(
            'DELETE FROM mail WHERE ' .
            $this->db->in('mail_id', $this->collector->mailIdsToDelete(), false, ilDBConstants::T_INTEGER)
        );
    }

Here is the caller graph for this function:

deleteMarkedAsNotified()

ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::deleteMarkedAsNotified ( )

private

Definition at line 198 of file MailDeletionHandler.php.

References ILIAS\Repository\settings(), and ilDBConstants\T_INTEGER.

Referenced by ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\delete().

                                             : void
    {
        if ((int) $this->settings->get('mail_notify_orphaned', '0') >= 1) {
            $this->db->manipulate(
                'DELETE FROM mail_cron_orphaned WHERE ' .
                $this->db->in('mail_id', $this->collector->mailIdsToDelete(), false, ilDBConstants::T_INTEGER)
            );
        } else {
            $this->db->manipulate('DELETE FROM mail_cron_orphaned');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

determineDeletableAttachmentPaths()

ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::determineDeletableAttachmentPaths ( )

private

Returns

list<string>

Definition at line 74 of file MailDeletionHandler.php.

References $res, ILIAS\Repository\int(), and ilDBConstants\T_INTEGER.

Referenced by ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\deleteDirectory().

                                                        : array
    {
        $attachment_paths = [];

        $res = $this->db->query(
            '
                                SELECT path, COUNT(mail_id) cnt_mail_ids
                                FROM mail_attachment 
                                WHERE ' . $this->db->in(
                'mail_id',
                $this->collector->mailIdsToDelete(),
                false,
                ilDBConstants::T_INTEGER
            ) . ' GROUP BY path'
        );

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

            $num_usages_total = (int) $this->db->fetchAssoc(
                $this->db->execute(
                    $this->mail_ids_for_path_stmt,
                    [$row['path']]
                )
            )['cnt'];
            $num_usages_within_deleted_mails = (int) $row['cnt_mail_ids'];

            if ($num_usages_within_deleted_mails >= $num_usages_total) {
                $attachment_paths[] = $row['path'];
            }

            ++$i;
        }

        return $attachment_paths;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$db

readonly ilDBInterface ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::$db

private

Definition at line 40 of file MailDeletionHandler.php.

$delete_directory_callback

ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::$delete_directory_callback

private

Definition at line 45 of file MailDeletionHandler.php.

Referenced by ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\__construct().

$logger

readonly ilLogger ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::$logger

private

Definition at line 42 of file MailDeletionHandler.php.

$mail_ids_for_path_stmt

readonly ilDBStatement ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::$mail_ids_for_path_stmt

private

Definition at line 43 of file MailDeletionHandler.php.

$settings

readonly ilSetting ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::$settings

private

Definition at line 41 of file MailDeletionHandler.php.

PING_THRESHOLD

const int ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler::PING_THRESHOLD = 250

private

Definition at line 38 of file MailDeletionHandler.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Mail/classes/Cron/ExpiredOrOrphanedMails/MailDeletionHandler.php