Skip to content

Commit

Permalink
ReportForm: Check whether the report name is unique
Browse files Browse the repository at this point in the history
The form now requires a database instance (RetryConnection), which should be specified as a constructor parameter in order to keep the form dependency-free.
  • Loading branch information
sukhwinder33445 committed Jul 22, 2024
1 parent 239dd71 commit 3aebc4d
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 7 deletions.
4 changes: 2 additions & 2 deletions application/controllers/ReportController.php
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ public function cloneAction(): void
$values[$name] = $value;
}

$form = (new ReportForm())
$form = (new ReportForm(Database::get()))
->setSubmitButtonLabel($this->translate('Clone Report'))
->setAction((string) Url::fromRequest())
->populate($values)
Expand Down Expand Up @@ -148,7 +148,7 @@ public function editAction(): void
$values[$name] = $value;
}

$form = ReportForm::fromId($this->report->getId())
$form = ReportForm::fromId($this->report->getId(), Database::get())
->setAction((string) Url::fromRequest())
->populate($values)
->on(ReportForm::ON_SUCCESS, function (ReportForm $form) {
Expand Down
2 changes: 1 addition & 1 deletion application/controllers/ReportsController.php
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ public function newAction(): void
break;
}

$form = (new ReportForm())
$form = (new ReportForm(Database::get()))
->setAction((string) Url::fromRequest())
->setRenderCreateAndShowButton($class !== null)
->populate([
Expand Down
37 changes: 33 additions & 4 deletions library/Reporting/Web/Forms/ReportForm.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@

use Icinga\Authentication\Auth;
use Icinga\Module\Reporting\Database;
use Icinga\Module\Reporting\Model\Report;
use Icinga\Module\Reporting\ProvidedReports;
use Icinga\Module\Reporting\RetryConnection;
use ipl\Html\Form;
use ipl\Html\HtmlDocument;
use ipl\Stdlib\Filter;
use ipl\Validator\CallbackValidator;
use ipl\Web\Compat\CompatForm;

Expand All @@ -24,16 +27,25 @@ class ReportForm extends CompatForm
/** @var bool Whether to render the create and show submit button (is only used from DB Web's object detail) */
protected $renderCreateAndShowButton = false;

/** @var RetryConnection */
protected $db;

public function __construct(RetryConnection $db)
{
$this->db = $db;
}

/**
* Create a new form instance with the given report id
*
* @param $id
* @param int $id
* @param RetryConnection $db
*
* @return static
*/
public static function fromId($id): self
public static function fromId(int $id, RetryConnection $db): self
{
$form = new static();
$form = new static($db);
$form->id = $id;

return $form;
Expand Down Expand Up @@ -106,14 +118,31 @@ protected function assemble()
),
'validators' => [
'Callback' => function ($value, CallbackValidator $validator) {
if ($value !== null && strpos($value, '..') !== false) {
if ($value === null) {
return true;
}

if (strpos($value, '..') !== false) {
$validator->addMessage(
$this->translate('Double dots are not allowed in the report name')
);

return false;
}

$report = Report::on($this->db)
->columns('1')
->filter(Filter::equal('name', $value))
->first();

if ($report !== null) {
$validator->addMessage(
$this->translate('A report with this name already exists')
);

return false;
}

return true;
}
]
Expand Down

0 comments on commit 3aebc4d

Please sign in to comment.