Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
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 | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | ||
18 | /** | |
3819f101 | 19 | * Access Control Cache. |
6a488035 | 20 | */ |
28fec8aa | 21 | class CRM_ACL_BAO_Cache extends CRM_ACL_DAO_ACLCache { |
6a488035 | 22 | |
683bf891 | 23 | public static $_cache = NULL; |
6a488035 | 24 | |
28518c90 | 25 | /** |
5b27235a | 26 | * Build an array of ACLs for a specific ACLed user |
581a9d2e | 27 | * |
5b27235a | 28 | * @param int $id - contact_id of the ACLed user |
28518c90 EM |
29 | * |
30 | * @return mixed | |
581a9d2e | 31 | * @throws \CRM_Core_Exception |
28518c90 | 32 | */ |
00be9182 | 33 | public static function &build($id) { |
6a488035 | 34 | if (!self::$_cache) { |
cf0d1c08 | 35 | self::$_cache = []; |
6a488035 TO |
36 | } |
37 | ||
38 | if (array_key_exists($id, self::$_cache)) { | |
39 | return self::$_cache[$id]; | |
40 | } | |
41 | ||
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]; | |
47 | } | |
48 | ||
581a9d2e | 49 | self::$_cache[$id] = CRM_ACL_BAO_ACL::getAllByContact((int) $id); |
6a488035 TO |
50 | self::store($id, self::$_cache[$id]); |
51 | return self::$_cache[$id]; | |
52 | } | |
53 | ||
28518c90 | 54 | /** |
100fef9d | 55 | * @param int $id |
28518c90 EM |
56 | * |
57 | * @return array | |
58 | */ | |
06b1ee60 | 59 | protected static function retrieve($id) { |
6a488035 TO |
60 | $query = " |
61 | SELECT acl_id | |
62 | FROM civicrm_acl_cache | |
63 | WHERE contact_id = %1 | |
64 | "; | |
cf0d1c08 | 65 | $params = [1 => [$id, 'Integer']]; |
6a488035 TO |
66 | |
67 | if ($id == 0) { | |
68 | $query .= " OR contact_id IS NULL"; | |
69 | } | |
70 | ||
71 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
72 | ||
cf0d1c08 | 73 | $cache = []; |
6a488035 TO |
74 | while ($dao->fetch()) { |
75 | $cache[$dao->acl_id] = 1; | |
76 | } | |
77 | return $cache; | |
78 | } | |
79 | ||
28518c90 | 80 | /** |
5b27235a SL |
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. | |
84 | * | |
28518c90 | 85 | */ |
06b1ee60 | 86 | protected static function store($id, &$cache) { |
6a488035 | 87 | foreach ($cache as $aclID => $data) { |
28fec8aa | 88 | $dao = new CRM_ACL_BAO_Cache(); |
6a488035 TO |
89 | if ($id) { |
90 | $dao->contact_id = $id; | |
91 | } | |
92 | $dao->acl_id = $aclID; | |
93 | ||
94 | $cache[$aclID] = 1; | |
95 | ||
96 | $dao->save(); | |
97 | } | |
98 | } | |
99 | ||
28518c90 | 100 | /** |
5b27235a SL |
101 | * Remove entries from civicrm_acl_cache for a specified ACLed user |
102 | * @param int $id - contact_id of the ACLed user | |
103 | * | |
28518c90 | 104 | */ |
00be9182 | 105 | public static function deleteEntry($id) { |
6a488035 TO |
106 | if (self::$_cache && |
107 | array_key_exists($id, self::$_cache) | |
108 | ) { | |
109 | unset(self::$_cache[$id]); | |
110 | } | |
111 | ||
112 | $query = " | |
113 | DELETE FROM civicrm_acl_cache | |
114 | WHERE contact_id = %1 | |
115 | "; | |
cf0d1c08 | 116 | $params = [1 => [$id, 'Integer']]; |
7e1f3142 | 117 | CRM_Core_DAO::executeQuery($query, $params); |
6a488035 TO |
118 | } |
119 | ||
67769683 | 120 | /** |
121 | * Do an opportunistic cache refresh if the site is configured for these. | |
122 | * | |
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. | |
126 | */ | |
127 | public static function opportunisticCacheFlush(): void { | |
128 | if (Civi::settings()->get('acl_cache_refresh_mode') === 'opportunistic') { | |
129 | self::resetCache(); | |
130 | } | |
131 | } | |
132 | ||
d3e86119 TO |
133 | /** |
134 | * Deletes all the cache entries. | |
135 | */ | |
67769683 | 136 | public static function resetCache(): void { |
0626851e | 137 | if (!CRM_Core_Config::isPermitCacheFlushMode()) { |
138 | return; | |
139 | } | |
6a488035 TO |
140 | // reset any static caching |
141 | self::$_cache = NULL; | |
142 | ||
6a488035 TO |
143 | $query = " |
144 | DELETE | |
145 | FROM civicrm_acl_cache | |
146 | WHERE modified_date IS NULL | |
4052239b | 147 | OR (modified_date <= %1) |
6a488035 | 148 | "; |
cf0d1c08 | 149 | $params = [ |
150 | 1 => [ | |
151 | CRM_Contact_BAO_GroupContactCache::getCacheInvalidDateTime(), | |
152 | 'String', | |
153 | ], | |
154 | ]; | |
4052239b | 155 | CRM_Core_DAO::singleValueQuery($query, $params); |
ed2f3757 EM |
156 | self::flushACLContactCache(); |
157 | } | |
158 | ||
159 | /** | |
160 | * Remove Entries from `civicrm_acl_contact_cache` for a specific ACLed user | |
161 | * @param int $userID - contact_id of the ACLed user | |
162 | * | |
163 | */ | |
164 | public static function deleteContactCacheEntry($userID) { | |
165 | CRM_Core_DAO::executeQuery("DELETE FROM civicrm_acl_contact_cache WHERE user_id = %1", [1 => [$userID, 'Positive']]); | |
166 | } | |
167 | ||
168 | /** | |
169 | * Flush the contents of the acl contact cache. | |
170 | */ | |
171 | protected static function flushACLContactCache(): void { | |
92f38c2a | 172 | unset(Civi::$statics['CRM_ACL_API']); |
cded6e48 TO |
173 | // CRM_Core_DAO::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache"); // No, force-commits transaction |
174 | // CRM_Core_DAO::singleValueQuery("DELETE FROM civicrm_acl_contact_cache"); // Transaction-safe | |
175 | if (CRM_Core_Transaction::isActive()) { | |
353ffa53 | 176 | CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_POST_COMMIT, function () { |
ed2f3757 | 177 | CRM_Core_DAO::singleValueQuery('TRUNCATE TABLE civicrm_acl_contact_cache'); |
cded6e48 | 178 | }); |
0db6c3e1 TO |
179 | } |
180 | else { | |
cded6e48 TO |
181 | CRM_Core_DAO::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache"); |
182 | } | |
6a488035 | 183 | } |
96025800 | 184 | |
6a488035 | 185 | } |