Handle rule filter serialization

BastianLedererIcinga · BastianLedererIcinga · commit b8a38fcc5a3a · 2026-04-28T10:02:32.000+02:00
Introduce `RuleSerializer` to create Json from a configured filter.

Introduce `Icinga\Module\Notifications\Hook\V2` which no longer requires
`serializeRuleFilter()` and `getRuleFilterTargets()` as they are now obsolete.

Adjust `EventRuleController` to skip target selection use the new `RuleSerializer`.
diff --git a/application/controllers/EventRuleController.php b/application/controllers/EventRuleController.php
@@ -7,27 +7,29 @@
 
 use Icinga\Application\Hook;
 use Icinga\Application\Logger;
+use Icinga\Exception\ConfigurationError;
 use Icinga\Exception\Http\HttpNotFoundException;
 use Icinga\Module\Notifications\Common\Auth;
 use Icinga\Module\Notifications\Common\Database;
 use Icinga\Module\Notifications\Common\Links;
 use Icinga\Module\Notifications\Forms\EventRuleConfigElements\NotificationConfigProvider;
 use Icinga\Module\Notifications\Forms\EventRuleConfigForm;
 use Icinga\Module\Notifications\Forms\EventRuleForm;
-use Icinga\Module\Notifications\Hook\V1\SourceHook;
+use Icinga\Module\Notifications\Hook\V2\SourceHook;
 use Icinga\Module\Notifications\Model\Rule;
 use Icinga\Module\Notifications\Model\Source;
+use Icinga\Module\Notifications\Util\RuleSerializer;
 use Icinga\Module\Notifications\Web\Control\SearchBar\ExtraTagSuggestions;
 use Icinga\Web\Notification;
 use Icinga\Web\Session;
 use ipl\Html\Contract\Form;
 use ipl\Html\Html;
 use ipl\Stdlib\Filter;
 use ipl\Web\Compat\CompatController;
-use ipl\Web\Compat\CompatForm;
 use ipl\Web\Url;
 use ipl\Web\Widget\Icon;
 use ipl\Web\Widget\Link;
+use JsonException;
 use Psr\Http\Message\ServerRequestInterface;
 use Throwable;
 
@@ -217,7 +219,7 @@ public function searchEditorAction(): void
         }
 
         $hook = null;
-        foreach (Hook::all('Notifications/v1/Source') as $h) {
+        foreach (Hook::all('Notifications/v2/Source') as $h) {
             /** @var SourceHook $h */
             try {
                 if ($h->getSourceType() === $source->type) {
@@ -237,50 +239,37 @@ public function searchEditorAction(): void
             ), $source->type));
         }
 
