FileCache.php 6.67 KB
Newer Older
Qiang Xue committed
1 2
<?php
/**
3
 * FileCache class file
Qiang Xue committed
4 5
 *
 * @link http://www.yiiframework.com/
Qiang Xue committed
6
 * @copyright Copyright &copy; 2008 Yii Software LLC
Qiang Xue committed
7 8 9
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
10 11
namespace yii\caching;

12
use yii\base\InvalidConfigException;
13

Qiang Xue committed
14
/**
15
 * FileCache implements a cache component using files.
Qiang Xue committed
16
 *
17 18 19
 * For each data value being cached, FileCache will store it in a separate file.
 * The cache files are placed under [[cachePath]]. FileCache will perform garbage collection
 * automatically to remove expired cache files.
Qiang Xue committed
20
 *
21
 * Please refer to [[Cache]] for common cache operations that are supported by FileCache.
Qiang Xue committed
22 23
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
24
 * @since 2.0
Qiang Xue committed
25
 */
26
class FileCache extends Cache
Qiang Xue committed
27 28
{
	/**
29
	 * @var string the directory to store cache files. You may use path alias here.
Qiang Xue committed
30
	 */
31
	public $cachePath = '@application/runtime/cache';
Qiang Xue committed
32 33 34
	/**
	 * @var string cache file suffix. Defaults to '.bin'.
	 */
35
	public $cacheFileSuffix = '.bin';
Qiang Xue committed
36
	/**
37 38 39 40
	 * @var integer the level of sub-directories to store cache files. Defaults to 1.
	 * If the system has huge number of cache files (e.g. one million), you may use a bigger value
	 * (usually no bigger than 3). Using sub-directories is mainly to ensure the file system
	 * is not over burdened with a single directory having too many files.
Qiang Xue committed
41
	 */
42
	public $directoryLevel = 1;
Qiang Xue committed
43
	/**
44
	 * @var integer the probability (parts per million) that garbage collection (GC) should be performed
45 46
	 * when storing a piece of data in the cache. Defaults to 10, meaning 0.001% chance.
	 * This number should be between 0 and 1000000. A value 0 means no GC will be performed at all.
47
	 **/
48
	public $gcProbability = 10;
Qiang Xue committed
49 50

	/**
51
	 * Initializes this component by ensuring the existence of the cache path.
Qiang Xue committed
52
	 */
53
	public function init()
Qiang Xue committed
54
	{
55 56 57
		parent::init();
		$this->cachePath = \Yii::getAlias($this->cachePath);
		if ($this->cachePath === false) {
58
			throw new InvalidConfigException('FileCache.cachePath must be a valid path alias.');
59 60 61 62
		}
		if (!is_dir($this->cachePath)) {
			mkdir($this->cachePath, 0777, true);
		}
Qiang Xue committed
63 64 65 66 67 68 69 70 71 72
	}

	/**
	 * Retrieves a value from cache with a specified key.
	 * This is the implementation of the method declared in the parent class.
	 * @param string $key a unique key identifying the cached value
	 * @return string the value stored in cache, false if the value is not in the cache or expired.
	 */
	protected function getValue($key)
	{
73 74
		$cacheFile = $this->getCacheFile($key);
		if (($time = @filemtime($cacheFile)) > time()) {
Qiang Xue committed
75
			return @file_get_contents($cacheFile);
76 77 78
		} else {
			return false;
		}
Qiang Xue committed
79 80 81 82 83 84 85 86 87 88 89
	}

	/**
	 * Stores a value identified by a key in cache.
	 * This is the implementation of the method declared in the parent class.
	 *
	 * @param string $key the key identifying the value to be cached
	 * @param string $value the value to be cached
	 * @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
	 * @return boolean true if the value is successfully stored into cache, false otherwise
	 */
90
	protected function setValue($key, $value, $expire)
Qiang Xue committed
91
	{
92 93
		if ($expire <= 0) {
			$expire = 31536000; // 1 year
Qiang Xue committed
94
		}
95
		$expire += time();
Qiang Xue committed
96

97 98 99
		$cacheFile = $this->getCacheFile($key);
		if ($this->directoryLevel > 0) {
			@mkdir(dirname($cacheFile), 0777, true);
Qiang Xue committed
100
		}
101 102 103 104
		if (@file_put_contents($cacheFile, $value, LOCK_EX) !== false) {
			@chmod($cacheFile, 0777);
			return @touch($cacheFile, $expire);
		} else {
Qiang Xue committed
105
			return false;
106
		}
Qiang Xue committed
107 108 109 110 111 112 113 114 115 116 117
	}

	/**
	 * Stores a value identified by a key into cache if the cache does not contain this key.
	 * This is the implementation of the method declared in the parent class.
	 *
	 * @param string $key the key identifying the value to be cached
	 * @param string $value the value to be cached
	 * @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
	 * @return boolean true if the value is successfully stored into cache, false otherwise
	 */
118
	protected function addValue($key, $value, $expire)
Qiang Xue committed
119
	{
120 121
		$cacheFile = $this->getCacheFile($key);
		if (@filemtime($cacheFile) > time()) {
Qiang Xue committed
122
			return false;
123 124
		}
		return $this->setValue($key, $value, $expire);
Qiang Xue committed
125 126 127 128 129 130 131 132 133 134
	}

	/**
	 * Deletes a value with the specified key from cache
	 * This is the implementation of the method declared in the parent class.
	 * @param string $key the key of the value to be deleted
	 * @return boolean if no error happens during deletion
	 */
	protected function deleteValue($key)
	{
135
		$cacheFile = $this->getCacheFile($key);
Qiang Xue committed
136 137 138 139 140 141 142 143 144 145
		return @unlink($cacheFile);
	}

	/**
	 * Returns the cache file path given the cache key.
	 * @param string $key cache key
	 * @return string the cache file path
	 */
	protected function getCacheFile($key)
	{
146 147 148 149 150 151
		if ($this->directoryLevel > 0) {
			$base = $this->cachePath;
			for ($i = 0; $i < $this->directoryLevel; ++$i) {
				if (($prefix = substr($key, $i + $i, 2)) !== false) {
					$base .= DIRECTORY_SEPARATOR . $prefix;
				}
Qiang Xue committed
152
			}
153 154 155
			return $base . DIRECTORY_SEPARATOR . $key . $this->cacheFileSuffix;
		} else {
			return $this->cachePath . DIRECTORY_SEPARATOR . $key . $this->cacheFileSuffix;
Qiang Xue committed
156
		}
157 158 159 160 161 162 163 164 165 166 167
	}

	/**
	 * Deletes all values from cache.
	 * This is the implementation of the method declared in the parent class.
	 * @return boolean whether the flush operation was successful.
	 */
	protected function flushValues()
	{
		$this->gc(true, false);
		return true;
Qiang Xue committed
168 169 170 171
	}

	/**
	 * Removes expired cache files.
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
	 * @param boolean $force whether to enforce the garbage collection regardless of [[gcProbability]].
	 * Defaults to false, meaning the actual deletion happens with the probability as specified by [[gcProbability]].
	 * @param boolean $expiredOnly whether to removed expired cache files only.
	 * If true, all cache files under [[cachePath]] will be removed.
	 */
	public function gc($force = false, $expiredOnly = true)
	{
		if ($force || mt_rand(0, 1000000) < $this->gcProbability) {
			$this->gcRecursive($this->cachePath, $expiredOnly);
		}
	}

	/**
	 * Recursively removing expired cache files under a directory.
	 * This method is mainly used by [[gc()]].
	 * @param string $path the directory under which expired cache files are removed.
	 * @param boolean $expiredOnly whether to only remove expired cache files. If false, all files
	 * under `$path` will be removed.
Qiang Xue committed
190
	 */
191
	protected function gcRecursive($path, $expiredOnly)
Qiang Xue committed
192
	{
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
		if (($handle = opendir($path)) !== false) {
			while (($file = readdir($handle)) !== false) {
				if ($file[0] === '.') {
					continue;
				}
				$fullPath = $path . DIRECTORY_SEPARATOR . $file;
				if (is_dir($fullPath)) {
					$this->gcRecursive($fullPath, $expiredOnly);
					if (!$expiredOnly) {
						@rmdir($fullPath);
					}
				} elseif (!$expiredOnly || $expiredOnly && @filemtime($fullPath) < time()) {
					@unlink($fullPath);
				}
			}
			closedir($handle);
Qiang Xue committed
209 210 211
		}
	}
}