2 /*********************************************************************************
3 * SugarCRM Community Edition is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
6 * This program is free software; you can redistribute it and/or modify it under
7 * the terms of the GNU Affero General Public License version 3 as published by the
8 * Free Software Foundation with the addition of the following permission added
9 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
10 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
11 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
18 * You should have received a copy of the GNU Affero General Public License along with
19 * this program; if not, see http://www.gnu.org/licenses or write to the Free
20 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
24 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
26 * The interactive user interfaces in modified source and object code versions
27 * of this program must display Appropriate Legal Notices, as required under
28 * Section 5 of the GNU Affero General Public License version 3.
30 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
31 * these Appropriate Legal Notices must retain the display of the "Powered by
32 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
33 * technical reasons, the Appropriate Legal Notices must display the words
34 * "Powered by SugarCRM".
35 ********************************************************************************/
38 require_once('include/SugarCache/SugarCacheAbstract.php');
41 * Redis SugarCache backend, using the PHP Redis C library at http://github.com/nicolasff/phpredis
43 class SugarCacheRedis extends SugarCacheAbstract
46 * @var Redis server name string
48 protected $_host = 'localhost';
51 * @var Redis server port int
53 protected $_port = 6379;
58 protected $_redis = null;
61 * @see SugarCacheAbstract::$_priority
63 protected $_priority = 920;
66 * @see SugarCacheAbstract::useBackend()
68 public function useBackend()
70 if ( !parent::useBackend() )
73 if ( extension_loaded("redis")
74 && empty($GLOBALS['sugar_config']['external_cache_disabled_redis'])
75 && $this->_getRedisObject() )
82 * @see SugarCacheAbstract::__construct()
84 public function __construct()
86 parent::__construct();
90 * Get the memcache object; initialize if needed
92 protected function _getRedisObject()
95 if ( !($this->_redis instanceOf Redis) ) {
96 $this->_redis = new Redis();
97 $this->_host = SugarConfig::getInstance()->get('external_cache.redis.host', $this->_host);
98 $this->_port = SugarConfig::getInstance()->get('external_cache.redis.port', $this->_port);
99 if ( !$this->_redis->connect($this->_host,$this->_port) ) {
104 catch (RedisException $e)
109 return $this->_redis;
113 * @see SugarCacheAbstract::_setExternal()
115 protected function _setExternal(
120 $value = serialize($value);
121 $key = $this->_fixKeyName($key);
123 $this->_getRedisObject()->set($key,$value);
124 $this->_getRedisObject()->expire($key, $this->expireTimeout);
128 * @see SugarCacheAbstract::_getExternal()
130 protected function _getExternal(
134 $key = $this->_fixKeyName($key);
135 $returnValue = $this->_getRedisObject()->get($key);
136 // return null if we don't get a cache hit
137 if ( $returnValue === false ) {
141 return is_string($returnValue) ?
142 unserialize($returnValue) :
147 * @see SugarCacheAbstract::_clearExternal()
149 protected function _clearExternal(
153 $key = $this->_fixKeyName($key);
154 $this->_getRedisObject()->delete($key);
158 * @see SugarCacheAbstract::_resetExternal()
160 protected function _resetExternal()
162 $this->_getRedisObject()->flushAll();
166 * Fixed the key naming used so we don't have any spaces
169 * @return string fixed key name
171 protected function _fixKeyName($key)
173 return str_replace(' ','_',$key);