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 * Access Control Cache.
21 class CRM_ACL_BAO_Cache
extends CRM_ACL_DAO_ACLCache
{
23 public static $_cache = NULL;
26 * Build an array of ACLs for a specific ACLed user
27 * @param int $id - contact_id of the ACLed user
31 public static function &build($id) {
36 if (array_key_exists($id, self
::$_cache)) {
37 return self
::$_cache[$id];
40 // check if this entry exists in db
41 // if so retrieve and return
42 self
::$_cache[$id] = self
::retrieve($id);
43 if (self
::$_cache[$id]) {
44 return self
::$_cache[$id];
47 self
::$_cache[$id] = CRM_ACL_BAO_ACL
::getAllByContact($id);
48 self
::store($id, self
::$_cache[$id]);
49 return self
::$_cache[$id];
57 public static function retrieve($id) {
60 FROM civicrm_acl_cache
63 $params = [1 => [$id, 'Integer']];
66 $query .= " OR contact_id IS NULL";
69 $dao = CRM_Core_DAO
::executeQuery($query, $params);
72 while ($dao->fetch()) {
73 $cache[$dao->acl_id
] = 1;
79 * Store ACLs for a specific user in the `civicrm_acl_cache` table
80 * @param int $id - contact_id of the ACLed user
81 * @param array $cache - key civicrm_acl.id - values is the details of the ACL.
84 public static function store($id, &$cache) {
85 foreach ($cache as $aclID => $data) {
86 $dao = new CRM_ACL_BAO_Cache();
88 $dao->contact_id
= $id;
90 $dao->acl_id
= $aclID;
99 * Remove entries from civicrm_acl_cache for a specified ACLed user
100 * @param int $id - contact_id of the ACLed user
103 public static function deleteEntry($id) {
105 array_key_exists($id, self
::$_cache)
107 unset(self
::$_cache[$id]);
111 DELETE FROM civicrm_acl_cache
112 WHERE contact_id = %1
114 $params = [1 => [$id, 'Integer']];
115 CRM_Core_DAO
::executeQuery($query, $params);
119 * Deletes all the cache entries.
121 public static function resetCache() {
122 if (!CRM_Core_Config
::isPermitCacheFlushMode()) {
125 // reset any static caching
126 self
::$_cache = NULL;
130 FROM civicrm_acl_cache
131 WHERE modified_date IS NULL
132 OR (modified_date <= %1)
136 CRM_Contact_BAO_GroupContactCache
::getCacheInvalidDateTime(),
140 CRM_Core_DAO
::singleValueQuery($query, $params);
142 // CRM_Core_DAO::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache"); // No, force-commits transaction
143 // CRM_Core_DAO::singleValueQuery("DELETE FROM civicrm_acl_contact_cache"); // Transaction-safe
144 if (CRM_Core_Transaction
::isActive()) {
145 CRM_Core_Transaction
::addCallback(CRM_Core_Transaction
::PHASE_POST_COMMIT
, function () {
146 CRM_Core_DAO
::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache");
150 CRM_Core_DAO
::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache");
155 * Remove Entries from `civicrm_acl_contact_cache` for a specific ACLed user
156 * @param int $userID - contact_id of the ACLed user
159 public static function deleteContactCacheEntry($userID) {
160 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_acl_contact_cache WHERE user_id = %1", [1 => [$userID, 'Positive']]);