RedirectModeHandler.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\FrontendLogin\Redirect;
 
use ‪TYPO3\CMS\Core\Site\SiteFinder;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder;
use ‪TYPO3\CMS\FrontendLogin\Domain\Repository\FrontendUserGroupRepository;
use ‪TYPO3\CMS\FrontendLogin\Domain\Repository\FrontendUserRepository;
use ‪TYPO3\CMS\FrontendLogin\Service\UserService;
use ‪TYPO3\CMS\FrontendLogin\Validation\RedirectUrlValidator;
 
class ‪RedirectModeHandler
{
    protected ‪$redirectUrlValidator;
 
    protected ‪$uriBuilder;
 
    protected ‪$serverRequestHandler;
 
    private ‪$userService;
 
    private ‪$frontendUserRepository;
 
    private ‪$frontendUserGroupRepository;
 
    public function ‪__construct(
        ‪UriBuilder ‪$uriBuilder,
        ‪ServerRequestHandler ‪$serverRequestHandler,
        ‪UserService ‪$userService,
        ‪FrontendUserRepository ‪$frontendUserRepository,
        ‪FrontendUserGroupRepository ‪$frontendUserGroupRepository
    ) {
        $this->uriBuilder = ‪$uriBuilder;
        $this->redirectUrlValidator = GeneralUtility::makeInstance(
            RedirectUrlValidator::class,
            GeneralUtility::makeInstance(SiteFinder::class)
        );
        $this->serverRequestHandler = ‪$serverRequestHandler;
        $this->userService = ‪$userService;
        $this->frontendUserRepository = ‪$frontendUserRepository;
        $this->frontendUserGroupRepository = ‪$frontendUserGroupRepository;
    }
 
    public function ‪redirectModeGroupLogin(): string
    {
        // taken from dkd_redirect_at_login written by Ingmar Schlecht; database-field changed
        $groupData = $this->userService->getFeUserGroupData();
 
        $groupUids = array_unique(array_map('intval', $groupData['uid']));
        if (empty($groupData['uid'])) {
            return '';
        }
 
        // take the first group with a redirect page
        foreach ($groupUids as $groupUid) {
            $redirectPageId = (int)$this->frontendUserGroupRepository
                ->findRedirectPageIdByGroupId($groupUid);
            if ($redirectPageId > 0) {
                return $this->‪buildUriForPageUid($redirectPageId);
            }
        }
        return '';
    }
 
    public function ‪redirectModeUserLogin(): string
    {
        $redirectPageId = $this->frontendUserRepository->findRedirectIdPageByUserId(
            $this->userService->getFeUserData()['uid']
        );
 
        if ($redirectPageId === null) {
            return '';
        }
 
        return $this->‪buildUriForPageUid($redirectPageId);
    }
 
    public function ‪redirectModeLogin(int $redirectPageLogin): string
    {
        $redirectUrl = '';
        if ($redirectPageLogin !== 0) {
            $redirectUrl = $this->‪buildUriForPageUid($redirectPageLogin);
        }
 
        return $redirectUrl;
    }
 
    public function ‪redirectModeReferrer(string $redirectReferrer): string
    {
        $redirectUrl = '';
        if ($redirectReferrer !== 'off') {
            // Avoid forced logout, when trying to login immediately after a logout
            $redirectUrl = preg_replace('/[&?]logintype=[a-z]+/', '', $this->‪getRefererRequestParam());
        }
 
        return $redirectUrl ?? '';
    }
 
    public function ‪redirectModeRefererDomains(string $domains, string $redirectReferrer): string
    {
        $redirectUrl = '';
        if ($redirectReferrer !== '') {
            return '';
        }
 
        // Auto redirect.
        // Feature to redirect to the page where the user came from (HTTP_REFERER).
        // Allowed domains to redirect to, can be configured with plugin.tx_felogin_login.domains
        // Thanks to plan2.net / Martin Kutschker for implementing this feature.
        // also avoid redirect when logging in after changing password
        if ($domains) {
            $url = $this->‪getRefererRequestParam();
            // Is referring url allowed to redirect?
            $match = [];
            if (preg_match('#^http://([[:alnum:]._-]+)/#', $url, $match)) {
                $redirectDomain = $match[1];
                $found = false;
                foreach (‪GeneralUtility::trimExplode(',', $domains, true) as $domain) {
                    if (preg_match('/(?:^|\\.)' . $domain . '$/', $redirectDomain)) {
                        $found = true;
                        break;
                    }
                }
                if (!$found) {
                    $url = '';
                }
            }
            // Avoid forced logout, when trying to login immediately after a logout
            if ($url) {
                $redirectUrl = preg_replace('/[&?]logintype=[a-z]+/', '', $url);
            }
        }
 
        return $redirectUrl ?? '';
    }
 
    public function ‪redirectModeLoginError(int $redirectPageLoginError = 0): string
    {
        $redirectUrl = '';
        if ($redirectPageLoginError > 0) {
            $redirectUrl = $this->‪buildUriForPageUid($redirectPageLoginError);
        }
 
        return $redirectUrl;
    }
 
    public function ‪redirectModeLogout(int $redirectPageLogout): string
    {
        $redirectUrl = '';
        if ($redirectPageLogout > 0) {
            $redirectUrl = $this->‪buildUriForPageUid($redirectPageLogout);
        }
 
        return $redirectUrl;
    }
 
    protected function ‪buildUriForPageUid(int $pageUid): string
    {
        $this->uriBuilder->reset();
        $this->uriBuilder->setTargetPageUid($pageUid);
 
        return $this->uriBuilder->build();
    }
 
    protected function ‪getRefererRequestParam(): string
    {
        $referer = '';
        $requestReferer = (string)$this->serverRequestHandler->getPropertyFromGetAndPost('referer');
        if ($this->redirectUrlValidator->isValid($requestReferer)) {
            $referer = $requestReferer;
        }
 
        return $referer;
    }
}