Zabbix

<?php

/*

** Zabbix

** Copyright (C) 2001-2022 Zabbix SIA

**

** This program is free software; you can redistribute it and/or modify

** it under the terms of the GNU General Public License as published by

** the Free Software Foundation; either version 2 of the License, or

** (at your option) any later version.

**

** 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 General Public License for more details.

**

** You should have received a copy of the GNU General Public License

** along with this program; if not, write to the Free Software

** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

**/

​

​

/**

 * Class containing methods for operations with scripts.

 */

class CScript extends CApiService {

​

    public const ACCESS_RULES = [

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

        'getscriptsbyhosts' => ['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],

        'execute' => ['min_user_type' => USER_TYPE_ZABBIX_USER, 'action' => CRoleHelper::ACTIONS_EXECUTE_SCRIPTS]

    ];

​

    protected $tableName = 'scripts';

    protected $tableAlias = 's';

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

​

    /**

     * Fields from "actions" table. Used in get() validation and addRelatedObjects() when selecting action fields.

     */

    private $action_fields = ['actionid', 'name', 'eventsource', 'status', 'esc_period', 'pause_suppressed',

        'notify_if_canceled'

    ];

​

    /**

     * This property, if filled out, will contain all hostrgroup ids

     * that requested scripts did inherit from.

     * Keyed by scriptid.

     *

     * @var array|HostGroup[]

     */

    protected $parent_host_groups = [];

​

    /**

     * @param array $options

     *

     * @throws APIException if the input is invalid.

     *

     * @return array|int

     */

    public function get(array $options) {

        $script_fields = ['scriptid', 'name', 'command', 'host_access', 'usrgrpid', 'groupid', 'description',

            'confirmation', 'type', 'execute_on', 'timeout', 'parameters', 'scope', 'port', 'authtype', 'username',

            'password', 'publickey', 'privatekey', 'menu_path'

        ];

        $group_fields = ['groupid', 'name', 'flags', 'internal'];

        $host_fields = ['hostid', 'host', 'name', 'description', 'status', 'proxy_hostid', 'inventory_mode', 'flags',

            'ipmi_authtype', 'ipmi_privilege', 'ipmi_username', 'ipmi_password', 'maintenanceid', 'maintenance_status',

            'maintenance_type', 'maintenance_from', 'tls_connect', 'tls_accept', 'tls_issuer', 'tls_subject'

        ];

​

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

            // filter

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

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

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

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

            'filter' =>                 ['type' => API_OBJECT, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => [

                'scriptid' =>               ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE],

                'name' =>                   ['type' => API_STRINGS_UTF8, 'flags' => API_ALLOW_NULL | API_NORMALIZE],

                'command' =>                ['type' => API_STRINGS_UTF8, 'flags' => API_ALLOW_NULL | API_NORMALIZE],

                'host_access' =>            ['type' => API_INTS32, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'in' => implode(',', [PERM_READ, PERM_READ_WRITE])],

                'usrgrpid' =>               ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE],

                'groupid' =>                ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE],

                'confirmation' =>           ['type' => API_STRINGS_UTF8, 'flags' => API_ALLOW_NULL | API_NORMALIZE],

                'type' =>                   ['type' => API_INTS32, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'in' => implode(',', [ZBX_SCRIPT_TYPE_CUSTOM_SCRIPT, ZBX_SCRIPT_TYPE_IPMI, ZBX_SCRIPT_TYPE_SSH, ZBX_SCRIPT_TYPE_TELNET, ZBX_SCRIPT_TYPE_WEBHOOK])],

                'execute_on' =>             ['type' => API_INTS32, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'in' => implode(',', [ZBX_SCRIPT_EXECUTE_ON_AGENT, ZBX_SCRIPT_EXECUTE_ON_SERVER, ZBX_SCRIPT_EXECUTE_ON_PROXY])],

                'scope' =>                  ['type' => API_INTS32, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'in' => implode(',', [ZBX_SCRIPT_SCOPE_ACTION, ZBX_SCRIPT_SCOPE_HOST, ZBX_SCRIPT_SCOPE_EVENT])],

                'menu_path' =>              ['type' => API_STRINGS_UTF8, 'flags' => API_ALLOW_NULL | API_NORMALIZE]