JibitFileCache::store() - Code Metrics - Inspection of "Add Jibit Gateway" - shetabit/multipay - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#218)

unknown
created 2024-01-28 16:20 UTC
JibitFileCache::store() A

↳ Parent: JibitFileCache
Complexity

Conditions	3
Paths	3
Size

Total Lines	20
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
cc	3
eloc	12
c	1
b	0
f	1
nc	3
nop	4
dl	0
loc	20
rs	9.8666
<?php
namespace Shetabit\Multipay\Drivers\Jibit;

/**
 * PhpFileCache - Light, simple and standalone PHP in-file caching class
 * This class was heavily inspired by Simple-PHP-Cache. Huge thanks to Christian Metz
 * @license MIT
 * @author Wruczek https://github.com/Wruczek
 */
class JibitFileCache
{

    /**
     * Path to the cache directory
     * @var string
     */
    private $cacheDir;

    /**
     * Cache file name
     * @var string
     */
    private $cacheFilename;

    /**
     * Cache file name, hashed with sha1. Used as an actual file name
     * @var string
     */
    private $cacheFilenameHashed;

    /**
     * Cache file extension
     * @var string
     */
    private $cacheFileExtension;

    /**
     * Holds current cache
     * @var array
     */
    private $cacheArray;

    /**
     * If true, cache expire after one second
     * @var bool
     */
    private $devMode;

    /**
     * Cache constructor.
     * @param string $cacheDirPath cache directory. Must end with "/"
     * @param string $cacheFileName cache file name
     * @param string $cacheFileExtension cache file extension. Must end with .php
     * @throws \Exception if there is a problem loading the cache
     */
    public function __construct($cacheDirPath = "cache/", $cacheFileName = "defaultcache", $cacheFileExtension = ".cache.php")
    {
        $this->setCacheFilename($cacheFileName);
        $this->setCacheDir($cacheDirPath);
        $this->setCacheFileExtension($cacheFileExtension);
        $this->setDevMode(false);

        $this->reloadFromDisc();
    }

    /**
     * Loads cache
     * @return array array filled with data
     * @throws \Exception if there is a problem loading the cache
     */
    private function loadCacheFile()
    {
        $filepath = $this->getCacheFilePath();
        $file = @file_get_contents($filepath);

        if (!$file) {
            unlink($filepath);
            throw new \Exception("Cannot load cache file! ({$this->getCacheFilename()})");
        }

        // Remove the first line which prevents direct access to the file
        $file = $this->stripFirstLine($file);
        $data = unserialize($file);

        if ($data === false) {
            unlink($filepath);
            throw new \Exception("Cannot unserialize cache file, cache file deleted. ({$this->getCacheFilename()})");
        }

        if (!isset($data["hash-sum"])) {
            unlink($filepath);
            throw new \Exception("No hash found in cache file, cache file deleted");
        }

        $hash = $data["hash-sum"];
        unset($data["hash-sum"]);

        if ($hash !== $this->getStringHash(serialize($data))) {
            unlink($filepath);
            throw new \Exception("Cache data miss-hashed, cache file deleted");
        }

        return $data;
    }

    /**
     * Saves current cacheArray into the cache file
     * @return $this
     * @throws \Exception if the file cannot be saved
     */
    private function saveCacheFile()
    {
        if (!file_exists($this->getCacheDir())) {
            @mkdir($this->getCacheDir());
            /** @scrutinizer ignore-unhandled */ @mkdir($this->getCacheDir());
        }

        $cache = $this->cacheArray;
        $cache["hash-sum"] = $this->getStringHash(serialize($cache));
        $data = serialize($cache);
        $firstLine = '<?php die("Access denied") ?>' . PHP_EOL;
        $success = file_put_contents($this->getCacheFilePath(), $firstLine . $data) !== false;

        if (!$success) {
            throw new \Exception("Cannot save cache");
        }

        return $this;
    }

    /**
     * Stores $data under $key for $expiration seconds
     * If $key is already used, then current data will be overwritten
     * @param $key string key associated with the current data
     * @param $data mixed data to store
     * @param $expiration int number of seconds before the $key expires
     * @param $permanent bool if true, this item will not be automatically cleared after expiring
     * @return $this
     * @throws \Exception if the file cannot be saved
     */
    public function store($key, $data, $expiration = 60, $permanent = false)
    {
        if (!is_string($key)) {
            throw new \InvalidArgumentException('$key must be a string, got type "' . get_class($key) . '" instead');
        }

        if ($this->isDevMode()) {
            $expiration = 1;
        }

        $storeData = [
            "time" => time(),
            "expire" => $expiration,
            "data" => $data,
            "permanent" => $permanent
        ];

        $this->cacheArray[$key] = $storeData;
        $this->saveCacheFile();
        return $this;
    }

