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
28 * @param int $id - contact_id of the ACLed user
31 * @throws \CRM_Core_Exception
33 public static function &build($id) {
38 if (array_key_exists($id, self
::$_cache)) {
39 return self
::$_cache[$id];
42 // check if this entry exists in db
43 // if so retrieve and return
44 self
::$_cache[$id] = self
::retrieve($id);
45 if (self
::$_cache[$id]) {
46 return self
::$_cache[$id];
49 self
::$_cache[$id] = CRM_ACL_BAO_ACL
::getAllByContact((int) $id);
50 self
::store($id, self
::$_cache[$id]);
51 return self
::$_cache[$id];
59 protected static function retrieve($id) {
62 FROM civicrm_acl_cache
65 $params = [1 => [$id, 'Integer']];
68 $query .= " OR contact_id IS NULL";
71 $dao = CRM_Core_DAO
::executeQuery($query, $params);
74 while ($dao->fetch()) {
75 $cache[$dao->acl_id
] = 1;
81 * Store ACLs for a specific user in the `civicrm_acl_cache` table
82 * @param int $id - contact_id of the ACLed user
83 * @param array $cache - key civicrm_acl.id - values is the details of the ACL.
86 protected static function store($id, &$cache) {
87 foreach ($cache as $aclID => $data) {
88 $dao = new CRM_ACL_BAO_Cache();
90 $dao->contact_id
= $id;
92 $dao->acl_id
= $aclID;
101 * Remove entries from civicrm_acl_cache for a specified ACLed user
102 * @param int $id - contact_id of the ACLed user
105 public static function deleteEntry($id) {
107 array_key_exists($id, self
::$_cache)
109 unset(self
::$_cache[$id]);
113 DELETE FROM civicrm_acl_cache
114 WHERE contact_id = %1
116 $params = [1 => [$id, 'Integer']];
117 CRM_Core_DAO
::executeQuery($query, $params);
121 * Do an opportunistic cache refresh if the site is configured for these.
123 * Sites that use acls and do not run the acl cache clearing cron job should
124 * refresh the caches on demand. The user session will be forced to wait
125 * and this is a common source of deadlocks, so it is less ideal.
127 public static function opportunisticCacheFlush(): void
{
128 if (Civi
::settings()->get('acl_cache_refresh_mode') === 'opportunistic') {
134 * Deletes all the cache entries.
136 public static function resetCache(): void
{
137 if (!CRM_Core_Config
::isPermitCacheFlushMode()) {
140 // reset any static caching
141 self
::$_cache = NULL;
145 FROM civicrm_acl_cache
146 WHERE modified_date IS NULL
147 OR (modified_date <= %1)
151 CRM_Contact_BAO_GroupContactCache
::getCacheInvalidDateTime(),
155 CRM_Core_DAO
::singleValueQuery($query, $params);
156 unset(Civi
::$statics['CRM_ACL_API']);
157 // CRM_Core_DAO::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache"); // No, force-commits transaction
158 // CRM_Core_DAO::singleValueQuery("DELETE FROM civicrm_acl_contact_cache"); // Transaction-safe
159 if (CRM_Core_Transaction
::isActive()) {
160 CRM_Core_Transaction
::addCallback(CRM_Core_Transaction
::PHASE_POST_COMMIT
, function () {
161 CRM_Core_DAO
::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache");
165 CRM_Core_DAO
::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache");
170 * Remove Entries from `civicrm_acl_contact_cache` for a specific ACLed user
171 * @param int $userID - contact_id of the ACLed user
174 public static function deleteContactCacheEntry($userID) {
175 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_acl_contact_cache WHERE user_id = %1", [1 => [$userID, 'Positive']]);