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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2014 Zabbix SIA
**
** 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.
**/
/**
* Class containing common methods for operations with triggers.
*
* @package API
*/
abstract class CTriggerGeneral extends CApiService {
/**
* @abstract
*
* @param array $options
*
* @return array
*/
abstract public function get(array $options = array());
/**
* @abstract
*
* @param array $array
*
* @return array
*/
abstract protected function createReal(array &$array);
/**
* @abstract
*
* @param array $array
*
* @return array
*/
abstract protected function updateReal(array $array);
/**
* Updates the children of the trigger on the given hosts and propagates the inheritance to all child hosts.
* If the given trigger was assigned to a different template or a host, all of the child triggers, that became
* obsolete will be deleted.
*
* @param array $trigger the trigger with an exploded expression
* @param array $hostids
*
* @return bool
*/
protected function inherit(array $trigger, array $hostIds = null) {
$triggerTemplates = API::Template()->get(array(
'triggerids' => $trigger['triggerid'],
'output' => API_OUTPUT_EXTEND,
'nopermissions' => true
));
if (empty($triggerTemplates)) {
// nothing to inherit, just exit
return true;
}
if (!isset($trigger['expression']) || !isset($trigger['description'])) {
$dbTriggers = $this->get(array(
'triggerids' => $trigger['triggerid'],
'output' => array('expression', 'description'),
'nopermissions' => true
));
$dbTrigger = reset($dbTriggers);
if (!isset($trigger['description'])) {
$trigger['description'] = $dbTrigger['description'];
}
if (!isset($trigger['expression'])) {
$trigger['expression'] = explode_exp($dbTrigger['expression']);
}
}
// fetch all of the child hosts
$childHosts = API::Host()->get(array(
'templateids' => zbx_objectValues($triggerTemplates, 'templateid'),
'output' => array('hostid', 'host'),
'preservekeys' => true,
'hostids' => $hostIds,
'nopermissions' => true,
'templated_hosts' => true
));
foreach ($childHosts as $childHost) {
// update the child trigger on the child host
$newTrigger = $this->inheritOnHost($trigger, $childHost, $triggerTemplates);
// propagate the trigger inheritance to all child hosts
$this->inherit($newTrigger);
}
return true;
}
/**
* Updates the child of the templated trigger on the given host. Trigger inheritance will not propagate to
* child hosts.
*
* @param array $trigger a templated trigger
* @param array $chdHost the target host
* @param array $triggerTemplates the templates, to which the templated trigger belongs
*
* @return array|mixed the updated child trigger
*/
protected function inheritOnHost(array $trigger, array $chdHost, array $triggerTemplates) {
$newTrigger = $trigger;
$newTrigger['templateid'] = $trigger['triggerid'];
unset($newTrigger['triggerid']);
if (isset($trigger['dependencies'])) {
$deps = zbx_objectValues($trigger['dependencies'], 'triggerid');
$newTrigger['dependencies'] = replace_template_dependencies($deps, $chdHost['hostid']);
}
$expressionData = new CTriggerExpression();
$expressionData->parse($trigger['expression']);
$newTrigger['expression'] = $trigger['expression'];
// replace template separately in each expression, only in beginning (host part)
$exprPart = end($expressionData->expressions);
do {
foreach ($triggerTemplates as $triggerTemplate) {
if ($triggerTemplate['host'] == $exprPart['host']) {
$exprPart['host'] = $chdHost['host'];
break;
}
}
$newTrigger['expression'] = substr_replace($newTrigger['expression'],
'{'.$exprPart['host'].':'.$exprPart['item'].'.'.$exprPart['function'].'}',
$exprPart['pos'], strlen($exprPart['expression'])
);
}
while ($exprPart = prev($expressionData->expressions));
// check if a child trigger already exists on the host
$childTriggers = $this->get(array(
'filter' => array('templateid' => $newTrigger['templateid']),
'output' => array('triggerid'),
'hostids' => $chdHost['hostid']
));
// yes we have a child trigger, just update it
if ($childTrigger = reset($childTriggers)) {
$newTrigger['triggerid'] = $childTrigger['triggerid'];
}
// no child trigger found
else {
// look for a trigger with the same description and expression
$childTriggers = $this->get(array(
'filter' => array(
'description' => $newTrigger['description'],
'flags' => null
),
'output' => array('triggerid', 'expression'),
'nopermissions' => true,
'hostids' => $chdHost['hostid']
));
foreach ($childTriggers as $childTrigger) {
$tmpExp = explode_exp($childTrigger['expression']);
if (strcmp($tmpExp, $newTrigger['expression']) == 0) {
// we have a trigger with the same description and expression as the parent
// convert it to a template trigger
$newTrigger['triggerid'] = $childTrigger['triggerid'];
break;
}
}
}
$this->checkIfExistsOnHost($newTrigger, $chdHost['hostid']);
if (isset($newTrigger['triggerid'])) {
$this->updateReal($newTrigger);
}
else {
$oldTrigger = $this->get(array(
'triggerids' => $trigger['triggerid'],
'output' => API_OUTPUT_EXTEND,
'preservekeys' => true
));
$oldTrigger = reset($oldTrigger);
unset($oldTrigger['triggerid']);
foreach ($oldTrigger as $key => $value) {
if (!isset($newTrigger[$key])) {
$newTrigger[$key] = $oldTrigger[$key];
}
}
$this->createReal($newTrigger);
$newTrigger = reset($newTrigger);
}
return $newTrigger;
}
/**
* Checks that no trigger with the same description and expression as $trigger exist on the given host.
* Assumes the given trigger is valid.
*
* @throws APIException if at least one trigger exists
*
* @param array $trigger a trigger with an exploded expression
* @param null $hostid
*
* @return void
*/
protected function checkIfExistsOnHost(array $trigger, $hostId = null) {
// skip the check if the description and expression haven't been changed
if (!isset($trigger['description']) && !isset($trigger['expression'])) {
return;
}
// make sure we have all the required data
if (!isset($trigger['description']) || !isset($trigger['expression'])) {
$explodeExpression = !isset($trigger['expression']);
$trigger = $this->extendObject($this->tableName(), $trigger, array('description', 'expression'));
if ($explodeExpression) {
$trigger['expression'] = explode_exp($trigger['expression']);
}
}
$filter = array('description' => $trigger['description']);
if ($hostId) {
$filter['hostid'] = $hostId;
}
else {
$expressionData = new CTriggerExpression($trigger['expression']);
$expressionData->parse($trigger['expression']);
$expressionHosts = $expressionData->getHosts();
$filter['host'] = reset($expressionHosts);
}
$triggers = $this->get(array(
'filter' => $filter,
'output' => array('expression', 'triggerid'),
'nopermissions' => true
));
foreach ($triggers as $dbTrigger) {
$tmpExp = explode_exp($dbTrigger['expression']);
// check if the expressions are also equal and that this is a different trigger
$differentTrigger = (!isset($trigger['triggerid']) || !idcmp($trigger['triggerid'], $dbTrigger['triggerid']));
if (strcmp($tmpExp, $trigger['expression']) == 0 && $differentTrigger) {
$options = array(
'output' => array('name'),
'templated_hosts' => true,
'nopermissions' => true,
'limit' => 1
);
if (isset($filter['host'])) {
$options['filter'] = array('host' => $filter['host']);
}
else {
$options['hostids'] = $hostId;
}
$host = API::Host()->get($options);
$host = reset($host);
self::exception(ZBX_API_ERROR_PARAMETERS,
_s('Trigger "%1$s" already exists on "%2$s".', $trigger['description'], $host['name']));
}
}
}
protected function addRelatedObjects(array $options, array $result) {
$result = parent::addRelatedObjects($options, $result);
$triggerids = array_keys($result);
// adding groups
if ($options['selectGroups'] !== null && $options['selectGroups'] != API_OUTPUT_COUNT) {
$res = DBselect(
'SELECT f.triggerid,hg.groupid'.
' FROM functions f,items i,hosts_groups hg'.
' WHERE '.dbConditionInt('f.triggerid', $triggerids).
' AND f.itemid=i.itemid'.
' AND i.hostid=hg.hostid'
);
$relationMap = new CRelationMap();
while ($relation = DBfetch($res)) {
$relationMap->addRelation($relation['triggerid'], $relation['groupid']);
}
$groups = API::HostGroup()->get(array(
'output' => $options['selectGroups'],
'groupids' => $relationMap->getRelatedIds(),
'preservekeys' => true
));
$result = $relationMap->mapMany($result, $groups, 'groups');
}
// adding hosts
if ($options['selectHosts'] !== null && $options['selectHosts'] != API_OUTPUT_COUNT) {
$res = DBselect(
'SELECT f.triggerid,i.hostid'.
' FROM functions f,items i'.
' WHERE '.dbConditionInt('f.triggerid', $triggerids).
' AND f.itemid=i.itemid'
);
$relationMap = new CRelationMap();
while ($relation = DBfetch($res)) {
$relationMap->addRelation($relation['triggerid'], $relation['hostid']);
}
$hosts = API::Host()->get(array(
'output' => $options['selectHosts'],
'hostids' => $relationMap->getRelatedIds(),
'templated_hosts' => true,
'nopermissions' => true,
'preservekeys' => true
));
if (!is_null($options['limitSelects'])) {
order_result($hosts, 'host');
}
$result = $relationMap->mapMany($result, $hosts, 'hosts', $options['limitSelects']);
}
// adding functions
if ($options['selectFunctions'] !== null && $options['selectFunctions'] != API_OUTPUT_COUNT) {
$functions = API::getApiService()->select('functions', array(
'output' => $this->outputExtend($options['selectFunctions'], array('triggerid', 'functionid')),
'filter' => array('triggerid' => $triggerids),
'preservekeys' => true
));
$relationMap = $this->createRelationMap($functions, 'triggerid', 'functionid');
$functions = $this->unsetExtraFields($functions, array('triggerid', 'functionid'), $options['selectFunctions']);
$result = $relationMap->mapMany($result, $functions, 'functions');
}
return $result;
}
}
|