icingaweb2/library/Icinga/Web/Widget/SearchDashboard.php

<?php
/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */

namespace Icinga\Web\Widget;

use Icinga\Exception\Http\HttpNotFoundException;
use Icinga\Application\Icinga;
use Icinga\Web\Dashboard\DashboardHome;
use Icinga\Web\Dashboard\Dashlet;
use Icinga\Web\Url;

/**
 * Class SearchDashboard display multiple search views on a single search page
 */
class SearchDashboard extends \Icinga\Web\Dashboard\Dashboard
{
    /**
     * Name for the search home
     *
     * @var string
     */
    const SEARCH_HOME = 'Search Home';

    /**
     * Name for the search pane
     *
     * @var string
     */
    const SEARCH_PANE = 'search';

    /**
     * Dashboard home of this search dashboard
     *
     * @var DashboardHome
     */
    protected $searchHome;

    public function __construct()
    {
        $this->searchHome = new DashboardHome(self::SEARCH_HOME);
    }

    public function getTabs()
    {
        if ($this->tabs === null) {
            $this->tabs = new \ipl\Web\Widget\Tabs();

            $this->tabs->add(
                'search',
                array(
                    'title' => t('Show Search', 'dashboard.pane.tooltip'),
                    'label' => t('Search'),
                    'url'   => Url::fromRequest()
                )
            );
        }

        return $this->tabs;
    }

    public function getActiveHome()
    {
        return $this->searchHome;
    }

    /**
     * Load all available search dashlets from modules
     *
     * @param   string $searchString
     *
     * @return  $this
     */
    public function search($searchString = '')
    {
        $pane = $this->searchHome->createEntry(self::SEARCH_PANE)->getEntry(self::SEARCH_PANE);
        $pane->setTitle(t('Search'));
        $this->activate(self::SEARCH_PANE);

        $manager = Icinga::app()->getModuleManager();
        $searchUrls = array();

        foreach ($manager->getLoadedModules() as $module) {
            if (self::getUser()->can($manager::MODULE_PERMISSION_NS . $module->getName())) {
                $moduleSearchUrls = $module->getSearchUrls();
                if (! empty($moduleSearchUrls)) {
                    if ($searchString === '') {
                        $pane->createEntry(t('Ready to search'), 'search/hint');
                        return $this;
                    }
                    $searchUrls = array_merge($searchUrls, $moduleSearchUrls);
                }
            }
        }

        usort($searchUrls, array($this, 'compareSearchUrls'));

        foreach (array_reverse($searchUrls) as $searchUrl) {
            $title = $searchUrl->title . ': ' . $searchString;
            $pane->createEntry($title, Url::fromPath($searchUrl->url, array('q' => $searchString)));
            $pane->getEntry($title)->setProgressLabel(t('Searching'));
        }

        return $this;
    }

    protected function assemble()
    {
        if (! $this->searchHome->getEntry(self::SEARCH_PANE)->hasEntries()) {
            throw new HttpNotFoundException(t('Page not found'));
        }

        /** @var Dashlet $dashlet */
        foreach ($this->searchHome->getEntry(self::SEARCH_PANE)->getEntries() as $dashlet) {
            $this->addHtml($dashlet->getHtml());
        }
    }

    /**
     * Compare search URLs based on their priority
     *
     * @param   object  $a
     * @param   object  $b
     *
     * @return  int
     */
    private function compareSearchUrls($a, $b)
    {
        if ($a->priority === $b->priority) {
            return 0;
        }
        return ($a->priority < $b->priority) ? -1 : 1;
    }
}