/usr/share/php/Cache/Container/file.php is in php-cache 1.5.6-2ubuntu1.
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 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 | <?php
// +----------------------------------------------------------------------+
// | PEAR :: Cache |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2003 The PHP Group |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.0 of the PHP license, |
// | that is bundled with this package in the file LICENSE, and is |
// | available at through the world-wide-web at |
// | http://www.php.net/license/2_02.txt. |
// | If you did not receive a copy of the PHP license and are unable to |
// | obtain it through the world-wide-web, please send a note to |
// | license@php.net so we can mail you a copy immediately. |
// +----------------------------------------------------------------------+
// | Authors: Ulf Wendel <ulf.wendel@phpdoc.de> |
// | Sebastian Bergmann <sb@sebastian-bergmann.de> |
// +----------------------------------------------------------------------+
//
// $Id: file.php 293864 2010-01-23 03:49:21Z clockwerx $
require_once 'Cache/Container.php';
/**
* Stores cache contents in a file.
*
* @author Ulf Wendel <ulf.wendel@phpdoc.de>
* @version $Id: file.php 293864 2010-01-23 03:49:21Z clockwerx $
*/
class Cache_Container_file extends Cache_Container
{
/**
* File locking
*
* With file container, it's possible, that you get corrupted
* data-entries under bad circumstances. The file locking must
* improve this problem but it's experimental stuff. So the
* default value is false. But it seems to give good results
*
* @var boolean
*/
var $fileLocking = false;
/**
* Directory where to put the cache files.
*
* @var string Make sure to add a trailing slash
*/
var $cache_dir = '';
/**
* Filename prefix for cache files.
*
* You can use the filename prefix to implement a "domain" based cache or just
* to give the files a more descriptive name. The word "domain" is borroed from
* a user authentification system. One user id (cached dataset with the ID x)
* may exists in different domains (different filename prefix). You might want
* to use this to have different cache values for a production, development and
* quality assurance system. If you want the production cache not to be influenced
* by the quality assurance activities, use different filename prefixes for them.
*
* I personally don't think that you'll never need this, but 640kb happend to be
* not enough, so... you know what I mean. If you find a useful application of the
* feature please update this inline doc.
*
* @var string
*/
var $filename_prefix = '';
/**
* List of cache entries, used within a gc run
*
* @var array
*/
var $entries;
/**
* Total number of bytes required by all cache entries, used within a gc run.
*
* @var int
*/
var $total_size = 0;
/**
* Max Line Length of userdata
*
* If set to 0, it will take the default
* ( 1024 in php 4.2, unlimited in php 4.3)
* see http://ch.php.net/manual/en/function.fgets.php
* for details
*
* @var int
*/
var $max_userdata_linelength = 257;
/**
* Creates the cache directory if neccessary
*
* @param array Config options: ["cache_dir" => ..., "filename_prefix" => ...]
*/
function Cache_Container_file($options = '')
{
if (is_array($options)) {
$this->setOptions($options, array_merge($this->allowed_options, array('cache_dir', 'filename_prefix', 'max_userdata_linelength')));
}
clearstatcache();
if ($this->cache_dir) {
// make relative paths absolute for use in deconstructor.
// it looks like the deconstructor has problems with relative paths
if (OS_UNIX && '/' != $this->cache_dir{0} )
$this->cache_dir = realpath( getcwd() . '/' . $this->cache_dir) . '/';
// check if a trailing slash is in cache_dir
if ($this->cache_dir{strlen($this->cache_dir)-1} != DIRECTORY_SEPARATOR)
$this->cache_dir .= '/';
if (!file_exists($this->cache_dir) || !is_dir($this->cache_dir))
mkdir($this->cache_dir, 0755);
}
$this->entries = array();
$this->group_dirs = array();
} // end func contructor
function fetch($id, $group)
{
$file = $this->getFilename($id, $group);
if (PEAR::isError($file)) {
return $file;
}
if (!file_exists($file)) {
return array(null, null, null);
}
// retrive the content
if (!($fh = @fopen($file, 'rb'))) {
return new Cache_Error("Can't access cache file '$file'. Check access rights and path.", __FILE__, __LINE__);
}
// File locking (shared lock)
if ($this->fileLocking) {
flock($fh, LOCK_SH);
}
// file format:
// 1st line: expiration date
// 2nd line: user data
// 3rd+ lines: cache data
$expire = trim(fgets($fh, 12));
if ($this->max_userdata_linelength == 0 ) {
$userdata = trim(fgets($fh));
} else {
$userdata = trim(fgets($fh, $this->max_userdata_linelength));
}
$buffer = '';
while (!feof($fh)) {
$buffer .= fread($fh, 8192);
}
$cachedata = $this->decode($buffer);
// Unlocking
if ($this->fileLocking) {
flock($fh, LOCK_UN);
}
fclose($fh);
// last usage date used by the gc - maxlifetime
// touch without second param produced stupid entries...
touch($file,time());
clearstatcache();
return array($expire, $cachedata, $userdata);
} // end func fetch
/**
* Stores a dataset.
*
* WARNING: If you supply userdata it must not contain any linebreaks,
* otherwise it will break the filestructure.
*/
function save($id, $cachedata, $expires, $group, $userdata)
{
$this->flushPreload($id, $group);
$file = $this->getFilename($id, $group);
if (!($fh = @fopen($file, 'wb'))) {
return new Cache_Error("Can't access '$file' to store cache data. Check access rights and path.", __FILE__, __LINE__);
}
// File locking (exclusive lock)
if ($this->fileLocking) {
flock($fh, LOCK_EX);
}
// file format:
// 1st line: expiration date
// 2nd line: user data
// 3rd+ lines: cache data
$expires = $this->getExpiresAbsolute($expires);
fwrite($fh, $expires . "\n");
fwrite($fh, $userdata . "\n");
fwrite($fh, $this->encode($cachedata));
// File unlocking
if ($this->fileLocking) {
flock($fh, LOCK_UN);
}
fclose($fh);
// I'm not sure if we need this
// i don't think we need this (chregu)
// touch($file);
return true;
} // end func save
function remove($id, $group)
{
$this->flushPreload($id, $group);
$file = $this->getFilename($id, $group);
if (PEAR::isError($file)) {
return $file;
}
if (file_exists($file)) {
$ok = unlink($file);
clearstatcache();
return $ok;
}
return false;
} // end func remove
function flush($group)
{
$this->flushPreload();
$dir = ($group) ? $this->cache_dir . $group . '/' : $this->cache_dir;
$num_removed = $this->deleteDir($dir);
unset($this->group_dirs[$group]);
clearstatcache();
return $num_removed;
} // end func flush
function idExists($id, $group)
{
return file_exists($this->getFilename($id, $group));
} // end func idExists
/**
* Deletes all expired files.
*
* Garbage collection for files is a rather "expensive", "long time"
* operation. All files in the cache directory have to be examined which
* means that they must be opened for reading, the expiration date has to be
* read from them and if neccessary they have to be unlinked (removed).
* If you have a user comment for a good default gc probability please add it to
* to the inline docs.
*
* @param integer Maximum lifetime in seconds of an no longer used/touched entry
* @throws Cache_Error
*/
function garbageCollection($maxlifetime)
{
$this->flushPreload();
clearstatcache();
$ok = $this->doGarbageCollection($maxlifetime, $this->cache_dir);
// check the space used by the cache entries
if ($this->total_size > $this->highwater) {
krsort($this->entries);
reset($this->entries);
while ($this->total_size > $this->lowwater && list($lastmod, $entry) = each($this->entries)) {
if (@unlink($entry['file'])) {
$this->total_size -= $entry['size'];
} else {
new CacheError("Can't delete {$entry['file']}. Check the permissions.");
}
}
}
$this->entries = array();
$this->total_size = 0;
return $ok;
} // end func garbageCollection
/**
* Does the recursive gc procedure, protected.
*
* @param integer Maximum lifetime in seconds of an no longer used/touched entry
* @param string directory to examine - don't sets this parameter, it's used for a
* recursive function call!
* @throws Cache_Error
*/
function doGarbageCollection($maxlifetime, $dir)
{
if (!is_writable($dir) || !is_readable($dir) || !($dh = opendir($dir))) {
return new Cache_Error("Can't remove directory '$dir'. Check permissions and path.", __FILE__, __LINE__);
}
while ($file = readdir($dh)) {
if ('.' == $file || '..' == $file)
continue;
$file = $dir . $file;
if (is_dir($file)) {
$this->doGarbageCollection($maxlifetime,$file . '/');
continue;
}
// skip trouble makers but inform the user
if (!($fh = @fopen($file, 'rb'))) {
new Cache_Error("Can't access cache file '$file', skipping it. Check permissions and path.", __FILE__, __LINE__);
continue;
}
$expire = fgets($fh, 11);
fclose($fh);
$lastused = filemtime($file);
$this->entries[$lastused] = array('file' => $file, 'size' => filesize($file));
$this->total_size += filesize($file);
// remove if expired
if (( ($expire && $expire <= time()) || ($lastused <= (time() - $maxlifetime)) ) && !unlink($file)) {
new Cache_Error("Can't unlink cache file '$file', skipping. Check permissions and path.", __FILE__, __LINE__);
}
}
closedir($dh);
// flush the disk state cache
clearstatcache();
} // end func doGarbageCollection
/**
* Returns the filename for the specified id.
*
* @param string dataset ID
* @param string cache group
* @return string full filename with the path
* @access public
*/
function getFilename($id, $group)
{
if (isset($this->group_dirs[$group])) {
return $this->group_dirs[$group] . $this->filename_prefix . $id;
}
$dir = $this->cache_dir . $group . '/';
if (is_writeable($this->cache_dir)) {
if (!file_exists($dir)) {
mkdir($dir, 0755, true);
clearstatcache();
}
} else {
return new Cache_Error("Can't make directory '$dir'. Check permissions and path.", __FILE__, __LINE__);
}
$this->group_dirs[$group] = $dir;
return $dir . $this->filename_prefix . $id;
} // end func getFilename
/**
* Deletes a directory and all files in it.
*
* @param string directory
* @return integer number of removed files
* @throws Cache_Error
*/
function deleteDir($dir)
{
if (!is_writable($dir) || !is_readable($dir) || !($dh = opendir($dir))) {
return new Cache_Error("Can't remove directory '$dir'. Check permissions and path.", __FILE__, __LINE__);
}
$num_removed = 0;
while (false !== $file = readdir($dh)) {
if ('.' == $file || '..' == $file)
continue;
$file = $dir . $file;
if (is_dir($file)) {
$file .= '/';
$num = $this->deleteDir($file . '/');
if (is_int($num))
$num_removed += $num;
} else {
if (unlink($file))
$num_removed++;
}
}
// according to php-manual the following is needed for windows installations.
closedir($dh);
unset( $dh);
if ($dir != $this->cache_dir) { //delete the sub-dir entries itself also, but not the cache-dir.
rmDir($dir);
$num_removed++;
}
return $num_removed;
} // end func deleteDir
} // end class file
?>
|