3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This is the basic permission class wrapper
21 class CRM_Core_Permission
{
24 * Static strings used to compose permissions.
29 const EDIT_GROUPS
= 'edit contacts in ', VIEW_GROUPS
= 'view contacts in ';
32 * The various type of permissions.
36 const EDIT
= 1, VIEW
= 2, DELETE
= 3, CREATE
= 4, SEARCH
= 5, ALL
= 6, ADMIN
= 7;
39 * A placeholder permission which always fails.
41 const ALWAYS_DENY_PERMISSION
= "*always deny*";
44 * A placeholder permission which always fails.
46 const ALWAYS_ALLOW_PERMISSION
= "*always allow*";
49 * Various authentication sources.
53 const AUTH_SRC_UNKNOWN
= 0, AUTH_SRC_CHECKSUM
= 1, AUTH_SRC_SITEKEY
= 2, AUTH_SRC_LOGIN
= 4;
56 * Get the current permission of this user.
59 * the permission of the user (edit or view or null)
61 public static function getPermission() {
62 $config = CRM_Core_Config
::singleton();
63 return $config->userPermissionClass
->getPermission();
67 * Given a permission string or array, check for access requirements
69 * Ex 1: Must have 'access CiviCRM'
70 * (string) 'access CiviCRM'
72 * Ex 2: Must have 'access CiviCRM' and 'access AJAX API'
73 * ['access CiviCRM', 'access AJAX API']
75 * Ex 3: Must have 'access CiviCRM' or 'access AJAX API'
77 * ['access CiviCRM', 'access AJAX API'],
80 * Ex 4: Must have 'access CiviCRM' or 'access AJAX API' AND 'access CiviEvent'
82 * ['access CiviCRM', 'access AJAX API'],
86 * Note that in permissions.php this is keyed by the action eg.
87 * (access Civi || access AJAX) && (access CiviEvent || access CiviContribute)
89 * ['access CiviCRM', 'access AJAX API'],
90 * ['access CiviEvent', 'access CiviContribute']
93 * @param string|array $permissions
94 * The permission to check as an array or string -see examples.
96 * @param int $contactId
97 * Contact id to check permissions for. Defaults to current logged-in user.
100 * true if contact has permission(s), else false
102 public static function check($permissions, $contactId = NULL) {
103 $permissions = (array) $permissions;
104 $userId = CRM_Core_BAO_UFMatch
::getUFId($contactId);
106 /** @var CRM_Core_Permission_Temp $tempPerm */
107 $tempPerm = CRM_Core_Config
::singleton()->userPermissionTemp
;
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
117 //none of our our conditions was met
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);
135 && !($tempPerm && $tempPerm->check($permission))
137 //one of our 'and' conditions has not been met
146 * Determine if any one of the permissions strings applies to current user.
148 * @param array $perms
151 public static function checkAnyPerm($perms) {
152 foreach ($perms as $perm) {
153 if (CRM_Core_Permission
::check($perm)) {
161 * Given a group/role array, check for access requirements
163 * @param array $array
164 * The group/role to check.
167 * true if yes, else false
169 public static function checkGroupRole($array) {
170 $config = CRM_Core_Config
::singleton();
171 return $config->userPermissionClass
->checkGroupRole($array);
175 * Get the permissioned where clause for the user.
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.
185 * the group where clause for this user
187 public static function getPermissionedStaticGroupClause($type, &$tables, &$whereTables) {
188 $config = CRM_Core_Config
::singleton();
189 return $config->userPermissionClass
->getPermissionedStaticGroupClause($type, $tables, $whereTables);
193 * Get all groups from database, filtered by permissions
196 * @param string $groupType
197 * Type of group(Access/Mailing).
198 * @param bool $excludeHidden
199 * exclude hidden groups.
203 * array reference of all groups.
205 public static function group($groupType, $excludeHidden = TRUE) {
206 $config = CRM_Core_Config
::singleton();
207 return $config->userPermissionClass
->group($groupType, $excludeHidden);
213 public static function customGroupAdmin() {
216 // check if user has all powerful permission
217 // or administer civicrm permission (CRM-1905)
218 if (self
::check('access all custom data')) {
223 self
::check('administer Multiple Organizations') &&
224 self
::isMultisiteEnabled()
229 if (self
::check('administer CiviCRM')) {
242 public static function customGroup($type = CRM_Core_Permission
::VIEW
, $reset = FALSE) {
243 $customGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_CustomField', 'custom_group_id',
244 ['fresh' => $reset]);
247 // check if user has all powerful permission
248 // or administer civicrm permission (CRM-1905)
249 if (self
::customGroupAdmin()) {
250 $defaultGroups = array_keys($customGroups);
253 return CRM_ACL_API
::group($type, NULL, 'civicrm_custom_group', $customGroups, $defaultGroups);
258 * @param null $prefix
263 public static function customGroupClause($type = CRM_Core_Permission
::VIEW
, $prefix = NULL, $reset = FALSE) {
264 if (self
::customGroupAdmin()) {
268 $groups = self
::customGroup($type, $reset);
269 if (empty($groups)) {
273 return "{$prefix}id IN ( " . implode(',', $groups) . ' ) ';
283 public static function ufGroupValid($gid, $type = CRM_Core_Permission
::VIEW
) {
288 $groups = self
::ufGroup($type);
289 return !empty($groups) && in_array($gid, $groups);
297 public static function ufGroup($type = CRM_Core_Permission
::VIEW
) {
298 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
300 $allGroups = array_keys($ufGroups);
302 // check if user has all powerful permission
303 if (self
::check('profile listings and forms')) {
308 case CRM_Core_Permission
::VIEW
:
309 if (self
::check('profile view')) {
314 case CRM_Core_Permission
::CREATE
:
315 if (self
::check('profile create')) {
320 case CRM_Core_Permission
::EDIT
:
321 if (self
::check('profile edit')) {
326 case CRM_Core_Permission
::SEARCH
:
327 if (self
::check('profile listings')) {
333 return CRM_ACL_API
::group($type, NULL, 'civicrm_uf_group', $ufGroups);
338 * @param null $prefix
339 * @param bool $returnUFGroupIds
341 * @return array|string
343 public static function ufGroupClause($type = CRM_Core_Permission
::VIEW
, $prefix = NULL, $returnUFGroupIds = FALSE) {
344 $groups = self
::ufGroup($type);
345 if ($returnUFGroupIds) {
348 elseif (empty($groups)) {
352 return "{$prefix}id IN ( " . implode(',', $groups) . ' ) ';
358 * @param int $eventID
359 * @param string $context
363 public static function event($type = CRM_Core_Permission
::VIEW
, $eventID = NULL, $context = '') {
364 if (!empty($context)) {
365 if (CRM_Core_Permission
::check($context)) {
369 $events = CRM_Event_PseudoConstant
::event(NULL, TRUE);
372 // check if user has all powerful permission
373 if (self
::check('register for events')) {
374 $includeEvents = array_keys($events);
377 if ($type == CRM_Core_Permission
::VIEW
&&
378 self
::check('view event info')
380 $includeEvents = array_keys($events);
383 $permissionedEvents = CRM_ACL_API
::group($type, NULL, 'civicrm_event', $events, $includeEvents);
385 return $permissionedEvents;
387 if (!empty($permissionedEvents)) {
388 return array_search($eventID, $permissionedEvents) === FALSE ?
NULL : $eventID;
395 * @param null $prefix
399 public static function eventClause($type = CRM_Core_Permission
::VIEW
, $prefix = NULL) {
400 $events = self
::event($type);
401 if (empty($events)) {
405 return "{$prefix}id IN ( " . implode(',', $events) . ' ) ';
410 * Checks that component is enabled and optionally that user has basic perm.
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
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".
423 * Access to specified $module is granted.
425 public static function access($module, $checkPermission = TRUE, $requireAllCasesPermOnCiviCase = FALSE) {
426 $config = CRM_Core_Config
::singleton();
428 if (!in_array($module, $config->enableComponents
)) {
432 if ($checkPermission) {
435 $access_all_cases = CRM_Core_Permission
::check("access all cases and activities");
436 $access_my_cases = CRM_Core_Permission
::check("access my cases and activities");
437 return $access_all_cases ||
(!$requireAllCasesPermOnCiviCase && $access_my_cases);
440 return CRM_Core_Permission
::check("administer $module");
443 return CRM_Core_Permission
::check("access $module");
451 * Check permissions for delete and edit actions.
453 * @param string $module
456 * Action to be check across component.
461 public static function checkActionPermission($module, $action) {
462 //check delete related permissions.
463 if ($action & CRM_Core_Action
::DELETE
) {
464 $permissionName = "delete in $module";
468 'CiviEvent' => 'edit event participants',
469 'CiviMember' => 'edit memberships',
470 'CiviPledge' => 'edit pledges',
471 'CiviContribute' => 'edit contributions',
472 'CiviGrant' => 'edit grants',
473 'CiviMail' => 'access CiviMail',
474 'CiviAuction' => 'add auction items',
476 $permissionName = $editPermissions[$module] ??
NULL;
479 if ($module == 'CiviCase' && !$permissionName) {
480 return CRM_Case_BAO_Case
::accessCiviCase();
483 //check for permission.
484 return CRM_Core_Permission
::check($permissionName);
494 public static function checkMenu(&$args, $op = 'and') {
495 if (!is_array($args)) {
498 foreach ($args as $str) {
499 $res = CRM_Core_Permission
::check($str);
500 if ($op == 'or' && $res) {
503 elseif ($op == 'and' && !$res) {
507 return ($op == 'or') ?
FALSE : TRUE;
516 public static function checkMenuItem(&$item) {
517 if (!array_key_exists('access_callback', $item)) {
518 CRM_Core_Error
::backtrace();
519 throw new CRM_Core_Exception('Missing Access Callback key in menu item');
522 // if component_id is present, ensure it is enabled
523 if (isset($item['component_id']) && $item['component_id']) {
524 if (!isset(Civi
::$statics[__CLASS__
]['componentNameId'])) {
525 Civi
::$statics[__CLASS__
]['componentNameId'] = array_flip(CRM_Core_Component
::getComponentIDs());
527 $componentName = Civi
::$statics[__CLASS__
]['componentNameId'][$item['component_id']];
529 $config = CRM_Core_Config
::singleton();
530 if (is_array($config->enableComponents
) && in_array($componentName, $config->enableComponents
)) {
531 // continue with process
538 // the following is imitating drupal 6 code in includes/menu.inc
539 if (empty($item['access_callback']) ||
540 is_numeric($item['access_callback'])
542 return (bool) $item['access_callback'];
545 // check whether the following Ajax requests submitted the right key
546 // FIXME: this should be integrated into ACLs proper
547 if (CRM_Utils_Array
::value('page_type', $item) == 3) {
548 if (!CRM_Core_Key
::validate($_REQUEST['key'], $item['path'])) {
553 // check if callback is for checkMenu, if so optimize it
554 if (is_array($item['access_callback']) &&
555 $item['access_callback'][0] == 'CRM_Core_Permission' &&
556 $item['access_callback'][1] == 'checkMenu'
558 $op = CRM_Utils_Array
::value(1, $item['access_arguments'], 'and');
559 return self
::checkMenu($item['access_arguments'][0], $op);
562 return call_user_func_array($item['access_callback'], $item['access_arguments']);
568 * Include disabled components
569 * @param bool $descriptions
570 * Whether to return descriptions
574 public static function basicPermissions($all = FALSE, $descriptions = FALSE) {
575 $cacheKey = implode('-', [$all, $descriptions]);
576 if (empty(Civi
::$statics[__CLASS__
][__FUNCTION__
][$cacheKey])) {
577 Civi
::$statics[__CLASS__
][__FUNCTION__
][$cacheKey] = self
::assembleBasicPermissions($all, $descriptions);
579 return Civi
::$statics[__CLASS__
][__FUNCTION__
][$cacheKey];
584 * @param bool $descriptions
585 * whether to return descriptions
588 * @throws \CRM_Core_Exception
590 public static function assembleBasicPermissions($all = FALSE, $descriptions = FALSE): array {
591 $permissions = self
::getCoreAndComponentPermissions($all);
593 // Add any permissions defined in hook_civicrm_permission implementations.
594 $module_permissions = CRM_Core_Config
::singleton()->userPermissionClass
->getAllModulePermissions(TRUE, $permissions);
595 $permissions = array_merge($permissions, $module_permissions);
596 if (!$descriptions) {
597 foreach ($permissions as $name => $attr) {
598 $permissions[$name] = array_shift($attr);
607 public static function getAnonymousPermissionsWarnings() {
608 static $permissions = [];
609 if (empty($permissions)) {
611 'administer CiviCRM',
613 $components = CRM_Core_Component
::getComponents();
614 foreach ($components as $comp) {
615 if (!method_exists($comp, 'getAnonymousPermissionWarnings')) {
618 $permissions = array_merge($permissions, $comp->getAnonymousPermissionWarnings());
625 * @param $anonymous_perms
629 public static function validateForPermissionWarnings($anonymous_perms) {
630 return array_intersect($anonymous_perms, self
::getAnonymousPermissionsWarnings());
634 * Get core permissions.
638 public static function getCorePermissions() {
639 $prefix = ts('CiviCRM') . ': ';
642 $prefix . ts('add contacts'),
643 ts('Create a new contact record in CiviCRM'),
645 'view all contacts' => [
646 $prefix . ts('view all contacts'),
647 ts('View ANY CONTACT in the CiviCRM database, export contact info and perform activities such as Send Email, Phone Call, etc.'),
649 'edit all contacts' => [
650 $prefix . ts('edit all contacts'),
651 ts('View, Edit and Delete ANY CONTACT in the CiviCRM database; Create and edit relationships, tags and other info about the contacts'),
653 'view my contact' => [
654 $prefix . ts('view my contact'),
656 'edit my contact' => [
657 $prefix . ts('edit my contact'),
659 'delete contacts' => [
660 $prefix . ts('delete contacts'),
662 'access deleted contacts' => [
663 $prefix . ts('access deleted contacts'),
664 ts('Access contacts in the trash'),
666 'import contacts' => [
667 $prefix . ts('import contacts'),
668 ts('Import contacts and activities'),
670 'import SQL datasource' => [
671 $prefix . ts('import SQL datasource'),
672 ts('When importing, consume data directly from a SQL datasource'),
675 $prefix . ts('edit groups'),
676 ts('Create new groups, edit group settings (e.g. group name, visibility...), delete groups'),
678 'administer CiviCRM' => [
679 $prefix . ts('administer CiviCRM'),
680 ts('Perform all tasks in the Administer CiviCRM control panel and Import Contacts'),
682 'skip IDS check' => [
683 $prefix . ts('skip IDS check'),
684 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.'),
686 'access uploaded files' => [
687 $prefix . ts('access uploaded files'),
688 ts('View / download files including images and photos'),
690 'profile listings and forms' => [
691 $prefix . ts('profile listings and forms'),
692 ts('Warning: Give to trusted roles only; this permission has privacy implications. Add/edit data in online forms and access public searchable directories.'),
694 'profile listings' => [
695 $prefix . ts('profile listings'),
696 ts('Warning: Give to trusted roles only; this permission has privacy implications. Access public searchable directories.'),
698 'profile create' => [
699 $prefix . ts('profile create'),
700 ts('Add data in a profile form.'),
703 $prefix . ts('profile edit'),
704 ts('Edit data in a profile form.'),
707 $prefix . ts('profile view'),
708 ts('View data in a profile.'),
710 'access all custom data' => [
711 $prefix . ts('access all custom data'),
712 ts('View all custom fields regardless of ACL rules'),
714 'view all activities' => [
715 $prefix . ts('view all activities'),
716 ts('View all activities (for visible contacts)'),
718 'delete activities' => [
719 $prefix . ts('Delete activities'),
721 'edit inbound email basic information' => [
722 $prefix . ts('edit inbound email basic information'),
723 ts('Edit all inbound email activities (for visible contacts) basic information. Content editing not allowed.'),
725 'edit inbound email basic information and content' => [
726 $prefix . ts('edit inbound email basic information and content'),
727 ts('Edit all inbound email activities (for visible contacts) basic information and content.'),
729 'access CiviCRM' => [
730 $prefix . ts('access CiviCRM backend and API'),
731 ts('Master control for access to the main CiviCRM backend and API. Give to trusted roles only.'),
733 'access Contact Dashboard' => [
734 $prefix . ts('access Contact Dashboard'),
735 ts('View Contact Dashboard (for themselves and visible contacts)'),
737 'translate CiviCRM' => [
738 $prefix . ts('translate CiviCRM'),
739 ts('Allow User to enable multilingual'),
742 $prefix . ts('manage tags'),
743 ts('Create and rename tags'),
745 'administer reserved groups' => [
746 $prefix . ts('administer reserved groups'),
747 ts('Edit and disable Reserved Groups (Needs Edit Groups)'),
749 'administer Tagsets' => [
750 $prefix . ts('administer Tagsets'),
752 'administer reserved tags' => [
753 $prefix . ts('administer reserved tags'),
755 'administer dedupe rules' => [
756 $prefix . ts('administer dedupe rules'),
757 ts('Create and edit rules, change the supervised and unsupervised rules'),
759 'merge duplicate contacts' => [
760 $prefix . ts('merge duplicate contacts'),
761 ts('Delete Contacts must also be granted in order for this to work.'),
763 'force merge duplicate contacts' => [
764 $prefix . ts('force merge duplicate contacts'),
765 ts('Delete Contacts must also be granted in order for this to work.'),
767 'view debug output' => [
768 $prefix . ts('view debug output'),
769 ts('View results of debug and backtrace'),
772 'view all notes' => [
773 $prefix . ts('view all notes'),
774 ts("View notes (for visible contacts) even if they're marked admin only"),
776 'add contact notes' => [
777 $prefix . ts('add contact notes'),
778 ts("Create notes for contacts"),
780 'access AJAX API' => [
781 $prefix . ts('access AJAX API'),
782 ts('Allow API access even if Access CiviCRM is not granted'),
784 'access contact reference fields' => [
785 $prefix . ts('access contact reference fields'),
786 ts('Allow entering data into contact reference fields'),
788 'create manual batch' => [
789 $prefix . ts('create manual batch'),
790 ts('Create an accounting batch (with Access to CiviContribute and View Own/All Manual Batches)'),
792 'edit own manual batches' => [
793 $prefix . ts('edit own manual batches'),
794 ts('Edit accounting batches created by user'),
796 'edit all manual batches' => [
797 $prefix . ts('edit all manual batches'),
798 ts('Edit all accounting batches'),
800 'close own manual batches' => [
801 $prefix . ts('close own manual batches'),
802 ts('Close accounting batches created by user (with Access to CiviContribute)'),
804 'close all manual batches' => [
805 $prefix . ts('close all manual batches'),
806 ts('Close all accounting batches (with Access to CiviContribute)'),
808 'reopen own manual batches' => [
809 $prefix . ts('reopen own manual batches'),
810 ts('Reopen accounting batches created by user (with Access to CiviContribute)'),
812 'reopen all manual batches' => [
813 $prefix . ts('reopen all manual batches'),
814 ts('Reopen all accounting batches (with Access to CiviContribute)'),
816 'view own manual batches' => [
817 $prefix . ts('view own manual batches'),
818 ts('View accounting batches created by user (with Access to CiviContribute)'),
820 'view all manual batches' => [
821 $prefix . ts('view all manual batches'),
822 ts('View all accounting batches (with Access to CiviContribute)'),
824 'delete own manual batches' => [
825 $prefix . ts('delete own manual batches'),
826 ts('Delete accounting batches created by user'),
828 'delete all manual batches' => [
829 $prefix . ts('delete all manual batches'),
830 ts('Delete all accounting batches'),
832 'export own manual batches' => [
833 $prefix . ts('export own manual batches'),
834 ts('Export accounting batches created by user'),
836 'export all manual batches' => [
837 $prefix . ts('export all manual batches'),
838 ts('Export all accounting batches'),
840 'administer payment processors' => [
841 $prefix . ts('administer payment processors'),
842 ts('Add, Update, or Disable Payment Processors'),
844 'edit message templates' => [
845 $prefix . ts('edit message templates'),
847 'edit system workflow message templates' => [
848 $prefix . ts('edit system workflow message templates'),
850 'edit user-driven message templates' => [
851 $prefix . ts('edit user-driven message templates'),
853 'view my invoices' => [
854 $prefix . ts('view my invoices'),
855 ts('Allow users to view/ download their own invoices'),
858 $prefix . ts('edit api keys'),
861 'edit own api keys' => [
862 $prefix . ts('edit own api keys'),
863 ts('Edit user\'s own API keys'),
866 $prefix . ts('send SMS'),
869 'administer CiviCRM system' => [
870 'label' => $prefix . ts('administer CiviCRM System'),
871 'description' => ts('Perform all system administration tasks in CiviCRM'),
873 'administer CiviCRM data' => [
874 'label' => $prefix . ts('administer CiviCRM Data'),
875 'description' => ts('Permit altering all restricted data options'),
877 'all CiviCRM permissions and ACLs' => [
878 'label' => $prefix . ts('all CiviCRM permissions and ACLs'),
879 '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'),
882 if (self
::isMultisiteEnabled()) {
883 // This could arguably be moved to the multisite extension but
884 // within core it does permit editing group-organization records.
885 $permissions['administer Multiple Organizations'] = [
886 'label' => $prefix . ts('administer Multiple Organizations'),
887 'description' => ts('Administer multiple organizations. In practice this allows editing the group organization link'),
894 * Get permissions implied by 'superset' permissions.
898 public static function getImpliedAdminPermissions(): array {
900 'administer CiviCRM' => ['implied_permissions' => ['administer CiviCRM system', 'administer CiviCRM data']],
901 'administer CiviCRM data' => ['implied_permissions' => ['edit message templates', 'administer dedupe rules']],
902 'administer CiviCRM system' => ['implied_permissions' => ['edit system workflow message templates']],
907 * Get any super-permissions that imply the given permission.
909 * @param string $permission
913 public static function getImpliedPermissionsFor(string $permission): array {
914 if (in_array($permission[0], ['@', '*'], TRUE)) {
915 // Special permissions like '*always deny*' - see DynamicFKAuthorizationTest.
916 // Also '@afform - see AfformUsageTest.
919 $implied = Civi
::cache('metadata')->get('implied_permissions', []);
920 if (isset($implied[$permission])) {
921 return $implied[$permission];
923 $implied[$permission] = ['all CiviCRM permissions and ACLs'];
924 foreach (self
::getImpliedAdminPermissions() as $key => $details) {
925 if (in_array($permission, $details['implied_permissions'] ??
[], TRUE)) {
926 $implied[$permission][] = $key;
929 Civi
::cache('metadata')->set('implied_permissions', $implied);
930 return $implied[$permission];
934 * For each entity provides an array of permissions required for each action
936 * The action is the array key, possible values:
937 * * create: applies to create (with no id in params)
938 * * update: applies to update, setvalue, create (with id in params)
939 * * get: applies to getcount, getsingle, getvalue and other gets
940 * * delete: applies to delete, replace
941 * * meta: applies to getfields, getoptions, getspec
942 * * default: catch-all for anything not declared
944 * Note: some APIs declare other actions as well
946 * Permissions should use arrays for AND and arrays of arrays for OR
947 * @see CRM_Core_Permission::check
949 * @return array of permissions
951 public static function getEntityActionPermissions() {
953 // These are the default permissions - if any entity does not declare permissions for a given action,
954 // (or the entity does not declare permissions at all) - then the action will be used from here
955 $permissions['default'] = [
956 // applies to getfields, getoptions, etc.
957 'meta' => ['access CiviCRM'],
958 // catch-all, applies to create, get, delete, etc.
959 // If an entity declares it's own 'default' action it will override this one
960 'default' => ['administer CiviCRM'],
963 // Note: Additional permissions in DynamicFKAuthorization
964 $permissions['attachment'] = [
966 ['access CiviCRM', 'access AJAX API'],
970 // Contact permissions
971 $permissions['contact'] = [
980 // managed by query object
982 // managed by _civicrm_api3_check_edit_permissions
985 ['access CiviCRM', 'access AJAX API'],
987 'duplicatecheck' => [
990 'merge' => ['merge duplicate contacts'],
993 $permissions['dedupe'] = [
994 'getduplicates' => ['access CiviCRM'],
995 'getstatistics' => ['access CiviCRM'],
998 // CRM-16963 - Permissions for country.
999 $permissions['country'] = [
1004 'administer CiviCRM',
1008 // Contact-related data permissions.
1009 $permissions['address'] = [
1010 // get is managed by BAO::addSelectWhereClause
1011 // create/delete are managed by _civicrm_api3_check_edit_permissions
1014 $permissions['email'] = $permissions['address'];
1015 $permissions['phone'] = $permissions['address'];
1016 $permissions['website'] = $permissions['address'];
1017 $permissions['im'] = $permissions['address'];
1018 $permissions['open_i_d'] = $permissions['address'];
1020 // Also managed by ACLs - CRM-19448
1021 $permissions['entity_tag'] = ['default' => []];
1022 $permissions['note'] = $permissions['entity_tag'];
1024 // Allow non-admins to get and create tags to support tagset widget
1025 // Delete is still reserved for admins
1026 $permissions['tag'] = [
1027 'get' => ['access CiviCRM'],
1028 'create' => ['access CiviCRM'],
1029 'update' => ['access CiviCRM'],
1032 //relationship permissions
1033 $permissions['relationship'] = [
1034 // get is managed by BAO::addSelectWhereClause
1038 'edit all contacts',
1042 'edit all contacts',
1046 // CRM-17741 - Permissions for RelationshipType.
1047 $permissions['relationship_type'] = [
1052 'administer CiviCRM',
1056 // Activity permissions
1057 $permissions['activity'] = [
1060 'delete activities',
1064 // Note that view all activities is also required within the api
1065 // if the id is not passed in. Where the id is passed in the activity
1066 // specific check functions are used and tested.
1070 'view all activities',
1073 $permissions['activity_contact'] = $permissions['activity'];
1076 $permissions['case'] = [
1083 'delete in CiviCase',
1086 'administer CiviCase',
1089 'administer CiviCase',
1092 // At minimum the user needs one of the following. Finer-grained access is controlled by CRM_Case_BAO_Case::addSelectWhereClause
1093 ['access my cases and activities', 'access all cases and activities'],
1096 $permissions['case_contact'] = $permissions['case'];
1097 $permissions['case_activity'] = $permissions['case'];
1099 $permissions['case_type'] = [
1100 'default' => ['administer CiviCase'],
1102 // nested array = OR
1103 ['access my cases and activities', 'access all cases and activities'],
1107 // Campaign permissions
1108 $permissions['campaign'] = [
1109 'get' => ['access CiviCRM'],
1111 // nested array = OR
1112 ['administer CiviCampaign', 'manage campaign'],
1115 $permissions['survey'] = $permissions['campaign'];
1117 // Financial permissions
1118 $permissions['contribution'] = [
1121 'access CiviContribute',
1125 'access CiviContribute',
1126 'delete in CiviContribute',
1128 'completetransaction' => [
1129 'edit contributions',
1133 'access CiviContribute',
1134 'edit contributions',
1137 $permissions['line_item'] = $permissions['contribution'];
1139 // Payment permissions
1140 $permissions['payment'] = [
1143 'access CiviContribute',
1147 'access CiviContribute',
1148 'delete in CiviContribute',
1152 'access CiviContribute',
1153 'edit contributions',
1157 'access CiviContribute',
1158 'edit contributions',
1162 'access CiviContribute',
1163 'edit contributions',
1166 $permissions['contribution_recur'] = $permissions['payment'];
1168 // Custom field permissions
1169 $permissions['custom_field'] = [
1171 'administer CiviCRM',
1172 'access all custom data',
1175 $permissions['custom_group'] = $permissions['custom_field'];
1177 // Event permissions
1178 $permissions['event'] = [
1187 'delete in CiviEvent',
1200 // Exception refers to dedupe_exception.
1201 $permissions['exception'] = [
1202 'default' => ['merge duplicate contacts'],
1205 $permissions['job'] = [
1206 'process_batch_merge' => ['merge duplicate contacts'],
1208 $permissions['rule_group']['get'] = [['merge duplicate contacts', 'administer CiviCRM']];
1209 // Loc block is only used for events
1210 $permissions['loc_block'] = $permissions['event'];
1212 $permissions['state_province'] = [
1218 // Price sets are shared by several components, user needs access to at least one of them
1219 $permissions['price_set'] = [
1221 ['access CiviEvent', 'access CiviContribute', 'access CiviMember'],
1224 ['access CiviCRM', 'view event info', 'make online contributions'],
1229 $permissions['file'] = [
1232 'access uploaded files',
1235 $permissions['files_by_entity'] = $permissions['file'];
1237 // Group permissions
1238 $permissions['group'] = [
1248 $permissions['group_nesting'] = $permissions['group'];
1249 $permissions['group_organization'] = $permissions['group'];
1251 //Group Contact permission
1252 $permissions['group_contact'] = [
1258 'edit all contacts',
1262 // CiviMail Permissions
1263 $civiMailBasePerms = [
1264 // To get/preview/update, one must have least one of these perms:
1265 // Mailing API implementations enforce nuances of create/approve/schedule permissions.
1268 'schedule mailings',
1271 $permissions['mailing'] = [
1279 'delete in CiviMail',
1283 ['access CiviMail', 'schedule mailings'],
1290 $permissions['mailing_group'] = $permissions['mailing'];
1291 $permissions['mailing_job'] = $permissions['mailing'];
1292 $permissions['mailing_recipients'] = $permissions['mailing'];
1294 $permissions['mailing_a_b'] = [
1302 'delete in CiviMail',
1306 ['access CiviMail', 'schedule mailings'],
1314 // Membership permissions
1315 $permissions['membership'] = [
1318 'access CiviMember',
1322 'access CiviMember',
1323 'delete in CiviMember',
1327 'access CiviMember',
1331 $permissions['membership_status'] = $permissions['membership'];
1332 $permissions['membership_type'] = $permissions['membership'];
1333 $permissions['membership_payment'] = [
1336 'access CiviMember',
1338 'access CiviContribute',
1339 'edit contributions',
1343 'access CiviMember',
1344 'delete in CiviMember',
1345 'access CiviContribute',
1346 'delete in CiviContribute',
1350 'access CiviMember',
1351 'access CiviContribute',
1355 'access CiviMember',
1357 'access CiviContribute',
1358 'edit contributions',
1362 // Participant permissions
1363 $permissions['participant'] = [
1367 'register for events',
1372 'edit event participants',
1377 'view event participants',
1382 'edit event participants',
1385 $permissions['participant_payment'] = [
1389 'register for events',
1390 'access CiviContribute',
1391 'edit contributions',
1396 'edit event participants',
1397 'access CiviContribute',
1398 'delete in CiviContribute',
1403 'view event participants',
1404 'access CiviContribute',
1409 'edit event participants',
1410 'access CiviContribute',
1411 'edit contributions',
1415 // Pledge permissions
1416 $permissions['pledge'] = [
1419 'access CiviPledge',
1424 'access CiviPledge',
1425 'delete in CiviPledge',
1429 'access CiviPledge',
1433 'access CiviPledge',
1438 //CRM-16777: Disable schedule reminder for user that have 'edit all events' and 'administer CiviCRM' permission.
1439 $permissions['action_schedule'] = [
1448 $permissions['pledge_payment'] = [
1451 'access CiviPledge',
1453 'access CiviContribute',
1454 'edit contributions',
1458 'access CiviPledge',
1459 'delete in CiviPledge',
1460 'access CiviContribute',
1461 'delete in CiviContribute',
1465 'access CiviPledge',
1466 'access CiviContribute',
1470 'access CiviPledge',
1472 'access CiviContribute',
1473 'edit contributions',
1477 // Dashboard permissions
1478 $permissions['dashboard'] = [
1483 $permissions['dashboard_contact'] = [
1489 // Profile permissions
1490 $permissions['profile'] = [
1491 // the profile will take care of this
1495 $permissions['uf_group'] = [
1499 'administer CiviCRM',
1500 'manage event profiles',
1509 'administer CiviCRM',
1510 'manage event profiles',
1514 $permissions['uf_field'] = $permissions['uf_join'] = $permissions['uf_group'];
1515 $permissions['uf_field']['delete'] = [
1518 'administer CiviCRM',
1519 'manage event profiles',
1522 $permissions['option_value'] = $permissions['uf_group'];
1523 $permissions['option_group'] = $permissions['option_value'];
1525 $permissions['custom_value'] = [
1526 'gettree' => ['access CiviCRM'],
1529 $permissions['message_template'] = [
1530 'get' => ['access CiviCRM'],
1531 'create' => [['edit message templates', 'edit user-driven message templates', 'edit system workflow message templates']],
1532 'update' => [['edit message templates', 'edit user-driven message templates', 'edit system workflow message templates']],
1535 $permissions['report_template']['update'] = 'save Report Criteria';
1536 $permissions['report_template']['create'] = 'save Report Criteria';
1537 return $permissions;
1541 * Translate an unknown action to a canonical form.
1543 * @param string $action
1546 * the standardised action name
1548 public static function getGenericAction($action) {
1549 $snippet = substr($action, 0, 3);
1550 if ($action == 'replace' ||
$snippet == 'del') {
1551 // 'Replace' is a combination of get+create+update+delete; however, the permissions
1552 // on each of those will be tested separately at runtime. This is just a sniff-test
1553 // based on the heuristic that 'delete' tends to be the most closely guarded
1554 // of the necessary permissions.
1557 elseif ($action == 'setvalue' ||
$snippet == 'upd') {
1560 elseif ($action == 'getfields' ||
$action == 'getfield' ||
$action == 'getspec' ||
$action == 'getoptions') {
1563 elseif ($snippet == 'get') {
1570 * Validate user permission across.
1571 * edit or view or with supportable acls.
1575 public static function giveMeAllACLs() {
1576 if (CRM_Core_Permission
::check('view all contacts') ||
1577 CRM_Core_Permission
::check('edit all contacts')
1582 $session = CRM_Core_Session
::singleton();
1583 $contactID = $session->get('userID');
1586 $aclPermission = self
::getPermission();
1587 if (in_array($aclPermission, [
1588 CRM_Core_Permission
::EDIT
,
1589 CRM_Core_Permission
::VIEW
,
1595 // run acl where hook and see if the user is supplying an ACL clause
1596 // that is not false
1597 $tables = $whereTables = [];
1600 CRM_Utils_Hook
::aclWhereClause(CRM_Core_Permission
::VIEW
,
1601 $tables, $whereTables,
1604 return empty($whereTables) ?
FALSE : TRUE;
1608 * Get component name from given permission.
1610 * @param string $permission
1612 * @return null|string
1613 * the name of component.
1615 public static function getComponentName($permission) {
1616 $componentName = NULL;
1617 $permission = trim($permission);
1618 if (empty($permission)) {
1619 return $componentName;
1622 static $allCompPermissions = [];
1623 if (empty($allCompPermissions)) {
1624 $components = CRM_Core_Component
::getComponents();
1625 foreach ($components as $name => $comp) {
1626 //get all permissions of each components unconditionally
1627 $allCompPermissions[$name] = $comp->getPermissions(TRUE);
1631 if (is_array($allCompPermissions)) {
1632 foreach ($allCompPermissions as $name => $permissions) {
1633 if (array_key_exists($permission, $permissions)) {
1634 $componentName = $name;
1640 return $componentName;
1644 * Get all the contact emails for users that have a specific permission.
1646 * @param string $permissionName
1647 * Name of the permission we are interested in.
1650 * a comma separated list of email addresses
1652 public static function permissionEmails($permissionName) {
1653 $config = CRM_Core_Config
::singleton();
1654 return $config->userPermissionClass
->permissionEmails($permissionName);
1658 * Get all the contact emails for users that have a specific role.
1660 * @param string $roleName
1661 * Name of the role we are interested in.
1664 * a comma separated list of email addresses
1666 public static function roleEmails($roleName) {
1667 $config = CRM_Core_Config
::singleton();
1668 return $config->userRoleClass
->roleEmails($roleName);
1674 public static function isMultisiteEnabled() {
1675 return (bool) Civi
::settings()->get('is_enabled');
1679 * Verify if the user has permission to get the invoice.
1682 * TRUE if the user has download all invoices permission or download my
1683 * invoices permission and the invoice author is the current user.
1685 public static function checkDownloadInvoice() {
1686 $cid = CRM_Core_Session
::getLoggedInContactID();
1687 if (CRM_Core_Permission
::check('access CiviContribute') ||
1688 (CRM_Core_Permission
::check('view my invoices') && $_GET['cid'] == $cid)
1696 * Get permissions for components.
1698 * @param bool $includeDisabled
1701 * @throws \CRM_Core_Exception
1703 protected static function getComponentPermissions(bool $includeDisabled): array {
1704 if (!$includeDisabled) {
1705 $components = CRM_Core_Component
::getEnabledComponents();
1708 $components = CRM_Core_Component
::getComponents();
1712 foreach ($components as $comp) {
1713 $perm = $comp->getPermissions($includeDisabled, TRUE);
1715 $info = $comp->getInfo();
1716 foreach ($perm as $p => $attr) {
1718 if (!is_array($attr)) {
1722 $attr[0] = $info['translatedName'] . ': ' . $attr[0];
1723 $permissions[$p] = $attr;
1727 return $permissions;
1731 * Get permissions for core functionality and for that of core components.
1736 * @throws \CRM_Core_Exception
1738 protected static function getCoreAndComponentPermissions(bool $all): array {
1739 $permissions = self
::getCorePermissions();
1740 $permissions = array_merge($permissions, self
::getComponentPermissions($all));
1741 $permissions['all CiviCRM permissions and ACLs']['implied_permissions'] = array_keys($permissions);
1742 return $permissions;