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
|
<?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 CTemplateImporter extends CImporter {
/**
* @var array a list of template IDs which were created or updated
*/
protected $processedTemplateIds = array();
/**
* Import templates.
*
* @throws Exception
*
* @param array $templates
*
* @return void
*/
public function import(array $templates) {
$templates = zbx_toHash($templates, 'host');
$this->checkCircularTemplateReferences($templates);
foreach ($templates as &$template) {
// screens are imported separately
unset($template['screens']);
if (!$this->options['templateLinkage']['createMissing']) {
unset($template['templates']);
}
}
unset($template);
do {
$independentTemplates = $this->getIndependentTemplates($templates);
$templatesToCreate = array();
$templatesToUpdate = array();
$templateLinkage = array();
foreach ($independentTemplates as $name) {
$template = $templates[$name];
unset($templates[$name]);
$template = $this->resolveTemplateReferences($template);
// if we need to add linkages, save linked templates to massAdd later
if ($this->options['templateLinkage']['createMissing'] && !empty($template['templates'])) {
$templateLinkage[$template['host']] = $template['templates'];
unset($template['templates']);
}
if (!empty($template['templateid'])) {
$templatesToUpdate[] = $template;
}
else {
$templatesToCreate[] = $template;
}
}
if ($this->options['templates']['createMissing'] && $templatesToCreate) {
$newTemplateIds = API::Template()->create($templatesToCreate);
foreach ($templatesToCreate as $num => $createdTemplate) {
$templateId = $newTemplateIds['templateids'][$num];
$this->referencer->addTemplateRef($createdTemplate['host'], $templateId);
$this->processedTemplateIds[$templateId] = $templateId;
if (!empty($templateLinkage[$createdTemplate['host']])) {
API::Template()->massAdd(array(
'templates' => array('templateid' => $templateId),
'templates_link' => $templateLinkage[$createdTemplate['host']]
));
}
}
}
if ($this->options['templates']['updateExisting'] && $templatesToUpdate) {
API::Template()->update($templatesToUpdate);
foreach ($templatesToUpdate as $updatedTemplate) {
$this->processedTemplateIds[$updatedTemplate['templateid']] = $updatedTemplate['templateid'];
if (!empty($templateLinkage[$updatedTemplate['host']])) {
API::Template()->massAdd(array(
'templates' => $updatedTemplate,
'templates_link' => $templateLinkage[$updatedTemplate['host']]
));
}
}
}
} while (!empty($independentTemplates));
// if there are templates left in $templates, then they have unresolved references
foreach ($templates as $template) {
$unresolvedReferences = array();
foreach ($template['templates'] as $linkedTemplate) {
if (!$this->referencer->resolveTemplate($linkedTemplate['name'])) {
$unresolvedReferences[] = $linkedTemplate['name'];
}
}
throw new Exception(_n('Cannot import template "%1$s", linked template "%2$s" does not exist.',
'Cannot import template "%1$s", linked templates "%2$s" do not exist.',
$template['host'], implode(', ', $unresolvedReferences), count($unresolvedReferences)));
}
}
/**
* Get a list of created or updated template IDs.
*
* @return array
*/
public function getProcessedTemplateIds() {
return $this->processedTemplateIds;
}
/**
* Check if templates have circular references.
*
* @throws Exception
* @see checkCircularRecursive
*
* @param array $templates
*
* @return void
*/
protected function checkCircularTemplateReferences(array $templates) {
foreach ($templates as $name => $template) {
if (empty($template['templates'])) {
continue;
}
foreach ($template['templates'] as $linkedTemplate) {
$checked = array($name);
if ($circTemplates = $this->checkCircularRecursive($linkedTemplate, $templates, $checked)) {
throw new Exception(_s('Circular reference in templates: %1$s.', implode(' - ', $circTemplates)));
}
}
}
}
/**
* Recursive function for searching for circular template references.
* If circular reference exist it return array with template names with circular reference.
*
* @param array $linkedTemplate template element to inspect on current recursive loop
* @param array $templates all templates where circular references should be searched
* @param array $checked template names that already were processed,
* should contain unique values if no circular references exist
*
* @return array|bool
*/
protected function checkCircularRecursive(array $linkedTemplate, array $templates, array $checked) {
$linkedTemplateName = $linkedTemplate['name'];
// if current element map name is already in list of checked map names,
// circular reference exists
if (in_array($linkedTemplateName, $checked)) {
// to have nice result containing only maps that have circular reference,
// remove everything that was added before repeated map name
$checked = array_slice($checked, array_search($linkedTemplateName, $checked));
// add repeated name to have nice loop like m1->m2->m3->m1
$checked[] = $linkedTemplateName;
return $checked;
}
else {
$checked[] = $linkedTemplateName;
}
// we need to find map that current element reference to
// and if it has selements check all them recursively
if (!empty($templates[$linkedTemplateName]['templates'])) {
foreach ($templates[$linkedTemplateName]['templates'] as $tpl) {
return $this->checkCircularRecursive($tpl, $templates, $checked);
}
}
return false;
}
/**
* Get templates that don't have not existing linked templates i.e. all templates that must be linked to these templates exist.
* Returns array with template names (host).
*
* @param array $templates
*
* @return array
*/
protected function getIndependentTemplates(array $templates) {
foreach ($templates as $num => $template) {
if (empty($template['templates'])) {
continue;
}
foreach ($template['templates'] as $linkedTpl) {
if (!$this->referencer->resolveTemplate($linkedTpl['name'])) {
unset($templates[$num]);
continue 2;
}
}
}
return zbx_objectValues($templates, 'host');
}
/**
* Change all references in template to database ids.
*
* @throws Exception
*
* @param array $template
*
* @return array
*/
protected function resolveTemplateReferences(array $template) {
if ($templateId = $this->referencer->resolveTemplate($template['host'])) {
$template['templateid'] = $templateId;
// if we update template, existing macros should have hostmacroid
foreach ($template['macros'] as &$macro) {
if ($hostMacroId = $this->referencer->resolveMacro($templateId, $macro['macro'])) {
$macro['hostmacroid'] = $hostMacroId;
}
}
unset($macro);
}
foreach ($template['groups'] as $gnum => $group) {
if (!$this->referencer->resolveGroup($group['name'])) {
throw new Exception(_s('Group "%1$s" does not exist.', $group['name']));
}
$template['groups'][$gnum] = array('groupid' => $this->referencer->resolveGroup($group['name']));
}
if (isset($template['templates'])) {
foreach ($template['templates'] as $tnum => $parentTemplate) {
$template['templates'][$tnum] = array(
'templateid' => $this->referencer->resolveTemplate($parentTemplate['name'])
);
}
}
return $template;
}
}
|