class.ilSessionControl.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilSessionControl
{
    public const int DEFAULT_MIN_IDLE = 15;
    public const int DEFAULT_ALLOW_CLIENT_MAINTENANCE = 1;

    private static array $setting_fields = [
        'session_allow_client_maintenance',
    ];

    private const int SESSION_TYPE_UNKNOWN = 0;
    private const int SESSION_TYPE_SYSTEM = 1;
    private const int SESSION_TYPE_ADMIN = 2;
    private const int SESSION_TYPE_USER = 3;
    private const int SESSION_TYPE_ANONYM = 4;

    private const string SESSION_TYPE_KEY = 'SessionType';
    public static array $session_types_controlled = [
        self::SESSION_TYPE_USER,
        self::SESSION_TYPE_ANONYM
    ];

    private static array $session_types_not_controlled = [
        self::SESSION_TYPE_UNKNOWN,
        self::SESSION_TYPE_SYSTEM,
        self::SESSION_TYPE_ADMIN
    ];

    public static function handleLoginEvent(string $a_login, ilAuthSession $auth_session): bool
    {
        $user_id = ilObjUser::_lookupId($a_login);

        // we need the session type for the session statistics
        // regardless of the current session handling type
        switch (true) {
            case isset($_ENV['SHELL']):
                $type = self::SESSION_TYPE_SYSTEM;
                break;

            case $user_id === ANONYMOUS_USER_ID:
                $type = self::SESSION_TYPE_ANONYM;
                break;

            case self::checkAdministrationPermission($user_id):
                $type = self::SESSION_TYPE_ADMIN;
                break;

            default:
                $type = self::SESSION_TYPE_USER;
                break;
        }

        ilSession::set(self::SESSION_TYPE_KEY, $type);
        self::debug(__METHOD__ . ' --> update sessions type to (' . $type . ')');

        return true;
    }

    public static function handleLogoutEvent(): void
    {
    }

    public static function getExistingSessionCount(array $a_types): int
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $ts = time();

        $query = 'SELECT count(session_id) AS num_sessions FROM usr_session ' .
            'WHERE expires > %s ' .
            'AND ' . $ilDB->in('type', $a_types, false, 'integer');

        $res = $ilDB->queryF($query, ['integer'], [$ts]);
        return (int) $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)->num_sessions;
    }

    private static function isValidSession(string $a_sid): bool
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT session_id, expires FROM usr_session ' .
            'WHERE session_id = %s';

        $res = $ilDB->queryF($query, ['text'], [$a_sid]);

        $ts = time();

        $sessions = [];

        while ($row = $ilDB->fetchAssoc($res)) {
            if ($row['expires'] > $ts) {
                self::debug(__METHOD__ . ' --> Found a valid session with id (' . $a_sid . ')');
                $sessions[] = $row;
            } else {
                self::debug(__METHOD__ . ' --> Found an expired session with id (' . $a_sid . ')');
            }
        }

        if (count($sessions) === 1) {
            self::debug(__METHOD__ . ' --> Exact one valid session found for session id (' . $a_sid . ')');

            return true;
        }

        if (count($sessions) > 1) {
            self::debug(__METHOD__ . ' --> Strange!!! More than one sessions found for given session id! (' . $a_sid . ')');
        } else {
            self::debug(__METHOD__ . ' --> No valid session found for session id (' . $a_sid . ')');
        }

        return false;
    }

    private static function removeSessionCookie(): void
    {
        ilUtil::setCookie(session_name(), 'deleted', true, true);
        self::debug('Session cookie has been removed');
    }

    private static function checkAdministrationPermission(int $a_user_id): bool
    {
        if (!$a_user_id) {
            return false;
        }

        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];

        $access = $rbacsystem->checkAccessOfUser(
            $a_user_id,
            'read,visible',
            SYSTEM_FOLDER_ID
        );

        return $access;
    }

    private static function debug(string $a_debug_log_message): void
    {
        global $DIC;

        $logger = $DIC->logger()->auth();

        $logger->debug($a_debug_log_message);
    }

    public static function getSettingFields(): array
    {
        return self::$setting_fields;
    }
}