3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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 +--------------------------------------------------------------------+
29 * Decide what permissions to check for an api call
31 * @param $entity : (str) api entity
32 * @param $action : (str) api action
33 * @param $params : (array) api params
36 * Array of permissions to check for this entity-action combo
38 function _civicrm_api3_permissions($entity, $action, &$params) {
39 // FIXME: Lowercase entity_names are nonstandard but difficult to fix here
40 // because this function invokes hook_civicrm_alterAPIPermissions
41 $entity = _civicrm_api_get_entity_name_from_camel($entity);
44 * @var array of permissions
46 * For each entity, we declare an array of permissions required for each action
47 * The action is the array key, possible values:
48 * * create: applies to create (with no id in params)
49 * * update: applies to update, setvalue, create (with id in params)
50 * * get: applies to getcount, getsingle, getvalue and other gets
51 * * delete: applies to delete, replace
52 * * meta: applies to getfields, getoptions, getspec
53 * * default: catch-all for anything not declared
55 * Note: some APIs declare other actions as well
57 * Permissions should use arrays for AND and arrays of arrays for OR
58 * @see CRM_Core_Permission::check for more documentation
60 $permissions = array();
62 // These are the default permissions - if any entity does not declare permissions for a given action,
63 // (or the entity does not declare permissions at all) - then the action will be used from here
64 $permissions['default'] = array(
65 // applies to getfields, getoptions, etc.
66 'meta' => array('access CiviCRM'),
67 // catch-all, applies to create, get, delete, etc.
68 // If an entity declares it's own 'default' action it will override this one
69 'default' => array('administer CiviCRM'),
72 // Note: Additional permissions in DynamicFKAuthorization
73 $permissions['attachment'] = array(
75 array('access CiviCRM', 'access AJAX API'),
79 // Contact permissions
80 $permissions['contact'] = array(
89 // managed by query object
91 // managed by _civicrm_api3_check_edit_permissions
94 array('access CiviCRM', 'access AJAX API'),
98 // CRM-16963 - Permissions for country.
99 $permissions['country'] = array(
104 'administer CiviCRM',
108 // Contact-related data permissions.
109 $permissions['address'] = array(
110 // get is managed by BAO::addSelectWhereClause
111 // create/delete are managed by _civicrm_api3_check_edit_permissions
112 'default' => array(),
114 $permissions['email'] = $permissions['address'];
115 $permissions['phone'] = $permissions['address'];
116 $permissions['website'] = $permissions['address'];
117 $permissions['im'] = $permissions['address'];
119 // @todo - implement CRM_Core_BAO_EntityTag::addSelectWhereClause and remove this heavy-handed restriction
120 $permissions['entity_tag'] = array(
121 'get' => array('access CiviCRM', 'view all contacts'),
122 'default' => array('access CiviCRM', 'edit all contacts'),
125 $permissions['note'] = $permissions['entity_tag'];
127 // CRM-17350 - entity_tag ACL permissions are checked at the BAO level
128 $permissions['entity_tag'] = array(
138 // Allow non-admins to get and create tags to support tagset widget
139 // Delete is still reserved for admins
140 $permissions['tag'] = array(
141 'get' => array('access CiviCRM'),
142 'create' => array('access CiviCRM'),
143 'update' => array('access CiviCRM'),
146 //relationship permissions
147 $permissions['relationship'] = array(
148 // get is managed by BAO::addSelectWhereClause
160 // CRM-17741 - Permissions for RelationshipType.
161 $permissions['relationship_type'] = array(
166 'administer CiviCRM',
170 // Activity permissions
171 $permissions['activity'] = array(
178 // Note that view all activities is also required within the api
179 // if the id is not passed in. Where the id is passed in the activity
180 // specific check functions are used and tested.
184 'view all activities',
189 $permissions['case'] = array(
196 'delete in CiviCase',
199 // At minimum the user needs one of the following. Finer-grained access is controlled by CRM_Case_BAO_Case::addSelectWhereClause
200 array('access my cases and activities', 'access all cases and activities'),
203 $permissions['case_contact'] = $permissions['case'];
205 $permissions['case_type'] = array(
206 'default' => array('administer CiviCase'),
209 array('access my cases and activities', 'access all cases and activities'),
213 // Campaign permissions
214 $permissions['campaign'] = array(
215 'get' => array('access CiviCRM'),
218 array('administer CiviCampaign', 'manage campaign')
221 $permissions['survey'] = $permissions['campaign'];
223 // Financial permissions
224 $permissions['contribution'] = array(
227 'access CiviContribute',
231 'access CiviContribute',
232 'delete in CiviContribute',
234 'completetransaction' => array(
235 'edit contributions',
239 'access CiviContribute',
240 'edit contributions',
243 $permissions['line_item'] = $permissions['contribution'];
245 // Payment permissions
246 $permissions['payment'] = array(
249 'access CiviContribute',
253 'access CiviContribute',
254 'delete in CiviContribute',
258 'access CiviContribute',
259 'edit contributions',
263 'access CiviContribute',
264 'edit contributions',
268 'access CiviContribute',
269 'edit contributions',
273 // Custom field permissions
274 $permissions['custom_field'] = array(
276 'administer CiviCRM',
277 'access all custom data',
280 $permissions['custom_group'] = $permissions['custom_field'];
283 $permissions['event'] = array(
292 'delete in CiviEvent',
305 // Loc block is only used for events
306 $permissions['loc_block'] = $permissions['event'];
309 $permissions['file'] = array(
312 'access uploaded files',
315 $permissions['files_by_entity'] = $permissions['file'];
318 $permissions['group'] = array(
328 $permissions['group_nesting'] = $permissions['group'];
329 $permissions['group_organization'] = $permissions['group'];
331 //Group Contact permission
332 $permissions['group_contact'] = array(
342 // CiviMail Permissions
343 $civiMailBasePerms = array(
344 // To get/preview/update, one must have least one of these perms:
345 // Mailing API implementations enforce nuances of create/approve/schedule permissions.
351 $permissions['mailing'] = array(
359 'delete in CiviMail',
363 array('access CiviMail', 'schedule mailings'),
370 $permissions['mailing_group'] = $permissions['mailing'];
371 $permissions['mailing_job'] = $permissions['mailing'];
372 $permissions['mailing_recipients'] = $permissions['mailing'];
374 $permissions['mailing_a_b'] = array(
382 'delete in CiviMail',
386 array('access CiviMail', 'schedule mailings'),
394 // Membership permissions
395 $permissions['membership'] = array(
403 'delete in CiviMember',
411 $permissions['membership_status'] = $permissions['membership'];
412 $permissions['membership_type'] = $permissions['membership'];
413 $permissions['membership_payment'] = array(
418 'access CiviContribute',
419 'edit contributions',
424 'delete in CiviMember',
425 'access CiviContribute',
426 'delete in CiviContribute',
431 'access CiviContribute',
437 'access CiviContribute',
438 'edit contributions',
442 // Participant permissions
443 $permissions['participant'] = array(
447 'register for events',
452 'edit event participants',
457 'view event participants',
462 'edit event participants',
465 $permissions['participant_payment'] = array(
469 'register for events',
470 'access CiviContribute',
471 'edit contributions',
476 'edit event participants',
477 'access CiviContribute',
478 'delete in CiviContribute',
483 'view event participants',
484 'access CiviContribute',
489 'edit event participants',
490 'access CiviContribute',
491 'edit contributions',
495 // Pledge permissions
496 $permissions['pledge'] = array(
505 'delete in CiviPledge',
518 //CRM-16777: Disable schedule reminder for user that have 'edit all events' and 'administer CiviCRM' permission.
519 $permissions['action_schedule'] = array(
528 $permissions['pledge_payment'] = array(
533 'access CiviContribute',
534 'edit contributions',
539 'delete in CiviPledge',
540 'access CiviContribute',
541 'delete in CiviContribute',
546 'access CiviContribute',
552 'access CiviContribute',
553 'edit contributions',
557 // Profile permissions
558 $permissions['profile'] = array(
559 'get' => array(), // the profile will take care of this
562 $permissions['uf_group'] = array(
566 'administer CiviCRM',
567 'manage event profiles',
576 'administer CiviCRM',
577 'manage event profiles',
581 $permissions['uf_field'] = $permissions['uf_join'] = $permissions['uf_group'];
582 $permissions['uf_field']['delete'] = array(
585 'administer CiviCRM',
586 'manage event profiles',
589 $permissions['option_value'] = $permissions['uf_group'];
590 $permissions['option_group'] = $permissions['option_value'];
592 $permissions['message_template'] = array(
593 'get' => array('access CiviCRM'),
594 'create' => array('edit message templates'),
595 'update' => array('edit message templates'),
598 // Translate 'create' action to 'update' if id is set
599 if ($action == 'create' && (!empty($params['id']) ||
!empty($params[$entity . '_id']))) {
603 // let third parties modify the permissions
604 CRM_Utils_Hook
::alterAPIPermissions($entity, $action, $params, $permissions);
606 // Merge permissions for this entity with the defaults
607 $perm = CRM_Utils_Array
::value($entity, $permissions, array()) +
$permissions['default'];
609 // Return exact match if permission for this action has been declared
610 if (isset($perm[$action])) {
611 return $perm[$action];
614 // Translate specific actions into their generic equivalents
615 $snippet = substr($action, 0, 3);
616 if ($action == 'replace' ||
$snippet == 'del') {
617 // 'Replace' is a combination of get+create+update+delete; however, the permissions
618 // on each of those will be tested separately at runtime. This is just a sniff-test
619 // based on the heuristic that 'delete' tends to be the most closely guarded
620 // of the necessary permissions.
623 elseif ($action == 'setvalue' ||
$snippet == 'upd') {
626 elseif ($action == 'getfields' ||
$action == 'getfield' ||
$action == 'getspec' ||
$action == 'getoptions') {
629 elseif ($snippet == 'get') {
632 return isset($perm[$action]) ?
$perm[$action] : $perm['default'];
635 # FIXME: not sure how to permission the following API 3 calls:
636 # contribution_transact (make online contributions)
638 # group_contact_pending
639 # group_contact_update_status
640 # mailing_event_bounce
641 # mailing_event_click
642 # mailing_event_confirm
643 # mailing_event_forward
645 # mailing_event_reply
646 # mailing_group_event_domain_unsubscribe
647 # mailing_group_event_resubscribe
648 # mailing_group_event_subscribe
649 # mailing_group_event_unsubscribe
650 # membership_status_calc
651 # survey_respondant_count