HandlerService.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\StaticURL\Handler;
 
use ILIAS\StaticURL\Request\Request;
use ILIAS\StaticURL\Request\RequestBuilder;
use ILIAS\Data\URI;
use ILIAS\StaticURL\Response\Factory;
use ILIAS\StaticURL\Context;
use ILIAS\StaticURL\Builder\StandardURIBuilder;
use ILIAS\StaticURL\Response\MaybeCanHandlerAfterLogin;
use ILIAS\StaticURL\Response\CannotReach;
use ILIAS\StaticURL\Response\CannotHandle;
use ILIAS\StaticURL\Session\SessionStore;
use ILIAS\StaticURL\StaticURLConfig;
 
class HandlerService
{
    private Factory $response_factory;
    private array $handlers = [];
 
    public function __construct(
        private RequestBuilder $request_builder,
        private Context $context,
        private array $handler_instances,
        private SessionStore $session_store
    ) {
        $this->response_factory = new Factory($context);
        // check handlers
        foreach ($handler_instances as $handler_instance) {
            if (!$handler_instance instanceof Handler) {
                throw new \InvalidArgumentException(
                    'Handler instances must implement the Handler interface'
                );
            }
        }
    }
 
    public function initHandler(): void
    {
        foreach ($this->handler_instances as $handler) {
            if (isset($this->handlers[$handler->getNamespace()])) {
                throw new \LogicException("Namespace-Collision detected: " . $handler->getNamespace());
            }
            $this->handlers[$handler->getNamespace()] = $handler;
            if ($handler instanceof AliasedHandler) {
                foreach ($handler->getNamespaceAliasses() as $namespace_aliass) {
                    if (isset($this->handlers[$namespace_aliass])) {
                        throw new \LogicException("Namespace-Collision detected: " . $namespace_aliass);
                    }
                    $this->handlers[$namespace_aliass] = $handler;
                }
            }
        }
    }
 
    public function performRedirect(URI $base_uri): void
    {
        if (empty($this->handlers)) {
            $this->initHandler();
        }
 
        $http = $this->context->http();
 
        $request = $this->request_builder->buildRequest(
            $http,
            $this->context->refinery(),
            $this->handlers
        );
        if (!$request instanceof Request) {
            throw new \RuntimeException('No request could be built');
        }
 
        $handler = $this->handlers[$request->getNamespace()] ?? null;
        if (!$handler instanceof Handler) {
            throw new \InvalidArgumentException('No handler found for namespace ' . $request->getNamespace());
        }
        $response = $handler->handle($request, $this->context, $this->response_factory);
 
        if ($response instanceof CannotHandle) {
            $http->saveResponse(
                $http->response()->withStatus(404),
            );
            $http->sendResponse();
            $http->close();
        }
 
        $uri_builder = new StandardURIBuilder(new StaticURLConfig());
 
        switch (true) {
            case $response instanceof MaybeCanHandlerAfterLogin:
                $target = $uri_builder->buildTarget(
                    $request->getNamespace(),
                    $request->getReferenceId(),
                    $request->getAdditionalParameters()
                );
                $full_uri = $base_uri . "/login.php?target=";
                $full_uri .= str_replace('/', '_', rtrim($target, '/')); // TODO: ILIAS currently need this like this
                if (!$this->context->isUserLoggedIn()) {
                    $full_uri .= '&cmd=force_login&lang=' . $this->context->getUserLanguage();
                }
                $full_uri = $this->appendUnknownParameters($this->context, $full_uri); // Read the comment below
                break;
            case $response instanceof CannotReach:
                $full_uri = $this->buildCannotReachRedirect($base_uri, $request);
                break;
            default:
                // Perform Redirect
                $uri_path = $response->getURIPath() ?? '';
                $base_path = $base_uri->getPath() ?? '';
                if ($base_path !== '' && $base_path !== '/') {
                    $uri_path = str_replace(rtrim($base_path, '/') . '/', '', $uri_path);
                }
 
                for ($x = 0; $x < $response->shift(); $x++) {
                    $base_uri = $base_uri->withPath(dirname((string) $base_uri->getPath()));
                }
 
                $full_uri = $base_uri . '/' . trim((string) $uri_path, '/');
                break;
        }
 
        $http->saveResponse(
            $http->response()->withAddedHeader('Location', $full_uri)
        );
        $http->sendResponse();
        $http->close();
    }
 
    private function buildCannotReachRedirect(URI $base_uri, Request $request): string
    {
        $target_ref_id = $request->getReferenceId()?->toInt() ?? 0;
        $fallback_ref_id = $target_ref_id > 0
            ? $this->context->findFirstAccessibleParentRefId($target_ref_id)
            : null;
 
        if ($fallback_ref_id !== null) {
            $this->session_store->set(
                'pending_goto',
                'goto.php?target=' . $request->getNamespace() . '_' . $target_ref_id
            );
            $this->context->mainTemplate()->setOnScreenMessage(
                'info',
                $this->context->lng()->txt('reg_goto_parent_membership_info'),
                true
            );
            return $base_uri . '/ilias.php?baseClass=ilRepositoryGUI&ref_id=' . $fallback_ref_id;
        }
 
        $this->context->mainTemplate()->setOnScreenMessage(
            'failure',
            $this->context->lng()->txt('permission_denied'),
            true
        );
 
        return $base_uri . '/' . ltrim(\ilUserUtil::getStartingPointAsUrl(), '/');
    }
 
    private function appendUnknownParameters(Context $context, string $full_uri): string
    {
        if ($context->http()->wrapper()->query()->has('soap_pw')) {
            return \ilUtil::appendUrlParameterString(
                $full_uri,
                'soap_pw=' . $context->http()->wrapper()->query()->retrieve(
                    'soap_pw',
                    $context->refinery()->kindlyTo()->string()
                )
            );
        }
        if ($context->http()->wrapper()->query()->has('ext_uid')) {
            return \ilUtil::appendUrlParameterString(
                $full_uri,
                'ext_uid=' . $context->http()->wrapper()->query()->retrieve(
                    'ext_uid',
                    $context->refinery()->kindlyTo()->string()
                )
            );
        }
 
        return $full_uri;
    }
}