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

**/

​

​

/**

 * User roles API implementation.

 */

class CRole extends CApiService {

​

    public const ACCESS_RULES = [

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

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

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

        'delete' => ['min_user_type' => USER_TYPE_SUPER_ADMIN]

    ];

​

    protected $tableName = 'role';

    protected $tableAlias = 'r';

    protected $sortColumns = ['roleid', 'name'];

​

    public const OUTPUT_FIELDS = ['roleid', 'name', 'type', 'readonly'];

​

    /**

     * Rule types.

     */

    private const RULE_TYPE_INT32 = 0;

    private const RULE_TYPE_STR = 1;

    private const RULE_TYPE_MODULE = 2;

    private const RULE_TYPE_SERVICE = 3;

​

    /**

     * Rule type correspondence to the database field names.

     */

    public const RULE_TYPE_FIELDS = [

        self::RULE_TYPE_INT32 => 'value_int',

        self::RULE_TYPE_STR => 'value_str',

        self::RULE_TYPE_MODULE => 'value_moduleid',

        self::RULE_TYPE_SERVICE => 'value_serviceid'

    ];

​

    /**

     * @param array $options

     *

     * @return array|int

     *

     * @throws APIException

     */

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

        $user_output_fields = self::$userData['type'] == USER_TYPE_SUPER_ADMIN

            ? CUser::OUTPUT_FIELDS

            : CUser::OWN_LIMITED_OUTPUT_FIELDS;

​

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

            // filter

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

            'filter' =>                 ['type' => API_FILTER, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => ['roleid', 'name', 'type', 'readonly']],

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

            'selectRules' =>            ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL, 'in' => implode(',', ['ui', 'ui.default_access', 'services.read.mode', 'services.read.list', 'services.read.tag', 'services.write.mode', 'services.write.list', 'services.write.tag', 'modules', 'modules.default_access', 'api.access', 'api.mode', 'api', 'actions', 'actions.default_access']), 'default' => null],

            'selectUsers' =>            ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL | API_ALLOW_COUNT, 'in' => implode(',', $user_output_fields), 'default' => null],

            // sort and limit

            'sortfield' =>              ['type' => API_STRINGS_UTF8, 'flags' => API_NORMALIZE, 'in' => implode(',', $this->sortColumns), 'uniq' => true, 'default' => []],

            'sortorder' =>              ['type' => API_SORTORDER, 'default' => []],

            'limit' =>                  ['type' => API_INT32, 'flags' => API_ALLOW_NULL, 'in' => '1:'.ZBX_MAX_INT32, 'default' => null],

            // flags

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

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

        ]];

​

        if (!CApiInputValidator::validate($api_input_rules, $options, '/', $error)) {

            self::exception(ZBX_API_ERROR_PARAMETERS, $error);

        }

​