Zabbix

<?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/>.

**/

​

​

/**

 * Class is used to validate and parse a function.

 */

class CHistFunctionParser extends CParser {

​

    protected const STATE_NEW = 0;

    protected const STATE_END = 1;

    protected const STATE_QUOTED = 3;

    protected const STATE_END_OF_PARAMS = 4;

​

    public const PARAM_TYPE_QUERY = 0;

    public const PARAM_TYPE_PERIOD = 1;

    public const PARAM_TYPE_QUOTED = 2;

    public const PARAM_TYPE_UNQUOTED = 3;

    public const PARAM_TYPE_EMPTY = 4;

​

    /**

     * An options array.

     *

     * Supported options:

     *   'usermacros' => false         Enable user macros usage in function parameters.

     *   'lldmacros' => false          Enable low-level discovery macros usage in function parameters.

     *   '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,

        'calculated' => false,

        'host_macro' => false,

        'host_macro_n' => false,

        'empty_host' => false,

        'escape_backslashes' => true

    ];

​

    private $query_parser;

    private $period_parser;

​

    /**

     * The list of parsers for unquoted parameters.

     *

     * @var array

     */

    private $unquoted_param_parsers = [];

​

    /**

     * Parsed function name.

     *

     * @var string

     */

    private $function = '';

​

    /**

     * The list of the parsed function parameters.

     *

     * @var array

     */

    private $parameters = [];

​

    /**

     * @param array $options

     */

    public function __construct(array $options = []) {

        $this->options = $options + $this->options;

​

        $this->query_parser = new CQueryParser([

            'usermacros' => $this->options['usermacros'],

            'lldmacros' => $this->options['lldmacros'],

            'calculated' => $this->options['calculated'],

            'host_macro' => $this->options['host_macro'],

            'host_macro_n' => $this->options['host_macro_n'],