summaryrefslogtreecommitdiffstats
path: root/library/Eventdb/Eventdb.php
blob: b8852582bfc187088c926dc3128c8fc760d5e03e (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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<?php
/* Icinga Web 2 | (c) 2016 Icinga Development Team | GPLv2+ */

namespace Icinga\Module\Eventdb;

use Icinga\Application\Config;
use Icinga\Data\ConfigObject;
use Icinga\Data\Filter\Filter;
use Icinga\Data\Filter\FilterExpression;
use Icinga\Data\ResourceFactory;
use Icinga\Exception\ConfigurationError;
use Icinga\Repository\DbRepository;
use Icinga\Repository\RepositoryQuery;

class Eventdb extends DbRepository
{
    /**
     * {@inheritdoc}
     */
    const DATETIME_FORMAT = 'Y-m-d G:i:s';

    /**
     * {@inheritdoc}
     */
    protected $tableAliases = array(
        'comment' => 'c',
        'event'   => 'e',
    );

    /**
     * Default query columns
     *
     * @var array
     */
    protected static $defaultQueryColumns = array(
        'event'   => array(
            'id',
            'host_name',
            'host_address',
            'type',
            'facility',
            'priority',
            'program',
            'message',
            'alternative_message',
            'ack',
            'created',
            'modified',
        ),
        'comment' => array(
            'id',
            'event_id',
            'type',
            'message',
            'created',
            'modified',
            'user'
        )
    );

    protected static $edbcQueryColumns = array(
        'event' => array(
            'group_active',
            'group_id',
            'group_count',
            'group_leader',
            'group_autoclear',
            'flags',
            'alternative_message'
        )
    );

    /** @var bool */
    protected $hasCorrelatorExtensions = null;

    /**
     * Checks if Event repository has EDBC columns
     *
     * @return bool
     */
    public function hasCorrelatorExtensions()
    {
        if ($this->hasCorrelatorExtensions === null) {
            $dba = $this->getDataSource()->getDbAdapter();
            $result = $dba->fetchRow("SHOW COLUMNS FROM `event` LIKE 'group_leader'");

            $this->hasCorrelatorExtensions = ! ! $result;
        }
        return $this->hasCorrelatorExtensions;
    }

    public function filterGroups(RepositoryQuery $query)
    {
        if ($this->hasCorrelatorExtensions()) {
            $query->addFilter(Filter::matchAny(
                Filter::expression('group_leader', '=', -1),
                new FilterExpression('group_leader', 'IS', new \Zend_Db_Expr('NULL'))
            ));
        }
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    protected function initializeQueryColumns()
    {
        $additionalColumns = Config::module('eventdb', 'columns')->keys();
        $queryColumns = static::$defaultQueryColumns;
        if ($this->hasCorrelatorExtensions()) {
            foreach (static::$edbcQueryColumns as $table => $fields) {
                if (array_key_exists($table, $queryColumns)) {
                    $queryColumns[$table] = array_merge($queryColumns[$table], $fields);
                } else {
                    $queryColumns[$table] = $fields;
                }
            }
        }
        if ($additionalColumns !== null) {
            $eventColumns = $queryColumns['event'];
            $queryColumns['event'] = array_merge($eventColumns, array_diff($additionalColumns, $eventColumns));
        }
        return $queryColumns;
    }

    /**
     * Create and return a new instance of the Eventdb
     *
     * @param   ConfigObject    $config     The configuration to use, otherwise the module's configuration
     *
     * @return  static
     *
     * @throws  ConfigurationError          In case no resource has been configured in the module's configuration
     */
    public static function fromConfig(ConfigObject $config = null)
    {
        if ($config === null) {
            $moduleConfig = Config::module('eventdb');
            if (($resourceName = $moduleConfig->get('backend', 'resource')) === null) {
                throw new ConfigurationError(
                    mt('eventdb', 'You need to configure a resource to access the EventDB database first')
                );
            }

            $resource = ResourceFactory::create($resourceName);
        } else {
            $resource = ResourceFactory::createResource($config);
        }

        return new static($resource);
    }

    /**
     * {@inheritdoc}
     */
    protected function initializeConversionRules()
    {
        return array('event' => array('host_address' => 'ip_address'));
    }

    /**
     * Convert an IP address into its human-readable form
     *
     * @param   string  $rawAddress
     *
     * @return  string
     */
    protected function retrieveIpAddress($rawAddress)
    {
        return $rawAddress === null ? null : inet_ntop($rawAddress);
    }

    /**
     * Convert an IP address into its binary form
     *
     * @param   string  $address
     *
     * @return  string
     */
    protected function persistIpAddress($address)
    {
        return $address === null ? null : inet_pton($address);
    }
}