ConfigurableLogoutTarget.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\components\Authentication\Logout;

use ilLink;
use ilObject;
use ilSetting;
use ILIAS\Data\URI;
use ilCtrlInterface;
use InvalidArgumentException;
use ILIAS\Authentication\Logout\LogoutDestinations;
use ilAccessHandler;

class ConfigurableLogoutTarget implements LogoutTarget
{
    public const INTERNAL_RESSOURCE = 'internal_ressource';
    public const EXTERNAL_RESSOURCE = 'external_ressource';

    public function __construct(
        private readonly ilCtrlInterface $ctrl,
        private readonly ilSetting $settings,
        private readonly ilAccessHandler $access,
        private readonly string $http_path = ILIAS_HTTP_PATH,
    ) {
    }

    public function asURI(): URI
    {
        switch ($this->settings->get('logout_behaviour', '')) {
            case LogoutDestinations::LOGIN_SCREEN->value:
                return LogoutDestinations::LOGIN_SCREEN->asURI($this->ctrl, $this->http_path);

            case self::INTERNAL_RESSOURCE:
                $ref_id = (int) $this->settings->get('logout_behaviour_ref_id', '0');
                if ($this->isValidInternalResource($ref_id)) {
                    return new URI(ilLink::_getStaticLink($ref_id));
                }

                break;

            case self::EXTERNAL_RESSOURCE:
                $url = $this->settings->get('logout_behaviour_url', '');
                if ($url && $this->isValidExternalResource($url)) {
                    return new URI($url);
                }
                break;

            case LogoutDestinations::LOGOUT_SCREEN->value:
            default:
                break;
        }

        return LogoutDestinations::LOGOUT_SCREEN->asURI($this->ctrl, $this->http_path);
    }

    public function isValidInternalResource(int $ref_id): bool
    {
        return $this->isInRepository($ref_id) && $this->isAnonymousAccessible($ref_id);
    }

    public function isInRepository(int $ref_id): bool
    {
        return ilObject::_exists($ref_id, true) && !ilObject::_isInTrash($ref_id);
    }

    public function isAnonymousAccessible(int $ref_id): bool
    {
        return $this->access->checkAccessOfUser(ANONYMOUS_USER_ID, 'read', '', $ref_id);
    }

    public function isValidExternalResource(string $url): bool
    {
        try {
            $uri = new URI($url);
        } catch (InvalidArgumentException) {
            return false;
        }

        return filter_var($url, FILTER_VALIDATE_URL) !== false;
    }
}