From 1e2bd37ae829f1dd7ccd7f519f65b689f0784bd3 Mon Sep 17 00:00:00 2001
From: Gianluca Piccolo <gianluca.piccolo@wuerth-phoenix.com>
Date: Wed, 2 Oct 2019 13:42:42 +0200
Subject: [PATCH] Add custom tab hook

---
 .../views/scripts/object/detail-tabhook.phtml | 21 +++++++
 .../Monitoring/Hook/ObjectDetailsTabHook.php  | 60 +++++++++++++++++++
 .../Controller/MonitoredObjectController.php  | 38 ++++++++++++
 3 files changed, 119 insertions(+)
 create mode 100644 modules/monitoring/application/views/scripts/object/detail-tabhook.phtml
 create mode 100644 modules/monitoring/library/Monitoring/Hook/ObjectDetailsTabHook.php

diff --git a/modules/monitoring/application/views/scripts/object/detail-tabhook.phtml b/modules/monitoring/application/views/scripts/object/detail-tabhook.phtml
new file mode 100644
index 000000000..abcfcc131
--- /dev/null
+++ b/modules/monitoring/application/views/scripts/object/detail-tabhook.phtml
@@ -0,0 +1,21 @@
+<?php
+
+if (! $this->compact): ?>
+<div class="controls separated">
+    <?= $this->tabs ?>
+<?php
+if ($this->header === true) {
+    if ($object->type === 'service') {
+        echo $this->render('partials/object/service-header.phtml');
+    } else {
+        echo $this->render('partials/object/host-header.phtml');
+    }
+} elseif ($this->header !== false) {
+    echo $this->header;
+}
+?>
+</div>
+<?php endif ?>
+<div class="content">
+    <?= $this->content ?>
+</div>
\ No newline at end of file
diff --git a/modules/monitoring/library/Monitoring/Hook/ObjectDetailsTabHook.php b/modules/monitoring/library/Monitoring/Hook/ObjectDetailsTabHook.php
new file mode 100644
index 000000000..15fa9bb60
--- /dev/null
+++ b/modules/monitoring/library/Monitoring/Hook/ObjectDetailsTabHook.php
@@ -0,0 +1,60 @@
+<?php
+/* Icinga Web 2 | (c) 2016 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Module\Monitoring\Hook;
+
+use Icinga\Authentication\Auth;
+use Icinga\Module\Monitoring\Object\MonitoredObject;
+use Icinga\Web\Request;
+
+/**
+ * Base class for object host details custom tab hooks
+ */
+abstract class ObjectDetailsTabHook
+{
+    /**
+     * Return the tab name - it must be unique
+     *
+     * @return  string
+     */
+    abstract public function getName();
+
+    /**
+     * Return the tab label
+     *
+     * @return  string
+     */
+    abstract public function getLabel();
+
+    /**
+     * Return the tab header
+     *
+     * @param MonitoredObject $monitoredObject The monitored object related to that page
+     * @param Request $request
+     * @return  string/bool The HTML string that compose the tab header,
+     *          bool True if the default header should be shown, False to display nothing
+     */
+    public function getHeader(MonitoredObject $monitoredObject, Request $request)
+    {
+        return true;
+    }
+
+    /**
+     * Return the tab content
+     *
+     * @param MonitoredObject $monitoredObject The monitored object related to that page
+     * @param Request $request
+     * @return  string The HTML string that compose the tab content
+     */
+    abstract public function getContent(MonitoredObject $monitoredObject, Request $request);
+
+    /**
+     * This method returns true if the tab is visible for the logged user, otherwise false
+     *
+     * @return  bool True if the tab is visible for the logged user, otherwise false
+     */
+    public function shouldBeShown(MonitoredObject $monitoredObject, Auth $auth)
+    {
+        return true;
+    }
+}
diff --git a/modules/monitoring/library/Monitoring/Web/Controller/MonitoredObjectController.php b/modules/monitoring/library/Monitoring/Web/Controller/MonitoredObjectController.php
index f4a1d44d2..69a93347a 100644
--- a/modules/monitoring/library/Monitoring/Web/Controller/MonitoredObjectController.php
+++ b/modules/monitoring/library/Monitoring/Web/Controller/MonitoredObjectController.php
@@ -12,6 +12,7 @@ use Icinga\Module\Monitoring\Forms\Command\Object\ObjectsCommandForm;
 use Icinga\Module\Monitoring\Forms\Command\Object\RemoveAcknowledgementCommandForm;
 use Icinga\Module\Monitoring\Forms\Command\Object\ToggleObjectFeaturesCommandForm;
 use Icinga\Module\Monitoring\Hook\DetailviewExtensionHook;
+use Icinga\Module\Monitoring\Hook\ObjectDetailsTabHook;
 use Icinga\Web\Hook;
 use Icinga\Web\Url;
 use Icinga\Web\Widget\Tabextension\DashboardAction;
@@ -36,6 +37,13 @@ abstract class MonitoredObjectController extends Controller
      */
     protected $commandRedirectUrl;
 
+    /**
+     * List of visible hooked tabs
+     *
+     * @var ObjectDetailsTabHook[]
+     */
+    protected $tabHooks = [];
+
     /**
      * (non-PHPDoc)
      * @see \Icinga\Web\Controller\ActionController For the method documentation.
@@ -117,6 +125,22 @@ abstract class MonitoredObjectController extends Controller
         $this->render('object/detail-history', null, true);
     }
 
+    /**
+     * Show the content of a custom tab
+     */
+    public function tabhookAction()
+    {
+        $hookName = $this->params->get('hook');
+        $this->getTabs()->activate($hookName);
+
+        $hook = $this->tabHooks[$hookName];
+
+        $this->view->header = $hook->getHeader($this->object, $this->getRequest());
+        $this->view->content = $hook->getContent($this->object, $this->getRequest());
+        $this->view->object = $this->object;
+        $this->render('object/detail-tabhook', null, true);
+    }
+
     /**
      * Handle a command form
      *
@@ -262,6 +286,20 @@ abstract class MonitoredObjectController extends Controller
                 )
             );
         }
+
+        /** @var ObjectDetailsTabHook $hook */
+        foreach (Hook::all('Monitoring\\ObjectDetailsTab') as $hook) {
+            $hookName = $hook->getName();
+            if ($hook->shouldBeShown($object, $this->Auth())) {
+                $this->tabHooks[$hookName] = $hook;
+                $tabs->add($hookName, [
+                    'label' => $hook->getLabel(),
+                    'url'       => $isService ? 'monitoring/service/tabhook' : 'monitoring/host/tabhook',
+                    'urlParams' => $params + [ 'hook' => $hookName ]
+                ]);
+            }
+        }
+
         $tabs->extend(new DashboardAction())->extend(new MenuAction());
     }