include/utils/external_cache/SugarCache_Memcache.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 class SugarCache_Memcache extends SugarCache_ExternalAbstract
  40 {
  41     var $_memcache = null;
  42     var $_config = array(
  43         'host' => 'localhost',
  44         'port' => 11211,
  45     );
  46
  47     function SugarCache_Memcache()
  48     {
  49         $config = SugarConfig::getInstance();
  50         $this->_config['host'] = $config->get('external_cache.memcache.host', 'localhost');
  51         $this->_config['port'] = $config->get('external_cache.memcache.port', 11211);
  52     }
  53
  54     function init()
  55     {
  56         if (EXTERNAL_CACHE_DEBUG) {
  57             SugarCache::log('initializing memcache');
  58         }
  59         $this->_memcache = new Memcache();
  60         $status = @$this->_memcache->connect(
  61             $this->_config['host'],
  62             $this->_config['port']
  63         );
  64         if (!$status) {
  65             if (EXTERNAL_CACHE_DEBUG) {
  66                 SugarCache::log('initialization of memcache failed', 'fail');
  67             }
  68             $this->initialized = false;
  69             return;
  70         }
  71         parent::init();
  72     }
  73
  74     function get($key)
  75     {
  76         $value = parent::get($key);
  77         if (!is_null($value)) {
  78             return $value;
  79         }
  80         if (EXTERNAL_CACHE_DEBUG) {
  81             SugarCache::log('grabbing via Memcache::get(' . $this->_realKey($key) . ')');
  82         }
  83         return $this->_processGet(
  84             $key,
  85             $this->_memcache->get(
  86                 $this->_realKey($key)
  87             )
  88         );
  89     }
  90
  91     function set($key, $value)
  92     {
  93         parent::set($key, $value);
  94
  95         // caching is turned off
  96         if(!$GLOBALS['external_cache_enabled']) {
  97             return;
  98         }
  99
 100         $external_key = $this->_realKey($key);
 101                 if (EXTERNAL_CACHE_DEBUG) {
 102             SugarCache::log("Step 3: Converting key ($key) to external key ($external_key)");
 103         }
 104
 105         $this->_memcache->set($external_key, $value, $this->timeout);
 106
 107         if (EXTERNAL_CACHE_DEBUG) {
 108             SugarCache::log("Step 4: Added key to memcache cache {$external_key} with value ($value) to be stored for ".EXTERNAL_CACHE_INTERVAL_SECONDS." seconds");
 109         }
 110     }
 111
 112     function __unset($key)
 113     {
 114         parent::__unset($key);
 115         $this->_memcache->delete($this->_realKey($key));
 116     }
 117 }
 118