UriBuilder.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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\Extbase\Mvc\Web\Routing;
 
use ‪TYPO3\CMS\Backend\Routing\Exception\RouteNotFoundException;
use ‪TYPO3\CMS\Backend\Routing\Route;
use ‪TYPO3\CMS\Core\Http\ApplicationType;
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\HttpUtility;
use ‪TYPO3\CMS\Extbase\DomainObject\AbstractValueObject;
use ‪TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface;
use ‪TYPO3\CMS\Extbase\Mvc\Exception\InvalidArgumentValueException;
use ‪TYPO3\CMS\Extbase\Mvc\RequestInterface;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\LazyLoadingProxy;
use ‪TYPO3\CMS\Extbase\Service\ExtensionService;
use ‪TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
 
class ‪UriBuilder
{
    protected ‪RequestInterface ‪$request;
 
    protected array ‪$arguments = [];
    protected array ‪$lastArguments = [];
    protected string ‪$section = '';
    protected bool ‪$createAbsoluteUri = false;
    protected ?string ‪$absoluteUriScheme = null;
    protected bool|string|int ‪$addQueryString = false;
    protected array ‪$argumentsToBeExcludedFromQueryString = [];
    protected bool ‪$linkAccessRestrictedPages = false;
    protected ?int ‪$targetPageUid = null;
    protected int ‪$targetPageType = 0;
    protected ?string ‪$language = null;
    protected bool ‪$noCache = false;
    protected string ‪$format = '';
    protected ?string ‪$argumentPrefix = null;
 
    public function ‪__construct(
        protected readonly ‪ExtensionService $extensionService,
    ) {}
 
    public function ‪setRequest(‪RequestInterface ‪$request): ‪UriBuilder
    {
        $this->request = ‪$request;
        return $this;
    }
 
    public function ‪setArguments(array ‪$arguments): ‪UriBuilder
    {
        $this->arguments = ‪$arguments;
        return $this;
    }
 
    public function ‪getArguments(): array
    {
        return ‪$this->arguments;
    }
 
    public function ‪setSection(string ‪$section): ‪UriBuilder
    {
        $this->section = ‪$section;
        return $this;
    }
 
    public function ‪getSection(): string
    {
        return ‪$this->section;
    }
 
    public function ‪setFormat(string ‪$format): ‪UriBuilder
    {
        $this->format = ‪$format;
        return $this;
    }
 
    public function ‪getFormat(): string
    {
        return ‪$this->format;
    }
 
    public function ‪setCreateAbsoluteUri(bool ‪$createAbsoluteUri): ‪UriBuilder
    {
        $this->createAbsoluteUri = ‪$createAbsoluteUri;
        return $this;
    }
 
    public function ‪getCreateAbsoluteUri(): bool
    {
        return ‪$this->createAbsoluteUri;
    }
 
    public function ‪getAbsoluteUriScheme(): ?string
    {
        return ‪$this->absoluteUriScheme;
    }
 
    public function ‪setAbsoluteUriScheme(string ‪$absoluteUriScheme): ‪UriBuilder
    {
        $this->absoluteUriScheme = ‪$absoluteUriScheme;
        return $this;
    }
 
    public function ‪setLanguage(?string ‪$language): ‪UriBuilder
    {
        $this->language = ‪$language;
        return $this;
    }
 
    public function ‪getLanguage(): ?string
    {
        return ‪$this->language;
    }
 
    public function ‪setAddQueryString(bool|string|int ‪$addQueryString): ‪UriBuilder
    {
        $this->addQueryString = ‪$addQueryString;
        return $this;
    }
 
    public function ‪getAddQueryString(): bool|string|int
    {
        return ‪$this->addQueryString;
    }
 
    public function ‪setArgumentsToBeExcludedFromQueryString(array ‪$argumentsToBeExcludedFromQueryString): ‪UriBuilder
    {
        $this->argumentsToBeExcludedFromQueryString = ‪$argumentsToBeExcludedFromQueryString;
        return $this;
    }
 
    public function ‪getArgumentsToBeExcludedFromQueryString(): array
    {
        return ‪$this->argumentsToBeExcludedFromQueryString;
    }
 
