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