CRM/Core/Permission.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This is the basic permission class wrapper
  38  */
  39 class CRM_Core_Permission {
  40
  41   /**
  42    * Static strings used to compose permissions
  43    *
  44    * @const
  45    * @var string
  46    */
  47   CONST EDIT_GROUPS = 'edit contacts in ', VIEW_GROUPS = 'view contacts in ';
  48
  49   /**
  50    * The various type of permissions
  51    *
  52    * @var int
  53    */
  54   CONST EDIT = 1, VIEW = 2, DELETE = 3, CREATE = 4, SEARCH = 5, ALL = 6, ADMIN = 7;
  55
  56   /**
  57    * A placeholder permission which always fails
  58    */
  59   const ALWAYS_DENY_PERMISSION = "*always deny*";
  60
  61   /**
  62    * A placeholder permission which always fails
  63    */
  64   const ALWAYS_ALLOW_PERMISSION = "*always allow*";
  65
  66   /**
  67    * Various authentication sources
  68    *
  69    * @var int
  70    */
  71   CONST AUTH_SRC_UNKNOWN = 0, AUTH_SRC_CHECKSUM = 1, AUTH_SRC_SITEKEY = 2, AUTH_SRC_LOGIN = 4;
  72
  73   /**
  74    * get the current permission of this user
  75    *
  76    * @return string the permission of the user (edit or view or null)
  77    */
  78   public static function getPermission() {
  79     $config = CRM_Core_Config::singleton();
  80     return $config->userPermissionClass->getPermission();
  81   }
  82
  83   /**
  84    * given a permission string or array, check for access requirements
  85    * @param mixed $permissions the permission to check as an array or string -see examples
  86    *  arrays
  87    *
  88    *  Ex 1
  89    *
  90    *  Must have 'access CiviCRM'
  91    *  (string) 'access CiviCRM'
  92    *
  93    *
  94    *  Ex 2 Must have 'access CiviCRM' and 'access Ajax API'
  95    *   array('access CiviCRM', 'access Ajax API')
  96    *
  97    *  Ex 3 Must have 'access CiviCRM' or 'access Ajax API'
  98    *   array(
  99    *      array('access CiviCRM', 'access Ajax API'),
 100    *   ),
 101    *
 102    *  Ex 4 Must have 'access CiviCRM' or 'access Ajax API' AND 'access CiviEvent'
 103    *  array(
 104    *    array('access CiviCRM', 'access Ajax API'),
 105    *    'access CiviEvent',
 106    *   ),
 107    *
 108    *  Note that in permissions.php this is keyed by the action eg.
 109    *  (access Civi || access AJAX) && (access CiviEvent || access CiviContribute)
 110    *  'myaction' => array(
 111    *    array('access CiviCRM', 'access Ajax API'),
 112    *    array('access CiviEvent', 'access CiviContribute')
 113    *  ),
 114    *
 115    * @return boolean true if yes, else false
 116    * @static
 117    * @access public
 118    */
 119   static function check($permissions) {
 120     $permissions = (array) $permissions;
 121
 122     foreach ($permissions as $permission) {
 123       if(is_array($permission)) {
 124         foreach ($permission as $orPerm) {
 125           if(self::check($orPerm)) {
 126             //one of our 'or' permissions has succeeded - stop checking this permission
 127             return TRUE;;
 128           }
 129         }
 130         //none of our our conditions was met
 131         return FALSE;
 132       }
 133       else {
 134         if(!CRM_Core_Config::singleton()->userPermissionClass->check($permission)) {
 135           //one of our 'and' conditions has not been met
 136           return FALSE;
 137         }
 138       }
 139     }
 140     return TRUE;
 141   }
 142
 143   /**
 144    * Determine if any one of the permissions strings applies to current user
 145    *
 146    * @param array $perms
 147    * @return bool
 148    */
 149   public static function checkAnyPerm($perms) {
 150     foreach ($perms as $perm) {
 151       if (CRM_Core_Permission::check($perm)) {
 152         return TRUE;
 153       }
 154     }
 155     return FALSE;
 156   }
 157
 158   /**
 159    * Given a group/role array, check for access requirements
 160    *
 161    * @param array $array the group/role to check
 162    *
 163    * @return boolean true if yes, else false
 164    * @static
 165    * @access public
 166    */
 167   static function checkGroupRole($array) {
 168     $config = CRM_Core_Config::singleton();
 169     return $config->userPermissionClass->checkGroupRole($array);
 170   }
 171
 172   /**
 173    * Get the permissioned where clause for the user
 174    *
 175    * @param int $type the type of permission needed
 176    * @param  array $tables (reference ) add the tables that are needed for the select clause
 177    * @param  array $whereTables (reference ) add the tables that are needed for the where clause
 178    *
 179    * @return string the group where clause for this user
 180    * @access public
 181    */
 182   public static function getPermissionedStaticGroupClause($type, &$tables, &$whereTables) {
 183     $config = CRM_Core_Config::singleton();
 184     return $config->userPermissionClass->getPermissionedStaticGroupClause($type, $tables, $whereTables);
 185   }
 186
 187   /**
 188    * Get all groups from database, filtered by permissions
 189    * for this user
 190    *
 191    * @param string $groupType     type of group(Access/Mailing)
 192    * @param boolen $excludeHidden exclude hidden groups.
 193    *
 194    * @access public
 195    * @static
 196    *
 197    * @return array - array reference of all groups.
 198    *
 199    */
 200   public static function group($groupType, $excludeHidden = TRUE) {
 201     $config = CRM_Core_Config::singleton();
 202     return $config->userPermissionClass->group($groupType, $excludeHidden);
 203   }
 204
 205   public static function customGroupAdmin() {
 206     $admin = FALSE;
 207
 208     // check if user has all powerful permission
 209     // or administer civicrm permission (CRM-1905)
 210     if (self::check('access all custom data')) {
 211       return TRUE;
 212     }
 213
 214     if (
 215       self::check('administer Multiple Organizations') &&
 216       self::isMultisiteEnabled()
 217     ) {
 218       return TRUE;
 219     }
 220
 221     if (self::check('administer CiviCRM')) {
 222       return TRUE;
 223     }
 224
 225     return FALSE;
 226   }
 227
 228   public static function customGroup($type = CRM_Core_Permission::VIEW, $reset = FALSE) {
 229     $customGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id',
 230       array('fresh' => $reset));
 231     $defaultGroups = array();
 232
 233     // check if user has all powerful permission
 234     // or administer civicrm permission (CRM-1905)
 235     if (self::customGroupAdmin()) {
 236       $defaultGroups = array_keys($customGroups);
 237     }
 238
 239     return CRM_ACL_API::group($type, NULL, 'civicrm_custom_group', $customGroups, $defaultGroups);
 240   }
 241
 242   static function customGroupClause($type = CRM_Core_Permission::VIEW, $prefix = NULL, $reset = FALSE) {
 243     if (self::customGroupAdmin()) {
 244       return ' ( 1 ) ';
 245     }
 246
 247     $groups = self::customGroup($type, $reset);
 248     if (empty($groups)) {
 249       return ' ( 0 ) ';
 250     }
 251     else {
 252       return "{$prefix}id IN ( " . implode(',', $groups) . ' ) ';
 253     }
 254   }
 255
 256   public static function ufGroupValid($gid, $type = CRM_Core_Permission::VIEW) {
 257     if (empty($gid)) {
 258       return TRUE;
 259     }
 260
 261     $groups = self::ufGroup($type);
 262     return in_array($gid, $groups) ? TRUE : FALSE;
 263   }
 264
 265   public static function ufGroup($type = CRM_Core_Permission::VIEW) {
 266     $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
 267
 268     $allGroups = array_keys($ufGroups);
 269
 270     // check if user has all powerful permission
 271     if (self::check('profile listings and forms')) {
 272       return $allGroups;
 273     }
 274
 275     switch ($type) {
 276       case CRM_Core_Permission::VIEW:
 277         if (self::check('profile view')) {
 278           return $allGroups;
 279         }
 280         break;
 281
 282       case CRM_Core_Permission::CREATE:
 283         if (self::check('profile create')) {
 284           return $allGroups;
 285         }
 286         break;
 287
 288       case CRM_Core_Permission::EDIT:
 289         if (self::check('profile edit')) {
 290           return $allGroups;
 291         }
 292         break;
 293
 294       case CRM_Core_Permission::SEARCH:
 295         if (self::check('profile listings')) {
 296           return $allGroups;
 297         }
 298         break;
 299     }
 300
 301     return CRM_ACL_API::group($type, NULL, 'civicrm_uf_group', $ufGroups);
 302   }
 303
 304   static function ufGroupClause($type = CRM_Core_Permission::VIEW, $prefix = NULL, $returnUFGroupIds = FALSE) {
 305     $groups = self::ufGroup($type);
 306     if ($returnUFGroupIds) {
 307       return $groups;
 308     }
 309     elseif (empty($groups)) {
 310       return ' ( 0 ) ';
 311     }
 312     else {
 313       return "{$prefix}id IN ( " . implode(',', $groups) . ' ) ';
 314     }
 315   }
 316
 317   public static function event($type = CRM_Core_Permission::VIEW, $eventID = NULL) {
 318     $events = CRM_Event_PseudoConstant::event(NULL, TRUE);
 319     $includeEvents = array();
 320
 321     // check if user has all powerful permission
 322     if (self::check('register for events')) {
 323       $includeEvents = array_keys($events);
 324     }
 325
 326     if ($type == CRM_Core_Permission::VIEW &&
 327       self::check('view event info')
 328     ) {
 329       $includeEvents = array_keys($events);
 330     }
 331
 332     $permissionedEvents = CRM_ACL_API::group($type, NULL, 'civicrm_event', $events, $includeEvents);
 333     if (!$eventID) {
 334       return $permissionedEvents;
 335     }
 336     if (!empty($permissionedEvents)) {
 337       return array_search($eventID, $permissionedEvents) === FALSE ? NULL : $eventID;
 338     }
 339     return NULL;
 340   }
 341
 342   static function eventClause($type = CRM_Core_Permission::VIEW, $prefix = NULL) {
 343     $events = self::event($type);
 344     if (empty($events)) {
 345       return ' ( 0 ) ';
 346     }
 347     else {
 348       return "{$prefix}id IN ( " . implode(',', $events) . ' ) ';
 349     }
 350   }
 351
 352   static function access($module, $checkPermission = TRUE) {
 353     $config = CRM_Core_Config::singleton();
 354
 355     if (!in_array($module, $config->enableComponents)) {
 356       return FALSE;
 357     }
 358
 359     if ($checkPermission) {
 360       if ($module == 'CiviCase') {
 361         return CRM_Case_BAO_Case::accessCiviCase();
 362       }
 363       else {
 364         return CRM_Core_Permission::check("access $module");
 365       }
 366     }
 367
 368     return TRUE;
 369   }
 370
 371   /**
 372    * check permissions for delete and edit actions
 373    *
 374    * @param string $module component name.
 375    * @param $action action to be check across component
 376    *
 377    **/
 378   static function checkActionPermission($module, $action) {
 379     //check delete related permissions.
 380     if ($action & CRM_Core_Action::DELETE) {
 381       $permissionName = "delete in $module";
 382     }
 383     else {
 384       $editPermissions = array(
 385         'CiviEvent' => 'edit event participants',
 386         'CiviMember' => 'edit memberships',
 387         'CiviPledge' => 'edit pledges',
 388         'CiviContribute' => 'edit contributions',
 389         'CiviGrant' => 'edit grants',
 390         'CiviMail' => 'access CiviMail',
 391         'CiviAuction' => 'add auction items',
 392       );
 393       $permissionName = CRM_Utils_Array::value($module, $editPermissions);
 394     }
 395
 396     if ($module == 'CiviCase' && !$permissionName) {
 397       return CRM_Case_BAO_Case::accessCiviCase();
 398     }
 399     else {
 400       //check for permission.
 401       return CRM_Core_Permission::check($permissionName);
 402     }
 403   }
 404
 405   static function checkMenu(&$args, $op = 'and') {
 406     if (!is_array($args)) {
 407       return $args;
 408     }
 409     foreach ($args as $str) {
 410       $res = CRM_Core_Permission::check($str);
 411       if ($op == 'or' && $res) {
 412         return TRUE;
 413       }
 414       elseif ($op == 'and' && !$res) {
 415         return FALSE;
 416       }
 417     }
 418     return ($op == 'or') ? FALSE : TRUE;
 419   }
 420
 421   static function checkMenuItem(&$item) {
 422     if (!array_key_exists('access_callback', $item)) {
 423       CRM_Core_Error::backtrace();
 424       CRM_Core_Error::fatal();
 425     }
 426
 427     // if component_id is present, ensure it is enabled
 428     if (isset($item['component_id']) &&
 429       $item['component_id']
 430     ) {
 431       $config = CRM_Core_Config::singleton();
 432       if (is_array($config->enableComponentIDs) &&
 433         in_array($item['component_id'], $config->enableComponentIDs)
 434       ) {
 435         // continue with process
 436       }
 437       else {
 438         return FALSE;
 439       }
 440     }
 441
 442     // the following is imitating drupal 6 code in includes/menu.inc
 443     if (empty($item['access_callback']) ||
 444       is_numeric($item['access_callback'])
 445     ) {
 446       return (boolean ) $item['access_callback'];
 447     }
 448
 449     // check whether the following Ajax requests submitted the right key
 450     // FIXME: this should be integrated into ACLs proper
 451     if (CRM_Utils_Array::value('page_type', $item) == 3) {
 452       if (!CRM_Core_Key::validate($_REQUEST['key'], $item['path'])) {
 453         return FALSE;
 454       }
 455     }
 456
 457     // check if callback is for checkMenu, if so optimize it
 458     if (is_array($item['access_callback']) &&
 459       $item['access_callback'][0] == 'CRM_Core_Permission' &&
 460       $item['access_callback'][1] == 'checkMenu'
 461     ) {
 462       $op = CRM_Utils_Array::value(1, $item['access_arguments'], 'and');
 463       return self::checkMenu($item['access_arguments'][0], $op);
 464     }
 465     else {
 466       return call_user_func_array($item['access_callback'], $item['access_arguments']);
 467     }
 468   }
 469
 470   static function &basicPermissions($all = FALSE) {
 471     static $permissions = NULL;
 472
 473     if (!$permissions) {
 474       $prefix = ts('CiviCRM') . ': ';
 475       $permissions = self::getCorePermissions();
 476
 477       if (self::isMultisiteEnabled()) {
 478         $permissions['administer Multiple Organizations'] = $prefix . ts('administer Multiple Organizations');
 479       }
 480
 481       $config = CRM_Core_Config::singleton();
 482
 483       if (!$all) {
 484         $components = CRM_Core_Component::getEnabledComponents();
 485       }
 486       else {
 487         $components = CRM_Core_Component::getComponents();
 488       }
 489
 490       foreach ($components as $comp) {
 491         $perm = $comp->getPermissions();
 492         if ($perm) {
 493           $info = $comp->getInfo();
 494           foreach ($perm as $p) {
 495             $permissions[$p] = $info['translatedName'] . ': ' . $p;
 496           }
 497         }
 498       }
 499
 500       // Add any permissions defined in hook_civicrm_permission implementations.
 501       $config = CRM_Core_Config::singleton();
 502       $module_permissions = $config->userPermissionClass->getAllModulePermissions();
 503       $permissions = array_merge($permissions, $module_permissions);
 504     }
 505
 506     return $permissions;
 507   }
 508
 509   static function getCorePermissions() {
 510     $prefix = ts('CiviCRM') . ': ';
 511     $permissions = array(
 512       'add contacts' => $prefix . ts('add contacts'),
 513       'view all contacts' => $prefix . ts('view all contacts'),
 514       'edit all contacts' => $prefix . ts('edit all contacts'),
 515       'view my contact' => $prefix . ts('view my contact'),
 516       'edit my contact' => $prefix . ts('edit my contact'),
 517       'delete contacts' => $prefix . ts('delete contacts'),
 518       'access deleted contacts' => $prefix . ts('access deleted contacts'),
 519       'import contacts' => $prefix . ts('import contacts'),
 520       'edit groups' => $prefix . ts('edit groups'),
 521       'administer CiviCRM' => $prefix . ts('administer CiviCRM'),
 522       'skip IDS check' => $prefix . ts('skip IDS check'),
 523       'access uploaded files' => $prefix . ts('access uploaded files'),
 524       'profile listings and forms' => $prefix . ts('profile listings and forms'),
 525       'profile listings' => $prefix . ts('profile listings'),
 526       'profile create' => $prefix . ts('profile create'),
 527       'profile edit' => $prefix . ts('profile edit'),
 528       'profile view' => $prefix . ts('profile view'),
 529       'access all custom data' => $prefix . ts('access all custom data'),
 530       'view all activities' => $prefix . ts('view all activities'),
 531       'delete activities' => $prefix . ts('delete activities'),
 532       'access CiviCRM' => $prefix . ts('access CiviCRM'),
 533       'access Contact Dashboard' => $prefix . ts('access Contact Dashboard'),
 534       'translate CiviCRM' => $prefix . ts('translate CiviCRM'),
 535       'administer reserved groups' => $prefix . ts('administer reserved groups'),
 536       'administer Tagsets' => $prefix . ts('administer Tagsets'),
 537       'administer reserved tags' => $prefix . ts('administer reserved tags'),
 538       'administer dedupe rules' => $prefix . ts('administer dedupe rules'),
 539       'merge duplicate contacts' => $prefix . ts('merge duplicate contacts'),
 540       'view debug output' => $prefix . ts('view debug output'),
 541       'view all notes' => $prefix . ts('view all notes'),
 542       'access AJAX API' => $prefix . ts('access AJAX API'),
 543       'access contact reference fields' => $prefix . ts('access contact reference fields'),
 544       'create manual batch' => $prefix . ts('create manual batch'),
 545       'edit own manual batches' => $prefix . ts('edit own manual batches'),
 546       'edit all manual batches' => $prefix . ts('edit all manual batches'),
 547       'view own manual batches' => $prefix . ts('view own manual batches'),
 548       'view all manual batches' => $prefix . ts('view all manual batches'),
 549       'delete own manual batches' => $prefix . ts('delete own manual batches'),
 550       'delete all manual batches' => $prefix . ts('delete all manual batches'),
 551       'export own manual batches' => $prefix . ts('export own manual batches'),
 552       'export all manual batches' => $prefix . ts('export all manual batches'),
 553     );
 554
 555     return $permissions;
 556   }
 557
 558   /**
 559    * Validate user permission across
 560    * edit or view or with supportable acls.
 561    *
 562    * return boolean true/false.
 563    **/
 564   static function giveMeAllACLs() {
 565     if (CRM_Core_Permission::check('view all contacts') ||
 566       CRM_Core_Permission::check('edit all contacts')
 567     ) {
 568       return TRUE;
 569     }
 570
 571     $session = CRM_Core_Session::singleton();
 572     $contactID = $session->get('userID');
 573
 574     //check for acl.
 575     $aclPermission = self::getPermission();
 576     if (in_array($aclPermission, array(
 577       CRM_Core_Permission::EDIT,
 578       CRM_Core_Permission::VIEW,
 579     ))
 580     ) {
 581       return TRUE;
 582     }
 583
 584     // run acl where hook and see if the user is supplying an ACL clause
 585     // that is not false
 586     $tables = $whereTables = array();
 587     $where = NULL;
 588
 589     CRM_Utils_Hook::aclWhereClause(CRM_Core_Permission::VIEW,
 590       $tables, $whereTables,
 591       $contactID, $where
 592     );
 593     return empty($whereTables) ? FALSE : TRUE;
 594   }
 595
 596   /**
 597    * Function to get component name from given permission.
 598    *
 599    * @param string $permission
 600    *
 601    * return string $componentName the name of component.
 602    * @static
 603    */
 604   static function getComponentName($permission) {
 605     $componentName = NULL;
 606     $permission = trim($permission);
 607     if (empty($permission)) {
 608       return $componentName;
 609     }
 610
 611     static $allCompPermissions = array();
 612     if (empty($allCompPermissions)) {
 613       $components = CRM_Core_Component::getComponents();
 614       foreach ($components as $name => $comp) {
 615         //get all permissions of each components unconditionally
 616         $allCompPermissions[$name] = $comp->getPermissions(TRUE);
 617       }
 618     }
 619
 620     if (is_array($allCompPermissions)) {
 621       foreach ($allCompPermissions as $name => $permissions) {
 622         if (in_array($permission, $permissions)) {
 623           $componentName = $name;
 624           break;
 625         }
 626       }
 627     }
 628
 629     return $componentName;
 630   }
 631
 632   /**
 633    * Get all the contact emails for users that have a specific permission
 634    *
 635    * @param string $permissionName name of the permission we are interested in
 636    *
 637    * @return string a comma separated list of email addresses
 638    */
 639   public static function permissionEmails($permissionName) {
 640     $config = CRM_Core_Config::singleton();
 641     return $config->userPermissionClass->permissionEmails($permissionName);
 642   }
 643
 644   /**
 645    * Get all the contact emails for users that have a specific role
 646    *
 647    * @param string $roleName name of the role we are interested in
 648    *
 649    * @return string a comma separated list of email addresses
 650    */
 651   public static function roleEmails($roleName) {
 652     $config = CRM_Core_Config::singleton();
 653     return $config->userRoleClass->roleEmails($roleName);
 654   }
 655
 656   static function isMultisiteEnabled() {
 657     return CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME,
 658       'is_enabled'
 659     ) ? TRUE : FALSE;
 660   }
 661 }