include/SugarCache/SugarCacheRedis.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   5  *
   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.
  12  *
  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
  16  * details.
  17  *
  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
  21  * 02110-1301 USA.
  22  *
  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.
  25  *
  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.
  29  *
  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  ********************************************************************************/
  36
  37
  38 require_once('include/SugarCache/SugarCacheAbstract.php');
  39
  40 /**
  41  * Redis SugarCache backend, using the PHP Redis C library at http://github.com/nicolasff/phpredis
  42  */
  43 class SugarCacheRedis extends SugarCacheAbstract
  44 {
  45     /**
  46      * @var Redis server name string
  47      */
  48     protected $_host = 'localhost';
  49
  50     /**
  51      * @var Redis server port int
  52      */
  53     protected $_port = 6379;
  54
  55     /**
  56      * @var Redis object
  57      */
  58     protected $_redis = null;
  59
  60     /**
  61      * @see SugarCacheAbstract::$_priority
  62      */
  63     protected $_priority = 920;
  64
  65     /**
  66      * @see SugarCacheAbstract::useBackend()
  67      */
  68     public function useBackend()
  69     {
  70         if ( !parent::useBackend() )
  71             return false;
  72
  73         if ( extension_loaded("redis")
  74                 && empty($GLOBALS['sugar_config']['external_cache_disabled_redis'])
  75                 && $this->_getRedisObject() )
  76             return true;
  77
  78         return false;
  79     }
  80
  81     /**
  82      * @see SugarCacheAbstract::__construct()
  83      */
  84     public function __construct()
  85     {
  86         parent::__construct();
  87     }
  88
  89     /**
  90      * Get the memcache object; initialize if needed
  91      */
  92     protected function _getRedisObject()
  93     {
  94         try {
  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) ) {
 100                     return false;
 101                 }
 102             }
 103         }
 104         catch (RedisException $e)
 105         {
 106             return false;
 107         }
 108
 109         return $this->_redis;
 110     }
 111
 112     /**
 113      * @see SugarCacheAbstract::_setExternal()
 114      */
 115     protected function _setExternal(
 116         $key,
 117         $value
 118         )
 119     {
 120         $value = serialize($value);
 121         $key = $this->_fixKeyName($key);
 122
 123         $this->_getRedisObject()->set($key,$value);
 124         $this->_getRedisObject()->expire($key, $this->_expireTimeout);
 125     }
 126
 127     /**
 128      * @see SugarCacheAbstract::_getExternal()
 129      */
 130     protected function _getExternal(
 131         $key
 132         )
 133     {
 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 ) {
 138             return null;
 139         }
 140
 141         return is_string($returnValue) ?
 142             unserialize($returnValue) :
 143             $returnValue;
 144     }
 145
 146     /**
 147      * @see SugarCacheAbstract::_clearExternal()
 148      */
 149     protected function _clearExternal(
 150         $key
 151         )
 152     {
 153         $key = $this->_fixKeyName($key);
 154         $this->_getRedisObject()->delete($key);
 155     }
 156
 157     /**
 158      * @see SugarCacheAbstract::_resetExternal()
 159      */
 160     protected function _resetExternal()
 161     {
 162         $this->_getRedisObject()->flushAll();
 163     }
 164
 165     /**
 166      * Fixed the key naming used so we don't have any spaces
 167      *
 168      * @param  string $key
 169      * @return string fixed key name
 170      */
 171     protected function _fixKeyName($key)
 172     {
 173         return str_replace(' ','_',$key);
 174     }
 175 }