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

8
namespace yii\redis;
9

10
use yii\base\Component;
11
use yii\base\InvalidConfigException;
12
use yii\db\Exception;
13 14 15 16 17 18 19 20
use yii\helpers\Inflector;

/**
 *
 * @method mixed set($key, $value) Set the string value of a key
 * @method mixed get($key) Set the string value of a key
 * TODO document methods
 *
21 22
 * @property string $driverName Name of the DB driver. This property is read-only.
 * @property boolean $isActive Whether the DB connection is established. This property is read-only.
23
 * @property LuaScriptBuilder $luaScriptBuilder This property is read-only.
24
 *
25
 * @author Carsten Brandt <mail@cebe.cc>
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
 * @since 2.0
 */
class Connection extends Component
{
	/**
	 * @event Event an event that is triggered after a DB connection is established
	 */
	const EVENT_AFTER_OPEN = 'afterOpen';

	/**
	 * @var string the Data Source Name, or DSN, contains the information required to connect to the database.
	 * DSN format: redis://server:port[/db]
	 * Where db is a zero based integer which refers to the DB to use.
	 * If no DB is given, ID 0 is used.
	 *
	 * Example: redis://localhost:6379/2
	 */
	public $dsn;
	/**
	 * @var string the password for establishing DB connection. Defaults to null meaning no AUTH command is send.
	 * See http://redis.io/commands/auth
	 */
	public $password;
	/**
	 * @var float timeout to use for connection to redis. If not set the timeout set in php.ini will be used: ini_get("default_socket_timeout")
	 */
	public $connectionTimeout = null;
	/**
	 * @var float timeout to use for redis socket when reading and writing data. If not set the php default value will be used.
	 */
	public $dataTimeout = null;

