PrivilegeAudit: Use strict interfaces to contruct ipl\Html objects

This commit is contained in:
Johannes Meyer 2021-06-21 16:11:30 +02:00
parent f400f4d96d
commit ed009bb032

View File

@ -6,9 +6,11 @@ namespace Icinga\Web\View;
use Icinga\Authentication\Role; use Icinga\Authentication\Role;
use Icinga\Forms\Security\RoleForm; use Icinga\Forms\Security\RoleForm;
use Icinga\Util\StringHelper; use Icinga\Util\StringHelper;
use ipl\Html\Attributes;
use ipl\Html\BaseHtmlElement; use ipl\Html\BaseHtmlElement;
use ipl\Html\HtmlElement; use ipl\Html\HtmlElement;
use ipl\Html\HtmlString; use ipl\Html\HtmlString;
use ipl\Html\Text;
use ipl\Stdlib\Filter; use ipl\Stdlib\Filter;
use ipl\Web\Common\BaseTarget; use ipl\Web\Common\BaseTarget;
use ipl\Web\Filter\QueryString; use ipl\Web\Filter\QueryString;
@ -132,19 +134,19 @@ class PrivilegeAudit extends BaseHtmlElement
$connector = null; $connector = null;
if ($role->getParent() !== null) { if ($role->getParent() !== null) {
$connector = new HtmlElement('li', ['class' => ['connector', $class]]); $connector = HtmlElement::create('li', ['class' => ['connector', $class]]);
if ($setInitiator) { if ($setInitiator) {
$setInitiator = false; $setInitiator = false;
$connector->getAttributes()->add('class', 'initiator'); $connector->getAttributes()->add('class', 'initiator');
} }
$path->prepend($connector); $path->prependHtml($connector);
} }
$path->prepend(new HtmlElement('li', [ $path->prependHtml(new HtmlElement('li', Attributes::create([
'class' => ['role', $class], 'class' => ['role', $class],
'title' => $role->getName() 'title' => $role->getName()
], new Link([$icon, $role->getName()], Url::fromPath('role/edit', ['role' => $role->getName()])))); ]), new Link([$icon, $role->getName()], Url::fromPath('role/edit', ['role' => $role->getName()]))));
if ($refused) { if ($refused) {
$setInitiator = $class !== 'refused'; $setInitiator = $class !== 'refused';
@ -160,18 +162,18 @@ class PrivilegeAudit extends BaseHtmlElement
} }
array_unshift($rolePaths, $path->prepend([ array_unshift($rolePaths, $path->prepend([
empty($rolePaths) ? null : new HtmlElement('li', ['class' => ['vertical-line', $vClass]]), empty($rolePaths) ? null : HtmlElement::create('li', ['class' => ['vertical-line', $vClass]]),
new HtmlElement('li', ['class' => [ new HtmlElement('li', Attributes::create(['class' => [
'connector', 'connector',
$class, $class,
$setInitiator ? 'initiator' : null $setInitiator ? 'initiator' : null
]]) ]]))
])); ]));
} }
return [ return [
empty($refusedBy) ? (empty($grantedBy) ? null : true) : false, empty($refusedBy) ? (empty($grantedBy) ? null : true) : false,
new HtmlElement('div', [ HtmlElement::create('div', [
'class' => [empty($rolePaths) ? null : 'collapsible', 'inheritance-paths'], 'class' => [empty($rolePaths) ? null : 'collapsible', 'inheritance-paths'],
'data-toggle-element' => '.collapsible-control', 'data-toggle-element' => '.collapsible-control',
'data-no-persistence' => true, 'data-no-persistence' => true,
@ -229,20 +231,24 @@ class PrivilegeAudit extends BaseHtmlElement
$roles = []; $roles = [];
if (! empty($restrictions) && count($restrictions) > 1) { if (! empty($restrictions) && count($restrictions) > 1) {
list($combinedRestrictions, $combinedLinks) = $this->createRestrictionLinks($restriction, $restrictions); list($combinedRestrictions, $combinedLinks) = $this->createRestrictionLinks($restriction, $restrictions);
$roles[] = new HtmlElement('li', null, [ $roles[] = HtmlElement::create('li', null, [
new HtmlElement('div', ['class' => 'flex-overflow'], [ new HtmlElement(
new HtmlElement('span', [ 'div',
Attributes::create(['class' => 'flex-overflow']),
HtmlElement::create('span', [
'class' => 'role', 'class' => 'role',
'title' => t('All roles combined') 'title' => t('All roles combined')
], join(' | ', array_map(function ($role) { ], join(' | ', array_map(function ($role) {
return $role->getName(); return $role->getName();
}, $restrictedBy))), }, $restrictedBy))),
new HtmlElement('code', ['class' => 'restriction'], $combinedRestrictions) HtmlElement::create('code', ['class' => 'restriction'], $combinedRestrictions)
]), ),
$combinedLinks ? new HtmlElement('div', ['class' => 'previews'], [ $combinedLinks ? new HtmlElement(
new HtmlElement('em', null, t('Previews:')), 'div',
Attributes::create(['class' => 'previews']),
HtmlElement::create('em', null, t('Previews:')),
$combinedLinks $combinedLinks
]) : null ) : null
]); ]);
} }
@ -252,32 +258,38 @@ class PrivilegeAudit extends BaseHtmlElement
[$role->getRestrictions($restriction)] [$role->getRestrictions($restriction)]
); );
$roles[] = new HtmlElement('li', null, [ $roles[] = HtmlElement::create('li', null, [
new HtmlElement('div', ['class' => 'flex-overflow'], [ new HtmlElement(
'div',
Attributes::create(['class' => 'flex-overflow']),
new Link($role->getName(), Url::fromPath('role/edit', ['role' => $role->getName()]), [ new Link($role->getName(), Url::fromPath('role/edit', ['role' => $role->getName()]), [
'class' => 'role', 'class' => 'role',
'title' => $role->getName() 'title' => $role->getName()
]), ]),
new HtmlElement('code', ['class' => 'restriction'], $roleRestriction) HtmlElement::create('code', ['class' => 'restriction'], $roleRestriction)
]), ),
$restrictionLinks ? new HtmlElement('div', ['class' => 'previews'], [ $restrictionLinks ? new HtmlElement(
new HtmlElement('em', null, t('Previews:')), 'div',
Attributes::create(['class' => 'previews']),
HtmlElement::create('em', null, t('Previews:')),
$restrictionLinks $restrictionLinks
]) : null ) : null
]); ]);
} }
return [ return [
! empty($restrictedBy), ! empty($restrictedBy),
new HtmlElement('div', [ new HtmlElement(
'class' => [empty($roles) ? null : 'collapsible', 'restrictions'], 'div',
'data-toggle-element' => '.collapsible-control', Attributes::create([
'data-no-persistence' => true, 'class' => [empty($roles) ? null : 'collapsible', 'restrictions'],
'data-visible-height' => 0 'data-toggle-element' => '.collapsible-control',
], [ 'data-no-persistence' => true,
'data-visible-height' => 0
]),
empty($roles) ? $header : $header->addAttributes(['class' => 'collapsible-control']), empty($roles) ? $header : $header->addAttributes(['class' => 'collapsible-control']),
new HtmlElement('ul', null, $roles) new HtmlElement('ul', null, ...$roles)
]) )
]; ];
} }
@ -287,32 +299,44 @@ class PrivilegeAudit extends BaseHtmlElement
list($wildcardState, $wildcardAudit) = $this->auditPermission('*'); list($wildcardState, $wildcardAudit) = $this->auditPermission('*');
list($unrestrictedState, $unrestrictedAudit) = $this->auditPermission(self::UNRESTRICTED_PERMISSION); list($unrestrictedState, $unrestrictedAudit) = $this->auditPermission(self::UNRESTRICTED_PERMISSION);
$this->add(new HtmlElement('li', [ $this->addHtml(new HtmlElement(
'class' => 'collapsible', 'li',
'data-toggle-element' => 'h3', Attributes::create([
'data-visible-height' => 0 'class' => 'collapsible',
], [ 'data-toggle-element' => 'h3',
new HtmlElement('h3', null, [ 'data-visible-height' => 0
new HtmlElement('span', null, t('Administrative Privileges')), ]),
new HtmlElement('span', ['class' => 'audit-preview'], [ new HtmlElement(
'h3',
null,
new HtmlElement('span', null, Text::create(t('Administrative Privileges'))),
HtmlElement::create(
'span',
['class' => 'audit-preview'],
$wildcardState || $unrestrictedState $wildcardState || $unrestrictedState
? new Icon('check-circle', ['class' => 'granted']) ? new Icon('check-circle', ['class' => 'granted'])
: null : null
]) )
]), ),
new HtmlElement('ol', ['class' => 'privilege-list'], [ new HtmlElement(
new HtmlElement('li', null, [ 'ol',
new HtmlElement('p', ['class' => 'privilege-label'], t('Administrative Access')), Attributes::create(['class' => 'privilege-list']),
new HtmlElement('div', ['class' => 'spacer']), new HtmlElement(
'li',
null,
HtmlElement::create('p', ['class' => 'privilege-label'], t('Administrative Access')),
HtmlElement::create('div', ['class' => 'spacer']),
$wildcardAudit $wildcardAudit
]), ),
new HtmlElement('li', null, [ new HtmlElement(
new HtmlElement('p', ['class' => 'privilege-label'], t('Unrestricted Access')), 'li',
new HtmlElement('div', ['class' => 'spacer']), null,
HtmlElement::create('p', ['class' => 'privilege-label'], t('Unrestricted Access')),
HtmlElement::create('div', ['class' => 'spacer']),
$unrestrictedAudit $unrestrictedAudit
]) )
]) )
])); ));
$privilegeSources = array_unique(array_merge(array_keys($permissions), array_keys($restrictions))); $privilegeSources = array_unique(array_merge(array_keys($permissions), array_keys($restrictions)));
foreach ($privilegeSources as $source) { foreach ($privilegeSources as $source) {
@ -320,7 +344,7 @@ class PrivilegeAudit extends BaseHtmlElement
$anythingRefused = false; $anythingRefused = false;
$anythingRestricted = false; $anythingRestricted = false;
$permissionList = new HtmlElement('ol', ['class' => 'privilege-list']); $permissionList = new HtmlElement('ol', Attributes::create(['class' => 'privilege-list']));
foreach (isset($permissions[$source]) ? $permissions[$source] : [] as $permission => $metaData) { foreach (isset($permissions[$source]) ? $permissions[$source] : [] as $permission => $metaData) {
list($permissionState, $permissionAudit) = $this->auditPermission($permission); list($permissionState, $permissionAudit) = $this->auditPermission($permission);
if ($permissionState !== null) { if ($permissionState !== null) {
@ -331,8 +355,10 @@ class PrivilegeAudit extends BaseHtmlElement
} }
} }
$permissionList->add(new HtmlElement('li', null, [ $permissionList->addHtml(new HtmlElement(
new HtmlElement( 'li',
null,
HtmlElement::create(
'p', 'p',
['class' => 'privilege-label'], ['class' => 'privilege-label'],
isset($metaData['label']) isset($metaData['label'])
@ -341,8 +367,8 @@ class PrivilegeAudit extends BaseHtmlElement
return $segment[0] === '/' ? [ return $segment[0] === '/' ? [
// Adds a zero-width char after each slash to help browsers break onto newlines // Adds a zero-width char after each slash to help browsers break onto newlines
new HtmlString('/​'), new HtmlString('/​'),
new HtmlElement('span', ['class' => 'no-wrap'], substr($segment, 1)) HtmlElement::create('span', ['class' => 'no-wrap'], substr($segment, 1))
] : new HtmlElement('em', null, $segment); ] : HtmlElement::create('em', null, $segment);
}, preg_split( }, preg_split(
'~(/[^/]+)~', '~(/[^/]+)~',
$permission, $permission,
@ -350,20 +376,22 @@ class PrivilegeAudit extends BaseHtmlElement
PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY
)) ))
), ),
new HtmlElement('div', ['class' => 'spacer']), new HtmlElement('div', Attributes::create(['class' => 'spacer'])),
$permissionAudit $permissionAudit
])); ));
} }
$restrictionList = new HtmlElement('ol', ['class' => 'privilege-list']); $restrictionList = new HtmlElement('ol', Attributes::create(['class' => 'privilege-list']));
foreach (isset($restrictions[$source]) ? $restrictions[$source] : [] as $restriction => $metaData) { foreach (isset($restrictions[$source]) ? $restrictions[$source] : [] as $restriction => $metaData) {
list($restrictionState, $restrictionAudit) = $this->auditRestriction($restriction); list($restrictionState, $restrictionAudit) = $this->auditRestriction($restriction);
if ($restrictionState) { if ($restrictionState) {
$anythingRestricted = true; $anythingRestricted = true;
} }
$restrictionList->add(new HtmlElement('li', null, [ $restrictionList->addHtml(new HtmlElement(
new HtmlElement( 'li',
null,
HtmlElement::create(
'p', 'p',
['class' => 'privilege-label'], ['class' => 'privilege-label'],
isset($metaData['label']) isset($metaData['label'])
@ -372,8 +400,8 @@ class PrivilegeAudit extends BaseHtmlElement
return $segment[0] === '/' ? [ return $segment[0] === '/' ? [
// Adds a zero-width char after each slash to help browsers break onto newlines // Adds a zero-width char after each slash to help browsers break onto newlines
new HtmlString('/​'), new HtmlString('/​'),
new HtmlElement('span', ['class' => 'no-wrap'], substr($segment, 1)) HtmlElement::create('span', ['class' => 'no-wrap'], substr($segment, 1))
] : new HtmlElement('em', null, $segment); ] : HtmlElement::create('em', null, $segment);
}, preg_split( }, preg_split(
'~(/[^/]+)~', '~(/[^/]+)~',
$restriction, $restriction,
@ -381,36 +409,38 @@ class PrivilegeAudit extends BaseHtmlElement
PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY
)) ))
), ),
new HtmlElement('div', ['class' => 'spacer']), new HtmlElement('div', Attributes::create(['class' => 'spacer'])),
$restrictionAudit $restrictionAudit
])); ));
} }
if ($source === 'application') { if ($source === 'application') {
$label = 'Icinga Web 2'; $label = 'Icinga Web 2';
} else { } else {
$label = [$source, ' ', new HtmlElement('em', null, t('Module'))]; $label = [$source, ' ', HtmlElement::create('em', null, t('Module'))];
} }
$this->add(new HtmlElement('li', [ $this->addHtml(HtmlElement::create('li', [
'class' => 'collapsible', 'class' => 'collapsible',
'data-toggle-element' => 'h3', 'data-toggle-element' => 'h3',
'data-visible-height' => 0 'data-visible-height' => 0
], [ ], [
new HtmlElement('h3', null, [ new HtmlElement(
new HtmlElement('span', null, $label), 'h3',
new HtmlElement('span', ['class' => 'audit-preview'], [ null,
HtmlElement::create('span', null, $label),
HtmlElement::create('span', ['class' => 'audit-preview'], [
$anythingGranted ? new Icon('check-circle', ['class' => 'granted']) : null, $anythingGranted ? new Icon('check-circle', ['class' => 'granted']) : null,
$anythingRefused ? new Icon('times-circle', ['class' => 'refused']) : null, $anythingRefused ? new Icon('times-circle', ['class' => 'refused']) : null,
$anythingRestricted ? new Icon('filter', ['class' => 'restricted']) : null $anythingRestricted ? new Icon('filter', ['class' => 'restricted']) : null
]) ])
]), ),
$permissionList->isEmpty() ? null : [ $permissionList->isEmpty() ? null : [
new HtmlElement('h4', null, t('Permissions')), HtmlElement::create('h4', null, t('Permissions')),
$permissionList $permissionList
], ],
$restrictionList->isEmpty() ? null : [ $restrictionList->isEmpty() ? null : [
new HtmlElement('h4', null, t('Restrictions')), HtmlElement::create('h4', null, t('Restrictions')),
$restrictionList $restrictionList
] ]
])); ]));
@ -433,7 +463,9 @@ class PrivilegeAudit extends BaseHtmlElement
switch ($restrictionName) { switch ($restrictionName) {
case 'icingadb/filter/objects': case 'icingadb/filter/objects':
$filterString = join('|', $restrictions); $filterString = join('|', $restrictions);
$list = new HtmlElement('ul', ['class' => 'links'], [ $list = new HtmlElement(
'ul',
Attributes::create(['class' => 'links']),
new HtmlElement('li', null, new Link( new HtmlElement('li', null, new Link(
'icingadb/hosts', 'icingadb/hosts',
Url::fromPath('icingadb/hosts')->setQueryString($filterString) Url::fromPath('icingadb/hosts')->setQueryString($filterString)
@ -450,12 +482,14 @@ class PrivilegeAudit extends BaseHtmlElement
'icingadb/servicegroups', 'icingadb/servicegroups',
Url::fromPath('icingadb/servicegroups')->setQueryString($filterString) Url::fromPath('icingadb/servicegroups')->setQueryString($filterString)
)) ))
]); );
break; break;
case 'icingadb/filter/hosts': case 'icingadb/filter/hosts':
$filterString = join('|', $restrictions); $filterString = join('|', $restrictions);
$list = new HtmlElement('ul', ['class' => 'links'], [ $list = new HtmlElement(
'ul',
Attributes::create(['class' => 'links']),
new HtmlElement('li', null, new Link( new HtmlElement('li', null, new Link(
'icingadb/hosts', 'icingadb/hosts',
Url::fromPath('icingadb/hosts')->setQueryString($filterString) Url::fromPath('icingadb/hosts')->setQueryString($filterString)
@ -464,22 +498,26 @@ class PrivilegeAudit extends BaseHtmlElement
'icingadb/services', 'icingadb/services',
Url::fromPath('icingadb/services')->setQueryString($filterString) Url::fromPath('icingadb/services')->setQueryString($filterString)
)) ))
]); );
break; break;
case 'icingadb/filter/services': case 'icingadb/filter/services':
$filterString = join('|', $restrictions); $filterString = join('|', $restrictions);
$list = new HtmlElement('ul', ['class' => 'links'], [ $list = new HtmlElement(
'ul',
Attributes::create(['class' => 'links']),
new HtmlElement('li', null, new Link( new HtmlElement('li', null, new Link(
'icingadb/services', 'icingadb/services',
Url::fromPath('icingadb/services')->setQueryString($filterString) Url::fromPath('icingadb/services')->setQueryString($filterString)
)) ))
]); );
break; break;
case 'monitoring/filter/objects': case 'monitoring/filter/objects':
$filterString = join('|', $restrictions); $filterString = join('|', $restrictions);
$list = new HtmlElement('ul', ['class' => 'links'], [ $list = new HtmlElement(
'ul',
Attributes::create(['class' => 'links']),
new HtmlElement('li', null, new Link( new HtmlElement('li', null, new Link(
'monitoring/list/hosts', 'monitoring/list/hosts',
Url::fromPath('monitoring/list/hosts')->setQueryString($filterString) Url::fromPath('monitoring/list/hosts')->setQueryString($filterString)
@ -496,7 +534,7 @@ class PrivilegeAudit extends BaseHtmlElement
'monitoring/list/servicegroups', 'monitoring/list/servicegroups',
Url::fromPath('monitoring/list/servicegroups')->setQueryString($filterString) Url::fromPath('monitoring/list/servicegroups')->setQueryString($filterString)
)) ))
]); );
break; break;
case 'application/share/users': case 'application/share/users':
@ -509,12 +547,14 @@ class PrivilegeAudit extends BaseHtmlElement
} }
$filterString = QueryString::render($filter); $filterString = QueryString::render($filter);
$list = new HtmlElement('ul', ['class' => 'links'], [ $list = new HtmlElement(
'ul',
Attributes::create(['class' => 'links']),
new HtmlElement('li', null, new Link( new HtmlElement('li', null, new Link(
'user/list', 'user/list',
Url::fromPath('user/list')->setQueryString($filterString) Url::fromPath('user/list')->setQueryString($filterString)
)) ))
]); );
break; break;
case 'application/share/groups': case 'application/share/groups':
@ -527,12 +567,14 @@ class PrivilegeAudit extends BaseHtmlElement
} }
$filterString = QueryString::render($filter); $filterString = QueryString::render($filter);
$list = new HtmlElement('ul', ['class' => 'links'], [ $list = new HtmlElement(
'ul',
Attributes::create(['class' => 'links']),
new HtmlElement('li', null, new Link( new HtmlElement('li', null, new Link(
'group/list', 'group/list',
Url::fromPath('group/list')->setQueryString($filterString) Url::fromPath('group/list')->setQueryString($filterString)
)) ))
]); );
break; break;
default: default: