Skip to content

Commit

Permalink
Add redundancy group detail view (#1079)
Browse files Browse the repository at this point in the history 
resolves #1056
  • Loading branch information
@nilmerg
nilmerg authored Nov 19, 2024
2 parents e96f2a4 + 3567a40 commit ae9002d
Show file tree
Hide file tree
Showing 16 changed files with 1,081 additions and 29 deletions.
354 changes: 354 additions & 0 deletions application/controllers/RedundancygroupController.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,354 @@
<?php

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

namespace Icinga\Module\Icingadb\Controllers;

use Icinga\Exception\NotFoundError;
use Icinga\Module\Icingadb\Common\CommandActions;
use Icinga\Module\Icingadb\Data\DependencyNodes;
use Icinga\Module\Icingadb\Model\DependencyNode;
use Icinga\Module\Icingadb\Model\RedundancyGroup;
use Icinga\Module\Icingadb\Model\RedundancyGroupSummary;
use Icinga\Module\Icingadb\Web\Control\SearchBar\ObjectSuggestions;
use Icinga\Module\Icingadb\Web\Control\ViewModeSwitcher;
use Icinga\Module\Icingadb\Web\Controller;
use Icinga\Module\Icingadb\Widget\Detail\MultiselectQuickActions;
use Icinga\Module\Icingadb\Widget\Detail\RedundancyGroupDetail;
use Icinga\Module\Icingadb\Widget\Detail\RedundancyGroupHeader;
use Icinga\Module\Icingadb\Widget\ItemList\DependencyNodeList;
use ipl\Html\HtmlElement;
use ipl\Html\Text;
use ipl\Orm\Query;
use ipl\Stdlib\Filter;
use ipl\Web\Control\LimitControl;
use ipl\Web\Control\SortControl;
use ipl\Web\Url;
use ipl\Web\Widget\Tabs;

class RedundancygroupController extends Controller
{
use CommandActions;

/** @var string */
protected $groupId;

/** @var RedundancyGroup */
protected $group;

/** @var RedundancyGroupSummary */
protected $groupSummary;

public function init(): void
{
// in case of quick actions, param id is not given
$groupId = $this->params->shift('child.redundancy_group.id');
if ($groupId === null) {
$groupId = $this->params->shiftRequired('id');
}

$this->groupId = $groupId;
}

/**
* Load the redundancy group
*/
protected function loadGroup(): void
{
$query = RedundancyGroup::on($this->getDb())
->with(['state'])
->filter(Filter::equal('id', $this->groupId));

$this->applyRestrictions($query);

$this->group = $query->first();

if ($this->group === null) {
$this->httpNotFound($this->translate('Redundancy Group not found'));
}

$this->setTitleTab($this->getRequest()->getActionName());
$this->setTitle($this->group->display_name);

$summary = RedundancyGroupSummary::on($this->getDb())
->filter(Filter::equal('id', $this->groupId));

$this->applyRestrictions($summary);

$this->groupSummary = $summary->first();

$this->addControl(new RedundancyGroupHeader($this->group, $this->groupSummary));
}

public function indexAction(): void
{
$this->loadGroup();

// The base filter is required to fetch the correct objects for MultiselectQuickActions::isGrantedOnType() check
$this->addControl(
(new MultiselectQuickActions('dependency_node', $this->groupSummary))
->setBaseFilter(Filter::equal('child.redundancy_group.id', $this->groupId))
->setAllowToProcessCheckResults(false)
->setColumnPrefix('nodes')
->setUrlPath('icingadb/redundancygroup')
);

$this->addContent(new RedundancyGroupDetail($this->group));
}

public function membersAction(): void
{
$this->loadGroup();
$nodesQuery = $this->fetchNodes(true);

$limitControl = $this->createLimitControl();
$paginationControl = $this->createPaginationControl($nodesQuery);
$sortControl = $this->createSortControl(
$nodesQuery,
[
'name' => $this->translate('Name'),
'severity desc, last_state_change desc' => $this->translate('Severity'),
'state' => $this->translate('Current State'),
'last_state_change desc' => $this->translate('Last State Change')
]
);
$viewModeSwitcher = $this->createViewModeSwitcher($paginationControl, $limitControl);

$searchBar = $this->createSearchBar(
$nodesQuery,
[
$limitControl->getLimitParam(),
$sortControl->getSortParam(),
$viewModeSwitcher->getViewModeParam(),
'id'
]
);

if ($searchBar->hasBeenSent() && ! $searchBar->isValid()) {
if ($searchBar->hasBeenSubmitted()) {
$filter = $this->getFilter();
} else {
$this->addControl($searchBar);
$this->sendMultipartUpdate();
return;
}
} else {
$filter = $searchBar->getFilter();
}

$nodesQuery->filter($filter);

$this->addControl($paginationControl);
$this->addControl($sortControl);
$this->addControl($limitControl);
$this->addControl($viewModeSwitcher);
$this->addControl($searchBar);

$this->addContent(
(new DependencyNodeList($nodesQuery))
->setViewMode($viewModeSwitcher->getViewMode())
);

if (! $searchBar->hasBeenSubmitted() && $searchBar->hasBeenSent()) {
$this->sendMultipartUpdate();
}

$this->setAutorefreshInterval(10);
}

public function childrenAction(): void
{
$this->loadGroup();
$nodesQuery = $this->fetchNodes();

$limitControl = $this->createLimitControl();
$paginationControl = $this->createPaginationControl($nodesQuery);
$sortControl = $this->createSortControl(
$nodesQuery,
[
'name' => $this->translate('Name'),
'severity desc, last_state_change desc' => $this->translate('Severity'),
'state' => $this->translate('Current State'),
'last_state_change desc' => $this->translate('Last State Change')
]
);
$viewModeSwitcher = $this->createViewModeSwitcher($paginationControl, $limitControl);

$searchBar = $this->createSearchBar(
$nodesQuery,
[
$limitControl->getLimitParam(),
$sortControl->getSortParam(),
$viewModeSwitcher->getViewModeParam(),
'id'
]
);

$searchBar->getSuggestionUrl()->setParam('isChildrenTab');
$searchBar->getEditorUrl()
->setParams((clone $searchBar->getEditorUrl()->getParams())->set('isChildrenTab', true));

if ($searchBar->hasBeenSent() && ! $searchBar->isValid()) {
if ($searchBar->hasBeenSubmitted()) {
$filter = $this->getFilter();
} else {
$this->addControl($searchBar);
$this->sendMultipartUpdate();
return;
}
} else {
$filter = $searchBar->getFilter();
}

$nodesQuery->filter($filter);

$this->addControl($paginationControl);
$this->addControl($sortControl);
$this->addControl($limitControl);
$this->addControl($viewModeSwitcher);
$this->addControl($searchBar);

$this->addContent(
(new DependencyNodeList($nodesQuery))
->setViewMode($viewModeSwitcher->getViewMode())
);

if (! $searchBar->hasBeenSubmitted() && $searchBar->hasBeenSent()) {
$this->sendMultipartUpdate();
}

$this->setAutorefreshInterval(10);
}

public function completeAction(): void
{
$isChildrenTab = $this->params->shift('isChildrenTab');
$column = $isChildrenTab ? 'parent' : 'child';

$suggestions = (new ObjectSuggestions())
->setModel(DependencyNode::class)
->setBaseFilter(Filter::equal("$column.redundancy_group.id", $this->groupId))
->forRequest($this->getServerRequest());

$this->getDocument()->add($suggestions);
}

public function searchEditorAction(): void
{
$isChildrenTab = $this->params->shift('isChildrenTab');
$redirectUrl = $isChildrenTab
? Url::fromPath('icingadb/redundancygroup/children', ['id' => $this->groupId])
: Url::fromPath('icingadb/redundancygroup/members', ['id' => $this->groupId]);

$editor = $this->createSearchEditor(
DependencyNode::on($this->getDb()),
$redirectUrl,
[
LimitControl::DEFAULT_LIMIT_PARAM,
SortControl::DEFAULT_SORT_PARAM,
ViewModeSwitcher::DEFAULT_VIEW_MODE_PARAM,
'id'
]
);

if ($isChildrenTab) {
$editor->getSuggestionUrl()->setParam('isChildrenTab');
}

$this->getDocument()->add($editor);
$this->setTitle($this->translate('Adjust Filter'));
}

protected function createTabs(): Tabs
{
$tabs = $this->getTabs()
->add('index', [
'label' => $this->translate('Redundancy Group'),
'url' => Url::fromPath('icingadb/redundancygroup', ['id' => $this->groupId])
])
->add('members', [
'label' => $this->translate('Members'),
'url' => Url::fromPath('icingadb/redundancygroup/members', ['id' => $this->groupId])
])
->add('children', [
'label' => $this->translate('Children'),
'url' => Url::fromPath('icingadb/redundancygroup/children', ['id' => $this->groupId])
]);

return $tabs;
}

protected function setTitleTab(string $name): void
{
$tab = $this->createTabs()->get($name);

if ($tab !== null) {
$this->getTabs()->activate($name);
}
}

/**
* Fetch the nodes for the current group
*
* @param bool $fetchParents Whether to fetch the parents or the children
*
* @return Query
*/
private function fetchNodes(bool $fetchParents = false): Query
{
$filterColumn = sprintf(
'%s.redundancy_group.id',
$fetchParents ? 'child' : 'parent'
);

$query = DependencyNode::on($this->getDb())
->with([
'host',
'host.state',
'host.state.last_comment',
'service',
'service.state',
'service.state.last_comment',
'service.host',
'service.host.state'
])
->filter(Filter::equal($filterColumn, $this->groupId));

$this->applyRestrictions($query);

return $query;
}

protected function fetchCommandTargets()
{
$filter = Filter::all(Filter::equal('child.redundancy_group.id', $this->groupId));

if ($this->getRequest()->getActionName() === 'acknowledge') {
$filter->add(
Filter::any(
Filter::all(
Filter::unlike('child.service.id', '*'),
Filter::equal('host.state.is_problem', 'y'),
Filter::equal('host.state.is_acknowledged', 'n')
),
Filter::all(
Filter::equal('service.state.is_problem', 'y'),
Filter::equal('service.state.is_acknowledged', 'n')
)
)
);
}

return new DependencyNodes($filter);
}

protected function getCommandTargetsUrl(): Url
{
return Url::fromPath('icingadb/redundancygroup', ['id' => $this->groupId]);
}

public function processCheckresultAction(): void
{
$this->httpBadRequest('Check result submission not implemented yet');
}
}
11 changes: 9 additions & 2 deletions library/Icingadb/Authentication/ObjectAuthorization.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

use Icinga\Module\Icingadb\Common\Auth;
use Icinga\Module\Icingadb\Common\Database;
use Icinga\Module\Icingadb\Model\DependencyNode;
use Icinga\Module\Icingadb\Model\Host;
use Icinga\Module\Icingadb\Model\Service;
use InvalidArgumentException;
Expand Down Expand Up @@ -85,6 +86,9 @@ public static function grantsOnType(string $permission, string $type, Filter\Rul
case 'service':
$for = Service::class;
break;
case 'dependency_node':
$for = DependencyNode::class;
break;
default:
throw new InvalidArgumentException(sprintf('Unknown type "%s"', $type));
}
Expand Down Expand Up @@ -161,13 +165,16 @@ protected function loadGrants(string $model, Filter\Rule $filter, string $cacheK
$roleFilter->add($this->parseRestriction($restriction, 'icingadb/filter/objects'));
}

if ($tableName === 'host' || $tableName === 'service') {
if ($tableName === 'host' || $tableName === 'service' || $tableName === 'dependency_node') {
if (($restriction = $role->getRestrictions('icingadb/filter/hosts'))) {
$roleFilter->add($this->parseRestriction($restriction, 'icingadb/filter/hosts'));
}
}

if ($tableName === 'service' && ($restriction = $role->getRestrictions('icingadb/filter/services'))) {
if (
($tableName === 'dependency_node' || $tableName === 'service')
&& ($restriction = $role->getRestrictions('icingadb/filter/services'))
) {
$roleFilter->add($this->parseRestriction($restriction, 'icingadb/filter/services'));
}

Expand Down
Loading

0 comments on commit ae9002d

Please sign in to comment.