include/SugarCache/SugarCacheMemcached.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2012 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 class SugarCacheMemcached extends SugarCacheAbstract
  41 {
  42     /**
  43      * @var Memcache server name string
  44      */
  45     protected $_host = '127.0.0.1';
  46
  47     /**
  48      * @var Memcache server port int
  49      */
  50     protected $_port = 11211;
  51
  52     /**
  53      * @var Memcached object
  54      */
  55     protected $_memcached = '';
  56
  57     /**
  58      * @see SugarCacheAbstract::$_priority
  59      */
  60     protected $_priority = 900;
  61
  62     /**
  63      * @see SugarCacheAbstract::useBackend()
  64      */
  65     public function useBackend()
  66     {
  67         if ( extension_loaded('memcached')
  68                 && empty($GLOBALS['sugar_config']['external_cache_disabled_memcached'])
  69                 && $this->_getMemcachedObject() )
  70             return true;
  71
  72         return false;
  73     }
  74
  75     /**
  76      * @see SugarCacheAbstract::__construct()
  77      */
  78     public function __construct()
  79     {
  80         parent::__construct();
  81     }
  82
  83     /**
  84      * Get the memcached object; initialize if needed
  85      */
  86     protected function _getMemcachedObject()
  87     {
  88         if ( !($this->_memcached instanceOf Memcached) ) {
  89             $this->_memcached = new Memcached();
  90             $this->_host = SugarConfig::getInstance()->get('external_cache.memcache.host', $this->_host);
  91             $this->_port = SugarConfig::getInstance()->get('external_cache.memcache.port', $this->_port);
  92             if ( !@$this->_memcached->addServer($this->_host,$this->_port) ) {
  93                 return false;
  94             }
  95         }
  96
  97         return $this->_memcached;
  98     }
  99
 100     /**
 101      * @see SugarCacheAbstract::_setExternal()
 102      */
 103     protected function _setExternal(
 104         $key,
 105         $value
 106         )
 107     {
 108         $this->_getMemcachedObject()->set($key, $value, $this->_expireTimeout);
 109     }
 110
 111     /**
 112      * @see SugarCacheAbstract::_getExternal()
 113      */
 114     protected function _getExternal(
 115         $key
 116         )
 117     {
 118         $returnValue = $this->_getMemcachedObject()->get($key);
 119         if ( $this->_getMemcachedObject()->getResultCode() != Memcached::RES_SUCCESS ) {
 120             return null;
 121         }
 122
 123         return $returnValue;
 124     }
 125
 126     /**
 127      * @see SugarCacheAbstract::_clearExternal()
 128      */
 129     protected function _clearExternal(
 130         $key
 131         )
 132     {
 133         $this->_getMemcachedObject()->delete($key);
 134     }
 135
 136     /**
 137      * @see SugarCacheAbstract::_resetExternal()
 138      */
 139     protected function _resetExternal()
 140     {
 141         $this->_getMemcachedObject()->flush();
 142     }
 143 }