Collaboration diagram for ILIAS\StaticURL\Handler\HandlerService:

Public Member Functions
	__construct (private RequestBuilder $request_builder, private Context $context, private array $handler_instances, private SessionStore $session_store)

	initHandler ()

	performRedirect (URI $base_uri)

Private Member Functions
	buildCannotReachRedirect (URI $base_uri, Request $request)
	Builds the redirect target for a {. More...

	appendUnknownParameters (Context $context, string $full_uri)

Private Attributes
Factory	$response_factory

array	$handlers = []

Detailed Description

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 38 of file HandlerService.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\StaticURL\Handler\HandlerService::__construct	(	private RequestBuilder	$request_builder,
		private Context	$context,
		private array	$handler_instances,
		private SessionStore	$session_store
	)

Definition at line 43 of file HandlerService.php.

      {
        $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'
                );
            }
        }
    }

Member Function Documentation

◆ appendUnknownParameters()

ILIAS\StaticURL\Handler\HandlerService::appendUnknownParameters	(	Context	$context,
		string	$full_uri
	)

private

Deprecated:: Thsi piece of code comes from the old goto.php and should be removed as soon as possible. Or this can be moved to the place where is is needed.

Definition at line 199 of file HandlerService.php.

                                                                                : 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;
    }

References ILIAS\StaticURL\Context\http(), and ILIAS\StaticURL\Context\refinery().

Referenced by ILIAS\StaticURL\Handler\HandlerService\performRedirect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildCannotReachRedirect()

ILIAS\StaticURL\Handler\HandlerService::buildCannotReachRedirect	(	URI	$base_uri,
		Request	$request
	)

private

Builds the redirect target for a {.

See also: CannotReach} response.

If the Request carries a ReferenceId, the repository tree is walked upwards until a parent the user can read is found; in that case {

See also: \ILIAS\StaticURL\Session\SessionStore} is populated with pending_goto so the parent course/group registration flow can show the reg_goto_parent_membership_info message and offer the join action. If no accessible parent is found (or the Request carries no ReferenceId), the user is redirected to their Starting Point / Dashboard.

Definition at line 166 of file HandlerService.php.

                                                                              : 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(), '/');
    }

References ILIAS\StaticURL\Request\Request\getNamespace(), ILIAS\StaticURL\Request\Request\getReferenceId(), and ilUserUtil\getStartingPointAsUrl().

Referenced by ILIAS\StaticURL\Handler\HandlerService\performRedirect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initHandler()

ILIAS\StaticURL\Handler\HandlerService::initHandler ( )

Definition at line 60 of file HandlerService.php.

                                 : 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;
                }
            }
        }
    }

References $handler.

Referenced by ILIAS\StaticURL\Handler\HandlerService\performRedirect().

Here is the caller graph for this function:

◆ performRedirect()

ILIAS\StaticURL\Handler\HandlerService::performRedirect ( URI $base_uri )

Returns: never

Definition at line 81 of file HandlerService.php.

                                                  : 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();
    }

References $handler, $http, $response, ILIAS\StaticURL\Handler\HandlerService\appendUnknownParameters(), ILIAS\StaticURL\Handler\HandlerService\buildCannotReachRedirect(), ILIAS\Data\URI\getPath(), ILIAS\StaticURL\Handler\HandlerService\initHandler(), and ILIAS\Data\URI\withPath().

Here is the call graph for this function:

Field Documentation

◆ $handlers

array ILIAS\StaticURL\Handler\HandlerService::$handlers = []

private

Definition at line 41 of file HandlerService.php.

◆ $response_factory

Factory ILIAS\StaticURL\Handler\HandlerService::$response_factory

private

Definition at line 40 of file HandlerService.php.

The documentation for this class was generated from the following file:

components/ILIAS/StaticURL/src/Handler/HandlerService.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appendUnknownParameters()

◆ buildCannotReachRedirect()

◆ initHandler()

◆ performRedirect()

Field Documentation

◆ $handlers

◆ $response_factory