Members/shoshi/webvirt: cake/libs/cache/file.php annotate

annotate cake/libs/cache/file.php @ 4:c3adb28473d6 default tip

modified icon feature

author	Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp>
date	Tue, 16 Aug 2011 18:31:36 +0900
parents	261e66bd5a0c
children

rev	line source
0 261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	1 <?php
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	2 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	3 * File Storage engine for cache
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	4 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	5 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	6 * PHP versions 4 and 5
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	7 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	8 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	9 * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	10 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	11 * Licensed under The MIT License
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	12 * Redistributions of files must retain the above copyright notice.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	13 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	14 * @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	15 * @link http://cakephp.org CakePHP(tm) Project
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	16 * @package cake
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	17 * @subpackage cake.cake.libs.cache
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	18 * @since CakePHP(tm) v 1.2.0.4933
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	19 * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	20 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	21
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	22 if (!class_exists('File')) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	23 require LIBS . 'file.php';
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	24 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	25 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	26 * File Storage engine for cache
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	27 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	28 * @todo use the File and Folder classes (if it's not a too big performance hit)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	29 * @package cake
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	30 * @subpackage cake.cake.libs.cache
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	31 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	32 class FileEngine extends CacheEngine {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	33
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	34 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	35 * Instance of File class
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	36 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	37 * @var File
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	38 * @access protected
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	39 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	40 var $_File = null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	41
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	42 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	43 * Settings
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	44 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	45 * - path = absolute path to cache directory, default => CACHE
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	46 * - prefix = string prefix for filename, default => cake_
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	47 * - lock = enable file locking on write, default => false
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	48 * - serialize = serialize the data, default => true
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	49 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	50 * @var array
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	51 * @see CacheEngine::__defaults
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	52 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	53 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	54 var $settings = array();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	55
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	56 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	57 * True unless FileEngine::__active(); fails
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	58 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	59 * @var boolean
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	60 * @access protected
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	61 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	62 var $_init = true;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	63
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	64 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	65 * Initialize the Cache Engine
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	66 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	67 * Called automatically by the cache frontend
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	68 * To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	69 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	70 * @param array $setting array of setting for the engine
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	71 * @return boolean True if the engine has been successfully initialized, false if not
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	72 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	73 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	74 function init($settings = array()) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	75 parent::init(array_merge(
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	76 array(
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	77 'engine' => 'File', 'path' => CACHE, 'prefix'=> 'cake_', 'lock'=> false,
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	78 'serialize'=> true, 'isWindows' => false
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	79 ),
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	80 $settings
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	81 ));
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	82 if (!isset($this->_File)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	83 $this->_File =& new File($this->settings['path'] . DS . 'cake');
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	84 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	85
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	86 if (DIRECTORY_SEPARATOR === '\\') {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	87 $this->settings['isWindows'] = true;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	88 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	89
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	90 $path = $this->_File->Folder->cd($this->settings['path']);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	91 if ($path) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	92 $this->settings['path'] = $path;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	93 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	94 return $this->__active();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	95 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	96
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	97 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	98 * Garbage collection. Permanently remove all expired and deleted data
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	99 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	100 * @return boolean True if garbage collection was succesful, false on failure
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	101 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	102 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	103 function gc() {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	104 return $this->clear(true);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	105 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	106
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	107 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	108 * Write data for key into cache
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	109 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	110 * @param string $key Identifier for the data
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	111 * @param mixed $data Data to be cached
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	112 * @param mixed $duration How long to cache the data, in seconds
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	113 * @return boolean True if the data was succesfully cached, false on failure
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	114 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	115 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	116 function write($key, &$data, $duration) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	117 if ($data === '' \|\| !$this->_init) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	118 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	119 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	120
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	121 if ($this->_setKey($key) === false) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	122 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	123 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	124
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	125 $lineBreak = "\n";
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	126
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	127 if ($this->settings['isWindows']) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	128 $lineBreak = "\r\n";
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	129 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	130
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	131 if (!empty($this->settings['serialize'])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	132 if ($this->settings['isWindows']) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	133 $data = str_replace('\\', '\\\\\\\\', serialize($data));
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	134 } else {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	135 $data = serialize($data);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	136 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	137 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	138
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	139 if ($this->settings['lock']) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	140 $this->_File->lock = true;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	141 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	142 $expires = time() + $duration;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	143 $contents = $expires . $lineBreak . $data . $lineBreak;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	144 $success = $this->_File->write($contents);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	145 $this->_File->close();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	146 return $success;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	147 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	148
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	149 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	150 * Read a key from the cache
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	151 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	152 * @param string $key Identifier for the data
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	153 * @return mixed The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	154 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	155 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	156 function read($key) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	157 if ($this->_setKey($key) === false \|\| !$this->_init \|\| !$this->_File->exists()) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	158 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	159 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	160 if ($this->settings['lock']) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	161 $this->_File->lock = true;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	162 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	163 $time = time();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	164 $cachetime = intval($this->_File->read(11));
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	165
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	166 if ($cachetime !== false && ($cachetime < $time \|\| ($time + $this->settings['duration']) < $cachetime)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	167 $this->_File->close();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	168 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	169 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	170 $data = $this->_File->read(true);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	171
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	172 if ($data !== '' && !empty($this->settings['serialize'])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	173 if ($this->settings['isWindows']) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	174 $data = str_replace('\\\\\\\\', '\\', $data);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	175 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	176 $data = unserialize((string)$data);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	177 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	178 $this->_File->close();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	179 return $data;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	180 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	181
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	182 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	183 * Delete a key from the cache
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	184 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	185 * @param string $key Identifier for the data
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	186 * @return boolean True if the value was successfully deleted, false if it didn't exist or couldn't be removed
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	187 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	188 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	189 function delete($key) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	190 if ($this->_setKey($key) === false \|\| !$this->_init) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	191 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	192 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	193 return $this->_File->delete();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	194 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	195
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	196 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	197 * Delete all values from the cache
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	198 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	199 * @param boolean $check Optional - only delete expired cache items
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	200 * @return boolean True if the cache was succesfully cleared, false otherwise
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	201 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	202 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	203 function clear($check) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	204 if (!$this->_init) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	205 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	206 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	207 $dir = dir($this->settings['path']);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	208 if ($check) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	209 $now = time();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	210 $threshold = $now - $this->settings['duration'];
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	211 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	212 $prefixLength = strlen($this->settings['prefix']);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	213 while (($entry = $dir->read()) !== false) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	214 if (substr($entry, 0, $prefixLength) !== $this->settings['prefix']) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	215 continue;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	216 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	217 if ($this->_setKey($entry) === false) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	218 continue;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	219 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	220 if ($check) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	221 $mtime = $this->_File->lastChange();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	222
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	223 if ($mtime === false \|\| $mtime > $threshold) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	224 continue;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	225 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	226
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	227 $expires = $this->_File->read(11);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	228 $this->_File->close();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	229
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	230 if ($expires > $now) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	231 continue;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	232 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	233 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	234 $this->_File->delete();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	235 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	236 $dir->close();
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	237 return true;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	238 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	239
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	240 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	241 * Get absolute file for a given key
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	242 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	243 * @param string $key The key
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	244 * @return mixed Absolute cache file for the given key or false if erroneous
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	245 * @access private
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	246 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	247 function _setKey($key) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	248 $this->_File->Folder->cd($this->settings['path']);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	249 if ($key !== $this->_File->name) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	250 $this->_File->name = $key;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	251 $this->_File->path = null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	252 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	253 if (!$this->_File->Folder->inPath($this->_File->pwd(), true)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	254 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	255 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	256 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	257
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	258 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	259 * Determine is cache directory is writable
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	260 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	261 * @return boolean
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	262 * @access private
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	263 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	264 function __active() {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	265 if ($this->_init && !is_writable($this->settings['path'])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	266 $this->_init = false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	267 trigger_error(sprintf(__('%s is not writable', true), $this->settings['path']), E_USER_WARNING);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	268 return false;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	269 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	270 return true;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	271 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	272 }

Mercurial > hg > Members > shoshi > webvirt

annotate cake/libs/cache/file.php @ 4:c3adb28473d6 default tip