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!
 */
 
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪CacheHashCalculator implements ‪SingletonInterface
{
    protected ‪$cachedParametersWhiteList = [];
 
    protected ‪$excludedParameters = [];
 
    protected ‪$requireCacheHashPresenceParameters = [];
 
    protected ‪$excludedParametersIfEmpty = [];
 
    protected ‪$excludeAllEmptyParameters = false;
 
    public function ‪__construct(array $configuration = null)
    {
        $configuration = $configuration ?? ‪$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash'] ?? [];
        $this->‪setConfiguration($configuration);
    }
 
    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, true)) {
                $hasRequiredParameter = true;
                break;
            }
        }
        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 (($parameterValue === null || $parameterValue === '') && !$this->‪isAllowedWithEmptyValue($parameterName)) {
                continue;
            }
            $relevantParameters[$parameterName] = $parameterValue;
        }
        if (!empty($relevantParameters)) {
            if (empty($parameters['id'])) {
                throw new \RuntimeException('ID parameter needs to be passed for the cHash calculation!', 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) {
            // should not remove empty values with trimExplode, otherwise cases like &=value, value is used as parameterName.
            $parts = GeneralUtility::trimExplode('=', $parameter, false);
            $parameterName = $parts[0];
            $parameterValue = $parts[1] ?? '';
            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_prev'
            || 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, true);
    }
 
    protected function ‪isInCachedParametersWhiteList($key)
    {
        return in_array($key, $this->cachedParametersWhiteList, true);
    }
 
    protected function ‪hasCachedParametersWhiteList()
    {
        return !empty($this->cachedParametersWhiteList);
    }
 
    protected function ‪isAllowedWithEmptyValue($key)
    {
        return !($this->excludeAllEmptyParameters || in_array($key, $this->excludedParametersIfEmpty, true));
    }
 
    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 ‪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;
    }
}