/usr/share/php/PHP/Depend/Util/Cache/Driver/File.php is in pdepend 1.1.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | <?php
/**
* This file is part of PHP_Depend.
*
* PHP Version 5
*
* Copyright (c) 2008-2012, Manuel Pichler <mapi@pdepend.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Manuel Pichler nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @category QualityAssurance
* @package PHP_Depend
* @subpackage Util_Cache_Driver
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version SVN: $Id$
* @link http://pdepend.org/
* @since 0.10.0
*/
/**
* A file system based cache implementation.
*
* This class implements the {@link PHP_Depend_Util_Cache_Driver} interface based
* on the local file system. It creates a special directory structure and stores
* all cache entries in files under this directory structure.
*
* @category QualityAssurance
* @package PHP_Depend
* @subpackage Util_Cache_Driver
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.1.4
* @link http://pdepend.org/
* @since 0.10.0
*/
class PHP_Depend_Util_Cache_Driver_File implements PHP_Depend_Util_Cache_Driver
{
/**
* The type of this class.
*/
const CLAZZ = __CLASS__;
/**
* Default cache entry type.
*/
const ENTRY_TYPE = 'cache';
/**
* The cache directory handler
*
* @var PHP_Depend_Util_Cache_Driver_File_Directory
*/
protected $directory;
/**
* The current cache entry type.
*
* @var string
*/
protected $type = self::ENTRY_TYPE;
/**
* Major and minor version of the currently used PHP.
*
* @var string
*/
protected $version;
/**
* Unique key for this cache instance.
*
* @var string
* @since 1.0.0
*/
private $cacheKey;
/**
* This method constructs a new file cache instance for the given root
* directory.
*
* @param string $root The cache root directory.
* @param string $cacheKey Unique key for this cache instance.
*/
public function __construct($root, $cacheKey = null)
{
$this->directory = new PHP_Depend_Util_Cache_Driver_File_Directory($root);
$this->version = preg_replace('(^(\d+\.\d+).*)', '\\1', phpversion());
$this->cacheKey = $cacheKey;
}
/**
* Sets the type for the next <em>store()</em> or <em>restore()</em> method
* call. A type is something like a namespace or group for cache entries.
*
* Note that the cache type will be reset after each storage method call, so
* you must invoke right before every call to <em>restore()</em> or
* <em>store()</em>.
*
* @param string $type The name or object type for the next storage method call.
*
* @return PHP_Depend_Util_Cache_Driver
*/
public function type($type)
{
$this->type = $type;
return $this;
}
/**
* This method will store the given <em>$data</em> under <em>$key</em>. This
* method can be called with a third parameter that will be used as a
* verification token, when the a cache entry gets restored. If the stored
* hash and the supplied hash are not identical, that cache entry will be
* removed and not returned.
*
* @param string $key The cache key for the given data.
* @param mixed $data Any data that should be cached.
* @param string $hash Optional hash that will be used for verification.
*
* @return void
*/
public function store($key, $data, $hash = null)
{
$file = $this->getCacheFile($key);
$this->write($file, serialize(array('hash' => $hash, 'data' => $data)));
}
/**
* This method writes the given <em>$data</em> into <em>$file</em>.
*
* @param string $file The cache file name.
* @param string $data Serialized cache data.
*
* @return void
*/
protected function write($file, $data)
{
$handle = fopen($file, 'wb');
flock($handle, LOCK_EX);
fwrite($handle, $data);
flock($handle, LOCK_UN);
fclose($handle);
}
/**
* This method tries to restore an existing cache entry for the given
* <em>$key</em>. If a matching entry exists, this method verifies that the
* given <em>$hash</em> and the the value stored with cache entry are equal.
* Then it returns the cached entry. Otherwise this method will return
* <b>NULL</b>.
*
* @param string $key The cache key for the given data.
* @param string $hash Optional hash that will be used for verification.
*
* @return mixed
*/
public function restore($key, $hash = null)
{
$file = $this->getCacheFile($key);
if (file_exists($file)) {
return $this->restoreFile($file, $hash);
}
return null;
}
/**
* This method restores a cache entry, when the given <em>$hash</em> is equal
* to stored hash value. If both hashes are equal this method returns the
* cached entry. Otherwise this method returns <b>NULL</b>.
*
* @param string $file The cache file name.
* @param string $hash The verification hash.
*
* @return mixed
*/
protected function restoreFile($file, $hash)
{
$data = unserialize($this->read($file));
if ($data['hash'] === $hash) {
return $data['data'];
}
return null;
}
/**
* This method reads the raw data from the given <em>$file</em>.
*
* @param string $file The cache file name.
*
* @return string
*/
protected function read($file)
{
$handle = fopen($file, 'rb');
flock($handle, LOCK_EX);
$data = fread($handle, filesize($file));
flock($handle, LOCK_UN);
fclose($handle);
return $data;
}
/**
* This method will remove an existing cache entry for the given identifier.
* It will delete all cache entries where the cache key start with the given
* <b>$pattern</b>. If no matching entry exists, this method simply does
* nothing.
*
* @param string $pattern The cache key pattern.
*
* @return void
*/
public function remove($pattern)
{
$file = $this->getCacheFileWithoutExtension($pattern);
foreach (glob("{$file}*.*") as $f) {
unlink($f);
}
}
/**
* This method creates the full qualified file name for a cache entry. This
* file name is a combination of the given <em>$key</em>, the cache root
* directory and the current entry type.
*
* @param string $key The cache key for the given data.
*
* @return string
*/
protected function getCacheFile($key)
{
$cacheFile = $this->getCacheFileWithoutExtension($key) .
'.' . $this->version .
'.' . $this->type;
$this->type = self::ENTRY_TYPE;
return $cacheFile;
}
/**
* This method creates the full qualified file name for a cache entry. This
* file name is a combination of the given <em>$key</em>, the cache root
* directory and the current entry type, but without the used cache file
* extension.
*
* @param string $key The cache key for the given data.
*
* @return string
*/
protected function getCacheFileWithoutExtension($key)
{
if (is_string($this->cacheKey)) {
$key = md5($key . $this->cacheKey);
}
$path = $this->directory->createCacheDirectory($key);
return "{$path}/{$key}";
}
}
|