    public function ‪setArgumentPrefix(string ‪$argumentPrefix): ‪UriBuilder
    {
        $this->argumentPrefix = ‪$argumentPrefix;
        return $this;
    }
 
    public function ‪getArgumentPrefix(): ?string
    {
        return ‪$this->argumentPrefix;
    }
 
    public function ‪setLinkAccessRestrictedPages(bool ‪$linkAccessRestrictedPages): ‪UriBuilder
    {
        $this->linkAccessRestrictedPages = ‪$linkAccessRestrictedPages;
        return $this;
    }
 
    public function ‪getLinkAccessRestrictedPages(): bool
    {
        return ‪$this->linkAccessRestrictedPages;
    }
 
    public function ‪setTargetPageUid(int ‪$targetPageUid): ‪UriBuilder
    {
        $this->targetPageUid = ‪$targetPageUid;
        return $this;
    }
 
    public function ‪getTargetPageUid(): ?int
    {
        return ‪$this->targetPageUid;
    }
 
    public function ‪setTargetPageType(int ‪$targetPageType): ‪UriBuilder
    {
        $this->targetPageType = ‪$targetPageType;
        return $this;
    }
 
    public function ‪getTargetPageType(): int
    {
        return ‪$this->targetPageType;
    }
 
    public function ‪setNoCache(bool ‪$noCache): ‪UriBuilder
    {
        $this->noCache = ‪$noCache;
        return $this;
    }
 
    public function ‪getNoCache(): bool
    {
        return ‪$this->noCache;
    }
 
    public function ‪getLastArguments(): array
    {
        return ‪$this->lastArguments;
    }
 
    public function ‪reset(): ‪UriBuilder
    {
        $this->arguments = [];
        $this->section = '';
        $this->format = '';
        $this->language = null;
        $this->createAbsoluteUri = false;
        $this->addQueryString = false;
        $this->argumentsToBeExcludedFromQueryString = [];
        $this->linkAccessRestrictedPages = false;
        $this->targetPageUid = null;
        $this->targetPageType = 0;
        $this->noCache = false;
        $this->argumentPrefix = null;
        $this->absoluteUriScheme = null;
        // $this->request MUST NOT be reset here because the request is actually a hard dependency
        // and not part of the internal state of this object.
        return $this;
    }
 
    public function ‪uriFor(
        ?string $actionName = null,
        ?array $controllerArguments = null,
        ?string $controllerName = null,
        ?string $extensionName = null,
        ?string $pluginName = null
    ): string {
        $controllerArguments = $controllerArguments ?? [];
 
        if ($actionName !== null) {
            $controllerArguments['action'] = $actionName;
        }
        if ($controllerName !== null) {
            $controllerArguments['controller'] = $controllerName;
        } else {
            $controllerArguments['controller'] = $this->request->getControllerName();
        }
        if ($extensionName === null) {
            $extensionName = $this->request->getControllerExtensionName();
        }
        $isFrontend = ‪ApplicationType::fromRequest($this->request)->isFrontend();
        if ($pluginName === null && $isFrontend) {
            $pluginName = $this->extensionService->getPluginNameByAction($extensionName, $controllerArguments['controller'], $controllerArguments['action'] ?? null);
        }
        if ($pluginName === null) {
            $pluginName = $this->request->getPluginName();
        }
        if ($this->targetPageUid === null && $isFrontend) {
            $this->targetPageUid = $this->extensionService->getTargetPidByPlugin($extensionName, $pluginName);
        }
        if ($this->format !== '') {
            $controllerArguments['format'] = ‪$this->format;
        }
        if ($this->argumentPrefix !== null) {
            $prefixedControllerArguments = [$this->argumentPrefix => $controllerArguments];
        } elseif (!$isFrontend) {
            $prefixedControllerArguments = $controllerArguments;
        } else {
            $pluginNamespace = $this->extensionService->getPluginNamespace($extensionName, $pluginName);
            $prefixedControllerArguments = [$pluginNamespace => $controllerArguments];
        }
        ArrayUtility::mergeRecursiveWithOverrule($this->arguments, $prefixedControllerArguments);
        return $this->‪build();
    }
 
