| 1 |  |  | <?php namespace Comodojo\Cache\Drivers; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 2 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 3 |  |  | use \Exception; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 4 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 5 |  |  | /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 6 |  |  |  * Apcu provider | 
            
                                                                                                            
                            
            
                                    
            
            
                | 7 |  |  |  * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 8 |  |  |  * @package     Comodojo Spare Parts | 
            
                                                                                                            
                            
            
                                    
            
            
                | 9 |  |  |  * @author      Marco Giovinazzi <[email protected]> | 
            
                                                                                                            
                            
            
                                    
            
            
                | 10 |  |  |  * @license     MIT | 
            
                                                                                                            
                            
            
                                    
            
            
                | 11 |  |  |  * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 12 |  |  |  * LICENSE: | 
            
                                                                                                            
                            
            
                                    
            
            
                | 13 |  |  |  * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 14 |  |  |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | 
            
                                                                                                            
                            
            
                                    
            
            
                | 15 |  |  |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | 
            
                                                                                                            
                            
            
                                    
            
            
                | 16 |  |  |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | 
            
                                                                                                            
                            
            
                                    
            
            
                | 17 |  |  |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | 
            
                                                                                                            
                            
            
                                    
            
            
                | 18 |  |  |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | 
            
                                                                                                            
                            
            
                                    
            
            
                | 19 |  |  |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | 
            
                                                                                                            
                            
            
                                    
            
            
                | 20 |  |  |  * THE SOFTWARE. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 21 |  |  |  */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 22 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 23 |  |  | class FilesystemGhost extends FilesystemXattr { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 24 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 25 |  |  |     const DRIVER_NAME = "filesystem-ghost"; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 26 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 27 |  |  |     // protected $cache_folder; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 28 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 29 |  |  |     // public function __construct(array $configuration) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 30 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 31 |  |  |     //     $this->cache_folder = $configuration['cache-folder']; | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 32 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 33 |  |  |     //     if ( $this->test() === false ) throw new Exception("Folder ".$this->cache_folder." not writable"); | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 34 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 35 |  |  |     // } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 36 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 37 |  |  |     // public function test() { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 38 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 39 |  |  |     //     return file_exists($this->cache_folder) && is_writable($this->cache_folder); | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 40 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 41 |  |  |     // } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 42 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 43 |  |  |     // public function get($key, $namespace) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 44 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 45 |  |  |     //     if ( $this->has($key, $namespace) ) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 46 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 47 |  |  |     //         $cacheFile = $this->cache_folder."$key-$namespace.cache"; | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 48 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 49 |  |  |     //         $data = @file_get_contents($cacheFile); | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 50 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 51 |  |  |     //         if ( $data === false ) throw new Exception("Error reading cache content $cacheFile"); | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 52 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 53 |  |  |     //         return $data; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 54 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 55 |  |  |     //     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 56 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 57 |  |  |     //     return null; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 58 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 59 |  |  |     // } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 60 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 61 | 28 |  |     public function set($key, $namespace, $value, $ttl = null) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 62 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 63 | 28 |  |         $cacheFile = $this->cache_folder."$key-$namespace.cache"; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 64 | 28 |  |         $cacheGhost = $this->cache_folder."$key-$namespace.expire"; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 65 |  |  |  | 
            
                                                                                                            
                            
            
                                                                    
                                                                                                        
            
            
                | 66 | 28 | View Code Duplication |         if ( $ttl == null || $ttl == 0 ) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 67 | 25 |  |             $ttl = 0; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 68 | 25 |  |         } else { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 69 | 4 |  |             $ttl = time() + intval($ttl); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 70 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 71 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 72 | 28 |  |         $cached = @file_put_contents($cacheFile, $value, LOCK_EX); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 73 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 74 | 28 |  |         if ( $cached === false ) throw new Exception("Error writing cache object $cacheFile"); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 75 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 76 | 28 |  |         $tagged = @file_put_contents($cacheGhost, $ttl, LOCK_EX); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 77 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 78 | 28 |  |         if ( $tagged === false ) throw new Exception("Error writing cache ttl $cacheFile"); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 79 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 80 | 28 |  |         return true; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 81 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 82 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 83 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 84 | 7 |  |     public function delete($key, $namespace) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 85 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 86 | 7 |  |         $result = []; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 87 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 88 | 7 |  |         $file_list = glob($this->cache_folder."$key-$namespace.{cache,expire}", GLOB_BRACE); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 89 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 90 | 7 |  |         if ( empty($file_list) ) return false; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 91 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 92 | 7 |  |         foreach ( $file_list as $file ) $result[] = unlink($file); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 93 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 94 | 7 |  |         return !in_array(false, $result); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 95 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 96 |  |  |     } | 
            
                                                                                                            
                                                                
            
                                    
            
            
                | 97 |  |  |  | 
            
                                                                        
                            
            
                                                                    
                                                                                                        
            
            
                | 98 | 11 | View Code Duplication |     public function clear($namespace = null) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                        
                            
            
                                    
            
            
                | 99 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 100 | 11 |  |         $result = []; | 
            
                                                                        
                            
            
                                    
            
            
                | 101 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 102 | 11 |  |         if ( $namespace === null ) { | 
            
                                                                        
                            
            
                                    
            
            
                | 103 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 104 | 9 |  |             $file_list = glob($this->cache_folder."*.{cache,expire}", GLOB_BRACE); | 
            
                                                                        
                            
            
                                    
            
            
                | 105 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 106 | 9 |  |         } else { | 
            
                                                                        
                            
            
                                    
            
            
                | 107 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 108 | 2 |  |             $file_list = glob($this->cache_folder."*-$namespace.{cache,expire}", GLOB_BRACE); | 
            
                                                                        
                            
            
                                    
            
            
                | 109 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 110 |  |  |         } | 
            
                                                                        
                            
            
                                    
            
            
                | 111 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 112 | 11 |  |         if ( empty($file_list) ) return true; | 
            
                                                                        
                            
            
                                    
            
            
                | 113 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 114 | 5 |  |         foreach ( $file_list as $file ) $result[] = unlink($file); | 
            
                                                                        
                            
            
                                    
            
            
                | 115 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 116 | 5 |  |         return !in_array(false, $result); | 
            
                                                                        
                            
            
                                    
            
            
                | 117 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 118 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 119 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 120 |  |  |     // public function getMultiple(array $keys, $namespace) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 121 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 122 |  |  |     //     $result = []; | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 123 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 124 |  |  |     //     foreach ($keys as $key) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 125 |  |  |     //         $result[$key] = $this->get($key, $namespace); | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 126 |  |  |     //     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 127 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 128 |  |  |     //     return $result; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 129 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 130 |  |  |     // } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 131 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 132 |  |  |     // public function setMultiple(array $key_values, $namespace, $ttl = null) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 133 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 134 |  |  |     //     $result = []; | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 135 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 136 |  |  |     //     foreach ($keys as $key => $value) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 137 |  |  |     //         $result[] = $this->set($key, $namespace, $value, $ttl); | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 138 |  |  |     //     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 139 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 140 |  |  |     //     return !in_array(false, $result); | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 141 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 142 |  |  |     // } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 143 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 144 |  |  |     // public function deleteMultiple(array $keys, $namespace) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 145 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 146 |  |  |     //     $result = []; | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 147 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 148 |  |  |     //     foreach ($keys as $key) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 149 |  |  |     //         $result[] = $this->delete($key, $namespace); | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 150 |  |  |     //     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 151 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 152 |  |  |     //     return !in_array(false, $result); | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 153 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 154 |  |  |     // } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 155 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 156 | 36 |  |     public function has($key, $namespace) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 157 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 158 | 36 |  |         $time = time(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 159 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 160 | 36 |  |         $cacheFile = $this->cache_folder."$key-$namespace.cache"; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 161 | 36 |  |         $cacheGhost = $this->cache_folder."$key-$namespace.expire"; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 162 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 163 | 36 |  |         if ( file_exists($cacheFile) && file_exists($cacheGhost) ) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 164 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 165 | 21 |  |             $expire = @file_get_contents($cacheGhost); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 166 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 167 | 21 |  |             if ( $expire === false ) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 168 |  |  |                 throw new Exception("Error reading cache ttl for $cacheFile"); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 169 | 21 |  |             } else if ( intval($expire) < $time && intval($expire) !== 0 ) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 170 | 1 |  |                 $this->delete($key, $namespace); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 171 | 1 |  |                 return false; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 172 |  |  |             } else { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 173 | 20 |  |                 return true; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 174 |  |  |             } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 175 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 176 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 177 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 178 | 23 |  |         return false; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 179 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 180 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 181 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 182 |  |  |     // public function stats() { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 183 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 184 |  |  |     //     return ['objects' => count(glob($this->cache_folder."*.cache"))]; | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 185 |  |  |     // | 
            
                                                                                                            
                            
            
                                    
            
            
                | 186 |  |  |     // } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 187 |  |  |  | 
            
                                                                                                            
                                                                
            
                                    
            
            
                | 188 |  |  | } | 
            
                                                        
            
                                    
            
            
                | 189 |  |  |  | 
            
                        
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.