mc-cms-namelessmc/core/classes/Core/Cache.php

<?php

/**
 * Handles caching for NamelessMC.
 *
 * @package NamelessMC\Core
 * @author Christian Metz
 * @version 1.6-Nameless
 * @license BSD http://www.opensource.org/licenses/bsd-license.php
 */
class Cache
{
    /**
     * The path to the cache file folder.
     */
    private string $_cachepath = 'cache/';

    /**
     * The name of the default cache file.
     */
    private string $_cachename = 'default';

    /**
     * The cache file extension.
     */
    private string $_extension = '.cache';

    /**
     * Whether to collect cache data.
     */
    private bool $_record_collector;

    /**
     * Create a new Cache instance.
     *
     * @param  string|array $config (optional)
     * @return void
     */
    public function __construct($config = null)
    {
        if (isset($config)) {
            if (is_string($config)) {
                $this->setCache($config);
            } elseif (is_array($config)) {
                $this->setCache($config['name']);
                $this->setCachePath($config['path']);
                $this->setExtension($config['extension']);
            }
        }
    }

    private function recordCollector(): bool
    {
        return $this->_record_collector ??= defined('PHPDEBUGBAR') && PHPDEBUGBAR && class_exists('DebugBar\DebugBar');
    }

    /**
     * Cache name Setter.
     *
     * @param  string $name Name of cache file to use
     * @return Cache
     */
    public function setCache(string $name): Cache
    {
        $this->_cachename = $name;

        return $this;
    }

    /**
     * Check whether data is accociated with a key.
     *
     * @param  string $key The key to check
     * @return bool
     */
    public function isCached(string $key): bool
    {
        if ($this->_loadCache()) {
            $cachedData = $this->_loadCache();
            if (isset($cachedData[$key])) {
                $entry = $cachedData[$key];
                if ($entry && $this->_checkExpired($entry['time'], $entry['expire'])) {
                    $is_cached = false;
                } else {
                    $is_cached = isset($cachedData[$key]['data']);
                }
            }
        }

        if (!isset($is_cached)) {
            $is_cached = false;
        }

        if ($this->recordCollector()) {
            CacheCollector::getInstance()->recordCheck("{$this->_cachename}:{$key}", $is_cached);
        }

        return $is_cached;
    }

    /**
     * Retrieve the cache data or persist it if not found.
     *
     * @param  string $key        The key to retrieve
     * @param  mixed  $data       The data to persist if not found
     * @param  int    $expiration Expiration time in seconds
     * @return mixed  The cached data or the persisted data
     */
    public function fetch(string $key, $data, int $expiration = 0)
    {
        if ($this->isCached($key)) {
            return $this->retrieve($key);
        }

        if (is_callable($data)) {
            $data = $data();
        }

        $this->store($key, $data, $expiration);

        return $data;
    }

    /**
     * Load appointed cache.
     *
     * @return mixed
     */
    private function _loadCache()
    {
        if (file_exists($this->getCacheDir())) {
            $file = file_get_contents($this->getCacheDir());

            return json_decode($file, true);
        }

        return false;
    }

    /**
     * Get the cache directory path.
     *
     * @return string
     */
    public function getCacheDir(): string
    {
        if ($this->_checkCacheDir()) {
            $filename = $this->getCache();
            $filename = preg_replace('/[^0-9a-z\.\_\-]/i', '', strtolower($filename));

            return $this->getCachePath() . $this->_getHash($filename) . $this->getExtension();
        }

        return '';
    }

    /**
     * Check if a writable cache directory exists and if not create a new one.
     *
     * @return bool
     */
    private function _checkCacheDir(): bool
    {
        if (!is_dir($this->getCachePath()) && !mkdir($this->getCachePath(), 0775, true)) {
            throw new RuntimeException('Unable to create cache directory ' . $this->getCachePath());
        }

        if (!is_readable($this->getCachePath()) || !is_writable($this->getCachePath())) {
            if (!chmod($this->getCachePath(), 0775)) {
                throw new RuntimeException('Your <b>' . $this->getCachePath() . '</b> directory must be readable and writeable. Check your file permissions.');
            }
        }

        return true;
    }

    /**
     * Cache path Getter.
     *
     * @return string The path to the cache file folder
     */
    public function getCachePath(): string
    {
        return $this->_cachepath;
    }

    /**
     * Cache path Setter.
     *
     * @param  string $path
     * @return Cache
     */
    public function setCachePath(string $path): Cache
    {
        $this->_cachepath = $path;

        return $this;
    }

    /**
     * Cache name Getter.
     *
     * @return string Cache name
     */
    public function getCache(): string
    {
        return $this->_cachename;
    }

    /**
     * Get the filename hash.
     *
     * @param  string $filename
     * @return string The hashed filename
     */
    private function _getHash(string $filename): string
    {
        return sha1($filename);
    }