    public function ‪build(): string
    {
        if (‪ApplicationType::fromRequest($this->request)->isBackend()) {
            return $this->‪buildBackendUri();
        }
        return $this->‪buildFrontendUri();
    }
 
    public function ‪buildBackendUri(): string
    {
        ‪$arguments = [];
        if ($this->addQueryString && $this->addQueryString !== 'false') {
            ‪$arguments = $this->request->getQueryParams();
            foreach ($this->argumentsToBeExcludedFromQueryString as $argumentToBeExcluded) {
                $argumentArrayToBeExcluded = [];
                parse_str($argumentToBeExcluded, $argumentArrayToBeExcluded);
                ‪$arguments = ArrayUtility::arrayDiffKeyRecursive(‪$arguments, $argumentArrayToBeExcluded);
            }
        } else {
            $id = $this->request->getParsedBody()['id'] ?? $this->request->getQueryParams()['id'] ?? null;
            if ($id !== null) {
                ‪$arguments['id'] = $id;
            }
        }
        if (($route = $this->request->getAttribute('route')) instanceof ‪Route) {
            ‪$arguments['route'] = $route->getOption('_identifier');
        }
        ‪$arguments = array_replace_recursive(‪$arguments, $this->arguments);
        ‪$arguments = $this->‪convertDomainObjectsToIdentityArrays($arguments);
        $this->lastArguments = ‪$arguments;
        $routeIdentifier = ‪$arguments['route'] ?? null;
        unset(‪$arguments['route'], ‪$arguments['token']);
 
        // In case the current route identifier is an identifier of a sub route, remove the sub route
        // part to be able to add the actually requested sub route based on the current arguments.
        if ($routeIdentifier && str_contains($routeIdentifier, '.')) {
            [$routeIdentifier] = explode('.', $routeIdentifier);
        }
        // Build route identifier to the actually requested sub route (controller / action pair) - if any -
        // and unset corresponding arguments.
        if ($routeIdentifier && isset(‪$arguments['controller'], ‪$arguments['action'])) {
            $routeIdentifier .= '.' . ‪$arguments['controller'] . '_' . ‪$arguments['action'];
            unset(‪$arguments['controller'], ‪$arguments['action']);
        }
        $uri = '';
        if ($routeIdentifier) {
            $backendUriBuilder = GeneralUtility::makeInstance(\‪TYPO3\CMS\Backend\Routing\UriBuilder::class);
            try {
                if ($this->createAbsoluteUri) {
                    $uri = (string)$backendUriBuilder->buildUriFromRoute($routeIdentifier, ‪$arguments, \‪TYPO3\CMS\Backend\Routing\UriBuilder::ABSOLUTE_URL);
                } else {
                    $uri = (string)$backendUriBuilder->buildUriFromRoute($routeIdentifier, ‪$arguments);
                }
            } catch (‪RouteNotFoundException) {
                // empty URL
            }
        }
        if ($this->section !== '') {
            $uri .= '#' . ‪$this->section;
        }
        return $uri;
    }
 
    public function ‪buildFrontendUri(): string
    {
        $typolinkConfiguration = $this->‪buildTypolinkConfiguration();
        if ($this->createAbsoluteUri === true) {
            $typolinkConfiguration['forceAbsoluteUrl'] = true;
            if ($this->absoluteUriScheme !== null) {
                $typolinkConfiguration['forceAbsoluteUrl.']['scheme'] = ‪$this->absoluteUriScheme;
            }
        }
        $currentContentObject = $this->request->getAttribute('currentContentObject');
        return $currentContentObject?->createUrl($typolinkConfiguration) ?? '';
    }
 
