/fuel/core/classes/cache/storage/redis.php

<?php
/**
 * Fuel
 *
 * Fuel is a fast, lightweight, community driven PHP5 framework.
 *
 * @package		Fuel
 * @version		1.0
 * @author		Harro "WanWizard" Verton
 * @license		MIT License
 * @copyright	2010 - 2011 Fuel Development Team
 * @link		http://fuelphp.com
 */

namespace Fuel\Core;



class Cache_Storage_Redis extends Cache_Storage_Driver {

	/**
	 * @const	string	Tag used for opening & closing cache properties
	 */
	const PROPS_TAG = 'Fuel_Cache_Properties';

	/**
	 * @var driver specific configuration
	 */
	protected $config = array();

	/*
	 * @var	storage for the redis object
	 */
	protected $redis = false;

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

	public function __construct($identifier, $config)
	{
		$this->config = isset($config['redis']) ? $config['redis'] : array();

		// make sure we have a redis id
		$this->config['cache_id'] = $this->_validate_config('cache_id', isset($this->config['cache_id']) ? $this->config['cache_id'] : 'fuel');

		// check for an expiration override
		$this->expiration = $this->_validate_config('expiration', isset($this->config['expiration']) ? $this->config['expiration'] : $this->expiration);

		// make sure we have a redis database configured
		$this->config['database'] = $this->_validate_config('database', isset($this->config['database']) ? $this->config['database'] : 'default');

		if ($this->redis === false)
		{
			// get the redis database instance
			try
			{
				$this->redis = \Redis::instance($this->config['database']);
			}
			catch (Exception $e)
			{
				throw new \Cache_Exception('Can not connect to the Redis engine. The error message says "'.$e->getMessage().'".');
			}

			// get the redis version
			preg_match('/redis_version:(.*?)\n/', $this->redis->info(), $info);
			if (version_compare(trim($info[1]), '1.2') < 0)
			{
				throw new \Cache_Exception('Version 1.2 or higher of the Redis NoSQL engine is required to use the redis cache driver.');
			}
		}

		parent::__construct($identifier, $config);
	}

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

	/**
	 * Translates a given identifier to a valid redis key
	 *
	 * @param	string
	 * @return	string
	 * @throws	Cache_Exception
	 */
	protected function identifier_to_key( $identifier )
	{
		return $this->config['cache_id'].':'.$identifier;
	}

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

	/**
	 * Prepend the cache properties
	 *
	 * @return string
	 */
	protected function prep_contents()
	{
		$properties = array(
			'created'			=> $this->created,
			'expiration'		=> $this->expiration,
			'dependencies'		=> $this->dependencies,
			'content_handler'	=> $this->content_handler
		);
		$properties = '{{'.self::PROPS_TAG.'}}'.json_encode($properties).'{{/'.self::PROPS_TAG.'}}';

		return $properties . $this->contents;
	}

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

	/**
	 * Remove the prepended cache properties and save them in class properties
	 *
	 * @param	string
	 * @throws	Cache_Exception
	 */
	protected function unprep_contents($payload)
	{
		$properties_end = strpos($payload, '{{/'.self::PROPS_TAG.'}}');
		if ($properties_end === FALSE)
		{
			throw new \Cache_Exception('Incorrect formatting');
		}

		$this->contents = substr($payload, $properties_end + strlen('{{/'.self::PROPS_TAG.'}}'));
		$props = substr(substr($payload, 0, $properties_end), strlen('{{'.self::PROPS_TAG.'}}'));
		$props = json_decode($props, true);
		if ($props === NULL)
		{
			throw new \Cache_Exception('Properties retrieval failed');
		}

		$this->created			= $props['created'];
		$this->expiration		= is_null($this->expiration) ? null : (int) ($props['expiration'] - time());
		$this->dependencies		= $props['dependencies'];
		$this->content_handler	= $props['content_handler'];
	}

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

