CRM/Utils/Cache/Memcached.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Utils_Cache_Memcached {
  36   const DEFAULT_HOST = 'localhost';
  37   const DEFAULT_PORT = 11211;
  38   const DEFAULT_TIMEOUT = 3600;
  39   const DEFAULT_PREFIX = '';
  40   const MAX_KEY_LEN = 62;
  41
  42   /**
  43    * The host name of the memcached server
  44    *
  45    * @var string
  46    */
  47   protected $_host = self::DEFAULT_HOST;
  48
  49   /**
  50    * The port on which to connect on
  51    *
  52    * @var int
  53    */
  54   protected $_port = self::DEFAULT_PORT;
  55
  56   /**
  57    * The default timeout to use
  58    *
  59    * @var int
  60    */
  61   protected $_timeout = self::DEFAULT_TIMEOUT;
  62
  63   /**
  64    * The prefix prepended to cache keys.
  65    *
  66    * If we are using the same memcache instance for multiple CiviCRM
  67    * installs, we must have a unique prefix for each install to prevent
  68    * the keys from clobbering each other.
  69    *
  70    * @var string
  71    */
  72   protected $_prefix = self::DEFAULT_PREFIX;
  73
  74   /**
  75    * The actual memcache object.
  76    *
  77    * @var resource
  78    */
  79   protected $_cache;
  80
  81   /**
  82    * Constructor.
  83    *
  84    * @param array $config
  85    *   An array of configuration params.
  86    *
  87    * @return \CRM_Utils_Cache_Memcached
  88    */
  89   public function __construct($config) {
  90     if (isset($config['host'])) {
  91       $this->_host = $config['host'];
  92     }
  93     if (isset($config['port'])) {
  94       $this->_port = $config['port'];
  95     }
  96     if (isset($config['timeout'])) {
  97       $this->_timeout = $config['timeout'];
  98     }
  99     if (isset($config['prefix'])) {
 100       $this->_prefix = $config['prefix'];
 101     }
 102
 103     $this->_cache = new Memcached();
 104
 105     if (!$this->_cache->addServer($this->_host, $this->_port)) {
 106       // dont use fatal here since we can go in an infinite loop
 107       echo 'Could not connect to Memcached server';
 108       CRM_Utils_System::civiExit();
 109     }
 110   }
 111
 112   /**
 113    * @param $key
 114    * @param $value
 115    *
 116    * @return bool
 117    * @throws Exception
 118    */
 119   public function set($key, &$value) {
 120     $key = $this->cleanKey($key);
 121     if (!$this->_cache->set($key, $value, $this->_timeout)) {
 122       CRM_Core_Error::debug('Result Code: ', $this->_cache->getResultMessage());
 123       CRM_Core_Error::fatal("memcached set failed, wondering why?, $key", $value);
 124       return FALSE;
 125     }
 126     return TRUE;
 127   }
 128
 129   /**
 130    * @param $key
 131    *
 132    * @return mixed
 133    */
 134   public function &get($key) {
 135     $key = $this->cleanKey($key);
 136     $result = $this->_cache->get($key);
 137     return $result;
 138   }
 139
 140   /**
 141    * @param $key
 142    *
 143    * @return mixed
 144    */
 145   public function delete($key) {
 146     $key = $this->cleanKey($key);
 147     return $this->_cache->delete($key);
 148   }
 149
 150   /**
 151    * @param $key
 152    *
 153    * @return mixed|string
 154    */
 155   public function cleanKey($key) {
 156     $key = preg_replace('/\s+|\W+/', '_', $this->_prefix . $key);
 157     if (strlen($key) > self::MAX_KEY_LEN) {
 158       $md5Key = md5($key);  // this should be 32 characters in length
 159       $subKeyLen = self::MAX_KEY_LEN - 1 - strlen($md5Key);
 160       $key = substr($key, 0, $subKeyLen) . "_" . $md5Key;
 161     }
 162     return $key;
 163   }
 164
 165   /**
 166    * @return mixed
 167    */
 168   public function flush() {
 169     return $this->_cache->flush();
 170   }
 171
 172 }