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