primo commit
This commit is contained in:
531
administrator/modules/mod_menu/src/Menu/CssMenu.php
Normal file
531
administrator/modules/mod_menu/src/Menu/CssMenu.php
Normal file
@ -0,0 +1,531 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @package Joomla.Administrator
|
||||
* @subpackage mod_menu
|
||||
*
|
||||
* @copyright (C) 2006 Open Source Matters, Inc. <https://www.joomla.org>
|
||||
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
||||
*/
|
||||
|
||||
namespace Joomla\Module\Menu\Administrator\Menu;
|
||||
|
||||
use Joomla\CMS\Application\CMSApplication;
|
||||
use Joomla\CMS\Component\ComponentHelper;
|
||||
use Joomla\CMS\Event\Menu\PreprocessMenuItemsEvent;
|
||||
use Joomla\CMS\Language\Associations;
|
||||
use Joomla\CMS\Language\Text;
|
||||
use Joomla\CMS\Menu\AdministratorMenuItem;
|
||||
use Joomla\CMS\Table\Table;
|
||||
use Joomla\CMS\Uri\Uri;
|
||||
use Joomla\Component\Menus\Administrator\Helper\MenusHelper;
|
||||
use Joomla\Registry\Registry;
|
||||
use Joomla\Utilities\ArrayHelper;
|
||||
|
||||
// phpcs:disable PSR1.Files.SideEffects
|
||||
\defined('_JEXEC') or die;
|
||||
// phpcs:enable PSR1.Files.SideEffects
|
||||
|
||||
/**
|
||||
* Tree based class to render the admin menu
|
||||
*
|
||||
* @since 1.5
|
||||
*/
|
||||
class CssMenu
|
||||
{
|
||||
/**
|
||||
* The root of the menu
|
||||
*
|
||||
* @var AdministratorMenuItem
|
||||
*
|
||||
* @since 4.0.0
|
||||
*/
|
||||
protected $root;
|
||||
|
||||
/**
|
||||
* An array of AdministratorMenuItem nodes
|
||||
*
|
||||
* @var AdministratorMenuItem[]
|
||||
*
|
||||
* @since 4.0.0
|
||||
*/
|
||||
protected $nodes = [];
|
||||
|
||||
/**
|
||||
* The module options
|
||||
*
|
||||
* @var Registry
|
||||
*
|
||||
* @since 3.8.0
|
||||
*/
|
||||
protected $params;
|
||||
|
||||
/**
|
||||
* The menu bar state
|
||||
*
|
||||
* @var boolean
|
||||
*
|
||||
* @since 3.8.0
|
||||
*/
|
||||
protected $enabled;
|
||||
|
||||
/**
|
||||
* The application
|
||||
*
|
||||
* @var CMSApplication
|
||||
*
|
||||
* @since 4.0.0
|
||||
*/
|
||||
protected $application;
|
||||
|
||||
/**
|
||||
* A counter for unique IDs
|
||||
*
|
||||
* @var integer
|
||||
*
|
||||
* @since 4.0.0
|
||||
*/
|
||||
protected $counter = 0;
|
||||
|
||||
/**
|
||||
* CssMenu constructor.
|
||||
*
|
||||
* @param CMSApplication $application The application
|
||||
*
|
||||
* @since 4.0.0
|
||||
*/
|
||||
public function __construct(CMSApplication $application)
|
||||
{
|
||||
$this->application = $application;
|
||||
$this->root = new AdministratorMenuItem();
|
||||
}
|
||||
|
||||
/**
|
||||
* Populate the menu items in the menu tree object
|
||||
*
|
||||
* @param Registry $params Menu configuration parameters
|
||||
* @param bool $enabled Whether the menu should be enabled or disabled
|
||||
*
|
||||
* @return AdministratorMenuItem Root node of the menu tree
|
||||
*
|
||||
* @since 3.7.0
|
||||
*/
|
||||
public function load($params, $enabled)
|
||||
{
|
||||
$this->params = $params;
|
||||
$this->enabled = $enabled;
|
||||
$menutype = $this->params->get('menutype', '*');
|
||||
|
||||
if ($menutype === '*') {
|
||||
$name = $this->params->get('preset', 'default');
|
||||
$this->root = MenusHelper::loadPreset($name);
|
||||
} else {
|
||||
$this->root = MenusHelper::getMenuItems($menutype, true);
|
||||
|
||||
// Can we access everything important with this menu? Create a recovery menu!
|
||||
if (
|
||||
$this->enabled
|
||||
&& $this->params->get('check', 1)
|
||||
&& $this->check($this->root, $this->params)
|
||||
) {
|
||||
$this->params->set('recovery', true);
|
||||
|
||||
// In recovery mode, load the preset inside a special root node.
|
||||
$this->root = new AdministratorMenuItem(['level' => 0]);
|
||||
$heading = new AdministratorMenuItem(['title' => 'MOD_MENU_RECOVERY_MENU_ROOT', 'type' => 'heading', 'class' => 'class:fa fa-notes-medical']);
|
||||
$this->root->addChild($heading);
|
||||
|
||||
MenusHelper::loadPreset('default', true, $heading);
|
||||
|
||||
$this->preprocess($this->root);
|
||||
|
||||
$this->root->addChild(new AdministratorMenuItem(['type' => 'separator']));
|
||||
|
||||
// Add link to exit recovery mode
|
||||
$uri = clone Uri::getInstance();
|
||||
$uri->setVar('recover_menu', 0);
|
||||
|
||||
$this->root->addChild(new AdministratorMenuItem(['title' => 'MOD_MENU_RECOVERY_EXIT', 'type' => 'url', 'link' => $uri->toString()]));
|
||||
|
||||
return $this->root;
|
||||
}
|
||||
}
|
||||
|
||||
$this->preprocess($this->root);
|
||||
|
||||
return $this->root;
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to render a given level of a menu using provided layout file
|
||||
*
|
||||
* @param string $layoutFile The layout file to be used to render
|
||||
* @param AdministratorMenuItem $node Node to render the children of
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 3.8.0
|
||||
*/
|
||||
public function renderSubmenu($layoutFile, $node)
|
||||
{
|
||||
if (is_file($layoutFile)) {
|
||||
$children = $node->getChildren();
|
||||
|
||||
foreach ($children as $current) {
|
||||
$current->level = $node->level + 1;
|
||||
|
||||
// This sets the scope to this object for the layout file and also isolates other `include`s
|
||||
require $layoutFile;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check the flat list of menu items for important links
|
||||
*
|
||||
* @param AdministratorMenuItem $node The menu items array
|
||||
* @param Registry $params Module options
|
||||
*
|
||||
* @return boolean Whether to show recovery menu
|
||||
*
|
||||
* @since 3.8.0
|
||||
*/
|
||||
protected function check($node, Registry $params)
|
||||
{
|
||||
$me = $this->application->getIdentity();
|
||||
$authMenus = $me->authorise('core.manage', 'com_menus');
|
||||
$authModules = $me->authorise('core.manage', 'com_modules');
|
||||
|
||||
if (!$authMenus && !$authModules) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$items = $node->getChildren(true);
|
||||
$types = array_column($items, 'type');
|
||||
$elements = array_column($items, 'element');
|
||||
$rMenu = $authMenus && !\in_array('com_menus', $elements);
|
||||
$rModule = $authModules && !\in_array('com_modules', $elements);
|
||||
$rContainer = !\in_array('container', $types);
|
||||
|
||||
if ($rMenu || $rModule || $rContainer) {
|
||||
$recovery = $this->application->getUserStateFromRequest('mod_menu.recovery', 'recover_menu', 0, 'int');
|
||||
|
||||
if ($recovery) {
|
||||
return true;
|
||||
}
|
||||
|
||||
$missing = [];
|
||||
|
||||
if ($rMenu) {
|
||||
$missing[] = Text::_('MOD_MENU_IMPORTANT_ITEM_MENU_MANAGER');
|
||||
}
|
||||
|
||||
if ($rModule) {
|
||||
$missing[] = Text::_('MOD_MENU_IMPORTANT_ITEM_MODULE_MANAGER');
|
||||
}
|
||||
|
||||
if ($rContainer) {
|
||||
$missing[] = Text::_('MOD_MENU_IMPORTANT_ITEM_COMPONENTS_CONTAINER');
|
||||
}
|
||||
|
||||
$uri = clone Uri::getInstance();
|
||||
$uri->setVar('recover_menu', 1);
|
||||
|
||||
$table = Table::getInstance('MenuType');
|
||||
$menutype = $params->get('menutype');
|
||||
|
||||
$table->load(['menutype' => $menutype]);
|
||||
|
||||
$menutype = isset($table->title) ? $table->title : $menutype;
|
||||
$message = Text::sprintf('MOD_MENU_IMPORTANT_ITEMS_INACCESSIBLE_LIST_WARNING', $menutype, implode(', ', $missing), $uri);
|
||||
|
||||
$this->application->enqueueMessage($message, 'warning');
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter and perform other preparatory tasks for loaded menu items based on access rights and module configurations for display
|
||||
*
|
||||
* @param AdministratorMenuItem $parent A menu item to process
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 3.8.0
|
||||
*/
|
||||
protected function preprocess($parent)
|
||||
{
|
||||
$user = $this->application->getIdentity();
|
||||
$language = $this->application->getLanguage();
|
||||
$dispatcher = $this->application->getDispatcher();
|
||||
|
||||
$noSeparator = true;
|
||||
$children = $parent->getChildren();
|
||||
|
||||
/**
|
||||
* Trigger onPreprocessMenuItems for the current level of backend menu items.
|
||||
* $children is an array of AdministratorMenuItem objects. A plugin can traverse the whole tree,
|
||||
* but new nodes will only be run through this method if their parents have not been processed yet.
|
||||
*/
|
||||
$children = $dispatcher->dispatch('onPreprocessMenuItems', new PreprocessMenuItemsEvent('onPreprocessMenuItems', [
|
||||
'context' => 'com_menus.administrator.module',
|
||||
'subject' => &$children, // @todo: Remove reference in Joomla 6, see PreprocessMenuItemsEvent::__constructor()
|
||||
'params' => $this->params,
|
||||
'enabled' => $this->enabled,
|
||||
]))->getArgument('subject', $children);
|
||||
|
||||
foreach ($children as $item) {
|
||||
$itemParams = $item->getParams();
|
||||
|
||||
// Exclude item with menu item option set to exclude from menu modules
|
||||
if ($itemParams->get('menu_show', 1) == 0) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
$item->scope = $item->scope ?? 'default';
|
||||
$item->icon = $item->icon ?? '';
|
||||
|
||||
// Whether this scope can be displayed. Applies only to preset items. Db driven items should use un/published state.
|
||||
if (($item->scope === 'help' && $this->params->get('showhelp', 1) == 0) || ($item->scope === 'edit' && !$this->params->get('shownew', 1))) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!empty($item->link) && substr($item->link, 0, 8) === 'special:') {
|
||||
$special = substr($item->link, 8);
|
||||
|
||||
if ($special === 'language-forum') {
|
||||
$item->link = 'index.php?option=com_admin&view=help&layout=langforum';
|
||||
} elseif ($special === 'custom-forum') {
|
||||
$item->link = $this->params->get('forum_url');
|
||||
}
|
||||
}
|
||||
|
||||
$uri = new Uri($item->link);
|
||||
$query = $uri->getQuery(true);
|
||||
|
||||
/**
|
||||
* If component is passed in the link via option variable, we set $item->element to this value for further
|
||||
* processing. It is needed for links from menu items of third party extensions link to Joomla! core
|
||||
* components like com_categories, com_fields...
|
||||
*/
|
||||
$item->element = !empty($uri->getVar('option')) ? $uri->getVar('option') : '';
|
||||
|
||||
// Exclude item if is not enabled
|
||||
if ($item->element !== '' && !ComponentHelper::isEnabled($item->element)) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
/*
|
||||
* Multilingual Associations if the site is not set as multilingual and/or Associations is not enabled in
|
||||
* the Language Filter plugin
|
||||
*/
|
||||
|
||||
if ($item->element === 'com_associations' && !Associations::isEnabled()) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
// Exclude Mass Mail if disabled in global configuration
|
||||
if ($item->scope === 'massmail' && ($this->application->get('mailonline', 1) == 0 || $this->application->get('massmailoff', 0) == 1)) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
// Exclude item if the component is not authorised
|
||||
$assetName = $item->element;
|
||||
|
||||
if ($item->element === 'com_categories') {
|
||||
$assetName = $query['extension'] ?? 'com_content';
|
||||
} elseif ($item->element === 'com_fields') {
|
||||
// Only display Fields menus when enabled in the component
|
||||
$createFields = null;
|
||||
|
||||
if (isset($query['context'])) {
|
||||
$createFields = ComponentHelper::getParams(strstr($query['context'], '.', true))->get('custom_fields_enable', 1);
|
||||
}
|
||||
|
||||
if (!$createFields) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
list($assetName) = isset($query['context']) ? explode('.', $query['context'], 2) : ['com_fields'];
|
||||
} elseif ($item->element === 'com_cpanel' && $item->link === 'index.php') {
|
||||
continue;
|
||||
} elseif (
|
||||
$item->link === 'index.php?option=com_cpanel&view=help'
|
||||
|| $item->link === 'index.php?option=com_cpanel&view=cpanel&dashboard=help'
|
||||
) {
|
||||
if ($this->params->get('showhelp', 1)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Exclude help menu item if set such in mod_menu
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
} elseif ($item->element === 'com_workflow') {
|
||||
// Only display Workflow menus when enabled in the component
|
||||
$workflow = null;
|
||||
|
||||
if (isset($query['extension'])) {
|
||||
$parts = explode('.', $query['extension']);
|
||||
|
||||
$workflow = ComponentHelper::getParams($parts[0])->get('workflow_enabled') && $user->authorise('core.manage.workflow', $parts[0]);
|
||||
}
|
||||
|
||||
if (!$workflow) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
list($assetName) = isset($query['extension']) ? explode('.', $query['extension'], 2) : ['com_workflow'];
|
||||
} elseif (\in_array($item->element, ['com_config', 'com_privacy', 'com_actionlogs'], true) && !$user->authorise('core.admin')) {
|
||||
// Special case for components which only allow super user access
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
} elseif ($item->element === 'com_joomlaupdate' && !$user->authorise('core.admin')) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
} elseif (
|
||||
($item->link === 'index.php?option=com_installer&view=install' || $item->link === 'index.php?option=com_installer&view=languages')
|
||||
&& !$user->authorise('core.admin')
|
||||
) {
|
||||
continue;
|
||||
} elseif ($item->element === 'com_admin') {
|
||||
if (isset($query['view']) && $query['view'] === 'sysinfo' && !$user->authorise('core.admin')) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
} elseif ($item->link === 'index.php?option=com_messages&view=messages' && !$user->authorise('core.manage', 'com_users')) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($assetName && !$user->authorise(($item->scope === 'edit') ? 'core.create' : 'core.manage', $assetName)) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
// Exclude if link is invalid
|
||||
if (!isset($item->link) || !\in_array($item->type, ['separator', 'heading', 'container']) && trim($item->link) === '') {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
// Process any children if exists
|
||||
if ($item->hasChildren()) {
|
||||
$this->preprocess($item);
|
||||
}
|
||||
|
||||
// Populate automatic children for container items
|
||||
if ($item->type === 'container') {
|
||||
$exclude = (array) $itemParams->get('hideitems') ?: [];
|
||||
$components = MenusHelper::getMenuItems('main', false, $exclude);
|
||||
|
||||
// We are adding the nodes first to preprocess them, then sort them and add them again.
|
||||
foreach ($components->getChildren() as $c) {
|
||||
$item->addChild($c);
|
||||
}
|
||||
|
||||
$this->preprocess($item);
|
||||
$children = ArrayHelper::sortObjects($item->getChildren(), 'text', 1, false, true);
|
||||
|
||||
foreach ($children as $c) {
|
||||
$item->addChild($c);
|
||||
}
|
||||
}
|
||||
|
||||
// Exclude if there are no child items under heading or container
|
||||
if (\in_array($item->type, ['heading', 'container']) && !$item->hasChildren() && empty($item->components)) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
// Remove repeated and edge positioned separators, It is important to put this check at the end of any logical filtering.
|
||||
if ($item->type === 'separator') {
|
||||
if ($noSeparator) {
|
||||
$parent->removeChild($item);
|
||||
continue;
|
||||
}
|
||||
|
||||
$noSeparator = true;
|
||||
} else {
|
||||
$noSeparator = false;
|
||||
}
|
||||
|
||||
// Ok we passed everything, load language at last only
|
||||
if (!empty($item->element)) {
|
||||
$language->load($item->element . '.sys', JPATH_ADMINISTRATOR) ||
|
||||
$language->load($item->element . '.sys', JPATH_ADMINISTRATOR . '/components/' . $item->element);
|
||||
}
|
||||
|
||||
if ($item->type === 'separator' && $itemParams->get('text_separator') == 0) {
|
||||
$item->title = '';
|
||||
}
|
||||
|
||||
$item->text = Text::_($item->title);
|
||||
}
|
||||
|
||||
// If last one was a separator remove it too.
|
||||
$last = end($parent->getChildren());
|
||||
|
||||
if ($last && $last->type === 'separator' && $last->getSibling(false) && $last->getSibling(false)->type === 'separator') {
|
||||
$parent->removeChild($last);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to get the CSS class name for an icon identifier or create one if
|
||||
* a custom image path is passed as the identifier
|
||||
*
|
||||
* @param AdministratorMenuItem $node Node to get icon data from
|
||||
*
|
||||
* @return string CSS class name
|
||||
*
|
||||
* @since 3.8.0
|
||||
*/
|
||||
public function getIconClass($node)
|
||||
{
|
||||
$identifier = !empty($node->class) ? $node->class : '';
|
||||
|
||||
// Top level is special
|
||||
if (trim($identifier) == '') {
|
||||
return null;
|
||||
}
|
||||
|
||||
// We were passed a class name
|
||||
if (substr($identifier, 0, 6) == 'class:') {
|
||||
$class = substr($identifier, 6);
|
||||
} else {
|
||||
// We were passed background icon url. Build the CSS class for the icon
|
||||
if ($identifier == null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$class = preg_replace('#\.[^.]*$#', '', basename($identifier));
|
||||
$class = preg_replace('#\.\.[^A-Za-z0-9\.\_\- ]#', '', $class);
|
||||
}
|
||||
|
||||
$html = 'icon-' . $class . ' icon-fw';
|
||||
|
||||
return $html;
|
||||
}
|
||||
|
||||
/**
|
||||
* Increase the counter and return the new value
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 4.0.0
|
||||
*/
|
||||
public function getCounter()
|
||||
{
|
||||
$this->counter++;
|
||||
|
||||
return $this->counter;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user