Commit | Line | Data |
---|---|---|
d0c9daa4 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
d0c9daa4 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
d0c9daa4 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
d0c9daa4 TO |
27 | |
28 | namespace Civi\API\Subscriber; | |
46bcf597 | 29 | |
d0c9daa4 TO |
30 | use Civi\API\Events; |
31 | use Symfony\Component\EventDispatcher\EventSubscriberInterface; | |
32 | ||
33 | /** | |
8882ff5c TO |
34 | * For any API requests that correspond to a Doctrine entity |
35 | * ($apiRequest['doctrineClass']), check permissions specified in | |
36 | * Civi\API\Annotation\Permission. | |
d0c9daa4 TO |
37 | */ |
38 | class PermissionCheck implements EventSubscriberInterface { | |
6550386a EM |
39 | /** |
40 | * @return array | |
41 | */ | |
d0c9daa4 TO |
42 | public static function getSubscribedEvents() { |
43 | return array( | |
44 | Events::AUTHORIZE => array( | |
45 | array('onApiAuthorize', Events::W_LATE), | |
46 | ), | |
47 | ); | |
48 | } | |
49 | ||
6550386a EM |
50 | /** |
51 | * @param \Civi\API\Event\AuthorizeEvent $event | |
8882ff5c | 52 | * API authorization event. |
6550386a EM |
53 | * |
54 | * @throws \Civi\API\Exception\UnauthorizedException | |
55 | */ | |
d0c9daa4 TO |
56 | public function onApiAuthorize(\Civi\API\Event\AuthorizeEvent $event) { |
57 | $apiRequest = $event->getApiRequest(); | |
58 | if ($apiRequest['version'] < 4) { | |
59 | // return early unless we’re told explicitly to do the permission check | |
60 | if (empty($apiRequest['params']['check_permissions']) or $apiRequest['params']['check_permissions'] == FALSE) { | |
61 | $event->authorize(); | |
62 | $event->stopPropagation(); | |
63 | return; | |
64 | } | |
65 | ||
66 | require_once 'CRM/Core/DAO/permissions.php'; | |
67 | $permissions = _civicrm_api3_permissions($apiRequest['entity'], $apiRequest['action'], $apiRequest['params']); | |
68 | ||
69 | // $params might’ve been reset by the alterAPIPermissions() hook | |
70 | if (isset($apiRequest['params']['check_permissions']) and $apiRequest['params']['check_permissions'] == FALSE) { | |
71 | $event->authorize(); | |
72 | $event->stopPropagation(); | |
73 | return; | |
74 | } | |
75 | ||
76 | if (!\CRM_Core_Permission::check($permissions)) { | |
77 | if (is_array($permissions)) { | |
78 | $permissions = implode(' and ', $permissions); | |
79 | } | |
8882ff5c TO |
80 | // FIXME: Generating the exception ourselves allows for detailed error |
81 | // but doesn't play well with multiple authz subscribers. | |
fedf821c | 82 | throw new \Civi\API\Exception\UnauthorizedException("API permission check failed for {$apiRequest['entity']}/{$apiRequest['action']} call; insufficient permission: require $permissions"); |
d0c9daa4 TO |
83 | } |
84 | ||
85 | $event->authorize(); | |
86 | $event->stopPropagation(); | |
87 | } | |
88 | } | |
96025800 | 89 | |
6550386a | 90 | } |