Merge pull request #17 from kodedphp/shmop

kodedphp · Dec 11, 2019 · ba598e8 · ba598e8
2 parents d6dac1c + 2cfe921
commit ba598e8
Show file tree

Hide file tree

Showing 19 changed files with 249 additions and 85 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -12,9 +12,13 @@ cache:
 php:
   - 7.2
   - 7.3
+  - 7.4
+  - nightly
 
 matrix:
   fast_finish: true
+  allow_failures:
+    - php: nightly
 
 services:
   - redis-server

diff --git a/Client/CacheClientFactory.php b/Client/CacheClientFactory.php
@@ -12,9 +12,10 @@
 
 namespace Koded\Caching\Client;
 
+use Error;
 use Exception;
 use Koded\Caching\{Cache, CacheException};
-use Koded\Caching\Configuration\{FileConfiguration, MemcachedConfiguration, PredisConfiguration, RedisConfiguration};
+use Koded\Caching\Configuration\{MemcachedConfiguration, PredisConfiguration, RedisConfiguration};
 use Koded\Stdlib\Interfaces\{Configuration, ConfigurationFactory, Serializer};
 use Koded\Stdlib\Serializer\SerializerFactory;
 use Psr\Log\{LoggerInterface, NullLogger};
@@ -58,8 +59,10 @@ public function new(string $client = ''): Cache
                 /** @var PredisConfiguration $config */
                 return $this->createPredisClient($config);
 
+            case 'shmop':
+                return new ShmopClient((string)$config->get('dir'), $config->get('ttl'));
+
             case 'file':
-                /** @var FileConfiguration $config */
                 return new FileClient($this->getLogger($config), (string)$config->get('dir'), $config->get('ttl'));
 
             case 'memory':
@@ -134,7 +137,7 @@ private function newRedis(RedisConfiguration $conf): \Redis
         catch (\RedisException $e) {
             error_log('[Redis] ' . $e->getMessage());
             throw CacheException::withConnectionErrorFor('Redis');
-        } catch (Exception $e) {
+        } catch (Exception | Error $e) {
             throw CacheException::from($e);
         }
     }

