Allow adding and editing of dashlet description.

raviks789 · raviks789 · commit e362ae6c511e · 2022-06-10T12:12:07.000+02:00
diff --git a/application/forms/Dashboard/DashletForm.php b/application/forms/Dashboard/DashletForm.php
@@ -31,7 +31,8 @@ public function load(BaseDashboard $dashboard)
             'org_pane'    => $dashboard->getPane()->getName(),
             'org_dashlet' => $dashboard->getName(),
             'dashlet'     => $dashboard->getTitle(),
-            'url'         => $dashboard->getUrl()->getRelativeUrl()
+            'url'         => $dashboard->getUrl()->getRelativeUrl(),
+            'description' => $dashboard->getDescription(),
         ]);
     }
 
@@ -184,6 +185,7 @@ protected function onSuccess()
             $customDashlet = null;
             if (($dashlet = $this->getPopulatedValue('dashlet')) && ($url = $this->getPopulatedValue('url'))) {
                 $customDashlet = new Dashlet($dashlet, $url, $currentPane);
+                $customDashlet->setDescription($this->getPopulatedValue('description'));
 
                 if ($currentPane->hasEntry($customDashlet->getName()) || $this->customDashletAlreadyExists) {
                     if ($this->customDashletAlreadyExists) {
@@ -265,11 +267,14 @@ protected function onSuccess()
                 $orgHome->setEntries([]);
             }
 
+            /** @var Dashlet $currentDashlet */
             $currentDashlet = clone $orgDashlet;
             $currentDashlet
                 ->setPane($currentPane)
                 ->setUrl($this->getValue('url'))
-                ->setTitle($this->getValue('dashlet'));
+                ->setTitle($this->getValue('dashlet'))
+                ->setDescription($this->getValue('description'));
+
 
             if ($orgPane->getName() !== $currentPane->getName()
                 && $currentPane->hasEntry($currentDashlet->getName())) {
diff --git a/application/forms/Dashboard/SetupNewDashboardForm.php b/application/forms/Dashboard/SetupNewDashboardForm.php
@@ -43,7 +43,6 @@ protected function init()
 
     /**
      * Dump all module dashlets which are not selected by the user
-     * from the member variable
      *
      * @param bool $strict Whether to match populated of the dashlet against a 'y'
      *
@@ -59,12 +58,14 @@ protected function dumpArbitaryDashlets(bool $strict = true): void
                 if ($this->getPopulatedValue($element) === 'y' || (! $strict && $this->getPopulatedValue($element))) {
                     $title = $this->getPopulatedValue($element);
                     $url = $this->getPopulatedValue($element . '_url');
+                    $description = $this->getPopulatedValue($element . '_description');
 
                     if (! $strict && $title && $url) {
                         $dashlet
                             ->setUrl($url)
                             ->setName($title . '(' . $module . ')')
-                            ->setTitle($title);
+                            ->setTitle($title)
+                            ->setDescription($description);
                     }
 
                     $chosenDashlets[$module][$dashlet->getName()] = $dashlet;
@@ -187,6 +188,12 @@ protected function assembleNexPageDashletPart()
                             'Enter url to be loaded in the dashlet. You can paste the full URL, including filters'
                         )
                     ]);
+
+                    $this->addElement('textarea', $elementId . '_description', [
+                        'label'       => t('Description'),
+                        'value'       => $dashlet->getDescription(),
+                        'description' => t('Enter description for the dashlet')
+                    ]);
                 }
             }
         }
@@ -210,6 +217,12 @@ protected function assembleDashletElements()
                 'Enter url to be loaded in the dashlet. You can paste the full URL, including filters.'
             ),
         ]);
+
+        $this->addElement('textarea', 'description', [
+            'label'       => t('Description'),
+            'placeholder' => t('Enter dashlet description'),
+            'description' => t('Enter description for the dashlet'),
+        ]);
     }
 
     protected function assemble()
diff --git a/etc/schema/mysql-upgrades/2.11.0.sql b/etc/schema/mysql-upgrades/2.11.0.sql
@@ -57,6 +57,7 @@ CREATE TABLE `icingaweb_dashlet` (
     `url`           varchar(2048) NOT NULL COLLATE utf8mb4_bin,
     `priority`      tinyint NOT NULL,
     `disabled`      enum ('n', 'y') DEFAULT 'n',
+    `description`   text DEFAULT NULL COLLATE utf8mb4_unicode_ci,
     PRIMARY KEY (`id`),
     KEY `fk_dashlet_dashboard` (`dashboard_id`),
     CONSTRAINT `fk_dashlet_dashboard` FOREIGN KEY (`dashboard_id`)
diff --git a/etc/schema/mysql.schema.sql b/etc/schema/mysql.schema.sql
@@ -98,6 +98,7 @@ CREATE TABLE `icingaweb_dashlet` (
     `url`           varchar(2048) NOT NULL COLLATE utf8mb4_bin,
     `priority`      tinyint NOT NULL,
     `disabled`      enum ('n', 'y') DEFAULT 'n',
+    `description`   text DEFAULT NULL COLLATE utf8mb4_unicode_ci,
     PRIMARY KEY (`id`),
     KEY `fk_dashlet_dashboard` (`dashboard_id`),
     CONSTRAINT `fk_dashlet_dashboard` FOREIGN KEY (`dashboard_id`)
diff --git a/etc/schema/pgsql-upgrades/2.11.0.sql b/etc/schema/pgsql-upgrades/2.11.0.sql
@@ -88,7 +88,8 @@ CREATE TABLE "icingaweb_dashlet" (
   "label"         character varying(254) NOT NULL,
   "url"           character varying(2048) NOT NULL,
   "priority"      tinyuint NOT NULL,
-  "disabled"      boolenum DEFAULT 'n'
+  "disabled"      boolenum DEFAULT 'n',
+  "description"   text DEFAULT NULL
 );
 
 ALTER TABLE "icingaweb_dashlet" ALTER COLUMN "id" SET STORAGE PLAIN;
diff --git a/etc/schema/pgsql.schema.sql b/etc/schema/pgsql.schema.sql
@@ -210,7 +210,8 @@ CREATE TABLE "icingaweb_dashlet" (
   "label"         character varying(254) NOT NULL,
   "url"           character varying(2048) NOT NULL,
   "priority"      tinyuint NOT NULL,
-  "disabled"      boolenum DEFAULT 'n'
+  "disabled"      boolenum DEFAULT 'n',
+  "description"   text DEFAULT NULL
 );
 
 ALTER TABLE "icingaweb_dashlet" ALTER COLUMN "id" SET STORAGE PLAIN;
diff --git a/library/Icinga/Application/Modules/DashletManager.php b/library/Icinga/Application/Modules/DashletManager.php
@@ -160,7 +160,8 @@ public static function getDashlets(): array
                 ->setTitle($moduleDashlet->label)
                 ->setModuleDashlet(true)
                 ->setModule($moduleDashlet->module)
-                ->setPriority($moduleDashlet->priority);
+                ->setPriority($moduleDashlet->priority)
+                ->setDescription($moduleDashlet->description);
 
             if (! self::ensureItIsNotOrphaned($dashlet)) {
                 continue;
diff --git a/library/Icinga/Model/Dashlet.php b/library/Icinga/Model/Dashlet.php
@@ -31,7 +31,8 @@ public function getColumns()
             'label',
             'url',
             'priority',
-            'disabled'
+            'disabled',
+            'description'
         ];
     }
 
@@ -42,7 +43,8 @@ public function getMetaData()
             'name'         => t('Dashlet Name'),
             'label'        => t('Dashlet Title'),
             'url'          => t('Dashlet Url'),
-            'priority'     => t('Dashlet Order Priority')
+            'priority'     => t('Dashlet Order Priority'),
+            'description'  => t('Dashlet Description')
         ];
     }
 
diff --git a/library/Icinga/Test/fixtures.sql b/library/Icinga/Test/fixtures.sql
@@ -33,6 +33,7 @@ CREATE TABLE `icingaweb_dashlet` (
      `url`           VARCHAR NOT NULL,
      `priority`      tinyint NOT NULL,
      `disabled`      TEXT CHECK ( disabled IN ('n', 'y') ) DEFAULT 'n',
+     `description`   text DEFAULT NULL,
      FOREIGN KEY (`dashboard_id`) REFERENCES `icingaweb_dashboard` (`id`) ON DELETE CASCADE ON UPDATE CASCADE
 );
 
diff --git a/library/Icinga/Web/Dashboard/Dashlet.php b/library/Icinga/Web/Dashboard/Dashlet.php
@@ -252,12 +252,13 @@ public function toArray(bool $stringify = true): array
     {
         $pane = $this->getPane();
         return [
-            'id'       => $this->getUuid(),
-            'pane'     => ! $stringify ? $pane : ($pane ? $pane->getName() : null),
-            'name'     => $this->getName(),
-            'url'      => $this->getUrl()->getRelativeUrl(),
-            'label'    => $this->getTitle(),
-            'priority' => $this->getPriority(),
+            'id'           => $this->getUuid(),
+            'pane'         => ! $stringify ? $pane : ($pane ? $pane->getName() : null),
+            'name'         => $this->getName(),
+            'url'          => $this->getUrl()->getRelativeUrl(),
+            'label'        => $this->getTitle(),
+            'priority'     => $this->getPriority(),
+            'description'  => $this->getDescription()
         ];
     }
 }
diff --git a/library/Icinga/Web/Dashboard/Pane.php b/library/Icinga/Web/Dashboard/Pane.php
@@ -116,7 +116,7 @@ public function loadDashboardEntries(string $name = null)
                 ->setDisabled($dashlet->disabled)
                 ->setModule($dashlet->icingaweb_module_dashlet->module ?? '')
                 ->setModuleDashlet($dashlet->system_dashlet_id !== null)
-                ->setDescription($dashlet->icingaweb_module_dashlet->description);
+                ->setDescription($dashlet->description);
 
             $this->addEntry($newDashlet);
 
@@ -193,7 +193,8 @@ public function manageEntry($entryOrEntries, BaseDashboard $origin = null, bool
                     'label'        => $dashlet->getTitle(),
                     'url'          => $url,
                     'priority'     => $order++,
-                    'disabled'     => DBUtils::bool2BoolEnum($dashlet->isDisabled())
+                    'disabled'     => DBUtils::bool2BoolEnum($dashlet->isDisabled()),
+                    'description'  => $dashlet->getDescription()
                 ]);
 
                 if ($dashlet->isModuleDashlet()) {
@@ -233,7 +234,8 @@ public function manageEntry($entryOrEntries, BaseDashboard $origin = null, bool
                     'label'        => $dashlet->getTitle(),
                     'url'          => $url,
                     'priority'     => $moveDashlet ? $order++ : $dashlet->getPriority(),
-                    'disabled'     => DBUtils::bool2BoolEnum($dashlet->isDisabled())
+                    'disabled'     => DBUtils::bool2BoolEnum($dashlet->isDisabled()),
+                    'description'  => $dashlet->getDescription()
                 ], $filterCondition);
             } else {
                 // Failed to move the pane! Should have already been handled by the caller,
diff --git a/modules/monitoring/configuration.php b/modules/monitoring/configuration.php
@@ -351,6 +351,11 @@
     130
 );
 
+$this->provideDashlet(N_('My new Dashlet'), 'monitoring/list/hosts?host_problem=1&sort=host_severity', [
+    'priority' => 200,
+    'description' => 'This is my dashlet'
+]);
+
 /*
  * Muted Objects
  */

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,6 @@ protected function init()`
`43`	`43`
`44`	`44`	`/**`
`45`	`45`	`* Dump all module dashlets which are not selected by the user`
`46`		`- * from the member variable`
`47`	`46`	`*`
`48`	`47`	`* @param bool $strict Whether to match populated of the dashlet against a 'y'`
`49`	`48`	`*`
`@@ -59,12 +58,14 @@ protected function dumpArbitaryDashlets(bool $strict = true): void`
`59`	`58`	`if ($this->getPopulatedValue($element) === 'y' \|\| (! $strict && $this->getPopulatedValue($element))) {`
`60`	`59`	`$title = $this->getPopulatedValue($element);`
`61`	`60`	`$url = $this->getPopulatedValue($element . '_url');`
	`61`	`+ $description = $this->getPopulatedValue($element . '_description');`
`62`	`62`
`63`	`63`	`if (! $strict && $title && $url) {`
`64`	`64`	`$dashlet`
`65`	`65`	`->setUrl($url)`
`66`	`66`	`->setName($title . '(' . $module . ')')`
`67`		`- ->setTitle($title);`
	`67`	`+ ->setTitle($title)`
	`68`	`+ ->setDescription($description);`
`68`	`69`	`}`
`69`	`70`
`70`	`71`	`$chosenDashlets[$module][$dashlet->getName()] = $dashlet;`
`@@ -187,6 +188,12 @@ protected function assembleNexPageDashletPart()`
`187`	`188`	`'Enter url to be loaded in the dashlet. You can paste the full URL, including filters'`
`188`	`189`	`)`
`189`	`190`	`]);`
	`191`	`+`
	`192`	`+ $this->addElement('textarea', $elementId . '_description', [`
	`193`	`+ 'label' => t('Description'),`
	`194`	`+ 'value' => $dashlet->getDescription(),`
	`195`	`+ 'description' => t('Enter description for the dashlet')`
	`196`	`+ ]);`
`190`	`197`	`}`
`191`	`198`	`}`
`192`	`199`	`}`
`@@ -210,6 +217,12 @@ protected function assembleDashletElements()`
`210`	`217`	`'Enter url to be loaded in the dashlet. You can paste the full URL, including filters.'`
`211`	`218`	`),`
`212`	`219`	`]);`
	`220`	`+`
	`221`	`+ $this->addElement('textarea', 'description', [`
	`222`	`+ 'label' => t('Description'),`
	`223`	`+ 'placeholder' => t('Enter dashlet description'),`
	`224`	`+ 'description' => t('Enter description for the dashlet'),`
	`225`	`+ ]);`
`213`	`226`	`}`
`214`	`227`
`215`	`228`	`protected function assemble()`