Introduce new widget MobileNavigation

2025-09-26 03:09:10 +02:00 · 2022-04-12 15:58:57 +02:00 · 2022-04-12 15:58:57 +02:00 · 1578baebe5
commit 1578baebe5
parent d5d714b1ee
1 changed files with 238 additions and 0 deletions
--- a/library/Icinga/Web/Navigation/Mobile/MobileNavigation.php
+++ b/library/Icinga/Web/Navigation/Mobile/MobileNavigation.php
@ -0,0 +1,238 @@
+<?php
+/* Icinga Web 2 | (c) 2022 Icinga GmbH | GPLv2+ */
+
+namespace Icinga\Web\Navigation\Mobile;
+
+use Icinga\Application\Hook\HealthHook;
+use Icinga\Application\Icinga;
+use Icinga\Authentication\Auth;
+use Icinga\Web\Menu;
+use ipl\Html\Attributes;
+use ipl\Html\BaseHtmlElement;
+use ipl\Html\HtmlElement;
+use ipl\Html\HtmlString;
+use ipl\Html\Text;
+use ipl\Web\Widget\Icon;
+use ipl\Web\Widget\StateBadge;
+
+class MobileNavigation extends BaseHtmlElement
+{
+
+    // Maybe states as a trait?, see also in ConfigMenu.php
+    const STATE_OK = 'ok';
+    const STATE_CRITICAL = 'critical';
+    const STATE_WARNING = 'warning';
+    const STATE_PENDING = 'pending';
+    const STATE_UNKNOWN = 'unknown';
+
+    const MAX_NUM_OF_ITEMS = 5;
+
+    const EXCLUDED_ITEMS = [
+        'configuration',
+        'system',
+        'user'
+    ];
+
+    protected $tag = 'nav';
+
+    protected $items;
+
+    public function __construct()
+    {
+        $menu = new Menu();
+        $this->items = $menu;
+
+        $this->items->order();
+    }
+
+    protected function createMoreItem()
+    {
+        $moreMenu = new HtmlElement('li');
+
+        $this->assembleMoreItem($moreMenu);
+
+        return $moreMenu;
+    }
+
+    protected function getHealthCount()
+    {
+        $count = 0;
+        $title = null;
+        $worstState = null;
+        foreach (HealthHook::collectHealthData()->select() as $result) {
+            if ($worstState === null || $result->state > $worstState) {
+                $worstState = $result->state;
+                $title = $result->message;
+                $count = 1;
+            } elseif ($worstState === $result->state) {
+                $count++;
+            }
+        }
+
+        switch ($worstState) {
+            case HealthHook::STATE_OK:
+                $count = 0;
+                break;
+            case HealthHook::STATE_WARNING:
+                $this->state = self::STATE_WARNING;
+                break;
+            case HealthHook::STATE_CRITICAL:
+                $this->state = self::STATE_CRITICAL;
+                break;
+            case HealthHook::STATE_UNKNOWN:
+                $this->state = self::STATE_UNKNOWN;
+                break;
+        }
+
+        $this->title = $title;
+
+        return $count;
+    }
+
+    protected function createHealthBadge()
+    {
+        $stateBadge = null;
+        if ($this->getHealthCount() > 0) {
+            $stateBadge = new StateBadge($this->getHealthCount(), $this->state);
+            $stateBadge->addAttributes(['class' => 'disabled']);
+        }
+
+        return $stateBadge;
+    }
+
+    protected function assembleMoreItem(BaseHtmlElement $moreMenu)
+    {
+        $moreMenu->add(
+            HtmlElement::create(
+                'button',
+                Attributes::create(['id' => 'toggle-more']),
+                [
+                    new Icon('ellipsis-v'),
+                    Text::create('More')
+                ]
+            )
+        );
+
+        $moreMenu->add($this->createMoreFlyout());
+    }
+
+    protected function createNavItemIcon($item)
+    {
+        if ($item->getUrl() !== null && substr($item->getUrl()->getPath(), 0, 9) === 'icingadb/') {
+            $icon = new Icon($item->getIcon(), [ 'aria-hidden' => 1]);
+            return $icon;
+        }
+
+        return new HtmlString(Icinga::app()->getViewRenderer()->view->icon($item->getIcon()));
+    }
+
+    protected function createMoreFlyout()
+    {
+        $moreFlyout = new HtmlElement('div', Attributes::create(['class' => 'flyout']));
+
+        $this->assembleMoreFlyout($moreFlyout);
+
+        return $moreFlyout;
+    }
+
+    protected function assembleMoreFlyout($moreFlyout)
+    {
+        $flyoutContent = HtmlElement::create('div', ['class' => 'flyout-content']);
+        $ul = HtmlElement::create('ul', ['class' => 'nav nav-level-2']);
+
+        $startIndex = 0;
+        foreach ($this->items as $key => $item) {
+            if ($this->isValidItem($key, $item)) {
+                if (++$startIndex > self::MAX_NUM_OF_ITEMS - 1) {
+                    $li = $this->createMenuItem($item, $key);
+                    $ul->add($li);
+                }
+            }
+        }
+
+        $flyoutContent->add($ul);
+        $moreFlyout->add($flyoutContent);
+    }
+
+    protected function createMenuItem($item, $key)
+    {
+        if (in_array($key, self::EXCLUDED_ITEMS)) {
+            return null;
+        }
+
+        if (isset($item->permission) && ! Auth::getInstance()->hasPermission($item->permission)) {
+            return null;
+        }
+
+        $class = $item->getCssClass() .
+            ' '.
+            ($item->getActive() ? ' active' : '') .
+            ' ' .
+            ($item->getSelected() ? ' selected' : '');
+
+        $menuItem = HtmlElement::create(
+            'li',
+            ['class' => $class],
+            [
+                HtmlElement::create('a', [
+                    'href' => $item->getUrl(),
+                ], [
+                    $this->createNavItemIcon($item),
+                    Text::create($item->getLabel())
+                ])
+            ]
+        );
+
+        return $menuItem;
+    }
+
+    protected function getValidItemCount()
+    {
+        $count = 0;
+        foreach ($this->items as $key => $item) {
+            if ($this->isValidItem($key, $item)) {
+                $count++;
+            }
+        }
+
+        return $count;
+    }
+
+    protected function isValidItem($key, $item)
+    {
+        if (in_array($key, self::EXCLUDED_ITEMS) || !($item->hasChildren())) {
+            if ($key === 'dashboard') {
+                return true;
+            }
+            return false;
+        }
+        return true;
+    }
+
+    protected function assemble()
+    {
+        $ul = new HtmlElement('ul', Attributes::create(['class' => 'nav nav-level-1']));
+        $validItemCount = $this->getValidItemCount();
+
+        $count = 0;
+        foreach ($this->items as $key => $item) {
+            if ($this->isValidItem($key, $item)) {
+                $count++;
+
+                if ($validItemCount == self::MAX_NUM_OF_ITEMS && $count == self::MAX_NUM_OF_ITEMS) {
+                    $ul->add($this->createMenuItem($item, $key));
+                    break;
+                }
+
+                if ($count > self::MAX_NUM_OF_ITEMS - 1) {
+                    $ul->add($this->createMoreItem());
+                    break;
+                }
+
+                $ul->add($this->createMenuItem($item, $key));
+            }
+        }
+
+        $this->add($ul);
+    }
+}