From 51188daa4549b9f826bf217770aaa40950798261 Mon Sep 17 00:00:00 2001
From: Marius Hein <marius.hein@netways.de>
Date: Tue, 11 Feb 2014 16:21:36 +0100
Subject: [PATCH] Implenent TopBar hook and status summary as hook in
 monitoring

refs #5597
---
 application/controllers/LayoutController.php  | 27 ++++++
 application/layouts/scripts/body.phtml        |  3 +-
 .../layouts/scripts/parts/topbar.phtml        | 13 +--
 library/Icinga/Web/Hook.php                   |  5 ++
 .../{Topbar.php => Hook/Layout/TopBar.php}    | 34 ++++----
 .../views/scripts/{ => layout}/topbar.phtml   |  0
 .../library/Monitoring/Web/Hook/TopBar.php    | 87 +++++++++++++++++++
 modules/monitoring/register.php               |  4 -
 modules/monitoring/run.php                    | 17 +++-
 9 files changed, 160 insertions(+), 30 deletions(-)
 rename library/Icinga/Web/{Topbar.php => Hook/Layout/TopBar.php} (72%)
 rename modules/monitoring/application/views/scripts/{ => layout}/topbar.phtml (100%)
 create mode 100644 modules/monitoring/library/Monitoring/Web/Hook/TopBar.php

diff --git a/application/controllers/LayoutController.php b/application/controllers/LayoutController.php
index 81bf36083..45836582e 100644
--- a/application/controllers/LayoutController.php
+++ b/application/controllers/LayoutController.php
@@ -4,16 +4,43 @@
 // {{{ICINGA_LICENSE_HEADER}}}
 
 use Icinga\Web\Controller\ActionController;
+use Icinga\Web\Hook;
 use Icinga\Web\Menu;
 use Icinga\Web\Url;
 
+/**
+ * Create complex layout parts
+ */
 class LayoutController extends ActionController
 {
+    /**
+     * Render the menu
+     */
     public function menuAction()
     {
         $this->view->url    = Url::fromRequest()->getRelativeUrl();
         $this->view->items  = Menu::fromConfig()->getChildren();
         $this->view->sub    = false;
     }
+
+    /**
+     * Render the top bar
+     */
+    public function topbarAction()
+    {
+        $topbarHtmlParts = array();
+
+        /** @var Hook\Layout\TopBar $hook */
+        $hook = null;
+
+        foreach (Hook::all(Hook::TARGET_LAYOUT_TOPBAR) as $hook) {
+            $topbarHtmlParts[] = $hook->getHtml($this->getRequest(), $this->view);
+        }
+
+        $this->view->topbarHtmlParts = $topbarHtmlParts;
+
+
+        $this->renderScript('parts/topbar.phtml');
+    }
 }
 // @codingStandardsIgnoreEnd
diff --git a/application/layouts/scripts/body.phtml b/application/layouts/scripts/body.phtml
index 565a3122d..a42b46dcc 100755
--- a/application/layouts/scripts/body.phtml
+++ b/application/layouts/scripts/body.phtml
@@ -1,4 +1,5 @@
-<?php echo $this->render('parts/topbar.phtml') ?>
+<?= $this->action('topbar', 'layout'); ?>
+
 <div class="row">
   <!-- Only required for left/right tabs -->
   <div class="col-sm-12 col-xs-12 col-md-2 col-lg-2">
diff --git a/application/layouts/scripts/parts/topbar.phtml b/application/layouts/scripts/parts/topbar.phtml
index e2aa3209c..39d559f57 100755
--- a/application/layouts/scripts/parts/topbar.phtml
+++ b/application/layouts/scripts/parts/topbar.phtml
@@ -1,14 +1,15 @@
-<?php
-use Icinga\Web\Topbar;
-?>
 <nav class="navbar-fixed-top" id="icingatopbar" role="navigation">
     <div class="navbar-header">
         <a href="<?= $this->baseUrl('/') ?>" class="navbar-brand icinga-logo">Icinga</a>
     </div>
 
-    <?php foreach (Topbar::getPartials() as $partial) {
-        echo $this->partial($partial['viewScriptName'], $partial['moduleName'], $partial['data']);
-    } ?>
+    <?php if (count($this->topbarHtmlParts)): ?>
+        <ul class="nav navbar-nav">
+        <?php foreach ($this->topbarHtmlParts as $part): ?>
+            <li><?= $part; ?></li>
+        <?php endforeach; ?>
+        </ul>
+    <?php endif; ?>
 
   <?php if ($this->auth()->isAuthenticated()): ?>
   <ul class="nav navbar-nav pull-right" >
diff --git a/library/Icinga/Web/Hook.php b/library/Icinga/Web/Hook.php
index 1af4e5438..b8982b21a 100755
--- a/library/Icinga/Web/Hook.php
+++ b/library/Icinga/Web/Hook.php
@@ -45,6 +45,11 @@ use \Icinga\Exception\ProgrammingError;
  */
 class Hook
 {
+    /**
+     * Hook name
+     */
+    const TARGET_LAYOUT_TOPBAR = 'Layout\\TopBar';
+
     /**
      * Our hook name registry
      *
diff --git a/library/Icinga/Web/Topbar.php b/library/Icinga/Web/Hook/Layout/TopBar.php
similarity index 72%
rename from library/Icinga/Web/Topbar.php
rename to library/Icinga/Web/Hook/Layout/TopBar.php
index 020d495f8..669ce6e46 100644
--- a/library/Icinga/Web/Topbar.php
+++ b/library/Icinga/Web/Hook/Layout/TopBar.php
@@ -27,23 +27,23 @@
  */
 // {{{ICINGA_LICENSE_HEADER}}}
 
-namespace Icinga\Web;
+namespace Icinga\Web\Hook\Layout;
 
-class Topbar
+use \Icinga\Web\Request;
+use \Zend_View;
+
+/**
+ * Hook to extend topbar items
+ */
+interface TopBar
 {
-    private static $partials = array();
-
-    public static function addPartial($viewScriptName, $moduleName, $data)
-    {
-        self::$partials[] = array(
-            'viewScriptName'    => $viewScriptName,
-            'moduleName'        => $moduleName,
-            'data'              => $data
-        );
-    }
-
-    public static function getPartials()
-    {
-        return self::$partials;
-    }
+    /**
+     * Function to generate top bar content
+     *
+     * @param   Request     $request
+     * @param   Zend_View   $view
+     *
+     * @return  string
+     */
+    public function getHtml($request, $view);
 }
diff --git a/modules/monitoring/application/views/scripts/topbar.phtml b/modules/monitoring/application/views/scripts/layout/topbar.phtml
similarity index 100%
rename from modules/monitoring/application/views/scripts/topbar.phtml
rename to modules/monitoring/application/views/scripts/layout/topbar.phtml
diff --git a/modules/monitoring/library/Monitoring/Web/Hook/TopBar.php b/modules/monitoring/library/Monitoring/Web/Hook/TopBar.php
new file mode 100644
index 000000000..cc085b58b
--- /dev/null
+++ b/modules/monitoring/library/Monitoring/Web/Hook/TopBar.php
@@ -0,0 +1,87 @@
+<?php
+// {{{ICINGA_LICENSE_HEADER}}}
+/**
+ * This file is part of Icinga Web 2.
+ *
+ * Icinga Web 2 - Head for multiple monitoring backends.
+ * Copyright (C) 2013 Icinga Development Team
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * @copyright  2013 Icinga Development Team <info@icinga.org>
+ * @license    http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
+ * @author     Icinga Development Team <info@icinga.org>
+ *
+ */
+// {{{ICINGA_LICENSE_HEADER}}}
+
+namespace Icinga\Module\Monitoring\Web\Hook;
+
+use Icinga\Web\Hook\Layout\TopBar as IcingaTopBar;
+use Icinga\Module\Monitoring\DataView\StatusSummary as StatusSummaryView;
+use Icinga\Web\Request;
+use Zend_View;
+
+/**
+ * Render status summary into the topbar of icinga
+ */
+class TopBar implements IcingaTopBar
+{
+    /**
+     * Function to generate top bar content
+     *
+     * @param   Request $request
+     * @param   Zend_View $view
+     *
+     * @return  string
+     */
+    public function getHtml($request, $view)
+    {
+        $hostSummary = StatusSummaryView::fromRequest(
+            $request,
+            array(
+                'hosts_up',
+                'hosts_unreachable_handled',
+                'hosts_unreachable_unhandled',
+                'hosts_down_handled',
+                'hosts_down_unhandled',
+                'hosts_pending'
+            )
+        )->getQuery()->fetchRow();
+
+        $serviceSummary = StatusSummaryView::fromRequest(
+            $request,
+            array(
+                'services_ok',
+                'services_critical_handled',
+                'services_critical_unhandled',
+                'services_warning_handled',
+                'services_warning_unhandled',
+                'services_unknown_handled',
+                'services_unknown_unhandled',
+                'services_pending'
+            )
+        )->getQuery()->fetchRow();
+
+        return $view->partial(
+            'layout/topbar.phtml',
+            'monitoring',
+            array(
+                'hostSummary'       => $hostSummary,
+                'serviceSummary'    => $serviceSummary
+            )
+        );
+    }
+}
diff --git a/modules/monitoring/register.php b/modules/monitoring/register.php
index 91e062d8b..d6267c22f 100644
--- a/modules/monitoring/register.php
+++ b/modules/monitoring/register.php
@@ -4,7 +4,3 @@
  *
  * This file runs only on installation
  */
-
-use Icinga\Application\Logger;
-
-Logger::debug('Monitor/register');
\ No newline at end of file
diff --git a/modules/monitoring/run.php b/modules/monitoring/run.php
index 575954fe2..8bdeef042 100644
--- a/modules/monitoring/run.php
+++ b/modules/monitoring/run.php
@@ -5,6 +5,19 @@
  * This file runs every request to register runtime functionality
  *
  */
-use Icinga\Application\Logger;
 
-Logger::debug('Monitor/run');
\ No newline at end of file
+use Icinga\Application\Icinga;
+use Icinga\Authentication\Manager as AuthManager;
+use Icinga\Web\Hook;
+
+if (Icinga::app()->isCli()) {
+    return;
+}
+
+if (AuthManager::getInstance()->isAuthenticated()) {
+    Hook::register(
+        Hook::TARGET_LAYOUT_TOPBAR,
+        'monitoring-topbar',
+        'Icinga\\Module\\Monitoring\\Web\\Hook\\TopBar'
+    );
+}