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 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
|
<?php
namespace Icinga\Module\Director\Forms;
use Exception;
use Icinga\Exception\AuthenticationException;
use Icinga\Module\Director\Auth\Permission;
use Icinga\Module\Director\Auth\Restriction;
use Icinga\Module\Director\Repository\IcingaTemplateRepository;
use Icinga\Module\Director\Restriction\HostgroupRestriction;
use Icinga\Module\Director\Web\Form\DirectorObjectForm;
use ipl\Html\BaseHtmlElement;
use ipl\Html\Html;
use gipfl\IcingaWeb2\Link;
class IcingaHostForm extends DirectorObjectForm
{
public function setup()
{
$this->addObjectTypeElement();
if (! $this->hasObjectType()) {
$this->groupMainProperties();
return;
}
$simpleImports = $this->isNew() && ! $this->isTemplate();
if ($simpleImports) {
if (!$this->addSingleImportElement(true)) {
$this->setSubmitLabel(false);
return;
}
if (! ($imports = $this->getSentOrObjectValue('imports'))) {
$this->setSubmitLabel($this->translate('Next'));
$this->groupMainProperties();
return;
}
}
$nameLabel = $this->isTemplate()
? $this->translate('Name')
: $this->translate('Hostname');
$this->addElement('text', 'object_name', array(
'label' => $nameLabel,
'required' => true,
'spellcheck' => 'false',
'description' => $this->translate(
'Icinga object name for this host. This is usually a fully qualified host name'
. ' but it could basically be any kind of string. To make things easier for your'
. ' users we strongly suggest to use meaningful names for templates. E.g. "generic-host"'
. ' is ugly, "Standard Linux Server" is easier to understand'
)
));
if (! $simpleImports) {
$this->addImportsElement();
}
$this->addChoices('host')
->addDisplayNameElement()
->addAddressElements()
->addGroupsElement()
->addDisabledElement()
->groupMainProperties($simpleImports)
->addCheckCommandElements()
->addCheckExecutionElements()
->addExtraInfoElements()
->addClusteringElements()
->setButtons();
}
/**
* @return $this
*/
protected function addClusteringElements()
{
$this->addZoneElement();
$this->addBoolean('has_agent', [
'label' => $this->translate('Icinga2 Agent'),
'description' => $this->translate(
'Whether this host has the Icinga 2 Agent installed'
),
'class' => 'autosubmit',
]);
try {
$hasAgent = $this->getSentOrResolvedObjectValue('has_agent') === 'y';
} catch (Exception $e) {
$hasAgent = false;
}
if ($hasAgent) {
$this->addBoolean('master_should_connect', [
'label' => $this->translate('Establish connection'),
'description' => $this->translate(
'Whether the parent (master) node should actively try to connect to this agent'
),
'required' => true
]);
$this->addBoolean('accept_config', [
'label' => $this->translate('Accepts config'),
'description' => $this->translate('Whether the agent is configured to accept config'),
'required' => true
]);
$this->addHidden('command_endpoint_id', null);
$this->setSentValue('command_endpoint_id', null);
$settings = $this->object->getConnection()->settings();
if ($settings->get('feature_custom_endpoint') === 'y' && ! $this->isTemplate()) {
$this->addElement('text', 'custom_endpoint_name', [
'label' => $this->translate('Custom Endpoint Name'),
'description' => $this->translate(
'Use a different name for the generated endpoint object than the host name'
. ' and add a custom variable to allow services setting the correct command endpoint.'
),
]);
}
} else {
if ($this->isTemplate()) {
$this->addElement('select', 'command_endpoint_id', [
'label' => $this->translate('Command endpoint'),
'description' => $this->translate(
'Setting a command endpoint allows you to force host checks'
. ' to be executed by a specific endpoint. Please carefully'
. ' study the related Icinga documentation before using this'
. ' feature'
),
'multiOptions' => $this->optionalEnum($this->enumEndpoints())
]);
}
foreach (['master_should_connect', 'accept_config'] as $key) {
$this->addHidden($key, null);
$this->setSentValue($key, null);
}
}
$elements = [
'zone_id',
'has_agent',
'master_should_connect',
'accept_config',
'command_endpoint_id',
'custom_endpoint_name',
'api_key',
];
$this->addDisplayGroup($elements, 'clustering', [
'decorators' => [
'FormElements',
['HtmlTag', ['tag' => 'dl']],
'Fieldset',
],
'order' => self::GROUP_ORDER_CLUSTERING,
'legend' => $this->translate('Icinga Agent and zone settings')
]);
return $this;
}
/**
* @param bool $required
* @return bool
*/
protected function addSingleImportElement($required = null)
{
$enum = $this->enumHostTemplates();
if (empty($enum)) {
if ($required) {
if ($this->hasBeenSent()) {
$this->addError($this->translate('No Host template has been chosen'));
} else {
if ($this->hasPermission(Permission::ADMIN)) {
$html = sprintf(
$this->translate('Please define a %s first'),
Link::create(
$this->translate('Host Template'),
'director/host/add',
['type' => 'template']
)
);
} else {
$html = $this->translate('No Host Template has been provided yet');
}
$this->addHtml('<p class="warning">' . $html . '</p>');
}
}
return false;
}
$this->addElement('select', 'imports', [
'label' => $this->translate('Host Template'),
'description' => $this->translate(
'Choose a Host Template'
),
'required' => true,
'multiOptions' => $this->optionalEnum($enum),
'class' => 'autosubmit'
]);
return true;
}
protected function enumHostTemplates()
{
$tpl = IcingaTemplateRepository::instanceByType('host', $this->getDb())
->listAllowedTemplateNames();
return array_combine($tpl, $tpl);
}
/**
* @return $this
*/
protected function addGroupsElement()
{
if (
$this->hasHostGroupRestriction()
&& ! $this->getAuth()->hasPermission(Permission::GROUPS_FOR_RESTRICTED_HOSTS)
) {
return $this;
}
$this->addElement('extensibleSet', 'groups', array(
'label' => $this->translate('Groups'),
'suggest' => 'hostgroupnames',
'description' => $this->translate(
'Hostgroups that should be directly assigned to this node. Hostgroups can be useful'
. ' for various reasons. You might assign service checks based on assigned hostgroup.'
. ' They are also often used as an instrument to enforce restricted views in Icinga Web 2.'
. ' Hostgroups can be directly assigned to single hosts or to host templates. You might'
. ' also want to consider assigning hostgroups using apply rules'
)
));
$applied = $this->getAppliedGroups();
if (! empty($applied)) {
$this->addElement('simpleNote', 'applied_groups', [
'label' => $this->translate('Applied groups'),
'value' => $this->createHostgroupLinks($applied),
'ignore' => true,
]);
}
$inherited = $this->getInheritedGroups();
if (! empty($inherited)) {
/** @var BaseHtmlElement $links */
$links = $this->createHostgroupLinks($inherited);
if (count($this->object()->getGroups())) {
$links->addAttributes(['class' => 'strike-links']);
/** @var BaseHtmlElement $link */
foreach ($links->getContent() as $link) {
if ($link instanceof BaseHtmlElement) {
$link->addAttributes([
'title' => $this->translate(
'Group has been inherited, but will be overridden'
. ' by locally assigned group(s)'
)
]);
}
}
}
$this->addElement('simpleNote', 'inherited_groups', [
'label' => $this->translate('Inherited groups'),
'value' => $links,
'ignore' => true,
]);
}
return $this;
}
protected function getInheritedGroups()
{
if ($this->hasObject()) {
return $this->object->listInheritedGroupNames();
} else {
return [];
}
}
protected function createHostgroupLinks($groups)
{
$links = [];
foreach ($groups as $name) {
if (! empty($links)) {
$links[] = ', ';
}
$links[] = Link::create(
$name,
'director/hostgroup',
['name' => $name],
['data-base-target' => '_next']
);
}
return Html::tag('span', ['class' => 'host-group-links'], $links);
}
protected function getAppliedGroups()
{
if ($this->isNew()) {
return [];
}
return $this->object()->getAppliedGroups();
}
protected function hasHostGroupRestriction()
{
return $this->getAuth()->getRestrictions(Restriction::FILTER_HOSTGROUPS);
}
/**
* @return $this
*/
protected function addAddressElements()
{
if ($this->isTemplate()) {
return $this;
}
$this->addElement('text', 'address', array(
'label' => $this->translate('Host address'),
'description' => $this->translate(
'Host address. Usually an IPv4 address, but may be any kind of address'
. ' your check plugin is able to deal with'
)
));
$this->addElement('text', 'address6', array(
'label' => $this->translate('IPv6 address'),
'description' => $this->translate('Usually your hosts main IPv6 address')
));
return $this;
}
/**
* @return $this
*/
protected function addDisplayNameElement()
{
if ($this->isTemplate()) {
return $this;
}
$this->addElement('text', 'display_name', array(
'label' => $this->translate('Display name'),
'spellcheck' => 'false',
'description' => $this->translate(
'Alternative name for this host. Might be a host alias or and kind'
. ' of string helping your users to identify this host'
)
));
return $this;
}
protected function enumEndpoints()
{
$db = $this->db->getDbAdapter();
$select = $db->select()->from('icinga_endpoint', [
'id',
'object_name'
])->where(
'object_type IN (?)',
['object', 'external_object']
)->order('object_name');
return $db->fetchPairs($select);
}
public function onSuccess()
{
if ($this->hasHostGroupRestriction()) {
$restriction = new HostgroupRestriction($this->getDb(), $this->getAuth());
if (! $restriction->allowsHost($this->object())) {
throw new AuthenticationException($this->translate(
'Unable to store a host with the given properties because of insufficient permissions'
));
}
}
parent::onSuccess();
}
}
|