CacheHashCalculator.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Frontend\Page;

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

class CacheHashCalculator implements \TYPO3\CMS\Core\SingletonInterface
{
    protected $cachedParametersWhiteList = [];

    protected $excludedParameters = [];

    protected $requireCacheHashPresenceParameters = [];

    protected $excludedParametersIfEmpty = [];

    protected $excludeAllEmptyParameters = false;

    protected $includePageId = false;

    public function __construct()
    {
        $this->setConfiguration($GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']);
    }

    public function calculateCacheHash(array $params)
    {
        return !empty($params) ? md5(serialize($params)) : '';
    }

    public function generateForParameters($queryString)
    {
        $cacheHashParams = $this->getRelevantParameters($queryString);
        return $this->calculateCacheHash($cacheHashParams);
    }

    public function doParametersRequireCacheHash($queryString)
    {
        if (empty($this->requireCacheHashPresenceParameters)) {
            return false;
        }
        $hasRequiredParameter = false;
        $parameterNames = array_keys($this->splitQueryStringToArray($queryString));
        foreach ($parameterNames as $parameterName) {
            if (in_array($parameterName, $this->requireCacheHashPresenceParameters)) {
                $hasRequiredParameter = true;
            }
        }
        return $hasRequiredParameter;
    }

    public function getRelevantParameters($queryString)
    {
        $parameters = $this->splitQueryStringToArray($queryString);
        $relevantParameters = [];
        foreach ($parameters as $parameterName => $parameterValue) {
            if ($this->isAdminPanelParameter($parameterName) || $this->isExcludedParameter($parameterName) || $this->isCoreParameter($parameterName)) {
                continue;
            }
            if ($this->hasCachedParametersWhiteList() && !$this->isInCachedParametersWhiteList($parameterName)) {
                continue;
            }
            if ((is_null($parameterValue) || $parameterValue === '') && !$this->isAllowedWithEmptyValue($parameterName)) {
                continue;
            }
            $relevantParameters[$parameterName] = $parameterValue;
        }
        if (!empty($relevantParameters)) {
            if ($this->includePageId) {
                if (empty($parameters['id'])) {
                    throw new \RuntimeException('ID parameter needs to be passed for the cHash calculation! As a temporary not recommended workaround, you can set $GLOBALS[\'TYPO3_CONF_VARS\'][\'FE\'][\'cHashIncludePageId\'] to false to avoid this error.', 1467983513);
                }
                $relevantParameters['id'] = $parameters['id'];
            }
            // Finish and sort parameters array by keys:
            $relevantParameters['encryptionKey'] = $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
            ksort($relevantParameters);
        }
        return $relevantParameters;
    }

    protected function splitQueryStringToArray($queryString)
    {
        $parameters = array_filter(explode('&', ltrim($queryString, '?')));
        $parameterArray = [];
        foreach ($parameters as $parameter) {
            list($parameterName, $parameterValue) = explode('=', $parameter);
            if (trim($parameterName) === '') {
                // This parameter cannot appear in $_GET in PHP even if its value is not empty, so it should be ignored!
                continue;
            }
            $parameterArray[rawurldecode($parameterName)] = rawurldecode($parameterValue);
        }
        return $parameterArray;
    }

    protected function isAdminPanelParameter($key)
    {
        return $key === 'ADMCMD_noBeUser' || $key === 'ADMCMD_view' || $key === 'ADMCMD_editIcons'
            || $key === 'ADMCMD_simUser' || $key === 'ADMCMD_simTime' || $key === 'ADMCMD_previewWS'
            || stripos($key, 'TSFE_ADMIN_PANEL') !== false && preg_match('/TSFE_ADMIN_PANEL\\[.*?\\]/', $key);
    }

    protected function isCoreParameter($key)
    {
        return $key === 'id' || $key === 'type' || $key === 'no_cache' || $key === 'cHash' || $key === 'MP' || $key === 'ftu';
    }

    protected function isExcludedParameter($key)
    {
        return in_array($key, $this->excludedParameters);
    }

    protected function isInCachedParametersWhiteList($key)
    {
        return in_array($key, $this->cachedParametersWhiteList);
    }

    protected function hasCachedParametersWhiteList()
    {
        return !empty($this->cachedParametersWhiteList);
    }

    protected function isAllowedWithEmptyValue($key)
    {
        return !($this->excludeAllEmptyParameters || in_array($key, $this->excludedParametersIfEmpty));
    }

    public function setConfiguration(array $configuration)
    {
        foreach ($configuration as $name => $value) {
            $setterName = 'set' . ucfirst($name);
            if (method_exists($this, $setterName)) {
                $this->{$setterName}($value);
            }
        }
    }

    protected function setCachedParametersWhiteList(array $cachedParametersWhiteList)
    {
        $this->cachedParametersWhiteList = $cachedParametersWhiteList;
    }

    protected function setIncludePageId($includePageId)
    {
        $this->includePageId = $includePageId;
    }

    protected function setExcludeAllEmptyParameters($excludeAllEmptyParameters)
    {
        $this->excludeAllEmptyParameters = $excludeAllEmptyParameters;
    }

    protected function setExcludedParameters(array $excludedParameters)
    {
        $this->excludedParameters = $excludedParameters;
    }

    protected function setExcludedParametersIfEmpty(array $excludedParametersIfEmpty)
    {
        $this->excludedParametersIfEmpty = $excludedParametersIfEmpty;
    }

    protected function setRequireCacheHashPresenceParameters(array $requireCacheHashPresenceParameters)
    {
        $this->requireCacheHashPresenceParameters = $requireCacheHashPresenceParameters;
    }
}