    /**
     * Returns data associated with $key
     * @param $key string
     * @param bool $meta if true, array will be returned containing metadata alongside data itself
     * @return mixed|null returns data if $key is valid and not expired, NULL otherwise
     * @throws \Exception if the file cannot be saved
     */
    public function retrieve($key, $meta = false)
    {
        $this->eraseExpired();

        if (!isset($this->cacheArray[$key])) {
            return null;
        }

        $data = $this->cacheArray[$key];
        return $meta ? $data : @$data["data"];
    }

    /**
     * Calls $refreshCallback if $key does not exists or is expired.
     * Also returns latest data associated with $key.
     * This is basically a shortcut, turns this:
     * <code>
     * if($cache->isExpired(key)) {
     *     $cache->store(key, $newdata, 10);
     * }
     *
     * $data = $cache->retrieve(key);
     * </code>
     *
     * to this:
     *
     * <code>
     * $data = $cache->refreshIfExpired(key, function () {
     *    return $newdata;
     * }, 10);
     * </code>
     *
     * @param $key
     * @param $refreshCallback Callback called when data needs to be refreshed. Should return data to be cached.
     * @param int $cacheTime Cache time. Defaults to 60
     * @param bool $meta If true, returns data with meta. @see retrieve
     * @return mixed|null Data currently stored under key
     * @throws \Exception if the file cannot be saved
     */
    public function refreshIfExpired($key, $refreshCallback, $cacheTime = 60, $meta = false)
    {
        if ($this->isExpired($key)) {
            $this->store($key, $refreshCallback(), $cacheTime);
        }

        return $this->retrieve($key, $meta);
    }

    /**
     * Erases data associated with $key
     * @param $key string
     * @return bool true if $key was found and removed, false otherwise
     * @throws \Exception if the file cannot be saved
     */
    public function eraseKey($key)
    {
        if (!$this->isCached($key, false)) {
            return false;
        }

        unset($this->cacheArray[$key]);
        $this->saveCacheFile();
        return true;
    }

    /**
     * Erases expired keys from cache
     * @return int number of erased entries
     * @throws \Exception if the file cannot be saved
     */
    public function eraseExpired()
    {
        $counter = 0;

        foreach ($this->cacheArray as $key => $value) {
            if (!$value["permanent"] && $this->isExpired($key, false)) {
                $this->eraseKey($key);
                $counter++;
            }
        }

        if ($counter > 0) {
            $this->saveCacheFile();
        }

        return $counter;
    }

    /**
     * Clears the cache
     * @throws \Exception if the file cannot be saved
     */
    public function clearCache()
    {
        $this->cacheArray = [];
        $this->saveCacheFile();
    }

    /**
     * Checks if $key has expired
     * @param $key
     * @param bool $eraseExpired if true, expired data will
     * be cleared before running this function
     * @return bool
     * @throws \Exception if the file cannot be saved
     */
    public function isExpired($key, $eraseExpired = true)
    {
        if ($eraseExpired) {
            $this->eraseExpired();
        }

        if (!$this->isCached($key, false)) {
            return true;
        }

        $item = $this->cacheArray[$key];

        return $this->isTimestampExpired($item["time"], $item["expire"]);
    }

    /**
     * Checks if $key is cached
     * @param $key
     * @param bool $eraseExpired if true, expired data will
     * be cleared before running this function
     * @return bool
     * @throws \Exception if the file cannot be saved
     */
    public function isCached($key, $eraseExpired = true)
    {
        if ($eraseExpired) {
            $this->eraseExpired();
        }

        return isset($this->cacheArray[$key]);
    }

    /**
     * Checks if the timestamp expired
     * @param $timestamp int
     * @param $expiration int number of seconds after the timestamp expires
     * @return bool true if the timestamp expired, false otherwise
     */
    private function isTimestampExpired($timestamp, $expiration)
    {
        $timeDiff = time() - $timestamp;
        return $timeDiff >= $expiration;
    }

