249 lines
9.1 KiB
PHP
249 lines
9.1 KiB
PHP
<?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\Controller;
|
|
|
|
use Psr\Http\Message\ResponseInterface;
|
|
use TYPO3\CMS\Core\Authentication\LoginType;
|
|
use TYPO3\CMS\Core\Context\Context;
|
|
use TYPO3\CMS\Core\Domain\Repository\PageRepository;
|
|
use TYPO3\CMS\Core\Security\RequestToken;
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
use TYPO3\CMS\Extbase\Http\ForwardResponse;
|
|
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
|
|
use TYPO3\CMS\FrontendLogin\Configuration\RedirectConfiguration;
|
|
use TYPO3\CMS\FrontendLogin\Event\BeforeRedirectEvent;
|
|
use TYPO3\CMS\FrontendLogin\Event\LoginConfirmedEvent;
|
|
use TYPO3\CMS\FrontendLogin\Event\LoginErrorOccurredEvent;
|
|
use TYPO3\CMS\FrontendLogin\Event\LogoutConfirmedEvent;
|
|
use TYPO3\CMS\FrontendLogin\Event\ModifyLoginFormViewEvent;
|
|
use TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler;
|
|
|
|
/**
|
|
* Used for plugin login
|
|
*
|
|
* @internal this is a concrete TYPO3 implementation and solely used for EXT:felogin and not part of TYPO3's Core API.
|
|
*/
|
|
class LoginController extends ActionController
|
|
{
|
|
public const MESSAGEKEY_DEFAULT = 'welcome';
|
|
public const MESSAGEKEY_ERROR = 'error';
|
|
public const MESSAGEKEY_LOGOUT = 'logout';
|
|
|
|
protected string $loginType = '';
|
|
protected string $redirectUrl = '';
|
|
protected RedirectConfiguration $configuration;
|
|
|
|
public function __construct(
|
|
protected readonly RedirectHandler $redirectHandler,
|
|
protected readonly Context $context,
|
|
protected readonly PageRepository $pageRepository
|
|
) {}
|
|
|
|
/**
|
|
* Initialize redirects
|
|
*/
|
|
public function initializeAction(): void
|
|
{
|
|
$this->loginType = (string)($this->request->getParsedBody()['logintype'] ?? $this->request->getQueryParams()['logintype'] ?? '');
|
|
$this->configuration = RedirectConfiguration::fromSettings($this->settings);
|
|
|
|
if ($this->isLoginOrLogoutInProgress() && !$this->isRedirectDisabled()) {
|
|
$this->redirectUrl = $this->redirectHandler->processRedirect(
|
|
$this->request,
|
|
$this->loginType,
|
|
$this->configuration,
|
|
$this->request->hasArgument('redirectReferrer') ? $this->request->getArgument('redirectReferrer') : ''
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Show login form
|
|
*/
|
|
public function loginAction(): ResponseInterface
|
|
{
|
|
if ($this->isLogoutSuccessful()) {
|
|
$this->eventDispatcher->dispatch(new LogoutConfirmedEvent($this, $this->view, $this->request));
|
|
} elseif ($this->hasLoginErrorOccurred()) {
|
|
$this->eventDispatcher->dispatch(new LoginErrorOccurredEvent($this->request));
|
|
}
|
|
|
|
if (($forwardResponse = $this->handleLoginForwards()) !== null) {
|
|
return $forwardResponse;
|
|
}
|
|
if (($redirectResponse = $this->handleRedirect()) !== null) {
|
|
return $redirectResponse;
|
|
}
|
|
|
|
$this->eventDispatcher->dispatch(new ModifyLoginFormViewEvent($this->view, $this->request));
|
|
|
|
$storagePageIds = ($GLOBALS['TYPO3_CONF_VARS']['FE']['checkFeUserPid'] ?? false)
|
|
? $this->pageRepository->getPageIdsRecursive(GeneralUtility::intExplode(',', (string)($this->settings['pages'] ?? ''), true), (int)($this->settings['recursive'] ?? 0))
|
|
: [];
|
|
|
|
$this->view->assignMultiple(
|
|
[
|
|
'messageKey' => $this->getStatusMessageKey(),
|
|
'permaloginStatus' => $this->getPermaloginStatus(),
|
|
'redirectURL' => $this->redirectHandler->getLoginFormRedirectUrl($this->request, $this->configuration, $this->isRedirectDisabled()),
|
|
'redirectReferrer' => $this->request->hasArgument('redirectReferrer') ? (string)$this->request->getArgument('redirectReferrer') : '',
|
|
'referer' => $this->redirectHandler->getReferrerForLoginForm($this->request, $this->settings),
|
|
'noRedirect' => $this->isRedirectDisabled(),
|
|
'requestToken' => RequestToken::create('core/user-auth/fe')
|
|
->withMergedParams(['pid' => implode(',', $storagePageIds)]),
|
|
]
|
|
);
|
|
|
|
return $this->htmlResponse();
|
|
}
|
|
|
|
/**
|
|
* User overview for logged in users
|
|
*/
|
|
public function overviewAction(bool $showLoginMessage = false): ResponseInterface
|
|
{
|
|
if (!$this->context->getAspect('frontend.user')->isLoggedIn()) {
|
|
return new ForwardResponse('login');
|
|
}
|
|
$this->eventDispatcher->dispatch(new LoginConfirmedEvent($this, $this->view, $this->request));
|
|
if (($redirectResponse = $this->handleRedirect()) !== null) {
|
|
return $redirectResponse;
|
|
}
|
|
$this->view->assignMultiple(
|
|
[
|
|
'user' => $this->request->getAttribute('frontend.user')->user,
|
|
'showLoginMessage' => $showLoginMessage,
|
|
]
|
|
);
|
|
return $this->htmlResponse();
|
|
}
|
|
|
|
/**
|
|
* Show logout form. Note, that this action should never process any redirects.
|
|
*/
|
|
public function logoutAction(): ResponseInterface
|
|
{
|
|
$this->view->assignMultiple(
|
|
[
|
|
'user' => $this->request->getAttribute('frontend.user')->user,
|
|
'noRedirect' => $this->isRedirectDisabled(),
|
|
]
|
|
);
|
|
return $this->htmlResponse();
|
|
}
|
|
|
|
/**
|
|
* Handles the redirect when $this->redirectUrl is not empty
|
|
*/
|
|
protected function handleRedirect(): ?ResponseInterface
|
|
{
|
|
if ($this->redirectUrl !== '') {
|
|
$event = new BeforeRedirectEvent($this->loginType, $this->redirectUrl, $this->request);
|
|
$this->eventDispatcher->dispatch($event);
|
|
if ($event->getRedirectUrl() !== '') {
|
|
return $this->redirectToUri($event->getRedirectUrl());
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Handle forwards to overview and logout actions from login action
|
|
*/
|
|
protected function handleLoginForwards(): ?ResponseInterface
|
|
{
|
|
if ($this->shouldRedirectToOverview()) {
|
|
return (new ForwardResponse('overview'))->withArguments(['showLoginMessage' => true]);
|
|
}
|
|
if ($this->context->getAspect('frontend.user')->isLoggedIn()) {
|
|
return new ForwardResponse('logout');
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* The permanent login checkbox should only be shown if permalogin is not deactivated (-1),
|
|
* not forced to be always active (2) and lifetime is greater than 0
|
|
*/
|
|
protected function getPermaloginStatus(): int
|
|
{
|
|
$permaLogin = (int)$GLOBALS['TYPO3_CONF_VARS']['FE']['permalogin'];
|
|
|
|
return $this->isPermaloginDisabled($permaLogin) ? -1 : $permaLogin;
|
|
}
|
|
|
|
protected function isPermaloginDisabled(int $permaLogin): bool
|
|
{
|
|
return $permaLogin > 1
|
|
|| (int)($this->settings['showPermaLogin'] ?? 0) === 0
|
|
|| $GLOBALS['TYPO3_CONF_VARS']['FE']['lifetime'] === 0;
|
|
}
|
|
|
|
/**
|
|
* Redirect to overview on login successful and setting showLogoutFormAfterLogin disabled
|
|
*/
|
|
protected function shouldRedirectToOverview(): bool
|
|
{
|
|
return $this->context->getAspect('frontend.user')->isLoggedIn()
|
|
&& (LoginType::tryFrom($this->loginType) === LoginType::LOGIN)
|
|
&& !($this->settings['showLogoutFormAfterLogin'] ?? 0);
|
|
}
|
|
|
|
/**
|
|
* Return message key based on user login status
|
|
*/
|
|
protected function getStatusMessageKey(): string
|
|
{
|
|
$messageKey = self::MESSAGEKEY_DEFAULT;
|
|
if ($this->hasLoginErrorOccurred()) {
|
|
$messageKey = self::MESSAGEKEY_ERROR;
|
|
} elseif (LoginType::tryFrom($this->loginType) === LoginType::LOGOUT) {
|
|
$messageKey = self::MESSAGEKEY_LOGOUT;
|
|
}
|
|
|
|
return $messageKey;
|
|
}
|
|
|
|
protected function isLoginOrLogoutInProgress(): bool
|
|
{
|
|
$type = LoginType::tryFrom($this->loginType);
|
|
return $type === LoginType::LOGIN || $type === LoginType::LOGOUT;
|
|
}
|
|
|
|
/**
|
|
* Is redirect disabled by setting or noredirect GET/POST parameter
|
|
*/
|
|
protected function isRedirectDisabled(): bool
|
|
{
|
|
return
|
|
(int)($this->request->getParsedBody()['noredirect'] ?? $this->request->getQueryParams()['noredirect'] ?? 0) === 1
|
|
|| ($this->settings['noredirect'] ?? false)
|
|
|| ($this->settings['redirectDisable'] ?? false);
|
|
}
|
|
|
|
protected function isLogoutSuccessful(): bool
|
|
{
|
|
return LoginType::tryFrom($this->loginType) === LoginType::LOGOUT && !$this->context->getAspect('frontend.user')->isLoggedIn();
|
|
}
|
|
|
|
protected function hasLoginErrorOccurred(): bool
|
|
{
|
|
return LoginType::tryFrom($this->loginType) === LoginType::LOGIN && !$this->context->getAspect('frontend.user')->isLoggedIn();
|
|
}
|
|
}
|