-        if (! $filter) {
-            $targets = $hook->getRuleFilterTargets($source->id);
-            if (count($targets) === 1 && ! is_array(reset($targets))) {
-                $filter = key($targets);
-            } else {
-                $target = null;
-                $form = (new CompatForm())
-                    ->applyDefaultElementDecorators()
-                    ->setAction(Url::fromRequest()->getAbsoluteUrl())
-                    ->addElement('select', 'target', [
-                        'required' => true,
-                        'label' => $this->translate('Filter Target'),
-                        'options' => ['' => ' - ' . $this->translate('Please choose') . ' - '] + $targets,
-                        'disabledOptions' => ['']
-                    ])
-                    ->addElement('submit', 'btn_submit', [
-                        // translators: shown on a submit button to proceed to the next step of a form wizard
-                        'label' => $this->translate('Next')
-                    ])
-                    ->on(Form::ON_SUBMIT, function (CompatForm $form) use (&$target) {
-                        $target = $form->getValue('target');
-                    })
-                    ->handleRequest($this->getServerRequest());
-
-                if ($target !== null) {
-                    $filter = $target;
-                } else {
-                    $this->addContent($form);
-                }
+        $queryStr = '';
+        if ($filter) {
+            try {
+                $data = json_decode($filter, true, flags: JSON_THROW_ON_ERROR);
+            } catch (JsonException $e) {
+                Logger::error('Failed to parse rule filter configuration: %s (Error: %s)', $filter, $e);
+                throw new ConfigurationError($this->translate(
+                    'Failed to parse rule filter configuration. Please contact your system administrator.'
+                ));
             }
-        }
 
-        if ($filter) {
-            $form = $hook->getRuleFilterEditor($filter)
-                ->setAction(Url::fromRequest()->with('object_filter', $filter)->getAbsoluteUrl())
-                ->on(Form::ON_SUBMIT, function (Form $form) use ($ruleId, $hook) {
-                    $this->session->set('object_filter', $hook->serializeRuleFilter($form));
-                    $this->redirectNow(Links::eventRule($ruleId)->setParam('_filterOnly'));
-                })
-                ->handleRequest($this->getServerRequest());
-
-            $this->getDocument()->addHtml($form);
+            if (! isset($data['filter']) || $data['version'] !== 2) {
+                Logger::error('Invalid rule filter configuration: %s', $filter);
+                throw new ConfigurationError($this->translate(
+                    'Invalid rule filter configuration. Please contact your system administrator.'
+                ));
+            }
+
+            $queryStr = $data['filter'];
         }
 
+        $form = $hook->getRuleFilterEditor($queryStr)
+            ->setAction(Url::fromRequest()->with('object_filter', $filter)->getAbsoluteUrl())
+            ->on(Form::ON_SUBMIT, function (Form $form) use ($ruleId, $hook) {
+                $this->session->set('object_filter', (new RuleSerializer($form->getFilter()))->getJson());
+                $this->redirectNow(Links::eventRule($ruleId)->setParam('_filterOnly'));
+            })
+            ->handleRequest($this->getServerRequest());
+
+        $this->getDocument()->addHtml($form);
+
         $this->setTitle($this->translate('Adjust Filter'));
     }
 
diff --git a/application/forms/SourceForm.php b/application/forms/SourceForm.php
@@ -9,7 +9,7 @@
 use Icinga\Application\Hook;
 use Icinga\Application\Logger;
 use Icinga\Exception\Http\HttpNotFoundException;
-use Icinga\Module\Notifications\Hook\V1\SourceHook;
+use Icinga\Module\Notifications\Hook\V2\SourceHook;
 use Icinga\Module\Notifications\Model\Source;
 use ipl\Html\Attributes;
 use ipl\Html\HtmlDocument;
diff --git a/library/Notifications/Hook/V2/SourceHook.php b/library/Notifications/Hook/V2/SourceHook.php
@@ -0,0 +1,45 @@
+<?php
+
+// SPDX-FileCopyrightText: 2026 Icinga GmbH <https://icinga.com>
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+namespace Icinga\Module\Notifications\Hook\V2;
+
+use ipl\Html\Contract\Form;
+use ipl\Web\Widget\Icon;
+
+interface SourceHook
+{
+    /**
+     * Get the type of source this integration is responsible for
+     *
+     * @return string
+     */
+    public function getSourceType(): string;
+
+    /**
+     * Get the label of the source this integration is responsible for
+     *
+     * @return string
+     */
+    public function getSourceLabel(): string;
+
+    /**
+     * Get the icon of the source this integration is responsible for
+     *
+     * @return Icon
+     */
+    public function getSourceIcon(): Icon;
+
+    /**
+     * Get an editor for the given filter
+     *
+     * The returned form MUST NOT have a request associated with it and MUST NOT navigate away upon submission.
+     * The action of the form is overridden in any case.
+     *
+     * @param string $filter The query filter
+     *
+     * @return Form
+     */
+    public function getRuleFilterEditor(string $filter): Form;
+}
diff --git a/library/Notifications/Model/Source.php b/library/Notifications/Model/Source.php
@@ -8,7 +8,7 @@
 use DateTime;
 use Icinga\Application\Hook;
 use Icinga\Application\Logger;
-use Icinga\Module\Notifications\Hook\V1\SourceHook;
+use Icinga\Module\Notifications\Hook\V2\SourceHook;
 use ipl\Orm\Behavior\BoolCast;
 use ipl\Orm\Behavior\MillisecondTimestamp;
 use ipl\Orm\Behaviors;
diff --git a/library/Notifications/Util/RuleSerializer.php b/library/Notifications/Util/RuleSerializer.php
@@ -0,0 +1,104 @@
+<?php
+
+// SPDX-FileCopyrightText: 2026 Icinga GmbH <https://icinga.com>
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+namespace Icinga\Module\Notifications\Util;
+
+use Icinga\Util\Json;
+use ipl\Stdlib\Filter;
+use ipl\Stdlib\Filter\Chain;
+use ipl\Web\Filter\Renderer;
+
+class RuleSerializer
+{
+    protected Filter\Rule $filter;
+
+    /**
+     * Create an object that can be used to serialize a rule to JSON
+     *
+     * @param Filter\Rule $filter
+     */
+    public function __construct(Filter\Rule $filter)
+    {
+        $this->filter = $filter;
+    }
+
+    /**
+     * Serialize the filter as Json
+     *
+     * @return string
+     *
+     * @throws \Icinga\Exception\Json\JsonEncodeException
+     */
+    public function getJson(): string
+    {
+        $queryString = (new Renderer($this->filter))->render();
+        $result = [];
+        $result['version'] = 2;
+        $result['filter'] = $queryString;
+        if ($this->filter instanceof Filter\Chain) {
+            $result['json'] = $this->serializeChain($this->filter);
+        } else {
+            /** @var Filter\Condition $this->filter */
+            $result['json'] = $this->serializeCondition($this->filter);
+        }
+
+        return Json::encode($result);
+    }
+
+    /**
+     * Create an array with keys `op` and `rules` from a chain
+     *
+     * @param Chain $chain
+     *
+     * @return array{op: string, rules: array}
+     */
+    protected function serializeChain(Chain $chain): array
+    {
+        $result = [
+            'op' => match (true) {
+                $chain instanceof Filter\All => '&',
+                $chain instanceof Filter\None => '!',
+                $chain instanceof Filter\Any => '|'
+            }
+        ];
+
+        $rules = [];
+        foreach ($chain as $rule) {
+            if ($rule instanceof Chain) {
+                $rules[] = $this->serializeChain($rule);
+            } else {
+                $rules[] = $this->serializeCondition($rule);
+            }
+        }
+
+        $result['rules'] = $rules;
+        return $result;
+    }
+
+    /**
+     * Create an array with the keys `op`, `column` and `value` from a condition
+     *
+     * @param Filter\Condition $condition
+     *
+     * @return array{op: string, column: string, value: mixed}
+     */
+    protected function serializeCondition(Filter\Condition $condition): array
+    {
+        return [
+            'op' => match (true) {
+                $condition instanceof Filter\Unlike => '!~',
+                $condition instanceof Filter\Unequal => '!=',
+                $condition instanceof Filter\Like => '~',
+                $condition instanceof Filter\Equal => '=',
+                $condition instanceof Filter\GreaterThan => '>',
+                $condition instanceof Filter\LessThan => '<',
+                $condition instanceof Filter\GreaterThanOrEqual => '>=',
+                $condition instanceof Filter\LessThanOrEqual => '<=',
+            },
+            'column' => $condition->getColumn(),
+            'value' => $condition->getValue(),
+        ];
+    }
+}
