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
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2022 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 for override widget field used in Graph widget configuration overrides tab.
*/
class CWidgetFieldGraphOverride extends CWidgetField {
/**
* Create widget field for Graph Override selection.
*
* @param string $name Field name in form.
* @param string $label Label for the field in form.
*/
public function __construct($name, $label) {
parent::__construct($name, $label);
$this->setSaveType(ZBX_WIDGET_FIELD_TYPE_STR);
$this->setValidationRules(['type' => API_OBJECTS, 'fields' => [
'hosts' => ['type' => API_STRINGS_UTF8, 'flags' => API_REQUIRED],
'items' => ['type' => API_STRINGS_UTF8, 'flags' => API_REQUIRED],
'color' => ['type' => API_COLOR],
'type' => ['type' => API_INT32, 'in' => implode(',', [SVG_GRAPH_TYPE_LINE, SVG_GRAPH_TYPE_POINTS, SVG_GRAPH_TYPE_STAIRCASE, SVG_GRAPH_TYPE_BAR])],
'width' => ['type' => API_INT32, 'in' => implode(',', range(0, 10))],
'pointsize' => ['type' => API_INT32, 'in' => implode(',', range(1, 10))],
'transparency' => ['type' => API_INT32, 'in' => implode(',', range(0, 10))],
'fill' => ['type' => API_INT32, 'in' => implode(',', range(0, 10))],
'missingdatafunc' => ['type' => API_INT32, 'in' => implode(',', [SVG_GRAPH_MISSING_DATA_NONE, SVG_GRAPH_MISSING_DATA_CONNECTED, SVG_GRAPH_MISSING_DATA_TREAT_AS_ZERO])],
'axisy' => ['type' => API_INT32, 'in' => implode(',', [GRAPH_YAXIS_SIDE_LEFT, GRAPH_YAXIS_SIDE_RIGHT])],
'timeshift' => ['type' => API_TIME_UNIT, 'in' => implode(':', [ZBX_MIN_TIMESHIFT, ZBX_MAX_TIMESHIFT])]
]]);
$this->setDefault([]);
}
/**
* Set field values for the overrides.
*
* @return $this
*/
public function setValue($value) {
$overrides = [];
foreach ((array) $value as $override) {
$overrides[] = $override + self::getDefaults();
}
return parent::setValue($overrides);
}
/**
* Set additional flags, which can be used in configuration form.
*
* @param int $flags
*
* @return $this
*/
public function setFlags($flags) {
parent::setFlags($flags);
if ($flags & self::FLAG_NOT_EMPTY) {
$strict_validation_rules = $this->getValidationRules();
self::setValidationRuleFlag($strict_validation_rules['fields']['hosts'], API_NOT_EMPTY);
self::setValidationRuleFlag($strict_validation_rules['fields']['items'], API_NOT_EMPTY);
self::setValidationRuleFlag($strict_validation_rules['fields']['color'], API_NOT_EMPTY);
self::setValidationRuleFlag($strict_validation_rules['fields']['timeshift'], API_NOT_EMPTY);
$this->setStrictValidationRules($strict_validation_rules);
}
else {
$this->setStrictValidationRules(null);
}
return $this;
}
/**
* Default values filled in newly created data set or used as unspecified values.
*
* @return array
*/
public static function getDefaults() {
return [
'hosts' => [],
'items' => []
];
}
/**
* Returns array of supported override options.
*
* @return array
*/
public static function getOverrideOptions() {
return ['color', 'width', 'type', 'transparency', 'fill', 'pointsize', 'missingdatafunc', 'axisy', 'timeshift'];
}
/**
* @param bool $strict
*
* @return array
*/
public function validate(bool $strict = false): array {
$errors = parent::validate($strict);
$value = $this->getValue();
$label = ($this->label === null) ? $this->name : $this->label;
// Validate options.
if (!$errors && $strict) {
foreach ($value as $index => $overrides) {
if (!array_intersect(self::getOverrideOptions(), array_keys($overrides))) {
$errors[] = _s('Invalid parameter "%1$s": %2$s.', $label.'/'.($index + 1),
_('at least one override option must be specified')
);
break;
}
}
}
return $errors;
}
/**
* Prepares array entry for widget field, ready to be passed to CDashboard API functions.
* Reference is needed here to avoid array merging in CWidgetForm::fieldsToApi method. With large number of widget
* fields it causes significant performance decrease.
*
* @param array $widget_fields reference to Array of widget fields.
*/
public function toApi(array &$widget_fields = []) {
$value = $this->getValue();
foreach ($value as $index => $val) {
// Hosts and items fields are stored as arrays to bypass length limit.
foreach ($val['hosts'] as $num => $pattern_item) {
$widget_fields[] = [
'type' => ZBX_WIDGET_FIELD_TYPE_STR,
'name' => $this->name.'.hosts.'.$index.'.'.$num,
'value' => $pattern_item
];
}
foreach ($val['items'] as $num => $pattern_item) {
$widget_fields[] = [
'type' => ZBX_WIDGET_FIELD_TYPE_STR,
'name' => $this->name.'.items.'.$index.'.'.$num,
'value' => $pattern_item
];
}
foreach (self::getOverrideOptions() as $opt) {
if (array_key_exists($opt, $val)) {
$widget_fields[] = [
'type' => ($opt === 'color' || $opt === 'timeshift')
? ZBX_WIDGET_FIELD_TYPE_STR
: ZBX_WIDGET_FIELD_TYPE_INT32,
'name' => $this->name.'.'.$opt.'.'.$index,
'value' => $val[$opt]
];
}
}
}
}
}
|
