icingaweb2/modules/monitoring/application/controllers/MultiController.php

<?php
// {{{ICINGA_LICENSE_HEADER}}}
/**
 * This file is part of Icinga Web 2.
 *
 * Icinga Web 2 - 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}}}

use \Icinga\Web\Form;
use \Icinga\Web\Controller\ActionController;
use \Icinga\Web\Widget\Tabextension\OutputFormat;
use \Icinga\Module\Monitoring\Backend;
use \Icinga\Data\BaseQuery;
use \Icinga\Web\Widget\Chart\InlinePie;
use \Icinga\Module\Monitoring\Form\Command\MultiCommandFlagForm;
use \Icinga\Module\Monitoring\DataView\HostStatus    as HostStatusView;
use \Icinga\Module\Monitoring\DataView\ServiceStatus as ServiceStatusView;
use \Icinga\Module\Monitoring\DataView\Comment       as CommentView;

/**
 * Displays aggregations collections of multiple objects.
 */
class Monitoring_MultiController extends ActionController
{
    public function init()
    {
        $this->view->queries = $this->getAllParamsAsArray();
        $this->backend = Backend::createBackend($this->_getParam('backend'));
        $this->createTabs();
    }

    public function hostAction()
    {
        $filters = $this->view->queries;
        $errors  = array();

        // Fetch Hosts
        $hostQuery = HostStatusView::fromRequest(
            $this->_request,
            array(
                'host_name',
                'host_in_downtime',
                'host_unhandled_service_count',
                'host_passive_checks_enabled',
                'host_obsessing',
                'host_notifications_enabled',
                'host_event_handler_enabled',
                'host_flap_detection_enabled',
                'host_active_checks_enabled'
            )
        )->getQuery();
        if ($this->_getParam('host') !== '*') {
            $this->applyQueryFilter($hostQuery, $filters);
        }
        $hosts = $hostQuery->fetchAll();

        // Fetch comments
        $commentQuery = $this->applyQueryFilter(
            CommentView::fromRequest($this->_request)->getQuery(),
            $filters,
            'comment_host'
        );
        $comments = array_keys($this->getUniqueValues($commentQuery->fetchAll(), 'comment_internal_id'));

        // Populate view
        $this->view->objects   = $this->view->hosts = $hosts;
        $this->view->problems  = $this->getProblems($hosts);
        $this->view->comments  = isset($comments) ? $comments : $this->getComments($hosts);
        $this->view->hostnames = $this->getProperties($hosts, 'host_name');
        $this->view->downtimes = $this->getDowntimes($hosts);
        $this->view->errors    = $errors;
        $this->view->states    = $this->countStates($hosts);
        $this->view->pie       = $this->createPie($this->view->states);

        // Handle configuration changes
        $this->handleConfigurationForm(array(
            'host_passive_checks_enabled' => 'Passive Checks',
            'host_active_checks_enabled'  => 'Active Checks',
            'host_obsessing'              => 'Obsessing',
            'host_notifications_enabled'  => 'Notifications',
            'host_event_handler_enabled'  => 'Event Handler',
            'host_flap_detection_enabled' => 'Flap Detection'
        ));
    }


    public function serviceAction()
    {
        $filters = $this->view->queries;
        $errors = array();

        $backendQuery = ServiceStatusView::fromRequest(
            $this->_request,
            array(
                'host_name',
                'host_state',
                'service_description',
                'service_handled',
                'service_state',
                'service_in_downtime',
                'service_passive_checks_enabled',
                'service_notifications_enabled',
                'service_event_handler_enabled',
                'service_flap_detection_enabled',
                'service_active_checks_enabled'
            )
        )->getQuery();
        if ($this->_getParam('service') !== '*' && $this->_getParam('host') !== '*') {
            $this->applyQueryFilter($backendQuery, $filters);
            $this->applyQueryFilter($backendQuery, $filters);
        }
        $services = $backendQuery->fetchAll();

        // Comments
        $commentQuery = $this->applyQueryFilter(
            CommentView::fromRequest($this->_request)->getQuery(),
            $filters,
            'comment_host',
            'comment_service'
        );
        $comments = array_keys($this->getUniqueValues($commentQuery->fetchAll(), 'comment_internal_id'));

        $this->view->objects        = $this->view->services = $services;
        $this->view->problems       = $this->getProblems($services);
        $this->view->comments       = isset($comments) ? $comments : $this->getComments($services);
        $this->view->hostnames      = $this->getProperties($services, 'host_name');
        $this->view->servicenames   = $this->getProperties($services, 'service_description');
        $this->view->downtimes      = $this->getDowntimes($services);
        $this->view->service_states = $this->countStates($services);
        $this->view->host_states    =  $this->countStates($services, 'host_name', 'host_state');
        $this->view->service_pie    = $this->createPie($this->view->service_states);
        $this->view->host_pie       = $this->createPie($this->view->host_states);
        $this->view->errors         = $errors;

        $this->handleConfigurationForm(array(
            'service_passive_checks_enabled' => 'Passive Checks',
            'service_active_checks_enabled'  => 'Active Checks',
            'service_notifications_enabled'  => 'Notifications',
            'service_event_handler_enabled'  => 'Event Handler',
            'service_flap_detection_enabled' => 'Flap Detection'
        ));
    }