    /**
     * Prints cache file using var_dump, useful for debugging
     */
    public function debugCache()
    {
        if (file_exists($this->getCacheFilePath())) {
            var_dump(unserialize($this->stripFirstLine(file_get_contents($this->getCacheFilePath()))));

        }
    }

    /**
     * Reloads cache from disc. Can be used after changing file name, extension or cache dir
     * using functions instead of constructor. (This class loads data once, when is created)
     * @throws \Exception if there is a problem loading the cache
     */
    public function reloadFromDisc()
    {
        // Try to load the cache, otherwise create a empty array
        $this->cacheArray = is_readable($this->getCacheFilePath()) ? $this->loadCacheFile() : [];
    }

    /**
     * Returns md5 hash of the given string.
     * @param $str string String to be hashed
     * @return string MD5 hash
     * @throws \InvalidArgumentException if $str is not a string
     */
    private function getStringHash($str)
    {
        if (!is_string($str)) {
            throw new \InvalidArgumentException('$key must be a string, got type "' . get_class($str) . '" instead');
        }

        return md5($str);
    }

    // Utils

    /**
     * Strips the first line from string
     * https://stackoverflow.com/a/7740485
     * @param $str
     * @return bool|string stripped text without the first line or false on failure
     */
    private function stripFirstLine($str)
    {
        $position = strpos($str, "\n");

        if ($position === false) {
            return $str;
        }

        return substr($str, $position + 1);
    }

    // Generic setters and getters below

    /**
     * Returns cache directory
     * @return string
     */
    public function getCacheDir()
    {
        return $this->cacheDir;
    }

    /**
     * Sets new cache directory. If you want to read data from new file, consider calling reloadFromDisc.
     * @param string $cacheDir new cache directory. Must end with "/"
     * @return $this
     */
    public function setCacheDir($cacheDir)
    {
        // Add "/" to the end if its not here
        if (substr($cacheDir, -1) !== "/") {
            $cacheDir .= "/";
        }

        $this->cacheDir = $cacheDir;
        return $this;
    }

    /**
     * Returns cache file name, hashed with sha1. Used as an actual file name
     * The new value is computed when using setCacheFilename method.
     * @return string
     */
    public function getCacheFilenameHashed()
    {
        return $this->cacheFilenameHashed;
    }

    /**
     * Returns cache file name
     * @return string
     */
    public function getCacheFilename()
    {
        return $this->cacheFilename;
    }

    /**
     * Sets new cache file name. If you want to read data from new file, consider calling reloadFromDisc.
     * @param string $cacheFilename
     * @return $this
     * @throws \InvalidArgumentException if $cacheFilename is not a string
     */
    public function setCacheFilename($cacheFilename)
    {
        if (!is_string($cacheFilename)) {

            throw new \InvalidArgumentException('$key must be a string, got type "' . get_class($cacheFilename) . '" instead');
        }

        $this->cacheFilename = $cacheFilename;
        $this->cacheFilenameHashed = $this->getStringHash($cacheFilename);
        return $this;
    }

    /**
     * Returns cache file extension
     * @return string
     */
    public function getCacheFileExtension()
    {
        return $this->cacheFileExtension;
    }

    /**
     * Sets new cache file extension. If you want to read data from new file, consider calling reloadFromDisc.
     * @param string $cacheFileExtension new cache file extension. Must end with ".php"
     * @return $this
     */
    public function setCacheFileExtension($cacheFileExtension)
    {
        // Add ".php" to the end if its not here
        if (substr($cacheFileExtension, -4) !== ".php") {
            $cacheFileExtension .= ".php";
        }

        $this->cacheFileExtension = $cacheFileExtension;
        return $this;
    }

    /**
     * Combines directory, filename and extension into a path
     * @return string
     */
    public function getCacheFilePath()
    {
        return $this->getCacheDir() . $this->getCacheFilenameHashed() . $this->getCacheFileExtension();
    }

    /**
     * Returns raw cache array
     * @return array
     */
    public function getCacheArray()
    {
        return $this->cacheArray;
    }

    /**
     * Returns true if dev mode is on
     * If dev mode is on, cache expire after one second
     * @return bool
     */
    public function isDevMode()
    {
        return $this->devMode;
    }

    /**
     * Sets dev mode on or off
     * If dev mode is on, cache expire after one second
     * @param $devMode
     * @return $this
     */
    public function setDevMode($devMode)
    {
        $this->devMode = $devMode;
        return $this;
    }
}

shetabit / multipay

Pull Request — master (#218)

JibitFileCache::store() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
