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
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2013 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 is used to validate and parse item keys.
*
* Example of usage:
* $itemKey = new CItemKey('test.key[a, b, c]');
* echo $itemKey->isValid(); // true
* echo $itemKey->getKeyId(); // test.key
* print_r($itemKey->parameters()); // array('a', 'b', 'c')
*
* @package API
*/
class CItemKey {
private $key;
private $keyByteCnt;
private $currentByte;
private $isValid = true;
private $error = '';
private $parameters = array();
private $keyId = ''; // main part of the key (for 'key[1, 2, 3]' key id would be 'key')
/**
* Parse key and determine if it is valid
* @param string $key
*/
public function __construct($key) {
$this->key = $key;
$this->keyByteCnt = strlen($this->key); // get key length
// checking if key is empty
if ($this->keyByteCnt == 0) {
$this->isValid = false;
$this->error = _('Key cannot be empty.');
}
else {
$this->parseKeyId(); // getting key id out of the key
if ($this->isValid) {
// parameters ($currentByte now points to start of parameters)
$this->parseKeyParameters();
}
}
}
/**
* Get the key id and put $currentByte after it
* @return void
*/
private function parseKeyId() {
// checking every byte, one by one, until first 'not key_id' char is reached
for ($this->currentByte = 0; $this->currentByte < $this->keyByteCnt; $this->currentByte++) {
if (!isKeyIdChar($this->key[$this->currentByte])) {
break; // $this->currentByte now points to a first 'not a key name' char
}
}
// checking if key is empty
if ($this->currentByte == 0) {
$this->isValid = false;
$this->error = _('Invalid item key format.');
}
else {
$this->keyId = substr($this->key, 0, $this->currentByte);
}
}
/**
* Parse key parameters and put them into $this->parameters array
* @return void
*/
private function parseKeyParameters() {
if ($this->currentByte == $this->keyByteCnt) {
return;
}
// invalid symbol instead of '[', which would be the beginning of params
if ($this->key[$this->currentByte] != '[') {
$this->isValid = false;
$this->error = _('Invalid item key format.');
return;
}
// let the parsing begin!
$state = 0; // 0 - initial, 1 - inside quoted param, 2 - inside unquoted param
$nestLevel = 0;
$currParamNo = 0;
$this->parameters[$currParamNo] = '';
// for every byte, starting after '['
for ($this->currentByte++; $this->currentByte < $this->keyByteCnt; $this->currentByte++) {
switch ($state) {
case 0: // initial state
if ($this->key[$this->currentByte] == ',') {
if ($nestLevel == 0) {
$currParamNo++;
$this->parameters[$currParamNo] = '';
}
else {
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
}
// Zapcat: '][' is treated as ','
elseif ($this->key[$this->currentByte] == ']' && isset($this->key[$this->currentByte + 1]) && $this->key[$this->currentByte + 1] == '[' && $nestLevel == 0) {
$currParamNo++;
$this->parameters[$currParamNo] = '';
$this->currentByte++;
}
// entering quotes
elseif ($this->key[$this->currentByte] == '"') {
$state = 1;
// in key[["a"]] param is "a"
if ($nestLevel > 0) {
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
}
// next nesting level
elseif ($this->key[$this->currentByte] == '[') {
if ($nestLevel > 0) {
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
$nestLevel++;
}
// one of the nested sets ended
elseif ($this->key[$this->currentByte] == ']' && $nestLevel > 0) {
$nestLevel--;
if ($nestLevel > 0) {
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
// skipping spaces
while (isset($this->key[$this->currentByte + 1]) && $this->key[$this->currentByte + 1] == ' ') {
$this->currentByte++;
if ($nestLevel > 0) {
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
}
// all nestings are closed correctly
if ($nestLevel == 0 && isset($this->key[$this->currentByte + 1]) && $this->key[$this->currentByte + 1] == ']' && !isset($this->key[$this->currentByte + 2])) {
return;
}
if (!isset($this->key[$this->currentByte + 1]) || $this->key[$this->currentByte + 1] != ','
&& !($nestLevel > 0 && isset($this->key[$this->currentByte + 1]) && $this->key[$this->currentByte + 1] == ']')
&& $this->key[$this->currentByte + 1] != ']' // Zapcat - '][' is the same as ','
&& $this->key[$this->currentByte + 2] != '[') {
$this->isValid = false;
$this->error = _s('Incorrect syntax near "%1$s".', $this->key[$this->currentByte]);
return;
}
}
// looks like we have reached final ']'
elseif ($this->key[$this->currentByte] == ']' && $nestLevel == 0) {
if (!isset($this->key[$this->currentByte + 1])) {
return;
}
// nothing else is allowed after final ']'
$this->isValid = false;
$this->error = _s('Incorrect usage of bracket symbols. "%1$s" found after final bracket.', $this->key[$this->currentByte + 1]);
return;
}
elseif ($this->key[$this->currentByte] != ' ') {
$state = 2;
// this is the first symbol of unquoted param
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
elseif ($nestLevel > 0) {
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
break;
case 1: // quoted
// ending quote is reached
if ($this->key[$this->currentByte] == '"' && $this->key[$this->currentByte - 1] != '\\') {
// skipping spaces
while (isset($this->key[$this->currentByte + 1]) && $this->key[$this->currentByte + 1] == ' ') {
$this->currentByte++;
if ($nestLevel > 0) {
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
}
// Zapcat
if ($nestLevel == 0 && isset($this->key[$this->currentByte + 1]) && isset($this->key[$this->currentByte + 2])
&& $this->key[$this->currentByte + 1] == ']' && $this->key[$this->currentByte + 2] == '[') {
$state = 0;
break;
}
if ($nestLevel == 0 && isset($this->key[$this->currentByte + 1]) && $this->key[$this->currentByte + 1] == ']' && !isset($this->key[$this->currentByte + 2])) {
return;
}
elseif ($nestLevel == 0 && $this->key[$this->currentByte + 1] == ']' && isset($this->key[$this->currentByte + 2])) {
// nothing else is allowed after final ']'
$this->isValid = false;
$this->error = _s('Incorrect usage of bracket symbols. "%1$s" found after final bracket.', $this->key[$this->currentByte + 1]);
return;
}
if ((!isset($this->key[$this->currentByte + 1]) || $this->key[$this->currentByte + 1] != ',') // if next symbol is not ','
&& !($nestLevel != 0 && isset($this->key[$this->currentByte + 1]) && $this->key[$this->currentByte + 1] == ']')) {
// nothing else is allowed after final ']'
$this->isValid = false;
$this->error = _s('Incorrect syntax near "%1$s" at position "%2$s"', $this->key[$this->currentByte], $this->currentByte);
return;
}
// in key[["a"]] param is "a"
if ($nestLevel > 0) {
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
$state = 0;
}
// escaped quote (\")
elseif ($this->key[$this->currentByte] == '\\' && isset($this->key[$this->currentByte + 1]) && $this->key[$this->currentByte + 1] == '"') {
if ($nestLevel > 0) {
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
}
else {
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
break;
case 2: // unquoted
// Zapcat
if ($nestLevel == 0 && $this->key[$this->currentByte] == ']' && isset($this->key[$this->currentByte + 1]) && $this->key[$this->currentByte + 1] =='[' ) {
$this->currentByte--;
$state = 0;
}
elseif ($this->key[$this->currentByte] == ',' || ($this->key[$this->currentByte] == ']' && $nestLevel > 0)) {
$this->currentByte--;
$state = 0;
}
elseif ($this->key[$this->currentByte] == ']' && $nestLevel == 0) {
if (isset($this->key[$this->currentByte + 1])) {
// nothing else is allowed after final ']'
$this->isValid = false;
$this->error = _s('Incorrect usage of bracket symbols. "%1$s" found after final bracket.', $this->key[$this->currentByte + 1]);
return;
}
else {
return;
}
}
else {
$this->parameters[$currParamNo] .= $this->key[$this->currentByte];
}
break;
}
}
$this->isValid = false;
$this->error = _('Invalid item key format.');
}
/**
* Is key valid?
* @return bool
*/
public function isValid() {
return $this->isValid;
}
/**
* Get the error if key is invalid
* @return string
*/
public function getError() {
return $this->error;
}
/**
* Get the list of key parameters
* @return array
*/
public function getParameters() {
return $this->parameters;
}
/**
* Get the key id (first part of the key)
* @return string
*/
public function getKeyId() {
return $this->keyId;
}
}
|
