Skip to content

Provide integration for Icinga Notifications Web #1289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 28, 2025
Merged

Provide integration for Icinga Notifications Web #1289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e906b1d
ObjectSuggestions: Allow to use a fixed set of columns
nilmerg Oct 24, 2025
0a3b0b9
Introduce new route `icingadb/suggest/restriction-column`
nilmerg Oct 24, 2025
a0c9f03
Provide integration for Icinga Notifications Web
nilmerg Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions application/controllers/SuggestController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?php

/* Icinga DB Web | (c) 2025 Icinga GmbH | GPLv2 */

namespace Icinga\Module\Icingadb\Controllers;

use Icinga\Module\Icingadb\Model\Host;
use Icinga\Module\Icingadb\Model\Service;
use Icinga\Module\Icingadb\ProvidedHook\Notifications\V1\Source;
use Icinga\Module\Icingadb\Web\Control\SearchBar\ObjectSuggestions;
use ipl\Web\Compat\CompatController;

class SuggestController extends CompatController
{
public function restrictionColumnAction(): void
{
$suggestions = (new ObjectSuggestions())
->setModel(
match ($this->params->getRequired('type')) {
'host', Source::TYPE_ALL => Host::class,
'service' => Service::class,
default => $this->httpBadRequest('Invalid type')
}
)
->onlyWithCustomVarSources(['host', 'service'])
->withFixedColumns([
'host.name' => $this->translate('Host Name'),
'hostgroup.name' => $this->translate('Hostgroup Name'),
'host.user.name' => $this->translate('Contact Name'),
'host.usergroup.name' => $this->translate('Contactgroup Name'),
'service.name' => $this->translate('Service Name'),
'servicegroup.name' => $this->translate('Servicegroup Name'),
'service.user.name' => $this->translate('Contact Name'),
'service.usergroup.name' => $this->translate('Contactgroup Name')
]);

$this->getDocument()->addHtml(
$suggestions->forRequest($this->getServerRequest())
);
}
}
207 changes: 207 additions & 0 deletions library/Icingadb/ProvidedHook/Notifications/V1/Source.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
<?php

/* Icinga DB Web | (c) 2025 Icinga GmbH | GPLv2 */

namespace Icinga\Module\Icingadb\ProvidedHook\Notifications\V1;

use Icinga\Application\Logger;
use Icinga\Exception\ConfigurationError;
use Icinga\Module\Icingadb\Common\Backend;
use Icinga\Module\Icingadb\Model\Host;
use Icinga\Module\Icingadb\Model\Service;
use Icinga\Module\Notifications\Hook\V1\SourceHook;
use InvalidArgumentException;
use ipl\Html\Attributes;
use ipl\Html\Contract\Form;
use ipl\Html\HtmlDocument;
use ipl\Html\HtmlElement;
use ipl\Html\Text;
use ipl\I18n\Translation;
use ipl\Sql\Expression;
use ipl\Stdlib\Filter;
use ipl\Stdlib\Filter\Condition;
use ipl\Web\Control\SearchBar\SearchException;
use ipl\Web\Control\SearchEditor;
use ipl\Web\Filter\QueryString;
use ipl\Web\Filter\Renderer;
use ipl\Web\Url;
use ipl\Web\Widget\IcingaIcon;
use ipl\Web\Widget\Icon;
use JsonException;

