<?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 "{host:item.func()}". */ class C10FunctionMacroParser extends CParser { /** * An options array. * * Supported options: * '18_simple_checks' => true with support for old-style simple checks like "ftp,{$PORT}" * 'host_macro' Array of macro to be supported as host name. * * @var array */ private $options = [ '18_simple_checks' => false, 'host_macro' => [] ]; /** * Parser for item keys. * * @var CItemkey */ private $item_key_parser; /** * Parser for trigger functions. * * @var C10FunctionParser */ private $function_parser; /** * Parser for host names. * * @var CHostNameParser */ private $host_name_parser; /** * @var CSetParser */ private $host_macro_parser; private $host = ''; private $item = ''; private $function = ''; /** * @param array $options */ public function __construct($options = []) { $this->options = $options + $this->options; $this->item_key_parser = new CItemKey(['18_simple_checks' => $this->options['18_simple_checks']]); $this->function_parser = new C10FunctionParser(); $this->host_name_parser = new CHostNameParser(); if ($this->options['host_macro']) { $this->host_macro_parser = new CSetParser($this->options['host_macro']); } } /** * @param string $source * @param int $pos * * @return int */ public function parse($source, $pos = 0) { $this->length = 0; $this->match = ''; $this->host = ''; $this->item = ''; $this->function = ''; $p = $pos; if (!isset($source[$p]) || $source[$p] !== '{') { return self::PARSE_FAIL; } $p++; if (!$this->parseHost($source, $p)) { return self::PARSE_FAIL; } if (!isset($source[$p]) || $source[$p] !== ':') { return self::PARSE_FAIL; } $p++; $p2 = $p; if ($this->item_key_parser->parse($source, $p) == CParser::PARSE_FAIL) { return self::PARSE_FAIL; } $p += $this->item_key_parser->getLength(); // for instance, agent.ping.last(0) if ($this->item_key_parser->getParamsNum() == 0 && isset($source[$p]) && $source[$p] == '(') { for (; $p > $p2 && $source[$p] != '.'; $p--) { // Code is not missing here. } if ($p == $p2) { return self::PARSE_FAIL; } } $p3 = $p; if (!isset($source[$p]) || $source[$p] !== '.') { return self::PARSE_FAIL; } $p++; if ($this->function_parser->parse($source, $p) == CParser::PARSE_FAIL) { return self::PARSE_FAIL; } $p += $this->function_parser->getLength(); if (!isset($source[$p]) || $source[$p] !== '}') { return self::PARSE_FAIL; } $p++; $this->length = $p - $pos; $this->match = substr($source, $pos, $this->length); $this->host = substr($source, $pos + 1, $p2 - $pos - 2); $this->item = substr($source, $p2, $p3 - $p2); $this->function = $this->function_parser->getMatch(); return (isset($source[$pos + $this->length]) ? self::PARSE_SUCCESS_CONT : self::PARSE_SUCCESS); } /** * Parses a host in a trigger function macro constant and moves a position ($pos) on a next symbol after the host. * * @param string $source * @param int $pos * * @return bool */ protected function parseHost($source, &$pos) { if ($this->options['host_macro'] && $this->host_macro_parser->parse($source, $pos) !== CParser::PARSE_FAIL) { $pos += $this->host_macro_parser->getLength(); return true; } if ($this->host_name_parser->parse($source, $pos) == self::PARSE_FAIL) { return false; } $pos += $this->host_name_parser->getLength(); return true; } /** * Returns parsed host. * * @return string */ public function getHost() { return $this->host; } /** * Returns parsed item. * * @return string */ public function getItem() { return $this->item; } /** * Returns parsed function. * * @return string */ public function getFunction() { return $this->function; } }