CRM/Contact/BAO/Contact/Permission.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 class CRM_Contact_BAO_Contact_Permission {
  18
  19   /**
  20    * @var bool
  21    */
  22   public static $useTempTable = TRUE;
  23
  24   /**
  25    * Set whether to use a temporary table or not when building ACL Cache
  26    * @param bool $useTemporaryTable
  27    */
  28   public static function setUseTemporaryTable($useTemporaryTable = TRUE) {
  29     self::$useTempTable = $useTemporaryTable;
  30   }
  31
  32   /**
  33    * Get variable for determining if we should use Temporary Table or not
  34    * @return bool
  35    */
  36   public static function getUseTemporaryTable() {
  37     return self::$useTempTable;
  38   }
  39
  40   /**
  41    * Check which of the given contact IDs the logged in user
  42    *   has permissions for the operation type according to:
  43    *    - general permissions (e.g. 'edit all contacts')
  44    *    - deletion status (unless you have 'access deleted contacts')
  45    *    - ACL
  46    *    - permissions inherited through relationships (also second degree if enabled)
  47    *
  48    * @param array $contact_ids
  49    *   Contact IDs.
  50    * @param int $type the type of operation (view|edit)
  51    *
  52    * @see CRM_Contact_BAO_Contact_Permission::allow
  53    *
  54    * @return array
  55    *   list of contact IDs the logged in user has the given permission for
  56    */
  57   public static function allowList($contact_ids, $type = CRM_Core_Permission::VIEW) {
  58     $result_set = [];
  59     if (empty($contact_ids)) {
  60       // empty contact lists would cause trouble in the SQL. And be pointless.
  61       return $result_set;
  62     }
  63
  64     // make sure the the general permissions are given
  65     if (CRM_Core_Permission::check('edit all contacts')
  66         || $type == CRM_Core_Permission::VIEW && CRM_Core_Permission::check('view all contacts')
  67       ) {
  68
  69       // if the general permission is there, all good
  70       if (CRM_Core_Permission::check('access deleted contacts')) {
  71         // if user can access deleted contacts -> fine
  72         return $contact_ids;
  73       }
  74       else {
  75         // if the user CANNOT access deleted contacts, these need to be filtered
  76         $contact_id_list = implode(',', $contact_ids);
  77         $filter_query = "SELECT DISTINCT(id) FROM civicrm_contact WHERE id IN ($contact_id_list) AND is_deleted = 0";
  78         $query = CRM_Core_DAO::executeQuery($filter_query);
  79         while ($query->fetch()) {
  80           $result_set[(int) $query->id] = TRUE;
  81         }
  82         return array_keys($result_set);
  83       }
  84     }
  85
  86     // get logged in user
  87     $contactID = CRM_Core_Session::getLoggedInContactID();
  88     if (empty($contactID)) {
  89       return [];
  90     }
  91
  92     // make sure the cache is filled
  93     self::cache($contactID, $type);
  94
  95     // compile query
  96     $operation = ($type == CRM_Core_Permission::VIEW) ? 'View' : 'Edit';
  97
  98     // add clause for deleted contacts, if the user doesn't have the permission to access them
  99     $LEFT_JOIN_DELETED = $AND_CAN_ACCESS_DELETED = '';
 100     if (!CRM_Core_Permission::check('access deleted contacts')) {
 101       $LEFT_JOIN_DELETED      = "LEFT JOIN civicrm_contact ON civicrm_contact.id = contact_id";
 102       $AND_CAN_ACCESS_DELETED = "AND civicrm_contact.is_deleted = 0";
 103     }
 104
 105     // RUN the query
 106     $contact_id_list = implode(',', $contact_ids);
 107     $query = "
 108 SELECT contact_id
 109  FROM civicrm_acl_contact_cache
 110  {$LEFT_JOIN_DELETED}
 111 WHERE contact_id IN ({$contact_id_list})
 112   AND user_id = {$contactID}
 113   AND operation = '{$operation}'
 114   {$AND_CAN_ACCESS_DELETED}";
 115     $result = CRM_Core_DAO::executeQuery($query);
 116     while ($result->fetch()) {
 117       $result_set[(int) $result->contact_id] = TRUE;
 118     }
 119
 120     // if some have been rejected, double check for permissions inherited by relationship
 121     if (count($result_set) < count($contact_ids)) {
 122       $rejected_contacts = array_diff_key($contact_ids, $result_set);
 123       // @todo consider storing these to the acl cache for next time, since we have fetched.
 124       $allowed_by_relationship = self::relationshipList($rejected_contacts, $type);
 125       foreach ($allowed_by_relationship as $contact_id) {
 126         $result_set[(int) $contact_id] = TRUE;
 127       }
 128     }
 129
 130     return array_keys($result_set);
 131   }
 132
 133   /**
 134    * Check if the logged in user has permissions for the operation type.
 135    *
 136    * @param int $id
 137    *   Contact id.
 138    * @param int|string $type the type of operation (view|edit)
 139    *
 140    * @return bool
 141    *   true if the user has permission, false otherwise
 142    */
 143   public static function allow($id, $type = CRM_Core_Permission::VIEW) {
 144     // get logged in user
 145     $contactID = CRM_Core_Session::getLoggedInContactID();
 146
 147     // first: check if contact is trying to view own contact
 148     if ($contactID == $id && ($type == CRM_Core_Permission::VIEW && CRM_Core_Permission::check('view my contact')
 149      || $type == CRM_Core_Permission::EDIT && CRM_Core_Permission::check('edit my contact'))
 150       ) {
 151       return TRUE;
 152     }
 153
 154     // FIXME: push this somewhere below, to not give this permission so many rights
 155     $isDeleted = (bool) CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'is_deleted');
 156     if (CRM_Core_Permission::check('access deleted contacts') && $isDeleted) {
 157       return TRUE;
 158     }
 159
 160     // short circuit for admin rights here so we avoid unneeeded queries
 161     // some duplication of code, but we skip 3-5 queries
 162     if (CRM_Core_Permission::check('edit all contacts') ||
 163       ($type == CRM_ACL_API::VIEW && CRM_Core_Permission::check('view all contacts'))
 164     ) {
 165       return TRUE;
 166     }
 167
 168     // check permission based on relationship, CRM-2963
 169     if (self::relationshipList([$id], $type)) {
 170       return TRUE;
 171     }
 172
 173     // We should probably do a cheap check whether it's in the cache first.
 174     // check permission based on ACL
 175     $tables = [];
 176     $whereTables = [];
 177
 178     $permission = CRM_ACL_API::whereClause($type, $tables, $whereTables, NULL, FALSE, FALSE, TRUE);
 179     $from = CRM_Contact_BAO_Query::fromClause($whereTables);
 180
 181     $query = "
 182 SELECT contact_a.id
 183        $from
 184 WHERE contact_a.id = %1 AND $permission
 185   LIMIT 1
 186 ";
 187
 188     if (CRM_Core_DAO::singleValueQuery($query, [1 => [$id, 'Integer']])) {
 189       return TRUE;
 190     }
 191     return FALSE;
 192   }
 193
 194   /**
 195    * Fill the acl contact cache for this ACLed contact id if empty.
 196    *
 197    * @param int $userID - contact_id of the ACLed user
 198    * @param int|string $type the type of operation (view|edit)
 199    * @param bool $force - Should we force a recompute.
 200    *
 201    */
 202   public static function cache($userID, $type = CRM_Core_Permission::VIEW, $force = FALSE) {
 203     // FIXME: maybe find a better way of keeping track of this. @eileen pointed out
 204     //   that somebody might flush the cache away from under our feet,
 205     //   but the alternative would be a SQL call every time this is called,
 206     //   and a complete rebuild if the result was an empty set...
 207     if (!isset(Civi::$statics[__CLASS__]['processed'])) {
 208       Civi::$statics[__CLASS__]['processed'] = [
 209         CRM_Core_Permission::VIEW => [],
 210         CRM_Core_Permission::EDIT => [],
 211       ];
 212     }
 213
 214     if ($type == CRM_Core_Permission::VIEW) {
 215       $operationClause = " operation IN ( 'Edit', 'View' ) ";
 216       $operation = 'View';
 217     }
 218     else {
 219       $operationClause = " operation = 'Edit' ";
 220       $operation = 'Edit';
 221     }
 222     $queryParams = [1 => [$userID, 'Integer']];
 223
 224     if (!$force) {
 225       // skip if already calculated
 226       if (!empty(Civi::$statics[__CLASS__]['processed'][$type][$userID])) {
 227         return;
 228       }
 229
 230       // run a query to see if the cache is filled
 231       $sql = "
 232 SELECT count(*)
 233 FROM   civicrm_acl_contact_cache
 234 WHERE  user_id = %1
 235 AND    $operationClause
 236 ";
 237       $count = CRM_Core_DAO::singleValueQuery($sql, $queryParams);
 238       if ($count > 0) {
 239         Civi::$statics[__CLASS__]['processed'][$type][$userID] = 1;
 240         return;
 241       }
 242     }
 243
 244     // grab a lock so other processes don't compete and do the same query
 245     $lock = Civi::lockManager()->acquire("data.core.aclcontact.{$userID}");
 246     if (!$lock->isAcquired()) {
 247       // this can cause inconsistent results since we don't know if the other process
 248       // will fill up the cache before our calling routine needs it.
 249       // The default 3 second timeout should be enough for the other process to finish.
 250       // However this routine does not return the status either, so basically
 251       // its a "lets return and hope for the best"
 252       return;
 253     }
 254
 255     $tables = [];
 256     $whereTables = [];
 257
 258     $permission = CRM_ACL_API::whereClause($type, $tables, $whereTables, $userID, FALSE, FALSE, TRUE);
 259
 260     $from = CRM_Contact_BAO_Query::fromClause($whereTables);
 261     /* Ends up something like this:
 262     CREATE TEMPORARY TABLE civicrm_temp_acl_contact_cache1310 (SELECT DISTINCT 2960 as user_id, contact_a.id as contact_id, 'View' as operation
 263     FROM civicrm_contact contact_a  LEFT JOIN civicrm_group_contact_cache `civicrm_group_contact_cache-ACL` ON contact_a.id = `civicrm_group_contact_cache-ACL`.contact_id
 264     LEFT JOIN civicrm_acl_contact_cache ac ON ac.user_id = 2960 AND ac.contact_id = contact_a.id AND ac.operation = 'View'
 265     WHERE     ( `civicrm_group_contact_cache-ACL`.group_id IN (14, 25, 46, 47, 48, 49, 50, 51) )  AND (contact_a.is_deleted = 0)
 266     AND ac.user_id IS NULL*/
 267     /*$sql = "SELECT DISTINCT $userID as user_id, contact_a.id as contact_id, '{$operation}' as operation
 268     $from
 269     LEFT JOIN civicrm_acl_contact_cache ac ON ac.user_id = $userID AND ac.contact_id = contact_a.id AND ac.operation = '{$operation}'
 270     WHERE    $permission
 271     AND ac.user_id IS NULL
 272     ";*/
 273     $sql = " $from WHERE    $permission";
 274     $useTempTable = self::getUseTemporaryTable();
 275     if ($useTempTable) {
 276       $aclContactsTempTable = CRM_Utils_SQL_TempTable::build()->setCategory('aclccache')->setMemory();
 277       $tempTable = $aclContactsTempTable->getName();
 278       $aclContactsTempTable->createWithColumns('contact_id int, UNIQUE INDEX UI_contact (contact_id)');
 279       CRM_Core_DAO::executeQuery("INSERT INTO {$tempTable} (contact_id) SELECT DISTINCT contact_a.id {$sql}");
 280       CRM_Core_DAO::executeQuery("INSERT IGNORE INTO civicrm_acl_contact_cache (user_id, contact_id, operation) SELECT {$userID}, contact_id, '{$operation}' FROM {$tempTable}");
 281       $aclContactsTempTable->drop();
 282     }
 283     else {
 284       $sql = "SELECT DISTINCT $userID as user_id, contact_a.id as contact_id, '{$operation}' as operation" . $sql;
 285       CRM_Core_DAO::executeQuery("INSERT IGNORE INTO civicrm_acl_contact_cache (user_id, contact_id, operation) {$sql}");
 286     }
 287
 288     // Add in a row for the logged in contact. Do not try to combine with the above query or an ugly OR will appear in
 289     // the permission clause.
 290     if (CRM_Core_Permission::check('edit my contact') ||
 291       ($type == CRM_Core_Permission::VIEW && CRM_Core_Permission::check('view my contact'))) {
 292       if (!CRM_Core_DAO::singleValueQuery("
 293         SELECT count(*) FROM civicrm_acl_contact_cache WHERE user_id = %1 AND contact_id = %1 AND operation = '{$operation}' LIMIT 1", $queryParams)) {
 294         CRM_Core_DAO::executeQuery("INSERT IGNORE INTO civicrm_acl_contact_cache ( user_id, contact_id, operation ) VALUES(%1, %1, '{$operation}')", $queryParams);
 295       }
 296     }
 297     Civi::$statics[__CLASS__]['processed'][$type][$userID] = 1;
 298     $lock->release();
 299   }
 300
 301   /**
 302    * @param string $contactAlias
 303    *
 304    * @return array
 305    */
 306   public static function cacheClause($contactAlias = 'contact_a') {
 307     if (CRM_Core_Permission::check('view all contacts') ||
 308       CRM_Core_Permission::check('edit all contacts')
 309     ) {
 310       if (is_array($contactAlias)) {
 311         $wheres = [];
 312         foreach ($contactAlias as $alias) {
 313           // CRM-6181
 314           $wheres[] = "$alias.is_deleted = 0";
 315         }
 316         return [NULL, '(' . implode(' AND ', $wheres) . ')'];
 317       }
 318       else {
 319         // CRM-6181
 320         return [NULL, "$contactAlias.is_deleted = 0"];
 321       }
 322     }
 323
 324     $contactID = (int) CRM_Core_Session::getLoggedInContactID();
 325     self::cache($contactID);
 326
 327     if (is_array($contactAlias) && !empty($contactAlias)) {
 328       //More than one contact alias
 329       $clauses = [];
 330       foreach ($contactAlias as $k => $alias) {
 331         $clauses[] = " INNER JOIN civicrm_acl_contact_cache aclContactCache_{$k} ON {$alias}.id = aclContactCache_{$k}.contact_id AND aclContactCache_{$k}.user_id = $contactID ";
 332       }
 333
 334       $fromClause = implode(" ", $clauses);
 335       $whereClase = NULL;
 336     }
 337     else {
 338       $fromClause = " INNER JOIN civicrm_acl_contact_cache aclContactCache ON {$contactAlias}.id = aclContactCache.contact_id ";
 339       $whereClase = " aclContactCache.user_id = $contactID AND $contactAlias.is_deleted = 0";
 340     }
 341
 342     return [$fromClause, $whereClase];
 343   }
 344
 345   /**
 346    * Generate acl subquery that can be placed in the WHERE clause of a query or the ON clause of a JOIN.
 347    *
 348    * This is specifically for VIEW operations.
 349    *
 350    * @return string|null
 351    */
 352   public static function cacheSubquery() {
 353     if (!CRM_Core_Permission::check([['view all contacts', 'edit all contacts']])) {
 354       $contactID = (int) CRM_Core_Session::getLoggedInContactID();
 355       self::cache($contactID);
 356       return "IN (SELECT contact_id FROM civicrm_acl_contact_cache WHERE user_id = $contactID)";
 357     }
 358     return NULL;
 359   }
 360
 361   /**
 362    * Filter a list of contact_ids by the ones that the
 363    *  currently active user as a permissioned relationship with
 364    *
 365    * @param array $contact_ids
 366    *   List of contact IDs to be filtered
 367    *
 368    * @param int $type
 369    *   access type CRM_Core_Permission::VIEW or CRM_Core_Permission::EDIT
 370    *
 371    * @return array
 372    *   List of contact IDs that the user has permissions for
 373    */
 374   public static function relationshipList($contact_ids, $type) {
 375     $result_set = [];
 376
 377     // no processing empty lists (avoid SQL errors as well)
 378     if (empty($contact_ids)) {
 379       return [];
 380     }
 381
 382     // get the currently logged in user
 383     $contactID = CRM_Core_Session::getLoggedInContactID();
 384     if (empty($contactID)) {
 385       return [];
 386     }
 387
 388     // compile a list of queries (later to UNION)
 389     $queries = [];
 390     $contact_id_list = implode(',', $contact_ids);
 391
 392     // add a select statement for each direction
 393     $directions = [['from' => 'a', 'to' => 'b'], ['from' => 'b', 'to' => 'a']];
 394
 395     // CRM_Core_Permission::VIEW is satisfied by either CRM_Contact_BAO_Relationship::VIEW or CRM_Contact_BAO_Relationship::EDIT
 396     if ($type == CRM_Core_Permission::VIEW) {
 397       $is_perm_condition = ' IN ( ' . CRM_Contact_BAO_Relationship::EDIT . ' , ' . CRM_Contact_BAO_Relationship::VIEW . ' ) ';
 398     }
 399     else {
 400       $is_perm_condition = ' = ' . CRM_Contact_BAO_Relationship::EDIT;
 401     }
 402
 403     // NORMAL/SINGLE DEGREE RELATIONSHIPS
 404     foreach ($directions as $direction) {
 405       $user_id_column    = "contact_id_{$direction['from']}";
 406       $contact_id_column = "contact_id_{$direction['to']}";
 407
 408       // add clause for deleted contacts, if the user doesn't have the permission to access them
 409       $LEFT_JOIN_DELETED = $AND_CAN_ACCESS_DELETED = '';
 410       if (!CRM_Core_Permission::check('access deleted contacts')) {
 411         $LEFT_JOIN_DELETED       = "LEFT JOIN civicrm_contact ON civicrm_contact.id = {$contact_id_column} ";
 412         $AND_CAN_ACCESS_DELETED  = "AND civicrm_contact.is_deleted = 0";
 413       }
 414
 415       $queries[] = "
 416 SELECT civicrm_relationship.{$contact_id_column} AS contact_id
 417   FROM civicrm_relationship
 418   {$LEFT_JOIN_DELETED}
 419  WHERE civicrm_relationship.{$user_id_column} = {$contactID}
 420    AND civicrm_relationship.{$contact_id_column} IN ({$contact_id_list})
 421    AND civicrm_relationship.is_active = 1
 422    AND civicrm_relationship.is_permission_{$direction['from']}_{$direction['to']} {$is_perm_condition}
 423    $AND_CAN_ACCESS_DELETED";
 424     }
 425
 426     // FIXME: secondDegRelPermissions should be a setting
 427     $config = CRM_Core_Config::singleton();
 428     if ($config->secondDegRelPermissions) {
 429       foreach ($directions as $first_direction) {
 430         foreach ($directions as $second_direction) {
 431           // add clause for deleted contacts, if the user doesn't have the permission to access them
 432           $LEFT_JOIN_DELETED = $AND_CAN_ACCESS_DELETED = '';
 433           if (!CRM_Core_Permission::check('access deleted contacts')) {
 434             $LEFT_JOIN_DELETED       = "LEFT JOIN civicrm_contact first_degree_contact  ON first_degree_contact.id  = second_degree_relationship.contact_id_{$second_direction['from']}\n";
 435             $LEFT_JOIN_DELETED      .= "LEFT JOIN civicrm_contact second_degree_contact ON second_degree_contact.id = second_degree_relationship.contact_id_{$second_direction['to']} ";
 436             $AND_CAN_ACCESS_DELETED  = "AND first_degree_contact.is_deleted = 0\n";
 437             $AND_CAN_ACCESS_DELETED .= "AND second_degree_contact.is_deleted = 0 ";
 438           }
 439
 440           $queries[] = "
 441 SELECT second_degree_relationship.contact_id_{$second_direction['to']} AS contact_id
 442   FROM civicrm_relationship first_degree_relationship
 443   LEFT JOIN civicrm_relationship second_degree_relationship ON first_degree_relationship.contact_id_{$first_direction['to']} = second_degree_relationship.contact_id_{$second_direction['from']}
 444   {$LEFT_JOIN_DELETED}
 445  WHERE first_degree_relationship.contact_id_{$first_direction['from']} = {$contactID}
 446    AND second_degree_relationship.contact_id_{$second_direction['to']} IN ({$contact_id_list})
 447    AND first_degree_relationship.is_active = 1
 448    AND first_degree_relationship.is_permission_{$first_direction['from']}_{$first_direction['to']} {$is_perm_condition}
 449    AND second_degree_relationship.is_active = 1
 450    AND second_degree_relationship.is_permission_{$second_direction['from']}_{$second_direction['to']} {$is_perm_condition}
 451    $AND_CAN_ACCESS_DELETED";
 452         }
 453       }
 454     }
 455
 456     // finally UNION the queries and call
 457     $query = "(" . implode(")\nUNION DISTINCT (", $queries) . ")";
 458     $result = CRM_Core_DAO::executeQuery($query);
 459     while ($result->fetch()) {
 460       $result_set[(int) $result->contact_id] = TRUE;
 461     }
 462     return array_keys($result_set);
 463   }
 464
 465   /**
 466    * @param int $contactID
 467    * @param CRM_Core_Form $form
 468    * @param bool $redirect
 469    *
 470    * @return bool
 471    */
 472   public static function validateOnlyChecksum($contactID, &$form, $redirect = TRUE) {
 473     // check if this is of the format cs=XXX
 474     if (!CRM_Contact_BAO_Contact_Utils::validChecksum($contactID,
 475       CRM_Utils_Request::retrieve('cs', 'String', $form, FALSE)
 476     )
 477     ) {
 478       if ($redirect) {
 479         // also set a message in the UF framework
 480         $message = ts('You do not have permission to edit this contact record. Contact the site administrator if you need assistance.');
 481         CRM_Utils_System::setUFMessage($message);
 482
 483         $config = CRM_Core_Config::singleton();
 484         CRM_Core_Error::statusBounce($message,
 485           $config->userFrameworkBaseURL
 486         );
 487         // does not come here, we redirect in the above statement
 488       }
 489       return FALSE;
 490     }
 491
 492     // set appropriate AUTH source
 493     self::initChecksumAuthSrc(TRUE, $form);
 494
 495     // so here the contact is posing as $contactID, lets set the logging contact ID variable
 496     // CRM-8965
 497     CRM_Core_DAO::executeQuery('SET @civicrm_user_id = %1',
 498       [1 => [$contactID, 'Integer']]
 499     );
 500
 501     return TRUE;
 502   }
 503
 504   /**
 505    * @param bool $checkSumValidationResult
 506    * @param null $form
 507    */
 508   public static function initChecksumAuthSrc($checkSumValidationResult = FALSE, $form = NULL) {
 509     $session = CRM_Core_Session::singleton();
 510     if ($checkSumValidationResult && $form && CRM_Utils_Request::retrieve('cs', 'String', $form, FALSE)) {
 511       // if result is already validated, and url has cs, set the flag.
 512       $session->set('authSrc', CRM_Core_Permission::AUTH_SRC_CHECKSUM);
 513     }
 514     elseif (($session->get('authSrc') & CRM_Core_Permission::AUTH_SRC_CHECKSUM) == CRM_Core_Permission::AUTH_SRC_CHECKSUM) {
 515       // if checksum wasn't present in REQUEST OR checksum result validated as FALSE,
 516       // and flag was already set exactly as AUTH_SRC_CHECKSUM, unset it.
 517       $session->set('authSrc', CRM_Core_Permission::AUTH_SRC_UNKNOWN);
 518     }
 519   }
 520
 521   /**
 522    * @param int $contactID
 523    * @param CRM_Core_Form $form
 524    * @param bool $redirect
 525    *
 526    * @return bool
 527    */
 528   public static function validateChecksumContact($contactID, &$form, $redirect = TRUE) {
 529     if (!self::allow($contactID, CRM_Core_Permission::EDIT)) {
 530       // check if this is of the format cs=XXX
 531       return self::validateOnlyChecksum($contactID, $form, $redirect);
 532     }
 533     return TRUE;
 534   }
 535
 536 }