	/**
	 * Check if other caches or files have been changed since cache creation
	 *
	 * @param	array
	 * @return	bool
	 */
	public function check_dependencies(Array $dependencies)
	{
		foreach($dependencies as $dep)
		{
			// get the section name and identifier
			$sections = explode('.', $dep);
			if (count($sections) > 1)
			{
				$identifier = array_pop($sections);
				$sections = '.'.implode('.', $sections);

			}
			else
			{
				$identifier = $dep;
				$sections = '';
			}

			// get the cache index
			$index = $this->redis->get($this->config['cache_id'].':index:'.$sections);
			is_null($index) or $index = $this->_unserialize($index);

			// get the key from the index
			$key = isset($index[$identifier][0]) ? $index[$identifier] : false;

			// key found and newer?
			if ($key !== false and $key[1] > $this->created)
			{
				return false;
			}
		}
		return true;
	}

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

	/**
	 * Delete Cache
	 */
	public function delete()
	{
		// get the key for the cache identifier
		$key = $this->_get_key(true);

		// delete the key from the redis server
		if ($key and $this->redis->del($key) === false)
		{
			// do something here?
		}

		$this->reset();
	}

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

	/**
	 * Purge all caches
	 *
	 * @param	limit purge to subsection
	 * @return	bool
	 * @throws	Cache_Exception
	 */
	public function delete_all($section)
	{
		// determine the section index name
		$section = empty($section) ? '' : '.'.$section;

		// get the directory index
		$index = $this->redis->get($this->config['cache_id'].':dir:');
		is_null($index) or $index = $this->_unserialize($index);

		if (is_array($index))
		{
			if (!empty($section))
			{
				// limit the delete if we have a valid section
				$dirs = array();
				foreach ($index as $entry)
				{
					if ($entry == $section or strpos($entry, $section.'.') === 0)
					{
						$dirs[] = $entry;
					}
				}
			}
			else
			{
				// else delete the entire contents of the cache
				$dirs = $index;
			}

			// loop through the selected indexes
			foreach ($dirs as $dir)
			{
				// get the stored cache entries for this index
				$list = $this->redis->get($this->config['cache_id'].':index:'.$dir);
				if (is_null($list))
				{
					$list = array();
				}
				else
				{
					$list = $this->_unserialize($list);
				}

				// delete all stored keys
				foreach($list as $item)
				{
					$this->redis->del($item[0]);
				}

				// and delete the index itself
				$this->redis->del($this->config['cache_id'].':index:'.$dir);
			}

			// update the directory index
			$this->redis->set($this->config['cache_id'].':dir:', $this->_serialize(array_diff($index, $dirs)));
		}
	}

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

	/**
	 * Save a cache, this does the generic pre-processing
	 *
	 * @return	bool
	 */
	protected function _set()
	{
		// get the key for the cache identifier
		$key = $this->_get_key();

		// write the cache
		$this->redis->set($key, $this->prep_contents());
		if (!empty($this->expiration))
		{
			$this->redis->expireat($key, $this->expiration);
		}
	}

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

	/**
	 * Load a cache, this does the generic post-processing
	 *
	 * @return bool
	 */
	protected function _get()
	{
		// get the key for the cache identifier
		$key = $this->_get_key();

		// fetch the session data from the redis server
		$payload = $this->redis->get($key);
		try
		{
			$this->unprep_contents($payload);
		}
		catch(Cache_Exception $e)
		{

			return false;
		}

		return true;
	}

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

