3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
39 class CRM_Core_Permission_Joomla
extends CRM_Core_Permission_Base
{
41 * Given a permission string, check for access requirements
44 * The permission to check.
48 * true if yes, else false
50 public function check($str, $userId = NULL) {
51 $config = CRM_Core_Config
::singleton();
52 // JFactory::getUser does strict type checking, so convert falesy values to NULL
57 $translated = $this->translateJoomlaPermission($str);
58 if ($translated === CRM_Core_Permission
::ALWAYS_DENY_PERMISSION
) {
61 if ($translated === CRM_Core_Permission
::ALWAYS_ALLOW_PERMISSION
) {
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')) {
69 $user = JFactory
::getUser($userId);
70 $api_key = CRM_Utils_Request
::retrieve('api_key', 'String', $store, FALSE, NULL, 'REQUEST');
72 // If we are coming from REST we don't have a user but we do have the api_key for a user.
73 if ($user->id
=== 0 && !is_null($api_key)) {
74 // This is a codeblock copied from /Civicrm/Utils/REST
79 $contact_id = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $api_key, 'id', 'api_key');
82 $uid = CRM_Core_BAO_UFMatch
::getUFId($contact_id);
84 $user = JFactory
::getUser($uid);
89 return $user->authorise($translated[0], $translated[1]);
98 public function isModulePermissionSupported() {
105 * @internal param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:example.action:com_some_asset"
106 * @return ALWAYS_DENY_PERMISSION|ALWAYS_ALLOW_PERMISSION|array(0 => $joomlaAction, 1 => $joomlaAsset)
108 public function translateJoomlaPermission($perm) {
109 if ($perm === CRM_Core_Permission
::ALWAYS_DENY_PERMISSION ||
$perm === CRM_Core_Permission
::ALWAYS_ALLOW_PERMISSION
) {
113 list ($civiPrefix, $name) = CRM_Utils_String
::parsePrefix(':', $perm, NULL);
114 switch ($civiPrefix) {
116 return explode(':', $name);
119 // FIXME: This needn't be DENY, but we don't currently have any translations.
120 return CRM_Core_Permission
::ALWAYS_DENY_PERMISSION
;
123 return array('civicrm.' . CRM_Utils_String
::munge(strtolower($name)), 'com_civicrm');
126 return CRM_Core_Permission
::ALWAYS_DENY_PERMISSION
;
131 * Given a roles array, check for access requirements
133 * @param array $array
134 * The roles to check.
137 * true if yes, else false
139 public function checkGroupRole($array) {
146 public function upgradePermissions($permissions) {
147 $translatedPerms = array();
149 // Flipping the $permissions array gives us just the raw names of the
150 // permissions. The descriptions, etc., are irrelevant for the purposes of
152 foreach (array_flip($permissions) as $perm) {
153 $translated = $this->translateJoomlaPermission($perm);
154 $translatedPerms[] = $translated[0];
157 $associations = $this->getUserGroupPermsAssociations();
158 $cmsPermsHaveGoneStale = FALSE;
159 foreach (array_keys(get_object_vars($associations)) as $permName) {
160 if (!in_array($permName, $translatedPerms)) {
161 unset($associations->$permName);
162 $cmsPermsHaveGoneStale = TRUE;
166 if ($cmsPermsHaveGoneStale) {
167 $this->updateGroupPermsAssociations($associations);
172 * Fetches the associations between user groups and CiviCRM permissions.
174 * @see https://docs.joomla.org/Selecting_data_using_JDatabase
176 * Properties of the object are Joomla-fied permission names.
178 private function getUserGroupPermsAssociations() {
179 $db = JFactory
::getDbo();
180 $query = $db->getQuery(TRUE);
183 ->select($db->quoteName('rules'))
184 ->from($db->quoteName('#__assets'))
185 ->where($db->quoteName('name') . ' = ' . $db->quote('com_civicrm'));
187 $db->setQuery($query);
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();
195 * Writes user-group/permissions associations back to Joomla.
197 * @see https://docs.joomla.org/Inserting,_Updating_and_Removing_data_using_JDatabase
198 * @param object $associations
199 * Same format as the return of
200 * CRM_Core_Permission_Joomla->getUserGroupPermsAssociations().
202 private function updateGroupPermsAssociations($associations) {
203 $db = JFactory
::getDbo();
204 $query = $db->getQuery(TRUE);
207 ->update($db->quoteName('#__assets'))
208 ->set($db->quoteName('rules') . ' = ' . $db->quote(json_encode($associations)))
209 ->where($db->quoteName('name') . ' = ' . $db->quote('com_civicrm'));
211 $db->setQuery($query)->execute();