From 3f4c0a8de6c8525c7f2bb5a964f3160162c110d0 Mon Sep 17 00:00:00 2001
From: Yonas Habteab <yonas.habteab@icinga.com>
Date: Fri, 20 May 2022 16:50:00 +0200
Subject: [PATCH] Forms: Introduce `PaneForm` class

---
 application/forms/Dashboard/PaneForm.php | 164 +++++++++++++++++++++++
 1 file changed, 164 insertions(+)
 create mode 100644 application/forms/Dashboard/PaneForm.php

diff --git a/application/forms/Dashboard/PaneForm.php b/application/forms/Dashboard/PaneForm.php
new file mode 100644
index 000000000..c5fb0fe04
--- /dev/null
+++ b/application/forms/Dashboard/PaneForm.php
@@ -0,0 +1,164 @@
+<?php
+
+/* Icinga Web 2 | (c) 2022 Icinga GmbH | GPLv2+ */
+
+namespace Icinga\Forms\Dashboard;
+
+use Icinga\Application\Logger;
+use Icinga\Web\Dashboard\Common\BaseDashboard;
+use Icinga\Web\Dashboard\DashboardHome;
+use Icinga\Util\DBUtils;
+use Icinga\Web\Dashboard\Pane;
+use Icinga\Web\Notification;
+use Icinga\Web\Dashboard\Dashboard;
+
+class PaneForm extends BaseDashboardForm
+{
+    protected function assemble()
+    {
+        $this->addElement('hidden', 'org_name', ['required' => false]);
+        $this->addElement('hidden', 'org_title', ['required' => false]);
+
+        $this->addElement('text', 'title', [
+            'required'    => true,
+            'label'       => t('Title'),
+            'placeholder' => t('Create new Dashboard'),
+            'description' => $this->isUpdating()
+                ? t('Edit the title of this dashboard pane.')
+                : t('Add new dashboard to this home.')
+        ]);
+
+        $homes = $this->dashboard->getEntryKeyTitleArr();
+        $activeHome = $this->dashboard->getActiveHome();
+        $populatedHome = $this->getPopulatedValue('home', $activeHome->getName());
+
+        $this->addElement('select', 'home', [
+            'required'     => true,
+            'class'        => 'autosubmit',
+            'value'        => $populatedHome,
+            'multiOptions' => array_merge([self::CREATE_NEW_HOME => self::CREATE_NEW_HOME], $homes),
+            'label'        => t('Assign to Home'),
+            'description'  => sprintf(
+                t('Select a dashboard home you want to %s the dashboard to.'),
+                $this->isUpdating() ? 'move' : 'assign'
+            ),
+        ]);
+
+        if (empty($homes) || $this->getPopulatedValue('home') === self::CREATE_NEW_HOME) {
+            $this->addElement('text', 'new_home', [
+                'required'    => true,
+                'label'       => t('Dashboard Home'),
+                'placeholder' => t('Enter dashboard home title'),
+                'description' => t('Enter a title for the new dashboard home.'),
+            ]);
+        }
+
+        $formControls = $this->createFormControls();
+        $formControls->addHtml(
+            $this->registerSubmitButton($this->isUpdating() ? t('Update Pane') : t('Add Dashboard'))
+        );
+
+        if ($this->isUpdating()) {
+            $removeTargetUrl = (clone $this->requestUrl)->setPath(Dashboard::BASE_ROUTE . '/remove-pane');
+            $formControls->addHtml($this->createRemoveButton($removeTargetUrl, t('Remove Pane')));
+        }
+
+        $formControls->addHtml($this->createCancelButton());
+        $this->addHtml($formControls);
+    }
+
+    protected function onSuccess()
+    {
+        $conn = DBUtils::getConn();
+        $dashboard = $this->dashboard;
+
+        $selectedHome = $this->getPopulatedValue('home');
+        if (! $selectedHome || $selectedHome === self::CREATE_NEW_HOME) {
+            $selectedHome = $this->getPopulatedValue('new_home');
+        }
+
+        $currentHome = new DashboardHome($selectedHome);
+        if ($dashboard->hasEntry($currentHome->getName())) {
+            /** @var DashboardHome $currentHome */
+            $currentHome = clone $dashboard->getEntry($currentHome->getName());
+            if ($currentHome->getName() !== $dashboard->getActiveHome()->getName()) {
+                $currentHome->loadDashboardEntries();
+            }
+        }
+
+        if ($this->isUpdating()) {
+            $orgHome = $dashboard->getEntry($this->requestUrl->getParam('home'));
+
+            $currentPane = clone $orgHome->getEntry($this->getValue('org_name'));
+            $currentPane
+                ->setHome($currentHome)
+                ->setTitle($this->getValue('title'));
+
+            if ($orgHome->getName() !== $currentHome->getName() && $currentHome->hasEntry($currentPane->getName())) {
+                Notification::error(sprintf(
+                    t('Failed to move dashboard "%s": Dashbaord pane already exists within the "%s" dashboard home'),
+                    $currentPane->getTitle(),
+                    $currentHome->getTitle()
+                ));
+
+                return;
+            }
+
+            if ($currentHome->getName() === $orgHome->getName()) {
+                // There is no dashboard home diff so clear all the dashboard pane
+                // of the org home
+                $orgHome->setEntries([]);
+            }
+
+            $conn->beginTransaction();
+
+            try {
+                $dashboard->manageEntry($currentHome);
+                $currentHome->manageEntry($currentPane, $orgHome);
+                // We have to update all the dashlet ids too sha1(username + home + pane + dashlet)
+                $currentPane->manageEntry($currentPane->getEntries());
+
+                $conn->commitTransaction();
+            } catch (\Exception $err) {
+                Logger::error($err);
+                $conn->rollBackTransaction();
+            }
+
+            Notification::success(sprintf(t('Updated dashboard pane "%s" successfully'), $currentPane->getTitle()));
+        } else {
+            $pane = new Pane($this->getPopulatedValue('title'));
+            if ($currentHome->hasEntry($pane->getName())) {
+                Notification::error(sprintf(
+                    t('Failed to create dashboard "%s": Dashbaord pane already exists within the "%s" dashboard home'),
+                    $pane->getTitle(),
+                    $currentHome->getTitle()
+                ));
+
+                return;
+            }
+
+            $conn->beginTransaction();
+
+            try {
+                $dashboard->manageEntry($currentHome);
+                $currentHome->manageEntry($pane);
+
+                $conn->commitTransaction();
+            } catch (\Exception $err) {
+                $conn->rollBackTransaction();
+                throw $err;
+            }
+
+            Notification::success(sprintf(t('Added dashboard pane "%s" successfully'), $pane->getName()));
+        }
+    }
+
+    public function load(BaseDashboard $dashboard)
+    {
+        $this->populate([
+            'org_title' => $dashboard->getTitle(),
+            'title'     => $dashboard->getTitle(),
+            'org_name'  => $dashboard->getName()
+        ]);
+    }
+}