class.t3lib_formprotection_factory.php

Go to the documentation of this file.

<?php
/***************************************************************
 * Copyright notice
 *
 * (c) 2010-2011 Oliver Klee <typo3-coding@oliverklee.de>
 * All rights reserved
 *
 * This script is part of the TYPO3 project. The TYPO3 project is
 * free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * The GNU General Public License can be found at
 * http://www.gnu.org/copyleft/gpl.html.
 *
 * This script is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

/**
 * Class t3lib_formprotection_Factory.
 *
 * This class creates and manages instances of the various form protection
 * classes.
 *
 * This class provides only static methods. It can not be instantiated.
 *
 * Usage for the back-end form protection:
 *
 * <pre>
 * $formProtection = t3lib_formprotection_Factory::get(
 *   't3lib_formProtection_BackEnd'
 * );
 * </pre>
 *
 * Usage for the install tool form protection:
 *
 * <pre>
 * $formProtection = t3lib_formprotection_Factory::get(
 *   'tx_install_formprotection'
 * );
 * $formProtection->injectInstallTool($this);
 * </pre>
 *
 * $Id$
 *
 * @package TYPO3
 * @subpackage t3lib
 *
 * @author Oliver Klee <typo3-coding@oliverklee.de>
 * @author Ernesto Baschny <ernst@cron-it.de>
 */
final class t3lib_formprotection_Factory {
    /**
     * created instances of form protections using the type as array key
     *
     * @var array<t3lib_formProtectionAbstract>
     */
    protected static $instances = array();

    /**
     * Private constructor to prevent instantiation.
     */
    private function __construct() {
    }

    /**
     * Gets a form protection instance for the requested class $className.
     *
     * If there already is an existing instance of the requested $className, the
     * existing instance will be returned.
     *
     * @param string $className
     *      the name of the class for which to return an instance, must be
     *      "t3lib_formProtection_BackEnd" or "t3lib_formprotection_InstallToolFormProtection"
     *
     * @return t3lib_formprotection_Abstract the requested instance
     */
    public static function get($className = NULL) {
        if ($className === NULL) {
            $className = self::getClassNameByState();
        }
        if (!isset(self::$instances[$className])) {
            self::createAndStoreInstance($className);
        }
        return self::$instances[$className];
    }

    /**
     * Returns the classname depending on TYPO3_MODE and
     * active backend session.
     *
     * @return string
     */
    protected static function getClassNameByState() {
        switch (true) {
            case self::isInstallToolSession():
                $className = 't3lib_formprotection_InstallToolFormProtection';
                break;
            case self::isBackendSession():
                $className = 't3lib_formprotection_BackendFormProtection';
                break;
            case self::isFrontendSession():
            default:
                $className = 't3lib_formprotection_DisabledFormProtection';
        }
        return $className;
    }

    /**
     * Check if we are in the install tool
     *
     * @return boolean
     */
    protected static function isInstallToolSession() {
        return (defined(TYPO3_enterInstallScript) && TYPO3_enterInstallScript);
    }

    /**
     * Checks if a user is logged in and the session is active.
     *
     * @return boolean
     */
    protected static function isBackendSession() {
        return (isset($GLOBALS['BE_USER']) &&
            $GLOBALS['BE_USER'] instanceof t3lib_beUserAuth &&
            isset($GLOBALS['BE_USER']->user['uid']) &&
            !(TYPO3_MODE == 'FE')
        );
    }

    /**
     * Checks if a frontend user is logged in and the session is active.
     *
     * @return boolean
     */
    protected static function isFrontendSession() {
        return (is_object($GLOBALS['TSFE']) &&
            $GLOBALS['TSFE']->fe_user instanceof tslib_feUserAuth &&
            isset($GLOBALS['TSFE']->fe_user->user['uid']) &&
            (TYPO3_MODE == 'FE')
        );
    }

    /**
     * Creates an instace for the requested class $className
     * and stores it internally.
     *
     * @param string $className
     *      the name of the class for which to return an instance, must be
     *      "t3lib_formProtection_BackEnd" or "t3lib_formprotection_InstallToolFormProtection"
     *
     * @throws InvalidArgumentException
     */
    protected static function createAndStoreInstance($className) {
            if (!class_exists($className, TRUE)) {
                throw new InvalidArgumentException(
                    '$className must be the name of an existing class, but ' .
                    'actually was "' . $className . '".',
                    1285352962
                );
            }

            $instance = t3lib_div::makeInstance($className);
            if (!$instance instanceof t3lib_formprotection_Abstract) {
                throw new InvalidArgumentException(
                    '$className must be a subclass of ' .
                    't3lib_formprotection_Abstract, but actually was "' .
                    $className . '".',
                    1285353026
                );
            }
            self::$instances[$className] = $instance;
    }

    /**
     * Sets the instance that will be returned by get() for a specific class
     * name.
     *
     * Note: This function is intended for testing purposes only.
     *
     * @param string $className
     *      the name of the class for which to set an instance, must be
     *      "t3lib_formProtection_BackEnd" or "t3lib_formprotection_InstallToolFormProtection"
     * @param t3lib_formprotection_Abstract $instance
     *      the instance to set
     *
     * @return void
     */
    public static function set($className, t3lib_formprotection_Abstract $instance) {
        self::$instances[$className] = $instance;
    }

    /**
     * Purges all existing instances.
     *
     * This function is particularly useful when cleaning up in unit testing.
     *
     * @return void
     */
    public static function purgeInstances() {
        foreach (self::$instances as $key => $instance) {
            $instance->__destruct();
            unset(self::$instances[$key]);
        }
    }
}

if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/formprotection/class.t3lib_formprotection_factory.php'])) {
    include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/formprotection/class.t3lib_formprotection_factory.php']);
}
?>