3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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 +--------------------------------------------------------------------+
29 * BAO object for civicrm_cache table. This is a database cache and is persisted across sessions. Typically we use
30 * this to store meta data (like profile fields, custom fields etc).
32 * The group_name column is used for grouping together all cache elements that logically belong to the same set.
33 * Thus all session cache entries are grouped under 'CiviCRM Session'. This allows us to delete all entries of
34 * a specific group if needed.
36 * The path column allows us to differentiate between items in that group. Thus for the session cache, the path is
37 * the unique form name for each form (per user)
39 class CRM_Core_BAO_Cache
extends CRM_Core_DAO_Cache
{
42 * @var array ($cacheKey => $cacheValue)
44 static $_cache = NULL;
47 * Retrieve an item from the DB cache.
49 * @param string $group
50 * (required) The group name of the item.
52 * (required) The path under which this item is stored.
53 * @param int $componentID
54 * The optional component ID (so componenets can share the same name space).
57 * The data if present in cache, else null
59 public static function &getItem($group, $path, $componentID = NULL) {
60 if (self
::$_cache === NULL) {
61 self
::$_cache = array();
64 $argString = "CRM_CT_{$group}_{$path}_{$componentID}";
65 if (!array_key_exists($argString, self
::$_cache)) {
66 $cache = CRM_Utils_Cache
::singleton();
67 self
::$_cache[$argString] = $cache->get($argString);
68 if (!self
::$_cache[$argString]) {
69 $dao = new CRM_Core_DAO_Cache();
71 $dao->group_name
= $group;
73 $dao->component_id
= $componentID;
76 if ($dao->find(TRUE)) {
77 $data = unserialize($dao->data
);
80 self
::$_cache[$argString] = $data;
81 $cache->set($argString, self
::$_cache[$argString]);
84 return self
::$_cache[$argString];
88 * Retrieve all items in a group.
90 * @param string $group
91 * (required) The group name of the item.
92 * @param int $componentID
93 * The optional component ID (so componenets can share the same name space).
96 * The data if present in cache, else null
98 public static function &getItems($group, $componentID = NULL) {
99 if (self
::$_cache === NULL) {
100 self
::$_cache = array();
103 $argString = "CRM_CT_CI_{$group}_{$componentID}";
104 if (!array_key_exists($argString, self
::$_cache)) {
105 $cache = CRM_Utils_Cache
::singleton();
106 self
::$_cache[$argString] = $cache->get($argString);
107 if (!self
::$_cache[$argString]) {
108 $dao = new CRM_Core_DAO_Cache();
110 $dao->group_name
= $group;
111 $dao->component_id
= $componentID;
115 while ($dao->fetch()) {
116 $result[$dao->path
] = unserialize($dao->data
);
120 self
::$_cache[$argString] = $result;
121 $cache->set($argString, self
::$_cache[$argString]);
125 return self
::$_cache[$argString];
129 * Store an item in the DB cache.
131 * @param object $data
132 * (required) A reference to the data that will be serialized and stored.
133 * @param string $group
134 * (required) The group name of the item.
135 * @param string $path
136 * (required) The path under which this item is stored.
137 * @param int $componentID
138 * The optional component ID (so componenets can share the same name space).
140 public static function setItem(&$data, $group, $path, $componentID = NULL) {
141 if (self
::$_cache === NULL) {
142 self
::$_cache = array();
145 $dao = new CRM_Core_DAO_Cache();
147 $dao->group_name
= $group;
149 $dao->component_id
= $componentID;
151 // get a lock so that multiple ajax requests on the same page
152 // dont trample on each other
154 $lockName = "civicrm.cache.{$group}_{$path}._{$componentID}";
155 $lock = new CRM_Core_Lock($lockName);
156 if (!$lock->isAcquired()) {
157 CRM_Core_Error
::fatal();
161 $dao->data
= serialize($data);
162 $dao->created_date
= date('YmdHis');
169 // cache coherency - refresh or remove dependent caches
171 $argString = "CRM_CT_{$group}_{$path}_{$componentID}";
172 $cache = CRM_Utils_Cache
::singleton();
173 $data = unserialize($dao->data
);
174 self
::$_cache[$argString] = $data;
175 $cache->set($argString, $data);
177 $argString = "CRM_CT_CI_{$group}_{$componentID}";
178 unset(self
::$_cache[$argString]);
179 $cache->delete($argString);
183 * Delete all the cache elements that belong to a group OR delete the entire cache if group is not specified.
185 * @param string $group
186 * The group name of the entries to be deleted.
187 * @param string $path
188 * Path of the item that needs to be deleted.
189 * @param bool $clearAll clear all caches
191 public static function deleteGroup($group = NULL, $path = NULL, $clearAll = TRUE) {
192 $dao = new CRM_Core_DAO_Cache();
194 if (!empty($group)) {
195 $dao->group_name
= $group;
205 // also reset ACL Cache
206 CRM_ACL_BAO_Cache
::resetCache();
208 // also reset memory cache if any
209 CRM_Utils_System
::flushCache();
214 * The next two functions are internal functions used to store and retrieve session from
215 * the database cache. This keeps the session to a limited size and allows us to
216 * create separate session scopes for each form in a tab
220 * This function takes entries from the session array and stores it in the cache.
222 * It also deletes the entries from the $_SESSION object (for a smaller session size)
224 * @param array $names
225 * Array of session values that should be persisted.
226 * This is either a form name + qfKey or just a form name
227 * (in the case of profile)
228 * @param bool $resetSession
229 * Should session state be reset on completion of DB store?.
231 public static function storeSessionToCache($names, $resetSession = TRUE) {
232 foreach ($names as $key => $sessionName) {
233 if (is_array($sessionName)) {
235 if (!empty($_SESSION[$sessionName[0]][$sessionName[1]])) {
236 $value = $_SESSION[$sessionName[0]][$sessionName[1]];
238 self
::setItem($value, 'CiviCRM Session', "{$sessionName[0]}_{$sessionName[1]}");
240 $_SESSION[$sessionName[0]][$sessionName[1]] = NULL;
241 unset($_SESSION[$sessionName[0]][$sessionName[1]]);
246 if (!empty($_SESSION[$sessionName])) {
247 $value = $_SESSION[$sessionName];
249 self
::setItem($value, 'CiviCRM Session', $sessionName);
251 $_SESSION[$sessionName] = NULL;
252 unset($_SESSION[$sessionName]);
260 /* Retrieve the session values from the cache and populate the $_SESSION array
262 * @param array $names
263 * Array of session values that should be persisted.
264 * This is either a form name + qfKey or just a form name
265 * (in the case of profile)
271 * Restore session from cache.
273 * @param string $names
275 public static function restoreSessionFromCache($names) {
276 foreach ($names as $key => $sessionName) {
277 if (is_array($sessionName)) {
278 $value = self
::getItem('CiviCRM Session',
279 "{$sessionName[0]}_{$sessionName[1]}"
282 $_SESSION[$sessionName[0]][$sessionName[1]] = $value;
286 $value = self
::getItem('CiviCRM Session',
290 $_SESSION[$sessionName] = $value;
297 * Do periodic cleanup of the CiviCRM session table.
299 * Also delete all session cache entries which are a couple of days old.
300 * This keeps the session cache to a manageable size
302 * @param bool $session
304 * @param bool $prevNext
306 public static function cleanup($session = FALSE, $table = FALSE, $prevNext = FALSE) {
307 // clean up the session cache every $cacheCleanUpNumber probabilistically
308 $cleanUpNumber = 757;
310 // clean up all sessions older than $cacheTimeIntervalDays days
311 $timeIntervalDays = 2;
312 $timeIntervalMins = 30;
314 if (mt_rand(1, 100000) %
$cleanUpNumber == 0) {
315 $session = $table = $prevNext = TRUE;
318 if (!$session && !$table && !$prevNext) {
323 // delete all PrevNext caches
324 CRM_Core_BAO_PrevNextCache
::cleanupCache();
328 CRM_Core_Config
::clearTempTables($timeIntervalDays . ' day');
332 // first delete all sessions which are related to any potential transaction
334 $transactionPages = array(
335 'CRM_Contribute_Controller_Contribution',
336 'CRM_Event_Controller_Registration',
341 date('Y-m-d H:i:s', time() - $timeIntervalMins * 60),
345 foreach ($transactionPages as $trPage) {
346 $params[] = array("%${trPage}%", 'String');
347 $where[] = 'path LIKE %' . count($params);
351 DELETE FROM civicrm_cache
352 WHERE group_name = 'CiviCRM Session'
353 AND created_date <= %1
354 AND (" . implode(' OR ', $where) . ")";
355 CRM_Core_DAO
::executeQuery($sql, $params);
358 DELETE FROM civicrm_cache
359 WHERE group_name = 'CiviCRM Session'
360 AND created_date < date_sub( NOW( ), INTERVAL $timeIntervalDays DAY )
362 CRM_Core_DAO
::executeQuery($sql);