diff --git a/Client/ClientTrait.php b/Client/ClientTrait.php
@@ -17,11 +17,10 @@
 
 trait ClientTrait
 {
-
     /** @var int|null Global TTL for caching, used as default expiration time in cache clients */
     private $ttl;
 
-    /** @var \Memcached | \Redis | \Predis\Client | \Koded\Caching\Client\FileClient | \Koded\Caching\Client\MemoryClient */
+    /** @var \Memcached | \Redis | \Predis\Client | \Koded\Caching\Client\FileClient | \Koded\Caching\Client\MemoryClient | \Koded\Caching\Client\ShmopClient */
     private $client;
 
     public function getTtl(): ?int

diff --git a/Client/FileClient.php b/Client/FileClient.php
@@ -15,7 +15,7 @@
 use Koded\Caching\{Cache, CacheException};
 use Psr\Log\LoggerInterface;
 use function Koded\Caching\verify_key;
-use function Koded\Stdlib\{now, rmdir};
+use function Koded\Stdlib\rmdir;
 
 /**
  * @property FileClient client
@@ -89,16 +89,16 @@ public function clear()
     public function has($key, &$filename = '', &$cache = null)
     {
         verify_key($key);
-
         $filename = $this->filename($key, false);
+
         if (false === is_file($filename)) {
             return false;
         }
 
         /** @noinspection PhpIncludeInspection */
         $cache = include $filename;
 
-        if ($cache['timestamp'] <= now()->getTimestamp()) {
+        if ($cache['timestamp'] <= time()) {
             unlink($filename);
 
             return false;
@@ -142,7 +142,7 @@ private function filename(string $key, bool $create): string
      *
      * @throws CacheException
      */
-    private function setDirectory(string $directory)
+    private function setDirectory(string $directory): void
     {
         // Overrule shell misconfiguration or the web server
         umask(umask() | 0002);

diff --git a/Client/ShmopClient.php b/Client/ShmopClient.php
@@ -0,0 +1,164 @@
+<?php
+
+/*
+ * This file is part of the Koded package.
+ *
+ * (c) Mihail Binev <[email protected]>
+ *
+ * Please view the LICENSE distributed with this source code
+ * for the full copyright and license information.
+ *
+ */
+
+namespace Koded\Caching\Client;
+
+use Exception;
+use Koded\Caching\{Cache, CacheException};
+use function Koded\Caching\verify_key;
+
+/**
+ * @property ShmopClient client
+ *
+ */
+final class ShmopClient implements Cache
+{
+    use ClientTrait, MultiplesTrait;
+
+    /** @var string */
+    private $dir;
+
+    public function __construct(string $dir, ?int $ttl)
+    {
+        $this->dir = $dir;
+        $this->ttl = $ttl;
+        $this->setDirectory($dir);
+    }
+
+
+    public function get($key, $default = null)
+    {
+        if (false === $this->has($key, $filename)) {
+            return $default;
+        }
+
+        try {
+            $resource = shmop_open(fileinode($filename), 'a', 0, 0);
+            return unserialize(shmop_read($resource, 0, shmop_size($resource)));
+        } finally {
+            shmop_close($resource);
+        }
+    }
+
+
+    public function set($key, $value, $ttl = null)
+    {
+        verify_key($key);
+
+        if (1 > $expiration = $this->timestampWithGlobalTtl($ttl, Cache::DATE_FAR_FAR_AWAY)) {
+            // The item is considered expired and must be deleted
+            return $this->delete($key);
+        }
+
+        $value = serialize($value);
+        $size = strlen($value);
+        $filename = $this->filename($key, true);
+
+        try {
+            $resource = shmop_open(fileinode($filename), 'n', 0666, $size);
+        } catch (Exception $e) {
+            $resource = shmop_open(fileinode($filename), 'w', 0666, $size);
+        }
+
+        try {
+            return shmop_write($resource, $value, 0) === $size
+                && false !== file_put_contents($filename . '-ttl', $expiration);
+
+        } finally {
+            shmop_close($resource);
+        }
+    }
+
+
+    public function delete($key)
+    {
+        if (false === $this->has($key, $filename)) {
+            return true;
+        }
+
+        return $this->expire($filename);
+    }
+
+
+    public function clear()
+    {
+        foreach ((glob($this->dir . 'shmop-*.cache*') ?: []) as $filename) {
+            $this->expire($filename);
+        }
+        return true;
+    }
+
+
+    public function has($key, &$filename = '')
+    {
+        verify_key($key);
+        $filename = $this->filename($key, false);
+        $expiration = (int)(@file_get_contents($filename . '-ttl') ?: 0);
+
+        if ($expiration <= time()) {
+            $this->expire($filename);
+            return false;
+        }
+
+        return true;
+    }
+
+
+    private function filename(string $key, bool $create): string
+    {
+        $filename = $this->dir . 'shmop-' . sha1($key) . '.cache';
+
+        if ($create) {
+            touch($filename);
+            touch($filename . '-ttl');
+            chmod($filename, 0666);
+            chmod($filename . '-ttl', 0666);
+        }
+
+        return $filename;
+    }
+
+    /**
+     * Prepares the cache directory.
+     *
+     * @param string $directory
+     *
+     * @throws CacheException
+     */
+    private function setDirectory(string $directory): void
+    {
+        // Overrule shell misconfiguration or the web server
+        umask(umask() | 0002);
+        $dir = $directory ?: sys_get_temp_dir();
+        $dir = rtrim($dir, '/') . '/';
+
+        if (false === is_dir($dir) && false === mkdir($dir, 0775, true)) {
+            throw CacheException::forCreatingDirectory($dir);
+        }
+
+        $this->dir = $dir;
+    }
+
+    private function expire(string $filename): bool
+    {
+        if (false === $resource = @shmop_open(fileinode($filename), 'w', 0, 0)) {
+            return false;
+        }
+
+        try {
+            unlink($filename . '-ttl');
+            return shmop_delete($resource);
+        } finally {
+            shmop_close($resource);
+        }
+    }
+}
diff --git a/Configuration/FileConfiguration.php b/Configuration/FileConfiguration.php
diff --git a/README.md b/README.md
@@ -242,6 +242,18 @@ There are many configuration options for this package.
 Please refer to [Predis configuration page][6].
 
 
+### Shared Memory (shmop)
+
+Requires a [PHP shmop extension][11].
+
+```php
+$cache = simple_cache_factory('shmop', [
+    'dir' => '/path/to/app/cache', // optional
+    'ttl' => null,                 // global TTL
+]);
+```
+
+
 ### FileConfiguration
 
 This is the slowest cache client, please avoid it for production environments.
@@ -281,4 +293,5 @@ The code is distributed under the terms of [The 3-Clause BSD license](LICENSE).
 [7]: https://github.com/phpredis/phpredis#connect-open
 [8]: http://php.net/sys_get_temp_dir
 [9]: http://php.net/json_encode
-[10]: https://www.php-fig.org/psr/psr-16/
+[10]: https://www.php-fig.org/psr/psr-16/
+[11]: https://www.php.net/manual/en/book.shmop.php
diff --git a/Tests/Integration/FileClientTest.php b/Tests/Integration/FileClientTest.php
@@ -27,10 +27,6 @@ public function createSimpleCache()
 
     protected function setUp(): void
     {
-        $this->skippedTests = [
-            'testSetMultipleInvalidKeys' => '',
-        ];
-
         $this->dir = vfsStream::setup();
         parent::setUp();
     }

diff --git a/Tests/Integration/MemcachedClientTest.php b/Tests/Integration/MemcachedClientTest.php
@@ -35,21 +35,6 @@ protected function setUp(): void
 
         $this->skippedTests = [
             'testBasicUsageWithLongKey' => 'Memcached max key length is 250 chars',
-
-            'testSet' => '',
-            'testSetTtl' => '',
-            'testSetExpiredTtl' => '',
-            'testGet' => '',
-            'testDelete' => '',
-            'testClear' => '',
-
-            'testSetMultiple' => '',
-            'testSetMultipleWithIntegerArrayKey' => '',
-            'testSetMultipleTtl' => '',
-            'testSetMultipleExpiredTtl' => '',
-            'testSetMultipleWithGenerator' => '',
-            'testGetMultiple' => '',
-            'testSetMultipleInvalidKeys' => '',
         ];
     }
 }
diff --git a/Tests/Integration/MemoryClientTest.php b/Tests/Integration/MemoryClientTest.php
@@ -15,10 +15,6 @@ class MemoryClientTest extends SimpleCacheTest
      */
     public function createSimpleCache()
     {
-        $this->skippedTests = [
-            'testSetMultipleInvalidKeys' => '',
-        ];
-
         return simple_cache_factory('memory');
     }
 }
diff --git a/Tests/Integration/PredisClientTest.php b/Tests/Integration/PredisClientTest.php
@@ -15,10 +15,6 @@ class PredisClientTest extends SimpleCacheTest
      */
     public function createSimpleCache()
     {
-        $this->skippedTests = [
-            'testSetMultipleInvalidKeys' => '',
-        ];
-
         return simple_cache_factory('predis', [
             'host' => getenv('REDIS_SERVER_HOST'),
         ]);

diff --git a/Tests/Integration/PredisJsonClientTest.php b/Tests/Integration/PredisJsonClientTest.php
@@ -16,10 +16,6 @@ class PredisJsonClientTest extends SimpleCacheTest
      */
     public function createSimpleCache()
     {
-        $this->skippedTests = [
-            'testSetMultipleInvalidKeys' => '',
-        ];
-
         return simple_cache_factory('predis', [
             'host' => getenv('REDIS_SERVER_HOST'),
             'port' => getenv('REDIS_SERVER_PORT'),

diff --git a/Tests/Integration/RedisClientTest.php b/Tests/Integration/RedisClientTest.php
@@ -15,10 +15,6 @@ class RedisClientTest extends SimpleCacheTest
      */
     public function createSimpleCache()
     {
-        $this->skippedTests = [
-            'testSetMultipleInvalidKeys' => '',
-        ];
-
         return simple_cache_factory('redis', [
             'host' => getenv('REDIS_SERVER_HOST'),
         ]);

diff --git a/Tests/Integration/RedisJsonClientTest.php b/Tests/Integration/RedisJsonClientTest.php
@@ -16,10 +16,6 @@ class RedisJsonClientTest extends SimpleCacheTest
      */
     public function createSimpleCache()
     {
-        $this->skippedTests = [
-            'testSetMultipleInvalidKeys' => '',
-        ];
-
         return simple_cache_factory('redis', [
             'host' => getenv('REDIS_SERVER_HOST'),
             'serializer' => Serializer::JSON,