RedirectService.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\Redirects\Service;
 
use Psr\Http\Message\UriInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Domain\Repository\PageRepository;
use ‪TYPO3\CMS\Core\Http\Uri;
use ‪TYPO3\CMS\Core\LinkHandling\LinkService;
use ‪TYPO3\CMS\Core\Resource\Exception\InvalidPathException;
use ‪TYPO3\CMS\Core\Resource\File;
use ‪TYPO3\CMS\Core\Resource\Folder;
use ‪TYPO3\CMS\Core\Routing\PageArguments;
use ‪TYPO3\CMS\Core\Site\Entity\NullSite;
use ‪TYPO3\CMS\Core\Site\Entity\SiteInterface;
use ‪TYPO3\CMS\Core\Site\SiteFinder;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\HttpUtility;
use ‪TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication;
use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
use ‪TYPO3\CMS\Frontend\Service\TypoLinkCodecService;
use ‪TYPO3\CMS\Frontend\Typolink\AbstractTypolinkBuilder;
use ‪TYPO3\CMS\Frontend\Typolink\UnableToLinkException;
 
class ‪RedirectService implements LoggerAwareInterface
{
    use LoggerAwareTrait;
 
    protected ‪$redirectCacheService;
 
    protected ‪$linkService;
 
    protected ‪$siteFinder;
 
    public function ‪__construct(‪RedirectCacheService ‪$redirectCacheService, ‪LinkService ‪$linkService, ‪SiteFinder ‪$siteFinder)
    {
        $this->redirectCacheService = ‪$redirectCacheService;
        $this->linkService = ‪$linkService;
        $this->siteFinder = ‪$siteFinder;
    }
 
    public function ‪matchRedirect(string $domain, string $path, string $query = '')
    {
        $allRedirects = $this->‪fetchRedirects();
        $path = rawurldecode($path);
        // Check if the domain matches, or if there is a
        // redirect fitting for any domain
        foreach ([$domain, '*'] as $domainName) {
            if (empty($allRedirects[$domainName])) {
                continue;
            }
 
            $possibleRedirects = [];
            // check if a flat redirect matches
            if (!empty($allRedirects[$domainName]['flat'][rtrim($path, '/') . '/'])) {
                $possibleRedirects = $allRedirects[$domainName]['flat'][rtrim($path, '/') . '/'];
            }
            // check if a flat redirect matches with the Query applied
            if (!empty($query)) {
                $pathWithQuery = rtrim($path, '/') . '?' . ltrim($query, '?');
                if (!empty($allRedirects[$domainName]['respect_query_parameters'][$pathWithQuery])) {
                    $possibleRedirects = $allRedirects[$domainName]['respect_query_parameters'][$pathWithQuery];
                } else {
                    $pathWithQueryAndSlash = rtrim($path, '/') . '/?' . ltrim($query, '?');
                    if (!empty($allRedirects[$domainName]['respect_query_parameters'][$pathWithQueryAndSlash])) {
                        $possibleRedirects = $allRedirects[$domainName]['respect_query_parameters'][$pathWithQueryAndSlash];
                    }
                }
            }
            // check all redirects that are registered as regex
            if (!empty($allRedirects[$domainName]['regexp'])) {
                $allRegexps = array_keys($allRedirects[$domainName]['regexp']);
                $regExpPath = $path;
                if (!empty($query)) {
                    $regExpPath .= '?' . ltrim($query, '?');
                }
                foreach ($allRegexps as $regexp) {
                    $matchResult = @preg_match((string)$regexp, $regExpPath);
                    if ($matchResult > 0) {
                        $possibleRedirects += $allRedirects[$domainName]['regexp'][$regexp];
                        continue;
                    }
 
                    // Log invalid regular expression
                    if ($matchResult === false) {
                        $this->logger->warning('Invalid regex in redirect', ['regex' => $regexp]);
                        continue;
                    }
 
                    // We need a second match run to evaluate against path only, even when query parameters where
                    // provided to ensure regexp without query parameters in mind are still processed.
                    // We need to do this only if there are query parameters in the request, otherwise first
                    // preg_match would have found it.
                    if (!empty($query)) {
                        $matchResult = preg_match((string)$regexp, $path);
                        if ($matchResult > 0) {
                            $possibleRedirects += $allRedirects[$domainName]['regexp'][$regexp];
                            continue;
                        }
                    }
                }
            }
 
            foreach ($possibleRedirects as $possibleRedirect) {
                // check starttime and endtime for all existing records
                if ($this->‪isRedirectActive($possibleRedirect)) {
                    return $possibleRedirect;
                }
            }
        }
 
        return null;
    }
 
