CRM/Core/Permission.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  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
  77    *   the permission of the user (edit or view or null)
  78    */
  79   public static function getPermission() {
  80     $config = CRM_Core_Config::singleton();
  81     return $config->userPermissionClass->getPermission();
  82   }
  83
  84   /**
  85    * Given a permission string or array, check for access requirements
  86    * @param mixed $permissions
  87    *   The permission to check as an array or string -see examples.
  88    *   arrays
  89    *
  90    *  Ex 1
  91    *
  92    *  Must have 'access CiviCRM'
  93    *  (string) 'access CiviCRM'
  94    *
  95    *
  96    *  Ex 2 Must have 'access CiviCRM' and 'access Ajax API'
  97    *   array('access CiviCRM', 'access Ajax API')
  98    *
  99    *  Ex 3 Must have 'access CiviCRM' or 'access Ajax API'
 100    *   array(
 101    *      array('access CiviCRM', 'access Ajax API'),
 102    *   ),
 103    *
 104    *  Ex 4 Must have 'access CiviCRM' or 'access Ajax API' AND 'access CiviEvent'
 105    *  array(
 106    *    array('access CiviCRM', 'access Ajax API'),
 107    *    'access CiviEvent',
 108    *   ),
 109    *
 110    *  Note that in permissions.php this is keyed by the action eg.
 111    *  (access Civi || access AJAX) && (access CiviEvent || access CiviContribute)
 112    *  'myaction' => array(
 113    *    array('access CiviCRM', 'access Ajax API'),
 114    *    array('access CiviEvent', 'access CiviContribute')
 115    *  ),
 116    *
 117    * @return bool
 118    *   true if yes, else false
 119    */
 120   public static function check($permissions) {
 121     $permissions = (array) $permissions;
 122
 123     $tempPerm = CRM_Core_Config::singleton()->userPermissionTemp;
 124
 125     foreach ($permissions as $permission) {
 126       if (is_array($permission)) {
 127         foreach ($permission as $orPerm) {
 128           if (self::check($orPerm)) {
 129             //one of our 'or' permissions has succeeded - stop checking this permission
 130             return TRUE;
 131           }
 132         }
 133         //none of our our conditions was met
 134         return FALSE;
 135       }
 136       else {
 137         // This is an individual permission
 138         $granted = CRM_Core_Config::singleton()->userPermissionClass->check($permission);
 139         // Call the permission_check hook to permit dynamic escalation (CRM-19256)
 140         CRM_Utils_Hook::permission_check($permission, $granted);
 141         if (
 142           !$granted
 143           && !($tempPerm && $tempPerm->check($permission))
 144         ) {
 145           //one of our 'and' conditions has not been met
 146           return FALSE;
 147         }
 148       }
 149     }
 150     return TRUE;
 151   }
 152
 153   /**
 154    * Determine if any one of the permissions strings applies to current user.
 155    *
 156    * @param array $perms
 157    * @return bool
 158    */
 159   public static function checkAnyPerm($perms) {
 160     foreach ($perms as $perm) {
 161       if (CRM_Core_Permission::check($perm)) {
 162         return TRUE;
 163       }
 164     }
 165     return FALSE;
 166   }
 167
 168   /**
 169    * Given a group/role array, check for access requirements
 170    *
 171    * @param array $array
 172    *   The group/role to check.
 173    *
 174    * @return bool
 175    *   true if yes, else false
 176    */
 177   public static function checkGroupRole($array) {
 178     $config = CRM_Core_Config::singleton();
 179     return $config->userPermissionClass->checkGroupRole($array);
 180   }
 181
 182   /**
 183    * Get the permissioned where clause for the user.
 184    *
 185    * @param int $type
 186    *   The type of permission needed.
 187    * @param array $tables
 188    *   (reference ) add the tables that are needed for the select clause.
 189    * @param array $whereTables
 190    *   (reference ) add the tables that are needed for the where clause.
 191    *
 192    * @return string
 193    *   the group where clause for this user
 194    */
 195   public static function getPermissionedStaticGroupClause($type, &$tables, &$whereTables) {
 196     $config = CRM_Core_Config::singleton();
 197     return $config->userPermissionClass->getPermissionedStaticGroupClause($type, $tables, $whereTables);
 198   }
 199
 200   /**
 201    * Get all groups from database, filtered by permissions
 202    * for this user
 203    *
 204    * @param string $groupType
 205    *   Type of group(Access/Mailing).
 206    * @param bool $excludeHidden
 207    *   exclude hidden groups.
 208    *
 209    *
 210    * @return array
 211    *   array reference of all groups.
 212    */
 213   public static function group($groupType, $excludeHidden = TRUE) {
 214     $config = CRM_Core_Config::singleton();
 215     return $config->userPermissionClass->group($groupType, $excludeHidden);
 216   }
 217
 218   /**
 219    * @return bool
 220    */
 221   public static function customGroupAdmin() {
 222     $admin = FALSE;
 223
 224     // check if user has all powerful permission
 225     // or administer civicrm permission (CRM-1905)
 226     if (self::check('access all custom data')) {
 227       return TRUE;
 228     }
 229
 230     if (
 231       self::check('administer Multiple Organizations') &&
 232       self::isMultisiteEnabled()
 233     ) {
 234       return TRUE;
 235     }
 236
 237     if (self::check('administer CiviCRM')) {
 238       return TRUE;
 239     }
 240
 241     return FALSE;
 242   }
 243
 244   /**
 245    * @param int $type
 246    * @param bool $reset
 247    *
 248    * @return array
 249    */
 250   public static function customGroup($type = CRM_Core_Permission::VIEW, $reset = FALSE) {
 251     $customGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id',
 252       array('fresh' => $reset));
 253     $defaultGroups = array();
 254
 255     // check if user has all powerful permission
 256     // or administer civicrm permission (CRM-1905)
 257     if (self::customGroupAdmin()) {
 258       $defaultGroups = array_keys($customGroups);
 259     }
 260
 261     return CRM_ACL_API::group($type, NULL, 'civicrm_custom_group', $customGroups, $defaultGroups);
 262   }
 263
 264   /**
 265    * @param int $type
 266    * @param null $prefix
 267    * @param bool $reset
 268    *
 269    * @return string
 270    */
 271   public static function customGroupClause($type = CRM_Core_Permission::VIEW, $prefix = NULL, $reset = FALSE) {
 272     if (self::customGroupAdmin()) {
 273       return ' ( 1 ) ';
 274     }
 275
 276     $groups = self::customGroup($type, $reset);
 277     if (empty($groups)) {
 278       return ' ( 0 ) ';
 279     }
 280     else {
 281       return "{$prefix}id IN ( " . implode(',', $groups) . ' ) ';
 282     }
 283   }
 284
 285   /**
 286    * @param int $gid
 287    * @param int $type
 288    *
 289    * @return bool
 290    */
 291   public static function ufGroupValid($gid, $type = CRM_Core_Permission::VIEW) {
 292     if (empty($gid)) {
 293       return TRUE;
 294     }
 295
 296     $groups = self::ufGroup($type);
 297     return !empty($groups) && in_array($gid, $groups) ? TRUE : FALSE;
 298   }
 299
 300   /**
 301    * @param int $type
 302    *
 303    * @return array
 304    */
 305   public static function ufGroup($type = CRM_Core_Permission::VIEW) {
 306     $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
 307
 308     $allGroups = array_keys($ufGroups);
 309
 310     // check if user has all powerful permission
 311     if (self::check('profile listings and forms')) {
 312       return $allGroups;
 313     }
 314
 315     switch ($type) {
 316       case CRM_Core_Permission::VIEW:
 317         if (self::check('profile view')) {
 318           return $allGroups;
 319         }
 320         break;
 321
 322       case CRM_Core_Permission::CREATE:
 323         if (self::check('profile create')) {
 324           return $allGroups;
 325         }
 326         break;
 327
 328       case CRM_Core_Permission::EDIT:
 329         if (self::check('profile edit')) {
 330           return $allGroups;
 331         }
 332         break;
 333
 334       case CRM_Core_Permission::SEARCH:
 335         if (self::check('profile listings')) {
 336           return $allGroups;
 337         }
 338         break;
 339     }
 340
 341     return CRM_ACL_API::group($type, NULL, 'civicrm_uf_group', $ufGroups);
 342   }
 343
 344   /**
 345    * @param int $type
 346    * @param null $prefix
 347    * @param bool $returnUFGroupIds
 348    *
 349    * @return array|string
 350    */
 351   public static function ufGroupClause($type = CRM_Core_Permission::VIEW, $prefix = NULL, $returnUFGroupIds = FALSE) {
 352     $groups = self::ufGroup($type);
 353     if ($returnUFGroupIds) {
 354       return $groups;
 355     }
 356     elseif (empty($groups)) {
 357       return ' ( 0 ) ';
 358     }
 359     else {
 360       return "{$prefix}id IN ( " . implode(',', $groups) . ' ) ';
 361     }
 362   }
 363
 364   /**
 365    * @param int $type
 366    * @param int $eventID
 367    * @param string $context
 368    *
 369    * @return array|null
 370    */
 371   public static function event($type = CRM_Core_Permission::VIEW, $eventID = NULL, $context = '') {
 372     if (!empty($context)) {
 373       if (CRM_Core_Permission::check($context)) {
 374         return TRUE;
 375       }
 376     }
 377     $events = CRM_Event_PseudoConstant::event(NULL, TRUE);
 378     $includeEvents = array();
 379
 380     // check if user has all powerful permission
 381     if (self::check('register for events')) {
 382       $includeEvents = array_keys($events);
 383     }
 384
 385     if ($type == CRM_Core_Permission::VIEW &&
 386       self::check('view event info')
 387     ) {
 388       $includeEvents = array_keys($events);
 389     }
 390
 391     $permissionedEvents = CRM_ACL_API::group($type, NULL, 'civicrm_event', $events, $includeEvents);
 392     if (!$eventID) {
 393       return $permissionedEvents;
 394     }
 395     if (!empty($permissionedEvents)) {
 396       return array_search($eventID, $permissionedEvents) === FALSE ? NULL : $eventID;
 397     }
 398     return NULL;
 399   }
 400
 401   /**
 402    * @param int $type
 403    * @param null $prefix
 404    *
 405    * @return string
 406    */
 407   public static function eventClause($type = CRM_Core_Permission::VIEW, $prefix = NULL) {
 408     $events = self::event($type);
 409     if (empty($events)) {
 410       return ' ( 0 ) ';
 411     }
 412     else {
 413       return "{$prefix}id IN ( " . implode(',', $events) . ' ) ';
 414     }
 415   }
 416
 417   /**
 418    * Checks that component is enabled and optionally that user has basic perm.
 419    *
 420    * @param string $module
 421    *   Specifies the name of the CiviCRM component.
 422    * @param bool $checkPermission
 423    *   Check not only that module is enabled, but that user has necessary
 424    *   permission.
 425    * @param bool $requireAllCasesPermOnCiviCase
 426    *   Significant only if $module == CiviCase
 427    *   Require "access all cases and activities", not just
 428    *   "access my cases and activities".
 429    *
 430    * @return bool
 431    *   Access to specified $module is granted.
 432    */
 433   public static function access($module, $checkPermission = TRUE, $requireAllCasesPermOnCiviCase = FALSE) {
 434     $config = CRM_Core_Config::singleton();
 435
 436     if (!in_array($module, $config->enableComponents)) {
 437       return FALSE;
 438     }
 439
 440     if ($checkPermission) {
 441       switch ($module) {
 442         case 'CiviCase':
 443           $access_all_cases = CRM_Core_Permission::check("access all cases and activities");
 444           $access_my_cases  = CRM_Core_Permission::check("access my cases and activities");
 445           return $access_all_cases || (!$requireAllCasesPermOnCiviCase && $access_my_cases);
 446
 447         case 'CiviCampaign':
 448           return CRM_Core_Permission::check("administer $module");
 449
 450         default:
 451           return CRM_Core_Permission::check("access $module");
 452       }
 453     }
 454
 455     return TRUE;
 456   }
 457
 458   /**
 459    * Check permissions for delete and edit actions.
 460    *
 461    * @param string $module
 462    *   Component name.
 463    * @param int $action
 464    *   Action to be check across component.
 465    *
 466    *
 467    * @return bool
 468    */
 469   public static function checkActionPermission($module, $action) {
 470     //check delete related permissions.
 471     if ($action & CRM_Core_Action::DELETE) {
 472       $permissionName = "delete in $module";
 473     }
 474     else {
 475       $editPermissions = array(
 476         'CiviEvent' => 'edit event participants',
 477         'CiviMember' => 'edit memberships',
 478         'CiviPledge' => 'edit pledges',
 479         'CiviContribute' => 'edit contributions',
 480         'CiviGrant' => 'edit grants',
 481         'CiviMail' => 'access CiviMail',
 482         'CiviAuction' => 'add auction items',
 483       );
 484       $permissionName = CRM_Utils_Array::value($module, $editPermissions);
 485     }
 486
 487     if ($module == 'CiviCase' && !$permissionName) {
 488       return CRM_Case_BAO_Case::accessCiviCase();
 489     }
 490     else {
 491       //check for permission.
 492       return CRM_Core_Permission::check($permissionName);
 493     }
 494   }
 495
 496   /**
 497    * @param $args
 498    * @param string $op
 499    *
 500    * @return bool
 501    */
 502   public static function checkMenu(&$args, $op = 'and') {
 503     if (!is_array($args)) {
 504       return $args;
 505     }
 506     foreach ($args as $str) {
 507       $res = CRM_Core_Permission::check($str);
 508       if ($op == 'or' && $res) {
 509         return TRUE;
 510       }
 511       elseif ($op == 'and' && !$res) {
 512         return FALSE;
 513       }
 514     }
 515     return ($op == 'or') ? FALSE : TRUE;
 516   }
 517
 518   /**
 519    * @param $item
 520    *
 521    * @return bool|mixed
 522    * @throws Exception
 523    */
 524   public static function checkMenuItem(&$item) {
 525     if (!array_key_exists('access_callback', $item)) {
 526       CRM_Core_Error::backtrace();
 527       CRM_Core_Error::fatal();
 528     }
 529
 530     // if component_id is present, ensure it is enabled
 531     if (isset($item['component_id']) && $item['component_id']) {
 532       if (!isset(Civi::$statics[__CLASS__]['componentNameId'])) {
 533         Civi::$statics[__CLASS__]['componentNameId'] = array_flip(CRM_Core_Component::getComponentIDs());
 534       }
 535       $componentName = Civi::$statics[__CLASS__]['componentNameId'][$item['component_id']];
 536
 537       $config = CRM_Core_Config::singleton();
 538       if (is_array($config->enableComponents) && in_array($componentName, $config->enableComponents)) {
 539         // continue with process
 540       }
 541       else {
 542         return FALSE;
 543       }
 544     }
 545
 546     // the following is imitating drupal 6 code in includes/menu.inc
 547     if (empty($item['access_callback']) ||
 548       is_numeric($item['access_callback'])
 549     ) {
 550       return (boolean ) $item['access_callback'];
 551     }
 552
 553     // check whether the following Ajax requests submitted the right key
 554     // FIXME: this should be integrated into ACLs proper
 555     if (CRM_Utils_Array::value('page_type', $item) == 3) {
 556       if (!CRM_Core_Key::validate($_REQUEST['key'], $item['path'])) {
 557         return FALSE;
 558       }
 559     }
 560
 561     // check if callback is for checkMenu, if so optimize it
 562     if (is_array($item['access_callback']) &&
 563       $item['access_callback'][0] == 'CRM_Core_Permission' &&
 564       $item['access_callback'][1] == 'checkMenu'
 565     ) {
 566       $op = CRM_Utils_Array::value(1, $item['access_arguments'], 'and');
 567       return self::checkMenu($item['access_arguments'][0], $op);
 568     }
 569     else {
 570       return call_user_func_array($item['access_callback'], $item['access_arguments']);
 571     }
 572   }
 573
 574   /**
 575    * @param bool $all
 576    *   Include disabled components
 577    * @param bool $descriptions
 578    *   Whether to return descriptions
 579    *
 580    * @return array
 581    */
 582   public static function basicPermissions($all = FALSE, $descriptions = FALSE) {
 583     $cacheKey = implode('-', array($all, $descriptions));
 584     if (empty(Civi::$statics[__CLASS__][__FUNCTION__][$cacheKey])) {
 585       Civi::$statics[__CLASS__][__FUNCTION__][$cacheKey] = self::assembleBasicPermissions($all, $descriptions);
 586     }
 587     return Civi::$statics[__CLASS__][__FUNCTION__][$cacheKey];
 588   }
 589
 590   /**
 591    * @param bool $all
 592    * @param bool $descriptions
 593    *   whether to return descriptions
 594    *
 595    * @return array
 596    */
 597   public static function assembleBasicPermissions($all = FALSE, $descriptions = FALSE) {
 598     $config = CRM_Core_Config::singleton();
 599     $prefix = ts('CiviCRM') . ': ';
 600     $permissions = self::getCorePermissions($descriptions);
 601
 602     if (self::isMultisiteEnabled()) {
 603       $permissions['administer Multiple Organizations'] = array($prefix . ts('administer Multiple Organizations'));
 604     }
 605
 606     if (!$descriptions) {
 607       foreach ($permissions as $name => $attr) {
 608         $permissions[$name] = array_shift($attr);
 609       }
 610     }
 611     if (!$all) {
 612       $components = CRM_Core_Component::getEnabledComponents();
 613     }
 614     else {
 615       $components = CRM_Core_Component::getComponents();
 616     }
 617
 618     foreach ($components as $comp) {
 619       $perm = $comp->getPermissions(FALSE, $descriptions);
 620       if ($perm) {
 621         $info = $comp->getInfo();
 622         foreach ($perm as $p => $attr) {
 623
 624           if (!is_array($attr)) {
 625             $attr = array($attr);
 626           }
 627
 628           $attr[0] = $info['translatedName'] . ': ' . $attr[0];
 629
 630           if ($descriptions) {
 631             $permissions[$p] = $attr;
 632           }
 633           else {
 634             $permissions[$p] = $attr[0];
 635           }
 636         }
 637       }
 638     }
 639
 640     // Add any permissions defined in hook_civicrm_permission implementations.
 641     $module_permissions = $config->userPermissionClass->getAllModulePermissions($descriptions);
 642     $permissions = array_merge($permissions, $module_permissions);
 643     CRM_Financial_BAO_FinancialType::permissionedFinancialTypes($permissions, $descriptions);
 644     return $permissions;
 645   }
 646
 647   /**
 648    * @return array
 649    */
 650   public static function getAnonymousPermissionsWarnings() {
 651     static $permissions = array();
 652     if (empty($permissions)) {
 653       $permissions = array(
 654         'administer CiviCRM',
 655       );
 656       $components = CRM_Core_Component::getComponents();
 657       foreach ($components as $comp) {
 658         if (!method_exists($comp, 'getAnonymousPermissionWarnings')) {
 659           continue;
 660         }
 661         $permissions = array_merge($permissions, $comp->getAnonymousPermissionWarnings());
 662       }
 663     }
 664     return $permissions;
 665   }
 666
 667   /**
 668    * @param $anonymous_perms
 669    *
 670    * @return array
 671    */
 672   public static function validateForPermissionWarnings($anonymous_perms) {
 673     return array_intersect($anonymous_perms, self::getAnonymousPermissionsWarnings());
 674   }
 675
 676   /**
 677    * Get core permissions.
 678    *
 679    * @return array
 680    */
 681   public static function getCorePermissions() {
 682     $prefix = ts('CiviCRM') . ': ';
 683     $permissions = array(
 684       'add contacts' => array(
 685         $prefix . ts('add contacts'),
 686         ts('Create a new contact record in CiviCRM'),
 687       ),
 688       'view all contacts' => array(
 689         $prefix . ts('view all contacts'),
 690         ts('View ANY CONTACT in the CiviCRM database, export contact info and perform activities such as Send Email, Phone Call, etc.'),
 691       ),
 692       'edit all contacts' => array(
 693         $prefix . ts('edit all contacts'),
 694         ts('View, Edit and Delete ANY CONTACT in the CiviCRM database; Create and edit relationships, tags and other info about the contacts'),
 695       ),
 696       'view my contact' => array(
 697         $prefix . ts('view my contact'),
 698       ),
 699       'edit my contact' => array(
 700         $prefix . ts('edit my contact'),
 701       ),
 702       'delete contacts' => array(
 703         $prefix . ts('delete contacts'),
 704       ),
 705       'access deleted contacts' => array(
 706         $prefix . ts('access deleted contacts'),
 707         ts('Access contacts in the trash'),
 708       ),
 709       'import contacts' => array(
 710         $prefix . ts('import contacts'),
 711         ts('Import contacts and activities'),
 712       ),
 713       'import SQL datasource' => array(
 714         $prefix . ts('import SQL datasource'),
 715         ts('When importing, consume data directly from a SQL datasource'),
 716       ),
 717       'edit groups' => array(
 718         $prefix . ts('edit groups'),
 719         ts('Create new groups, edit group settings (e.g. group name, visibility...), delete groups'),
 720       ),
 721       'administer CiviCRM' => array(
 722         $prefix . ts('administer CiviCRM'),
 723         ts('Perform all tasks in the Administer CiviCRM control panel and Import Contacts'),
 724       ),
 725       'skip IDS check' => array(
 726         $prefix . ts('skip IDS check'),
 727         ts('Warning: Give to trusted roles only; this permission has security implications. IDS system is bypassed for users with this permission. Prevents false errors for admin users.'),
 728       ),
 729       'access uploaded files' => array(
 730         $prefix . ts('access uploaded files'),
 731         ts('View / download files including images and photos'),
 732       ),
 733       'profile listings and forms' => array(
 734         $prefix . ts('profile listings and forms'),
 735         ts('Warning: Give to trusted roles only; this permission has privacy implications. Add/edit data in online forms and access public searchable directories.'),
 736       ),
 737       'profile listings' => array(
 738         $prefix . ts('profile listings'),
 739         ts('Warning: Give to trusted roles only; this permission has privacy implications. Access public searchable directories.'),
 740       ),
 741       'profile create' => array(
 742         $prefix . ts('profile create'),
 743         ts('Add data in a profile form.'),
 744       ),
 745       'profile edit' => array(
 746         $prefix . ts('profile edit'),
 747         ts('Edit data in a profile form.'),
 748       ),
 749       'profile view' => array(
 750         $prefix . ts('profile view'),
 751         ts('View data in a profile.'),
 752       ),
 753       'access all custom data' => array(
 754         $prefix . ts('access all custom data'),
 755         ts('View all custom fields regardless of ACL rules'),
 756       ),
 757       'view all activities' => array(
 758         $prefix . ts('view all activities'),
 759         ts('View all activities (for visible contacts)'),
 760       ),
 761       'delete activities' => array(
 762         $prefix . ts('Delete activities'),
 763       ),
 764       'access CiviCRM' => array(
 765         $prefix . ts('access CiviCRM backend and API'),
 766         ts('Master control for access to the main CiviCRM backend and API. Give to trusted roles only.'),
 767       ),
 768       'access Contact Dashboard' => array(
 769         $prefix . ts('access Contact Dashboard'),
 770         ts('View Contact Dashboard (for themselves and visible contacts)'),
 771       ),
 772       'translate CiviCRM' => array(
 773         $prefix . ts('translate CiviCRM'),
 774         ts('Allow User to enable multilingual'),
 775       ),
 776       'manage tags' => array(
 777         $prefix . ts('manage tags'),
 778         ts('Create and rename tags'),
 779       ),
 780       'administer reserved groups' => array(
 781         $prefix . ts('administer reserved groups'),
 782         ts('Edit and disable Reserved Groups (Needs Edit Groups)'),
 783       ),
 784       'administer Tagsets' => array(
 785         $prefix . ts('administer Tagsets'),
 786       ),
 787       'administer reserved tags' => array(
 788         $prefix . ts('administer reserved tags'),
 789       ),
 790       'administer dedupe rules' => array(
 791         $prefix . ts('administer dedupe rules'),
 792         ts('Create and edit rules, change the supervised and unsupervised rules'),
 793       ),
 794       'merge duplicate contacts' => array(
 795         $prefix . ts('merge duplicate contacts'),
 796         ts('Delete Contacts must also be granted in order for this to work.'),
 797       ),
 798       'force merge duplicate contacts' => array(
 799         $prefix . ts('force merge duplicate contacts'),
 800         ts('Delete Contacts must also be granted in order for this to work.'),
 801       ),
 802       'view debug output' => array(
 803         $prefix . ts('view debug output'),
 804         ts('View results of debug and backtrace'),
 805       ),
 806
 807       'view all notes' => array(
 808         $prefix . ts('view all notes'),
 809         ts("View notes (for visible contacts) even if they're marked admin only"),
 810       ),
 811       'add contact notes' => array(
 812         $prefix . ts('add contact notes'),
 813         ts("Create notes for contacts"),
 814       ),
 815       'access AJAX API' => array(
 816         $prefix . ts('access AJAX API'),
 817         ts('Allow API access even if Access CiviCRM is not granted'),
 818       ),
 819       'access contact reference fields' => array(
 820         $prefix . ts('access contact reference fields'),
 821         ts('Allow entering data into contact reference fields'),
 822       ),
 823       'create manual batch' => array(
 824         $prefix . ts('create manual batch'),
 825         ts('Create an accounting batch (with Access to CiviContribute and View Own/All Manual Batches)'),
 826       ),
 827       'edit own manual batches' => array(
 828         $prefix . ts('edit own manual batches'),
 829         ts('Edit accounting batches created by user'),
 830       ),
 831       'edit all manual batches' => array(
 832         $prefix . ts('edit all manual batches'),
 833         ts('Edit all accounting batches'),
 834       ),
 835       'close own manual batches' => array(
 836         $prefix . ts('close own manual batches'),
 837         ts('Close accounting batches created by user (with Access to CiviContribute)'),
 838       ),
 839       'close all manual batches' => array(
 840         $prefix . ts('close all manual batches'),
 841         ts('Close all accounting batches (with Access to CiviContribute)'),
 842       ),
 843       'reopen own manual batches' => array(
 844         $prefix . ts('reopen own manual batches'),
 845         ts('Reopen accounting batches created by user (with Access to CiviContribute)'),
 846       ),
 847       'reopen all manual batches' => array(
 848         $prefix . ts('reopen all manual batches'),
 849         ts('Reopen all accounting batches (with Access to CiviContribute)'),
 850       ),
 851       'view own manual batches' => array(
 852         $prefix . ts('view own manual batches'),
 853         ts('View accounting batches created by user (with Access to CiviContribute)'),
 854       ),
 855       'view all manual batches' => array(
 856         $prefix . ts('view all manual batches'),
 857         ts('View all accounting batches (with Access to CiviContribute)'),
 858       ),
 859       'delete own manual batches' => array(
 860         $prefix . ts('delete own manual batches'),
 861         ts('Delete accounting batches created by user'),
 862       ),
 863       'delete all manual batches' => array(
 864         $prefix . ts('delete all manual batches'),
 865         ts('Delete all accounting batches'),
 866       ),
 867       'export own manual batches' => array(
 868         $prefix . ts('export own manual batches'),
 869         ts('Export accounting batches created by user'),
 870       ),
 871       'export all manual batches' => array(
 872         $prefix . ts('export all manual batches'),
 873         ts('Export all accounting batches'),
 874       ),
 875       'administer payment processors' => array(
 876         $prefix . ts('administer payment processors'),
 877         ts('Add, Update, or Disable Payment Processors'),
 878       ),
 879       'edit message templates' => array(
 880         $prefix . ts('edit message templates'),
 881       ),
 882       'view my invoices' => array(
 883         $prefix . ts('view my invoices'),
 884         ts('Allow users to view/ download their own invoices'),
 885       ),
 886       'edit api keys' => array(
 887         $prefix . ts('edit api keys'),
 888         ts('Edit API keys'),
 889       ),
 890       'edit own api keys' => array(
 891         $prefix . ts('edit own api keys'),
 892         ts('Edit user\'s own API keys'),
 893       ),
 894       'send SMS' => array(
 895         $prefix . ts('send SMS'),
 896         ts('Send an SMS'),
 897       ),
 898     );
 899
 900     return $permissions;
 901   }
 902
 903   /**
 904    * For each entity provides an array of permissions required for each action
 905    *
 906    * The action is the array key, possible values:
 907    *  * create: applies to create (with no id in params)
 908    *  * update: applies to update, setvalue, create (with id in params)
 909    *  * get: applies to getcount, getsingle, getvalue and other gets
 910    *  * delete: applies to delete, replace
 911    *  * meta: applies to getfields, getoptions, getspec
 912    *  * default: catch-all for anything not declared
 913    *
 914    *  Note: some APIs declare other actions as well
 915    *
 916    * Permissions should use arrays for AND and arrays of arrays for OR
 917    * @see CRM_Core_Permission::check
 918    *
 919    * @return array of permissions
 920    */
 921   public static function getEntityActionPermissions() {
 922     $permissions = array();
 923     // These are the default permissions - if any entity does not declare permissions for a given action,
 924     // (or the entity does not declare permissions at all) - then the action will be used from here
 925     $permissions['default'] = array(
 926       // applies to getfields, getoptions, etc.
 927       'meta' => array('access CiviCRM'),
 928       // catch-all, applies to create, get, delete, etc.
 929       // If an entity declares it's own 'default' action it will override this one
 930       'default' => array('administer CiviCRM'),
 931     );
 932
 933     // Note: Additional permissions in DynamicFKAuthorization
 934     $permissions['attachment'] = array(
 935       'default' => array(
 936         array('access CiviCRM', 'access AJAX API'),
 937       ),
 938     );
 939
 940     // Contact permissions
 941     $permissions['contact'] = array(
 942       'create' => array(
 943         'access CiviCRM',
 944         'add contacts',
 945       ),
 946       'delete' => array(
 947         'access CiviCRM',
 948         'delete contacts',
 949       ),
 950       // managed by query object
 951       'get' => array(),
 952       // managed by _civicrm_api3_check_edit_permissions
 953       'update' => array(),
 954       'getquick' => array(
 955         array('access CiviCRM', 'access AJAX API'),
 956       ),
 957     );
 958
 959     // CRM-16963 - Permissions for country.
 960     $permissions['country'] = array(
 961       'get' => array(
 962         'access CiviCRM',
 963       ),
 964       'default' => array(
 965         'administer CiviCRM',
 966       ),
 967     );
 968
 969     // Contact-related data permissions.
 970     $permissions['address'] = array(
 971       // get is managed by BAO::addSelectWhereClause
 972       // create/delete are managed by _civicrm_api3_check_edit_permissions
 973       'default' => array(),
 974     );
 975     $permissions['email'] = $permissions['address'];
 976     $permissions['phone'] = $permissions['address'];
 977     $permissions['website'] = $permissions['address'];
 978     $permissions['im'] = $permissions['address'];
 979     $permissions['open_i_d'] = $permissions['address'];
 980
 981     // Also managed by ACLs - CRM-19448
 982     $permissions['entity_tag'] = array('default' => array());
 983     $permissions['note'] = $permissions['entity_tag'];
 984
 985     // Allow non-admins to get and create tags to support tagset widget
 986     // Delete is still reserved for admins
 987     $permissions['tag'] = array(
 988       'get' => array('access CiviCRM'),
 989       'create' => array('access CiviCRM'),
 990       'update' => array('access CiviCRM'),
 991     );
 992
 993     //relationship permissions
 994     $permissions['relationship'] = array(
 995       // get is managed by BAO::addSelectWhereClause
 996       'get' => array(),
 997       'delete' => array(
 998         'access CiviCRM',
 999         'edit all contacts',
1000       ),
1001       'default' => array(
1002         'access CiviCRM',
1003         'edit all contacts',
1004       ),
1005     );
1006
1007     // CRM-17741 - Permissions for RelationshipType.
1008     $permissions['relationship_type'] = array(
1009       'get' => array(
1010         'access CiviCRM',
1011       ),
1012       'default' => array(
1013         'administer CiviCRM',
1014       ),
1015     );
1016
1017     // Activity permissions
1018     $permissions['activity'] = array(
1019       'delete' => array(
1020         'access CiviCRM',
1021         'delete activities',
1022       ),
1023       'get' => array(
1024         'access CiviCRM',
1025         // Note that view all activities is also required within the api
1026         // if the id is not passed in. Where the id is passed in the activity
1027         // specific check functions are used and tested.
1028       ),
1029       'default' => array(
1030         'access CiviCRM',
1031         'view all activities',
1032       ),
1033     );
1034
1035     // Case permissions
1036     $permissions['case'] = array(
1037       'create' => array(
1038         'access CiviCRM',
1039         'add cases',
1040       ),
1041       'delete' => array(
1042         'access CiviCRM',
1043         'delete in CiviCase',
1044       ),
1045       'restore' => array(
1046         'administer CiviCase',
1047       ),
1048       'merge' => array(
1049         'administer CiviCase',
1050       ),
1051       'default' => array(
1052         // At minimum the user needs one of the following. Finer-grained access is controlled by CRM_Case_BAO_Case::addSelectWhereClause
1053         array('access my cases and activities', 'access all cases and activities'),
1054       ),
1055     );
1056     $permissions['case_contact'] = $permissions['case'];
1057
1058     $permissions['case_type'] = array(
1059       'default' => array('administer CiviCase'),
1060       'get' => array(
1061         // nested array = OR
1062         array('access my cases and activities', 'access all cases and activities'),
1063       ),
1064     );
1065
1066     // Campaign permissions
1067     $permissions['campaign'] = array(
1068       'get' => array('access CiviCRM'),
1069       'default' => array(
1070         // nested array = OR
1071         array('administer CiviCampaign', 'manage campaign'),
1072       ),
1073     );
1074     $permissions['survey'] = $permissions['campaign'];
1075
1076     // Financial permissions
1077     $permissions['contribution'] = array(
1078       'get' => array(
1079         'access CiviCRM',
1080         'access CiviContribute',
1081       ),
1082       'delete' => array(
1083         'access CiviCRM',
1084         'access CiviContribute',
1085         'delete in CiviContribute',
1086       ),
1087       'completetransaction' => array(
1088         'edit contributions',
1089       ),
1090       'default' => array(
1091         'access CiviCRM',
1092         'access CiviContribute',
1093         'edit contributions',
1094       ),
1095     );
1096     $permissions['line_item'] = $permissions['contribution'];
1097
1098     // Payment permissions
1099     $permissions['payment'] = array(
1100       'get' => array(
1101         'access CiviCRM',
1102         'access CiviContribute',
1103       ),
1104       'delete' => array(
1105         'access CiviCRM',
1106         'access CiviContribute',
1107         'delete in CiviContribute',
1108       ),
1109       'cancel' => array(
1110         'access CiviCRM',
1111         'access CiviContribute',
1112         'edit contributions',
1113       ),
1114       'create' => array(
1115         'access CiviCRM',
1116         'access CiviContribute',
1117         'edit contributions',
1118       ),
1119       'default' => array(
1120         'access CiviCRM',
1121         'access CiviContribute',
1122         'edit contributions',
1123       ),
1124     );
1125     $permissions['contribution_recur'] = $permissions['payment'];
1126
1127     // Custom field permissions
1128     $permissions['custom_field'] = array(
1129       'default' => array(
1130         'administer CiviCRM',
1131         'access all custom data',
1132       ),
1133     );
1134     $permissions['custom_group'] = $permissions['custom_field'];
1135
1136     // Event permissions
1137     $permissions['event'] = array(
1138       'create' => array(
1139         'access CiviCRM',
1140         'access CiviEvent',
1141         'edit all events',
1142       ),
1143       'delete' => array(
1144         'access CiviCRM',
1145         'access CiviEvent',
1146         'delete in CiviEvent',
1147       ),
1148       'get' => array(
1149         'access CiviCRM',
1150         'access CiviEvent',
1151         'view event info',
1152       ),
1153       'update' => array(
1154         'access CiviCRM',
1155         'access CiviEvent',
1156         'edit all events',
1157       ),
1158     );
1159     // Loc block is only used for events
1160     $permissions['loc_block'] = $permissions['event'];
1161
1162     $permissions['state_province'] = array(
1163       'get' => array(
1164         'access CiviCRM',
1165       ),
1166     );
1167
1168     // Price sets are shared by several components, user needs access to at least one of them
1169     $permissions['price_set'] = array(
1170       'default' => array(
1171         array('access CiviEvent', 'access CiviContribute', 'access CiviMember'),
1172       ),
1173       'get' => array(
1174         array('access CiviCRM', 'view event info', 'make online contributions'),
1175       ),
1176     );
1177
1178     // File permissions
1179     $permissions['file'] = array(
1180       'default' => array(
1181         'access CiviCRM',
1182         'access uploaded files',
1183       ),
1184     );
1185     $permissions['files_by_entity'] = $permissions['file'];
1186
1187     // Group permissions
1188     $permissions['group'] = array(
1189       'get' => array(
1190         'access CiviCRM',
1191       ),
1192       'default' => array(
1193         'access CiviCRM',
1194         'edit groups',
1195       ),
1196     );
1197
1198     $permissions['group_nesting'] = $permissions['group'];
1199     $permissions['group_organization'] = $permissions['group'];
1200
1201     //Group Contact permission
1202     $permissions['group_contact'] = array(
1203       'get' => array(
1204         'access CiviCRM',
1205       ),
1206       'default' => array(
1207         'access CiviCRM',
1208         'edit all contacts',
1209       ),
1210     );
1211
1212     // CiviMail Permissions
1213     $civiMailBasePerms = array(
1214       // To get/preview/update, one must have least one of these perms:
1215       // Mailing API implementations enforce nuances of create/approve/schedule permissions.
1216       'access CiviMail',
1217       'create mailings',
1218       'schedule mailings',
1219       'approve mailings',
1220     );
1221     $permissions['mailing'] = array(
1222       'get' => array(
1223         'access CiviCRM',
1224         $civiMailBasePerms,
1225       ),
1226       'delete' => array(
1227         'access CiviCRM',
1228         $civiMailBasePerms,
1229         'delete in CiviMail',
1230       ),
1231       'submit' => array(
1232         'access CiviCRM',
1233         array('access CiviMail', 'schedule mailings'),
1234       ),
1235       'default' => array(
1236         'access CiviCRM',
1237         $civiMailBasePerms,
1238       ),
1239     );
1240     $permissions['mailing_group'] = $permissions['mailing'];
1241     $permissions['mailing_job'] = $permissions['mailing'];
1242     $permissions['mailing_recipients'] = $permissions['mailing'];
1243
1244     $permissions['mailing_a_b'] = array(
1245       'get' => array(
1246         'access CiviCRM',
1247         'access CiviMail',
1248       ),
1249       'delete' => array(
1250         'access CiviCRM',
1251         'access CiviMail',
1252         'delete in CiviMail',
1253       ),
1254       'submit' => array(
1255         'access CiviCRM',
1256         array('access CiviMail', 'schedule mailings'),
1257       ),
1258       'default' => array(
1259         'access CiviCRM',
1260         'access CiviMail',
1261       ),
1262     );
1263
1264     // Membership permissions
1265     $permissions['membership'] = array(
1266       'get' => array(
1267         'access CiviCRM',
1268         'access CiviMember',
1269       ),
1270       'delete' => array(
1271         'access CiviCRM',
1272         'access CiviMember',
1273         'delete in CiviMember',
1274       ),
1275       'default' => array(
1276         'access CiviCRM',
1277         'access CiviMember',
1278         'edit memberships',
1279       ),
1280     );
1281     $permissions['membership_status'] = $permissions['membership'];
1282     $permissions['membership_type'] = $permissions['membership'];
1283     $permissions['membership_payment'] = array(
1284       'create' => array(
1285         'access CiviCRM',
1286         'access CiviMember',
1287         'edit memberships',
1288         'access CiviContribute',
1289         'edit contributions',
1290       ),
1291       'delete' => array(
1292         'access CiviCRM',
1293         'access CiviMember',
1294         'delete in CiviMember',
1295         'access CiviContribute',
1296         'delete in CiviContribute',
1297       ),
1298       'get' => array(
1299         'access CiviCRM',
1300         'access CiviMember',
1301         'access CiviContribute',
1302       ),
1303       'update' => array(
1304         'access CiviCRM',
1305         'access CiviMember',
1306         'edit memberships',
1307         'access CiviContribute',
1308         'edit contributions',
1309       ),
1310     );
1311
1312     // Participant permissions
1313     $permissions['participant'] = array(
1314       'create' => array(
1315         'access CiviCRM',
1316         'access CiviEvent',
1317         'register for events',
1318       ),
1319       'delete' => array(
1320         'access CiviCRM',
1321         'access CiviEvent',
1322         'edit event participants',
1323       ),
1324       'get' => array(
1325         'access CiviCRM',
1326         'access CiviEvent',
1327         'view event participants',
1328       ),
1329       'update' => array(
1330         'access CiviCRM',
1331         'access CiviEvent',
1332         'edit event participants',
1333       ),
1334     );
1335     $permissions['participant_payment'] = array(
1336       'create' => array(
1337         'access CiviCRM',
1338         'access CiviEvent',
1339         'register for events',
1340         'access CiviContribute',
1341         'edit contributions',
1342       ),
1343       'delete' => array(
1344         'access CiviCRM',
1345         'access CiviEvent',
1346         'edit event participants',
1347         'access CiviContribute',
1348         'delete in CiviContribute',
1349       ),
1350       'get' => array(
1351         'access CiviCRM',
1352         'access CiviEvent',
1353         'view event participants',
1354         'access CiviContribute',
1355       ),
1356       'update' => array(
1357         'access CiviCRM',
1358         'access CiviEvent',
1359         'edit event participants',
1360         'access CiviContribute',
1361         'edit contributions',
1362       ),
1363     );
1364
1365     // Pledge permissions
1366     $permissions['pledge'] = array(
1367       'create' => array(
1368         'access CiviCRM',
1369         'access CiviPledge',
1370         'edit pledges',
1371       ),
1372       'delete' => array(
1373         'access CiviCRM',
1374         'access CiviPledge',
1375         'delete in CiviPledge',
1376       ),
1377       'get' => array(
1378         'access CiviCRM',
1379         'access CiviPledge',
1380       ),
1381       'update' => array(
1382         'access CiviCRM',
1383         'access CiviPledge',
1384         'edit pledges',
1385       ),
1386     );
1387
1388     //CRM-16777: Disable schedule reminder for user that have 'edit all events' and 'administer CiviCRM' permission.
1389     $permissions['action_schedule'] = array(
1390       'update' => array(
1391         array(
1392           'access CiviCRM',
1393           'edit all events',
1394         ),
1395       ),
1396     );
1397
1398     $permissions['pledge_payment'] = array(
1399       'create' => array(
1400         'access CiviCRM',
1401         'access CiviPledge',
1402         'edit pledges',
1403         'access CiviContribute',
1404         'edit contributions',
1405       ),
1406       'delete' => array(
1407         'access CiviCRM',
1408         'access CiviPledge',
1409         'delete in CiviPledge',
1410         'access CiviContribute',
1411         'delete in CiviContribute',
1412       ),
1413       'get' => array(
1414         'access CiviCRM',
1415         'access CiviPledge',
1416         'access CiviContribute',
1417       ),
1418       'update' => array(
1419         'access CiviCRM',
1420         'access CiviPledge',
1421         'edit pledges',
1422         'access CiviContribute',
1423         'edit contributions',
1424       ),
1425     );
1426
1427     // Profile permissions
1428     $permissions['profile'] = array(
1429       'get' => array(), // the profile will take care of this
1430     );
1431
1432     $permissions['uf_group'] = array(
1433       'create' => array(
1434         'access CiviCRM',
1435         array(
1436           'administer CiviCRM',
1437           'manage event profiles',
1438         ),
1439       ),
1440       'get' => array(
1441         'access CiviCRM',
1442       ),
1443       'update' => array(
1444         'access CiviCRM',
1445         array(
1446           'administer CiviCRM',
1447           'manage event profiles',
1448         ),
1449       ),
1450     );
1451     $permissions['uf_field'] = $permissions['uf_join'] = $permissions['uf_group'];
1452     $permissions['uf_field']['delete'] = array(
1453       'access CiviCRM',
1454       array(
1455         'administer CiviCRM',
1456         'manage event profiles',
1457       ),
1458     );
1459     $permissions['option_value'] = $permissions['uf_group'];
1460     $permissions['option_group'] = $permissions['option_value'];
1461
1462     $permissions['message_template'] = array(
1463       'get' => array('access CiviCRM'),
1464       'create' => array('edit message templates'),
1465       'update' => array('edit message templates'),
1466     );
1467     return $permissions;
1468   }
1469
1470   /**
1471    * Translate an unknown action to a canonical form.
1472    *
1473    * @param string $action
1474    *
1475    * @return string
1476    *   the standardised action name
1477    */
1478   public static function getGenericAction($action) {
1479     $snippet = substr($action, 0, 3);
1480     if ($action == 'replace' || $snippet == 'del') {
1481       // 'Replace' is a combination of get+create+update+delete; however, the permissions
1482       // on each of those will be tested separately at runtime. This is just a sniff-test
1483       // based on the heuristic that 'delete' tends to be the most closely guarded
1484       // of the necessary permissions.
1485       $action = 'delete';
1486     }
1487     elseif ($action == 'setvalue' || $snippet == 'upd') {
1488       $action = 'update';
1489     }
1490     elseif ($action == 'getfields' || $action == 'getfield' || $action == 'getspec' || $action == 'getoptions') {
1491       $action = 'meta';
1492     }
1493     elseif ($snippet == 'get') {
1494       $action = 'get';
1495     }
1496     return $action;
1497   }
1498
1499   /**
1500    * Validate user permission across.
1501    * edit or view or with supportable acls.
1502    *
1503    * @return bool
1504    */
1505   public static function giveMeAllACLs() {
1506     if (CRM_Core_Permission::check('view all contacts') ||
1507       CRM_Core_Permission::check('edit all contacts')
1508     ) {
1509       return TRUE;
1510     }
1511
1512     $session = CRM_Core_Session::singleton();
1513     $contactID = $session->get('userID');
1514
1515     //check for acl.
1516     $aclPermission = self::getPermission();
1517     if (in_array($aclPermission, array(
1518       CRM_Core_Permission::EDIT,
1519       CRM_Core_Permission::VIEW,
1520     ))
1521     ) {
1522       return TRUE;
1523     }
1524
1525     // run acl where hook and see if the user is supplying an ACL clause
1526     // that is not false
1527     $tables = $whereTables = array();
1528     $where = NULL;
1529
1530     CRM_Utils_Hook::aclWhereClause(CRM_Core_Permission::VIEW,
1531       $tables, $whereTables,
1532       $contactID, $where
1533     );
1534     return empty($whereTables) ? FALSE : TRUE;
1535   }
1536
1537   /**
1538    * Get component name from given permission.
1539    *
1540    * @param string $permission
1541    *
1542    * @return null|string
1543    *   the name of component.
1544    */
1545   public static function getComponentName($permission) {
1546     $componentName = NULL;
1547     $permission = trim($permission);
1548     if (empty($permission)) {
1549       return $componentName;
1550     }
1551
1552     static $allCompPermissions = array();
1553     if (empty($allCompPermissions)) {
1554       $components = CRM_Core_Component::getComponents();
1555       foreach ($components as $name => $comp) {
1556         //get all permissions of each components unconditionally
1557         $allCompPermissions[$name] = $comp->getPermissions(TRUE);
1558       }
1559     }
1560
1561     if (is_array($allCompPermissions)) {
1562       foreach ($allCompPermissions as $name => $permissions) {
1563         if (array_key_exists($permission, $permissions)) {
1564           $componentName = $name;
1565           break;
1566         }
1567       }
1568     }
1569
1570     return $componentName;
1571   }
1572
1573   /**
1574    * Get all the contact emails for users that have a specific permission.
1575    *
1576    * @param string $permissionName
1577    *   Name of the permission we are interested in.
1578    *
1579    * @return string
1580    *   a comma separated list of email addresses
1581    */
1582   public static function permissionEmails($permissionName) {
1583     $config = CRM_Core_Config::singleton();
1584     return $config->userPermissionClass->permissionEmails($permissionName);
1585   }
1586
1587   /**
1588    * Get all the contact emails for users that have a specific role.
1589    *
1590    * @param string $roleName
1591    *   Name of the role we are interested in.
1592    *
1593    * @return string
1594    *   a comma separated list of email addresses
1595    */
1596   public static function roleEmails($roleName) {
1597     $config = CRM_Core_Config::singleton();
1598     return $config->userRoleClass->roleEmails($roleName);
1599   }
1600
1601   /**
1602    * @return bool
1603    */
1604   public static function isMultisiteEnabled() {
1605     return Civi::settings()->get('is_enabled') ? TRUE : FALSE;
1606   }
1607
1608   /**
1609    * Verify if the user has permission to get the invoice.
1610    *
1611    * @return bool
1612    *   TRUE if the user has download all invoices permission or download my
1613    *   invoices permission and the invoice author is the current user.
1614    */
1615   public static function checkDownloadInvoice() {
1616     $cid = CRM_Core_Session::getLoggedInContactID();
1617     if (CRM_Core_Permission::check('access CiviContribute') ||
1618       (CRM_Core_Permission::check('view my invoices') && $_GET['cid'] == $cid)
1619     ) {
1620       return TRUE;
1621     }
1622     return FALSE;
1623   }
1624
1625 }