tyler.durden
/
icingaweb2
mirror of https://github.com/Icinga/icingaweb2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'bugfix/modules-menu-provider-6639' 

refs #6639
This commit is contained in:
Alexander Fuhr 2014-08-22 11:46:43 +02:00
parent da821fd952 20cead67a6
commit a5373a6e9e
11 changed files with 361 additions and 182 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
.vagrant-puppet/manifests/default.pp
View File

@ -709,13 +709,6 @@ file { '/etc/icingaweb/config.ini':
group => 'apache',
}
file { '/etc/icingaweb/menu.ini':
source => 'puppet:////vagrant/config/menu.ini',
owner => 'apache',
group => 'apache',
# replace => false,
}
file { '/etc/icingaweb/resources.ini':
source => 'puppet:////vagrant/.vagrant-puppet/files/etc/icingaweb/resources.ini',
owner => 'apache',
@ -747,12 +740,6 @@ file { '/etc/icingaweb/modules/monitoring/instances.ini':
group => 'apache',
}
file { '/etc/icingaweb/modules/monitoring/menu.ini':
source => 'puppet:////vagrant/config/modules/monitoring/menu.ini',
owner => 'apache',
group => 'apache',
}
file { '/etc/icingaweb/dashboard':
ensure => 'directory',
owner => 'apache',
@ -791,16 +778,3 @@ file { '/etc/bash_completion.d/icingacli':
mode => 755,
require => Exec['install bash-completion']
}
file { '/etc/icingaweb/modules/doc/':
ensure => 'directory',
owner => 'apache',
group => 'apache'
}
file { '/etc/icingaweb/modules/doc/menu.ini':
source => 'puppet:////vagrant/config/modules/doc/menu.ini',
owner => 'apache',
group => 'apache',
}

3
application/controllers/LayoutController.php
View File

@ -18,8 +18,9 @@ class LayoutController extends ActionController
*/
public function menuAction()
{
$this->_helper->layout()->disableLayout();
$this->view->menuRenderer = new MenuRenderer(
Menu::fromConfig()->order(), Url::fromRequest()->without('renderLayout')->getRelativeUrl()
Menu::load(), Url::fromRequest()->without('renderLayout')->getRelativeUrl()
);
}

2
application/layouts/scripts/parts/navigation.phtml
View File

@ -14,5 +14,5 @@ if (! $this->auth()->isAuthenticated()) {
<form action="<?= $this->href('search') ?>" method="get" role="search">
<input type="text" name="q" class="search autofocus" placeholder="<?= $this->translate('Search...') ?>" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</form>
<?= new MenuRenderer(Menu::fromConfig()->order(), Url::fromRequest()->without('renderLayout')->getRelativeUrl()); ?>
<?= new MenuRenderer(Menu::load(), Url::fromRequest()->without('renderLayout')->getRelativeUrl()); ?>
</div>

34
config/menu.ini
View File

@ -1,34 +0,0 @@
[Dashboard]
title = "Dashboard"
url = "dashboard"
icon = "img/icons/dashboard.png"
priority = 10
[System]
icon = img/icons/configuration.png
priority = 200
[System.Preferences]
title = "Preferences"
url = "preference"
priority = 200
[System.Configuration]
title = "Configuration"
url = "config"
priority = 300
[System.Modules]
title = "Modules"
url = "config/modules"
priority = 400
[System.ApplicationLog]
title = "Application log"
url = "list/applicationlog"
priority = 500
[Logout]
url = "authentication/logout"
icon = img/icons/logout.png
priority = 300

5
config/modules/doc/menu.ini
View File

@ -1,5 +0,0 @@
[Documentation]
title = "Documentation"
icon = "img/icons/comment.png"
url = "doc"
priority = 80

109
config/modules/monitoring/menu.ini
View File

@ -1,109 +0,0 @@
[Problems]
priority = 20
icon = "img/icons/error.png"
[Problems.Unhandled Hosts]
priority = 40
url = "monitoring/list/hosts?host_problem=1&host_handled=0"
[Problems.Unhandled Services]
priority = 40
url = "monitoring/list/services?service_problem=1&service_handled=0&sort=service_severity"
[Problems.Host Problems]
priority = 50
url = "monitoring/list/hosts?host_problem=1&sort=host_severity"
[Problems.Service Problems]
priority = 50
url = "monitoring/list/services?service_problem=1&sort=service_severity&dir=desc"
[Problems.Current Downtimes]
url = "monitoring/list/downtimes?downtime_is_in_effect=1"
[Overview]
priority = 30
icon = "img/icons/hostgroup.png"
[Overview.Tactical Overview]
title = "Tactical Overview"
url = "monitoring/tactical"
priority = 40
[Overview.Hosts]
title = "Hosts"
url = "monitoring/list/hosts"
priority = 50
[Overview.Services]
title = "Services"
url = "monitoring/list/services"
priority = 50
[Overview.Servicematrix]
title = "Servicematrix"
url = "monitoring/list/servicematrix?service_problem=1"
priority = 51
[Overview.Servicegroups]
title = "Servicegroups"
url = "monitoring/list/servicegroups"
priority = 60
[Overview.Hostgroups]
title = "Hostgroups"
url = "monitoring/list/hostgroups"
priority = 60
[Overview.Contactgroups]
title = "Contactgroups"
url = "monitoring/list/contactgroups"
priority = 61
[Overview.Downtimes]
title = "Downtimes"
url = "monitoring/list/downtimes"
priority = 70
[Overview.Comments]
title = "Comments"
url = "monitoring/list/comments?comment_type=(comment|ack)"
priority = 70
[Overview.Contacts]
title = "Contacts"
url = "monitoring/list/contacts"
priority = 70
[History]
icon = "img/icons/history.png"
[History.Critical Events]
title = "Critical Events"
url = "monitoring/list/statehistorysummary"
priority = 50
[History.Notifications]
title = "Notifications"
url = "monitoring/list/notifications"
[History.Events]
title = "All Events"
url = "monitoring/list/eventhistory?timestamp>=-7%20days"
[History.Timeline]
title = "Timeline"
url = "monitoring/timeline"
[System.Process Info]
title = "Process Info"
url = "monitoring/process/info"
priority = 120
[System.Performance Info]
title = "Performance Info"
url = "monitoring/process/performance"
priority = 130

3
icingaweb2.spec
View File

@ -181,9 +181,6 @@ install -D -m0644 packages/rpm/etc/httpd/conf.d/icingaweb.conf %{buildroot}/%{ap
%{__cp} -r application library modules public %{buildroot}/%{sharedir}/
## config
# use the default menu.ini for application and monitoring mobule
install -D -m0644 config/menu.ini %{buildroot}/%{_sysconfdir}/icingaweb/menu.ini
install -D -m0644 config/modules/monitoring/menu.ini %{buildroot}/%{_sysconfdir}/icingaweb/modules/monitoring/menu.ini
# authentication is db only
install -D -m0644 packages/rpm/etc/icingaweb/authentication.ini %{buildroot}/%{_sysconfdir}/icingaweb/authentication.ini
# custom resource paths

50
library/Icinga/Application/Modules/Module.php
View File

@ -5,6 +5,7 @@
namespace Icinga\Application\Modules;
use Exception;
use Zend_Config;
use Zend_Controller_Router_Route_Abstract;
use Zend_Controller_Router_Route as Route;
use Icinga\Application\ApplicationBootstrap;
@ -13,6 +14,7 @@ use Icinga\Application\Icinga;
use Icinga\Logger\Logger;
use Icinga\Util\Translator;
use Icinga\Web\Hook;
use Icinga\Web\Menu;
use Icinga\Web\Widget;
use Icinga\Util\File;
use Icinga\Exception\ProgrammingError;
@ -136,7 +138,6 @@ class Module
*/
private $app;
/**
* Routes to add to the route chain
*
@ -146,6 +147,42 @@ class Module
*/
protected $routes = array();
/**
* A set of menu elements
*
* @var array
*/
protected $menuItems = array();
/**
* Get all Menu Items
*
* @return array
*/
public function getMenuItems()
{
$this->launchConfigScript();
return $this->menuItems;
}
/**
* Add a menu Section to the Sidebar menu
*
* @param $name
* @param array $properties
* @return mixed
*/
protected function menuSection($name, array $properties = array())
{
if (array_key_exists($name, $this->menuItems)) {
$this->menuItems[$name]->setProperties($properties);
} else {
$this->menuItems[$name] = new Menu($name, new Zend_Config($properties));
}
return $this->menuItems[$name];
}
/**
* Create a new module object
*
@ -781,4 +818,15 @@ class Module
$this->routes[$name] = $route;
return $this;
}
/**
* Translate a string with the global mt()
*
* @param $string
* @return mixed|string
*/
protected function translate($string)
{
return mt($this->name, $string);
}
}

183
library/Icinga/Web/Menu.php
View File

@ -4,6 +4,7 @@
namespace Icinga\Web;
use Icinga\Exception\ConfigurationError;
use Zend_Config;
use RecursiveIterator;
use Icinga\Application\Config;
@ -67,20 +68,68 @@ class Menu implements RecursiveIterator
public function __construct($id, Zend_Config $config = null)
{
$this->id = $id;
$this->setProperties($config);
}
if ($config !== null) {
foreach ($config as $key => $value) {
/**
* Set all given properties
*
* @param array|Zend_Config $props Property list
*/
public function setProperties($props = null)
{
if ($props !== null) {
foreach ($props as $key => $value) {
$method = 'set' . implode('', array_map('ucfirst', explode('_', strtolower($key))));
if (method_exists($this, $method)) {
$this->{$method}($value);
} else {
throw new ConfigurationError(
sprintf('Menu got invalid property "%s"', $key)
);
}
}
}
return $this;
}
/**
* Get Properties
*
* @return array
*/
public function getProperties()
{
$props = array();
$keys = array('url', 'icon', 'priority', 'title');
foreach ($keys as $key) {
$func = 'get' . ucfirst($key);
if (null !== ($val = $this->{$func}())) {
$props[$key] = $val;
}
}
return $props;
}
/**
* Whether this Menu conflicts with the given Menu object
*
* @param Menu $menu
* @return bool
*/
public function conflictsWith(Menu $menu)
{
if ($menu->getUrl() === null || $this->getUrl() === null) {
return false;
}
return $menu->getUrl() !== $this->getUrl();
}
/**
* Create menu from the application's menu config file plus the config files from all enabled modules
*
* THIS IS OBSOLATE. LEFT HERE FOR FUTURE USE WITH USER-SPECIFIC MODULES
*
* @return self
*/
public static function fromConfig()
@ -100,6 +149,63 @@ class Menu implements RecursiveIterator
return $menu->loadSubMenus($menu->flattenConfigs($menuConfigs));
}
/**
* Create menu from the application's menu config plus menu entries provided by all enabled modules
*
* @return self
*/
public static function load()
{
/** @var $menu \Icinga\Web\Menu */
$menu = new static('menu');
$menu->addMainMenuItems();
$manager = Icinga::app()->getModuleManager();
foreach ($manager->getLoadedModules() as $module) {
/** @var $module \Icinga\Application\Modules\Module */
$menu->mergeSubMenus($module->getMenuItems());
}
return $menu->order();
}
/**
* Add Applications Main Menu Items
*/
protected function addMainMenuItems()
{
$this->add(t('Dashboard'), array(
'url' => 'dashboard',
'icon' => 'img/icons/dashboard.png',
'priority' => 10
));
$section = $this->add(t('System'), array(
'icon' => 'img/icons/configuration.png',
'priority' => 200
));
$section->add(t('Preferences'), array(
'url' => 'preference',
'priority' => 200
));
$section->add(t('Configuration'), array(
'url' => 'config',
'priority' => 300
));
$section->add(t('Modules'), array(
'url' => 'config/modules',
'priority' => 400
));
$section->add(t('ApplicationLog'), array(
'url' => 'list/applicationlog',
'priority' => 500
));
$this->add(t('Logout'), array(
'url' => 'authentication/logout',
'icon' => 'img/icons/logout.png',
'priority' => 300
));
}
/**
* Set the id of this menu
*
@ -253,6 +359,79 @@ class Menu implements RecursiveIterator
return $subMenu;
}
/**
* Set required Permissions
*
* @param $permission
* @return $this
*/
public function requirePermission($permission)
{
// Not implemented yet
return $this;
}
/**
* Merge Sub Menus
*
* @param array $submenus
* @return $this
*/
public function mergeSubMenus(array $submenus)
{
foreach ($submenus as $menu) {
$this->mergeSubMenu($menu);
}
return $this;
}
/**
* Merge Sub Menu
*
* @param Menu $menu
* @return mixed
*/
public function mergeSubMenu(Menu $menu)
{
$name = $menu->getId();
if (array_key_exists($name, $this->subMenus)) {
/** @var $current Menu */
$current = $this->subMenus[$name];
if ($current->conflictsWith($menu)) {
while (array_key_exists($name, $this->subMenus)) {
if (preg_match('/_(\d+)$/', $name, $m)) {
$name = preg_replace('/_\d+$/', $m[1]++, $name);
} else {
$name .= '_2';
}
}
$menu->setId($name);
$this->subMenus[$name] = $menu;
} else {
$current->setProperties($menu->getProperties());
foreach ($menu->subMenus as $child) {
$current->mergeSubMenu($child);
}
}
} else {
$this->subMenus[$name] = $menu;
}
return $this->subMenus[$name];
}
/**
* Add a Menu
*
* @param $name
* @param array $config
* @return Menu
*/
public function add($name, $config = array())
{
return $this->addSubMenu($name, new Zend_Config($config));
}
/**
* Return whether a sub menu with the given id exists
*

12
modules/doc/configuration.php Normal file
View File

@ -0,0 +1,12 @@
<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
/* @var $this \Icinga\Application\Modules\Module */
$section = $this->menuSection($this->translate('Documentation'), array(
'title' => 'Documentation',
'icon' => 'img/icons/comment.png',
'url' => 'doc',
'priority' => 80
));

116
modules/monitoring/configuration.php
View File

@ -2,6 +2,8 @@
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
/* @var $this \Icinga\Application\Modules\Module */
// TODO: We need to define a useful permission set for this module, the
// list provided here is just an example
$this->providePermission('commands/all', 'Allow to send all commands');
@ -16,3 +18,117 @@ $this->provideConfigTab('security', array(
'title' => 'Security',
'url' => 'config/security'
));
/*
* Problems Section
*/
$section = $this->menuSection($this->translate('Problems'), array(
'icon' => 'img/icons/error.png',
'priority' => 20
));
$section->add($this->translate('Unhandled Hosts'), array(
'url' => 'monitoring/list/hosts?host_problem=1&host_handled=0',
'priority' => 40
));
$section->add($this->translate('Unhandled Services'), array(
'url' => 'monitoring/list/services?service_problem=1&service_handled=0&sort=service_severity',
'priority' => 40
));
$section->add($this->translate('Host Problems'), array(
'url' => 'monitoring/list/hosts?host_problem=1&sort=host_severity',
'priority' => 50
));
$section->add($this->translate('Service Problems'), array(
'url' => 'monitoring/list/services?service_problem=1&sort=service_severity&dir=desc',
'priority' => 50
));
$section->add($this->translate('Current Downtimes'))->setUrl('monitoring/list/downtimes?downtime_is_in_effect=1');
/*
* Overview Section
*/
$section = $this->menuSection($this->translate('Overview'), array(
'icon' => 'img/icons/hostgroup.png',
'priority' => 30
));
$section->add($this->translate('Tactical Overview'), array(
'url' => 'monitoring/tactical',
'priority' => 40
));
$section->add($this->translate('Hosts'), array(
'url' => 'monitoring/list/hosts',
'priority' => 50
));
$section->add($this->translate('Services'), array(
'url' => 'monitoring/list/services',
'priority' => 50
));
$section->add($this->translate('Servicematrix'), array(
'url' => 'monitoring/list/servicematrix?service_problem=1',
'priority' => 51
));
$section->add($this->translate('Servicegroups'), array(
'url' => 'monitoring/list/servicegroups',
'priority' => 60
));
$section->add($this->translate('Hostgroups'), array(
'url' => 'monitoring/list/hostgroups',
'priority' => 60
));
$section->add($this->translate('Contactgroups'), array(
'url' => 'monitoring/list/contactgroups',
'priority' => 61
));
$section->add($this->translate('Downtimes'), array(
'url' => 'monitoring/list/downtimes',
'priority' => 71
));
$section->add($this->translate('Comments'), array(
'url' => 'monitoring/list/comments?comment_type=(comment|ack)',
'priority' => 70
));
$section->add($this->translate('Contacts'), array(
'url' => 'monitoring/list/contacts',
'priority' => 70
));
/*
* History Section
*/
$section = $this->menuSection($this->translate('History'), array(
'icon' => 'img/icons/history.png'
));
$section->add($this->translate('Critical Events'), array(
'url' => 'monitoring/list/statehistorysummary',
'priority' => 50
));
$section->add($this->translate('Notifications'), array(
'url' => 'monitoring/list/notifications'
));
$section->add($this->translate('Events'), array(
'title' => $this->translate('All Events'),
'url' => 'monitoring/list/eventhistory?timestamp>=-7%20days'
));
$section->add($this->translate('Timeline'))->setUrl('monitoring/timeline');
/*
* System Section
*/
$section = $this->menuSection($this->translate('System'));
$section->add($this->translate('Process Info'), array(
'url' => 'monitoring/process/info',
'priority' => 120
));
$section->add($this->translate('Performance Info'), array(
'url' => 'monitoring/process/performance',
'priority' => 130
));
/*
$dashboard = $this->dashboard('Current Incidents'); // Web\Widget\Dashboard\Pane
$dashboard->add('Service Problems', array(
));
*/