Skip to content
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

Allow restricting reports using defined prefix #160

Closed
wants to merge 1 commit into from
Closed

Allow restricting reports using defined prefix #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions application/controllers/ReportController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public function cloneAction()

public function editAction()
{
$this->assertPermission('reporting/reports');
$this->assertPermission('reporting/reports/modify');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you add/change the permission? That is a problem for users already having the reporting/reports permission configured. They would no longer be able to manage reports. I see no reason to have two permissions but maybe there is one :).

$this->addTitleTab($this->translate('Edit Report'));

$values = [
Expand Down Expand Up @@ -234,7 +234,7 @@ protected function assembleActions()

$actions = new ActionBar();

if ($this->hasPermission('reporting/reports')) {
if ($this->hasPermission('reporting/reports/modify')) {
$actions->addHtml(
new ActionLink(
$this->translate('Modify'),
Expand Down
19 changes: 13 additions & 6 deletions application/controllers/ReportsController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public function indexAction()
{
$this->createTabs()->activate('reports');

if ($this->hasPermission('reporting/reports')) {
if ($this->hasPermission('reporting/reports/modify')) {
$this->addControl(new ButtonLink(
$this->translate('New Report'),
Url::fromPath('reporting/reports/new'),
Expand All @@ -43,6 +43,8 @@ public function indexAction()
$reports = Report::on($this->getDb())
->withColumns(['report.timeframe.name']);

$this->applyRestriction($reports, 'name');

$sortControl = $this->createSortControl(
$reports,
[
Expand All @@ -58,13 +60,16 @@ public function indexAction()
foreach ($reports as $report) {
$url = Url::fromPath('reporting/report', ['id' => $report->id])->getAbsoluteUrl('&');

$tableRows[] = Html::tag('tr', ['href' => $url], [
$content = [
Html::tag('td', null, $report->name),
Html::tag('td', null, $report->author),
Html::tag('td', null, $report->timeframe->name),
Html::tag('td', null, $report->ctime->format('Y-m-d H:i')),
Html::tag('td', null, $report->mtime->format('Y-m-d H:i')),
Html::tag('td', ['class' => 'icon-col'], [
];

if ($this->hasPermission('reporting/reports/modify')) {
$content[] = Html::tag('td', ['class' => 'icon-col'], [
new Link(
new Icon('edit'),
Url::fromPath('reporting/report/edit', ['id' => $report->id]),
Expand All @@ -73,8 +78,10 @@ public function indexAction()
'data-no-icinga-ajax' => true
]
)
])
]);
]);
}

$tableRows[] = Html::tag('tr', ['href' => $url], $content);
}

if (! empty($tableRows)) {
Expand Down Expand Up @@ -110,7 +117,7 @@ public function indexAction()

public function newAction()
{
$this->assertPermission('reporting/reports');
$this->assertPermission('reporting/reports/modify');
$this->addTitleTab($this->translate('New Report'));

switch ($this->params->shift('report')) {
Expand Down
10 changes: 10 additions & 0 deletions configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@
$this->translate('Allow managing reports')
);

$this->providePermission(
'reporting/reports/modify',
$this->translate('Allow creating, editing and removing reports')
);

$this->providePermission(
'reporting/schedules',
$this->translate('Allow managing schedules')
Expand All @@ -50,4 +55,9 @@
'reporting/timeframes',
$this->translate('Allow managing timeframes')
);

$this->provideRestriction(
'reporting/prefix',
$this->translate('Restrict access to reports with the given prefix')
);
}
25 changes: 25 additions & 0 deletions library/Reporting/Web/Controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,33 @@

namespace Icinga\Module\Reporting\Web;

use Icinga\Authentication\Auth;
use ipl\Orm\Query;
use ipl\Stdlib\Filter;
use ipl\Web\Compat\CompatController;

class Controller extends CompatController
{
/**
* @param Query $query
* @param string $column
* @return void
*/
protected function applyRestriction(Query $query, string $column)
{
$restrictions = Auth::getInstance()->getRestrictions('reporting/prefix');
$prefixes = [];
foreach ($restrictions as $restriction) {
$prefixes = array_merge(
$prefixes,
explode(', ', trim($restriction))
);
}

if (! empty($prefixes)) {
foreach ($prefixes as $prefix) {
$query->orFilter(Filter::like($column, $prefix . '*'));
}
}
}
}
53 changes: 44 additions & 9 deletions library/Reporting/Web/Forms/ReportForm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,17 +83,52 @@ protected function assemble()
. ' and also when listing the reports in the cli'
),
'validators' => [
'Callback' => function ($value, CallbackValidator $validator) {
if ($value !== null && strpos($value, '..') !== false) {
$validator->addMessage(
$this->translate('Double dots are not allowed in the report name')
);
new CallbackValidator(
function ($value, CallbackValidator $validator) {
if ($value !== null && strpos($value, '..') !== false) {
$validator->addMessage(
$this->translate('Double dots are not allowed in the report name')
);

return false;
}
return false;
}

return true;
}
return true;
}
),
new CallbackValidator(
function ($value, $validator) {
/** @var CallbackValidator $validator */
$restrictions = Auth::getInstance()->getRestrictions('reporting/prefix');
$prefixes = [];
foreach ($restrictions as $restriction) {
$prefixes = array_merge(
$prefixes,
explode(',', trim($restriction))
);
}

if (! empty($prefixes)) {
foreach ($prefixes as $prefix) {
$prefix = trim($prefix);
if (substr($value, 0, strlen($prefix)) === $prefix) {
return true;
}
}

$validator->addMessage(
sprintf(
$this->translate('Please prefix the name with "%s"'),
implode(' | ', $prefixes)
)
);

return false;
}

return true;
}
)
]
]);

Expand Down