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
|
<?php
/*
** Copyright (C) 2001-2025 Zabbix SIA
**
** This program is free software: you can redistribute it and/or modify it under the terms of
** the GNU Affero General Public License as published by the Free Software Foundation, version 3.
**
** 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 Affero General Public License for more details.
**
** You should have received a copy of the GNU Affero General Public License along with this program.
** If not, see <https://www.gnu.org/licenses/>.
**/
/**
* A parser for function macros like "{?<trigger expression>}".
*/
class CExpressionMacroParser extends CParser {
/**
* @var CExpressionParser
*/
private $expression_parser;
/**
* @var string
*/
private $error = '';
/**
* @var array
*/
private $tokens = [];
/**
* An options array.
*
* Supported options:
* 'usermacros' => false Enable user macros usage in expression.
* 'lldmacros' => false Enable low-level discovery macros usage in expression.
* 'host_macro' => false Allow {HOST.HOST} macro as host name part in the query.
* 'host_macro_n' => false Allow {HOST.HOST} and {HOST.HOST<1-9>} macros as host name part in the query.
* 'empty_host' => false Allow empty hostname in the query string.
* 'escape_backslashes' => true Disable backslash escaping in history function parameters prior to v7.0.
*
* @var array
*/
private $options = [
'usermacros' => false,
'lldmacros' => false,
'host_macro' => false,
'host_macro_n' => false,
'empty_host' => false,
'escape_backslashes' => true
];
/**
* Set up necessary parsers.
*
* @param array $options
*/
public function __construct(array $options = []) {
$this->options = $options + $this->options;
$this->expression_parser = new CExpressionParser([
'usermacros' => $this->options['usermacros'],
'lldmacros' => $this->options['lldmacros'],
'host_macro' => $this->options['host_macro'],
'host_macro_n' => $this->options['host_macro_n'],
'empty_host' => $this->options['empty_host'],
'escape_backslashes' => $this->options['escape_backslashes']
]);
}
/**
* @param string $source
* @param int $pos
*
* @return int
*/
public function parse($source, $pos = 0) {
$this->length = 0;
$this->match = '';
$this->error = '';
$p = $pos;
if (substr($source, $p, 2) !== '{?') {
return CParser::PARSE_FAIL;
}
$p += 2;
switch ($this->expression_parser->parse($source, $p)) {
case CParser::PARSE_SUCCESS_CONT:
$this->error = $this->expression_parser->getError();
break;
case CParser::PARSE_FAIL:
$this->error = $this->expression_parser->getError();
return CParser::PARSE_FAIL;
}
$p += $this->expression_parser->getLength();
while (isset($source[$p]) && strpos(CExpressionParser::WHITESPACES, $source[$p]) !== false) {
$p++;
}
if (!isset($source[$p])) {
$this->error = _('unexpected end of expression macro');
}
if (!isset($source[$p]) || $source[$p] !== '}') {
return CParser::PARSE_FAIL;
}
$p++;
$this->length = $p - $pos;
$this->match = substr($source, $pos, $this->length);
$this->tokens = $this->expression_parser->getResult()->getTokens();
return (isset($source[$p]) ? CParser::PARSE_SUCCESS_CONT : CParser::PARSE_SUCCESS);
}
/**
* Returns the error message if the expression macro is invalid.
*
* @return string
*/
public function getError(): string {
return $this->error;
}
/**
* Returns the expression parser.
*
* @return CExpressionParser
*/
public function getExpressionParser(): CExpressionParser {
return $this->expression_parser;
}
}
|
