UriBuilder.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Backend\Routing;
 
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\UriInterface;
use Symfony\Component\Routing\Generator\UrlGenerator;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Routing\RequestContext;
use Symfony\Component\Routing\Route as SymfonyRoute;
use ‪TYPO3\CMS\Backend\Routing\Exception\MethodNotAllowedException;
use ‪TYPO3\CMS\Backend\Routing\Exception\RouteNotFoundException;
use ‪TYPO3\CMS\Backend\Routing\Exception\RouteTypeNotAllowedException;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Core\SystemEnvironmentBuilder;
use ‪TYPO3\CMS\Core\FormProtection\FormProtectionFactory;
use ‪TYPO3\CMS\Core\Http\ServerRequestFactory;
use ‪TYPO3\CMS\Core\Http\Uri;
use ‪TYPO3\CMS\Core\Routing\RequestContextFactory;
use ‪TYPO3\CMS\Core\SingletonInterface;
 
class ‪UriBuilder implements ‪SingletonInterface
{
    public const ‪ABSOLUTE_URL = 'url';
 
    public const ‪ABSOLUTE_PATH = 'absolute';
 
    public const ‪SHAREABLE_URL = 'share';
 
    protected array ‪$generated = [];
 
    protected RequestContext|null ‪$requestContext = null;
    public function ‪__construct(
        protected readonly ‪Router $router,
        protected readonly ‪FormProtectionFactory $formProtectionFactory,
        protected readonly ‪RequestContextFactory $requestContextFactory
    ) {
    }
 
    public function ‪setRequestContext(RequestContext ‪$requestContext): void
    {
        $this->requestContext = ‪$requestContext;
    }
 
    public function ‪buildUriFromRoutePath($pathInfo, $parameters = [], $referenceType = self::ABSOLUTE_PATH)
    {
        $route = $this->router->match($pathInfo);
        return $this->‪buildUriFromRoute($route->getOption('_identifier'), $parameters, $referenceType);
    }
 
    public function ‪buildUriWithRedirect(string $name, array $parameters = [], ‪RouteRedirect $redirect = null, string $referenceType = self::ABSOLUTE_PATH): UriInterface
    {
        if ($redirect === null) {
            return $this->‪buildUriFromRoute($name, $parameters, $referenceType);
        }
 
        try {
            $redirect->resolve($this->router);
        } catch (‪RouteNotFoundException|‪RouteTypeNotAllowedException|‪MethodNotAllowedException $e) {
            return $this->‪buildUriFromRoute($name, $parameters, $referenceType);
        }
        $parameters['redirect'] = $redirect->getName();
        if ($redirect->hasParameters()) {
            $parameters['redirectParams'] = $redirect->getFormattedParameters();
        }
        return $this->‪buildUriFromRoute($name, $parameters, $referenceType);
    }
 
    public function ‪buildUriFromRequest(ServerRequestInterface $request, array $parameters = [], string $referenceType = self::ABSOLUTE_PATH): UriInterface
    {
        $route = $request->getAttribute('route');
        if (!$route instanceof ‪Route && !$route instanceof SymfonyRoute) {
            throw new ‪RouteNotFoundException('No route object was given inside the request object', 1691423325);
        }
        return $this->‪buildUriFromRoute($route->getOption('_identifier'), $parameters, $referenceType);
    }
 
    public function ‪buildUriFromRoute($name, $parameters = [], $referenceType = self::ABSOLUTE_PATH)
    {
        $cacheIdentifier = 'route' . $name . serialize($parameters) . $referenceType;
        if (isset($this->generated[$cacheIdentifier])) {
            return $this->generated[$cacheIdentifier];
        }
 
        $route = $this->router->getRoute((string)$name);
        if ($route === null) {
            throw new ‪RouteNotFoundException('Unable to generate a URL for the named route "' . $name . '" because this route was not found.', 1476050190);
        }
 
        $parameters = array_merge(
            $route->getOption('parameters') ?? [],
            $parameters
        );
 
        // If the route is not shareable and doesn't have the "public" option set, a token must be generated.
        if ($referenceType !== self::SHAREABLE_URL && (!$route->hasOption('access') || $route->getOption('access') !== 'public')) {
            $parameters = [
                'token' => $this->formProtectionFactory->createForType('backend')->generateToken('route', $name),
            ] + $parameters;
        }
 
        $this->generated[$cacheIdentifier] = $this->‪buildUri($name, $parameters, (string)$referenceType);
        return $this->generated[$cacheIdentifier];
    }
 
    protected function ‪buildUri(string $routeName, array $parameters, string $referenceType): UriInterface
    {
        if (isset($this->requestContext)) {
            ‪$requestContext = ‪$this->requestContext;
        } elseif (isset(‪$GLOBALS['TYPO3_REQUEST'])) {
            ‪$requestContext = $this->requestContextFactory->fromBackendRequest(‪$GLOBALS['TYPO3_REQUEST']);
        } elseif (!‪Environment::isCli()) {
            ‪$requestContext = $this->requestContextFactory->fromBackendRequest(‪ServerRequestFactory::fromGlobals()->withAttribute('applicationType', ‪SystemEnvironmentBuilder::REQUESTTYPE_BE));
        } else {
            ‪$requestContext = new RequestContext('/typo3/');
        }
        $urlGenerator = new UrlGenerator($this->router->getRouteCollection(), ‪$requestContext);
        ‪$url = $urlGenerator->generate($routeName, $parameters, $referenceType === self::ABSOLUTE_PATH ? UrlGeneratorInterface::ABSOLUTE_PATH : UrlGeneratorInterface::ABSOLUTE_URL);
        return new ‪Uri(‪$url);
    }
}