summaryrefslogtreecommitdiffstats
path: root/modules/doc/application/controllers/SearchController.php
blob: 6d26f5220773f988794d12ea07a3d08fc82289fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<?php
/* Icinga Web 2 | (c) 2015 Icinga Development Team | GPLv2+ */

namespace Icinga\Module\Doc\Controllers;

use Icinga\Application\Icinga;
use Icinga\Module\Doc\DocController;
use Icinga\Module\Doc\DocParser;
use Icinga\Module\Doc\Exception\DocException;
use Icinga\Module\Doc\Renderer\DocSearchRenderer;
use Icinga\Module\Doc\Search\DocSearch;
use Icinga\Module\Doc\Search\DocSearchIterator;

class SearchController extends DocController
{
    /**
     * Render search
     */
    public function indexAction()
    {
        $parser = new DocParser($this->getWebPath());
        $search = new DocSearchRenderer(
            new DocSearchIterator(
                $parser->getDocTree()->getIterator(),
                new DocSearch($this->params->get('q'))
            )
        );
        $search->setUrl('doc/icingaweb/chapter');
        if (strlen($this->params->get('q')) < 3) {
            $this->view->searches = array();
            return;
        }
        $searches = array(
            'Icinga Web 2' => $search
        );
        foreach (Icinga::app()->getModuleManager()->listEnabledModules() as $module) {
            if (($path = $this->getModulePath($module)) !== null) {
                try {
                    $parser = new DocParser($path);
                    $search = new DocSearchRenderer(
                        new DocSearchIterator(
                            $parser->getDocTree()->getIterator(),
                            new DocSearch($this->params->get('q'))
                        )
                    );
                } catch (DocException $e) {
                    continue;
                }
                $search
                    ->setUrl('doc/module/chapter')
                    ->setUrlParams(array('moduleName' => $module));
                $searches[$module] = $search;
            }
        }
        $this->view->searches = $searches;
    }

    /**
     * Get the path to a module's documentation
     *
     * @param   string  $module
     *
     * @return  string|null
     */
    protected function getModulePath($module)
    {
        if (is_dir(($path = Icinga::app()->getModuleManager()->getModuleDir($module, '/doc')))) {
            return $path;
        }
        if (($path = $this->Config()->get('documentation', 'modules')) !== null) {
            $path = str_replace('{module}', $module, $path);
            if (is_dir($path)) {
                return $path;
            }
        }
        return null;
    }

    /**
     * Get the path to Icinga Web 2's documentation
     *
     * @return ?string
     */
    protected function getWebPath()
    {
        $path = Icinga::app()->getBaseDir('doc');
        if (is_dir($path)) {
            return $path;
        }
        if (($path = $this->Config()->get('documentation', 'icingaweb2')) !== null) {
            if (is_dir($path)) {
                return $path;
            }
        }
        $this->httpNotFound($this->translate('Documentation for Icinga Web 2 is not available'));
    }
}