    protected function ‪isRedirectActive(array $redirectRecord): bool
    {
        return !$redirectRecord['disabled'] && $redirectRecord['starttime'] <= ‪$GLOBALS['SIM_ACCESS_TIME'] &&
               (!$redirectRecord['endtime'] || $redirectRecord['endtime'] >= ‪$GLOBALS['SIM_ACCESS_TIME']);
    }
 
    protected function ‪fetchRedirects(): array
    {
        return $this->redirectCacheService->getRedirects();
    }
 
    protected function ‪resolveLinkDetailsFromLinkTarget(string $redirectTarget): array
    {
        try {
            $linkDetails = $this->linkService->resolve($redirectTarget);
            switch ($linkDetails['type']) {
                case ‪LinkService::TYPE_URL:
                    // all set up, nothing to do
                    break;
                case ‪LinkService::TYPE_FILE:
                    $file = $linkDetails['file'];
                    if ($file instanceof ‪File) {
                        $linkDetails['url'] = $file->getPublicUrl();
                    }
                    break;
                case ‪LinkService::TYPE_FOLDER:
                    $folder = $linkDetails['folder'];
                    if ($folder instanceof ‪Folder) {
                        $linkDetails['url'] = $folder->getPublicUrl();
                    }
                    break;
                case ‪LinkService::TYPE_UNKNOWN:
                    // If $redirectTarget could not be resolved, we can only assume $redirectTarget with leading '/'
                    // as relative redirect and try to resolve it with enriched information from current request.
                    // That ensures that regexp redirects ending in replaceRegExpCaptureGroup(), but also ensures
                    // that relative urls are not left as unknown file here.
                    if (str_starts_with($redirectTarget, '/')) {
                        $linkDetails = [
                            'type' => ‪LinkService::TYPE_URL,
                            'url' => $redirectTarget,
                        ];
                    }
                    break;
                default:
                    // we have to return the link details without having a "URL" parameter
            }
        } catch (‪InvalidPathException $e) {
            return [];
        }
 
        return $linkDetails;
    }
 
    public function ‪getTargetUrl(array $matchedRedirect, array $queryParams, ‪FrontendUserAuthentication $frontendUserAuthentication, UriInterface $uri, ?‪SiteInterface $site = null): ?UriInterface
    {
        $this->logger->debug('Found a redirect to process', $matchedRedirect);
        $linkParameterParts = GeneralUtility::makeInstance(TypoLinkCodecService::class)->decode((string)$matchedRedirect['target']);
        $redirectTarget = $linkParameterParts['url'];
        $linkDetails = $this->‪resolveLinkDetailsFromLinkTarget($redirectTarget);
        $this->logger->debug('Resolved link details for redirect', $linkDetails);
        if (!empty($linkParameterParts['additionalParams']) && $matchedRedirect['keep_query_parameters']) {
            $params = GeneralUtility::explodeUrl2Array($linkParameterParts['additionalParams']);
            foreach ($params as $key => $value) {
                $queryParams[$key] = $value;
            }
        }
        // Do this for files, folders, external URLs or relative urls
        if (!empty($linkDetails['url'])) {
            if ($matchedRedirect['is_regexp'] ?? false) {
                $linkDetails = $this->‪replaceRegExpCaptureGroup($matchedRedirect, $uri, $linkDetails);
            }
 
            $url = new ‪Uri($linkDetails['url']);
            if ($matchedRedirect['force_https']) {
                $url = $url->withScheme('https');
            }
            if ($matchedRedirect['keep_query_parameters']) {
                $url = $this->‪addQueryParams($queryParams, $url);
            }
            return $url;
        }
        if (($site === null || $site instanceof ‪NullSite) && $linkDetails['type'] === 'page') {
            $site = $this->siteFinder->getSiteByPageId((int)$linkDetails['pageuid']);
        }
        // If it's a record or page, then boot up TSFE and use typolink
        return $this->‪getUriFromCustomLinkDetails($matchedRedirect, $frontendUserAuthentication, $site, $linkDetails, $queryParams);
    }
 
