tyler.durden
/
icingaweb2
mirror of https://github.com/Icinga/icingaweb2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Monitoring/Commands: Add help messages to the custom notification form 

refs
This commit is contained in:
Eric Lippmann 2013-08-15 15:34:48 +02:00 committed by Jannis Moßhammer
parent 9c047f5b72
commit 3d3fbb123d
4 changed files with 202 additions and 51 deletions
library/Icinga/Protocol/Commandpipe
CommandPipe.phpCustomNotification.php
modules/monitoring/application
controllers
CommandController.php
forms/Command
CustomNotificationForm.php

52
library/Icinga/Protocol/Commandpipe/CommandPipe.php
View File

@ -2,24 +2,24 @@
// {{{ICINGA_LICENSE_HEADER}}}
/**
* This file is part of Icinga 2 Web.
*
*
* Icinga 2 Web - Head for multiple monitoring backends.
* Copyright (C) 2013 Icinga Development Team
*
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*
* @copyright 2013 Icinga Development Team <info@icinga.org>
* @license http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
* @author Icinga Development Team <info@icinga.org>
@ -648,31 +648,31 @@ class CommandPipe
}
/**
* Send a custom host or service notification
* Send custom host and/or service notifications
*
* @param $objects monitoring objects to send this notification to
* @param Comment $comment comment to use in the notification
* @param int [$...] Optional list of Notification flags which will be used as the option parameter
* @param array $objects Affected monitoring objects
* @param CustomNotification $notification
*/
public function sendCustomNotification($objects, Comment $comment, $optionsVarList = 0/*, ...*/)
public function sendCustomNotification(array $objects, CustomNotification $notification)
{
$args = func_get_args();
// logical OR for all notification options
for ($i = 3; $i < count($args); $i++) {
$optionsVarList |= $args[$i];
}
foreach ($objects as $object) {
$type = $this->getObjectType($object);
$msg = 'SEND_CUSTOM_'.(($type == self::TYPE_SERVICE) ? 'SVC' : 'HOST' ).'_NOTIFICATION';
$msg .= ';'.$object->host_name;
if ($type == self::TYPE_SERVICE) {
$msg .= ';'.$object->service_description;
foreach ($objects as $hostOrService) {
if (isset($hostOrService->service_description) && isset($hostOrService->host_name)) {
// Assume service
$command = sprintf(
$notification->getFormatString(self::TYPE_SERVICE),
$hostOrService->host_name,
$hostOrService->service_description
);
} elseif (isset($hostOrService->host_name)) {
// Assume host
$command = sprintf(
$notification->getFormatString(self::TYPE_HOST),
$hostOrService->host_name
);
} else {
continue;
}
$msg .= ';'.$optionsVarList;
$msg .= ';'.$comment->author;
$msg .= ';'.$comment->comment;
$this->send($msg);
$this->send($command);
}
}

109
library/Icinga/Protocol/Commandpipe/CustomNotification.php Normal file
View File

@ -0,0 +1,109 @@
<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
namespace Icinga\Protocol\Commandpipe;
/**
* Custom notification about hosts or services sent to Icinga's command pipe
*/
class CustomNotification
{
/**
* Notification comment
*
* @var string
*/
private $comment;
/**
* Notification author
*
* @var string
*/
private $author;
/**
* Whether to force the notification to be sent out, regardless of the time restrictions, whether or not
* notifications are enabled, etc.
*
* @var bool
*/
private $forced;
/**
* Whether the notification is sent out to all normal (non-escalated) and escalated contacts
*
* @var bool
*/
private $broadcast;
/**
* 1 = Broadcast (send notification to all normal and all escalated contacts for the host)
*/
const NOTIFY_BROADCAST = 1;
/**
* 2 = Forced (notification is sent out regardless of current time, whether or not notifications are enabled, etc.)
*/
const NOTIFY_FORCED = 2;
/**
* Constructor
*
* @param string $author Notification author
* @param string $comment Notification comment
* @param bool $forced Whether to force the notification to be sent out, regardless of the time
* restrictions, whether or not notifications are enabled, etc.
* @param bool $broadcast Whether the notification is sent out to all normal (non-escalated) and escalated
* contacts
*/
public function __construct($author, $comment, $forced = false, $broadcast = false)
{
$this->author = $author;
$this->comment = $comment;
$this->forced = $forced;
$this->broadcast = $broadcast;
}
/**
* Get Custom Notification command format string according to if its sent to a host or a service
*
* @param string $type Identifier for either host or service
*
* @return string
*
* @throws InvalidCommandException When the given type is unknown
* @see \Icinga\Protocol\Commandpipe\CommandPipe::TYPE_HOST
* @see \Icinga\Protocol\Commandpipe\CommandPipe::TYPE_SERVICE
*/
public function getFormatString($type)
{
switch ($type) {
case CommandPipe::TYPE_HOST:
$format = '%s';
break;
case CommandPipe::TYPE_SERVICE:
$format = '%s;%s';
break;
default:
throw new InvalidCommandException('Custom Notifications can only apply on hosts and services');
}
$options = 0;
if ($this->forced) {
$options |= self::NOTIFY_FORCED;
}
if ($this->broadcast) {
$options |= self::NOTIFY_BROADCAST;
}
// Build the command
$command = 'SEND_CUSTOM_' . $type . '_NOTIFICATION;'
. $format . ';'
. $options . ';'
. $this->author . ';'
. $this->comment;
return $command;
}
}

7
modules/monitoring/application/controllers/CommandController.php
View File

@ -431,12 +431,7 @@ class Monitoring_CommandController extends ModuleActionController
$this->setForm($form);
if ($form->IsSubmittedAndValid() === true) {
$author = $this->getRequest()->getUser()->getUsername();
$this->target->sendCustomNotification(
$this->view->objects,
new Comment($author, $form->getComment()),
$form->getOptions()
);
$this->target->sendCustomNotification($this->view->objects, $form->getCustomNotification());
}
}

85
modules/monitoring/application/forms/Command/CustomNotificationForm.php
View File

@ -28,7 +28,8 @@
namespace Monitoring\Form\Command;
use Zend_Form_Element_Hidden;
use \Icinga\Web\Form\Element\Note;
use \Icinga\Protocol\Commandpipe\CustomNotification;
/**
* For for command CustomNotification
@ -36,11 +37,23 @@ use Zend_Form_Element_Hidden;
class CustomNotificationForm extends CommandForm
{
/**
* Interface method to build the form
* @see CommandForm::create
* Create the form's elements
*/
protected function create()
{
$this->addElement(
new Note(
array(
'name' => 'commanddescription',
'value' => t(
'This command is used to send a custom notification about hosts or services. Useful in '
. 'emergencies when you need to notify admins of an issue regarding a monitored system or '
. 'service.'
)
)
)
);
$this->addElement($this->createAuthorField());
$this->addElement(
@ -52,14 +65,38 @@ class CustomNotificationForm extends CommandForm
'required' => true
)
);
$this->addElement(
new Note(
array(
'name' => 'commentnote',
'value' => t(
'If you work with other administrators, you may find it useful to share information '
. 'about a host or service that is having problems if more than one of you may be working on '
. 'it. Make sure you enter a brief description of what you are doing.'
)
)
)
);
$this->addElement(
'checkbox',
'force',
'forced',
array(
'label' => t('Forced')
)
);
$this->addElement(
new Note(
array(
'name' => 'forcenote',
'value' => t(
'Custom notifications normally follow the regular notification logic in Icinga. Selecting this '
. 'option will force the notification to be sent out, regardless of the time restrictions, '
. 'whether or not notifications are enabled, etc.'
)
)
)
);
$this->addElement(
'checkbox',
@ -68,26 +105,36 @@ class CustomNotificationForm extends CommandForm
'label' => t('Broadcast')
)
);
$this->addElement(
new Note(
array(
'name' => 'broadcastnote',
'value' => t(
'Selecting this option causes the notification to be sent out to all normal (non-escalated) '
. ' and escalated contacts. These options allow you to override the normal notification logic '
. 'if you need to get an important message out.'
)
)
)
);
$this->setSubmitLabel(t('Send custom notification'));
$this->setSubmitLabel(t('Send Custom Notification'));
parent::create();
}
public function getComment()
/**
* Create Custom Notification from request data
*
* @return \Icinga\Protocol\Commandpipe\CustomNotification
*/
public function getCustomNotification()
{
return $this->getValue('comment');
}
public function getOptions()
{
$value = 0;
if ($this->getValue('force')) {
$value |= 2;
}
if ($this->getValue('broadcast')) {
$value |= 1;
}
return $value;
return new CustomNotification(
$this->getAuthorName(),
$this->getValue('comment'),
$this->getValue('forced'),
$this->getValue('broadcast')
);
}
}