CRM/Utils/Cache/Redis.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  * $Id$
  33  *
  34  */
  35 class CRM_Utils_Cache_Redis implements CRM_Utils_Cache_Interface {
  36   const DEFAULT_HOST    = 'localhost';
  37   const DEFAULT_PORT    = 6379;
  38   const DEFAULT_TIMEOUT = 3600;
  39   const DEFAULT_PREFIX  = '';
  40
  41   /**
  42    * The host name of the redisd server
  43    *
  44    * @var string
  45    */
  46   protected $_host = self::DEFAULT_HOST;
  47
  48   /**
  49    * The port on which to connect on
  50    *
  51    * @var int
  52    */
  53   protected $_port = self::DEFAULT_PORT;
  54
  55   /**
  56    * The default timeout to use
  57    *
  58    * @var int
  59    */
  60   protected $_timeout = self::DEFAULT_TIMEOUT;
  61
  62   /**
  63    * The prefix prepended to cache keys.
  64    *
  65    * If we are using the same redis instance for multiple CiviCRM
  66    * installs, we must have a unique prefix for each install to prevent
  67    * the keys from clobbering each other.
  68    *
  69    * @var string
  70    */
  71   protected $_prefix = self::DEFAULT_PREFIX;
  72
  73   /**
  74    * The actual redis object
  75    *
  76    * @var Redis
  77    */
  78   protected $_cache;
  79
  80   /**
  81    * Constructor
  82    *
  83    * @param array $config
  84    *   An array of configuration params.
  85    *
  86    * @return \CRM_Utils_Cache_Redis
  87    */
  88   public function __construct($config) {
  89     if (isset($config['host'])) {
  90       $this->_host = $config['host'];
  91     }
  92     if (isset($config['port'])) {
  93       $this->_port = $config['port'];
  94     }
  95     if (isset($config['timeout'])) {
  96       $this->_timeout = $config['timeout'];
  97     }
  98     if (isset($config['prefix'])) {
  99       $this->_prefix = $config['prefix'];
 100     }
 101
 102     $this->_cache = new Redis();
 103     if (!$this->_cache->connect($this->_host, $this->_port)) {
 104       // dont use fatal here since we can go in an infinite loop
 105       echo 'Could not connect to redisd server';
 106       CRM_Utils_System::civiExit();
 107     }
 108     if (CRM_Utils_Constant::value('CIVICRM_DB_CACHE_PASSWORD')) {
 109       $this->_cache->auth(CIVICRM_DB_CACHE_PASSWORD);
 110     }
 111   }
 112
 113   /**
 114    * @param $key
 115    * @param $value
 116    *
 117    * @return bool
 118    * @throws Exception
 119    */
 120   public function set($key, &$value) {
 121     if (!$this->_cache->set($this->_prefix . $key, serialize($value), $this->_timeout)) {
 122       if (PHP_SAPI === 'cli' || (Civi\Core\Container::isContainerBooted() && CRM_Core_Permission::check('view debug output'))) {
 123         CRM_Core_Error::fatal("Redis set ($key) failed: " . $this->_cache->getLastError());
 124       }
 125       else {
 126         Civi::log()->error("Redis set ($key) failed: " . $this->_cache->getLastError());
 127         CRM_Core_Error::fatal("Redis set ($key) failed");
 128       }
 129       return FALSE;
 130     }
 131     return TRUE;
 132   }
 133
 134   /**
 135    * @param $key
 136    * @param mixed $default
 137    *
 138    * @return mixed
 139    */
 140   public function get($key, $default = NULL) {
 141     $result = $this->_cache->get($this->_prefix . $key);
 142     return ($result === FALSE) ? $default : unserialize($result);
 143   }
 144
 145   /**
 146    * @param $key
 147    *
 148    * @return mixed
 149    */
 150   public function delete($key) {
 151     return $this->_cache->delete($this->_prefix . $key);
 152   }
 153
 154   /**
 155    * @return mixed
 156    */
 157   public function flush() {
 158     // FIXME: Ideally, we'd map each prefix to a different 'hash' object in Redis,
 159     // and this would be simpler. However, that needs to go in tandem with a
 160     // more general rethink of cache expiration/TTL.
 161
 162     $keys = $this->_cache->keys($this->_prefix . '*');
 163     return $this->_cache->del($keys);
 164   }
 165
 166 }