icingaweb2/modules/monitoring/application/forms/Command/SubmitPassiveCheckResultForm.php

<?php
// {{{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>
 */
// {{{ICINGA_LICENSE_HEADER}}}

namespace Monitoring\Form\Command;

use \Icinga\Exception\ProgrammingError;

/**
 * Form for submitting passive check results
 */
class SubmitPassiveCheckResultForm extends CommandForm
{
    /**
     * Type constant for host form
     */
    const TYPE_HOST = 'host';

    /**
     * Type constant for service form
     */
    const TYPE_SERVICE = 'service';

    /**
     * List of choices for plugin states
     * @var array
     */
    private static $options = array();

    /**
     * Type of form
     * @var string
     */
    private $type;

    /**
     * Setup plugin states
     *
     * @see Zend_Form::init
     */
    public function init()
    {
        if (!count(self::$options)) {
            self::$options = array(
                self::TYPE_HOST => array(
                    0 => t('UP'),
                    1 => t('DOWN'),
                    2 => t('UNREACHABLE')
                ),
                self::TYPE_SERVICE => array(
                    0 => t('OK'),
                    1 => t('WARNING'),
                    2 => t('CRITICAL'),
                    3 => t('UNKNOWN')
                )
            );
        }

        parent::init();
    }


    /**
     * Setter for type
     *
     * @param string $type
     */
    public function setType($type)
    {
        $this->type = $type;
    }

    /**
     * Getter for type
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Return array of options
     *
     * @return array
     * @throws \Icinga\Exception\ProgrammingError
     */
    public function getOptions()
    {
        if (in_array($this->getType(), array(self::TYPE_HOST, self::TYPE_SERVICE)) === false) {
            throw new ProgrammingError('Type is not valid');
        }

        return self::$options[$this->getType()];
    }

    /**
     * Create the form's elements
     */
    protected function create()
    {
        $this->addNote(
            t(
                'This command is used to submit a passive check result for particular hosts/services. It is '
                . 'particularly useful for resetting security-related objects to OK states once they have been '
                . 'dealt with.'
            )
        );

        $this->addElement(
            'select',
            'pluginstate',
            array(
                'label'        => t('Check Result'),
                'multiOptions' => $this->getOptions(),
                'required'     => true,
                'validators'   => array(
                    array(
                        'Digits',
                        true
                    ),
                    array(
                        'InArray',
                        true,
                        array(
                            array_keys($this->getOptions())
                        )
                    )
                ),
                'helptext'     => t('Set the state which should be send to Icinga for this objects.')
            )
        );

        $this->addElement(
            'textarea',
            'checkoutput',
            array(
                'label'    => t('Check Output'),
                'rows'     => 2,
                'required' => true,
                'helptext' => t('Fill in the check output string which should be send to Icinga.')
            )
        );

        $this->addElement(
            'textarea',
            'performancedata',
            array(
                'label'    => t('Performance Data'),
                'rows'     => 2,
                'helptext' => t('Fill in the performance data string which should be send to Icinga.')
            )
        );

        $this->setSubmitLabel(t('Submit Passive Check Result'));

        parent::create();
    }

    /**
     * Return the entered object state as an integer
     *
     * @return int
     */
    public function getState()
    {
        return intval($this->getValue('pluginstate'));
    }

    /**
     * Return the entered check output as a string
     *
     * @return string
     */
    public function getOutput()
    {
        return $this->getValue('checkoutput');
    }

    /**
     * Return the entered performance data as a string
     *
     * @return string
     */
    public function getPerformancedata()
    {
        return $this->getValue('performancedata');
    }
}