    protected function ‪buildTypolinkConfiguration(): array
    {
        $typolinkConfiguration = [];
        $typolinkConfiguration['parameter'] = $this->targetPageUid ?? $this->request->getAttribute('frontend.page.information')?->getId() ?? '';
        if ($this->targetPageType !== 0) {
            $typolinkConfiguration['parameter'] .= ',' . ‪$this->targetPageType;
        } elseif ($this->format !== '') {
            ‪$targetPageType = $this->extensionService->getTargetPageTypeByFormat($this->request->getControllerExtensionName(), $this->format);
            $typolinkConfiguration['parameter'] .= ',' . ‪$targetPageType;
        }
        if (!empty($this->arguments)) {
            ‪$arguments = $this->‪convertDomainObjectsToIdentityArrays($this->arguments);
            $this->lastArguments = ‪$arguments;
            $typolinkConfiguration['additionalParams'] = ‪HttpUtility::buildQueryString(‪$arguments, '&');
        }
        if ($this->addQueryString && $this->addQueryString !== 'false') {
            $typolinkConfiguration['addQueryString'] = ‪$this->addQueryString;
            if (!empty($this->argumentsToBeExcludedFromQueryString)) {
                $typolinkConfiguration['addQueryString.'] = [
                    'exclude' => implode(',', $this->argumentsToBeExcludedFromQueryString),
                ];
            }
        }
        if ($this->language !== null) {
            $typolinkConfiguration['language'] = ‪$this->language;
        }
        if ($this->noCache === true) {
            $typolinkConfiguration['no_cache'] = 1;
        }
        if ($this->section !== '') {
            $typolinkConfiguration['section'] = ‪$this->section;
        }
        if ($this->linkAccessRestrictedPages === true) {
            $typolinkConfiguration['linkAccessRestrictedPages'] = 1;
        }
        return $typolinkConfiguration;
    }
 
    protected function ‪convertDomainObjectsToIdentityArrays(array ‪$arguments): array
    {
        foreach (‪$arguments as $argumentKey => $argumentValue) {
            // if we have a LazyLoadingProxy here, make sure to get the real instance for further processing
            if ($argumentValue instanceof ‪LazyLoadingProxy) {
                $argumentValue = $argumentValue->_loadRealInstance();
                // also update the value in the arguments array, because the lazyLoaded object could be
                // hidden and thus the $argumentValue would be NULL.
                ‪$arguments[$argumentKey] = $argumentValue;
            }
            if ($argumentValue instanceof \Iterator) {
                $argumentValue = $this->‪convertIteratorToArray($argumentValue);
            }
            if ($argumentValue instanceof ‪DomainObjectInterface) {
                if ($argumentValue->getUid() !== null) {
                    ‪$arguments[$argumentKey] = $argumentValue->getUid();
                } elseif ($argumentValue instanceof ‪AbstractValueObject) {
                    ‪$arguments[$argumentKey] = $this->‪convertTransientObjectToArray($argumentValue);
                } else {
                    throw new ‪InvalidArgumentValueException('Could not serialize Domain Object ' . get_class($argumentValue) . '. It is neither an Entity with identity properties set, nor a Value Object.', 1260881688);
                }
            } elseif (is_array($argumentValue)) {
                ‪$arguments[$argumentKey] = $this->‪convertDomainObjectsToIdentityArrays($argumentValue);
            }
        }
        return ‪$arguments;
    }
 
    protected function ‪convertIteratorToArray(\Iterator $iterator): array
    {
        if (method_exists($iterator, 'toArray')) {
            $array = $iterator->toArray();
        } else {
            $array = iterator_to_array($iterator);
        }
        return $array;
    }
 
    protected function ‪convertTransientObjectToArray(‪DomainObjectInterface $object): array
    {
        $result = [];
        foreach ($object->_getProperties() as $propertyName => $propertyValue) {
            if ($propertyValue instanceof \Iterator) {
                $propertyValue = $this->‪convertIteratorToArray($propertyValue);
            }
            if ($propertyValue instanceof ‪DomainObjectInterface) {
                if ($propertyValue->getUid() !== null) {
                    $result[$propertyName] = $propertyValue->getUid();
                } else {
                    $result[$propertyName] = $this->‪convertTransientObjectToArray($propertyValue);
                }
            } elseif (is_array($propertyValue)) {
                $result[$propertyName] = $this->‪convertDomainObjectsToIdentityArrays($propertyValue);
            } else {
                $result[$propertyName] = $propertyValue;
            }
        }
        return $result;
    }
}