3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This caching provider stores all cached items as a "group" in the
20 * "civicrm_cache" table. The entire 'group' may be prefetched when
21 * instantiating the cache provider.
23 class CRM_Utils_Cache_SqlGroup
implements CRM_Utils_Cache_Interface
{
26 const DEFAULT_TTL
= 21600;
28 const TS_FMT
= 'Y-m-d H:i:s';
29 // TODO Consider native implementation.
30 use CRM_Utils_Cache_NaiveMultipleTrait
;
33 * The host name of the memcached server.
42 protected $componentID;
45 * In-memory cache to optimize redundant get()s.
49 protected $valueCache;
52 * In-memory cache to optimize redundant get()s.
55 * Note: expiresCache[$key]===NULL means cache-miss
57 protected $expiresCache;
69 * @param array $config
70 * An array of configuration params.
73 * - prefetch: bool, whether to preemptively read the entire cache group; default: TRUE
75 * @throws RuntimeException
76 * @return \CRM_Utils_Cache_SqlGroup
78 public function __construct($config) {
79 $this->table
= CRM_Core_DAO_Cache
::getTableName();
80 if (isset($config['group'])) {
81 $this->group
= $config['group'];
84 throw new RuntimeException("Cannot construct SqlGroup cache: missing group");
86 if (isset($config['componentID'])) {
87 $this->componentID
= $config['componentID'];
90 $this->componentID
= NULL;
92 $this->valueCache
= [];
93 if (CRM_Utils_Array
::value('prefetch', $config, TRUE)) {
100 * @param mixed $value
101 * @param null|int|\DateInterval $ttl
104 public function set($key, $value, $ttl = NULL) {
105 CRM_Utils_Cache
::assertValidKey($key);
107 $lock = Civi
::lockManager()->acquire("cache.{$this->group}_{$key}._null");
108 if (!$lock->isAcquired()) {
109 throw new \
CRM_Utils_Cache_CacheException("SqlGroup: Failed to acquire lock on cache key.");
112 if (is_int($ttl) && $ttl <= 0) {
113 return $this->delete($key);
116 $dataExists = CRM_Core_DAO
::singleValueQuery("SELECT COUNT(*) FROM {$this->table} WHERE {$this->where($key)}");
117 $expires = round(microtime(1)) + CRM_Utils_Date
::convertCacheTtl($ttl, self
::DEFAULT_TTL
);
119 $dataSerialized = CRM_Core_BAO_Cache
::encode($value);
121 // This table has a wonky index, so we cannot use REPLACE or
122 // "INSERT ... ON DUPE". Instead, use SELECT+(INSERT|UPDATE).
124 $sql = "UPDATE {$this->table} SET data = %1, created_date = FROM_UNIXTIME(%2), expired_date = FROM_UNIXTIME(%3) WHERE {$this->where($key)}";
126 1 => [$dataSerialized, 'String'],
127 2 => [time(), 'Positive'],
128 3 => [$expires, 'Positive'],
130 $dao = CRM_Core_DAO
::executeQuery($sql, $args, FALSE, NULL, FALSE, FALSE);
133 $sql = "INSERT INTO {$this->table} (group_name,path,data,created_date,expired_date) VALUES (%1,%2,%3,FROM_UNIXTIME(%4),FROM_UNIXTIME(%5))";
135 1 => [$this->group
, 'String'],
136 2 => [$key, 'String'],
137 3 => [$dataSerialized, 'String'],
138 4 => [time(), 'Positive'],
139 5 => [$expires, 'Positive'],
141 $dao = CRM_Core_DAO
::executeQuery($sql, $args, FALSE, NULL, FALSE, FALSE);
146 $this->valueCache
[$key] = CRM_Core_BAO_Cache
::decode($dataSerialized);
147 $this->expiresCache
[$key] = $expires;
153 * @param mixed $default
157 public function get($key, $default = NULL) {
158 CRM_Utils_Cache
::assertValidKey($key);
159 if (!isset($this->expiresCache
[$key]) ||
time() >= $this->expiresCache
[$key]) {
160 $sql = "SELECT path, data, UNIX_TIMESTAMP(expired_date) as expires FROM {$this->table} WHERE " . $this->where($key);
161 $dao = CRM_Core_DAO
::executeQuery($sql);
162 while ($dao->fetch()) {
163 $this->expiresCache
[$key] = $dao->expires
;
164 $this->valueCache
[$key] = CRM_Core_BAO_Cache
::decode($dao->data
);
167 return (isset($this->expiresCache
[$key]) && time() < $this->expiresCache
[$key]) ?
$this->reobjectify($this->valueCache
[$key]) : $default;
170 private function reobjectify($value) {
171 return is_object($value) ?
unserialize(serialize($value)) : $value;
176 * @param null $default
180 public function getFromFrontCache($key, $default = NULL) {
181 if (isset($this->expiresCache
[$key]) && time() < $this->expiresCache
[$key] && $this->valueCache
[$key]) {
182 return $this->reobjectify($this->valueCache
[$key]);
189 public function has($key) {
191 return isset($this->expiresCache
[$key]) && time() < $this->expiresCache
[$key];
198 public function delete($key) {
199 CRM_Utils_Cache
::assertValidKey($key);
200 // If we are triggering a deletion of a prevNextCache key in the civicrm_cache tabl
201 // Alssure that the relevant prev_next_cache values are also removed.
202 if ($this->group
== CRM_Utils_Cache
::cleanKey('CiviCRM Search PrevNextCache')) {
203 Civi
::service('prevnext')->deleteItem(NULL, $key);
205 CRM_Core_DAO
::executeQuery("DELETE FROM {$this->table} WHERE {$this->where($key)}");
206 unset($this->valueCache
[$key]);
207 unset($this->expiresCache
[$key]);
211 public function flush() {
212 if ($this->group
== CRM_Utils_Cache
::cleanKey('CiviCRM Search PrevNextCache') &&
213 Civi
::service('prevnext') instanceof CRM_Core_PrevNextCache_Sql
) {
214 Civi
::service('prevnext')->cleanup();
217 CRM_Core_DAO
::executeQuery("DELETE FROM {$this->table} WHERE {$this->where()}");
219 $this->valueCache
= [];
220 $this->expiresCache
= [];
224 public function clear() {
225 return $this->flush();
228 public function prefetch() {
229 $dao = CRM_Core_DAO
::executeQuery("SELECT path, data, UNIX_TIMESTAMP(expired_date) AS expires FROM {$this->table} WHERE " . $this->where(NULL));
230 $this->valueCache
= [];
231 $this->expiresCache
= [];
232 while ($dao->fetch()) {
233 $this->valueCache
[$dao->path
] = CRM_Core_BAO_Cache
::decode($dao->data
);
234 $this->expiresCache
[$dao->path
] = $dao->expires
;
238 protected function where($path = NULL) {
240 $clauses[] = ('group_name = "' . CRM_Core_DAO
::escapeString($this->group
) . '"');
242 $clauses[] = ('path = "' . CRM_Core_DAO
::escapeString($path) . '"');
244 return $clauses ?
implode(' AND ', $clauses) : '(1)';