First Commit

Author: nabeelalihashmi

.gitignore

@@ -0,0 +1,2 @@
+vendor/
+cache/

README.md

@@ -0,0 +1,89 @@
+![LightCache](./docs/header.png)
+
+# LightCache
+
+A Fast, Easy and FileSystem based Cache for PHP.
+## About Author
+[Nabeel Ali](https://iconiccodes.com)
+
+Website: [https://iconiccodes.com](https://iconiccodes.com)
+
+Email: [mail2nabeelali@gmail.com](mailto:mail2nabeelali@gmail.com)
+
+## Features
+
+    * Fast
+    * Easy
+    * Lightweight
+    * Supports Expiration
+
+
+## Installtion
+```
+composer require nabeelalihashmi/LightCache
+```
+
+## Basic Usage
+```
+$cache = new IconicCodes\LightCache\FilesCache;
+$cache->cachedir = __DIR__ . "/cache";
+
+$cache->get('key', function () {
+    return ["value", time() + 10]; // cache for 10 seconds
+});
+
+$cache->delete('key');
+
+```
+
+## Methods
+
+* `get`
+* `getValue`
+* `has`
+* `delete`
+* `set`
+
+### get($key, $callback)
+Returns the value of the key. If the key is not found, the callback will be called and the value will be cached. If the key is found, the callback will not be called. The callback shall return an array with the value and the expiration time.
+
+```
+$cache-get('key', function() {
+    return ["value", time() + 10]; // cache for 10 seconds
+});
+```
+
+This is probably most used function.
+
+### getValue($key)
+Return value if key exists or cache is not exired. If key does not exist, returns false. If cache is expired, returns false.
+
+### has($key)
+Returns true if key exists. Doesn't check cache expiration.
+
+### delete($key)
+Deletes key from cache. This is probably the second most used function.
+
+## set($key, $value, $expiration)
+Sets the value of the key. The expiration time is optional. If not set, the value will be cached for ever.
+
+-------------------------
+
+## License
+
+LightCache is released under permissive licese with following conditions:
+
+* It cannot be used to create adult apps.
+* It cannot be used to gambling apps.
+* It cannot be used to create apps having hate speech.
+
+### MIT License
+
+Copyright 2022 Nabeel Ali | IconicCodes.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

composer.json

@@ -0,0 +1,19 @@
+{
+    "name": "nabeelalihashmi/lightcache",
+    "description": "Lightweight Files Based Caching",
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "IconicCodes\\LightCache\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Nabeel Ali",
+            "email": "mail2nabeelali@gmail.com"
+        }
+    ],
+    "minimum-stability": "stable",
+    "require": {}
+}

docs/header.png

@@ -0,0 +1,87 @@
+<?php
+
+namespace IconicCodes\LightCache;
+
+
+class FilesCache {
+
+    public $cachedir = "";
+    public $cache_version = "1.0.0";
+
+    public function getValue($key) {
+        $filename = $this->getHashFilename($key);
+        if (file_exists($filename)) {
+            $data = unserialize(file_get_contents($filename));
+            $ttl = $data['t'];
+            if ($ttl === 0) {
+                return $data['d'];
+            }
+            
+            if ($ttl !== 0 &&  time() >= $ttl) {
+                return false;
+            }
+            return $data['d'];
+        }
+        return false;
+    }
+
+    private function sha($key) {
+        return sha1($key);
+    }
+
+    private function getHashFilename($filename, $makeDirs = false) {
+        if (!file_exists($this->cachedir)) {
+            mkdir($this->cachedir, 0777, true);
+        }
+        if (strpos($filename, '.')) {
+            $parts = explode('.', $filename);
+            $list = array_map(function ($part) {
+                return $this->sha($part);
+                $part;
+            }, $parts);
+            $outputFilename = implode('/', $list) . '.cache';
+
+            if ($makeDirs) {
+                $dir = $this->cachedir . '/' . $outputFilename;
+                if (!file_exists($dir)) {
+                    $path = dirname($dir);
+                    mkdir($path, 0777, true);
+                }
+            }
+        } else {
+            $outputFilename = $this->sha($filename) . '.cache';
+        }
+
+        return $this->cachedir . '/' . $outputFilename;
+    }
+
+    public function has($key) {
+        $filename = $this->getHashFilename($key);
+        return file_exists($filename);
+    }
+
+    public function delete($key) {
+        $filename = $this->getHashFilename($key);
+        if (file_exists($filename)) {
+            unlink($filename);
+        }
+    }
+
+    public function set($key, $value, $ttl = 0) {
+        $cacheData = serialize([
+            'd' => $value,
+            't' => $ttl
+        ]);
+        file_put_contents($this->getHashFilename($key, true), $cacheData);
+    }
+
+    public function get($key, $callback) {
+        $data = $this->getValue($key);
+        if ($data !== false) {
+            return $data;
+        }
+        $data = $callback();
+        $this->set($key, $data[0], $data[1]);
+        return $data[0];
+    }
+}

src/FilesCache.php

@@ -0,0 +1,66 @@
+<?php
+
+use IconicCodes\LightCache\FilesCache;
+
+require 'vendor/autoload.php';
+
+$cache = new FilesCache;
+
+$cache->cachedir = __DIR__ . "/cache";
+
+$item = $cache->get('test_cache_1', function() {
+    return [ uniqid(), time() + 5];
+});
+
+$count = 0;
+$oldItem = $item;
+while ($count < 7) {
+    $item = $cache->get('test_cache_1', function() {
+        return [ uniqid(), time() + 5];
+    });
+
+    if($count < 5) {
+        $test = 'testEq';
+        $exp = 'cached for';
+    } else {
+        $test = 'testNotEq';
+        $exp = 'expired after';
+    }
+    $test_num = $count + 1;
+    $test($item, $oldItem, "Test ${test_num} \nExpected item to be $exp 5 seconds");
+    $count++;
+    sleep(1);
+}
+
+
+
+
+function testNotEq($expect, $output, $message) {
+    echo "\n$message \n";
+    echo 'not expected value: '  . $expect . "\n";
+    echo 'output value: ' . $output . "\n";
+
+    if ($expect !== $output) {
+        echo "TEST OK \n";
+    } else {
+        echo "TEST FAIL \n";
+    }
+
+    echo "\n-----------------------------------\n";
+
+}
+
+function testEq($expect, $output, $message) {
+    echo "\n$message \n";
+    echo 'expected value: '  . $expect . "\n";
+    echo 'output value: ' . $output . "\n";
+
+    if ($expect === $output) {
+        echo "TEST OK \n";
+    } else {
+        echo "TEST FAIL \n";
+    }
+
+    echo "\n-----------------------------------\n";
+
+}