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

<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}

namespace Icinga\Module\Monitoring\Form\Command;

use Icinga\Module\Monitoring\Object\MonitoredObject;
use Zend_Form_Element_Text;
use Zend_Validate_GreaterThan;
use Zend_Validate_Digits;
use Icinga\Web\Form\Element\DateTimePicker;
use Icinga\Protocol\Commandpipe\Comment;
use Icinga\Util\DateTimeFactory;
use Icinga\Module\Monitoring\Backend;
use Icinga\Module\Monitoring\Command\ScheduleDowntimeCommand;
use Icinga\Module\Monitoring\Object\Service;
use Icinga\Web\Url;

/**
 * Form for scheduling downtimes
 */
class ScheduleDowntimeForm extends WithChildrenCommandForm
{
    /**
     * Type constant for fixed downtimes
     */
    const  TYPE_FIXED = 'fixed';

    /**
     * Type constant for flexible downtimes
     */
    const TYPE_FLEXIBLE = 'flexible';

    private $downtimes;

    /**
     * Initialize form
     */
    public function init()
    {
        $this->setName('ScheduleDowntimeForm');
    }

    /**
     * Generate translated multi options based on type constants
     *
     * @return array
     */
    private function getDowntimeTypeOptions()
    {
        return array(
            self::TYPE_FIXED    => t('Fixed'),
            self::TYPE_FLEXIBLE => t('Flexible')
        );
    }

    /**
     * Fetch all available downtimes from the database
     *
     * @return array
     */
    private function getCurrentDowntimes()
    {
        if (isset($this->downtimes)) {
            return $this->downtimes;
        }

        $cfg = $this->getConfiguration();
        $preferences = $this->getUserPreferences();
        $object = MonitoredObject::fromParams(Url::fromRequest()->getParams());
        $object->fetchDowntimes();
        $downtimes = $object->downtimes;
/*

        $downtimes = Backend::createBackend($this->getRequest()->getParam('backend'))->select()
            ->from(
                'downtime',
                array(
                    'host',
                    'service',
                    'downtime_start',
                    'downtime_scheduled_start_time',
                    'downtime_internal_downtime_id'
                )
            )->fetchAll();
*/
        $options = array(
            '0' =>  'No Triggered Downtime'
        );
        $dateFormat = $this->getView()->dateFormat();
        foreach ($downtimes as $downtime) {
            $label = sprintf(
                'ID %s: %s%s Starting @ %s',
                $downtime->id,
                $object->host_name,
                $object instanceof Service ? ' (' . $object->service_description . ')' : '',
                $dateFormat->formatDateTime($downtime->scheduled_start)
            );
            $options[$downtime->id] = $label;
        }
        return $options;
    }

    /**
     * Set the downtimes displayed by this form (used for testing)
     *
     * @param   array   $downtimes  list of strings
     */
    public function setCurrentDowntimes($downtimes)
    {
        $this->downtimes = $downtimes;
    }

