3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
37 * This is the basic permission class wrapper
39 class CRM_Core_Permission
{
42 * Static strings used to compose permissions
47 CONST EDIT_GROUPS
= 'edit contacts in ', VIEW_GROUPS
= 'view contacts in ';
50 * The various type of permissions
54 CONST EDIT
= 1, VIEW
= 2, DELETE
= 3, CREATE
= 4, SEARCH
= 5, ALL
= 6, ADMIN
= 7;
57 * A placeholder permission which always fails
59 const ALWAYS_DENY_PERMISSION
= "*always deny*";
62 * A placeholder permission which always fails
64 const ALWAYS_ALLOW_PERMISSION
= "*always allow*";
67 * Various authentication sources
71 CONST AUTH_SRC_UNKNOWN
= 0, AUTH_SRC_CHECKSUM
= 1, AUTH_SRC_SITEKEY
= 2, AUTH_SRC_LOGIN
= 4;
74 * get the current permission of this user
76 * @return string the permission of the user (edit or view or null)
78 public static function getPermission() {
79 $config = CRM_Core_Config
::singleton();
80 return $config->userPermissionClass
->getPermission();
84 * given a permission string or array, check for access requirements
85 * @param mixed $permissions the permission to check as an array or string -see examples
90 * Must have 'access CiviCRM'
91 * (string) 'access CiviCRM'
94 * Ex 2 Must have 'access CiviCRM' and 'access Ajax API'
95 * array('access CiviCRM', 'access Ajax API')
97 * Ex 3 Must have 'access CiviCRM' or 'access Ajax API'
99 * array('access CiviCRM', 'access Ajax API'),
102 * Ex 4 Must have 'access CiviCRM' or 'access Ajax API' AND 'access CiviEvent'
104 * array('access CiviCRM', 'access Ajax API'),
105 * 'access CiviEvent',
108 * Note that in permissions.php this is keyed by the action eg.
109 * (access Civi || access AJAX) && (access CiviEvent || access CiviContribute)
110 * 'myaction' => array(
111 * array('access CiviCRM', 'access Ajax API'),
112 * array('access CiviEvent', 'access CiviContribute')
115 * @return boolean true if yes, else false
119 static function check($permissions) {
120 $permissions = (array) $permissions;
122 foreach ($permissions as $permission) {
123 if(is_array($permission)) {
124 foreach ($permission as $orPerm) {
125 if(self
::check($orPerm)) {
126 //one of our 'or' permissions has succeeded - stop checking this permission
130 //none of our our conditions was met
134 if(!CRM_Core_Config
::singleton()->userPermissionClass
->check($permission)) {
135 //one of our 'and' conditions has not been met
144 * Determine if any one of the permissions strings applies to current user
146 * @param array $perms
149 public static function checkAnyPerm($perms) {
150 foreach ($perms as $perm) {
151 if (CRM_Core_Permission
::check($perm)) {
159 * Given a group/role array, check for access requirements
161 * @param array $array the group/role to check
163 * @return boolean true if yes, else false
167 static function checkGroupRole($array) {
168 $config = CRM_Core_Config
::singleton();
169 return $config->userPermissionClass
->checkGroupRole($array);
173 * Get the permissioned where clause for the user
175 * @param int $type the type of permission needed
176 * @param array $tables (reference ) add the tables that are needed for the select clause
177 * @param array $whereTables (reference ) add the tables that are needed for the where clause
179 * @return string the group where clause for this user
182 public static function getPermissionedStaticGroupClause($type, &$tables, &$whereTables) {
183 $config = CRM_Core_Config
::singleton();
184 return $config->userPermissionClass
->getPermissionedStaticGroupClause($type, $tables, $whereTables);
188 * Get all groups from database, filtered by permissions
191 * @param string $groupType type of group(Access/Mailing)
192 * @param boolen $excludeHidden exclude hidden groups.
197 * @return array - array reference of all groups.
200 public static function group($groupType, $excludeHidden = TRUE) {
201 $config = CRM_Core_Config
::singleton();
202 return $config->userPermissionClass
->group($groupType, $excludeHidden);
205 public static function customGroupAdmin() {
208 // check if user has all powerful permission
209 // or administer civicrm permission (CRM-1905)
210 if (self
::check('access all custom data')) {
215 self
::check('administer Multiple Organizations') &&
216 self
::isMultisiteEnabled()
221 if (self
::check('administer CiviCRM')) {
228 public static function customGroup($type = CRM_Core_Permission
::VIEW
, $reset = FALSE) {
229 $customGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_CustomField', 'custom_group_id',
230 array('fresh' => $reset));
231 $defaultGroups = array();
233 // check if user has all powerful permission
234 // or administer civicrm permission (CRM-1905)
235 if (self
::customGroupAdmin()) {
236 $defaultGroups = array_keys($customGroups);
239 return CRM_ACL_API
::group($type, NULL, 'civicrm_custom_group', $customGroups, $defaultGroups);
242 static function customGroupClause($type = CRM_Core_Permission
::VIEW
, $prefix = NULL, $reset = FALSE) {
243 if (self
::customGroupAdmin()) {
247 $groups = self
::customGroup($type, $reset);
248 if (empty($groups)) {
252 return "{$prefix}id IN ( " . implode(',', $groups) . ' ) ';
256 public static function ufGroupValid($gid, $type = CRM_Core_Permission
::VIEW
) {
261 $groups = self
::ufGroup($type);
262 return in_array($gid, $groups) ?
TRUE : FALSE;
265 public static function ufGroup($type = CRM_Core_Permission
::VIEW
) {
266 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
268 $allGroups = array_keys($ufGroups);
270 // check if user has all powerful permission
271 if (self
::check('profile listings and forms')) {
276 case CRM_Core_Permission
::VIEW
:
277 if (self
::check('profile view')) {
282 case CRM_Core_Permission
::CREATE
:
283 if (self
::check('profile create')) {
288 case CRM_Core_Permission
::EDIT
:
289 if (self
::check('profile edit')) {
294 case CRM_Core_Permission
::SEARCH
:
295 if (self
::check('profile listings')) {
301 return CRM_ACL_API
::group($type, NULL, 'civicrm_uf_group', $ufGroups);
304 static function ufGroupClause($type = CRM_Core_Permission
::VIEW
, $prefix = NULL, $returnUFGroupIds = FALSE) {
305 $groups = self
::ufGroup($type);
306 if ($returnUFGroupIds) {
309 elseif (empty($groups)) {
313 return "{$prefix}id IN ( " . implode(',', $groups) . ' ) ';
317 public static function event($type = CRM_Core_Permission
::VIEW
, $eventID = NULL) {
318 $events = CRM_Event_PseudoConstant
::event(NULL, TRUE);
319 $includeEvents = array();
321 // check if user has all powerful permission
322 if (self
::check('register for events')) {
323 $includeEvents = array_keys($events);
326 if ($type == CRM_Core_Permission
::VIEW
&&
327 self
::check('view event info')
329 $includeEvents = array_keys($events);
332 $permissionedEvents = CRM_ACL_API
::group($type, NULL, 'civicrm_event', $events, $includeEvents);
334 return $permissionedEvents;
336 if (!empty($permissionedEvents)) {
337 return array_search($eventID, $permissionedEvents) === FALSE ?
NULL : $eventID;
344 static function eventClause($type = CRM_Core_Permission
::VIEW
, $prefix = NULL) {
345 $events = self
::event($type);
346 if (empty($events)) {
350 return "{$prefix}id IN ( " . implode(',', $events) . ' ) ';
354 static function access($module, $checkPermission = TRUE) {
355 $config = CRM_Core_Config
::singleton();
357 if (!in_array($module, $config->enableComponents
)) {
361 if ($checkPermission) {
362 if ($module == 'CiviCase') {
363 return CRM_Case_BAO_Case
::accessCiviCase();
366 return CRM_Core_Permission
::check("access $module");
374 * check permissions for delete and edit actions
376 * @param string $module component name.
377 * @param $action action to be check across component
380 static function checkActionPermission($module, $action) {
381 //check delete related permissions.
382 if ($action & CRM_Core_Action
::DELETE
) {
383 $permissionName = "delete in $module";
386 $editPermissions = array(
387 'CiviEvent' => 'edit event participants',
388 'CiviMember' => 'edit memberships',
389 'CiviPledge' => 'edit pledges',
390 'CiviContribute' => 'edit contributions',
391 'CiviGrant' => 'edit grants',
392 'CiviMail' => 'access CiviMail',
393 'CiviAuction' => 'add auction items',
395 $permissionName = CRM_Utils_Array
::value($module, $editPermissions);
398 if ($module == 'CiviCase' && !$permissionName) {
399 return CRM_Case_BAO_Case
::accessCiviCase();
402 //check for permission.
403 return CRM_Core_Permission
::check($permissionName);
407 static function checkMenu(&$args, $op = 'and') {
408 if (!is_array($args)) {
411 foreach ($args as $str) {
412 $res = CRM_Core_Permission
::check($str);
413 if ($op == 'or' && $res) {
416 elseif ($op == 'and' && !$res) {
420 return ($op == 'or') ?
FALSE : TRUE;
423 static function checkMenuItem(&$item) {
424 if (!array_key_exists('access_callback', $item)) {
425 CRM_Core_Error
::backtrace();
426 CRM_Core_Error
::fatal();
429 // if component_id is present, ensure it is enabled
430 if (isset($item['component_id']) &&
431 $item['component_id']
433 $config = CRM_Core_Config
::singleton();
434 if (is_array($config->enableComponentIDs
) &&
435 in_array($item['component_id'], $config->enableComponentIDs
)
437 // continue with process
444 // the following is imitating drupal 6 code in includes/menu.inc
445 if (empty($item['access_callback']) ||
446 is_numeric($item['access_callback'])
448 return (boolean
) $item['access_callback'];
451 // check whether the following Ajax requests submitted the right key
452 // FIXME: this should be integrated into ACLs proper
453 if (CRM_Utils_Array
::value('page_type', $item) == 3) {
454 if (!CRM_Core_Key
::validate($_REQUEST['key'], $item['path'])) {
459 // check if callback is for checkMenu, if so optimize it
460 if (is_array($item['access_callback']) &&
461 $item['access_callback'][0] == 'CRM_Core_Permission' &&
462 $item['access_callback'][1] == 'checkMenu'
464 $op = CRM_Utils_Array
::value(1, $item['access_arguments'], 'and');
465 return self
::checkMenu($item['access_arguments'][0], $op);
468 return call_user_func_array($item['access_callback'], $item['access_arguments']);
472 static function &basicPermissions($all = FALSE) {
473 static $permissions = NULL;
476 $prefix = ts('CiviCRM') . ': ';
477 $permissions = self
::getCorePermissions();
479 if (self
::isMultisiteEnabled()) {
480 $permissions['administer Multiple Organizations'] = $prefix . ts('administer Multiple Organizations');
483 $config = CRM_Core_Config
::singleton();
486 $components = CRM_Core_Component
::getEnabledComponents();
489 $components = CRM_Core_Component
::getComponents();
492 foreach ($components as $comp) {
493 $perm = $comp->getPermissions();
495 $info = $comp->getInfo();
496 foreach ($perm as $p) {
497 $permissions[$p] = $info['translatedName'] . ': ' . $p;
502 // Add any permissions defined in hook_civicrm_permission implementations.
503 $config = CRM_Core_Config
::singleton();
504 $module_permissions = $config->userPermissionClass
->getAllModulePermissions();
505 $permissions = array_merge($permissions, $module_permissions);
511 static function getCorePermissions() {
512 $prefix = ts('CiviCRM') . ': ';
513 $permissions = array(
514 'add contacts' => $prefix . ts('add contacts'),
515 'view all contacts' => $prefix . ts('view all contacts'),
516 'edit all contacts' => $prefix . ts('edit all contacts'),
517 'view my contact' => $prefix . ts('view my contact'),
518 'edit my contact' => $prefix . ts('edit my contact'),
519 'delete contacts' => $prefix . ts('delete contacts'),
520 'access deleted contacts' => $prefix . ts('access deleted contacts'),
521 'import contacts' => $prefix . ts('import contacts'),
522 'edit groups' => $prefix . ts('edit groups'),
523 'administer CiviCRM' => $prefix . ts('administer CiviCRM'),
524 'skip IDS check' => $prefix . ts('skip IDS check'),
525 'access uploaded files' => $prefix . ts('access uploaded files'),
526 'profile listings and forms' => $prefix . ts('profile listings and forms'),
527 'profile listings' => $prefix . ts('profile listings'),
528 'profile create' => $prefix . ts('profile create'),
529 'profile edit' => $prefix . ts('profile edit'),
530 'profile view' => $prefix . ts('profile view'),
531 'access all custom data' => $prefix . ts('access all custom data'),
532 'view all activities' => $prefix . ts('view all activities'),
533 'delete activities' => $prefix . ts('delete activities'),
534 'access CiviCRM' => $prefix . ts('access CiviCRM'),
535 'access Contact Dashboard' => $prefix . ts('access Contact Dashboard'),
536 'translate CiviCRM' => $prefix . ts('translate CiviCRM'),
537 'administer reserved groups' => $prefix . ts('administer reserved groups'),
538 'administer Tagsets' => $prefix . ts('administer Tagsets'),
539 'administer reserved tags' => $prefix . ts('administer reserved tags'),
540 'administer dedupe rules' => $prefix . ts('administer dedupe rules'),
541 'merge duplicate contacts' => $prefix . ts('merge duplicate contacts'),
542 'view debug output' => $prefix . ts('view debug output'),
543 'view all notes' => $prefix . ts('view all notes'),
544 'access AJAX API' => $prefix . ts('access AJAX API'),
545 'access contact reference fields' => $prefix . ts('access contact reference fields'),
546 'create manual batch' => $prefix . ts('create manual batch'),
547 'edit own manual batches' => $prefix . ts('edit own manual batches'),
548 'edit all manual batches' => $prefix . ts('edit all manual batches'),
549 'view own manual batches' => $prefix . ts('view own manual batches'),
550 'view all manual batches' => $prefix . ts('view all manual batches'),
551 'delete own manual batches' => $prefix . ts('delete own manual batches'),
552 'delete all manual batches' => $prefix . ts('delete all manual batches'),
553 'export own manual batches' => $prefix . ts('export own manual batches'),
554 'export all manual batches' => $prefix . ts('export all manual batches'),
555 'administer payment processors' => $prefix . ts('administer payment processors'),
562 * Validate user permission across
563 * edit or view or with supportable acls.
565 * return boolean true/false.
567 static function giveMeAllACLs() {
568 if (CRM_Core_Permission
::check('view all contacts') ||
569 CRM_Core_Permission
::check('edit all contacts')
574 $session = CRM_Core_Session
::singleton();
575 $contactID = $session->get('userID');
578 $aclPermission = self
::getPermission();
579 if (in_array($aclPermission, array(
580 CRM_Core_Permission
::EDIT
,
581 CRM_Core_Permission
::VIEW
,
587 // run acl where hook and see if the user is supplying an ACL clause
589 $tables = $whereTables = array();
592 CRM_Utils_Hook
::aclWhereClause(CRM_Core_Permission
::VIEW
,
593 $tables, $whereTables,
596 return empty($whereTables) ?
FALSE : TRUE;
600 * Function to get component name from given permission.
602 * @param string $permission
604 * return string $componentName the name of component.
607 static function getComponentName($permission) {
608 $componentName = NULL;
609 $permission = trim($permission);
610 if (empty($permission)) {
611 return $componentName;
614 static $allCompPermissions = array();
615 if (empty($allCompPermissions)) {
616 $components = CRM_Core_Component
::getComponents();
617 foreach ($components as $name => $comp) {
618 //get all permissions of each components unconditionally
619 $allCompPermissions[$name] = $comp->getPermissions(TRUE);
623 if (is_array($allCompPermissions)) {
624 foreach ($allCompPermissions as $name => $permissions) {
625 if (in_array($permission, $permissions)) {
626 $componentName = $name;
632 return $componentName;
636 * Get all the contact emails for users that have a specific permission
638 * @param string $permissionName name of the permission we are interested in
640 * @return string a comma separated list of email addresses
642 public static function permissionEmails($permissionName) {
643 $config = CRM_Core_Config
::singleton();
644 return $config->userPermissionClass
->permissionEmails($permissionName);
648 * Get all the contact emails for users that have a specific role
650 * @param string $roleName name of the role we are interested in
652 * @return string a comma separated list of email addresses
654 public static function roleEmails($roleName) {
655 $config = CRM_Core_Config
::singleton();
656 return $config->userRoleClass
->roleEmails($roleName);
659 static function isMultisiteEnabled() {
660 return CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MULTISITE_PREFERENCES_NAME
,