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
|
<?php
namespace Icinga\Module\Director\Forms;
use Icinga\Module\Director\DataType\DataTypeDirectorObject;
use Icinga\Module\Director\Web\Form\DirectorObjectForm;
class IcingaNotificationForm extends DirectorObjectForm
{
public function setup()
{
$this->addObjectTypeElement();
if (! $this->hasObjectType()) {
$this->groupMainProperties();
return;
}
if ($this->isTemplate()) {
$this->addElement('text', 'object_name', array(
'label' => $this->translate('Notification Template'),
'required' => true,
'description' => $this->translate('Name for the Icinga notification template you are going to create')
));
} else {
$this->addElement('text', 'object_name', array(
'label' => $this->translate('Notification'),
'required' => true,
'description' => $this->translate('Name for the Icinga notification you are going to create')
));
$this->eventuallyAddNameRestriction(
'director/notification/apply/filter-by-name'
);
}
$this->addDisabledElement()
->addImportsElement()
->addUsersElement()
->addUsergroupsElement()
->addIntervalElement()
->addPeriodElement()
->addTimesElements()
->addAssignmentElements()
->addDisabledElement()
->addCommandElements()
->addEventFilterElements()
->addZoneElements()
->groupMainProperties()
->setButtons();
}
protected function addZoneElements()
{
if (! $this->isTemplate()) {
return $this;
}
$this->addZoneElement();
$this->addDisplayGroup(array('zone_id'), 'clustering', array(
'decorators' => array(
'FormElements',
array('HtmlTag', array('tag' => 'dl')),
'Fieldset',
),
'order' => self::GROUP_ORDER_CLUSTERING,
'legend' => $this->translate('Zone settings')
));
return $this;
}
/**
* @return self
*/
protected function addAssignmentElements()
{
if (!$this->object || !$this->object->isApplyRule()) {
return $this;
}
$this->addElement('select', 'apply_to', array(
'label' => $this->translate('Apply to'),
'description' => $this->translate(
'Whether this notification should affect hosts or services'
),
'required' => true,
'class' => 'autosubmit',
'multiOptions' => $this->optionalEnum(
array(
'host' => $this->translate('Hosts'),
'service' => $this->translate('Services'),
)
)
));
$applyTo = $this->getSentOrObjectValue('apply_to');
if (! $applyTo) {
return $this;
}
$suggestionContext = ucfirst($applyTo) . 'FilterColumns';
$this->addAssignFilter([
'required' => true,
'suggestionContext' => $suggestionContext,
'description' => $this->translate(
'This allows you to configure an assignment filter. Please feel'
. ' free to combine as many nested operators as you want. The'
. ' "contains" operator is valid for arrays only. Please use'
. ' wildcards and the = (equals) operator when searching for'
. ' partial string matches, like in *.example.com'
)
]);
return $this;
}
/**
* @return $this
*/
protected function addUsersElement()
{
$users = $this->enumUsers();
if (empty($users)) {
$this->addElement('select', 'users', [
'label' => $this->translate('Users'),
'description' => $this->translate('No User object has been created yet'),
'multiOptions' => $this->optionalEnum([]),
]);
} else {
$this->addElement('extensibleSet', 'users', [
'label' => $this->translate('Users'),
'description' => $this->translate(
'Users that should be notified by this notifications'
),
'multiOptions' => $this->optionalEnum($users)
]);
}
$this->addElement('select', 'users_var', [
'label' => $this->translate('Users Custom Variable'),
'multiOptions' => $this->enumDirectorObjectFields('user'),
'description' => $this->translate(
'If defined, Users from this Custom Variable will be combined with single users chosen below. '
. ' e.g.: when set to notification_contacts, this notification will pick Users from the Array'
. ' service.vars.notification_contacts and fall back to host.vars.notification_contacts, in'
. ' case the former one does not exist.'
. ' Only Array type DirectorObject Fields for User objects are eligible for this feature.'
)
]);
return $this;
}
/**
* @return $this
*/
protected function addUsergroupsElement()
{
$groups = $this->enumUsergroups();
if (empty($groups)) {
$this->addElement('select', 'user_groups', [
'label' => $this->translate('Users'),
'description' => $this->translate('No UserGroup object has been created yet'),
'multiOptions' => $this->optionalEnum([]),
]);
} else {
$this->addElement('extensibleSet', 'user_groups', [
'label' => $this->translate('User groups'),
'description' => $this->translate(
'User groups that should be notified by this notifications'
),
'multiOptions' => $this->optionalEnum($groups)
]);
}
$this->addElement('select', 'user_groups_var', [
'label' => $this->translate('User Groups Custom Variable'),
'multiOptions' => $this->enumDirectorObjectFields('usergroup'),
'description' => $this->translate(
'If defined, User Groups from this Custom Variable will be combined with single Groups chosen below. '
. ' e.g.: when set to notification_groups, this notification will pick User Groups from the Array'
. ' service.vars.notification_groups and fall back to host.vars.notification_groups, in'
. ' case the former one does not exist.'
. ' Only Array type DirectorObject Fields for User objects are eligible for this feature.'
)
]);
return $this;
}
protected function enumDirectorObjectFields($objectType, $dataType = 'array')
{
$db = $this->db->getDbAdapter();
$query = $db->select()
->from(['df' => 'director_datafield'], ['k' => 'df.varname', 'v' => 'df.varname'])
->join(
['dfs' => 'director_datafield_setting'],
$db->quoteInto('df.id = dfs.datafield_id AND dfs.setting_name = ?', 'icinga_object_type'),
[]
)
->join(
['dft' => 'director_datafield_setting'],
$db->quoteInto('df.id = dft.datafield_id AND dft.setting_name = ?', 'data_type'),
[]
)
->where('df.datatype = ?', DataTypeDirectorObject::class)
->where('dfs.setting_value = ?', $objectType)
->where('dft.setting_value = ?', $dataType)
->order('df.varname');
return $this->optionalEnum($db->fetchPairs($query));
}
/**
* @return self
*/
protected function addIntervalElement()
{
$this->addElement(
'text',
'notification_interval',
array(
'label' => $this->translate('Notification interval'),
'description' => $this->translate(
'The notification interval (in seconds). This interval is'
. ' used for active notifications. Defaults to 30 minutes.'
. ' If set to 0, re-notifications are disabled.'
)
)
);
return $this;
}
/**
* @return self
*/
protected function addTimesElements()
{
$this->addElement(
'text',
'times_begin',
array(
'label' => $this->translate('First notification delay'),
'description' => $this->translate(
'Delay until the first notification should be sent'
) . '. ' . $this->getTimeValueInfo()
)
);
$this->addElement(
'text',
'times_end',
array(
'label' => $this->translate('Last notification'),
'description' => $this->translate(
'When the last notification should be sent'
) . '. ' . $this->getTimeValueInfo()
)
);
return $this;
}
protected function getTimeValueInfo()
{
return $this->translate(
'Unit is seconds unless a suffix is given. Supported suffixes include'
. ' ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days).'
);
}
/**
* @return self
*/
protected function addPeriodElement()
{
$periods = $this->db->enumTimeperiods();
if (empty($periods)) {
return $this;
}
$this->addElement(
'select',
'period_id',
array(
'label' => $this->translate('Time period'),
'description' => $this->translate(
'The name of a time period which determines when this'
. ' notification should be triggered. Not set by default.'
),
'multiOptions' => $this->optionalEnum($periods),
)
);
return $this;
}
/**
* @return self
*/
protected function addCommandElements()
{
if (! $this->isTemplate()) {
return $this;
}
$this->addElement('select', 'command_id', array(
'label' => $this->translate('Notification command'),
'description' => $this->translate('Check command definition'),
'multiOptions' => $this->optionalEnum($this->db->enumNotificationCommands()),
'class' => 'autosubmit',
));
return $this;
}
protected function enumUsers()
{
$db = $this->db->getDbAdapter();
$select = $db->select()->from(
'icinga_user',
array(
'name' => 'object_name',
'display' => 'COALESCE(display_name, object_name)'
)
)->where('object_type = ?', 'object')->order('display');
return $db->fetchPairs($select);
}
protected function enumUsergroups()
{
$db = $this->db->getDbAdapter();
$select = $db->select()->from(
'icinga_usergroup',
array(
'name' => 'object_name',
'display' => 'COALESCE(display_name, object_name)'
)
)->where('object_type = ?', 'object')->order('display');
return $db->fetchPairs($select);
}
}
|