class Source implements SourceHook
{
use Translation;

/** @var string */
public const TYPE_ALL = 'all';

/** @var array<string, string> */
private array $allowedColumns;

public function __construct()
{
$this->allowedColumns = [
'host.name' => $this->translate('Host Name'),
'hostgroup.name' => $this->translate('Hostgroup Name'),
'host.user.name' => $this->translate('Contact Name'),
'host.usergroup.name' => $this->translate('Contactgroup Name'),
'service.name' => $this->translate('Service Name'),
'servicegroup.name' => $this->translate('Servicegroup Name'),
'service.user.name' => $this->translate('Contact Name'),
'service.usergroup.name' => $this->translate('Contactgroup Name')
];
}

public function getSourceType(): string
{
return 'icinga2';
}

public function getSourceLabel(): string
{
return 'Icinga';
}

public function getSourceIcon(): Icon
{
return new IcingaIcon('icinga');
}

public function getRuleFilterTargets(int $sourceId): array
{
return [
'host' => $this->translate('Hosts only'),
'service' => $this->translate('Services only'),
self::TYPE_ALL => $this->translate('Hosts and Services')
];
}

public function getRuleFilterEditor(string $filter): SearchEditor
{
if ($filter === 'host' || $filter === 'service' || $filter === self::TYPE_ALL) {
$type = $filter;
$filter = '';
} else {
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 ($data['version'] !== 1 || ! isset($data['config']['type']) || ! isset($data['config']['filter'])) {
Logger::error('Invalid rule filter configuration: %s', $filter);
throw new ConfigurationError($this->translate(
'Invalid rule filter configuration. Please contact your system administrator.'
));
}

$type = $data['config']['type'];
$filter = $data['config']['filter'];
}

$editor = new SearchEditor();
$editor->setQueryString($filter);
$editor->setSuggestionUrl(Url::fromPath(
'icingadb/suggest/restriction-column',
['_disableLayout' => true, 'showCompact' => true, 'type' => $type]
));
$editor->getParser()->on(QueryString::ON_CONDITION, function (Condition $condition) {
if ($condition->getColumn()) {
if (array_key_exists($condition->getColumn(), $this->allowedColumns)) {
$condition->metaData()->set('columnLabel', $this->allowedColumns[$condition->getColumn()]);
} elseif (preg_match('/^(host|service)\.vars\.(.*)/i', $condition->getColumn(), $m)) {
$prefix = $m[1] === 'host' ? $this->translate('Host') : $this->translate('Service');
$condition->metaData()->set('columnLabel', $prefix . ' ' . $m[2]);
}
}
});
$editor->on(SearchEditor::ON_VALIDATE_COLUMN, function (Condition $condition) {
if (! array_key_exists($condition->getColumn(), $this->allowedColumns)) {
if (! preg_match('/^(?:host|service)\.vars\./i', $condition->getColumn())) {
throw new SearchException($this->translate('Is not a valid column'));
}
}
})->on(HtmlDocument::ON_ASSEMBLED, function (SearchEditor $editor) use ($type) {
$editor->prependHtml(new HtmlElement(
'p',
Attributes::create(['class' => 'description']),
Text::create(
match ($type) {
'host' => $this->translate(
'Only hosts matching the following criteria will be affected.'
),
'service' => $this->translate(
'Only services matching the following criteria will be affected.'
),
self::TYPE_ALL => $this->translate(
'All hosts and services matching the following criteria will be affected.'
)
}
)
));

// Not using addElement, as otherwise the submit button is hidden because it's not last-of-type
$hidden = $editor->createElement('hidden', 'type', ['value' => $type]);
$editor->registerElement($hidden);
$editor->prependHtml($hidden);
});

return $editor;
}

public function serializeRuleFilter(Form $editor): string
{
if (! $editor instanceof SearchEditor) {
throw new InvalidArgumentException('Editor must be an instance of ' . SearchEditor::class);
}

$rule = $editor->getFilter();
$filter = (new Renderer($rule))->render();
if ($filter === '') {
return '';
}

$type = $editor->getElement('type')->getValue();

$queries = [];
if ($type === 'host' || $type === self::TYPE_ALL) {
$queries['host'] = Host::on(Backend::getDb())
->filter(Filter::all(
Filter::equal('host.id', ':host_id'),
Filter::equal('host.environment_id', ':environment_id')
));
}

if ($type === 'service' || $type === self::TYPE_ALL) {
$queries['service'] = Service::on(Backend::getDb())
->filter(Filter::all(
Filter::equal('service.id', ':service_id'),
Filter::equal('service.environment_id', ':environment_id')
));
}

return json_encode([
'version' => 1,
'config' => [
'type' => $type,
'filter' => $filter
],
'queries' => array_map(function ($query) use ($rule) {
$query->columns([new Expression('1')])->filter($rule)->limit(1);

[$query, $parameters] = $query->getDb()->getQueryBuilder()->assembleSelect(
$query->assembleSelect()->resetOrderBy()
);

return [
'query' => $query,
'parameters' => $parameters
];
}, $queries)
], JSON_THROW_ON_ERROR);
}
}
22 changes: 20 additions & 2 deletions library/Icingadb/Web/Control/SearchBar/ObjectSuggestions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ class ObjectSuggestions extends Suggestions
/** @var array */
protected $customVarSources;

/** @var ?array<string, string> */
protected ?array $fixedColumns = null;

public function __construct()
{
$this->customVarSources = [
Expand Down Expand Up @@ -154,7 +157,7 @@ protected function fetchValueSuggestions($column, $searchTerm, Filter\Chain $sea
if (strpos($column, ' ') !== false) {
// $column may be a label
list($path, $_) = Seq::find(
self::collectFilterColumns($query->getModel(), $query->getResolver()),
$this->fixedColumns ?? self::collectFilterColumns($query->getModel(), $query->getResolver()),
$column,
false
);
Expand Down Expand Up @@ -269,7 +272,8 @@ protected function fetchColumnSuggestions($searchTerm)
// Ordinary columns comes after exact matches,
// or if there ar no exact matches they come first
$titleAdded = false;
foreach (self::collectFilterColumns($model, $query->getResolver()) as $columnName => $columnMeta) {
$columns = $this->fixedColumns ?? self::collectFilterColumns($query->getModel(), $query->getResolver());
foreach ($columns as $columnName => $columnMeta) {
if ($this->matchSuggestion($columnName, $columnMeta, $searchTerm)) {
if ($titleAdded === false) {
$this->addHtml(HtmlElement::create(
Expand Down Expand Up @@ -518,4 +522,18 @@ public function onlyWithCustomVarSources(array $relations): self

return $this;
}

/**
* Provide suggestions based on a fixed set of columns
*
* @param array<string, string> $columns
*
* @return $this
*/
public function withFixedColumns(array $columns): static
{
$this->fixedColumns = $columns;

return $this;
}
}
4 changes: 4 additions & 0 deletions run.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
$this->provideHook('Reporting/Report', 'Reporting/ServiceSlaReport');
$this->provideHook('Reporting/Report', 'Reporting/TotalServiceSlaReport');

if ($this::exists('notifications')) {
$this->provideHook('Notifications/v1/Source');
}

if ($this::exists('reporting')) {
$this->provideHook('Icingadb/HostActions', 'CreateHostSlaReport');
$this->provideHook('Icingadb/ServiceActions', 'CreateServiceSlaReport');
Expand Down
Loading