    protected function ‪addQueryParams(array $queryParams, ‪Uri $url): ‪Uri
    {
        // New query parameters overrule the ones that should be kept
        $newQueryParamString = $url->‪getQuery();
        if (!empty($newQueryParamString)) {
            $newQueryParams = [];
            parse_str($newQueryParamString, $newQueryParams);
            $queryParams = array_replace_recursive($queryParams, $newQueryParams);
        }
        $query = http_build_query($queryParams, '', '&', PHP_QUERY_RFC3986);
        if ($query) {
            $url = $url->‪withQuery($query);
        }
        return $url;
    }
 
    protected function ‪getUriFromCustomLinkDetails(array $redirectRecord, ‪FrontendUserAuthentication $frontendUserAuthentication, ?‪SiteInterface $site, array $linkDetails, array $queryParams): ?UriInterface
    {
        if (!isset($linkDetails['type'], ‪$GLOBALS['TYPO3_CONF_VARS']['FE']['typolinkBuilder'][$linkDetails['type']])) {
            return null;
        }
        $controller = $this->‪bootFrontendController($frontendUserAuthentication, $site, $queryParams);
        $linkBuilder = GeneralUtility::makeInstance(
            ‪$GLOBALS['TYPO3_CONF_VARS']['FE']['typolinkBuilder'][$linkDetails['type']],
            $controller->cObj,
            $controller
        );
        try {
            $configuration = [
                'parameter' => (string)$redirectRecord['target'],
                'forceAbsoluteUrl' => true,
                'linkAccessRestrictedPages' => true,
            ];
            if ($redirectRecord['force_https']) {
                $configuration['forceAbsoluteUrl.']['scheme'] = 'https';
            }
            if ($redirectRecord['keep_query_parameters']) {
                $configuration['additionalParams'] = ‪HttpUtility::buildQueryString($queryParams, '&');
            }
            [$url] = $linkBuilder->build($linkDetails, '', '', $configuration);
            return new ‪Uri($url);
        } catch (‪UnableToLinkException $e) {
            // This exception is also thrown by the DatabaseRecordTypolinkBuilder
            $url = $controller->cObj->lastTypoLinkUrl;
            if (!empty($url)) {
                return new ‪Uri($url);
            }
            return null;
        }
    }
 
    protected function ‪bootFrontendController(‪FrontendUserAuthentication $frontendUserAuthentication, ?‪SiteInterface $site, array $queryParams): ‪TypoScriptFrontendController
    {
        $pageId = $site ? $site->‪getRootPageId() : (‪$GLOBALS['TSFE'] ? ‪$GLOBALS['TSFE']->id : 0);
        $controller = GeneralUtility::makeInstance(
            TypoScriptFrontendController::class,
            GeneralUtility::makeInstance(Context::class),
            $site,
            $site->‪getDefaultLanguage(),
            new ‪PageArguments((int)$pageId, '0', [])
        );
        $controller->fe_user = $frontendUserAuthentication;
        $controller->fetch_the_id();
        $controller->calculateLinkVars($queryParams);
        $controller->getConfigArray();
        $controller->settingLanguage();
        $controller->newCObj();
        if (!‪$GLOBALS['TSFE'] instanceof ‪TypoScriptFrontendController) {
            ‪$GLOBALS['TSFE'] = $controller;
        }
        if (!‪$GLOBALS['TSFE']->sys_page instanceof ‪PageRepository) {
            ‪$GLOBALS['TSFE']->sys_page = GeneralUtility::makeInstance(PageRepository::class);
        }
        return $controller;
    }
 
    protected function ‪replaceRegExpCaptureGroup(array $matchedRedirect, UriInterface $uri, array $linkDetails): array
    {
        $uriToCheck = rawurldecode($uri->getPath());
        if (($matchedRedirect['respect_query_parameters'] ?? false) && $uri->getQuery()) {
            $uriToCheck .= '?' . rawurldecode($uri->getQuery());
        }
        $matchResult = preg_match($matchedRedirect['source_path'], $uriToCheck, $matches);
        if ($matchResult > 0) {
            foreach ($matches as $key => $val) {
                // Unsafe regexp captching group may lead to adding query parameters to result url, which we need
                // to prevent here, thus throwing everything beginning with ? away
                if (strpos($val, '?') !== false) {
                    $val = explode('?', $val, 2)[0] ?? '';
                    $this->logger->warning(
                        sprintf(
                            'Unsafe captching group regex in redirect #%s, including query parameters in matched group',
                            $matchedRedirect['uid'] ?? 0
                        ),
                        ['regex' => $matchedRedirect['source_path']]
                    );
                }
                $linkDetails['url'] = str_replace('$' . $key, $val, $linkDetails['url']);
            }
        }
        return $linkDetails;
    }
}