/libraries/joomla/form/fields/rules.php
PHP | 318 lines | 203 code | 46 blank | 69 comment | 20 complexity | 9a0cc0f44c052ca958131ba0c7f4bd30 MD5 | raw file
Possible License(s): LGPL-2.1
- <?php
- /**
- * @package Joomla.Platform
- * @subpackage Form
- *
- * @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
- * @license GNU General Public License version 2 or later; see LICENSE
- */
- defined('JPATH_PLATFORM') or die;
- /**
- * Form Field class for the Joomla Platform.
- * Field for assigning permissions to groups for a given asset
- *
- * @package Joomla.Platform
- * @subpackage Form
- * @see JAccess
- * @since 11.1
- */
- class JFormFieldRules extends JFormField
- {
- /**
- * The form field type.
- *
- * @var string
- * @since 11.1
- */
- public $type = 'Rules';
- /**
- * Method to get the field input markup for Access Control Lists.
- * Optionally can be associated with a specific component and section.
- *
- * TODO: Add access check.
- *
- * @return string The field input markup.
- *
- * @since 11.1
- */
- protected function getInput()
- {
- JHtml::_('behavior.tooltip');
- // Initialise some field attributes.
- $section = $this->element['section'] ? (string) $this->element['section'] : '';
- $component = $this->element['component'] ? (string) $this->element['component'] : '';
- $assetField = $this->element['asset_field'] ? (string) $this->element['asset_field'] : 'asset_id';
- // Get the actions for the asset.
- $actions = JAccess::getActions($component, $section);
- // Iterate over the children and add to the actions.
- foreach ($this->element->children() as $el)
- {
- if ($el->getName() == 'action')
- {
- $actions[] = (object) array('name' => (string) $el['name'], 'title' => (string) $el['title'],
- 'description' => (string) $el['description']);
- }
- }
- // Get the explicit rules for this asset.
- if ($section == 'component')
- {
- // Need to find the asset id by the name of the component.
- $db = JFactory::getDbo();
- $query = $db->getQuery(true);
- $query->select($db->quoteName('id'));
- $query->from($db->quoteName('#__assets'));
- $query->where($db->quoteName('name') . ' = ' . $db->quote($component));
- $db->setQuery($query);
- $assetId = (int) $db->loadResult();
- if ($error = $db->getErrorMsg())
- {
- JError::raiseNotice(500, $error);
- }
- }
- else
- {
- // Find the asset id of the content.
- // Note that for global configuration, com_config injects asset_id = 1 into the form.
- $assetId = $this->form->getValue($assetField);
- }
- // Use the compact form for the content rules (deprecated).
- //if (!empty($component) && $section != 'component') {
- // return JHtml::_('rules.assetFormWidget', $actions, $assetId, $assetId ? null : $component, $this->name, $this->id);
- //}
- // Full width format.
- // Get the rules for just this asset (non-recursive).
- $assetRules = JAccess::getAssetRules($assetId);
- // Get the available user groups.
- $groups = $this->getUserGroups();
- // Build the form control.
- $curLevel = 0;
- // Prepare output
- $html = array();
- $html[] = '<div id="permissions-sliders" class="pane-sliders">';
- $html[] = '<p class="rule-desc">' . JText::_('JLIB_RULES_SETTINGS_DESC') . '</p>';
- $html[] = '<ul id="rules">';
- // Start a row for each user group.
- foreach ($groups as $group)
- {
- $difLevel = $group->level - $curLevel;
- if ($difLevel > 0)
- {
- $html[] = '<li><ul>';
- }
- elseif ($difLevel < 0)
- {
- $html[] = str_repeat('</ul></li>', -$difLevel);
- }
- $html[] = '<li>';
- $html[] = '<div class="panel">';
- $html[] = '<h3 class="pane-toggler title"><a href="javascript:void(0);"><span>';
- $html[] = str_repeat('<span class="level">|–</span> ', $curLevel = $group->level) . $group->text;
- $html[] = '</span></a></h3>';
- $html[] = '<div class="pane-slider content pane-hide">';
- $html[] = '<div class="mypanel">';
- $html[] = '<table class="group-rules">';
- $html[] = '<thead>';
- $html[] = '<tr>';
- $html[] = '<th class="actions" id="actions-th' . $group->value . '">';
- $html[] = '<span class="acl-action">' . JText::_('JLIB_RULES_ACTION') . '</span>';
- $html[] = '</th>';
- $html[] = '<th class="settings" id="settings-th' . $group->value . '">';
- $html[] = '<span class="acl-action">' . JText::_('JLIB_RULES_SELECT_SETTING') . '</span>';
- $html[] = '</th>';
- // The calculated setting is not shown for the root group of global configuration.
- $canCalculateSettings = ($group->parent_id || !empty($component));
- if ($canCalculateSettings)
- {
- $html[] = '<th id="aclactionth' . $group->value . '">';
- $html[] = '<span class="acl-action">' . JText::_('JLIB_RULES_CALCULATED_SETTING') . '</span>';
- $html[] = '</th>';
- }
- $html[] = '</tr>';
- $html[] = '</thead>';
- $html[] = '<tbody>';
- foreach ($actions as $action)
- {
- $html[] = '<tr>';
- $html[] = '<td headers="actions-th' . $group->value . '">';
- $html[] = '<label class="hasTip" for="' . $this->id . '_' . $action->name . '_' . $group->value . '" title="'
- . htmlspecialchars(JText::_($action->title) . '::' . JText::_($action->description), ENT_COMPAT, 'UTF-8') . '">';
- $html[] = JText::_($action->title);
- $html[] = '</label>';
- $html[] = '</td>';
- $html[] = '<td headers="settings-th' . $group->value . '">';
- $html[] = '<select name="' . $this->name . '[' . $action->name . '][' . $group->value . ']" id="' . $this->id . '_' . $action->name
- . '_' . $group->value . '" title="'
- . JText::sprintf('JLIB_RULES_SELECT_ALLOW_DENY_GROUP', JText::_($action->title), trim($group->text)) . '">';
- $inheritedRule = JAccess::checkGroup($group->value, $action->name, $assetId);
- // Get the actual setting for the action for this group.
- $assetRule = $assetRules->allow($action->name, $group->value);
- // Build the dropdowns for the permissions sliders
- // The parent group has "Not Set", all children can rightly "Inherit" from that.
- $html[] = '<option value=""' . ($assetRule === null ? ' selected="selected"' : '') . '>'
- . JText::_(empty($group->parent_id) && empty($component) ? 'JLIB_RULES_NOT_SET' : 'JLIB_RULES_INHERITED') . '</option>';
- $html[] = '<option value="1"' . ($assetRule === true ? ' selected="selected"' : '') . '>' . JText::_('JLIB_RULES_ALLOWED')
- . '</option>';
- $html[] = '<option value="0"' . ($assetRule === false ? ' selected="selected"' : '') . '>' . JText::_('JLIB_RULES_DENIED')
- . '</option>';
- $html[] = '</select>  ';
- // If this asset's rule is allowed, but the inherited rule is deny, we have a conflict.
- if (($assetRule === true) && ($inheritedRule === false))
- {
- $html[] = JText::_('JLIB_RULES_CONFLICT');
- }
- $html[] = '</td>';
- // Build the Calculated Settings column.
- // The inherited settings column is not displayed for the root group in global configuration.
- if ($canCalculateSettings)
- {
- $html[] = '<td headers="aclactionth' . $group->value . '">';
- // This is where we show the current effective settings considering currrent group, path and cascade.
- // Check whether this is a component or global. Change the text slightly.
- if (JAccess::checkGroup($group->value, 'core.admin') !== true)
- {
- if ($inheritedRule === null)
- {
- $html[] = '<span class="icon-16-unset">' . JText::_('JLIB_RULES_NOT_ALLOWED') . '</span>';
- }
- elseif ($inheritedRule === true)
- {
- $html[] = '<span class="icon-16-allowed">' . JText::_('JLIB_RULES_ALLOWED') . '</span>';
- }
- elseif ($inheritedRule === false)
- {
- if ($assetRule === false)
- {
- $html[] = '<span class="icon-16-denied">' . JText::_('JLIB_RULES_NOT_ALLOWED') . '</span>';
- }
- else
- {
- $html[] = '<span class="icon-16-denied"><span class="icon-16-locked">' . JText::_('JLIB_RULES_NOT_ALLOWED_LOCKED')
- . '</span></span>';
- }
- }
- }
- elseif (!empty($component))
- {
- $html[] = '<span class="icon-16-allowed"><span class="icon-16-locked">' . JText::_('JLIB_RULES_ALLOWED_ADMIN')
- . '</span></span>';
- }
- else
- {
- // Special handling for groups that have global admin because they can't be denied.
- // The admin rights can be changed.
- if ($action->name === 'core.admin')
- {
- $html[] = '<span class="icon-16-allowed">' . JText::_('JLIB_RULES_ALLOWED') . '</span>';
- }
- elseif ($inheritedRule === false)
- {
- // Other actions cannot be changed.
- $html[] = '<span class="icon-16-denied"><span class="icon-16-locked">'
- . JText::_('JLIB_RULES_NOT_ALLOWED_ADMIN_CONFLICT') . '</span></span>';
- }
- else
- {
- $html[] = '<span class="icon-16-allowed"><span class="icon-16-locked">' . JText::_('JLIB_RULES_ALLOWED_ADMIN')
- . '</span></span>';
- }
- }
- $html[] = '</td>';
- }
- $html[] = '</tr>';
- }
- $html[] = '</tbody>';
- $html[] = '</table></div>';
- $html[] = '</div></div>';
- $html[] = '</li>';
- }
- $html[] = str_repeat('</ul></li>', $curLevel);
- $html[] = '</ul><div class="rule-notes">';
- if ($section == 'component' || $section == null)
- {
- $html[] = JText::_('JLIB_RULES_SETTING_NOTES');
- }
- else
- {
- $html[] = JText::_('JLIB_RULES_SETTING_NOTES_ITEM');
- }
- $html[] = '</div></div>';
- $js = "window.addEvent('domready', function(){ new Fx.Accordion($$('div#permissions-sliders.pane-sliders .panel h3.pane-toggler'),"
- . "$$('div#permissions-sliders.pane-sliders .panel div.pane-slider'), {onActive: function(toggler, i) {toggler.addClass('pane-toggler-down');"
- . "toggler.removeClass('pane-toggler');i.addClass('pane-down');i.removeClass('pane-hide');Cookie.write('jpanesliders_permissions-sliders"
- . $component
- . "',$$('div#permissions-sliders.pane-sliders .panel h3').indexOf(toggler));},"
- . "onBackground: function(toggler, i) {toggler.addClass('pane-toggler');toggler.removeClass('pane-toggler-down');i.addClass('pane-hide');"
- . "i.removeClass('pane-down');}, duration: 300, display: "
- . JRequest::getInt('jpanesliders_permissions-sliders' . $component, 0, 'cookie') . ", show: "
- . JRequest::getInt('jpanesliders_permissions-sliders' . $component, 0, 'cookie') . ", alwaysHide:true, opacity: false}); });";
- JFactory::getDocument()->addScriptDeclaration($js);
- return implode("\n", $html);
- }
- /**
- * Get a list of the user groups.
- *
- * @return array
- *
- * @since 11.1
- */
- protected function getUserGroups()
- {
- // Initialise variables.
- $db = JFactory::getDBO();
- $query = $db->getQuery(true);
- $query->select('a.id AS value, a.title AS text, COUNT(DISTINCT b.id) AS level, a.parent_id')
- ->from('#__usergroups AS a')
- ->leftJoin($db->quoteName('#__usergroups') . ' AS b ON a.lft > b.lft AND a.rgt < b.rgt')
- ->group('a.id, a.title, a.lft, a.rgt, a.parent_id')
- ->order('a.lft ASC');
- $db->setQuery($query);
- $options = $db->loadObjectList();
- return $options;
- }
- }