	/**
	 * @var array List of available redis commands http://redis.io/commands
	 */
Alexander Makarov committed
61
	public $redisCommands = [
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
		'BRPOP', // key [key ...] timeout Remove and get the last element in a list, or block until one is available
		'BRPOPLPUSH', // source destination timeout Pop a value from a list, push it to another list and return it; or block until one is available
		'CLIENT KILL', // ip:port Kill the connection of a client
		'CLIENT LIST', // Get the list of client connections
		'CLIENT GETNAME', // Get the current connection name
		'CLIENT SETNAME', // connection-name Set the current connection name
		'CONFIG GET', // parameter Get the value of a configuration parameter
		'CONFIG SET', // parameter value Set a configuration parameter to the given value
		'CONFIG RESETSTAT', // Reset the stats returned by INFO
		'DBSIZE', // Return the number of keys in the selected database
		'DEBUG OBJECT', // key Get debugging information about a key
		'DEBUG SEGFAULT', // Make the server crash
		'DECR', // key Decrement the integer value of a key by one
		'DECRBY', // key decrement Decrement the integer value of a key by the given number
		'DEL', // key [key ...] Delete a key
		'DISCARD', // Discard all commands issued after MULTI
		'DUMP', // key Return a serialized version of the value stored at the specified key.
		'ECHO', // message Echo the given string
		'EVAL', // script numkeys key [key ...] arg [arg ...] Execute a Lua script server side
		'EVALSHA', // sha1 numkeys key [key ...] arg [arg ...] Execute a Lua script server side
		'EXEC', // Execute all commands issued after MULTI
		'EXISTS', // key Determine if a key exists
		'EXPIRE', // key seconds Set a key's time to live in seconds
		'EXPIREAT', // key timestamp Set the expiration for a key as a UNIX timestamp
		'FLUSHALL', // Remove all keys from all databases
		'FLUSHDB', // Remove all keys from the current database
		'GET', // key Get the value of a key
		'GETBIT', // key offset Returns the bit value at offset in the string value stored at key
		'GETRANGE', // key start end Get a substring of the string stored at a key
		'GETSET', // key value Set the string value of a key and return its old value
		'HDEL', // key field [field ...] Delete one or more hash fields
		'HEXISTS', // key field Determine if a hash field exists
		'HGET', // key field Get the value of a hash field
		'HGETALL', // key Get all the fields and values in a hash
		'HINCRBY', // key field increment Increment the integer value of a hash field by the given number
		'HINCRBYFLOAT', // key field increment Increment the float value of a hash field by the given amount
		'HKEYS', // key Get all the fields in a hash
		'HLEN', // key Get the number of fields in a hash
		'HMGET', // key field [field ...] Get the values of all the given hash fields
		'HMSET', // key field value [field value ...] Set multiple hash fields to multiple values
		'HSET', // key field value Set the string value of a hash field
		'HSETNX', // key field value Set the value of a hash field, only if the field does not exist
		'HVALS', // key Get all the values in a hash
		'INCR', // key Increment the integer value of a key by one
		'INCRBY', // key increment Increment the integer value of a key by the given amount
		'INCRBYFLOAT', // key increment Increment the float value of a key by the given amount
		'INFO', // [section] Get information and statistics about the server
		'KEYS', // pattern Find all keys matching the given pattern
		'LASTSAVE', // Get the UNIX time stamp of the last successful save to disk
		'LINDEX', // key index Get an element from a list by its index
		'LINSERT', // key BEFORE|AFTER pivot value Insert an element before or after another element in a list
		'LLEN', // key Get the length of a list
		'LPOP', // key Remove and get the first element in a list
		'LPUSH', // key value [value ...] Prepend one or multiple values to a list
		'LPUSHX', // key value Prepend a value to a list, only if the list exists
		'LRANGE', // key start stop Get a range of elements from a list
		'LREM', // key count value Remove elements from a list
		'LSET', // key index value Set the value of an element in a list by its index
		'LTRIM', // key start stop Trim a list to the specified range
		'MGET', // key [key ...] Get the values of all the given keys
		'MIGRATE', // host port key destination-db timeout Atomically transfer a key from a Redis instance to another one.
		'MONITOR', // Listen for all requests received by the server in real time
		'MOVE', // key db Move a key to another database
		'MSET', // key value [key value ...] Set multiple keys to multiple values
		'MSETNX', // key value [key value ...] Set multiple keys to multiple values, only if none of the keys exist
		'MULTI', // Mark the start of a transaction block
		'OBJECT', // subcommand [arguments [arguments ...]] Inspect the internals of Redis objects
		'PERSIST', // key Remove the expiration from a key
		'PEXPIRE', // key milliseconds Set a key's time to live in milliseconds
		'PEXPIREAT', // key milliseconds-timestamp Set the expiration for a key as a UNIX timestamp specified in milliseconds
		'PING', // Ping the server
		'PSETEX', // key milliseconds value Set the value and expiration in milliseconds of a key
		'PSUBSCRIBE', // pattern [pattern ...] Listen for messages published to channels matching the given patterns
		'PTTL', // key Get the time to live for a key in milliseconds
		'PUBLISH', // channel message Post a message to a channel
		'PUNSUBSCRIBE', // [pattern [pattern ...]] Stop listening for messages posted to channels matching the given patterns
		'QUIT', // Close the connection
		'RANDOMKEY', // Return a random key from the keyspace
		'RENAME', // key newkey Rename a key
		'RENAMENX', // key newkey Rename a key, only if the new key does not exist
		'RESTORE', // key ttl serialized-value Create a key using the provided serialized value, previously obtained using DUMP.
		'RPOP', // key Remove and get the last element in a list
		'RPOPLPUSH', // source destination Remove the last element in a list, append it to another list and return it
		'RPUSH', // key value [value ...] Append one or multiple values to a list
		'RPUSHX', // key value Append a value to a list, only if the list exists
		'SADD', // key member [member ...] Add one or more members to a set
		'SAVE', // Synchronously save the dataset to disk
		'SCARD', // key Get the number of members in a set
		'SCRIPT EXISTS', // script [script ...] Check existence of scripts in the script cache.
		'SCRIPT FLUSH', // Remove all the scripts from the script cache.
		'SCRIPT KILL', // Kill the script currently in execution.
		'SCRIPT LOAD', // script Load the specified Lua script into the script cache.
		'SDIFF', // key [key ...] Subtract multiple sets
		'SDIFFSTORE', // destination key [key ...] Subtract multiple sets and store the resulting set in a key
		'SELECT', // index Change the selected database for the current connection
		'SET', // key value Set the string value of a key
		'SETBIT', // key offset value Sets or clears the bit at offset in the string value stored at key
		'SETEX', // key seconds value Set the value and expiration of a key
		'SETNX', // key value Set the value of a key, only if the key does not exist
		'SETRANGE', // key offset value Overwrite part of a string at key starting at the specified offset
		'SHUTDOWN', // [NOSAVE] [SAVE] Synchronously save the dataset to disk and then shut down the server
		'SINTER', // key [key ...] Intersect multiple sets
		'SINTERSTORE', // destination key [key ...] Intersect multiple sets and store the resulting set in a key
		'SISMEMBER', // key member Determine if a given value is a member of a set
		'SLAVEOF', // host port Make the server a slave of another instance, or promote it as master
		'SLOWLOG', // subcommand [argument] Manages the Redis slow queries log
		'SMEMBERS', // key Get all the members in a set
		'SMOVE', // source destination member Move a member from one set to another
		'SORT', // key [BY pattern] [LIMIT offset count] [GET pattern [GET pattern ...]] [ASC|DESC] [ALPHA] [STORE destination] Sort the elements in a list, set or sorted set
		'SPOP', // key Remove and return a random member from a set
		'SRANDMEMBER', // key [count] Get one or multiple random members from a set
		'SREM', // key member [member ...] Remove one or more members from a set
		'STRLEN', // key Get the length of the value stored in a key
		'SUBSCRIBE', // channel [channel ...] Listen for messages published to the given channels
		'SUNION', // key [key ...] Add multiple sets
		'SUNIONSTORE', // destination key [key ...] Add multiple sets and store the resulting set in a key
		'SYNC', // Internal command used for replication
		'TIME', // Return the current server time
		'TTL', // key Get the time to live for a key
		'TYPE', // key Determine the type stored at key
		'UNSUBSCRIBE', // [channel [channel ...]] Stop listening for messages posted to the given channels
		'UNWATCH', // Forget about all watched keys
		'WATCH', // key [key ...] Watch the given keys to determine execution of the MULTI/EXEC block
		'ZADD', // key score member [score member ...] Add one or more members to a sorted set, or update its score if it already exists
		'ZCARD', // key Get the number of members in a sorted set
		'ZCOUNT', // key min max Count the members in a sorted set with scores within the given values
		'ZINCRBY', // key increment member Increment the score of a member in a sorted set
		'ZINTERSTORE', // destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE SUM|MIN|MAX] Intersect multiple sorted sets and store the resulting sorted set in a new key
		'ZRANGE', // key start stop [WITHSCORES] Return a range of members in a sorted set, by index
		'ZRANGEBYSCORE', // key min max [WITHSCORES] [LIMIT offset count] Return a range of members in a sorted set, by score
		'ZRANK', // key member Determine the index of a member in a sorted set
		'ZREM', // key member [member ...] Remove one or more members from a sorted set
		'ZREMRANGEBYRANK', // key start stop Remove all members in a sorted set within the given indexes
		'ZREMRANGEBYSCORE', // key min max Remove all members in a sorted set within the given scores
		'ZREVRANGE', // key start stop [WITHSCORES] Return a range of members in a sorted set, by index, with scores ordered from high to low
		'ZREVRANGEBYSCORE', // key max min [WITHSCORES] [LIMIT offset count] Return a range of members in a sorted set, by score, with scores ordered from high to low
		'ZREVRANK', // key member Determine the index of a member in a sorted set, with scores ordered from high to low
		'ZSCORE', // key member Get the score associated with the given member in a sorted set
		'ZUNIONSTORE', // destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE SUM|MIN|MAX] Add multiple sorted sets and store the resulting sorted set in a new key
Alexander Makarov committed
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
	/**
	 * @var resource redis socket connection
	 */
	private $_socket;

	/**
	 * Closes the connection when this component is being serialized.
	 * @return array
	 */
	public function __sleep()
	{
		$this->close();
		return array_keys(get_object_vars($this));
	}

	/**
	 * Returns a value indicating whether the DB connection is established.
	 * @return boolean whether the DB connection is established
	 */
	public function getIsActive()
	{
		return $this->_socket !== null;
	}

	/**
	 * Establishes a DB connection.
	 * It does nothing if a DB connection has already been established.
	 * @throws Exception if connection fails
	 */
	public function open()
	{
		if ($this->_socket === null) {
			if (empty($this->dsn)) {
				throw new InvalidConfigException('Connection.dsn cannot be empty.');
			}
			$dsn = explode('/', $this->dsn);
			$host = $dsn[2];
			if (strpos($host, ':')===false) {
				$host .= ':6379';
			}
			$db = isset($dsn[3]) ? $dsn[3] : 0;

			\Yii::trace('Opening DB connection: ' . $this->dsn, __CLASS__);
			$this->_socket = @stream_socket_client(
				$host,
				$errorNumber,
				$errorDescription,
				$this->connectionTimeout ? $this->connectionTimeout : ini_get("default_socket_timeout")
			);
			if ($this->_socket) {
				if ($this->dataTimeout !== null) {
					stream_set_timeout($this->_socket, $timeout=(int)$this->dataTimeout, (int) (($this->dataTimeout - $timeout) * 1000000));
				}
				if ($this->password !== null) {
Alexander Makarov committed
256
					$this->executeCommand('AUTH', [$this->password]);
257
				}
Alexander Makarov committed
258
				$this->executeCommand('SELECT', [$db]);
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
				$this->initConnection();
			} else {
				\Yii::error("Failed to open DB connection ({$this->dsn}): " . $errorNumber . ' - ' . $errorDescription, __CLASS__);
				$message = YII_DEBUG ? 'Failed to open DB connection: ' . $errorNumber . ' - ' . $errorDescription : 'Failed to open DB connection.';
				throw new Exception($message, $errorDescription, (int)$errorNumber);
			}
		}
	}

	/**
	 * Closes the currently active DB connection.
	 * It does nothing if the connection is already closed.
	 */
	public function close()
	{
		if ($this->_socket !== null) {
			\Yii::trace('Closing DB connection: ' . $this->dsn, __CLASS__);
			$this->executeCommand('QUIT');
			stream_socket_shutdown($this->_socket, STREAM_SHUT_RDWR);
			$this->_socket = null;
		}
	}

	/**
	 * Initializes the DB connection.
	 * This method is invoked right after the DB connection is established.
	 * The default implementation triggers an [[EVENT_AFTER_OPEN]] event.
	 */
	protected function initConnection()
	{
		$this->trigger(self::EVENT_AFTER_OPEN);
	}

	/**
	 * Returns the name of the DB driver for the current [[dsn]].
	 * @return string name of the DB driver
	 */
	public function getDriverName()
	{
		if (($pos = strpos($this->dsn, ':')) !== false) {
			return strtolower(substr($this->dsn, 0, $pos));
		} else {
			return 'redis';
		}
	}

305 306 307
	/**
	 * @return LuaScriptBuilder
	 */
308 309 310 311 312
	public function getLuaScriptBuilder()
	{
		return new LuaScriptBuilder();
	}

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
	/**
	 *
	 * @param string $name
	 * @param array $params
	 * @return mixed
	 */
	public function __call($name, $params)
	{
		$redisCommand = strtoupper(Inflector::camel2words($name, false));
		if (in_array($redisCommand, $this->redisCommands)) {
			return $this->executeCommand($name, $params);
		} else {
			return parent::__call($name, $params);
		}
	}

	/**
	 * Executes a redis command.
	 * For a list of available commands and their parameters see http://redis.io/commands.
	 *
	 * @param string $name the name of the command
	 * @param array $params list of parameters for the command
	 * @return array|bool|null|string Dependend on the executed command this method
	 * will return different data types:
	 *
	 * - `true` for commands that return "status reply".
	 * - `string` for commands that return "integer reply"
	 *   as the value is in the range of a signed 64 bit integer.
	 * - `string` or `null` for commands that return "bulk reply".
	 * - `array` for commands that return "Multi-bulk replies".
	 *
	 * See [redis protocol description](http://redis.io/topics/protocol)
	 * for details on the mentioned reply types.
	 * @trows Exception for commands that return [error reply](http://redis.io/topics/protocol#error-reply).
	 */
Alexander Makarov committed
348
	public function executeCommand($name, $params=[])
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
	{
		$this->open();

		array_unshift($params, $name);
		$command = '*' . count($params) . "\r\n";
		foreach($params as $arg) {
			$command .= '$' . mb_strlen($arg, '8bit') . "\r\n" . $arg . "\r\n";
		}

		\Yii::trace("Executing Redis Command: {$name}", __CLASS__);
		fwrite($this->_socket, $command);

		return $this->parseResponse(implode(' ', $params));
	}

	private function parseResponse($command)
	{
366
		if (($line = fgets($this->_socket)) === false) {
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
			throw new Exception("Failed to read from socket.\nRedis command was: " . $command);
		}
		$type = $line[0];
		$line = mb_substr($line, 1, -2, '8bit');
		switch($type)
		{
			case '+': // Status reply
				return true;
			case '-': // Error reply
				throw new Exception("Redis error: " . $line . "\nRedis command was: " . $command);
			case ':': // Integer reply
				// no cast to int as it is in the range of a signed 64 bit integer
				return $line;
			case '$': // Bulk replies
				if ($line == '-1') {
					return null;
				}
				$length = $line + 2;
				$data = '';
				while ($length > 0) {
387
					if (($block = fread($this->_socket, $line + 2)) === false) {
388 389 390 391 392 393 394 395
						throw new Exception("Failed to read from socket.\nRedis command was: " . $command);
					}
					$data .= $block;
					$length -= mb_strlen($block, '8bit');
				}
				return mb_substr($data, 0, -2, '8bit');
			case '*': // Multi-bulk replies
				$count = (int) $line;
Alexander Makarov committed
396
				$data = [];
397
				for ($i = 0; $i < $count; $i++) {
398 399 400 401 402 403 404 405
					$data[] = $this->parseResponse($command);
				}
				return $data;
			default:
				throw new Exception('Received illegal data from redis: ' . $line . "\nRedis command was: " . $command);
		}
	}
}