3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
21 class CRM_Core_Permission_Joomla
extends CRM_Core_Permission_Base
{
24 * Given a permission string, check for access requirements
27 * The permission to check.
31 * true if yes, else false
33 public function check($str, $userId = NULL) {
34 $config = CRM_Core_Config
::singleton();
35 // JFactory::getUser does strict type checking, so convert falesy values to NULL
40 $translated = $this->translateJoomlaPermission($str);
41 if ($translated === CRM_Core_Permission
::ALWAYS_DENY_PERMISSION
) {
44 if ($translated === CRM_Core_Permission
::ALWAYS_ALLOW_PERMISSION
) {
48 // ensure that we are running in a joomla context
49 // we've not yet figured out how to bootstrap joomla, so we should
50 // not execute hooks if joomla is not loaded
51 if (defined('_JEXEC')) {
52 $user = JFactory
::getUser($userId);
53 $api_key = CRM_Utils_Request
::retrieve('api_key', 'String', $store, FALSE, NULL, 'REQUEST');
55 // If we are coming from REST we don't have a user but we do have the api_key for a user.
56 if ($user->id
=== 0 && !is_null($api_key)) {
57 // This is a codeblock copied from /Civicrm/Utils/REST
62 $contact_id = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $api_key, 'id', 'api_key');
65 $uid = CRM_Core_BAO_UFMatch
::getUFId($contact_id);
67 $user = JFactory
::getUser($uid);
72 return $user->authorise($translated[0], $translated[1]);
81 public function isModulePermissionSupported() {
88 * @internal param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:example.action:com_some_asset"
89 * @return ALWAYS_DENY_PERMISSION|ALWAYS_ALLOW_PERMISSION|array(0 => $joomlaAction, 1 => $joomlaAsset)
91 public function translateJoomlaPermission($perm) {
92 if ($perm === CRM_Core_Permission
::ALWAYS_DENY_PERMISSION ||
$perm === CRM_Core_Permission
::ALWAYS_ALLOW_PERMISSION
) {
96 list ($civiPrefix, $name) = CRM_Utils_String
::parsePrefix(':', $perm, NULL);
97 switch ($civiPrefix) {
99 return explode(':', $name);
102 // FIXME: This needn't be DENY, but we don't currently have any translations.
103 return CRM_Core_Permission
::ALWAYS_DENY_PERMISSION
;
106 return ['civicrm.' . CRM_Utils_String
::munge(strtolower($name)), 'com_civicrm'];
109 return CRM_Core_Permission
::ALWAYS_DENY_PERMISSION
;
114 * Given a roles array, check for access requirements
116 * @param array $array
117 * The roles to check.
120 * true if yes, else false
122 public function checkGroupRole($array) {
129 public function upgradePermissions($permissions) {
130 $translatedPerms = [];
132 // Flipping the $permissions array gives us just the raw names of the
133 // permissions. The descriptions, etc., are irrelevant for the purposes of
135 foreach (array_flip($permissions) as $perm) {
136 $translated = $this->translateJoomlaPermission($perm);
137 $translatedPerms[] = $translated[0];
140 $associations = $this->getUserGroupPermsAssociations();
141 $cmsPermsHaveGoneStale = FALSE;
142 foreach (array_keys(get_object_vars($associations)) as $permName) {
143 if (!in_array($permName, $translatedPerms)) {
144 unset($associations->$permName);
145 $cmsPermsHaveGoneStale = TRUE;
149 if ($cmsPermsHaveGoneStale) {
150 $this->updateGroupPermsAssociations($associations);
155 * Fetches the associations between user groups and CiviCRM permissions.
157 * @see https://docs.joomla.org/Selecting_data_using_JDatabase
159 * Properties of the object are Joomla-fied permission names.
161 private function getUserGroupPermsAssociations() {
162 $db = JFactory
::getDbo();
163 $query = $db->getQuery(TRUE);
166 ->select($db->quoteName('rules'))
167 ->from($db->quoteName('#__assets'))
168 ->where($db->quoteName('name') . ' = ' . $db->quote('com_civicrm'));
170 $db->setQuery($query);
172 // Joomla gotcha: loadObject returns NULL in the case of no matches.
173 $result = $db->loadObject();
174 return $result ?
json_decode($result->rules
) : (object) [];
178 * Writes user-group/permissions associations back to Joomla.
180 * @see https://docs.joomla.org/Inserting,_Updating_and_Removing_data_using_JDatabase
181 * @param object $associations
182 * Same format as the return of
183 * CRM_Core_Permission_Joomla->getUserGroupPermsAssociations().
185 private function updateGroupPermsAssociations($associations) {
186 $db = JFactory
::getDbo();
187 $query = $db->getQuery(TRUE);
190 ->update($db->quoteName('#__assets'))
191 ->set($db->quoteName('rules') . ' = ' . $db->quote(json_encode($associations)))
192 ->where($db->quoteName('name') . ' = ' . $db->quote('com_civicrm'));
194 $db->setQuery($query)->execute();