Aoe\Restler\System\TYPO3\Cache

Complexity

Total Complexity

10

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	isResponseCacheableByTypo3Cache()	0	8	4
A	__construct()	0	4	1
A	flushByTag()	0	3	1
A	cacheResponseByTypo3Cache()	0	24	1
A	getCacheEntry()	0	4	1
A	hasCacheEntry()	0	4	1
A	buildIdentifier()	0	3	1

<?php
namespace Aoe\Restler\System\TYPO3;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2016 AOE GmbH <dev@aoe.com>
 *
 *  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 3 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!
 ***************************************************************/

use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManager;

/**
 * @package Restler
 */
class Cache implements SingletonInterface
{
    /**
     * This is the phpdoc-tag, which defines, that the response of API-method is cacheable via TYPO3-caching-framework
     *
     * Syntax:
     * The PHPdoc-comment must look like this:
     * @restler_typo3cache_expires [expires-in-seconds]
     *
     * Examples:
     * When API-method should be cacheable in TYPO3 for 10 minutes, than the PHPdoc-comment must look like this:
     * @restler_typo3cache_expires 600
     * When API-method should be cacheable in TYPO3 for endless time, than the PHPdoc-comment must look like this:
     * @restler_typo3cache_expires 0
     *
     * @var string
     */
    const API_METHOD_TYPO3CACHE_EXPIRES = 'restler_typo3cache_expires';

    /**
     * This is the phpdoc-tag, which defines, that the cached response of API-method should be tagged with given tags
     *
     * Syntax:
     * The PHPdoc-comment must look like this:
     * @restler_typo3cache_tags [comma-separated-list-of-tags]
     *
     * Example:
     * When response of API-method should be tagged with 'tag_a' and 'tag_b', than the PHPdoc-comment must look like this:
     * @restler_typo3cache_tags tag_a,tag_b
     *
     * @var string
     */
    const API_METHOD_TYPO3CACHE_TAGS = 'restler_typo3cache_tags';

    /**
     * @var FrontendInterface
     */
    private $cache;

    /**
     * @param CacheManager $cacheManager
     */
    public function __construct(CacheManager $cacheManager = null)
    {
        $cacheManager = $cacheManager ?? GeneralUtility::makeInstance(ObjectManager::class)->get(CacheManager::class);
        $this->cache = $cacheManager->getCache('cache_restler');
    }

    /**
     * @param string $requestMethod
     * @param array $apiMethodInfoMetadata
     * @return boolean
     */
    public function isResponseCacheableByTypo3Cache($requestMethod, array $apiMethodInfoMetadata)
    {
        if ($requestMethod === 'GET' &&
            array_key_exists(self::API_METHOD_TYPO3CACHE_EXPIRES, $apiMethodInfoMetadata) &&
            array_key_exists(self::API_METHOD_TYPO3CACHE_TAGS, $apiMethodInfoMetadata)) {
            return true;
        }
        return false;
    }

    /**
     * cache response
     *
     * @param int $responseCode
     * @param string $requestUri
     * @param array $requestGetData
     * @param array $apiMethodInfoMetadata
     * @param string $responseData
     * @param $responseFormatClass
     * @param array $responseHeaders
     */
    public function cacheResponseByTypo3Cache(
        $responseCode,
        $requestUri,
        array $requestGetData,
        array $apiMethodInfoMetadata,
        $responseData,
        $responseFormatClass,
        array $responseHeaders
    ) {
        $identifier = $this->buildIdentifier($requestUri, $requestGetData);
        $frontendCacheExpires = (integer) $apiMethodInfoMetadata['expires'];
        $typo3CacheExpires = (integer) $apiMethodInfoMetadata[self::API_METHOD_TYPO3CACHE_EXPIRES];
        $typo3CacheTags = explode(',', $apiMethodInfoMetadata[self::API_METHOD_TYPO3CACHE_TAGS]);

        $cacheData = array();
        $cacheData['responseCode'] = $responseCode;
        $cacheData['requestUri'] = $requestUri;
        $cacheData['requestGetData'] = $requestGetData;
        $cacheData['responseData'] = $responseData;
        $cacheData['responseFormatClass'] = $responseFormatClass;
        $cacheData['responseHeaders'] = $responseHeaders;
        $cacheData['frontendCacheExpires'] = $frontendCacheExpires;

        $this->cache->set($identifier, $cacheData, $typo3CacheTags, $typo3CacheExpires);
    }

    /**
     * @param string $requestUri
     * @param array $getData
     * @return array
     */
    public function getCacheEntry($requestUri, array $getData)
    {
        $identifier = $this->buildIdentifier($requestUri, $getData);
        return $this->cache->get($identifier);
    }

    /**
     * @param string $requestUri
     * @param array $getData
     * @return boolean
     */
    public function hasCacheEntry($requestUri, array $getData)
    {
        $identifier = $this->buildIdentifier($requestUri, $getData);
        return $this->cache->has($identifier);
    }

    /**
     * @param string $tag
     */
    public function flushByTag($tag)
    {
        $this->cache->flushByTag($tag);
    }

    /**
     * @param string $requestUri
     * @param array $getData
     * @return string
     */
    private function buildIdentifier($requestUri, array $getData)
    {
        return md5($requestUri . serialize($getData));
    }
}