CRM/ACL/API.php

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