CRM/Utils/Cache/SqlGroup.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  */
  33
  34 /**
  35  * This caching provider stores all cached items as a "group" in the
  36  * "civicrm_cache" table. The entire 'group' may be prefetched when
  37  * instantiating the cache provider.
  38  */
  39 class CRM_Utils_Cache_SqlGroup implements CRM_Utils_Cache_Interface {
  40
  41   /**
  42    * The host name of the memcached server.
  43    *
  44    * @var string
  45    */
  46   protected $group;
  47
  48   /**
  49    * @var int $componentID The optional component ID (so componenets can share the same name space)
  50    */
  51   protected $componentID;
  52
  53   /**
  54    * @var array in-memory cache to optimize redundant get()s
  55    */
  56   protected $frontCache;
  57
  58   /**
  59    * Constructor.
  60    *
  61    * @param array $config
  62    *   An array of configuration params.
  63    *   - group: string
  64    *   - componentID: int
  65    *   - prefetch: bool, whether to preemptively read the entire cache group; default: TRUE
  66    *
  67    * @throws RuntimeException
  68    * @return \CRM_Utils_Cache_SqlGroup
  69    */
  70   public function __construct($config) {
  71     if (isset($config['group'])) {
  72       $this->group = $config['group'];
  73     }
  74     else {
  75       throw new RuntimeException("Cannot construct SqlGroup cache: missing group");
  76     }
  77     if (isset($config['componentID'])) {
  78       $this->componentID = $config['componentID'];
  79     }
  80     else {
  81       $this->componentID = NULL;
  82     }
  83     $this->frontCache = array();
  84     if (CRM_Utils_Array::value('prefetch', $config, TRUE)) {
  85       $this->prefetch();
  86     }
  87   }
  88
  89   /**
  90    * @param string $key
  91    * @param mixed $value
  92    * @param null|int|\DateInterval $ttl
  93    * @return bool
  94    */
  95   public function set($key, $value, $ttl = NULL) {
  96     if ($ttl !== NULL) {
  97       throw new \RuntimeException("FIXME: " . __CLASS__ . "::set() should support non-NULL TTL");
  98     }
  99     CRM_Core_BAO_Cache::setItem($value, $this->group, $key, $this->componentID);
 100     $this->frontCache[$key] = $value;
 101     return TRUE;
 102   }
 103
 104   /**
 105    * @param string $key
 106    * @param mixed $default
 107    *
 108    * @return mixed
 109    */
 110   public function get($key, $default = NULL) {
 111     if ($default !== NULL) {
 112       throw new \RuntimeException("FIXME: " . __CLASS__ . "::get() only supports NULL default");
 113     }
 114     if (!array_key_exists($key, $this->frontCache)) {
 115       $this->frontCache[$key] = CRM_Core_BAO_Cache::getItem($this->group, $key, $this->componentID);
 116     }
 117     return $this->frontCache[$key];
 118   }
 119
 120   /**
 121    * @param $key
 122    * @param null $default
 123    *
 124    * @return mixed
 125    */
 126   public function getFromFrontCache($key, $default = NULL) {
 127     return CRM_Utils_Array::value($key, $this->frontCache, $default);
 128   }
 129
 130   /**
 131    * @param string $key
 132    */
 133   public function delete($key) {
 134     CRM_Core_BAO_Cache::deleteGroup($this->group, $key, FALSE);
 135     CRM_Core_BAO_Cache::$_cache = NULL; // FIXME: remove multitier cache
 136     CRM_Utils_Cache::singleton()->flush(); // FIXME: remove multitier cache
 137     unset($this->frontCache[$key]);
 138   }
 139
 140   public function flush() {
 141     CRM_Core_BAO_Cache::deleteGroup($this->group, NULL, FALSE);
 142     CRM_Core_BAO_Cache::$_cache = NULL; // FIXME: remove multitier cache
 143     CRM_Utils_Cache::singleton()->flush(); // FIXME: remove multitier cache
 144     $this->frontCache = array();
 145   }
 146
 147   public function prefetch() {
 148     $this->frontCache = CRM_Core_BAO_Cache::getItems($this->group, $this->componentID);
 149   }
 150
 151 }