    /**
     * Cache file extension Getter.
     *
     * @return string Cache file extension
     */
    public function getExtension(): string
    {
        return $this->_extension;
    }

    /**
     * Cache file extension Setter.
     *
     * @param  string $ext Extension to use
     * @return Cache
     */
    public function setExtension(string $ext): Cache
    {
        $this->_extension = $ext;

        return $this;
    }

    /**
     * Check whether a timestamp is still in the duration.
     *
     * @param  int  $timestamp  Timestamp to check
     * @param  int  $expiration Duration to check
     * @return bool True if still in duration
     */
    private function _checkExpired(int $timestamp, int $expiration): bool
    {
        $result = false;
        if ($expiration !== 0) {
            $timeDiff = time() - $timestamp;
            $result = $timeDiff > $expiration;
        }

        return $result;
    }

    /**
     * Store data in the cache.
     *
     * @param string $key        Key to store data under
     * @param mixed  $data       Data to store
     * @param int    $expiration Expiration time in seconds
     *
     * @return Cache
     */
    public function store(string $key, $data, int $expiration = 0): Cache
    {
        $storeData = [
            'time' => time(),
            'expire' => $expiration,
            'data' => serialize($data),
        ];
        $dataArray = $this->_loadCache();
        if (is_array($dataArray)) {
            $dataArray[$key] = $storeData;
        } else {
            $dataArray = [$key => $storeData];
        }
        $cacheData = json_encode($dataArray);
        file_put_contents($this->getCacheDir(), $cacheData);

        if ($this->recordCollector()) {
            CacheCollector::getInstance()->recordSet("{$this->_cachename}:{$key}", $data, $expiration);
        }

        return $this;
    }

    /**
     * Retrieve cached data by its key.
     *
     * @param string $key       The key to retrieve
     * @param bool   $timestamp Whether to check if the cache is expired
     *
     * @return mixed The cached data or null if not found/expired
     */
    public function retrieve(string $key, bool $timestamp = false)
    {
        $cachedData = $this->_loadCache();
        $type = $timestamp ? 'time' : 'data';

        if (!isset($cachedData[$key][$type])) {
            if ($this->recordCollector()) {
                CacheCollector::getInstance()->recordMiss("{$this->_cachename}:{$key}");
            }

            return null;
        }

        if (!$timestamp) {
            $entry = $cachedData[$key];
            if ($entry && $this->_checkExpired($entry['time'], $entry['expire'])) {
                if ($this->recordCollector()) {
                    CacheCollector::getInstance()->recordMiss("{$this->_cachename}:{$key}");
                }

                return null;
            }
        }

        $data = unserialize($cachedData[$key][$type]);

        if ($this->recordCollector()) {
            CacheCollector::getInstance()->recordHit("{$this->_cachename}:{$key}", $data);
        }

        return $data;
    }

    /**
     * Retrieve all cached data.
     *
     * @param  bool  $meta (optional)
     * @return array The cached data
     */
    public function retrieveAll(bool $meta = false): array
    {
        if ($meta) {
            return $this->_loadCache();
        }

        $results = [];
        $cachedData = $this->_loadCache();
        if ($cachedData) {
            foreach ($cachedData as $k => $v) {
                $results[$k] = unserialize($v['data']);
            }
        }

        return $results;
    }

    /**
     * Erase cached entry by its key.
     *
     * @param  string $key The key to erase
     * @return Cache
     */
    public function erase(string $key): Cache
    {
        $cacheData = $this->_loadCache();
        if (is_array($cacheData)) {
            if (isset($cacheData[$key])) {
                unset($cacheData[$key]);
                $cacheData = json_encode($cacheData);
                file_put_contents($this->getCacheDir(), $cacheData);
            } else {
                throw new RuntimeException("Error: erase() - Key '$key' not found.");
            }
        }

        return $this;
    }

    /**
     * Erase all expired entries.
     *
     * @return int Number of entries erased
     */
    public function eraseExpired(): int
    {
        $cacheData = $this->_loadCache();
        if (is_array($cacheData)) {
            $counter = 0;
            foreach ($cacheData as $key => $entry) {
                if ($this->_checkExpired($entry['time'], $entry['expire'])) {
                    unset($cacheData[$key]);
                    $counter++;
                }
            }
            if ($counter > 0) {
                $cacheData = json_encode($cacheData);
                file_put_contents($this->getCacheDir(), $cacheData);
            }

            return $counter;
        }

        return -1;
    }

    /**
     * Erase all cached entries.
     *
     * @return Cache
     */
    public function eraseAll(): Cache
    {
        $cacheDir = $this->getCacheDir();
        if (file_exists($cacheDir)) {
            $cacheFile = fopen($cacheDir, 'wb');
            fclose($cacheFile);
        }

        return $this;
    }
}