CRM/Core/Permission.php

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