Zabbix

<?php

/*

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

**/

​

​

/**

 * Dashboards API implementation.

 */

class CDashboard extends CDashboardGeneral {

​

    public const ACCESS_RULES = [

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

        'create' => ['min_user_type' => USER_TYPE_ZABBIX_USER, 'action' => CRoleHelper::ACTIONS_EDIT_DASHBOARDS],

        'update' => ['min_user_type' => USER_TYPE_ZABBIX_USER, 'action' => CRoleHelper::ACTIONS_EDIT_DASHBOARDS],

        'delete' => ['min_user_type' => USER_TYPE_ZABBIX_USER, 'action' => CRoleHelper::ACTIONS_EDIT_DASHBOARDS]

    ];

​

    /**

     * @param array $options

     *

     * @throws APIException if the input is invalid.

     *

     * @return array|int

     */

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

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

            // filter

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

            'filter' =>                 ['type' => API_FILTER, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => ['dashboardid', 'name', 'userid', 'private', 'display_period', 'auto_start']],

            '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(',', ['dashboardid', 'name', 'userid', 'private', 'display_period', 'auto_start']), 'default' => API_OUTPUT_EXTEND],

            'selectUsers' =>            ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL, 'in' => implode(',', ['userid', 'permission']), 'default' => null],

            'selectUserGroups' =>       ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL, 'in' => implode(',', ['usrgrpid', 'permission']), 'default' => null],

            'selectPages' =>            ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL, 'in' => implode(',', ['dashboard_pageid', 'name', 'display_period', 'widgets']), 'default' => null],

            '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

            '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);

        }

​

        $sql_parts = [

            'select' => ['dashboard' => 'd.dashboardid'],

            'from' => ['dashboard' => 'dashboard d'],

            'where' => ['d.templateid IS NULL'],

            'order' => [],

            'group' => []

        ];

​

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

            $options['output'] = $this->getTableSchema()['fields'];

            unset($options['output']['templateid']);

            $options['output'] = array_keys($options['output']);

        }

​

        // permissions

        if (in_array(self::$userData['type'], [USER_TYPE_ZABBIX_USER, USER_TYPE_ZABBIX_ADMIN])) {

            $permission = $options['editable'] ? PERM_READ_WRITE : PERM_READ;

​

            $user_groups = getUserGroupsByUserId(self::$userData['userid']);

​

            $sql_where = ['d.userid='.self::$userData['userid']];

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

                $sql_where[] = 'd.private='.PUBLIC_SHARING;

            }

            $sql_where[] = 'EXISTS ('.

                'SELECT NULL'.

                ' FROM dashboard_user du'.