class.ilUserCronCheckAccounts.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\Cron\Job\Schedule\JobScheduleType;
use ILIAS\Cron\Job\JobResult;
use ILIAS\Cron\CronJob;
 
class ilUserCronCheckAccounts extends CronJob
{
    protected int $counter = 0;
 
    private ilDBInterface $db;
    private ilLanguage $lng;
    private ilComponentLogger $log;
 
    public function __construct()
    {
        global $DIC;
 
        if (isset($DIC['ilDB'])) {
            $this->db = $DIC['ilDB'];
        }
 
        if (isset($DIC['lng'])) {
            $this->lng = $DIC['lng'];
        }
 
        if (isset($DIC['ilDB'])) {
            $this->log = $DIC['ilLog'];
        }
    }
 
    public function getId(): string
    {
        return 'user_check_accounts';
    }
 
    public function getTitle(): string
    {
        return $this->lng->txt('check_user_accounts');
    }
 
    public function getDescription(): string
    {
        return $this->lng->txt('check_user_accounts_desc');
    }
 
    public function getDefaultScheduleType(): JobScheduleType
    {
        return JobScheduleType::DAILY;
    }
 
    public function getDefaultScheduleValue(): ?int
    {
        return null;
    }
 
    public function hasAutoActivation(): bool
    {
        return false;
    }
 
    public function hasFlexibleSchedule(): bool
    {
        return false;
    }
 
    public function run(): JobResult
    {
        $status = JobResult::STATUS_NO_ACTION;
 
        $now = time();
        $two_weeks_in_seconds = $now + (60 * 60 * 24 * 14); // #14630
 
        // all users who are currently active and expire in the next 2 weeks
        $query = 'SELECT usr_id, login, time_limit_until ' .
            'FROM usr_data ' .
            'WHERE expiration_reminder_sent = 0 ' .
            'AND time_limit_unlimited = 0 ' .
            'AND time_limit_from < ' . $this->db->quote($now, 'integer') . ' ' .
            'AND time_limit_until > ' . $this->db->quote($now, 'integer') . ' ' .
            'AND time_limit_until < ' . $this->db->quote($two_weeks_in_seconds, 'integer');
 
        $res = $this->db->query($query);
 
        while ($row = $this->db->fetchObject($res)) {
            $expires = $row->time_limit_until;
            $login = $row->login;
            $usr_id = $row->usr_id;
 
            $lng = ilLanguageFactory::_getLanguageOfUser($usr_id);
            $lng->loadLanguageModule('mail');
 
            $salutation = ilMail::getSalutation($usr_id, $lng);
 
            $body = $salutation . "\n\n";
            $body .= sprintf(
                $lng->txt('account_expires_body'),
                $login,
                ILIAS_HTTP_PATH,
                date('Y-m-d H:i', $expires)
            );
 
            $body .= "\n\n" . ilMail::_getAutoGeneratedMessageString($lng);
 
            // force email
            $mail = new ilMail(ANONYMOUS_USER_ID);
            $mail->enqueue(
                ilObjUser::_lookupEmail($usr_id),
                '',
                '',
                $lng->txt('account_expires_subject'),
                $body,
                []
            );
 
            // set status 'mail sent'
            $query = 'UPDATE usr_data SET expiration_reminder_sent = 1' . PHP_EOL
                . "WHERE usr_id = {$this->db->quote($usr_id, ilDBConstants::T_INTEGER)}";
            $this->db->query($query);
 
            // Send log message
            $this->log->write('Cron: (checkUserAccounts()) sent message to ' . $login . '.');
 
            $this->counter++;
        }
 
        if ($this->counter) {
            $status = JobResult::STATUS_OK;
        }
        $result = new JobResult();
        $result->setStatus($status);
        return $result;
    }
}