1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
<?php
/* Icinga DB Web | (c) 2021 Icinga GmbH | GPLv2 */
namespace Icinga\Module\Icingadb\Forms\Command;
use ArrayIterator;
use Countable;
use Exception;
use Icinga\Application\Logger;
use Icinga\Module\Icingadb\Command\IcingaCommand;
use Icinga\Module\Icingadb\Command\Transport\CommandTransport;
use Icinga\Module\Icingadb\Common\Auth;
use Icinga\Web\Notification;
use Icinga\Web\Session;
use ipl\Html\Form;
use ipl\Orm\Model;
use ipl\Web\Common\CsrfCounterMeasure;
use Iterator;
use IteratorIterator;
use Traversable;
abstract class CommandForm extends Form
{
use Auth;
use CsrfCounterMeasure;
protected $defaultAttributes = ['class' => 'icinga-form icinga-controls'];
/** @var (Traversable<Model>&Countable)|array<Model> */
protected $objects;
/** @var bool */
protected $isApiTarget = false;
/**
* Whether an error occurred while sending the command
*
* Prevents the success message from being rendered simultaneously
*
* @var bool
*/
protected $errorOccurred = false;
/**
* Set the objects to issue the command for
*
* @param (Traversable<Model>&Countable)|array<Model> $objects A traversable that is also countable
*
* @return $this
*/
public function setObjects($objects): self
{
$this->objects = $objects;
return $this;
}
/**
* Get the objects to issue the command for
*
* @return (Traversable<Model>&Countable)|array<Model>
*/
public function getObjects()
{
return $this->objects;
}
/**
* Set whether this form is an API target
*
* @param bool $state
*
* @return $this
*/
public function setIsApiTarget(bool $state = true): self
{
$this->isApiTarget = $state;
return $this;
}
/**
* Get whether this form is an API target
*
* @return bool
*/
public function isApiTarget(): bool
{
return $this->isApiTarget;
}
/**
* Create and add form elements representing the command's options
*
* @return void
*/
abstract protected function assembleElements();
/**
* Create and add a submit button to the form
*
* @return void
*/
abstract protected function assembleSubmitButton();
/**
* Get the commands to issue for the given objects
*
* @param Iterator<Model> $objects
*
* @return Traversable<IcingaCommand>
*/
abstract protected function getCommands(Iterator $objects): Traversable;
protected function assemble()
{
$this->assembleElements();
if (! $this->isApiTarget()) {
$this->assembleSubmitButton();
$this->addElement($this->createCsrfCounterMeasure(Session::getSession()->getId()));
}
}
protected function onSuccess()
{
$objects = $this->getObjects();
if (is_array($objects)) {
$objects = new ArrayIterator($objects);
} else {
$objects = new IteratorIterator($objects);
}
$errors = [];
foreach ($this->getCommands($objects) as $command) {
try {
$this->sendCommand($command);
} catch (Exception $e) {
Logger::error($e->getMessage());
$errors[] = $e->getMessage();
}
}
if (! empty($errors)) {
if (count($errors) > 1) {
Notification::warning(
t('Some commands were not transmitted. Please check the log. The first error follows.')
);
}
$this->errorOccurred = true;
Notification::error($errors[0]);
}
}
/**
* Transmit the given command
*
* @param IcingaCommand $command
*
* @return void
*/
protected function sendCommand(IcingaCommand $command)
{
(new CommandTransport())->send($command);
}
}
|
