Decouple incident rendering from source integrations

application/controllers/IncidentsController.php

@@ -7,24 +7,25 @@
 
 use Icinga\Module\Notifications\Common\Auth;
 use Icinga\Module\Notifications\Common\Database;
-use Icinga\Module\Notifications\Hook\ObjectsRendererHook;
 use Icinga\Module\Notifications\Model\Incident;
 use Icinga\Module\Notifications\View\IncidentRenderer;
 use Icinga\Module\Notifications\Web\Control\SearchBar\ObjectSuggestions;
 use Icinga\Module\Notifications\Widget\ItemList\ObjectList;
+use ipl\Web\Common\Controls;
 use ipl\Web\Compat\CompatController;
 use ipl\Web\Compat\SearchControls;
 use ipl\Web\Control\LimitControl;
 use ipl\Web\Control\SortControl;
 use ipl\Web\Filter\QueryString;
+use ipl\Web\Layout\DetailedItemLayout;
+use ipl\Web\Layout\ItemLayout;
 use ipl\Web\Layout\MinimalItemLayout;
-use ipl\Web\Widget\ItemList;
-use ipl\Web\Widget\ListItem;
 
 class IncidentsController extends CompatController
 {
     use Auth;
     use SearchControls;
+    use Controls;
 
     public function indexAction(): void
     {
@@ -45,11 +46,15 @@ public function indexAction(): void
         );
 
         $paginationControl = $this->createPaginationControl($incidents);
+        $viewModeSwitcher = $this->createViewModeSwitcher($this->params);
         $searchBar = $this->createSearchBar($incidents, [
             $limitControl->getLimitParam(),
             $sortControl->getSortParam(),
         ]);
 
+        $this->applyViewModeLimit($limitControl, $paginationControl);
+        $this->handleControls($this->getServerRequest());
+
         if ($searchBar->hasBeenSent() && ! $searchBar->isValid()) {
             if ($searchBar->hasBeenSubmitted()) {
                 $filter = QueryString::parse((string) $this->params);
@@ -68,18 +73,17 @@ public function indexAction(): void
         $this->addControl($paginationControl);
         $this->addControl($sortControl);
         $this->addControl($limitControl);
+        $this->addControl($viewModeSwitcher);
         $this->addControl($searchBar);
 
-        $incidentList = (new ObjectList($incidents, new IncidentRenderer()))
-            ->setItemLayoutClass(MinimalItemLayout::class)
-            ->on(ItemList::ON_ITEM_ADD, function (ListItem $item, Incident $data) {
-                ObjectsRendererHook::register($data->object);
-            })
-            ->on(ItemList::ON_ASSEMBLED, function () {
-                ObjectsRendererHook::load();
-            });
-
-        $this->addContent($incidentList);
+        $this->addContent(
+            (new ObjectList($incidents, new IncidentRenderer()))
+                ->setItemLayoutClass(match ($viewModeSwitcher->getViewMode()) {
+                    'minimal' => MinimalItemLayout::class,
+                    'detailed' => DetailedItemLayout::class,
+                    'common' => ItemLayout::class
+                })
+        );
 
         if (! $searchBar->hasBeenSubmitted() && $searchBar->hasBeenSent()) {
             $this->sendMultipartUpdate();

doc/03-Configuration.md

@@ -36,6 +36,21 @@ If you just installed Icinga Notifications Web, remember to activate it on your
 | notifications/view/contacts      | Allow to view contacts                         |
 | notifications/api                | Allow to modify configuration via API          |
 
+## General Configuration
+
+There is currently one configurable option: the maximum number of characters of the incident
+message shown in the incident detail view (default: 10000). It cannot be adjusted in the UI
+directly, but has to be set in the configuration file `/etc/icingaweb2/modules/notifications/config.ini`.
+
+### Example
+
+Setting the incident message character limit to 2500.
+
+```
+[settings]
+incident_message_character_limit = 2500
+```
+
 ## Database Configuration
 
 Connection configuration for the database, which both,

library/Notifications/Daemon/Daemon.php

@@ -8,7 +8,6 @@
 use Evenement\EventEmitter;
 use Icinga\Application\Logger;
 use Icinga\Module\Notifications\Common\Database;
-use Icinga\Module\Notifications\Hook\ObjectsRendererHook;
 use Icinga\Module\Notifications\Model\BrowserSession;
 use Icinga\Module\Notifications\Model\Daemon\Connection;
 use Icinga\Module\Notifications\Model\Daemon\Event;
@@ -263,7 +262,6 @@ protected function processNotifications(): void
         $notificationsToProcess = [];
         foreach ($notifications as $notification) {
             if ($notification->contact_id !== null && isset($connections[$notification->contact_id])) {
-                ObjectsRendererHook::register($notification->incident->object);
                 $notificationsToProcess[] = $notification;
 
                 ++$numOfNotifications;
@@ -273,8 +271,6 @@ protected function processNotifications(): void
         }
 
         if ($numOfNotifications > 0) {
-            ObjectsRendererHook::load(false);
-
             foreach ($notificationsToProcess as $notification) {
                 /** @var Incident $incident */
                 $incident = $notification->incident;
@@ -286,7 +282,7 @@ protected function processNotifications(): void
                         (object) [
                             'incident_id' => $notification->incident_id,
                             'severity'    => $incident->severity->getValue(),
-                            'title'       => ObjectsRendererHook::getObjectNameAsString($incident->object),
+                            'title'       => $incident->object->name,
                             'message'     => $notification->message
                         ]
                     )

library/Notifications/Hook/ObjectsRendererHook.php

@@ -8,6 +8,7 @@
 use Generator;
 use Icinga\Application\Hook;
 use Icinga\Application\Logger;
+use Icinga\Module\Notifications\Hook\V2\SourceHook;
 use Icinga\Module\Notifications\Model\Objects;
 use ipl\Html\Attributes;
 use ipl\Html\BaseHtmlElement;
@@ -20,6 +21,9 @@
 
 /**
  * Base hook to prepare and render objects
+ *
+ * @deprecated For object name, use the db column `object.name`. To create object link, use
+ * {@see SourceHook::createObjectLink()} instead.
  */
 abstract class ObjectsRendererHook
 {

library/Notifications/Hook/V2/SourceHook.php

@@ -5,6 +5,7 @@
 
 namespace Icinga\Module\Notifications\Hook\V2;
 
+use ipl\Html\ValidHtml;
 use ipl\Stdlib\Filter\Chain;
 use ipl\Stdlib\Filter\Condition;
 use ipl\Web\Control\SearchBar\SearchException;
@@ -79,4 +80,13 @@ public function getValueSuggestions(string $column, string $searchTerm, Chain $s
      * @return Traversable Provider for {@see SearchSuggestions::__construct}
      */
     public function getColumnSuggestions(string $searchTerm): Traversable;
+
+    /**
+     * Create the object link using the given ID tags
+     *
+     * @param array $idTags
+     *
+     * @return ?ValidHtml
+     */
+    public function createObjectLink(array $idTags): ?ValidHtml;
 }

library/Notifications/Model/Incident.php

@@ -27,6 +27,7 @@
  * @property ?DateTime $recovered_at
  * @property Severity $severity
  * @property ?string $mute_reason
+ * @property ?string $message
  *
  * @property Query|Objects $object
  * @property Query|Contact $contact
@@ -54,7 +55,8 @@ public function getColumns(): array
             'started_at',
             'recovered_at',
             'severity',
-            'mute_reason'
+            'mute_reason',
+            'message'
         ];
     }
 
@@ -65,7 +67,8 @@ public function getColumnDefinitions(): array
             'started_at'   => t('Started At'),
             'recovered_at' => t('Recovered At'),
             'severity'     => t('Severity'),
-            'mute_reason'  => t('Mute Reason')
+            'mute_reason'  => t('Mute Reason'),
+            'message'      => t('Message')
         ];
     }
 

library/Notifications/Model/Objects.php

@@ -6,9 +6,7 @@
 namespace Icinga\Module\Notifications\Model;
 
 use Icinga\Module\Notifications\Common\Model;
-use Icinga\Module\Notifications\Hook\ObjectsRendererHook;
 use Icinga\Module\Notifications\Model\Behavior\IdTagAggregator;
-use ipl\Html\ValidHtml;
 use ipl\Orm\Behavior\Binary;
 use ipl\Orm\Behaviors;
 use ipl\Orm\Query;
@@ -79,9 +77,4 @@ public function createRelations(Relations $relations): void
 
         $relations->belongsTo('source', Source::class)->setJoinType('LEFT');
     }
-
-    public function getName(): ValidHtml
-    {
-        return ObjectsRendererHook::getObjectName($this);
-    }
 }