CRM/ACL/API.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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_ACL_API {
  36
  37   /**
  38    * The various type of permissions
  39    *
  40    * @var int
  41    */
  42   const EDIT = 1;
  43   const VIEW = 2;
  44   const DELETE = 3;
  45   const CREATE = 4;
  46   const SEARCH = 5;
  47   const ALL = 6;
  48
  49   /**
  50    * Given a permission string, check for access requirements
  51    *
  52    * @param string $str
  53    *   The permission to check.
  54    * @param int $contactID
  55    *   The contactID for whom the check is made.
  56    *
  57    * @return boolean
  58    *   true if yes, else false
  59    * @static
  60    */
  61   public static function check($str, $contactID = NULL) {
  62     if ($contactID == NULL) {
  63       $session = CRM_Core_Session::singleton();
  64       $contactID = $session->get('userID');
  65     }
  66
  67     if (!$contactID) {
  68       // anonymous user
  69       $contactID = 0;
  70     }
  71
  72     return CRM_ACL_BAO_ACL::check($str, $contactID);
  73   }
  74
  75   /**
  76    * Get the permissioned where clause for the user
  77    *
  78    * @param int $type
  79    *   The type of permission needed.
  80    * @param array $tables
  81    *   (reference ) add the tables that are needed for the select clause.
  82    * @param array $whereTables
  83    *   (reference ) add the tables that are needed for the where clause.
  84    * @param int $contactID
  85    *   The contactID for whom the check is made.
  86    * @param bool $onlyDeleted
  87    *   Whether to include only deleted contacts.
  88    * @param bool $skipDeleteClause
  89    *   Don't add delete clause if this is true,.
  90    *               this means it is handled by generating query
  91    *
  92    * @return string
  93    *   the group where clause for this user
  94    */
  95   public static function whereClause(
  96     $type,
  97     &$tables,
  98     &$whereTables,
  99     $contactID = NULL,
 100     $onlyDeleted = FALSE,
 101     $skipDeleteClause = FALSE
 102   ) {
 103     // the default value which is valid for rhe final AND
 104     $deleteClause = ' ( 1 ) ';
 105     if (!$skipDeleteClause) {
 106       if (CRM_Core_Permission::check('access deleted contacts') and $onlyDeleted) {
 107         $deleteClause = '(contact_a.is_deleted)';
 108       }
 109       else {
 110         // CRM-6181
 111         $deleteClause = '(contact_a.is_deleted = 0)';
 112       }
 113     }
 114
 115     // first see if the contact has edit / view all contacts
 116     if (CRM_Core_Permission::check('edit all contacts') ||
 117       ($type == self::VIEW &&
 118         CRM_Core_Permission::check('view all contacts')
 119       )
 120     ) {
 121       return $skipDeleteClause ? ' ( 1 ) ' : $deleteClause;
 122     }
 123
 124     if ($contactID == NULL) {
 125       $session = CRM_Core_Session::singleton();
 126       $contactID = $session->get('userID');
 127     }
 128
 129     if (!$contactID) {
 130       // anonymous user
 131       $contactID = 0;
 132     }
 133
 134     return implode(' AND ',
 135       array(
 136         CRM_ACL_BAO_ACL::whereClause($type,
 137           $tables,
 138           $whereTables,
 139           $contactID
 140         ),
 141         $deleteClause,
 142       )
 143     );
 144   }
 145
 146   /**
 147    * Get all the groups the user has access to for the given operation
 148    *
 149    * @param int $type
 150    *   The type of permission needed.
 151    * @param int $contactID
 152    *   The contactID for whom the check is made.
 153    *
 154    * @param string $tableName
 155    * @param null $allGroups
 156    * @param null $includedGroups
 157    *
 158    * @return array
 159    *   the ids of the groups for which the user has permissions
 160    */
 161   public static function group(
 162     $type,
 163     $contactID = NULL,
 164     $tableName = 'civicrm_saved_search',
 165     $allGroups = NULL,
 166     $includedGroups = NULL
 167   ) {
 168     if ($contactID == NULL) {
 169       $session = CRM_Core_Session::singleton();
 170       $contactID = $session->get('userID');
 171     }
 172
 173     if (!$contactID) {
 174       // anonymous user
 175       $contactID = 0;
 176     }
 177
 178     return CRM_ACL_BAO_ACL::group($type, $contactID, $tableName, $allGroups, $includedGroups);
 179   }
 180
 181   /**
 182    * Check if the user has access to this group for operation $type
 183    *
 184    * @param int $type
 185    *   The type of permission needed.
 186    * @param int $groupID
 187    * @param int $contactID
 188    *   The contactID for whom the check is made.
 189    *
 190    * @param string $tableName
 191    * @param null $allGroups
 192    * @param null $includedGroups
 193    * @param bool $flush
 194    *
 195    * @return array
 196    *   the ids of the groups for which the user has permissions
 197    */
 198   public static function groupPermission(
 199     $type,
 200     $groupID,
 201     $contactID = NULL,
 202     $tableName = 'civicrm_saved_search',
 203     $allGroups = NULL,
 204     $includedGroups = NULL,
 205     $flush = FALSE
 206   ) {
 207
 208     static $cache = array();
 209     //@todo this is pretty hacky!!!
 210     //adding a way for unit tests to flush the cache
 211     if ($flush) {
 212       $cache = array();
 213       return;
 214     }
 215     if (!$contactID) {
 216       $session = CRM_Core_Session::singleton();
 217       $contactID = NULL;
 218       if ($session->get('userID')) {
 219         $contactID = $session->get('userID');
 220       }
 221     }
 222
 223     $key = "{$tableName}_{$type}_{$contactID}";
 224     if (array_key_exists($key, $cache)) {
 225       $groups = &$cache[$key];
 226     }
 227     else {
 228       $groups = self::group($type, $contactID, $tableName, $allGroups, $includedGroups);
 229       $cache[$key] = $groups;
 230     }
 231
 232     return in_array($groupID, $groups) ? TRUE : FALSE;
 233   }
 234 }