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
|
<?php declare(strict_types = 0);
/*
** Zabbix
** Copyright (C) 2001-2023 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 information on math functions.
*/
final class CMathFunctionData {
/**
* Known math functions along with number or range of required parameters.
*
* @var array
*/
private const PARAMETERS = [
'abs' => [['count' => 1]],
'acos' => [['count' => 1]],
'ascii' => [['count' => 1]],
'asin' => [['count' => 1]],
'atan' => [['count' => 1]],
'atan2' => [['count' => 2]],
'avg' => [['min' => 1]],
'between' => [['count' => 3]],
'bitand' => [['count' => 2]],
'bitlength' => [['count' => 1]],
'bitlshift' => [['count' => 2]],
'bitnot' => [['count' => 1]],
'bitor' => [['count' => 2]],
'bitrshift' => [['count' => 2]],
'bitxor' => [['count' => 2]],
'bytelength' => [['count' => 1]],
'cbrt' => [['count' => 1]],
'ceil' => [['count' => 1]],
'char' => [['count' => 1]],
'concat' => [['min' => 2]],
'cos' => [['count' => 1]],
'cosh' => [['count' => 1]],
'cot' => [['count' => 1]],
'count' => [['count' => 1]],
'date' => [['count' => 0]],
'dayofmonth' => [['count' => 0]],
'dayofweek' => [['count' => 0]],
'degrees' => [['count' => 1]],
'e' => [['count' => 0]],
'exp' => [['count' => 1]],
'expm1' => [['count' => 1]],
'floor' => [['count' => 1]],
'histogram_quantile' => [['min' => 5, 'step' => 2], ['count' => 2]],
'in' => [['min' => 2]],
'insert' => [['count' => 4]],
'left' => [['count' => 2]],
'length' => [['count' => 1]],
'log' => [['count' => 1]],
'log10' => [['count' => 1]],
'ltrim' => [['min' => 1, 'max' => 2]],
'max' => [['min' => 1]],
'mid' => [['count' => 3]],
'min' => [['min' => 1]],
'mod' => [['count' => 2]],
'now' => [['count' => 0]],
'pi' => [['count' => 0]],
'power' => [['count' => 2]],
'radians' => [['count' => 1]],
'rand' => [['count' => 0]],
'repeat' => [['count' => 2]],
'replace' => [['count' => 3]],
'right' => [['count' => 2]],
'round' => [['count' => 2]],
'rtrim' => [['min' => 1, 'max' => 2]],
'signum' => [['count' => 1]],
'sin' => [['count' => 1]],
'sinh' => [['count' => 1]],
'sqrt' => [['count' => 1]],
'sum' => [['min' => 1]],
'tan' => [['count' => 1]],
'time' => [['count' => 0]],
'trim' => [['min' => 1, 'max' => 2]],
'truncate' => [['count' => 2]]
];
/**
* Additional requirements for math function usage in expressions.
*
* @var array
*/
private const EXPRESSION_RULES = [
'count' => [[
'if' => [
'parameters' => ['count' => 1]
],
'rules' => [[
'type' => 'require_history_child',
'in' => ['avg_foreach', 'bucket_rate_foreach', 'count_foreach', 'exists_foreach', 'last_foreach',
'max_foreach', 'min_foreach', 'sum_foreach'
],
'position' => 0
]]
]],
'histogram_quantile' => [[
'if' => [
'parameters' => ['count' => 2]
],
'rules' => [[
'type' => 'require_history_child',
'in' => ['bucket_rate_foreach'],
'position' => 1
]]
]]
];
/**
* A subset of aggregating math functions for use in calculated item formulas.
*
* @var array
*/
private const CALCULATED_ONLY = [
'count',
'histogram_quantile'
];
/**
* An options array.
*
* Supported options:
* 'calculated' => false Provide math functions data for use in calculated item formulas.
*
* @var array
*/
private $options = [
'calculated' => false
];
/**
* @param array $options
*/
public function __construct(array $options = []) {
$this->options = $options + $this->options;
}
/**
* Check if function is known math function.
*
* @param string $function
*
* @return bool
*/
public function isKnownFunction(string $function): bool {
if (!array_key_exists($function, self::PARAMETERS)) {
return false;
}
if (!$this->options['calculated'] && in_array($function, self::CALCULATED_ONLY, true)) {
return false;
}
return true;
}
/**
* Get known math functions along with number or range of required parameters.
*
* @return array
*/
public function getParameters(): array {
if ($this->options['calculated']) {
return self::PARAMETERS;
}
return array_diff_key(self::PARAMETERS, array_flip(self::CALCULATED_ONLY));
}
/**
* Get additional requirements for math function usage in expressions.
*
* @return array
*/
public function getExpressionRules(): array {
if ($this->options['calculated']) {
return self::EXPRESSION_RULES;
}
return array_diff_key(self::EXPRESSION_RULES, array_flip(self::CALCULATED_ONLY));
}
}
|