    /**
     * Apply the query-filter received
     *
     * @param $backendQuery  BaseQuery  The query to apply the filter to
     * @param $filter        array      Containing the queries of the current request, converted into an
     *                                      array-structure.
     * @param $hostColumn    string     The name of the host-column in the BaseQuery, defaults to 'host_name'
     * @param $serviceColumn string     The name of the service-column in the BaseQuery, defaults to 'service-description'
     *
     * @return BaseQuery    The given BaseQuery
     */
    private function applyQueryFilter(
        BaseQuery $backendQuery,
        array $filter,
        $hostColumn = 'host_name',
        $serviceColumn = 'service_description'
    ) {
        // fetch specified hosts
        foreach ($filter as $index => $expr) {
            // Every query entry must define at least the host.
            if (!array_key_exists('host', $expr)) {
                $errors[] = 'Query ' . $index . ' misses property host.';
                continue;
            }
            // apply filter expressions from query
            $backendQuery->orWhere($hostColumn, $expr['host']);
            if (array_key_exists('service', $expr)) {
                $backendQuery->andWhere($serviceColumn, $expr['service']);
            }
        }
        return $backendQuery;
    }

    /**
     * Create an array with all unique values as keys.
     *
     * @param array $values     The array containing the objects
     * @param       $key        The key to access
     *
     * @return array
     */
    private function getUniqueValues($values, $key)
    {
        $unique = array();
        foreach ($values as $value)
        {
			if (is_array($value)) {
				$unique[$value[$key]] = $value[$key];
			} else {
            	$unique[$value->$key] = $value->$key;
			}
        }
        return $unique;
    }

    /**
     * Get the numbers of problems of the given objects
     *
     * @param $objects  The objects containing the problems
     *
     * @return int  The problem count
     */
    private function getProblems($objects)
    {
        $problems = 0;
        foreach ($objects as $object) {
            if (property_exists($object, 'host_unhandled_service_count')) {
                $problems += $object->host_unhandled_service_count;
            } else if (
                property_exists($object, 'service_handled') &&
                !$object->service_handled &&
                $object->service_state > 0
            ) {
                $problems++;
            }
        }
        return $problems;
    }

    private function countStates($objects, $unique = null, $state = 'service_state')
    {
        $known = array();
        $states = array(
            '0'  => 0,
            '1'  => 0,
            '2'  => 0,
            '3'  => 0,
            '99' => 0
        );
        foreach ($objects as $object) {
            if (isset($unique)) {
                if (array_key_exists($object->$unique, $known)) {
                    continue;
                }
                $known[$object->$unique] = true;
            }
            $states[$object->$state]++;
        }
        return array(
            'up'          => $states['0'],
            'down'        => $states['1'],
            'unreachable' => $states['2'],
            'unknown'     => $states['3'],
            'pending'     => $states['99']
        );
    }

    private function createPie($states)
    {
        $chart = new InlinePie(
            array_values($states),
            array('#44bb77', '#FF5566', '#FF5566', '#E066FF', '#77AAFF')
        );
        $chart->setLabels(array_keys($states))
            ->setHeight(100)
            ->setWidth(100);
        return $chart;
    }


    private function getComments($objects)
    {
        $unique = array();
        foreach ($objects as $object) {
            $unique = array_merge($unique, $this->getUniqueValues($object->comments, 'comment_internal_id'));
        }
        return array_keys($unique);
    }

    private function getProperties($objects, $property)
    {
        $objectnames = array();
        foreach ($objects as $object) {
            $objectnames[] = $object->$property;
        }
        return $objectnames;
    }

    private function getDowntimes($objects)
    {
        $downtimes = array();
        foreach ($objects as $object)
        {
            if (
                (property_exists($object, 'host_in_downtime') && $object->host_in_downtime) ||
                (property_exists($object, 'service_in_downtime') && $object->service_in_downtime)
            ) {
                $downtimes[] = true;
            }
        }
        return $downtimes;
    }


    /**
     * Handle the form to edit configuration flags.
     *
     * @param $flags array  The used flags.
     */
    private function handleConfigurationForm(array $flags)
    {
        $this->view->form = $form = new MultiCommandFlagForm($flags);
        $this->view->formElements = $form->buildCheckboxes();
        $form->setRequest($this->_request);
        if ($form->isSubmittedAndValid()) {
            // TODO: Handle commands
            $changed = $form->getChangedValues();
        }
        if ($this->_request->isPost() === false) {
            $this->view->form->initFromItems($this->view->objects);
        }
    }

    /**
     * "Flips" the structure of the objects created by _getAllParams
     *
     * Regularly, _getAllParams would return queries like <b>host[0]=value1&service[0]=value2</b> as
     * two entirely separate arrays. Instead, we want it as one single array, containing one single object
     * for each index, containing all of its members as keys.
     *
     * @return array    An array of all query parameters (See example above)
     *                  <b>
     *                      array( <br />
     *                          0 => array(host => value1, service => value2), <br />
     *                          ... <br />
     *                      )
     *                  </b>
     */
    private function getAllParamsAsArray()
    {
        $details = $this->_getAllParams();
        $queries = array();

        foreach ($details as $property => $values) {
            if (!is_array($values)) {
                continue;
            }
            foreach ($values as $index => $value) {
                if (!array_key_exists($index, $queries)) {
                    $queries[$index] = array();
                }
                $queries[$index][$property] = $value;
            }
        }
        return $queries;
    }

    /**
     * Return all tabs for this controller
     *
     * @return Tabs
     */
    private function createTabs()
    {
        $tabs = $this->getTabs();
        $tabs->extend(new OutputFormat());
    }
}