Comodojo\Dispatcher\Cache\ServerCache

Complexity

Total Complexity

9

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

26.09%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	read()	0	16	2
B	dump()	0	29	6
A	getCacheName()	0	5	1

<?php namespace Comodojo\Dispatcher\Cache;

use \Comodojo\Dispatcher\Request\Model as Request;
use \Comodojo\Dispatcher\Router\Route;
use \Comodojo\Dispatcher\Response\Model as Response;

/**
 * @package     Comodojo Dispatcher
 * @author      Marco Giovinazzi <marco.giovinazzi@comodojo.org>
 * @author      Marco Castiello <marco.castiello@gmail.com>
 * @license     GPL-3.0+
 *
 * LICENSE:
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */


class ServerCache extends AbstractCache {

    // @NOTE: Server cache will not consider cacheable POST or PUT requests
    //        because of dispatcher internal structure: if post request is cached
    //        subsequent requests will never reach the service.
    const CACHABLE_METHODS = ['GET', 'HEAD'];

    const CACHABLE_STATUSES = [200, 203, 300, 301, 302, 404, 410];

    const CACHE_NAMESPACE = "DISPATCHERSERVICES";

    public function read(
        Request $request,
        Response $response
    ) {

        $name = self::getCacheName($request);

        $cache_object = $this->getCache()->setNamespace(self::CACHE_NAMESPACE)->get($name);

        if ( is_null($cache_object) ) return false;

        $response->import($cache_object);

        return true;

    }

    public function dump(
        Request $request,
        Response $response,
        Route $route
    ) {

        $cache = strtoupper($route->getParameter('cache'));

        $ttl = $route->getParameter('ttl');

        $name = self::getCacheName($request);

        $method = (string) $request->getMethod();

        $status = $response->getStatus()->get();

        if (
            ( $cache == 'SERVER' || $cache == 'BOTH' ) &&
            in_array($method, self::CACHABLE_METHODS) &&
            in_array($status, self::CACHABLE_STATUSES)
        ){

            $this->getCache()
                ->setNamespace(self::CACHE_NAMESPACE)
                ->set($name, $response->export(), $ttl === null ? self::DEFAULTTTL : intval($ttl));

        }

    }

    private static function getCacheName(Request $request) {

        return md5( (string) $request->getMethod() . (string) $request->getUri() );

    }

}