Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Contact_BAO_Contact_Permission { | |
36 | ||
37 | /** | |
fe482240 | 38 | * Check if the logged in user has permissions for the operation type. |
6a488035 | 39 | * |
77c5b619 TO |
40 | * @param int $id |
41 | * Contact id. | |
77b97be7 | 42 | * @param int|string $type the type of operation (view|edit) |
6a488035 | 43 | * |
acb1052e | 44 | * @return bool |
a6c01b45 | 45 | * true if the user has permission, false otherwise |
6a488035 | 46 | */ |
00be9182 | 47 | public static function allow($id, $type = CRM_Core_Permission::VIEW) { |
6a488035 TO |
48 | $tables = array(); |
49 | $whereTables = array(); | |
50 | ||
51 | # FIXME: push this somewhere below, to not give this permission so many rights | |
52 | $isDeleted = (bool) CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'is_deleted'); | |
53 | if (CRM_Core_Permission::check('access deleted contacts') && $isDeleted) { | |
54 | return TRUE; | |
55 | } | |
56 | ||
57 | // short circuit for admin rights here so we avoid unneeeded queries | |
58 | // some duplication of code, but we skip 3-5 queries | |
59 | if (CRM_Core_Permission::check('edit all contacts') || | |
60 | ($type == CRM_ACL_API::VIEW && CRM_Core_Permission::check('view all contacts')) | |
61 | ) { | |
62 | return TRUE; | |
63 | } | |
64 | ||
65 | //check permission based on relationship, CRM-2963 | |
66 | if (self::relationship($id)) { | |
67 | return TRUE; | |
68 | } | |
69 | ||
70 | $permission = CRM_ACL_API::whereClause($type, $tables, $whereTables); | |
71 | ||
72 | $from = CRM_Contact_BAO_Query::fromClause($whereTables); | |
73 | ||
74 | $query = " | |
75 | SELECT count(DISTINCT contact_a.id) | |
76 | $from | |
77 | WHERE contact_a.id = %1 AND $permission"; | |
78 | $params = array(1 => array($id, 'Integer')); | |
79 | ||
80 | return (CRM_Core_DAO::singleValueQuery($query, $params) > 0) ? TRUE : FALSE; | |
81 | } | |
82 | ||
83 | /** | |
fe482240 | 84 | * Fill the acl contact cache for this contact id if empty. |
6a488035 | 85 | * |
c490a46a | 86 | * @param int $userID |
dd244018 | 87 | * @param int|string $type the type of operation (view|edit) |
77c5b619 TO |
88 | * @param bool $force |
89 | * Should we force a recompute. | |
6a488035 TO |
90 | * |
91 | * @return void | |
6a488035 | 92 | */ |
00be9182 | 93 | public static function cache($userID, $type = CRM_Core_Permission::VIEW, $force = FALSE) { |
6a488035 TO |
94 | static $_processed = array(); |
95 | ||
96 | if ($type = CRM_Core_Permission::VIEW) { | |
97 | $operationClause = " operation IN ( 'Edit', 'View' ) "; | |
98 | $operation = 'View'; | |
99 | } | |
100 | else { | |
101 | $operationClause = " operation = 'Edit' "; | |
102 | $operation = 'Edit'; | |
103 | } | |
104 | ||
105 | if (!$force) { | |
a7488080 | 106 | if (!empty($_processed[$userID])) { |
6a488035 TO |
107 | return; |
108 | } | |
109 | ||
110 | // run a query to see if the cache is filled | |
111 | $sql = " | |
112 | SELECT count(id) | |
113 | FROM civicrm_acl_contact_cache | |
114 | WHERE user_id = %1 | |
115 | AND $operationClause | |
116 | "; | |
117 | $params = array(1 => array($userID, 'Integer')); | |
118 | $count = CRM_Core_DAO::singleValueQuery($sql, $params); | |
119 | if ($count > 0) { | |
120 | $_processed[$userID] = 1; | |
121 | return; | |
122 | } | |
123 | } | |
124 | ||
125 | $tables = array(); | |
126 | $whereTables = array(); | |
127 | ||
128 | $permission = CRM_ACL_API::whereClause($type, $tables, $whereTables, $userID); | |
129 | ||
130 | $from = CRM_Contact_BAO_Query::fromClause($whereTables); | |
131 | ||
132 | CRM_Core_DAO::executeQuery(" | |
133 | INSERT INTO civicrm_acl_contact_cache ( user_id, contact_id, operation ) | |
134 | SELECT $userID as user_id, contact_a.id as contact_id, '$operation' as operation | |
135 | $from | |
136 | WHERE $permission | |
137 | GROUP BY contact_a.id | |
138 | ON DUPLICATE KEY UPDATE | |
139 | user_id=VALUES(user_id), | |
140 | contact_id=VALUES(contact_id), | |
141 | operation=VALUES(operation)" | |
142 | ); | |
143 | ||
144 | CRM_Core_DAO::executeQuery('DELETE FROM civicrm_acl_contact_cache WHERE contact_id IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)'); | |
145 | $_processed[$userID] = 1; | |
6a488035 TO |
146 | } |
147 | ||
148 | /** | |
fe482240 | 149 | * Check if there are any contacts in cache table. |
6a488035 | 150 | * |
da6b46f4 | 151 | * @param int|string $type the type of operation (view|edit) |
77c5b619 TO |
152 | * @param int $contactID |
153 | * Contact id. | |
6a488035 | 154 | * |
acb1052e | 155 | * @return bool |
6a488035 | 156 | */ |
acb1052e | 157 | public static function hasContactsInCache( |
51ccfbbe | 158 | $type = CRM_Core_Permission::VIEW, |
6a488035 TO |
159 | $contactID = NULL |
160 | ) { | |
161 | if (!$contactID) { | |
162 | $session = CRM_Core_Session::singleton(); | |
163 | $contactID = $session->get('userID'); | |
164 | } | |
165 | ||
166 | if ($type = CRM_Core_Permission::VIEW) { | |
167 | $operationClause = " operation IN ( 'Edit', 'View' ) "; | |
168 | $operation = 'View'; | |
169 | } | |
170 | else { | |
171 | $operationClause = " operation = 'Edit' "; | |
172 | $operation = 'Edit'; | |
173 | } | |
174 | ||
175 | // fill cache | |
176 | self::cache($contactID); | |
177 | ||
178 | $sql = " | |
179 | SELECT id | |
180 | FROM civicrm_acl_contact_cache | |
181 | WHERE user_id = %1 | |
182 | AND $operationClause LIMIT 1"; | |
183 | ||
184 | $params = array(1 => array($contactID, 'Integer')); | |
185 | return (bool) CRM_Core_DAO::singleValueQuery($sql, $params); | |
186 | } | |
187 | ||
86538308 EM |
188 | /** |
189 | * @param string $contactAlias | |
100fef9d | 190 | * @param int $contactID |
86538308 EM |
191 | * |
192 | * @return array | |
193 | */ | |
00be9182 | 194 | public static function cacheClause($contactAlias = 'contact_a', $contactID = NULL) { |
6a488035 TO |
195 | if (CRM_Core_Permission::check('view all contacts') || |
196 | CRM_Core_Permission::check('edit all contacts') | |
197 | ) { | |
198 | if (is_array($contactAlias)) { | |
199 | $wheres = array(); | |
200 | foreach ($contactAlias as $alias) { | |
201 | // CRM-6181 | |
202 | $wheres[] = "$alias.is_deleted = 0"; | |
203 | } | |
204 | return array(NULL, '(' . implode(' AND ', $wheres) . ')'); | |
205 | } | |
206 | else { | |
207 | // CRM-6181 | |
208 | return array(NULL, "$contactAlias.is_deleted = 0"); | |
209 | } | |
210 | } | |
211 | ||
212 | $session = CRM_Core_Session::singleton(); | |
213 | $contactID = $session->get('userID'); | |
214 | if (!$contactID) { | |
215 | $contactID = 0; | |
216 | } | |
217 | $contactID = CRM_Utils_Type::escape($contactID, 'Integer'); | |
218 | ||
219 | self::cache($contactID); | |
220 | ||
221 | if (is_array($contactAlias) && !empty($contactAlias)) { | |
222 | //More than one contact alias | |
223 | $clauses = array(); | |
224 | foreach ($contactAlias as $k => $alias) { | |
225 | $clauses[] = " INNER JOIN civicrm_acl_contact_cache aclContactCache_{$k} ON {$alias}.id = aclContactCache_{$k}.contact_id AND aclContactCache_{$k}.user_id = $contactID "; | |
226 | } | |
227 | ||
228 | $fromClause = implode(" ", $clauses); | |
229 | $whereClase = NULL; | |
230 | } | |
231 | else { | |
232 | $fromClause = " INNER JOIN civicrm_acl_contact_cache aclContactCache ON {$contactAlias}.id = aclContactCache.contact_id "; | |
233 | $whereClase = " aclContactCache.user_id = $contactID "; | |
234 | } | |
235 | ||
236 | return array($fromClause, $whereClase); | |
237 | } | |
238 | ||
239 | /** | |
fe482240 | 240 | * Get the permission base on its relationship. |
6a488035 | 241 | * |
77c5b619 TO |
242 | * @param int $selectedContactID |
243 | * Contact id of selected contact. | |
244 | * @param int $contactID | |
245 | * Contact id of the current contact. | |
6a488035 | 246 | * |
a6c01b45 CW |
247 | * @return bool |
248 | * true if logged in user has permission to view | |
c490a46a | 249 | * selected contact record else false |
6a488035 | 250 | */ |
00be9182 | 251 | public static function relationship($selectedContactID, $contactID = NULL) { |
6a488035 | 252 | $session = CRM_Core_Session::singleton(); |
d5f1ee75 | 253 | $config = CRM_Core_Config::singleton(); |
6a488035 TO |
254 | if (!$contactID) { |
255 | $contactID = $session->get('userID'); | |
256 | if (!$contactID) { | |
257 | return FALSE; | |
258 | } | |
259 | } | |
ad623fd4 | 260 | if ($contactID == $selectedContactID && CRM_Core_Permission::check('edit my contact')) { |
6a488035 TO |
261 | return TRUE; |
262 | } | |
263 | else { | |
d5f1ee75 DG |
264 | if ($config->secondDegRelPermissions) { |
265 | $query = " | |
266 | SELECT firstdeg.id | |
267 | FROM civicrm_relationship firstdeg | |
268 | LEFT JOIN civicrm_relationship seconddegaa | |
269 | on firstdeg.contact_id_a = seconddegaa.contact_id_b | |
270 | and seconddegaa.is_permission_b_a = 1 | |
271 | and firstdeg.is_permission_b_a = 1 | |
272 | and seconddegaa.is_active = 1 | |
273 | LEFT JOIN civicrm_relationship seconddegab | |
274 | on firstdeg.contact_id_a = seconddegab.contact_id_a | |
275 | and seconddegab.is_permission_a_b = 1 | |
276 | and firstdeg.is_permission_b_a = 1 | |
277 | and seconddegab.is_active = 1 | |
278 | LEFT JOIN civicrm_relationship seconddegba | |
279 | on firstdeg.contact_id_b = seconddegba.contact_id_b | |
280 | and seconddegba.is_permission_b_a = 1 | |
281 | and firstdeg.is_permission_a_b = 1 | |
282 | and seconddegba.is_active = 1 | |
283 | LEFT JOIN civicrm_relationship seconddegbb | |
284 | on firstdeg.contact_id_b = seconddegbb.contact_id_a | |
285 | and seconddegbb.is_permission_a_b = 1 | |
286 | and firstdeg.is_permission_a_b = 1 | |
287 | and seconddegbb.is_active = 1 | |
2efcf0c2 | 288 | WHERE |
d5f1ee75 | 289 | ( |
2efcf0c2 | 290 | ( firstdeg.contact_id_a = %1 AND firstdeg.contact_id_b = %2 AND firstdeg.is_permission_a_b = 1 ) |
d5f1ee75 | 291 | OR ( firstdeg.contact_id_a = %2 AND firstdeg.contact_id_b = %1 AND firstdeg.is_permission_b_a = 1 ) |
2efcf0c2 | 292 | OR ( |
d5f1ee75 | 293 | firstdeg.contact_id_a = %1 AND seconddegba.contact_id_a = %2 |
2efcf0c2 | 294 | AND (seconddegba.contact_id_a NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)) |
d5f1ee75 | 295 | ) |
2efcf0c2 | 296 | OR ( |
d5f1ee75 | 297 | firstdeg.contact_id_a = %1 AND seconddegbb.contact_id_b = %2 |
2efcf0c2 | 298 | AND (seconddegbb.contact_id_b NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)) |
d5f1ee75 | 299 | ) |
2efcf0c2 | 300 | OR ( |
d5f1ee75 | 301 | firstdeg.contact_id_b = %1 AND seconddegab.contact_id_b = %2 |
2efcf0c2 | 302 | AND (seconddegab.contact_id_b NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)) |
d5f1ee75 | 303 | ) |
2efcf0c2 | 304 | OR ( |
305 | firstdeg.contact_id_b = %1 AND seconddegaa.contact_id_a = %2 AND (seconddegaa.contact_id_a NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)) | |
d5f1ee75 | 306 | ) |
2efcf0c2 | 307 | ) |
308 | AND (firstdeg.contact_id_a NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)) | |
d5f1ee75 DG |
309 | AND (firstdeg.contact_id_b NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)) |
310 | AND ( firstdeg.is_active = 1) | |
311 | "; | |
312 | } | |
313 | else { | |
314 | $query = " | |
6a488035 TO |
315 | SELECT id |
316 | FROM civicrm_relationship | |
317 | WHERE (( contact_id_a = %1 AND contact_id_b = %2 AND is_permission_a_b = 1 ) OR | |
318 | ( contact_id_a = %2 AND contact_id_b = %1 AND is_permission_b_a = 1 )) AND | |
319 | (contact_id_a NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)) AND | |
320 | (contact_id_b NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)) | |
321 | AND ( civicrm_relationship.is_active = 1 ) | |
322 | "; | |
d5f1ee75 | 323 | } |
51ccfbbe | 324 | $params = array( |
353ffa53 | 325 | 1 => array($contactID, 'Integer'), |
6a488035 TO |
326 | 2 => array($selectedContactID, 'Integer'), |
327 | ); | |
328 | return CRM_Core_DAO::singleValueQuery($query, $params); | |
329 | } | |
330 | } | |
331 | ||
332 | ||
86538308 | 333 | /** |
100fef9d | 334 | * @param int $contactID |
c490a46a | 335 | * @param CRM_Core_Form $form |
86538308 EM |
336 | * @param bool $redirect |
337 | * | |
338 | * @return bool | |
339 | */ | |
00be9182 | 340 | public static function validateOnlyChecksum($contactID, &$form, $redirect = TRUE) { |
6a488035 TO |
341 | // check if this is of the format cs=XXX |
342 | if (!CRM_Contact_BAO_Contact_Utils::validChecksum($contactID, | |
353ffa53 TO |
343 | CRM_Utils_Request::retrieve('cs', 'String', $form, FALSE) |
344 | ) | |
345 | ) { | |
6a488035 TO |
346 | if ($redirect) { |
347 | // also set a message in the UF framework | |
348 | $message = ts('You do not have permission to edit this contact record. Contact the site administrator if you need assistance.'); | |
349 | CRM_Utils_System::setUFMessage($message); | |
350 | ||
351 | $config = CRM_Core_Config::singleton(); | |
352 | CRM_Core_Error::statusBounce($message, | |
353 | $config->userFrameworkBaseURL | |
354 | ); | |
355 | // does not come here, we redirect in the above statement | |
356 | } | |
357 | return FALSE; | |
358 | } | |
359 | ||
a9a1ea2c | 360 | // set appropriate AUTH source |
e8f14831 | 361 | self::initChecksumAuthSrc(TRUE, $form); |
a9a1ea2c | 362 | |
6a488035 TO |
363 | // so here the contact is posing as $contactID, lets set the logging contact ID variable |
364 | // CRM-8965 | |
365 | CRM_Core_DAO::executeQuery('SET @civicrm_user_id = %1', | |
366 | array(1 => array($contactID, 'Integer')) | |
367 | ); | |
77b97be7 | 368 | |
6a488035 TO |
369 | return TRUE; |
370 | } | |
371 | ||
86538308 EM |
372 | /** |
373 | * @param bool $checkSumValidationResult | |
374 | * @param null $form | |
375 | */ | |
00be9182 | 376 | public static function initChecksumAuthSrc($checkSumValidationResult = FALSE, $form = NULL) { |
a9a1ea2c | 377 | $session = CRM_Core_Session::singleton(); |
e8f14831 | 378 | if ($checkSumValidationResult && $form && CRM_Utils_Request::retrieve('cs', 'String', $form, FALSE)) { |
a9a1ea2c DS |
379 | // if result is already validated, and url has cs, set the flag. |
380 | $session->set('authSrc', CRM_Core_Permission::AUTH_SRC_CHECKSUM); | |
0db6c3e1 | 381 | } |
4c9b6178 | 382 | elseif (($session->get('authSrc') & CRM_Core_Permission::AUTH_SRC_CHECKSUM) == CRM_Core_Permission::AUTH_SRC_CHECKSUM) { |
77b97be7 | 383 | // if checksum wasn't present in REQUEST OR checksum result validated as FALSE, |
a9a1ea2c DS |
384 | // and flag was already set exactly as AUTH_SRC_CHECKSUM, unset it. |
385 | $session->set('authSrc', CRM_Core_Permission::AUTH_SRC_UNKNOWN); | |
386 | } | |
387 | } | |
388 | ||
86538308 | 389 | /** |
100fef9d | 390 | * @param int $contactID |
c490a46a | 391 | * @param CRM_Core_Form $form |
86538308 EM |
392 | * @param bool $redirect |
393 | * | |
394 | * @return bool | |
395 | */ | |
00be9182 | 396 | public static function validateChecksumContact($contactID, &$form, $redirect = TRUE) { |
6a488035 TO |
397 | if (!self::allow($contactID, CRM_Core_Permission::EDIT)) { |
398 | // check if this is of the format cs=XXX | |
399 | return self::validateOnlyChecksum($contactID, $form, $redirect); | |
400 | } | |
401 | return TRUE; | |
402 | } | |
96025800 | 403 | |
6a488035 | 404 | } |