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

**/

​

​

/**

 * Services API implementation.

 */

class CService extends CApiService {

​

    public const ACCESS_RULES = [

        'get' =>    ['min_user_type' => USER_TYPE_ZABBIX_USER],

        'create' => ['min_user_type' => USER_TYPE_ZABBIX_USER],

        'update' => ['min_user_type' => USER_TYPE_ZABBIX_USER],

        'delete' => ['min_user_type' => USER_TYPE_ZABBIX_USER]

    ];

​

    protected $tableName = 'services';

    protected $tableAlias = 's';

    protected $sortColumns = ['serviceid', 'name', 'status', 'sortorder', 'created_at'];

​

    public const OUTPUT_FIELDS = ['serviceid', 'uuid', 'name', 'status', 'algorithm', 'sortorder', 'weight',

        'propagation_rule', 'propagation_value', 'description', 'created_at', 'readonly'

    ];

​

    /**

     * @param array $options

     *

     * @throws APIException

     *

     * @return array|string

     */

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

        return $this->doGet($options, self::getPermissions());

    }

​

    /**

     * @param array      $options

     * @param array|null $permissions

     *

     * @throws APIException

     *

     * @return array|string

     */

    private function doGet(array $options = [], ?array $permissions = null) {

        $api_input_rules = ['type' => API_OBJECT, 'fields' => [

            // filter

            'serviceids' =>             ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'default' => null],

            'parentids' =>              ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'default' => null],

            'deep_parentids' =>         ['type' => API_BOOLEAN, 'default' => false],

            'childids' =>               ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'default' => null],

            'evaltype' =>               ['type' => API_INT32, 'in' => implode(',', [TAG_EVAL_TYPE_AND_OR, TAG_EVAL_TYPE_OR]), 'default' => TAG_EVAL_TYPE_AND_OR],

            'tags' =>                   ['type' => API_OBJECTS, 'default' => [], 'fields' => [

                'tag' =>                    ['type' => API_STRING_UTF8, 'flags' => API_REQUIRED],

                'value' =>                  ['type' => API_STRING_UTF8],

                'operator' =>               ['type' => API_INT32, 'in' => implode(',', [TAG_OPERATOR_LIKE, TAG_OPERATOR_EQUAL, TAG_OPERATOR_NOT_LIKE, TAG_OPERATOR_NOT_EQUAL, TAG_OPERATOR_EXISTS, TAG_OPERATOR_NOT_EXISTS])]

            ]],

            'problem_tags' =>           ['type' => API_OBJECTS, 'default' => [], 'fields' => [

                'tag' =>                    ['type' => API_STRING_UTF8, 'flags' => API_REQUIRED],

                'value' =>                  ['type' => API_STRING_UTF8],

                'operator' =>               ['type' => API_INT32, 'in' => implode(',', [TAG_OPERATOR_LIKE, TAG_OPERATOR_EQUAL, TAG_OPERATOR_NOT_LIKE, TAG_OPERATOR_NOT_EQUAL, TAG_OPERATOR_EXISTS, TAG_OPERATOR_NOT_EXISTS])]

            ]],

            'without_problem_tags' =>   ['type' => API_BOOLEAN, 'default' => false],

            'slaids' =>                 ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'default' => null],

            'filter' =>                 ['type' => API_FILTER, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => ['uuid', 'serviceid', 'name', 'status', 'algorithm']],

            'search' =>                 ['type' => API_FILTER, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => ['name']],

            'searchByAny' =>            ['type' => API_BOOLEAN, 'default' => false],

            'startSearch' =>            ['type' => API_FLAG, 'default' => false],

            'excludeSearch' =>          ['type' => API_FLAG, 'default' => false],

            'searchWildcardsEnabled' => ['type' => API_BOOLEAN, 'default' => false],

            // output

            'output' =>                 ['type' => API_OUTPUT, 'in' => implode(',', self::OUTPUT_FIELDS), 'default' => API_OUTPUT_EXTEND],

            'countOutput' =>            ['type' => API_FLAG, 'default' => false],

            'selectParents' =>          ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL | API_ALLOW_COUNT, 'in' => implode(',', self::OUTPUT_FIELDS), 'default' => null],

            'selectChildren' =>         ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL | API_ALLOW_COUNT, 'in' => implode(',', self::OUTPUT_FIELDS), 'default' => null],

            'selectTags' =>             ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL | API_ALLOW_COUNT, 'in' => implode(',', ['tag', 'value']), 'default' => null],

            'selectProblemTags' =>      ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL | API_ALLOW_COUNT, 'in' => implode(',', ['tag', 'operator', 'value']), 'default' => null],

            'selectProblemEvents' =>    ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL | API_ALLOW_COUNT, 'in' => implode(',', ['eventid', 'severity', 'name']), 'default' => null],

            'selectStatusRules' =>      ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL | API_ALLOW_COUNT, 'in' => implode(',', ['type', 'limit_value', 'limit_status', 'new_status']), 'default' => null],

            'selectStatusTimeline' =>   ['type' => API_OBJECTS, 'flags' => API_ALLOW_NULL | API_NOT_EMPTY, 'uniq' => [['period_from', 'period_to']], 'default' => null, 'fields' => [