DbCache.php 7.3 KB
Newer Older
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8 9
namespace yii\caching;

10
use Yii;
11
use yii\base\InvalidConfigException;
Qiang Xue committed
12 13
use yii\db\Connection;
use yii\db\Query;
Qiang Xue committed
14

Qiang Xue committed
15
/**
Qiang Xue committed
16
 * DbCache implements a cache application component by storing cached data in a database.
Qiang Xue committed
17
 *
18 19
 * By default, DbCache stores session data in a DB table named 'tbl_cache'. This table
 * must be pre-created. The table name can be changed by setting [[cacheTable]].
20 21
 *
 * Please refer to [[Cache]] for common cache operations that are supported by DbCache.
Qiang Xue committed
22
 *
23 24 25 26 27 28 29 30 31
 * The following example shows how you can configure the application to use DbCache:
 *
 * ~~~
 * 'cache' => array(
 *     'class' => 'yii\caching\DbCache',
 *     // 'db' => 'mydb',
 *     // 'cacheTable' => 'my_cache',
 * )
 * ~~~
Qiang Xue committed
32 33
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
34
 * @since 2.0
Qiang Xue committed
35
 */
Qiang Xue committed
36
class DbCache extends Cache
Qiang Xue committed
37 38
{
	/**
39 40 41
	 * @var Connection|string the DB connection object or the application component ID of the DB connection.
	 * After the DbCache object is created, if you want to change this property, you should only assign it
	 * with a DB connection object.
Qiang Xue committed
42
	 */
43
	public $db = 'db';
Qiang Xue committed
44
	/**
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
	 * @var string name of the DB table to store cache content.
	 * The table should be pre-created as follows:
	 *
	 * ~~~
	 * CREATE TABLE tbl_cache (
	 *     id char(128) NOT NULL PRIMARY KEY,
	 *     expire int(11),
	 *     data BLOB
	 * );
	 * ~~~
	 *
	 * where 'BLOB' refers to the BLOB-type of your preferred DBMS. Below are the BLOB type
	 * that can be used for some popular DBMS:
	 *
	 * - MySQL: LONGBLOB
	 * - PostgreSQL: BYTEA
	 * - MSSQL: BLOB
	 *
	 * When using DbCache in a production server, we recommend you create a DB index for the 'expire'
	 * column in the cache table to improve the performance.
Qiang Xue committed
65
	 */
66
	public $cacheTable = 'tbl_cache';
Qiang Xue committed
67
	/**
Qiang Xue committed
68
	 * @var integer the probability (parts per million) that garbage collection (GC) should be performed
69
	 * when storing a piece of data in the cache. Defaults to 100, meaning 0.01% chance.
Qiang Xue committed
70 71 72
	 * This number should be between 0 and 1000000. A value 0 meaning no GC will be performed at all.
	 **/
	public $gcProbability = 100;
Qiang Xue committed
73 74 75


	/**
76 77 78
	 * Initializes the DbCache component.
	 * This method will initialize the [[db]] property to make sure it refers to a valid DB connection.
	 * @throws InvalidConfigException if [[db]] is invalid.
Qiang Xue committed
79
	 */
80
	public function init()
Qiang Xue committed
81
	{
82 83 84 85 86 87 88
		parent::init();
		if (is_string($this->db)) {
			$this->db = Yii::$app->getComponent($this->db);
		}
		if (!$this->db instanceof Connection) {
			throw new InvalidConfigException("DbCache::db must be either a DB connection instance or the application component ID of a DB connection.");
		}
Qiang Xue committed
89 90 91 92 93 94
	}

	/**
	 * 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
95
	 * @return string|boolean the value stored in cache, false if the value is not in the cache or expired.
Qiang Xue committed
96 97 98
	 */
	protected function getValue($key)
	{
Qiang Xue committed
99
		$query = new Query;
100
		$query->select(array('data'))
101
			->from($this->cacheTable)
102
			->where('[[id]] = :id AND ([[expire]] = 0 OR [[expire]] >' . time() . ')', array(':id' => $key));
103
		if ($this->db->enableQueryCache) {
Qiang Xue committed
104
			// temporarily disable and re-enable query caching
105 106 107
			$this->db->enableQueryCache = false;
			$result = $query->createCommand($this->db)->queryScalar();
			$this->db->enableQueryCache = true;
Qiang Xue committed
108
			return $result;
Qiang Xue committed
109
		} else {
110
			return $query->createCommand($this->db)->queryScalar();
Qiang Xue committed
111 112 113 114 115 116 117 118 119 120
		}
	}

	/**
	 * Retrieves multiple values from cache with the specified keys.
	 * @param array $keys a list of keys identifying the cached values
	 * @return array a list of cached values indexed by the keys
	 */
	protected function getValues($keys)
	{
Qiang Xue committed
121
		if (empty($keys)) {
Qiang Xue committed
122
			return array();
Qiang Xue committed
123
		}
124 125
		$query = new Query;
		$query->select(array('id', 'data'))
126
			->from($this->cacheTable)
127
			->where(array('id' => $keys))
128
			->andWhere('([[expire]] = 0 OR [[expire]] > ' . time() . ')');
Qiang Xue committed
129

130 131 132 133
		if ($this->db->enableQueryCache) {
			$this->db->enableQueryCache = false;
			$rows = $query->createCommand($this->db)->queryAll();
			$this->db->enableQueryCache = true;
Qiang Xue committed
134
		} else {
135
			$rows = $query->createCommand($this->db)->queryAll();
Qiang Xue committed
136 137
		}

Qiang Xue committed
138 139 140 141 142
		$results = array();
		foreach ($keys as $key) {
			$results[$key] = false;
		}
		foreach ($rows as $row) {
143
			$results[$row['id']] = $row['data'];
Qiang Xue committed
144
		}
Qiang Xue committed
145 146 147 148 149 150 151 152 153 154 155 156
		return $results;
	}

	/**
	 * 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
	 */
Qiang Xue committed
157
	protected function setValue($key, $value, $expire)
Qiang Xue committed
158
	{
159 160 161 162 163 164 165
		$command = $this->db->createCommand()
			->update($this->cacheTable, array(
				'expire' => $expire > 0 ? $expire + time() : 0,
				'data' => array($value, \PDO::PARAM_LOB),
			), array(
				'id' => $key,
			));
166 167 168 169 170 171 172

		if ($command->execute()) {
			$this->gc();
			return true;
		} else {
			return $this->addValue($key, $value, $expire);
		}
resurtm committed
173
	}
Qiang Xue committed
174 175 176 177 178 179 180 181 182 183

	/**
	 * 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
	 */
Qiang Xue committed
184
	protected function addValue($key, $value, $expire)
Qiang Xue committed
185
	{
186
		$this->gc();
Qiang Xue committed
187

Qiang Xue committed
188 189 190 191 192
		if ($expire > 0) {
			$expire += time();
		} else {
			$expire = 0;
		}
193

Qiang Xue committed
194
		try {
195 196 197 198 199 200
			$this->db->createCommand()
				->insert($this->cacheTable, array(
					'id' => $key,
					'expire' => $expire,
					'data' => array($value, \PDO::PARAM_LOB),
				))->execute();
Qiang Xue committed
201
			return true;
202
		} catch (\Exception $e) {
Qiang Xue committed
203 204 205 206 207 208 209 210 211 212 213 214
			return false;
		}
	}

	/**
	 * 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)
	{
215 216 217
		$this->db->createCommand()
			->delete($this->cacheTable, array('id' => $key))
			->execute();
Qiang Xue committed
218 219 220 221 222
		return true;
	}

	/**
	 * Removes the expired data values.
223 224
	 * @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]].
Qiang Xue committed
225
	 */
226
	public function gc($force = false)
Qiang Xue committed
227
	{
228
		if ($force || mt_rand(0, 1000000) < $this->gcProbability) {
229
			$this->db->createCommand()
230
				->delete($this->cacheTable, '[[expire]] > 0 AND [[expire]] < ' . time())
231
				->execute();
232
		}
Qiang Xue committed
233 234 235 236 237 238 239 240 241
	}

	/**
	 * 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()
	{
242 243 244
		$this->db->createCommand()
			->delete($this->cacheTable)
			->execute();
Qiang Xue committed
245 246 247
		return true;
	}
}