class.ilSessionReminderCheck.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Data\Clock\ClockInterface;
use ILIAS\Filesystem\Stream\Streams;
use ILIAS\HTTP\Response\ResponseHeader;
use Psr\Http\Message\ResponseInterface;
use ILIAS\HTTP\GlobalHttpState;
use ILIAS\Refinery\Factory as Refinery;

class ilSessionReminderCheck
{
    private GlobalHttpState $http;
    private Refinery $refinery;
    private ilLanguage $lng;
    private ilDBInterface $db;
    private ilIniFile $clientIni;
    private ilLogger $logger;
    private ClockInterface $clock;

    public function __construct(
        GlobalHttpState $http,
        Refinery $refinery,
        ilLanguage $lng,
        ilDBInterface $db,
        ilIniFile $clientIni,
        ilLogger $logger,
        ClockInterface $utcClock,
    ) {
        $this->http = $http;
        $this->refinery = $refinery;
        $this->lng = $lng;
        $this->db = $db;
        $this->clientIni = $clientIni;
        $this->logger = $logger;
        $this->clock = $utcClock;
    }

    public function handle(): ResponseInterface
    {
        $sessionIdHash = ilUtil::stripSlashes(
            $this->http->wrapper()->post()->retrieve(
                'hash',
                $this->refinery->kindlyTo()->string()
            )
        );

        $this->logger->debug('Session reminder call for session id hash: ' . $sessionIdHash);

        // disable session writing and extension of expiration time
        ilSession::enableWebAccessWithoutSession(true);

        $response = ['remind' => false];

        $res = $this->db->queryF(
            'SELECT expires, user_id, data FROM usr_session WHERE MD5(session_id) = %s',
            ['text'],
            [$sessionIdHash]
        );

        $num = $this->db->numRows($res);

        if (0 === $num) {
            $response['message'] = 'ILIAS could not determine the session data.';
            return $this->toJsonResponse($response);
        }

        if ($num > 1) {
            $response['message'] = 'The determined session data is not unique.';
            return $this->toJsonResponse($response);
        }

        $data = $this->db->fetchAssoc($res);
        if (!$this->isAuthenticatedUsrSession($data)) {
            $response['message'] = 'ILIAS could not fetch the session data or the corresponding user is no more authenticated.';
            return $this->toJsonResponse($response);
        }

        $expiration_time = (int) $data['expires'];
        if (null === $expiration_time) {
            $response['message'] = 'ILIAS could not determine the expiration time from the session data.';
            return $this->toJsonResponse($response);
        }

        if ($this->isSessionAlreadyExpired($expiration_time)) {
            $response['message'] = 'The session is already expired. The client should have received a remind command before.';
            return $this->toJsonResponse($response);
        }

        $ilUser = ilObjectFactory::getInstanceByObjId((int) $data['user_id'], false);
        if (!($ilUser instanceof ilObjUser)) {
            $response['message'] = 'ILIAS could not fetch the session data or the corresponding user is no more authenticated.';
            return $this->toJsonResponse($response);
        }

        $session_reminder = ilSessionReminder::byLoggedInUser();
        $reminder_time = $expiration_time - ($session_reminder->getEffectiveLeadTime() * 60);
        if ($reminder_time > $this->clock->now()->getTimestamp()) {
            // session will expire in <lead_time> minutes
            $response['message'] = 'Lead time not reached, yet. Current time: ' .
                date('Y-m-d H:i:s') . ', Reminder time: ' . date('Y-m-d H:i:s', $reminder_time);
            return $this->toJsonResponse($response);
        }

        $dateTime = new ilDateTime($expiration_time, IL_CAL_UNIX);
        switch ($ilUser->getTimeFormat()) {
            case ilCalendarSettings::TIME_FORMAT_12:
                $formatted_expiration_time = $dateTime->get(IL_CAL_FKT_DATE, 'g:ia', $ilUser->getTimeZone());
                break;

            case ilCalendarSettings::TIME_FORMAT_24:
            default:
                $formatted_expiration_time = $dateTime->get(IL_CAL_FKT_DATE, 'H:i', $ilUser->getTimeZone());
                break;
        }

        $response = [
            'extend_url' => './ilias.php?baseClass=ilDashboardGUI',
            'txt' => str_replace(
                "\\n",
                '%0A',
                sprintf(
                    $this->lng->txt('session_reminder_alert'),
                    ilDatePresentation::secondsToString($expiration_time - $this->clock->now()->getTimestamp()),
                    $formatted_expiration_time,
                    $this->clientIni->readVariable('client', 'name') . ' | ' . ilUtil::_getHttpPath()
                )
            ),
            'remind' => true
        ];

        return $this->toJsonResponse($response);
    }

    private function toJsonResponse($data): ResponseInterface
    {
        return $this->http->response()
            ->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
            ->withBody(Streams::ofString(json_encode($data, JSON_THROW_ON_ERROR)));
    }

    private function isSessionAlreadyExpired(int $expirationTime): bool
    {
        return $expirationTime < $this->clock->now()->getTimestamp();
    }

    private function isAuthenticatedUsrSession(?array $data): bool
    {
        return (
            is_array($data) &&
            isset($data['user_id']) &&
            (int) $data['user_id'] > 0 &&
            (int) $data['user_id'] !== ANONYMOUS_USER_ID
        );
    }
}