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 the main part of administration settings.

 */

class CSettings extends CApiService {

​

    public const ACCESS_RULES = [

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

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

    ];

​

    private array $output_fields = [

        // GUI.

        'default_lang', 'default_timezone', 'default_theme', 'search_limit', 'max_overview_table_size', 'max_in_table',

        'server_check_interval', 'work_period', 'show_technical_errors', 'history_period', 'period_default',

        'max_period',

​

        // Timeouts.

        'timeout_zabbix_agent', 'timeout_simple_check', 'timeout_snmp_agent', 'timeout_external_check',

        'timeout_db_monitor', 'timeout_http_agent', 'timeout_ssh_agent', 'timeout_telnet_agent', 'timeout_script',

        'timeout_browser', 'socket_timeout', 'connect_timeout', 'media_type_test_timeout', 'script_timeout',

        'item_test_timeout', 'report_test_timeout',

​

        // Trigger displaying options.

        'custom_color', 'problem_unack_color', 'problem_unack_style', 'problem_ack_color', 'problem_ack_style',

        'ok_unack_color', 'ok_unack_style', 'ok_ack_color', 'ok_ack_style', 'ok_period', 'blink_period',

        'severity_name_0', 'severity_color_0', 'severity_name_1', 'severity_color_1', 'severity_name_2',

        'severity_color_2', 'severity_name_3', 'severity_color_3', 'severity_name_4', 'severity_color_4',

        'severity_name_5', 'severity_color_5',

​

        // Geographical maps.

        'geomaps_tile_provider', 'geomaps_tile_url', 'geomaps_attribution', 'geomaps_max_zoom',

​

        // Other configuration parameters.

        'url', 'discovery_groupid', 'default_inventory_mode', 'alert_usrgrpid', 'snmptrap_logging', 'login_attempts',

        'login_block', 'vault_provider', 'proxy_secrets_provider', 'validate_uri_schemes', 'uri_valid_schemes',

        'x_frame_options', 'iframe_sandboxing_enabled', 'iframe_sandboxing_exceptions',

​

        // Audit log.

        'auditlog_enabled', 'auditlog_mode',

​

        // Read-only parameters.

        'ha_failover_delay'

    ];

​

    /**

     * @param array $options

     *

     * @throws APIException

     *

     * @return array

     */

    public function get(array $options): array {

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

            'output' => ['type' => API_OUTPUT, 'in' => implode(',', $this->output_fields), 'default' => API_OUTPUT_EXTEND]

        ]];

​

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

            self::exception(ZBX_API_ERROR_PARAMETERS, $error);

        }

​

        if ($options['output'] === API_OUTPUT_EXTEND) {

            $options['output'] = $this->output_fields;

        }

​

        return CApiSettingsHelper::getParameters($options['output']);

    }

​

    /**

     * Get the fields of the Settings API object that are used by parts of the UI where authentication is not required.

     */

    public static function getPublic(): array {

        return CApiSettingsHelper::getParameters([

            // GUI.

            'default_lang', 'default_timezone', 'default_theme', 'server_check_interval', 'show_technical_errors',

​