Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added redis cache driver #948

Merged
merged 10 commits into from
Jun 9, 2012
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions system/libraries/Cache/Cache.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,12 @@ class CI_Cache extends CI_Driver_Library {
*
* @var array
*/
protected $valid_drivers = array(
protected $valid_drivers = array(
'cache_apc',
'cache_dummy',
'cache_file',
'cache_memcached',
'cache_dummy',
'cache_redis',
'cache_wincache'
);

Expand Down Expand Up @@ -225,4 +226,4 @@ public function is_supported($driver)
}

/* End of file Cache.php */
/* Location: ./system/libraries/Cache/Cache.php */
/* Location: ./system/libraries/Cache/Cache.php */
221 changes: 221 additions & 0 deletions system/libraries/Cache/drivers/Cache_redis.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,221 @@
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* CodeIgniter
*
* An open source application development framework for PHP 5.2.4 or newer
*
* NOTICE OF LICENSE
*
* Licensed under the Open Software License version 3.0
*
* This source file is subject to the Open Software License (OSL 3.0) that is
* bundled with this package in the files license.txt / license.rst. It is
* also available through the world wide web at this URL:
* http://opensource.org/licenses/OSL-3.0
* If you did not receive a copy of the license and are unable to obtain it
* through the world wide web, please send an email to
* licensing@ellislab.com so we can send you a copy immediately.
*
* @package CodeIgniter
* @author EllisLab Dev Team
* @copyright Copyright (c) 2006 - 2012 EllisLab, Inc.
* @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
* @link http://codeigniter.com
* @since Version 2.0
* @filesource
*/

// ------------------------------------------------------------------------

/**
* CodeIgniter Redis Caching Class
*
* @package CodeIgniter
* @subpackage Libraries
* @category Core
* @author Anton Lindqvist <anton@qvister.se>
* @link
*/
class CI_Cache_redis extends CI_Driver
{

/**
* Default config
*
* @static
* @var array
*/
protected static $_default_config = array(
'host' => '127.0.0.1',
'password' => NULL,
'port' => 6379,
'timeout' => 0
);

/**
* Redis connection
*
* @var Redis
*/
protected $_redis;

/**
* Class destructor
*
* Closes the connection to Redis if present.
*
* @return void
*/
public function __destruct()
{
if ($this->_redis)
{
$this->_redis->close();
}
}

/**
* Get cache
*
* @param string $key Cache key identifier
* @return mixed
*/
public function get($key)
{
return $this->_redis->get($key);
}

/**
* Save cache
*
* @param string $key Cache key identifier
* @param mixed $value Data to save
* @param integer $ttl Time to live
* @return boolean
*/
public function save($key, $value, $ttl = NULL)
{
return ($ttl)
? $this->_redis->setex($key, $ttl, $value)
: $this->_redis->set($key, $value);
}

/**
* Delete from cache
*
* @param string $key Cache key
* @return boolean
*/
public function delete($key)
{
return ($this->_redis->delete($key) === 1);
}

/**
* Clean cache
*
* @return boolean
* @see Redis::flushDB()
*/
public function clean()
{
return $this->_redis->flushDB();
}

/**
* Get cache driver info
*
* @param string $type Not supported in Redis. Only included in order to offer a
* consistent cache API.
* @return array
* @see Redis::info()
*/
public function cache_info($type = NULL)
{
return $this->_redis->info();
}

/**
* Get cache metadata
*
* @param string $key Cache key
* @return array
*/
public function get_metadata($key)
{
$value = $this->get($key);

if ($value)
{
return array(
'expire' => time() + $this->_redis->ttl($key),
'data' => $value
);
}
}

/**
* Check if Redis driver is supported
*
* @return boolean
*/
public function is_supported()
{
if (extension_loaded('redis'))
{
$this->_setup_redis();

return TRUE;
}
else
{
log_message('error', 'The Redis extension must be loaded to use Redis cache.');

return FALSE;
}

}

/**
* Setup Redis config and connection
*
* Loads Redis config file if present. Will halt execution if a Redis connection
* can't be established.
*
* @return void
* @see Redis::connect()
*/
protected function _setup_redis()
{
$config = array();
$CI =& get_instance();

if ($CI->config->load('redis', TRUE, TRUE))
{
$config += $CI->config->item('redis');
}

$config = array_merge(self::$_default_config, $config);

$this->_redis = new Redis();

try
{
$this->_redis->connect($config['host'], $config['port'], $config['timeout']);
}
catch (RedisException $e)
{
show_error('Redis connection refused. ' . $e->getMessage());
}

if (isset($config['password']))
{
$this->_redis->auth($config['password']);
}
}

}
// End Class

/* End of file Cache_redis.php */
/* Location: ./system/libraries/Cache/drivers/Cache_redis.php */