2 /*********************************************************************************
3 * SugarCRM Community Edition is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2012 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');
40 class SugarCacheMemcache extends SugarCacheAbstract
43 * @var Memcache server name string
45 protected $_host = '127.0.0.1';
48 * @var Memcache server port int
50 protected $_port = 11211;
53 * @var Memcache object
55 protected $_memcache = '';
58 * @see SugarCacheAbstract::$_priority
60 protected $_priority = 900;
63 * Minimal data size to be compressed
66 protected $min_compress = 512;
68 * @see SugarCacheAbstract::useBackend()
70 public function useBackend()
72 if ( extension_loaded('memcache')
73 && empty($GLOBALS['sugar_config']['external_cache_disabled_memcache'])
74 && $this->_getMemcacheObject() )
81 * @see SugarCacheAbstract::__construct()
83 public function __construct()
85 parent::__construct();
89 * Get the memcache object; initialize if needed
91 protected function _getMemcacheObject()
93 if ( !($this->_memcache instanceOf Memcache) ) {
94 $this->_memcache = new Memcache();
95 $config = SugarConfig::getInstance();
96 $this->_host = $config->get('external_cache.memcache.host', $this->_host);
97 $this->_port = $config->get('external_cache.memcache.port', $this->_port);
98 if ( !@$this->_memcache->connect($this->_host,$this->_port) ) {
101 if($config->get('external_cache.memcache.disable_compression', false)) {
102 $this->_memcache->setCompressThreshold($config->get('external_cache.memcache.min_compression', $this->min_compress));
104 $this->_memcache->setCompressThreshold(0);
108 return $this->_memcache;
112 * @see SugarCacheAbstract::_setExternal()
114 protected function _setExternal(
119 $this->_getMemcacheObject()->set($key, $value, 0, $this->_expireTimeout);
123 * @see SugarCacheAbstract::_getExternal()
125 protected function _getExternal(
129 $returnValue = $this->_getMemcacheObject()->get($key);
130 if ( $returnValue === false ) {
138 * @see SugarCacheAbstract::_clearExternal()
140 protected function _clearExternal(
144 $this->_getMemcacheObject()->delete($key);
148 * @see SugarCacheAbstract::_resetExternal()
150 protected function _resetExternal()
152 $this->_getMemcacheObject()->flush();