mirror of
https://github.com/yiisoft/yii2.git
synced 2025-08-26 06:15:19 +08:00
cherry picked RedisCache and redis\Connection from redis WIP branch
commit in redis branch was: 0cd65e7496befb3c4aed86e47257103fea63d329
This commit is contained in:
Carsten Brandt
198
framework/yii/caching/RedisCache.php
Normal file
198
framework/yii/caching/RedisCache.php
Normal file
@ -0,0 +1,198 @@
|
||||
<?php
|
||||
/**
|
||||
* @link http://www.yiiframework.com/
|
||||
* @copyright Copyright (c) 2008 Yii Software LLC
|
||||
* @license http://www.yiiframework.com/license/
|
||||
*/
|
||||
|
||||
namespace yii\caching;
|
||||
|
||||
use yii\db\redis\Connection;
|
||||
|
||||
/**
|
||||
* RedisCache implements a cache application component based on [redis](http://redis.io/).
|
||||
*
|
||||
* RedisCache needs to be configured with [[hostname]], [[port]] and [[database]] of the server
|
||||
* to connect to. By default RedisCache assumes there is a redis server running on localhost at
|
||||
* port 6379 and uses the database number 0.
|
||||
*
|
||||
* RedisCache also supports [the AUTH command](http://redis.io/commands/auth) of redis.
|
||||
* When the server needs authentication, you can set the [[password]] property to
|
||||
* authenticate with the server after connect.
|
||||
*
|
||||
* See [[Cache]] manual for common cache operations that RedisCache supports.
|
||||
* Unlike the [[CCache]], RedisCache allows the expire parameter of
|
||||
* [[set]] and [[add]] to be a floating point number, so you may specify the time in milliseconds.
|
||||
*
|
||||
* To use RedisCache as the cache application component, configure the application as follows,
|
||||
*
|
||||
* ~~~
|
||||
* array(
|
||||
* 'components'=>array(
|
||||
* 'cache'=>array(
|
||||
* 'class'=>'RedisCache',
|
||||
* 'hostname'=>'localhost',
|
||||
* 'port'=>6379,
|
||||
* 'database'=>0,
|
||||
* ),
|
||||
* ),
|
||||
* )
|
||||
* ~~~
|
||||
*
|
||||
* @author Carsten Brandt <mail@cebe.cc>
|
||||
* @since 2.0
|
||||
*/
|
||||
class RedisCache extends Cache
|
||||
{
|
||||
/**
|
||||
* @var string hostname to use for connecting to the redis server. Defaults to 'localhost'.
|
||||
*/
|
||||
public $hostname = 'localhost';
|
||||
/**
|
||||
* @var int the port to use for connecting to the redis server. Default port is 6379.
|
||||
*/
|
||||
public $port = 6379;
|
||||
/**
|
||||
* @var string the password to use to authenticate with the redis server. If not set, no AUTH command will be sent.
|
||||
*/
|
||||
public $password;
|
||||
/**
|
||||
* @var int the redis database to use. This is an integer value starting from 0. Defaults to 0.
|
||||
*/
|
||||
public $database = 0;
|
||||
/**
|
||||
* @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 \yii\db\redis\Connection the redis connection
|
||||
*/
|
||||
private $_connection;
|
||||
|
||||
|
||||
/**
|
||||
* Initializes the cache component by establishing a connection to the redis server.
|
||||
*/
|
||||
public function init()
|
||||
{
|
||||
parent::init();
|
||||
$this->getConnection();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the redis connection object.
|
||||
* Establishes a connection to the redis server if it does not already exists.
|
||||
*
|
||||
* TODO throw exception on error
|
||||
* @return \yii\db\redis\Connection
|
||||
*/
|
||||
public function getConnection()
|
||||
{
|
||||
if ($this->_connection === null) {
|
||||
$this->_connection = new Connection(array(
|
||||
'dsn' => 'redis://' . $this->hostname . ':' . $this->port . '/' . $this->database,
|
||||
'password' => $this->password,
|
||||
'connectionTimeout' => $this->connectionTimeout,
|
||||
'dataTimeout' => $this->dataTimeout,
|
||||
));
|
||||
}
|
||||
return $this->_connection;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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|boolean the value stored in cache, false if the value is not in the cache or expired.
|
||||
*/
|
||||
protected function getValue($key)
|
||||
{
|
||||
return $this->_connection->executeCommand('GET', array($key));
|
||||
}
|
||||
|
||||
/**
|
||||
* 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)
|
||||
{
|
||||
$response = $this->_connection->executeCommand('MGET', $keys);
|
||||
$result = array();
|
||||
$i = 0;
|
||||
foreach($keys as $key) {
|
||||
$result[$key] = $response[$i++];
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 float $expire the number of seconds in which the cached value will expire. 0 means never expire.
|
||||
* This can be a floating point number to specify the time in milliseconds.
|
||||
* @return boolean true if the value is successfully stored into cache, false otherwise
|
||||
*/
|
||||
protected function setValue($key,$value,$expire)
|
||||
{
|
||||
if ($expire == 0) {
|
||||
return (bool) $this->_connection->executeCommand('SET', array($key, $value));
|
||||
} else {
|
||||
$expire = (int) ($expire * 1000);
|
||||
return (bool) $this->_connection->executeCommand('PSETEX', array($key, $expire, $value));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 float $expire the number of seconds in which the cached value will expire. 0 means never expire.
|
||||
* This can be a floating point number to specify the time in milliseconds.
|
||||
* @return boolean true if the value is successfully stored into cache, false otherwise
|
||||
*/
|
||||
protected function addValue($key,$value,$expire)
|
||||
{
|
||||
if ($expire == 0) {
|
||||
return (bool) $this->_connection->executeCommand('SETNX', array($key, $value));
|
||||
} else {
|
||||
// TODO consider requiring redis version >= 2.6.12 that supports this in one command
|
||||
$expire = (int) ($expire * 1000);
|
||||
$this->_connection->executeCommand('MULTI');
|
||||
$this->_connection->executeCommand('SETNX', array($key, $value));
|
||||
$this->_connection->executeCommand('PEXPIRE', array($key, $expire));
|
||||
$response = $this->_connection->executeCommand('EXEC');
|
||||
return (bool) $response[0];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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)
|
||||
{
|
||||
return (bool) $this->_connection->executeCommand('DEL', array($key));
|
||||
}
|
||||
|
||||
/**
|
||||
* 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()
|
||||
{
|
||||
return $this->_connection->executeCommand('FLUSHDB');
|
||||
}
|
||||
}
|
||||
425
framework/yii/db/redis/Connection.php
Normal file
425
framework/yii/db/redis/Connection.php
Normal file
@ -0,0 +1,425 @@
|
||||
<?php
|
||||
/**
|
||||
* Connection class file
|
||||
*
|
||||
* @link http://www.yiiframework.com/
|
||||
* @copyright Copyright © 2008 Yii Software LLC
|
||||
* @license http://www.yiiframework.com/license/
|
||||
*/
|
||||
|
||||
namespace yii\db\redis;
|
||||
|
||||
use \yii\base\Component;
|
||||
use yii\base\InvalidConfigException;
|
||||
use \yii\db\Exception;
|
||||
use yii\helpers\Inflector;
|
||||
use yii\helpers\StringHelper;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
*
|
||||
* @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
|
||||
*
|
||||
* @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
|
||||
*/
|
||||
public $redisCommands = array(
|
||||
'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
|
||||
);
|
||||
/**
|
||||
* @var Transaction the currently active transaction
|
||||
*/
|
||||
private $_transaction;
|
||||
/**
|
||||
* @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) {
|
||||
$this->executeCommand('AUTH', array($this->password));
|
||||
}
|
||||
$this->executeCommand('SELECT', array($db));
|
||||
$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;
|
||||
$this->_transaction = 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 currently active transaction.
|
||||
* @return Transaction the currently active transaction. Null if no active transaction.
|
||||
*/
|
||||
public function getTransaction()
|
||||
{
|
||||
return $this->_transaction && $this->_transaction->isActive ? $this->_transaction : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Starts a transaction.
|
||||
* @return Transaction the transaction initiated
|
||||
*/
|
||||
public function beginTransaction()
|
||||
{
|
||||
$this->open();
|
||||
$this->_transaction = new Transaction(array(
|
||||
'db' => $this,
|
||||
));
|
||||
$this->_transaction->begin();
|
||||
return $this->_transaction;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @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).
|
||||
*/
|
||||
public function executeCommand($name, $params=array())
|
||||
{
|
||||
$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)
|
||||
{
|
||||
if(($line = fgets($this->_socket)) === false) {
|
||||
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) {
|
||||
if(($block = fread($this->_socket, $line + 2)) === false) {
|
||||
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;
|
||||
$data = array();
|
||||
for($i = 0; $i < $count; $i++) {
|
||||
$data[] = $this->parseResponse($command);
|
||||
}
|
||||
return $data;
|
||||
default:
|
||||
throw new Exception('Received illegal data from redis: ' . $line . "\nRedis command was: " . $command);
|
||||
}
|
||||
}
|
||||
}
|
||||
91
framework/yii/db/redis/Transaction.php
Normal file
91
framework/yii/db/redis/Transaction.php
Normal file
@ -0,0 +1,91 @@
|
||||
<?php
|
||||
/**
|
||||
* Transaction class file.
|
||||
*
|
||||
* @link http://www.yiiframework.com/
|
||||
* @copyright Copyright © 2008 Yii Software LLC
|
||||
* @license http://www.yiiframework.com/license/
|
||||
*/
|
||||
|
||||
namespace yii\db\redis;
|
||||
|
||||
use yii\base\InvalidConfigException;
|
||||
use yii\db\Exception;
|
||||
|
||||
/**
|
||||
* Transaction represents a DB transaction.
|
||||
*
|
||||
* @property boolean $isActive Whether the transaction is active. This property is read-only.
|
||||
*
|
||||
* @since 2.0
|
||||
*/
|
||||
class Transaction extends \yii\base\Object
|
||||
{
|
||||
/**
|
||||
* @var Connection the database connection that this transaction is associated with.
|
||||
*/
|
||||
public $db;
|
||||
/**
|
||||
* @var boolean whether this transaction is active. Only an active transaction
|
||||
* can [[commit()]] or [[rollBack()]]. This property is set true when the transaction is started.
|
||||
*/
|
||||
private $_active = false;
|
||||
|
||||
/**
|
||||
* Returns a value indicating whether this transaction is active.
|
||||
* @return boolean whether this transaction is active. Only an active transaction
|
||||
* can [[commit()]] or [[rollBack()]].
|
||||
*/
|
||||
public function getIsActive()
|
||||
{
|
||||
return $this->_active;
|
||||
}
|
||||
|
||||
/**
|
||||
* Begins a transaction.
|
||||
* @throws InvalidConfigException if [[connection]] is null
|
||||
*/
|
||||
public function begin()
|
||||
{
|
||||
if (!$this->_active) {
|
||||
if ($this->db === null) {
|
||||
throw new InvalidConfigException('Transaction::db must be set.');
|
||||
}
|
||||
\Yii::trace('Starting transaction', __CLASS__);
|
||||
$this->db->open();
|
||||
$this->db->createCommand('MULTI')->execute();
|
||||
$this->_active = true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Commits a transaction.
|
||||
* @throws Exception if the transaction or the DB connection is not active.
|
||||
*/
|
||||
public function commit()
|
||||
{
|
||||
if ($this->_active && $this->db && $this->db->isActive) {
|
||||
\Yii::trace('Committing transaction', __CLASS__);
|
||||
$this->db->createCommand('EXEC')->execute();
|
||||
// TODO handle result of EXEC
|
||||
$this->_active = false;
|
||||
} else {
|
||||
throw new Exception('Failed to commit transaction: transaction was inactive.');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Rolls back a transaction.
|
||||
* @throws Exception if the transaction or the DB connection is not active.
|
||||
*/
|
||||
public function rollback()
|
||||
{
|
||||
if ($this->_active && $this->db && $this->db->isActive) {
|
||||
\Yii::trace('Rolling back transaction', __CLASS__);
|
||||
$this->db->pdo->commit();
|
||||
$this->_active = false;
|
||||
} else {
|
||||
throw new Exception('Failed to roll back transaction: transaction was inactive.');
|
||||
}
|
||||
}
|
||||
}
|
||||
83
tests/unit/framework/caching/RedisCacheTest.php
Normal file
83
tests/unit/framework/caching/RedisCacheTest.php
Normal file
@ -0,0 +1,83 @@
|
||||
<?php
|
||||
namespace yiiunit\framework\caching;
|
||||
use yii\caching\MemCache;
|
||||
use yii\caching\RedisCache;
|
||||
use yiiunit\TestCase;
|
||||
|
||||
/**
|
||||
* Class for testing redis cache backend
|
||||
*/
|
||||
class RedisCacheTest extends CacheTestCase
|
||||
{
|
||||
private $_cacheInstance = null;
|
||||
|
||||
/**
|
||||
* @return MemCache
|
||||
*/
|
||||
protected function getCacheInstance()
|
||||
{
|
||||
$config = array(
|
||||
'hostname' => 'localhost',
|
||||
'port' => 6379,
|
||||
'database' => 0,
|
||||
'dataTimeout' => 0.1,
|
||||
);
|
||||
$dsn = $config['hostname'] . ':' .$config['port'];
|
||||
if(!@stream_socket_client($dsn, $errorNumber, $errorDescription, 0.5)) {
|
||||
$this->markTestSkipped('No redis server running at ' . $dsn .' : ' . $errorNumber . ' - ' . $errorDescription);
|
||||
}
|
||||
|
||||
if($this->_cacheInstance === null) {
|
||||
$this->_cacheInstance = new RedisCache($config);
|
||||
}
|
||||
return $this->_cacheInstance;
|
||||
}
|
||||
|
||||
public function testExpireMilliseconds()
|
||||
{
|
||||
$cache = $this->getCacheInstance();
|
||||
|
||||
$this->assertTrue($cache->set('expire_test_ms', 'expire_test_ms', 0.2));
|
||||
usleep(100000);
|
||||
$this->assertEquals('expire_test_ms', $cache->get('expire_test_ms'));
|
||||
usleep(300000);
|
||||
$this->assertFalse($cache->get('expire_test_ms'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Store a value that is 2 times buffer size big
|
||||
* https://github.com/yiisoft/yii2/issues/743
|
||||
*/
|
||||
public function testLargeData()
|
||||
{
|
||||
$cache = $this->getCacheInstance();
|
||||
|
||||
$data=str_repeat('XX',8192); // http://www.php.net/manual/en/function.fread.php
|
||||
$key='bigdata1';
|
||||
|
||||
$this->assertFalse($cache->get($key));
|
||||
$cache->set($key,$data);
|
||||
$this->assertTrue($cache->get($key)===$data);
|
||||
|
||||
// try with multibyte string
|
||||
$data=str_repeat('ЖЫ',8192); // http://www.php.net/manual/en/function.fread.php
|
||||
$key='bigdata2';
|
||||
|
||||
$this->assertFalse($cache->get($key));
|
||||
$cache->set($key,$data);
|
||||
$this->assertTrue($cache->get($key)===$data);
|
||||
}
|
||||
|
||||
public function testMultiByteGetAndSet()
|
||||
{
|
||||
$cache = $this->getCacheInstance();
|
||||
|
||||
$data=array('abc'=>'ежик',2=>'def');
|
||||
$key='data1';
|
||||
|
||||
$this->assertFalse($cache->get($key));
|
||||
$cache->set($key,$data);
|
||||
$this->assertTrue($cache->get($key)===$data);
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user