CRM/Utils/Cache/SqlGroup.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  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.
  22  */
  23 class CRM_Utils_Cache_SqlGroup implements CRM_Utils_Cache_Interface {
  24
  25   // 6*60*60
  26   const DEFAULT_TTL = 21600;
  27
  28   const TS_FMT = 'Y-m-d H:i:s';
  29   // TODO Consider native implementation.
  30   use CRM_Utils_Cache_NaiveMultipleTrait;
  31
  32   /**
  33    * The host name of the memcached server.
  34    *
  35    * @var string
  36    */
  37   protected $group;
  38
  39   /**
  40    * @var int
  41    */
  42   protected $componentID;
  43
  44   /**
  45    * In-memory cache to optimize redundant get()s.
  46    *
  47    * @var array
  48    */
  49   protected $valueCache;
  50
  51   /**
  52    * In-memory cache to optimize redundant get()s.
  53    *
  54    * @var array
  55    *   Note: expiresCache[$key]===NULL means cache-miss
  56    */
  57   protected $expiresCache;
  58
  59   /**
  60    * Table.
  61    *
  62    * @var string
  63    */
  64   protected $table;
  65
  66   /**
  67    * Constructor.
  68    *
  69    * @param array $config
  70    *   An array of configuration params.
  71    *   - group: string
  72    *   - componentID: int
  73    *   - prefetch: bool, whether to preemptively read the entire cache group; default: TRUE
  74    *
  75    * @throws RuntimeException
  76    * @return \CRM_Utils_Cache_SqlGroup
  77    */
  78   public function __construct($config) {
  79     $this->table = CRM_Core_DAO_Cache::getTableName();
  80     if (isset($config['group'])) {
  81       $this->group = $config['group'];
  82     }
  83     else {
  84       throw new RuntimeException("Cannot construct SqlGroup cache: missing group");
  85     }
  86     if (isset($config['componentID'])) {
  87       $this->componentID = $config['componentID'];
  88     }
  89     else {
  90       $this->componentID = NULL;
  91     }
  92     $this->valueCache = [];
  93     if (CRM_Utils_Array::value('prefetch', $config, TRUE)) {
  94       $this->prefetch();
  95     }
  96   }
  97
  98   /**
  99    * @param string $key
 100    * @param mixed $value
 101    * @param null|int|\DateInterval $ttl
 102    *
 103    * @return bool
 104    *
 105    * @throws \CRM_Core_Exception
 106    * @throws \CRM_Utils_Cache_CacheException
 107    * @throws \CRM_Utils_Cache_InvalidArgumentException
 108    */
 109   public function set($key, $value, $ttl = NULL) {
 110     CRM_Utils_Cache::assertValidKey($key);
 111
 112     $lock = Civi::lockManager()->acquire("cache.{$this->group}_{$key}._null");
 113     if (!$lock->isAcquired()) {
 114       throw new \CRM_Utils_Cache_CacheException("SqlGroup: Failed to acquire lock on cache key.");
 115     }
 116
 117     if (is_int($ttl) && $ttl <= 0) {
 118       return $this->delete($key);
 119     }
 120
 121     $dataExists = CRM_Core_DAO::singleValueQuery("SELECT COUNT(*) FROM {$this->table} WHERE {$this->where($key)}");
 122     $expires = round(microtime(1)) + CRM_Utils_Date::convertCacheTtl($ttl, self::DEFAULT_TTL);
 123
 124     $dataSerialized = CRM_Core_BAO_Cache::encode($value);
 125
 126     // This table has a wonky index, so we cannot use REPLACE or
 127     // "INSERT ... ON DUPE". Instead, use SELECT+(INSERT|UPDATE).
 128     if ($dataExists) {
 129       $sql = "UPDATE {$this->table} SET data = %1, created_date = FROM_UNIXTIME(%2), expired_date = FROM_UNIXTIME(%3) WHERE {$this->where($key)}";
 130       $args = [
 131         1 => [$dataSerialized, 'String'],
 132         2 => [time(), 'Positive'],
 133         3 => [$expires, 'Positive'],
 134       ];
 135       CRM_Core_DAO::executeQuery($sql, $args, TRUE, NULL, FALSE, FALSE);
 136     }
 137     else {
 138       $sql = "INSERT INTO {$this->table} (group_name,path,data,created_date,expired_date) VALUES (%1,%2,%3,FROM_UNIXTIME(%4),FROM_UNIXTIME(%5))";
 139       $args = [
 140         1 => [(string) $this->group, 'String'],
 141         2 => [$key, 'String'],
 142         3 => [$dataSerialized, 'String'],
 143         4 => [time(), 'Positive'],
 144         5 => [$expires, 'Positive'],
 145       ];
 146       CRM_Core_DAO::executeQuery($sql, $args, TRUE, NULL, FALSE, FALSE);
 147     }
 148
 149     $lock->release();
 150
 151     $this->valueCache[$key] = CRM_Core_BAO_Cache::decode($dataSerialized);
 152     $this->expiresCache[$key] = $expires;
 153     return TRUE;
 154   }
 155
 156   /**
 157    * @param string $key
 158    * @param mixed $default
 159    *
 160    * @return mixed
 161    *
 162    * @throws \CRM_Utils_Cache_InvalidArgumentException
 163    */
 164   public function get($key, $default = NULL) {
 165     CRM_Utils_Cache::assertValidKey($key);
 166     if (!isset($this->expiresCache[$key]) || time() >= $this->expiresCache[$key]) {
 167       $sql = "SELECT path, data, UNIX_TIMESTAMP(expired_date) as expires FROM {$this->table} WHERE " . $this->where($key);
 168       $dao = CRM_Core_DAO::executeQuery($sql);
 169       while ($dao->fetch()) {
 170         $this->expiresCache[$key] = $dao->expires;
 171         $this->valueCache[$key] = CRM_Core_BAO_Cache::decode($dao->data);
 172       }
 173     }
 174     return (isset($this->expiresCache[$key]) && time() < $this->expiresCache[$key]) ? $this->reobjectify($this->valueCache[$key]) : $default;
 175   }
 176
 177   /**
 178    * @param mixed $value
 179    *
 180    * @return object
 181    */
 182   private function reobjectify($value) {
 183     return is_object($value) ? unserialize(serialize($value)) : $value;
 184   }
 185
 186   /**
 187    * @param string $key
 188    * @param null $default
 189    *
 190    * @return mixed
 191    */
 192   public function getFromFrontCache($key, $default = NULL) {
 193     if (isset($this->expiresCache[$key]) && time() < $this->expiresCache[$key] && $this->valueCache[$key]) {
 194       return $this->reobjectify($this->valueCache[$key]);
 195     }
 196     else {
 197       return $default;
 198     }
 199   }
 200
 201   public function has($key) {
 202     $this->get($key);
 203     return isset($this->expiresCache[$key]) && time() < $this->expiresCache[$key];
 204   }
 205
 206   /**
 207    * @param string $key
 208    *
 209    * @return bool
 210    * @throws \CRM_Utils_Cache_InvalidArgumentException
 211    */
 212   public function delete($key) {
 213     CRM_Utils_Cache::assertValidKey($key);
 214     // If we are triggering a deletion of a prevNextCache key in the civicrm_cache tabl
 215     // Alssure that the relevant prev_next_cache values are also removed.
 216     if ($this->group == CRM_Utils_Cache::cleanKey('CiviCRM Search PrevNextCache')) {
 217       Civi::service('prevnext')->deleteItem(NULL, $key);
 218     }
 219     CRM_Core_DAO::executeQuery("DELETE FROM {$this->table} WHERE {$this->where($key)}");
 220     unset($this->valueCache[$key]);
 221     unset($this->expiresCache[$key]);
 222     return TRUE;
 223   }
 224
 225   public function flush() {
 226     if ($this->group == CRM_Utils_Cache::cleanKey('CiviCRM Search PrevNextCache') &&
 227       Civi::service('prevnext') instanceof CRM_Core_PrevNextCache_Sql) {
 228       Civi::service('prevnext')->cleanup();
 229     }
 230     else {
 231       CRM_Core_DAO::executeQuery("DELETE FROM {$this->table} WHERE {$this->where()}");
 232     }
 233     $this->valueCache = [];
 234     $this->expiresCache = [];
 235     return TRUE;
 236   }
 237
 238   public function clear() {
 239     return $this->flush();
 240   }
 241
 242   public function prefetch() {
 243     $dao = CRM_Core_DAO::executeQuery("SELECT path, data, UNIX_TIMESTAMP(expired_date) AS expires FROM {$this->table} WHERE " . $this->where(NULL));
 244     $this->valueCache = [];
 245     $this->expiresCache = [];
 246     while ($dao->fetch()) {
 247       $this->valueCache[$dao->path] = CRM_Core_BAO_Cache::decode($dao->data);
 248       $this->expiresCache[$dao->path] = $dao->expires;
 249     }
 250   }
 251
 252   protected function where($path = NULL) {
 253     $clauses = [];
 254     $clauses[] = ('group_name = "' . CRM_Core_DAO::escapeString($this->group) . '"');
 255     if ($path) {
 256       $clauses[] = ('path = "' . CRM_Core_DAO::escapeString($path) . '"');
 257     }
 258     return $clauses ? implode(' AND ', $clauses) : '(1)';
 259   }
 260
 261 }