CRM/Core/Permission.php

   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
  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 bool|\boolen $excludeHidden exclude hidden groups.
 193    *
 194    * @access public
 195    * @static
 196    *
 197    * @return array - array reference of all groups.
 198    */
 199   public static function group($groupType, $excludeHidden = TRUE) {
 200     $config = CRM_Core_Config::singleton();
 201     return $config->userPermissionClass->group($groupType, $excludeHidden);
 202   }
 203
 204   public static function customGroupAdmin() {
 205     $admin = FALSE;
 206
 207     // check if user has all powerful permission
 208     // or administer civicrm permission (CRM-1905)
 209     if (self::check('access all custom data')) {
 210       return TRUE;
 211     }
 212
 213     if (
 214       self::check('administer Multiple Organizations') &&
 215       self::isMultisiteEnabled()
 216     ) {
 217       return TRUE;
 218     }
 219
 220     if (self::check('administer CiviCRM')) {
 221       return TRUE;
 222     }
 223
 224     return FALSE;
 225   }
 226
 227   public static function customGroup($type = CRM_Core_Permission::VIEW, $reset = FALSE) {
 228     $customGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id',
 229       array('fresh' => $reset));
 230     $defaultGroups = array();
 231
 232     // check if user has all powerful permission
 233     // or administer civicrm permission (CRM-1905)
 234     if (self::customGroupAdmin()) {
 235       $defaultGroups = array_keys($customGroups);
 236     }
 237
 238     return CRM_ACL_API::group($type, NULL, 'civicrm_custom_group', $customGroups, $defaultGroups);
 239   }
 240
 241   static function customGroupClause($type = CRM_Core_Permission::VIEW, $prefix = NULL, $reset = FALSE) {
 242     if (self::customGroupAdmin()) {
 243       return ' ( 1 ) ';
 244     }
 245
 246     $groups = self::customGroup($type, $reset);
 247     if (empty($groups)) {
 248       return ' ( 0 ) ';
 249     }
 250     else {
 251       return "{$prefix}id IN ( " . implode(',', $groups) . ' ) ';
 252     }
 253   }
 254
 255   public static function ufGroupValid($gid, $type = CRM_Core_Permission::VIEW) {
 256     if (empty($gid)) {
 257       return TRUE;
 258     }
 259
 260     $groups = self::ufGroup($type);
 261     return in_array($gid, $groups) ? TRUE : FALSE;
 262   }
 263
 264   public static function ufGroup($type = CRM_Core_Permission::VIEW) {
 265     $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
 266
 267     $allGroups = array_keys($ufGroups);
 268
 269     // check if user has all powerful permission
 270     if (self::check('profile listings and forms')) {
 271       return $allGroups;
 272     }
 273
 274     switch ($type) {
 275       case CRM_Core_Permission::VIEW:
 276         if (self::check('profile view')) {
 277           return $allGroups;
 278         }
 279         break;
 280
 281       case CRM_Core_Permission::CREATE:
 282         if (self::check('profile create')) {
 283           return $allGroups;
 284         }
 285         break;
 286
 287       case CRM_Core_Permission::EDIT:
 288         if (self::check('profile edit')) {
 289           return $allGroups;
 290         }
 291         break;
 292
 293       case CRM_Core_Permission::SEARCH:
 294         if (self::check('profile listings')) {
 295           return $allGroups;
 296         }
 297         break;
 298     }
 299
 300     return CRM_ACL_API::group($type, NULL, 'civicrm_uf_group', $ufGroups);
 301   }
 302
 303   static function ufGroupClause($type = CRM_Core_Permission::VIEW, $prefix = NULL, $returnUFGroupIds = FALSE) {
 304     $groups = self::ufGroup($type);
 305     if ($returnUFGroupIds) {
 306       return $groups;
 307     }
 308     elseif (empty($groups)) {
 309       return ' ( 0 ) ';
 310     }
 311     else {
 312       return "{$prefix}id IN ( " . implode(',', $groups) . ' ) ';
 313     }
 314   }
 315
 316   public static function event($type = CRM_Core_Permission::VIEW, $eventID = NULL) {
 317     $events = CRM_Event_PseudoConstant::event(NULL, TRUE);
 318     $includeEvents = array();
 319
 320     // check if user has all powerful permission
 321     if (self::check('register for events')) {
 322       $includeEvents = array_keys($events);
 323     }
 324
 325     if ($type == CRM_Core_Permission::VIEW &&
 326       self::check('view event info')
 327     ) {
 328       $includeEvents = array_keys($events);
 329     }
 330
 331     $permissionedEvents = CRM_ACL_API::group($type, NULL, 'civicrm_event', $events, $includeEvents);
 332     if (!$eventID) {
 333       return $permissionedEvents;
 334     }
 335     if (!empty($permissionedEvents)) {
 336       return array_search($eventID, $permissionedEvents) === FALSE ? NULL : $eventID;
 337     }
 338     return NULL;
 339   }
 340
 341   static function eventClause($type = CRM_Core_Permission::VIEW, $prefix = NULL) {
 342     $events = self::event($type);
 343     if (empty($events)) {
 344       return ' ( 0 ) ';
 345     }
 346     else {
 347       return "{$prefix}id IN ( " . implode(',', $events) . ' ) ';
 348     }
 349   }
 350
 351   static function access($module, $checkPermission = TRUE) {
 352     $config = CRM_Core_Config::singleton();
 353
 354     if (!in_array($module, $config->enableComponents)) {
 355       return FALSE;
 356     }
 357
 358     if ($checkPermission) {
 359       if ($module == 'CiviCase') {
 360         return CRM_Case_BAO_Case::accessCiviCase();
 361       }
 362       else {
 363         return CRM_Core_Permission::check("access $module");
 364       }
 365     }
 366
 367     return TRUE;
 368   }
 369
 370   /**
 371    * check permissions for delete and edit actions
 372    *
 373    * @param string $module component name.
 374    * @param $action action to be check across component
 375    *
 376    *
 377    * @return bool
 378    */
 379   static function checkActionPermission($module, $action) {
 380     //check delete related permissions.
 381     if ($action & CRM_Core_Action::DELETE) {
 382       $permissionName = "delete in $module";
 383     }
 384     else {
 385       $editPermissions = array(
 386         'CiviEvent' => 'edit event participants',
 387         'CiviMember' => 'edit memberships',
 388         'CiviPledge' => 'edit pledges',
 389         'CiviContribute' => 'edit contributions',
 390         'CiviGrant' => 'edit grants',
 391         'CiviMail' => 'access CiviMail',
 392         'CiviAuction' => 'add auction items',
 393       );
 394       $permissionName = CRM_Utils_Array::value($module, $editPermissions);
 395     }
 396
 397     if ($module == 'CiviCase' && !$permissionName) {
 398       return CRM_Case_BAO_Case::accessCiviCase();
 399     }
 400     else {
 401       //check for permission.
 402       return CRM_Core_Permission::check($permissionName);
 403     }
 404   }
 405
 406   static function checkMenu(&$args, $op = 'and') {
 407     if (!is_array($args)) {
 408       return $args;
 409     }
 410     foreach ($args as $str) {
 411       $res = CRM_Core_Permission::check($str);
 412       if ($op == 'or' && $res) {
 413         return TRUE;
 414       }
 415       elseif ($op == 'and' && !$res) {
 416         return FALSE;
 417       }
 418     }
 419     return ($op == 'or') ? FALSE : TRUE;
 420   }
 421
 422   static function checkMenuItem(&$item) {
 423     if (!array_key_exists('access_callback', $item)) {
 424       CRM_Core_Error::backtrace();
 425       CRM_Core_Error::fatal();
 426     }
 427
 428     // if component_id is present, ensure it is enabled
 429     if (isset($item['component_id']) &&
 430       $item['component_id']
 431     ) {
 432       $config = CRM_Core_Config::singleton();
 433       if (is_array($config->enableComponentIDs) &&
 434         in_array($item['component_id'], $config->enableComponentIDs)
 435       ) {
 436         // continue with process
 437       }
 438       else {
 439         return FALSE;
 440       }
 441     }
 442
 443     // the following is imitating drupal 6 code in includes/menu.inc
 444     if (empty($item['access_callback']) ||
 445       is_numeric($item['access_callback'])
 446     ) {
 447       return (boolean ) $item['access_callback'];
 448     }
 449
 450     // check whether the following Ajax requests submitted the right key
 451     // FIXME: this should be integrated into ACLs proper
 452     if (CRM_Utils_Array::value('page_type', $item) == 3) {
 453       if (!CRM_Core_Key::validate($_REQUEST['key'], $item['path'])) {
 454         return FALSE;
 455       }
 456     }
 457
 458     // check if callback is for checkMenu, if so optimize it
 459     if (is_array($item['access_callback']) &&
 460       $item['access_callback'][0] == 'CRM_Core_Permission' &&
 461       $item['access_callback'][1] == 'checkMenu'
 462     ) {
 463       $op = CRM_Utils_Array::value(1, $item['access_arguments'], 'and');
 464       return self::checkMenu($item['access_arguments'][0], $op);
 465     }
 466     else {
 467       return call_user_func_array($item['access_callback'], $item['access_arguments']);
 468     }
 469   }
 470
 471   static function &basicPermissions($all = FALSE) {
 472     static $permissions = NULL;
 473
 474     if (!$permissions) {
 475       $config = CRM_Core_Config::singleton();
 476       $prefix = ts('CiviCRM') . ': ';
 477       $permissions = self::getCorePermissions();
 478
 479       if (self::isMultisiteEnabled()) {
 480         $permissions['administer Multiple Organizations'] = $prefix . ts('administer Multiple Organizations');
 481       }
 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       $module_permissions = $config->userPermissionClass->getAllModulePermissions();
 502       $permissions = array_merge($permissions, $module_permissions);
 503     }
 504
 505     return $permissions;
 506   }
 507
 508   static function getAnonymousPermissionsWarnings() {
 509     static $permissions = array();
 510     if (empty($permissions)) {
 511       $permissions = array(
 512         'administer CiviCRM'
 513       );
 514       $components = CRM_Core_Component::getComponents();
 515       foreach ($components as $comp) {
 516         if (!method_exists($comp, 'getAnonymousPermissionWarnings')) {
 517           continue;
 518         }
 519         $permissions = array_merge($permissions, $comp->getAnonymousPermissionWarnings());
 520       }
 521     }
 522     return $permissions;
 523   }
 524
 525   static function validateForPermissionWarnings($anonymous_perms) {
 526     return array_intersect($anonymous_perms, self::getAnonymousPermissionsWarnings());
 527   }
 528
 529   static function getCorePermissions() {
 530     $prefix = ts('CiviCRM') . ': ';
 531     $permissions = array(
 532       'add contacts' => $prefix . ts('add contacts'),
 533       'view all contacts' => $prefix . ts('view all contacts'),
 534       'edit all contacts' => $prefix . ts('edit all contacts'),
 535       'view my contact' => $prefix . ts('view my contact'),
 536       'edit my contact' => $prefix . ts('edit my contact'),
 537       'delete contacts' => $prefix . ts('delete contacts'),
 538       'access deleted contacts' => $prefix . ts('access deleted contacts'),
 539       'import contacts' => $prefix . ts('import contacts'),
 540       'edit groups' => $prefix . ts('edit groups'),
 541       'administer CiviCRM' => $prefix . ts('administer CiviCRM'),
 542       'skip IDS check' => $prefix . ts('skip IDS check'),
 543       'access uploaded files' => $prefix . ts('access uploaded files'),
 544       'profile listings and forms' => $prefix . ts('profile listings and forms'),
 545       'profile listings' => $prefix . ts('profile listings'),
 546       'profile create' => $prefix . ts('profile create'),
 547       'profile edit' => $prefix . ts('profile edit'),
 548       'profile view' => $prefix . ts('profile view'),
 549       'access all custom data' => $prefix . ts('access all custom data'),
 550       'view all activities' => $prefix . ts('view all activities'),
 551       'delete activities' => $prefix . ts('delete activities'),
 552       'access CiviCRM' => $prefix . ts('access CiviCRM'),
 553       'access Contact Dashboard' => $prefix . ts('access Contact Dashboard'),
 554       'translate CiviCRM' => $prefix . ts('translate CiviCRM'),
 555       'administer reserved groups' => $prefix . ts('administer reserved groups'),
 556       'administer Tagsets' => $prefix . ts('administer Tagsets'),
 557       'administer reserved tags' => $prefix . ts('administer reserved tags'),
 558       'administer dedupe rules' => $prefix . ts('administer dedupe rules'),
 559       'merge duplicate contacts' => $prefix . ts('merge duplicate contacts'),
 560       'view debug output' => $prefix . ts('view debug output'),
 561       'view all notes' => $prefix . ts('view all notes'),
 562       'access AJAX API' => $prefix . ts('access AJAX API'),
 563       'access contact reference fields' => $prefix . ts('access contact reference fields'),
 564       'create manual batch' => $prefix . ts('create manual batch'),
 565       'edit own manual batches' => $prefix . ts('edit own manual batches'),
 566       'edit all manual batches' => $prefix . ts('edit all manual batches'),
 567       'view own manual batches' => $prefix . ts('view own manual batches'),
 568       'view all manual batches' => $prefix . ts('view all manual batches'),
 569       'delete own manual batches' => $prefix . ts('delete own manual batches'),
 570       'delete all manual batches' => $prefix . ts('delete all manual batches'),
 571       'export own manual batches' => $prefix . ts('export own manual batches'),
 572       'export all manual batches' => $prefix . ts('export all manual batches'),
 573       'administer payment processors' => $prefix . ts('administer payment processors'),
 574     );
 575
 576     return $permissions;
 577   }
 578
 579   /**
 580    * Validate user permission across
 581    * edit or view or with supportable acls.
 582    *
 583    * return boolean true/false.
 584    **/
 585   static function giveMeAllACLs() {
 586     if (CRM_Core_Permission::check('view all contacts') ||
 587       CRM_Core_Permission::check('edit all contacts')
 588     ) {
 589       return TRUE;
 590     }
 591
 592     $session = CRM_Core_Session::singleton();
 593     $contactID = $session->get('userID');
 594
 595     //check for acl.
 596     $aclPermission = self::getPermission();
 597     if (in_array($aclPermission, array(
 598       CRM_Core_Permission::EDIT,
 599       CRM_Core_Permission::VIEW,
 600     ))
 601     ) {
 602       return TRUE;
 603     }
 604
 605     // run acl where hook and see if the user is supplying an ACL clause
 606     // that is not false
 607     $tables = $whereTables = array();
 608     $where = NULL;
 609
 610     CRM_Utils_Hook::aclWhereClause(CRM_Core_Permission::VIEW,
 611       $tables, $whereTables,
 612       $contactID, $where
 613     );
 614     return empty($whereTables) ? FALSE : TRUE;
 615   }
 616
 617   /**
 618    * Function to get component name from given permission.
 619    *
 620    * @param string $permission
 621    *
 622    * return string $componentName the name of component.
 623    *
 624    * @return int|null|string
 625    * @static
 626    */
 627   static function getComponentName($permission) {
 628     $componentName = NULL;
 629     $permission = trim($permission);
 630     if (empty($permission)) {
 631       return $componentName;
 632     }
 633
 634     static $allCompPermissions = array();
 635     if (empty($allCompPermissions)) {
 636       $components = CRM_Core_Component::getComponents();
 637       foreach ($components as $name => $comp) {
 638         //get all permissions of each components unconditionally
 639         $allCompPermissions[$name] = $comp->getPermissions(TRUE);
 640       }
 641     }
 642
 643     if (is_array($allCompPermissions)) {
 644       foreach ($allCompPermissions as $name => $permissions) {
 645         if (in_array($permission, $permissions)) {
 646           $componentName = $name;
 647           break;
 648         }
 649       }
 650     }
 651
 652     return $componentName;
 653   }
 654
 655   /**
 656    * Get all the contact emails for users that have a specific permission
 657    *
 658    * @param string $permissionName name of the permission we are interested in
 659    *
 660    * @return string a comma separated list of email addresses
 661    */
 662   public static function permissionEmails($permissionName) {
 663     $config = CRM_Core_Config::singleton();
 664     return $config->userPermissionClass->permissionEmails($permissionName);
 665   }
 666
 667   /**
 668    * Get all the contact emails for users that have a specific role
 669    *
 670    * @param string $roleName name of the role we are interested in
 671    *
 672    * @return string a comma separated list of email addresses
 673    */
 674   public static function roleEmails($roleName) {
 675     $config = CRM_Core_Config::singleton();
 676     return $config->userRoleClass->roleEmails($roleName);
 677   }
 678
 679   static function isMultisiteEnabled() {
 680     return CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME,
 681       'is_enabled'
 682     ) ? TRUE : FALSE;
 683   }
 684 }