FormProtectionFactory.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\FormProtection;

/*
 * 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!
 */

use TYPO3\CMS\Core\Messaging\FlashMessageQueue;
use TYPO3\CMS\Core\Messaging\FlashMessageService;
use TYPO3\CMS\Core\Registry;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Lang\LanguageService;

class FormProtectionFactory
{
    protected static $instances = array();

    private function __construct()
    {
    }

    public static function get($className = 'default')
    {
        if (isset(self::$instances[$className])) {
            return self::$instances[$className];
        }
        if ($className === 'default') {
            $classNameAndConstructorArguments = self::getClassNameAndConstructorArgumentsByState();
        } else {
            $classNameAndConstructorArguments = func_get_args();
        }
        self::$instances[$className] = self::createInstance($classNameAndConstructorArguments);
        return self::$instances[$className];
    }

    protected static function getClassNameAndConstructorArgumentsByState()
    {
        switch (true) {
            case self::isInstallToolSession():
                $classNameAndConstructorArguments = [
                    InstallToolFormProtection::class
                ];
                break;
            case self::isFrontendSession():
                $classNameAndConstructorArguments = [
                    FrontendFormProtection::class,
                    $GLOBALS['TSFE']->fe_user
                ];
                break;
            case self::isBackendSession():
                $classNameAndConstructorArguments = [
                    BackendFormProtection::class,
                    $GLOBALS['BE_USER'],
                    GeneralUtility::makeInstance(Registry::class),
                    self::getMessageClosure(
                        $GLOBALS['LANG'],
                        GeneralUtility::makeInstance(FlashMessageService::class)->getMessageQueueByIdentifier(),
                        (bool)(TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX)
                    )
                ];
                break;
            default:
                $classNameAndConstructorArguments = [
                    DisabledFormProtection::class
                ];
        }
        return $classNameAndConstructorArguments;
    }

    protected static function isInstallToolSession()
    {
        return defined('TYPO3_enterInstallScript') && TYPO3_enterInstallScript;
    }

    protected static function isBackendSession()
    {
        return isset($GLOBALS['BE_USER']) && $GLOBALS['BE_USER'] instanceof \TYPO3\CMS\Core\Authentication\BackendUserAuthentication && isset($GLOBALS['BE_USER']->user['uid']);
    }

    protected static function isFrontendSession()
    {
        return TYPO3_MODE === 'FE' && is_object($GLOBALS['TSFE']) && $GLOBALS['TSFE']->fe_user instanceof \TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication && isset($GLOBALS['TSFE']->fe_user->user['uid']);
    }

    public static function getMessageClosure(LanguageService $languageService, FlashMessageQueue $messageQueue, $isAjaxCall)
    {
        return function () use ($languageService, $messageQueue, $isAjaxCall) {
            $flashMessage = GeneralUtility::makeInstance(
                \TYPO3\CMS\Core\Messaging\FlashMessage::class,
                $languageService->sL('LLL:EXT:lang/locallang_core.xlf:error.formProtection.tokenInvalid'),
                '',
                \TYPO3\CMS\Core\Messaging\FlashMessage::ERROR,
                !$isAjaxCall
            );
            $messageQueue->enqueue($flashMessage);
        };
    }

    protected static function createInstance(array $classNameAndConstructorArguments)
    {
        $className = $classNameAndConstructorArguments[0];
        if (!class_exists($className)) {
            throw new \InvalidArgumentException('$className must be the name of an existing class, but ' . 'actually was "' . $className . '".', 1285352962);
        }
        $instance = call_user_func_array([\TYPO3\CMS\Core\Utility\GeneralUtility::class, 'makeInstance'], $classNameAndConstructorArguments);
        if (!$instance instanceof AbstractFormProtection) {
            throw new \InvalidArgumentException('$className must be a subclass of ' . AbstractFormProtection::class . ', but actually was "' . $className . '".', 1285353026);
        }
        return $instance;
    }

    public static function set($className, AbstractFormProtection $instance)
    {
        self::$instances[$className] = $instance;
    }

    public static function purgeInstances()
    {
        foreach (self::$instances as $key => $instance) {
            unset(self::$instances[$key]);
        }
    }
}