	/**
	 * get's the memcached key belonging to the cache identifier
	 *
	 * @access	private
	 * @param	bool		if true, remove the key retrieved from the index
	 * @return  string
	 */
	private function _get_key($remove = false)
	{
		// get the section name and identifier
		$sections = explode('.', $this->identifier);
		if (count($sections) > 1)
		{
			$identifier = array_pop($sections);
			$sections = '.'.implode('.', $sections);
		}
		else
		{
			$identifier = $this->identifier;
			$sections = '';
		}

		// get the cache index
		$index = $this->redis->get($this->config['cache_id'].':index:'.$sections);
		is_null($index) or $index = $this->_unserialize($index);

		// get the key from the index
		$key = isset($index[$identifier][0]) ? $index[$identifier][0] : false;

		if ($remove === true)
		{
			if ( $key !== false )
			{
				unset($index[$identifier]);
				$this->redis->set($this->config['cache_id'].':index:'.$sections, $this->_serialize($index));
			}
		}
		else
		{
			if ( $key === false )
			{
				// create a new key
				$key = $this->_new_key();

				if ( ! is_array($index))
				{
					// create a new index and store the key
					$this->redis->set($this->config['cache_id'].':index:'.$sections, $this->_serialize(array($identifier => array($key,$this->created))));
				}
				else
				{
					// add the key to the index
					$index[$identifier] = array($key,$this->created);
					$this->redis->set($this->config['cache_id'].':index:'.$sections, $this->_serialize($index));
				}

				// get the directory index
				$index = $this->redis->get($this->config['cache_id'].':dir:');
				is_null($index) or $index = $this->_unserialize($index);

				if (is_array($index))
				{
					if ( ! in_array($sections, $index))
					{
						$index[] = $sections;
					}
				}
				else
				{
					$index = array($sections);
				}

				// update the directory index
				$this->redis->set($this->config['cache_id'].':dir:', $this->_serialize($index));
			}
		}

		return $key;
	}

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

	/**
	 * generate a new unique key for the current identifier
	 *
	 * @access	private
	 * @return  string
	 */
	private function _new_key()
	{
		$key = '';
		while (strlen($key) < 32)
		{
			$key .= mt_rand(0, mt_getrandmax());
		}
		return $this->config['cache_id'].'_'.uniqid($key);
	}

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

	/**
	 * validate a driver config value
	 *
	 * @param	string	name of the config variable to validate
	 * @param	mixed	value
	 * @access	private
	 * @return  mixed
	 */
	private function _validate_config($name, $value)
	{
		switch ($name)
		{
			case 'database':
				// do we have a database config
				if ( empty($value) OR ! is_array($value))
				{
					$value = 'default';
				}
			break;

			case 'cache_id':
				if ( empty($value) OR ! is_string($value))
				{
					$value = 'fuel';
				}
			break;

			case 'expiration':
				if ( empty($value) OR ! is_numeric($value))
				{
					$value = null;
				}
			break;

			default:
			break;
		}

		return $value;
	}

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

	/**
	 * Serialize an array
	 *
	 * This function first converts any slashes found in the array to a temporary
	 * marker, so when it gets unserialized the slashes will be preserved
	 *
	 * @access	private
	 * @param	array
	 * @return	string
	 */
	protected function _serialize($data)
	{
		if (is_array($data))
		{
			foreach ($data as $key => $val)
			{
				if (is_string($val))
				{
					$data[$key] = str_replace('\\', '{{slash}}', $val);
				}
			}
		}
		else
		{
			if (is_string($data))
			{
				$data = str_replace('\\', '{{slash}}', $data);
			}
		}

		return serialize($data);
	}

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

	/**
	 * Unserialize
	 *
	 * This function unserializes a data string, then converts any
	 * temporary slash markers back to actual slashes
	 *
	 * @access	private
	 * @param	array
	 * @return	string
	 */
	protected function _unserialize($data)
	{
		$data = @unserialize(stripslashes($data));

		if (is_array($data))
		{
			foreach ($data as $key => $val)
			{
				if (is_string($val))
				{
					$data[$key] = str_replace('{{slash}}', '\\', $val);
				}
			}

			return $data;
		}

		return (is_string($data)) ? str_replace('{{slash}}', '\\', $data) : $data;
	}

}

/* End of file file.php */