    /**
     * Create the form's elements
     */
    protected function create()
    {
        $this->addNote(
            t(
                'This command is used to schedule downtime for hosts/services. During the specified downtime, '
                . 'Icinga will not send notifications out about the affected objects. When the scheduled '
                . 'downtime expires, Icinga will send out notifications as it normally would. Scheduled '
                . 'downtimes are preserved across program shutdowns and restarts.'
            )
        );

        $this->addElement($this->createAuthorField());

        $this->addElement(
            'textarea',
            'comment',
            array(
                'label'    => t('Comment'),
                'rows'     => 4,
                'cols'     => 72,
                'required' => true,
                'helptext' => 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(
            'select',
            'triggered',
            array(
                'label'        => t('Triggered by'),
                'required'     => true,
                'multiOptions' => $this->getCurrentDowntimes()
            )
        );

        $now = DateTimeFactory::create();

        $this->addElement(
            new DateTimePicker(
                array(
                    'name'      => 'starttime',
                    'label'     => t('Start Time'),
                    'value'     => $now->getTimestamp(),
                    'patterns'  => $this->getValidDateTimeFormats(),
                    'helptext'  => t('Set the start date/time for the downtime.')
                )
            )
        );
        $this->addElement(
            new DateTimePicker(
                array(
                    'name'      => 'endtime',
                    'label'     => t('End Time'),
                    'value'     => $now->getTimestamp() + 3600,
                    'patterns'  => $this->getValidDateTimeFormats(),
                    'helptext'  => t('Set the end date/time for the downtime.')
                )
            )
        );

        $this->addElement(
            'select',
            'type',
            array(
                'label'        => t('Downtime Type'),
                'multiOptions' => $this->getDowntimeTypeOptions(),
                'required'     => true,
                'validators'   => array(
                    array(
                        'InArray',
                        true,
                        array(
                            array_keys($this->getDowntimeTypeOptions())
                        )
                    )
                ),
                'helptext'     => t(
                    'If you select the fixed option, the downtime will be in effect between the start and end '
                    . 'times you specify whereas a flexible downtime starts when the service enters a non-OK state '
                    . '(sometime between the start and end times you specified) and lasts as long as the duration '
                    . 'of time you enter. The duration fields do not apply for fixed downtime.'
                )
            )
        );
        $this->enableAutoSubmit(array('type'));

        if ($this->getRequest()->getPost('type') === self::TYPE_FLEXIBLE) {
            $hoursText = new Zend_Form_Element_Text('hours');
            $hoursText->setLabel(t('Flexible Duration'));
            $hoursText->setAttrib('style', 'width: 40px;');
            $hoursText->setValue(1);
            $hoursText->addDecorator('HtmlTag', array('tag' => 'dd', 'openOnly' => true));
            $hoursText->addDecorator(
                'Callback',
                array(
                    'callback' => function () {
                        return t('Hours');
                    }
                )
            );
            $minutesText = new Zend_Form_Element_Text('minutes');
            $minutesText->setLabel(t('Minutes'));
            $minutesText->setAttrib('style', 'width: 40px;');
            $minutesText->setValue(0);
            $minutesText->removeDecorator('HtmlTag');
            $minutesText->removeDecorator('Label');
            $minutesText->addDecorator(
                'Callback',
                array(
                    'callback' => function () {
                        return t('Minutes');
                    }
                )
            );
            $this->addElements(array($hoursText, $minutesText));
            $this->addNote(
                t(
                    'Enter here the duration of the downtime. Icinga will automatically delete the downtime '
                    . 'after this time expired.'
                )
            );
        }

        // TODO: As of the time of writing it's possible to set hosts AND services as affected by this command but
        // with children only makes sense on hosts
        if ($this->getWithChildren() === true) {
            $this->addNote(t('TODO: Help message when with children is enabled'));
        } else {
            $this->addElement(
                'select',
                'childobjects',
                array(
                    'label'        => t('Child Objects'),
                    'required'     => true,
                    'multiOptions' => array(
                        0 => t('Do nothing with child objects'),
                        1 => t('Schedule triggered downtime for all child objects'),
                        2 => t('Schedule non-triggered downtime for all child objects')
                    ),
                    'validators'   => array(
                        array(
                            'Digits',
                            true
                        ),
                        array(
                            'InArray',
                            true,
                            array(
                                array(0, 1, 2)
                            )
                        )
                    )
                )
            );
            $this->addNote(t('TODO: Help message when with children is disabled'));
        }

        $this->setSubmitLabel(t('Schedule Downtime'));

        parent::create();
    }

    /**
     * Change validators at runtime
     *
     * @param array $data   The user provided data that will go into validation
     *
     * @see Form::preValidation
     */
    protected function preValidation(array $data)
    {
        /*
         * Other values needed when downtime type change to flexible
         */
        if (isset($data['type']) && $data['type'] === self::TYPE_FLEXIBLE) {
            $greaterThanValidator = new Zend_Validate_GreaterThan(-1);
            $digitsValidator = new Zend_Validate_Digits();

            $hours = $this->getElement('hours');
            $hours->setRequired(true);
            $hours->addValidator($digitsValidator, true);
            $hours->addValidator($greaterThanValidator, true);

            $minutes = $this->getElement('minutes');
            $minutes->setRequired(true);
            $minutes->addValidator($digitsValidator, true);
            $minutes->addValidator($greaterThanValidator, true);
        }
    }

    /**
     * Create ScheduleDowntimeCommand object
     *
     * @return ScheduleDowntimeCommand
     */
    public function createCommand()
    {
        // TODO: Add support for host-/servicegroups and services only (#4588)
        $command = new ScheduleDowntimeCommand(
            $this->getValue('starttime'),
            $this->getValue('endtime'),
            new Comment(
                $this->getRequest()->getUser()->getUsername(),
                $this->getValue('comment')
                ),
            $this->getValue('type') === self::TYPE_FIXED,
            $this->getValue('hours') * 3600 + $this->getValue('minutes') * 60,
            $this->getValue('triggered')
        );

        return $command->includeChildren(
            $this->getWithChildren(),
            $this->getValue('childobjects') === 1
        );
    }
}