3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
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
= '';
42 * The host name of the redisd server
46 protected $_host = self
::DEFAULT_HOST
;
49 * The port on which to connect on
53 protected $_port = self
::DEFAULT_PORT
;
56 * The default timeout to use
60 protected $_timeout = self
::DEFAULT_TIMEOUT
;
63 * The prefix prepended to cache keys.
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.
71 protected $_prefix = self
::DEFAULT_PREFIX
;
74 * The actual redis object
83 * @param array $config
84 * An array of configuration params.
86 * @return \CRM_Utils_Cache_Redis
88 public function __construct($config) {
89 if (isset($config['host'])) {
90 $this->_host
= $config['host'];
92 if (isset($config['port'])) {
93 $this->_port
= $config['port'];
95 if (isset($config['timeout'])) {
96 $this->_timeout
= $config['timeout'];
98 if (isset($config['prefix'])) {
99 $this->_prefix
= $config['prefix'];
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();
108 if (CRM_Utils_Constant
::value('CIVICRM_DB_CACHE_PASSWORD')) {
109 $this->_cache
->auth(CIVICRM_DB_CACHE_PASSWORD
);
116 * @param null|int|\DateInterval $ttl
121 public function set($key, $value, $ttl = NULL) {
123 throw new \
RuntimeException("FIXME: " . __CLASS__
. "::set() should support non-NULL TTL");
125 if (!$this->_cache
->set($this->_prefix
. $key, serialize($value), $this->_timeout
)) {
126 if (PHP_SAPI
=== 'cli' ||
(Civi\Core\Container
::isContainerBooted() && CRM_Core_Permission
::check('view debug output'))) {
127 CRM_Core_Error
::fatal("Redis set ($key) failed: " . $this->_cache
->getLastError());
130 Civi
::log()->error("Redis set ($key) failed: " . $this->_cache
->getLastError());
131 CRM_Core_Error
::fatal("Redis set ($key) failed");
140 * @param mixed $default
144 public function get($key, $default = NULL) {
145 $result = $this->_cache
->get($this->_prefix
. $key);
146 return ($result === FALSE) ?
$default : unserialize($result);
154 public function delete($key) {
155 return $this->_cache
->delete($this->_prefix
. $key);
161 public function flush() {
162 // FIXME: Ideally, we'd map each prefix to a different 'hash' object in Redis,
163 // and this would be simpler. However, that needs to go in tandem with a
164 // more general rethink of cache expiration/TTL.
166 $keys = $this->_cache
->keys($this->_prefix
. '*');
167 return $this->_cache
->del($keys);