Helix\Asana\Api\FileCache

Complexity

Total Complexity

24

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	getLogger()	0	2	1
A	deleteMultiple()	0	1	1
A	get()	0	18	4
A	set()	0	21	5
A	has()	0	1	1
A	log()	0	3	2
A	_ref()	0	2	1
A	setLogger()	0	3	1
A	clear()	0	1	1
A	setMultiple()	0	1	1
A	delete()	0	10	3
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;

    /**
     * Compression.
     *
     * @var bool
     */
    private $gz;

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

    /**
     * @param string $dir
     * @param bool $gz
     */
    public function __construct (string $dir, $gz = false) {
        $this->dir = $dir;
        $this->gz = $gz;
    }

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

    private function _ref ($key): string {
        return "{$this->dir}/{$key}.ref";
    }

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

    public function delete ($key) {
        $path = $this->_path($key);
        if (is_link($ref = $this->_ref($key))) {
            $this->log('CACHE DELINK', $key);
            unlink($ref);
            unlink($path);
        }
        elseif (is_file($path)) {
            $this->log('CACHE DELETE', $key);
            unlink($path);
        }
    }

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

    public function get ($key, $default = null) {
        $path = $this->_path($key);
        if (is_file($path)) {
            if (filemtime($path) > time()) {
                $this->log('CACHE HIT', $key);
                $data = file_get_contents($path);
                if ($this->gz) {
                    $data = gzdecode($data);
                }
                return unserialize($data);
            }
            $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
    }

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

    /**
     * @param string $key
     * @param string|object $value
     * @param DateInterval $ttl
     * @return void
     */
    public function set ($key, $value, $ttl = null): void {
        assert($ttl instanceof DateInterval);
        $path = $this->_path($key);
        $data = serialize($value);
        if ($this->gz) {
            $data = gzencode($data);
        }
        if (!is_dir(dirname($path))) {
            mkdir(dirname($path), 0770, true);
        }
        if (is_object($value)) {
            $this->log('CACHE SET', $key);
            file_put_contents($path, $data);
        }
        elseif (!file_exists($path)) {
            $this->log('CACHE LINK', "{$key} => asana/{$value}");
            file_put_contents($path, $data);
            symlink($this->_path("asana/{$value}"), $this->_ref($key));
        }
        chmod($path, 0660);
        touch($path, (new DateTime())->add($ttl)->getTimeStamp());
    }

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

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