Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
35 | * Access Control List | |
36 | */ | |
37 | class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { | |
db01bf2f | 38 | /** |
39 | * @var string | |
40 | */ | |
683bf891 SL |
41 | public static $_entityTable = NULL; |
42 | public static $_objectTable = NULL; | |
43 | public static $_operation = NULL; | |
6a488035 | 44 | |
683bf891 | 45 | public static $_fieldKeys = NULL; |
6a488035 | 46 | |
28518c90 | 47 | /** |
3819f101 | 48 | * Get ACL entity table. |
49 | * | |
28518c90 EM |
50 | * @return array|null |
51 | */ | |
00be9182 | 52 | public static function entityTable() { |
6a488035 | 53 | if (!self::$_entityTable) { |
cf0d1c08 | 54 | self::$_entityTable = [ |
6a488035 TO |
55 | 'civicrm_contact' => ts('Contact'), |
56 | 'civicrm_acl_role' => ts('ACL Role'), | |
cf0d1c08 | 57 | ]; |
6a488035 TO |
58 | } |
59 | return self::$_entityTable; | |
60 | } | |
61 | ||
28518c90 EM |
62 | /** |
63 | * @return array|null | |
64 | */ | |
00be9182 | 65 | public static function objectTable() { |
6a488035 | 66 | if (!self::$_objectTable) { |
cf0d1c08 | 67 | self::$_objectTable = [ |
6a488035 TO |
68 | 'civicrm_contact' => ts('Contact'), |
69 | 'civicrm_group' => ts('Group'), | |
70 | 'civicrm_saved_search' => ts('Contact Group'), | |
6a488035 | 71 | 'civicrm_admin' => ts('Import'), |
cf0d1c08 | 72 | ]; |
6a488035 TO |
73 | } |
74 | return self::$_objectTable; | |
75 | } | |
76 | ||
28518c90 EM |
77 | /** |
78 | * @return array|null | |
79 | */ | |
00be9182 | 80 | public static function operation() { |
6a488035 | 81 | if (!self::$_operation) { |
cf0d1c08 | 82 | self::$_operation = [ |
6a488035 TO |
83 | 'View' => ts('View'), |
84 | 'Edit' => ts('Edit'), | |
85 | 'Create' => ts('Create'), | |
86 | 'Delete' => ts('Delete'), | |
87 | 'Search' => ts('Search'), | |
88 | 'All' => ts('All'), | |
cf0d1c08 | 89 | ]; |
6a488035 TO |
90 | } |
91 | return self::$_operation; | |
92 | } | |
93 | ||
94 | /** | |
95 | * Construct a WHERE clause to handle permissions to $object_* | |
96 | * | |
d6951adc | 97 | * @deprecated |
98 | * | |
b758c7d5 TO |
99 | * @param array $tables |
100 | * Any tables that may be needed in the FROM. | |
101 | * @param string $operation | |
102 | * The operation being attempted. | |
103 | * @param string $object_table | |
104 | * The table of the object in question. | |
105 | * @param int $object_id | |
106 | * The ID of the object in question. | |
107 | * @param int $acl_id | |
108 | * If it's a grant/revoke operation, the ACL ID. | |
109 | * @param bool $acl_role | |
110 | * For grant operations, this flag determines if we're granting a single acl (false) or an entire group. | |
6a488035 | 111 | * |
a6c01b45 CW |
112 | * @return string |
113 | * The WHERE clause, or 0 on failure | |
6a488035 | 114 | */ |
e6a83034 TO |
115 | public static function permissionClause( |
116 | &$tables, $operation, | |
6a488035 TO |
117 | $object_table = NULL, $object_id = NULL, |
118 | $acl_id = NULL, $acl_role = FALSE | |
119 | ) { | |
d6951adc | 120 | CRM_Core_Error::deprecatedFunctionWarning('unknown - this is really old & not used in core'); |
28a04ea9 | 121 | $dao = new CRM_ACL_DAO_ACL(); |
6a488035 | 122 | |
cf0d1c08 | 123 | $t = [ |
6a488035 TO |
124 | 'ACL' => self::getTableName(), |
125 | 'ACLRole' => 'civicrm_acl_role', | |
126 | 'ACLEntityRole' => CRM_ACL_DAO_EntityRole::getTableName(), | |
127 | 'Contact' => CRM_Contact_DAO_Contact::getTableName(), | |
128 | 'Group' => CRM_Contact_DAO_Group::getTableName(), | |
129 | 'GroupContact' => CRM_Contact_DAO_GroupContact::getTableName(), | |
cf0d1c08 | 130 | ]; |
6a488035 | 131 | |
3bdcd4ec | 132 | $contact_id = CRM_Core_Session::getLoggedInContactID(); |
6a488035 TO |
133 | |
134 | $where = " {$t['ACL']}.operation = '" . CRM_Utils_Type::escape($operation, 'String') . "'"; | |
135 | ||
136 | /* Include clause if we're looking for a specific table/id permission */ | |
137 | ||
6a488035 TO |
138 | if (!empty($object_table)) { |
139 | $where .= " AND ( {$t['ACL']}.object_table IS null | |
140 | OR ({$t['ACL']}.object_table = '" . CRM_Utils_Type::escape($object_table, 'String') . "'"; | |
141 | if (!empty($object_id)) { | |
142 | $where .= " AND ({$t['ACL']}.object_id IS null | |
143 | OR {$t['ACL']}.object_id = " . CRM_Utils_Type::escape($object_id, 'Integer') . ')'; | |
144 | } | |
145 | $where .= '))'; | |
146 | } | |
147 | ||
148 | /* Include clause if we're granting an ACL or ACL Role */ | |
149 | ||
6a488035 TO |
150 | if (!empty($acl_id)) { |
151 | $where .= " AND ({$t['ACL']}.acl_id IS null | |
152 | OR {$t['ACL']}.acl_id = " . CRM_Utils_Type::escape($acl_id, 'Integer') . ')'; | |
153 | if ($acl_role) { | |
154 | $where .= " AND {$t['ACL']}.acl_table = '{$t['ACLRole']}'"; | |
155 | } | |
156 | else { | |
157 | $where .= " AND {$t['ACL']}.acl_table = '{$t['ACL']}'"; | |
158 | } | |
159 | } | |
160 | ||
cf0d1c08 | 161 | $query = []; |
6a488035 TO |
162 | |
163 | /* Query for permissions granted to all contacts in the domain */ | |
164 | ||
6a488035 TO |
165 | $query[] = "SELECT {$t['ACL']}.*, 0 as override |
166 | FROM {$t['ACL']} | |
167 | ||
168 | WHERE {$t['ACL']}.entity_table = '{$t['Domain']}' | |
169 | AND ($where)"; | |
170 | ||
171 | /* Query for permissions granted to all contacts through an ACL group */ | |
172 | ||
6a488035 TO |
173 | $query[] = "SELECT {$t['ACL']}.*, 0 as override |
174 | FROM {$t['ACL']} | |
175 | ||
176 | INNER JOIN {$t['ACLEntityRole']} | |
177 | ON ({$t['ACL']}.entity_table = '{$t['ACLRole']}' | |
178 | AND {$t['ACL']}.entity_id = | |
179 | {$t['ACLEntityRole']}.acl_role_id) | |
180 | ||
181 | INNER JOIN {$t['ACLRole']} | |
182 | ON {$t['ACL']}.entity_id = | |
183 | {$t['ACLRole']}.id | |
184 | ||
185 | WHERE {$t['ACLEntityRole']}.entity_table = | |
186 | '{$t['Domain']}' | |
187 | AND {$t['ACLRole']}.is_active = 1 | |
188 | AND ($where)"; | |
189 | ||
190 | /* Query for permissions granted directly to the contact */ | |
191 | ||
6a488035 TO |
192 | $query[] = "SELECT {$t['ACL']}.*, 1 as override |
193 | FROM {$t['ACL']} | |
194 | ||
195 | INNER JOIN {$t['Contact']} | |
196 | ON ({$t['ACL']}.entity_table = '{$t['Contact']}' | |
197 | AND {$t['ACL']}.entity_id = {$t['Contact']}.id) | |
198 | ||
199 | WHERE {$t['Contact']}.id = $contact_id | |
200 | AND ($where)"; | |
201 | ||
202 | /* Query for permissions granted to the contact through an ACL group */ | |
203 | ||
6a488035 TO |
204 | $query[] = "SELECT {$t['ACL']}.*, 1 as override |
205 | FROM {$t['ACL']} | |
206 | ||
207 | INNER JOIN {$t['ACLEntityRole']} | |
208 | ON ({$t['ACL']}.entity_table = '{$t['ACLRole']}' | |
209 | AND {$t['ACL']}.entity_id = | |
210 | {$t['ACLEntityRole']}.acl_role_id) | |
211 | ||
212 | INNER JOIN {$t['ACLRole']} | |
213 | ON {$t['ACL']}.entity_id = {$t['ACLRole']}.id | |
214 | ||
215 | WHERE {$t['ACLEntityRole']}.entity_table = | |
216 | '{$t['Contact']}' | |
217 | AND {$t['ACLRole']}.is_active = 1 | |
218 | AND {$t['ACLEntityRole']}.entity_id = $contact_id | |
219 | AND ($where)"; | |
220 | ||
221 | /* Query for permissions granted to the contact through a group */ | |
222 | ||
6a488035 TO |
223 | $query[] = "SELECT {$t['ACL']}.*, 0 as override |
224 | FROM {$t['ACL']} | |
225 | ||
226 | INNER JOIN {$t['GroupContact']} | |
227 | ON ({$t['ACL']}.entity_table = '{$t['Group']}' | |
228 | AND {$t['ACL']}.entity_id = | |
229 | {$t['GroupContact']}.group_id) | |
230 | ||
231 | WHERE ($where) | |
232 | AND {$t['GroupContact']}.contact_id = $contact_id | |
233 | AND {$t['GroupContact']}.status = 'Added')"; | |
234 | ||
6a488035 | 235 | /* Query for permissions granted through an ACL group to a Contact |
e70a7fc0 | 236 | * group */ |
6a488035 | 237 | |
6a488035 TO |
238 | $query[] = "SELECT {$t['ACL']}.*, 0 as override |
239 | FROM {$t['ACL']} | |
240 | ||
241 | INNER JOIN {$t['ACLEntityRole']} | |
242 | ON ({$t['ACL']}.entity_table = '{$t['ACLRole']}' | |
243 | AND {$t['ACL']}.entity_id = | |
244 | {$t['ACLEntityRole']}.acl_role_id) | |
245 | ||
246 | INNER JOIN {$t['ACLRole']} | |
247 | ON {$t['ACL']}.entity_id = {$t['ACLRole']}.id | |
248 | ||
249 | INNER JOIN {$t['GroupContact']} | |
250 | ON ({$t['ACLEntityRole']}.entity_table = | |
251 | '{$t['Group']}' | |
252 | AND {$t['ACLEntityRole']}.entity_id = | |
253 | {$t['GroupContact']}.group_id) | |
254 | ||
255 | WHERE ($where) | |
256 | AND {$t['ACLRole']}.is_active = 1 | |
257 | AND {$t['GroupContact']}.contact_id = $contact_id | |
258 | AND {$t['GroupContact']}.status = 'Added'"; | |
259 | ||
260 | $union = '(' . implode(') UNION DISTINCT (', $query) . ')'; | |
261 | ||
262 | $dao->query($union); | |
263 | ||
cf0d1c08 | 264 | $allow = [0]; |
265 | $deny = [0]; | |
266 | $override = []; | |
6a488035 TO |
267 | |
268 | while ($dao->fetch()) { | |
269 | /* Instant bypass for the following cases: | |
e70a7fc0 TO |
270 | * 1) the rule governs all tables |
271 | * 2) the rule governs all objects in the table in question | |
272 | * 3) the rule governs the specific object we want | |
273 | */ | |
6a488035 | 274 | |
6a488035 TO |
275 | if (empty($dao->object_table) || |
276 | ($dao->object_table == $object_table | |
277 | && (empty($dao->object_id) | |
278 | || $dao->object_id == $object_id | |
279 | ) | |
280 | ) | |
281 | ) { | |
282 | $clause = 1; | |
283 | } | |
284 | else { | |
285 | /* Otherwise try to generate a clause for this rule */ | |
286 | ||
6a488035 TO |
287 | $clause = self::getClause( |
288 | $dao->object_table, $dao->object_id, $tables | |
289 | ); | |
290 | ||
291 | /* If the clause returned is null, then the rule is a blanket | |
e70a7fc0 TO |
292 | * (id is null) on a table other than the one we're interested |
293 | * in. So skip it. */ | |
6a488035 | 294 | |
6a488035 TO |
295 | if (empty($clause)) { |
296 | continue; | |
297 | } | |
298 | } | |
299 | ||
300 | /* Now we figure out if this is an allow or deny rule, and possibly | |
e70a7fc0 | 301 | * a contact-level override */ |
6a488035 | 302 | |
6a488035 TO |
303 | if ($dao->deny) { |
304 | $deny[] = $clause; | |
305 | } | |
306 | else { | |
307 | $allow[] = $clause; | |
308 | ||
309 | if ($dao->override) { | |
310 | $override[] = $clause; | |
311 | } | |
312 | } | |
313 | } | |
314 | ||
315 | $allows = '(' . implode(' OR ', $allow) . ')'; | |
316 | $denies = '(' . implode(' OR ', $deny) . ')'; | |
317 | if (!empty($override)) { | |
318 | $denies = '(NOT (' . implode(' OR ', $override) . ") AND $denies)"; | |
319 | } | |
320 | ||
321 | return "($allows AND NOT $denies)"; | |
322 | } | |
323 | ||
324 | /** | |
325 | * Given a table and id pair, return the filter clause | |
326 | * | |
b758c7d5 TO |
327 | * @param string $table |
328 | * The table owning the object. | |
329 | * @param int $id | |
330 | * The ID of the object. | |
331 | * @param array $tables | |
332 | * Tables that will be needed in the FROM. | |
6a488035 | 333 | * |
72b3a70c CW |
334 | * @return string|null |
335 | * WHERE-style clause to filter results, | |
16b10e64 | 336 | * or null if $table or $id is null |
6a488035 TO |
337 | */ |
338 | public static function getClause($table, $id, &$tables) { | |
353ffa53 TO |
339 | $table = CRM_Utils_Type::escape($table, 'String'); |
340 | $id = CRM_Utils_Type::escape($id, 'Integer'); | |
cf0d1c08 | 341 | $whereTables = []; |
6a488035 TO |
342 | |
343 | $ssTable = CRM_Contact_BAO_SavedSearch::getTableName(); | |
344 | ||
345 | if (empty($table)) { | |
346 | return NULL; | |
347 | } | |
348 | elseif ($table == $ssTable) { | |
349 | return CRM_Contact_BAO_SavedSearch::whereClause($id, $tables, $whereTables); | |
350 | } | |
351 | elseif (!empty($id)) { | |
352 | $tables[$table] = TRUE; | |
353 | return "$table.id = $id"; | |
354 | } | |
355 | return NULL; | |
356 | } | |
357 | ||
358 | /** | |
359 | * Construct an associative array of an ACL rule's properties | |
360 | * | |
b758c7d5 TO |
361 | * @param string $format |
362 | * Sprintf format for array. | |
363 | * @param bool $hideEmpty | |
364 | * Only return elements that have a value set. | |
6a488035 | 365 | * |
a6c01b45 CW |
366 | * @return array |
367 | * Assoc. array of the ACL rule's properties | |
6a488035 | 368 | */ |
100b0ec6 | 369 | public function toArray($format = '%s', $hideEmpty = FALSE) { |
cf0d1c08 | 370 | $result = []; |
6a488035 TO |
371 | |
372 | if (!self::$_fieldKeys) { | |
373 | $fields = CRM_ACL_DAO_ACL::fields(); | |
374 | self::$_fieldKeys = array_keys($fields); | |
375 | } | |
376 | ||
377 | foreach (self::$_fieldKeys as $field) { | |
378 | $result[$field] = $this->$field; | |
379 | } | |
380 | return $result; | |
381 | } | |
382 | ||
383 | /** | |
384 | * Retrieve ACLs for a contact or group. Note that including a contact id | |
385 | * without a group id will return those ACL rules which are granted | |
386 | * directly to the contact, but not those granted to the contact through | |
387 | * any/all of his group memberships. | |
388 | * | |
b758c7d5 TO |
389 | * @param int $contact_id |
390 | * ID of a contact to search for. | |
391 | * @param int $group_id | |
392 | * ID of a group to search for. | |
393 | * @param bool $aclRoles | |
394 | * Should we include ACL Roles. | |
6a488035 | 395 | * |
a6c01b45 CW |
396 | * @return array |
397 | * Array of assoc. arrays of ACL rules | |
6a488035 TO |
398 | */ |
399 | public static function &getACLs($contact_id = NULL, $group_id = NULL, $aclRoles = FALSE) { | |
cf0d1c08 | 400 | $results = []; |
6a488035 TO |
401 | |
402 | if (empty($contact_id)) { | |
403 | return $results; | |
404 | } | |
405 | ||
406 | $contact_id = CRM_Utils_Type::escape($contact_id, 'Integer'); | |
407 | if ($group_id) { | |
408 | $group_id = CRM_Utils_Type::escape($group_id, 'Integer'); | |
409 | } | |
410 | ||
411 | $rule = new CRM_ACL_BAO_ACL(); | |
412 | ||
353ffa53 | 413 | $acl = self::getTableName(); |
6a488035 | 414 | $contact = CRM_Contact_BAO_Contact::getTableName(); |
353ffa53 TO |
415 | $c2g = CRM_Contact_BAO_GroupContact::getTableName(); |
416 | $group = CRM_Contact_BAO_Group::getTableName(); | |
6a488035 TO |
417 | |
418 | $query = " SELECT $acl.* | |
419 | FROM $acl "; | |
420 | ||
421 | if (!empty($group_id)) { | |
422 | $query .= " INNER JOIN $c2g | |
423 | ON $acl.entity_id = $c2g.group_id | |
424 | WHERE $acl.entity_table = '$group' | |
425 | AND $acl.is_active = 1 | |
426 | AND $c2g.group_id = $group_id"; | |
427 | ||
428 | if (!empty($contact_id)) { | |
429 | $query .= " AND $c2g.contact_id = $contact_id | |
430 | AND $c2g.status = 'Added'"; | |
431 | } | |
432 | } | |
433 | else { | |
434 | if (!empty($contact_id)) { | |
435 | $query .= " WHERE $acl.entity_table = '$contact' | |
436 | AND $acl.entity_id = $contact_id"; | |
437 | } | |
438 | } | |
439 | ||
440 | $rule->query($query); | |
441 | ||
442 | while ($rule->fetch()) { | |
443 | $results[$rule->id] = $rule->toArray(); | |
444 | } | |
445 | ||
446 | if ($aclRoles) { | |
447 | $results += self::getACLRoles($contact_id, $group_id); | |
448 | } | |
449 | ||
450 | return $results; | |
451 | } | |
452 | ||
453 | /** | |
d2e5d2ce | 454 | * Get all of the ACLs through ACL groups. |
6a488035 | 455 | * |
b758c7d5 TO |
456 | * @param int $contact_id |
457 | * ID of a contact to search for. | |
458 | * @param int $group_id | |
459 | * ID of a group to search for. | |
6a488035 | 460 | * |
a6c01b45 CW |
461 | * @return array |
462 | * Array of assoc. arrays of ACL rules | |
6a488035 TO |
463 | */ |
464 | public static function &getACLRoles($contact_id = NULL, $group_id = NULL) { | |
465 | $contact_id = CRM_Utils_Type::escape($contact_id, 'Integer'); | |
466 | if ($group_id) { | |
467 | $group_id = CRM_Utils_Type::escape($group_id, 'Integer'); | |
468 | } | |
469 | ||
470 | $rule = new CRM_ACL_BAO_ACL(); | |
471 | ||
353ffa53 TO |
472 | $acl = self::getTableName(); |
473 | $aclRole = 'civicrm_acl_role'; | |
6a488035 | 474 | $aclRoleJoin = CRM_ACL_DAO_EntityRole::getTableName(); |
353ffa53 TO |
475 | $contact = CRM_Contact_BAO_Contact::getTableName(); |
476 | $c2g = CRM_Contact_BAO_GroupContact::getTableName(); | |
477 | $group = CRM_Contact_BAO_Group::getTableName(); | |
6a488035 TO |
478 | |
479 | $query = " SELECT $acl.* | |
480 | FROM $acl | |
481 | INNER JOIN civicrm_option_group og | |
482 | ON og.name = 'acl_role' | |
483 | INNER JOIN civicrm_option_value ov | |
484 | ON $acl.entity_table = '$aclRole' | |
485 | AND ov.option_group_id = og.id | |
486 | AND $acl.entity_id = ov.value"; | |
487 | ||
488 | if (!empty($group_id)) { | |
489 | $query .= " INNER JOIN $c2g | |
490 | ON $acl.entity_id = $c2g.group_id | |
491 | WHERE $acl.entity_table = '$group' | |
492 | AND $acl.is_active = 1 | |
493 | AND $c2g.group_id = $group_id"; | |
494 | ||
495 | if (!empty($contact_id)) { | |
496 | $query .= " AND $c2g.contact_id = $contact_id | |
497 | AND $c2g.status = 'Added'"; | |
498 | } | |
499 | } | |
500 | else { | |
501 | if (!empty($contact_id)) { | |
502 | $query .= " WHERE $acl.entity_table = '$contact' | |
503 | AND $acl.is_active = 1 | |
504 | AND $acl.entity_id = $contact_id"; | |
505 | } | |
506 | } | |
507 | ||
cf0d1c08 | 508 | $results = []; |
6a488035 TO |
509 | |
510 | $rule->query($query); | |
511 | ||
512 | while ($rule->fetch()) { | |
a5611c8e | 513 | $results[$rule->id] = $rule->toArray(); |
6a488035 TO |
514 | } |
515 | ||
516 | return $results; | |
517 | } | |
518 | ||
519 | /** | |
d2e5d2ce | 520 | * Get all ACLs granted to a contact through all group memberships. |
6a488035 | 521 | * |
b758c7d5 TO |
522 | * @param int $contact_id |
523 | * The contact's ID. | |
524 | * @param bool $aclRoles | |
525 | * Include ACL Roles?. | |
6a488035 | 526 | * |
a6c01b45 CW |
527 | * @return array |
528 | * Assoc array of ACL rules | |
6a488035 TO |
529 | */ |
530 | public static function &getGroupACLs($contact_id, $aclRoles = FALSE) { | |
531 | $contact_id = CRM_Utils_Type::escape($contact_id, 'Integer'); | |
532 | ||
533 | $rule = new CRM_ACL_BAO_ACL(); | |
534 | ||
353ffa53 TO |
535 | $acl = self::getTableName(); |
536 | $c2g = CRM_Contact_BAO_GroupContact::getTableName(); | |
537 | $group = CRM_Contact_BAO_Group::getTableName(); | |
cf0d1c08 | 538 | $results = []; |
6a488035 TO |
539 | |
540 | if ($contact_id) { | |
541 | $query = " | |
542 | SELECT $acl.* | |
543 | FROM $acl | |
544 | INNER JOIN $c2g | |
545 | ON $acl.entity_id = $c2g.group_id | |
546 | WHERE $acl.entity_table = '$group' | |
547 | AND $c2g.contact_id = $contact_id | |
548 | AND $c2g.status = 'Added'"; | |
549 | ||
550 | $rule->query($query); | |
551 | ||
552 | while ($rule->fetch()) { | |
79380078 | 553 | $results[$rule->id] = $rule->toArray(); |
6a488035 TO |
554 | } |
555 | } | |
556 | ||
557 | if ($aclRoles) { | |
558 | $results += self::getGroupACLRoles($contact_id); | |
559 | } | |
560 | ||
561 | return $results; | |
562 | } | |
563 | ||
564 | /** | |
d2e5d2ce | 565 | * Get all of the ACLs for a contact through ACL groups owned by Contact. |
6a488035 TO |
566 | * groups. |
567 | * | |
b758c7d5 TO |
568 | * @param int $contact_id |
569 | * ID of a contact to search for. | |
6a488035 | 570 | * |
a6c01b45 CW |
571 | * @return array |
572 | * Array of assoc. arrays of ACL rules | |
6a488035 TO |
573 | */ |
574 | public static function &getGroupACLRoles($contact_id) { | |
575 | $contact_id = CRM_Utils_Type::escape($contact_id, 'Integer'); | |
576 | ||
577 | $rule = new CRM_ACL_BAO_ACL(); | |
578 | ||
579 | $acl = self::getTableName(); | |
580 | $aclRole = 'civicrm_acl_role'; | |
581 | ||
6a488035 | 582 | $aclER = CRM_ACL_DAO_EntityRole::getTableName(); |
353ffa53 | 583 | $c2g = CRM_Contact_BAO_GroupContact::getTableName(); |
6a488035 TO |
584 | $group = CRM_Contact_BAO_Group::getTableName(); |
585 | ||
586 | $query = " SELECT $acl.* | |
587 | FROM $acl | |
588 | INNER JOIN civicrm_option_group og | |
589 | ON og.name = 'acl_role' | |
590 | INNER JOIN civicrm_option_value ov | |
591 | ON $acl.entity_table = '$aclRole' | |
592 | AND ov.option_group_id = og.id | |
593 | AND $acl.entity_id = ov.value | |
594 | AND ov.is_active = 1 | |
595 | INNER JOIN $aclER | |
596 | ON $aclER.acl_role_id = $acl.entity_id | |
597 | AND $aclER.is_active = 1 | |
598 | INNER JOIN $c2g | |
599 | ON $aclER.entity_id = $c2g.group_id | |
600 | AND $aclER.entity_table = 'civicrm_group' | |
601 | WHERE $acl.entity_table = '$aclRole' | |
602 | AND $acl.is_active = 1 | |
603 | AND $c2g.contact_id = $contact_id | |
604 | AND $c2g.status = 'Added'"; | |
605 | ||
cf0d1c08 | 606 | $results = []; |
6a488035 TO |
607 | |
608 | $rule->query($query); | |
609 | ||
610 | while ($rule->fetch()) { | |
39eb89f4 | 611 | $results[$rule->id] = $rule->toArray(); |
6a488035 TO |
612 | } |
613 | ||
614 | // also get all acls for "Any Role" case | |
615 | // and authenticated User Role if present | |
616 | $roles = "0"; | |
617 | $session = CRM_Core_Session::singleton(); | |
618 | if ($session->get('ufID') > 0) { | |
619 | $roles .= ",2"; | |
620 | } | |
621 | ||
622 | $query = " | |
623 | SELECT $acl.* | |
624 | FROM $acl | |
625 | WHERE $acl.entity_id IN ( $roles ) | |
626 | AND $acl.entity_table = 'civicrm_acl_role' | |
627 | "; | |
628 | ||
629 | $rule->query($query); | |
630 | while ($rule->fetch()) { | |
631 | $results[$rule->id] = $rule->toArray(); | |
632 | } | |
633 | ||
634 | return $results; | |
635 | } | |
636 | ||
637 | /** | |
638 | * Get all ACLs owned by a given contact, including domain and group-level. | |
639 | * | |
b758c7d5 TO |
640 | * @param int $contact_id |
641 | * The contact ID. | |
6a488035 | 642 | * |
a6c01b45 CW |
643 | * @return array |
644 | * Assoc array of ACL rules | |
6a488035 TO |
645 | */ |
646 | public static function &getAllByContact($contact_id) { | |
cf0d1c08 | 647 | $result = []; |
6a488035 TO |
648 | |
649 | /* First, the contact-specific ACLs, including ACL Roles */ | |
650 | $result += self::getACLs($contact_id, NULL, TRUE); | |
651 | ||
652 | /* Then, all ACLs granted through group membership */ | |
653 | $result += self::getGroupACLs($contact_id, TRUE); | |
654 | ||
655 | return $result; | |
656 | } | |
657 | ||
28518c90 | 658 | /** |
c490a46a | 659 | * @param array $params |
28518c90 EM |
660 | * |
661 | * @return CRM_ACL_DAO_ACL | |
662 | */ | |
00be9182 | 663 | public static function create(&$params) { |
6a488035 TO |
664 | $dao = new CRM_ACL_DAO_ACL(); |
665 | $dao->copyValues($params); | |
666 | $dao->save(); | |
1fe97a01 | 667 | return $dao; |
6a488035 TO |
668 | } |
669 | ||
28518c90 | 670 | /** |
c490a46a | 671 | * @param array $params |
28518c90 EM |
672 | * @param $defaults |
673 | */ | |
00be9182 | 674 | public static function retrieve(&$params, &$defaults) { |
6a488035 TO |
675 | CRM_Core_DAO::commonRetrieve('CRM_ACL_DAO_ACL', $params, $defaults); |
676 | } | |
677 | ||
678 | /** | |
fe482240 | 679 | * Update the is_active flag in the db. |
6a488035 | 680 | * |
b758c7d5 TO |
681 | * @param int $id |
682 | * Id of the database record. | |
683 | * @param bool $is_active | |
684 | * Value we want to set the is_active field. | |
6a488035 | 685 | * |
8a4fede3 | 686 | * @return bool |
687 | * true if we found and updated the object, else false | |
6a488035 | 688 | */ |
00be9182 | 689 | public static function setIsActive($id, $is_active) { |
6a488035 TO |
690 | // note this also resets any ACL cache |
691 | CRM_Core_BAO_Cache::deleteGroup('contact fields'); | |
692 | ||
693 | return CRM_Core_DAO::setFieldValue('CRM_ACL_DAO_ACL', $id, 'is_active', $is_active); | |
694 | } | |
695 | ||
28518c90 EM |
696 | /** |
697 | * @param $str | |
100fef9d | 698 | * @param int $contactID |
28518c90 EM |
699 | * |
700 | * @return bool | |
701 | */ | |
00be9182 | 702 | public static function check($str, $contactID) { |
6a488035 TO |
703 | |
704 | $acls = CRM_ACL_BAO_Cache::build($contactID); | |
705 | ||
706 | $aclKeys = array_keys($acls); | |
707 | $aclKeys = implode(',', $aclKeys); | |
708 | ||
709 | if (empty($aclKeys)) { | |
710 | return FALSE; | |
711 | } | |
712 | ||
6a488035 TO |
713 | $query = " |
714 | SELECT count( a.id ) | |
715 | FROM civicrm_acl_cache c, civicrm_acl a | |
716 | WHERE c.acl_id = a.id | |
717 | AND a.is_active = 1 | |
718 | AND a.object_table = %1 | |
719 | AND a.id IN ( $aclKeys ) | |
720 | "; | |
cf0d1c08 | 721 | $params = [1 => [$str, 'String']]; |
6a488035 TO |
722 | |
723 | $count = CRM_Core_DAO::singleValueQuery($query, $params); | |
724 | return ($count) ? TRUE : FALSE; | |
725 | } | |
726 | ||
28518c90 EM |
727 | /** |
728 | * @param $type | |
729 | * @param $tables | |
730 | * @param $whereTables | |
100fef9d | 731 | * @param int $contactID |
28518c90 EM |
732 | * |
733 | * @return null|string | |
734 | */ | |
199761b4 | 735 | public static function whereClause($type, &$tables, &$whereTables, $contactID = NULL) { |
6a488035 | 736 | $acls = CRM_ACL_BAO_Cache::build($contactID); |
6a488035 TO |
737 | |
738 | $whereClause = NULL; | |
cf0d1c08 | 739 | $clauses = []; |
6a488035 TO |
740 | |
741 | if (!empty($acls)) { | |
742 | $aclKeys = array_keys($acls); | |
743 | $aclKeys = implode(',', $aclKeys); | |
744 | ||
745 | $query = " | |
746 | SELECT a.operation, a.object_id | |
747 | FROM civicrm_acl_cache c, civicrm_acl a | |
748 | WHERE c.acl_id = a.id | |
749 | AND a.is_active = 1 | |
750 | AND a.object_table = 'civicrm_saved_search' | |
751 | AND a.id IN ( $aclKeys ) | |
752 | ORDER BY a.object_id | |
753 | "; | |
754 | ||
755 | $dao = CRM_Core_DAO::executeQuery($query); | |
756 | ||
757 | // do an or of all the where clauses u see | |
cf0d1c08 | 758 | $ids = []; |
6a488035 TO |
759 | while ($dao->fetch()) { |
760 | // make sure operation matches the type TODO | |
761 | if (self::matchType($type, $dao->operation)) { | |
762 | if (!$dao->object_id) { | |
cf0d1c08 | 763 | $ids = []; |
6a488035 TO |
764 | $whereClause = ' ( 1 ) '; |
765 | break; | |
766 | } | |
767 | $ids[] = $dao->object_id; | |
768 | } | |
769 | } | |
770 | ||
771 | if (!empty($ids)) { | |
772 | $ids = implode(',', $ids); | |
773 | $query = " | |
774 | SELECT g.* | |
775 | FROM civicrm_group g | |
776 | WHERE g.id IN ( $ids ) | |
777 | AND g.is_active = 1 | |
778 | "; | |
353ffa53 | 779 | $dao = CRM_Core_DAO::executeQuery($query); |
1bcdee33 | 780 | $groupIDs = []; |
781 | $groupContactCacheClause = FALSE; | |
6a488035 | 782 | while ($dao->fetch()) { |
1bcdee33 | 783 | $groupIDs[] = $dao->id; |
6a488035 | 784 | |
1d902030 | 785 | if (($dao->saved_search_id || $dao->children || $dao->parents)) { |
786 | if ($dao->cache_date == NULL) { | |
787 | CRM_Contact_BAO_GroupContactCache::load($dao); | |
788 | } | |
1bcdee33 | 789 | $groupContactCacheClause = " UNION SELECT contact_id FROM civicrm_group_contact_cache WHERE group_id IN (" . implode(', ', $groupIDs) . ")"; |
6a488035 | 790 | } |
6a488035 | 791 | |
6a488035 TO |
792 | } |
793 | ||
1bcdee33 | 794 | if ($groupIDs) { |
795 | $clauses[] = "( | |
796 | `contact_a`.id IN ( | |
797 | SELECT contact_id FROM civicrm_group_contact WHERE group_id IN (" . implode(', ', $groupIDs) . ") AND status = 'Added' | |
798 | $groupContactCacheClause | |
799 | ) | |
800 | )"; | |
6a488035 TO |
801 | } |
802 | } | |
803 | } | |
804 | ||
805 | if (!empty($clauses)) { | |
806 | $whereClause = ' ( ' . implode(' OR ', $clauses) . ' ) '; | |
807 | } | |
808 | ||
809 | // call the hook to get additional whereClauses | |
810 | CRM_Utils_Hook::aclWhereClause($type, $tables, $whereTables, $contactID, $whereClause); | |
811 | ||
199761b4 | 812 | if (empty($whereClause)) { |
6a488035 TO |
813 | $whereClause = ' ( 0 ) '; |
814 | } | |
815 | ||
816 | return $whereClause; | |
817 | } | |
818 | ||
28518c90 | 819 | /** |
c490a46a | 820 | * @param int $type |
100fef9d | 821 | * @param int $contactID |
28518c90 EM |
822 | * @param string $tableName |
823 | * @param null $allGroups | |
824 | * @param null $includedGroups | |
825 | * | |
826 | * @return array | |
827 | */ | |
e6a83034 TO |
828 | public static function group( |
829 | $type, | |
100b0ec6 TO |
830 | $contactID = NULL, |
831 | $tableName = 'civicrm_saved_search', | |
832 | $allGroups = NULL, | |
6a488035 TO |
833 | $includedGroups = NULL |
834 | ) { | |
e3ad0182 | 835 | $userCacheKey = "{$contactID}_{$type}_{$tableName}_" . CRM_Core_Config::domainID() . '_' . md5(implode(',', array_merge((array) $allGroups, (array) $includedGroups))); |
836 | if (empty(Civi::$statics[__CLASS__]['permissioned_groups'])) { | |
cf0d1c08 | 837 | Civi::$statics[__CLASS__]['permissioned_groups'] = []; |
e3ad0182 | 838 | } |
839 | if (!empty(Civi::$statics[__CLASS__]['permissioned_groups'][$userCacheKey])) { | |
840 | return Civi::$statics[__CLASS__]['permissioned_groups'][$userCacheKey]; | |
841 | } | |
6a488035 | 842 | |
8aace6af | 843 | if ($allGroups == NULL) { |
887688b9 | 844 | $allGroups = CRM_Contact_BAO_Contact::buildOptions('group_id', NULL, ['onlyActive' => FALSE]); |
8aace6af JG |
845 | } |
846 | ||
6a488035 TO |
847 | $acls = CRM_ACL_BAO_Cache::build($contactID); |
848 | ||
cf0d1c08 | 849 | $ids = []; |
6a488035 TO |
850 | if (!empty($acls)) { |
851 | $aclKeys = array_keys($acls); | |
852 | $aclKeys = implode(',', $aclKeys); | |
853 | ||
5d624b69 | 854 | $cacheKey = CRM_Core_BAO_Cache::cleanKey("$tableName-$aclKeys"); |
557f8c17 ARW |
855 | $cache = CRM_Utils_Cache::singleton(); |
856 | $ids = $cache->get($cacheKey); | |
857 | if (!$ids) { | |
cf0d1c08 | 858 | $ids = []; |
557f8c17 | 859 | $query = " |
6a488035 TO |
860 | SELECT a.operation, a.object_id |
861 | FROM civicrm_acl_cache c, civicrm_acl a | |
862 | WHERE c.acl_id = a.id | |
863 | AND a.is_active = 1 | |
864 | AND a.object_table = %1 | |
865 | AND a.id IN ( $aclKeys ) | |
866 | GROUP BY a.operation,a.object_id | |
867 | ORDER BY a.object_id | |
868 | "; | |
cf0d1c08 | 869 | $params = [1 => [$tableName, 'String']]; |
557f8c17 ARW |
870 | $dao = CRM_Core_DAO::executeQuery($query, $params); |
871 | while ($dao->fetch()) { | |
872 | if ($dao->object_id) { | |
873 | if (self::matchType($type, $dao->operation)) { | |
874 | $ids[] = $dao->object_id; | |
875 | } | |
6a488035 | 876 | } |
557f8c17 ARW |
877 | else { |
878 | // this user has got the permission for all objects of this type | |
879 | // check if the type matches | |
880 | if (self::matchType($type, $dao->operation)) { | |
881 | foreach ($allGroups as $id => $dontCare) { | |
882 | $ids[] = $id; | |
883 | } | |
6a488035 | 884 | } |
557f8c17 | 885 | break; |
6a488035 | 886 | } |
6a488035 | 887 | } |
557f8c17 | 888 | $cache->set($cacheKey, $ids); |
6a488035 TO |
889 | } |
890 | } | |
891 | ||
b1f4e637 RN |
892 | if (empty($ids) && !empty($includedGroups) && |
893 | is_array($includedGroups) | |
894 | ) { | |
895 | $ids = $includedGroups; | |
896 | } | |
e3ad0182 | 897 | if ($contactID) { |
54d93c06 | 898 | $groupWhere = ''; |
899 | if (!empty($allGroups)) { | |
900 | $groupWhere = " AND id IN (" . implode(',', array_keys($allGroups)) . ")"; | |
901 | } | |
e3ad0182 | 902 | // Contacts create hidden groups from search results. They should be able to retrieve their own. |
903 | $ownHiddenGroupsList = CRM_Core_DAO::singleValueQuery(" | |
904 | SELECT GROUP_CONCAT(id) FROM civicrm_group WHERE is_hidden =1 AND created_id = $contactID | |
54d93c06 | 905 | $groupWhere |
e3ad0182 | 906 | "); |
907 | if ($ownHiddenGroupsList) { | |
908 | $ownHiddenGroups = explode(',', $ownHiddenGroupsList); | |
54d93c06 | 909 | $ids = array_merge((array) $ids, $ownHiddenGroups); |
e3ad0182 | 910 | } |
911 | ||
912 | } | |
b1f4e637 | 913 | |
6a488035 | 914 | CRM_Utils_Hook::aclGroup($type, $contactID, $tableName, $allGroups, $ids); |
e3ad0182 | 915 | Civi::$statics[__CLASS__]['permissioned_groups'][$userCacheKey] = $ids; |
6a488035 TO |
916 | return $ids; |
917 | } | |
918 | ||
28518c90 | 919 | /** |
c490a46a | 920 | * @param int $type |
28518c90 EM |
921 | * @param $operation |
922 | * | |
923 | * @return bool | |
924 | */ | |
00be9182 | 925 | public static function matchType($type, $operation) { |
6a488035 TO |
926 | $typeCheck = FALSE; |
927 | switch ($operation) { | |
928 | case 'All': | |
929 | $typeCheck = TRUE; | |
930 | break; | |
931 | ||
932 | case 'View': | |
933 | if ($type == CRM_ACL_API::VIEW) { | |
934 | $typeCheck = TRUE; | |
935 | } | |
936 | break; | |
937 | ||
938 | case 'Edit': | |
939 | if ($type == CRM_ACL_API::VIEW || $type == CRM_ACL_API::EDIT) { | |
940 | $typeCheck = TRUE; | |
941 | } | |
942 | break; | |
943 | ||
944 | case 'Create': | |
945 | if ($type == CRM_ACL_API::CREATE) { | |
946 | $typeCheck = TRUE; | |
947 | } | |
948 | break; | |
949 | ||
950 | case 'Delete': | |
951 | if ($type == CRM_ACL_API::DELETE) { | |
952 | $typeCheck = TRUE; | |
953 | } | |
954 | break; | |
955 | ||
956 | case 'Search': | |
957 | if ($type == CRM_ACL_API::SEARCH) { | |
958 | $typeCheck = TRUE; | |
959 | } | |
960 | break; | |
961 | } | |
962 | return $typeCheck; | |
963 | } | |
964 | ||
965 | /** | |
d2e5d2ce | 966 | * Delete ACL records. |
6a488035 | 967 | * |
b758c7d5 TO |
968 | * @param int $aclId |
969 | * ID of the ACL record to be deleted. | |
6a488035 | 970 | * |
6a488035 | 971 | */ |
00be9182 | 972 | public static function del($aclId) { |
6a488035 TO |
973 | // delete all entries from the acl cache |
974 | CRM_ACL_BAO_Cache::resetCache(); | |
975 | ||
976 | $acl = new CRM_ACL_DAO_ACL(); | |
977 | $acl->id = $aclId; | |
978 | $acl->delete(); | |
979 | } | |
96025800 | 980 | |
6a488035 | 981 | } |