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 containing methods for operations with modules.

 */

class CModule 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 = 'module';

    protected $tableAlias = 'md';

    protected $sortColumns = ['moduleid', 'relative_path'];

​

    /**

     * @param array $options

     * @param bool  $api_call  Flag indicating whether this method called via an API call or from a local PHP file.

     *

     * @throws APIException

     *

     * @return array|string

     */

    public function get(array $options = [], bool $api_call = true) {

        if ($api_call && self::$userData['type'] != USER_TYPE_SUPER_ADMIN) {

            self::exception(ZBX_API_ERROR_PERMISSIONS, _('You do not have permission to perform this operation.'));

        }

​

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

            // filter

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

            'filter' =>                 ['type' => API_FILTER, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => ['moduleid', 'id', 'relative_path', 'status']],

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

            '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(',', ['moduleid', 'id', 'relative_path', 'status', 'config']), 'default' => API_OUTPUT_EXTEND],

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

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

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

        ]];

​

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

            self::exception(ZBX_API_ERROR_PARAMETERS, $error);

        }

​

        $db_modules = [];

​

        $result = DBselect($this->createSelectQuery('module', $options), $options['limit']);

​

        while ($row = DBfetch($result)) {

            if ($options['countOutput']) {

                return $row['rowscount'];

            }

​

            if ($this->outputIsRequested('config', $options['output'])) {

                $row['config'] = json_decode($row['config'], true);

            }

​

            $db_modules[$row['moduleid']] = $row;

        }

​

        if ($db_modules) {

            $db_modules = $this->unsetExtraFields($db_modules, ['moduleid'], $options['output']);

​

            if (!$options['preservekeys']) {

                $db_modules = array_values($db_modules);

            }