Zabbix

<?php declare(strict_types = 0);

/*

** 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 parse a query in trigger function in form of "/host/key".

 */

class CQueryParser extends CParser {

​

    // Wildcard character to define host or item key.

    const HOST_ITEMKEY_WILDCARD = '*';

​

    private $host_name_parser;

    private $host_macro_parser;

    private $item_key_parser;

    private $filter_parser;

​

    /**

     * An options array.

     *

     * Supported options:

     *   'usermacros' => false    Enable user macros usage in filter expression.

     *   'lldmacros' => false     Enable low-level discovery macros usage in filter expression.

     *   'calculated' => false    Allow wildcards to be used in place of hostname and item key. Allow filter expression

     *                            for item.

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

     *

     * @var array

     */

    private $options = [

        'usermacros' => false,

        'lldmacros' => false,

        'calculated' => false,

        'host_macro' => false,

        'host_macro_n' => false,

        'empty_host' => false

    ];

​

    /**

     * @var string

     */

    private $host = '';

​

    /**

     * @var string

     */

    private $item = '';

​

    /**

     * @var array

     */

    private $filter = [

        'match' => '',

        'tokens' => []

    ];

​

    /**

     * @param array $options

     */

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

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

​

        $this->host_name_parser = new CHostNameParser();

        if ($this->options['host_macro'] || $this->options['host_macro_n']) {

            $this->host_macro_parser = new CMacroParser([

                'macros' => ['{HOST.HOST}'],

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

                    ? CMacroParser::REFERENCE_NUMERIC

                    : CMacroParser::REFERENCE_NONE

            ]);

        }

        $this->item_key_parser = new CItemKey();

        if ($this->options['calculated']) {

            $this->filter_parser = new CFilterParser([

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

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

            ]);