Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
6a488035 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 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
8c9251b3 | 31 | * @copyright CiviCRM LLC (c) 2004-2018 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * | |
38 | */ | |
39 | class CRM_Core_Permission_Joomla extends CRM_Core_Permission_Base { | |
40 | /** | |
100fef9d | 41 | * Given a permission string, check for access requirements |
6a488035 | 42 | * |
6a0b768e TO |
43 | * @param string $str |
44 | * The permission to check. | |
18be3201 | 45 | * @param int $userId |
6a488035 | 46 | * |
c301f76e | 47 | * @return bool |
a6c01b45 | 48 | * true if yes, else false |
6a488035 | 49 | */ |
18be3201 | 50 | public function check($str, $userId = NULL) { |
6a488035 | 51 | $config = CRM_Core_Config::singleton(); |
18be3201 CW |
52 | // JFactory::getUser does strict type checking, so convert falesy values to NULL |
53 | if (!$userId) { | |
54 | $userId = NULL; | |
55 | } | |
6a488035 | 56 | |
cc222cb6 TO |
57 | $translated = $this->translateJoomlaPermission($str); |
58 | if ($translated === CRM_Core_Permission::ALWAYS_DENY_PERMISSION) { | |
59 | return FALSE; | |
60 | } | |
61 | if ($translated === CRM_Core_Permission::ALWAYS_ALLOW_PERMISSION) { | |
62 | return TRUE; | |
63 | } | |
64 | ||
6a488035 TO |
65 | // ensure that we are running in a joomla context |
66 | // we've not yet figured out how to bootstrap joomla, so we should | |
67 | // not execute hooks if joomla is not loaded | |
68 | if (defined('_JEXEC')) { | |
18be3201 | 69 | $user = JFactory::getUser($userId); |
906e5a45 | 70 | $api_key = CRM_Utils_Request::retrieve('api_key', 'String', $store, FALSE, NULL, 'REQUEST'); |
d37cd2a2 | 71 | |
a386d65b | 72 | // If we are coming from REST we don't have a user but we do have the api_key for a user. |
906e5a45 | 73 | if ($user->id === 0 && !is_null($api_key)) { |
a386d65b EW |
74 | // This is a codeblock copied from /Civicrm/Utils/REST |
75 | $uid = NULL; | |
76 | if (!$uid) { | |
77 | $store = NULL; | |
d37cd2a2 | 78 | |
a386d65b | 79 | $contact_id = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $api_key, 'id', 'api_key'); |
d37cd2a2 | 80 | |
a386d65b EW |
81 | if ($contact_id) { |
82 | $uid = CRM_Core_BAO_UFMatch::getUFId($contact_id); | |
83 | } | |
84 | $user = JFactory::getUser($uid); | |
d37cd2a2 EW |
85 | |
86 | } | |
87 | } | |
88 | ||
c50bc0a1 | 89 | return $user->authorise($translated[0], $translated[1]); |
d37cd2a2 | 90 | |
6a488035 TO |
91 | } |
92 | else { | |
d37cd2a2 | 93 | |
a386d65b | 94 | return FALSE; |
6a488035 TO |
95 | } |
96 | } | |
97 | ||
e5db5646 FG |
98 | public function isModulePermissionSupported() { |
99 | return TRUE; | |
100 | } | |
101 | ||
cc222cb6 | 102 | /** |
77b97be7 EM |
103 | * @param $perm |
104 | * | |
105 | * @internal param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:example.action:com_some_asset" | |
cc222cb6 TO |
106 | * @return ALWAYS_DENY_PERMISSION|ALWAYS_ALLOW_PERMISSION|array(0 => $joomlaAction, 1 => $joomlaAsset) |
107 | */ | |
00be9182 | 108 | public function translateJoomlaPermission($perm) { |
cc222cb6 TO |
109 | if ($perm === CRM_Core_Permission::ALWAYS_DENY_PERMISSION || $perm === CRM_Core_Permission::ALWAYS_ALLOW_PERMISSION) { |
110 | return $perm; | |
111 | } | |
112 | ||
113 | list ($civiPrefix, $name) = CRM_Utils_String::parsePrefix(':', $perm, NULL); | |
22e263ad | 114 | switch ($civiPrefix) { |
cc222cb6 TO |
115 | case 'Joomla': |
116 | return explode(':', $name); | |
2aa397bc | 117 | |
cc222cb6 TO |
118 | case 'cms': |
119 | // FIXME: This needn't be DENY, but we don't currently have any translations. | |
120 | return CRM_Core_Permission::ALWAYS_DENY_PERMISSION; | |
2aa397bc | 121 | |
cc222cb6 TO |
122 | case NULL: |
123 | return array('civicrm.' . CRM_Utils_String::munge(strtolower($name)), 'com_civicrm'); | |
2aa397bc | 124 | |
cc222cb6 TO |
125 | default: |
126 | return CRM_Core_Permission::ALWAYS_DENY_PERMISSION; | |
127 | } | |
128 | } | |
129 | ||
6a488035 TO |
130 | /** |
131 | * Given a roles array, check for access requirements | |
132 | * | |
6a0b768e TO |
133 | * @param array $array |
134 | * The roles to check. | |
6a488035 | 135 | * |
c301f76e | 136 | * @return bool |
a6c01b45 | 137 | * true if yes, else false |
6a488035 | 138 | */ |
00be9182 | 139 | public function checkGroupRole($array) { |
6a488035 TO |
140 | return FALSE; |
141 | } | |
96025800 | 142 | |
e5db5646 FG |
143 | /** |
144 | * @inheritDoc | |
145 | */ | |
146 | public function upgradePermissions($permissions) { | |
147 | $translatedPerms = array(); | |
b415fb17 FG |
148 | |
149 | // Flipping the $permissions array gives us just the raw names of the | |
150 | // permissions. The descriptions, etc., are irrelevant for the purposes of | |
151 | // this method. | |
e5db5646 FG |
152 | foreach (array_flip($permissions) as $perm) { |
153 | $translated = $this->translateJoomlaPermission($perm); | |
154 | $translatedPerms[] = $translated[0]; | |
155 | } | |
156 | ||
157 | $associations = $this->getUserGroupPermsAssociations(); | |
b415fb17 | 158 | $cmsPermsHaveGoneStale = FALSE; |
e5db5646 FG |
159 | foreach (array_keys(get_object_vars($associations)) as $permName) { |
160 | if (!in_array($permName, $translatedPerms)) { | |
161 | unset($associations->$permName); | |
b415fb17 | 162 | $cmsPermsHaveGoneStale = TRUE; |
e5db5646 FG |
163 | } |
164 | } | |
165 | ||
b415fb17 | 166 | if ($cmsPermsHaveGoneStale) { |
e5db5646 FG |
167 | $this->updateGroupPermsAssociations($associations); |
168 | } | |
169 | } | |
170 | ||
171 | /** | |
172 | * Fetches the associations between user groups and CiviCRM permissions. | |
173 | * | |
b415fb17 | 174 | * @see https://docs.joomla.org/Selecting_data_using_JDatabase |
f746881c | 175 | * @return object |
e5db5646 FG |
176 | * Properties of the object are Joomla-fied permission names. |
177 | */ | |
178 | private function getUserGroupPermsAssociations() { | |
e5db5646 | 179 | $db = JFactory::getDbo(); |
f746881c | 180 | $query = $db->getQuery(TRUE); |
e5db5646 | 181 | |
e5db5646 FG |
182 | $query |
183 | ->select($db->quoteName('rules')) | |
184 | ->from($db->quoteName('#__assets')) | |
185 | ->where($db->quoteName('name') . ' = ' . $db->quote('com_civicrm')); | |
186 | ||
e5db5646 FG |
187 | $db->setQuery($query); |
188 | ||
76d556c7 FG |
189 | // Joomla gotcha: loadObject returns NULL in the case of no matches. |
190 | $result = $db->loadObject(); | |
191 | return $result ? json_decode($result->rules) : (object) array(); | |
e5db5646 FG |
192 | } |
193 | ||
194 | /** | |
195 | * Writes user-group/permissions associations back to Joomla. | |
196 | * | |
b415fb17 | 197 | * @see https://docs.joomla.org/Inserting,_Updating_and_Removing_data_using_JDatabase |
f746881c FG |
198 | * @param object $associations |
199 | * Same format as the return of | |
200 | * CRM_Core_Permission_Joomla->getUserGroupPermsAssociations(). | |
e5db5646 | 201 | */ |
a1f60f01 | 202 | private function updateGroupPermsAssociations($associations) { |
e5db5646 | 203 | $db = JFactory::getDbo(); |
f746881c | 204 | $query = $db->getQuery(TRUE); |
e5db5646 | 205 | |
e5db5646 FG |
206 | $query |
207 | ->update($db->quoteName('#__assets')) | |
208 | ->set($db->quoteName('rules') . ' = ' . $db->quote(json_encode($associations))) | |
209 | ->where($db->quoteName('name') . ' = ' . $db->quote('com_civicrm')); | |
210 | ||
211 | $db->setQuery($query)->execute(); | |
212 | } | |
213 | ||
6a488035 | 214 | } |