feat(cache): improve performance and reduce data loss

Author: Marco Cesarato

src/Cache.php

@@ -28,7 +28,7 @@ class Cache extends SingletonAbstract
     protected function __construct()
     {
         parent::__construct();
-        $tempdir = sys_get_temp_dir() . self::$DS . Scanner::getName() . self::$DS;
+        $tempdir = sys_get_temp_dir() . self::$DS . Scanner::getName() . self::$DS . 'cache' . self::$DS;
 
         if (!is_dir($tempdir) && (!mkdir($tempdir, 0777, true) && !is_dir($tempdir))) {
             throw new RuntimeException(sprintf('Temp Directory "%s" was not created', $tempdir));
@@ -50,18 +50,19 @@ public function set($key, $value, $ttl = 3600)
     {
         $key = $this->key($key);
 
-        if ($data = json_encode(['ttl' => $ttl > 0 ? time() + $ttl : $ttl,  'data' => $value])) {
-            if (!Scanner::isCacheEnabled()) {
-                self::$cache[$key] = $data;
+        $data = ['ttl' => $ttl > 0 ? time() + $ttl : $ttl,  'data' => $value];
 
-                return true;
-            }
+        if (!Scanner::isCacheEnabled()) {
+            self::$cache[$key] = $data;
 
-            if (file_put_contents($this->tempdir . $key, $data) !== false) {
-                self::$cache[$key] = $data;
+            return true;
+        }
 
-                return true;
-            }
+        $fileData = '<?php return ' . var_export($data, true) . ';';
+        if (file_put_contents($this->tempdir . $key . '.' . self::$ext, $fileData) !== false) {
+            self::$cache[$key] = $data;
+
+            return true;
         }
 
         return false;
@@ -99,20 +100,18 @@ public function touch($key, $ttl = 3600)
     public function get($key, $default = null)
     {
         $key = $this->key($key);
-        $file = $this->tempdir . $key;
+        $file = $this->tempdir . $key . '.' . self::$ext;
 
         $data = false;
         if (isset(self::$cache[$key])) {
             $data = self::$cache[$key];
         } elseif (Scanner::isCacheEnabled() && is_file($file)) {
-            $data = file_get_contents($file);
+            $data = include $file;
             self::$cache[$key] = $data;
         }
 
         if ($data !== false) {
             if (!empty($data)) {
-                $data = json_decode($data, true);
-
                 if (isset($data['ttl'], $data['data'])) {
                     if ($data['ttl'] <= 0 || $data['ttl'] >= time()) {
                         return $data['data'];
@@ -175,16 +174,46 @@ public function deleteRegex($pattern = '*')
     /**
      * Generate key.
      *
+     * @see https://stackoverflow.com/a/42058764
+     *
      * @param string $key
      *
      * @return string
      */
     protected function key($key)
     {
-        $filename = $key . '.' . self::$ext;
-        $specialChars = ['?', '[', ']', '/', '\\', '=', '<', '>', ':', ';', ',', "'", '"', '&', '$', '#', '*', '(', ')', '|', '~', '`', '!', '{', '}'];
-        $filename = str_replace($specialChars, '', $filename);
-        $filename = preg_replace('/[\s-]+/', '-', $filename);
+        $filename = preg_replace(
+            '~' .
+                    '[<>:"/\\|?*]|' .            // file system reserved https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words
+                    '[\x00-\x1F]|' .             // control characters http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247%28v=vs.85%29.aspx
+                    '[\x7F\xA0\xAD]|' .          // non-printing characters DEL, NO-BREAK SPACE, SOFT HYPHEN
+                    '[#\[\]@!$&\'()+,;=]|' .     // URI reserved https://tools.ietf.org/html/rfc3986#section-2.2
+                    '[{}^\~`]' .                 // URL unsafe characters https://www.ietf.org/rfc/rfc1738.txt
+                    '~x',
+            '-',
+            $key
+        );
+        // avoids ".", ".." or ".hiddenFiles"
+        $filename = ltrim($filename, '.-');
+        // maximize filename length to 255 bytes http://serverfault.com/a/9548/44086
+
+        // reduce consecutive characters
+        $filename = preg_replace([
+            '/ +/', // "file   name.zip" becomes "file-name.zip"
+            '/_+/', // "file___name.zip" becomes "file-name.zip"
+            '/-+/', // "file---name.zip" becomes "file-name.zip"
+        ], '-', $filename);
+        $filename = preg_replace([
+            '/-*\.-*/',  // "file--.--.-.--name.zip" becomes "file.name.zip"
+            '/\.{2,}/',  // "file...name..zip" becomes "file.name.zip"
+        ], '.', $filename);
+        // lowercase for windows/unix interoperability http://support.microsoft.com/kb/100625
+        $filename = mb_strtolower($filename, mb_detect_encoding($filename));
+        // ".file-name.-" becomes "file-name"
+        $filename = trim($filename, '.-');
+
+        $ext = pathinfo($filename, PATHINFO_EXTENSION);
+        $filename = mb_strcut(pathinfo($filename, PATHINFO_FILENAME), 0, 255 - ($ext ? strlen($ext) + 1 : 0), mb_detect_encoding($filename)) . ($ext ? '.' . $ext : '');
 
         return trim($filename, '.-_');
     }