Helix\Asana\Api\FileCache

Complexity

Total Complexity

24

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	isGzEncoding()	0	2	1
A	__construct()	0	2	1
A	getLogger()	0	2	1
A	deleteMultiple()	0	1	1
A	get()	0	14	4
A	set()	0	18	5
A	has()	0	1	1
A	log()	0	3	2
A	setLogger()	0	3	1
A	clear()	0	1	1
A	setMultiple()	0	1	1
A	delete()	0	5	2
A	setGzEncoding()	0	3	1
A	getMultiple()	0	1	1
A	_path()	0	4	1

<?php

namespace Helix\Asana\Api;

use DateInterval;
use DateTime;
use Psr\SimpleCache\CacheInterface;

/**
 * A bare bones PSR-16 "compliant" file-based cache for {@see SimpleCache}.
 *
 * Use this if you don't have a better cache.
 *
 * This is not safe for concurrency.
 */
final class FileCache implements CacheInterface {

    /**
     * @var string
     */
    private $dir;

    /**
     * @var bool
     */
    private $gzEncoding = false;

    /**
     * @var LoggerInterface
     */
    private $logger;

    public function __construct (string $dir) {
        $this->dir = $dir;
    }

    private function _path ($key) {
        $file = "{$this->dir}/{$key}~";
        clearstatcache(true, $file);
        return $file;
    }

    public function clear () {
        // unused. just delete the dir.
    }

    public function delete ($key) {
        $path = $this->_path($key);
        if (file_exists($path)) {
            $this->log('CACHE DELETE', $key);
            unlink($path);
        }
    }

    public function deleteMultiple ($keys) {
        // unused
    }

    public function get ($key, $default = null) {
        $path = $this->_path($key);
        if (file_exists($path)) {
            if (filemtime($path) > time()) {
                $this->log('CACHE HIT', $key);
                return unserialize($this->gzEncoding ? gzdecode(file_get_contents($path)) : file_get_contents($path));
            }
            $this->log('CACHE EXPIRE', $key);
            unlink($path);
        }
        else {
            $this->log('CACHE MISS', $key);
        }
        return $default;
    }

    /**
     * @return LoggerInterface
     */
    public function getLogger () {
        return $this->logger;
    }

    public function getMultiple ($keys, $default = null) {
        // unused
    }

    public function has ($key) {
        // unused
    }

    /**
     * @return bool
     */
    public function isGzEncoding (): bool {
        return $this->gzEncoding;
    }

    private function log (string $msg, string $key): void {
        if ($this->logger) {
            $this->logger->log($msg, $key);
        }
    }

    public function set ($key, $value, $ttl = null) {
        assert($ttl instanceof DateInterval);
        $this->log('CACHE SET', $key);
        $path = $this->_path($key);
        if (!is_dir(dirname($path))) {
            mkdir(dirname($path), 0770, true);
        }
        // if a gid ref is being stashed, make a symlink for quality of life.
        if (is_scalar($value)) {
            $link = substr($path, 0, -1) . '.ref';
            $real = $this->_path("asana/{$value}");
            if (!is_link($link)) {
                symlink($real, $link);
            }
        }
        file_put_contents($path, $this->gzEncoding ? gzencode(serialize($value)) : serialize($value));
        chmod($path, 0660);
        touch($path, (new DateTime())->add($ttl)->getTimeStamp());
    }

    /**
     * @param bool $gzEncoding
     * @return $this
     */
    public function setGzEncoding (bool $gzEncoding) {
        $this->gzEncoding = $gzEncoding;
        return $this;
    }

    /**
     * @param null|LoggerInterface $logger
     * @return $this
     */
    public function setLogger (?LoggerInterface $logger) {
        $this->logger = $logger;
        return $this;
    }

    public function setMultiple ($values, $ttl = null) {
        // unused
    }
}