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

**/

​

​

/**

 * Alert API implementation.

 */

class CAlert extends CApiService {

​

    public const ACCESS_RULES = [

        'get' => [

            'min_user_type' => USER_TYPE_ZABBIX_USER

        ]

    ];

​

    protected $tableName = 'alerts';

    protected $tableAlias = 'a';

    protected $sortColumns = ['alertid', 'clock', 'eventid', 'status', 'sendto', 'mediatypeid'];

​

    public const OUTPUT_FIELDS = ['alertid', 'actionid', 'eventid', 'userid', 'clock', 'mediatypeid', 'sendto',

        'subject', 'message', 'status', 'retries', 'error', 'esc_step', 'alerttype', 'p_eventid', 'acknowledgeid'

    ];

​

    /**

     * @param array $options

     *

     * @throws APIException

     *

     * @return array|string

     */

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

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

            $media_type_output_fields = CMediatype::OUTPUT_FIELDS;

            $user_output_fields = CUser::OUTPUT_FIELDS;

        }

        else {

            $media_type_output_fields = CMediatype::LIMITED_OUTPUT_FIELDS;

            $user_output_fields = CUser::OWN_LIMITED_OUTPUT_FIELDS;

        }

​

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

            // filter

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

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

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

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

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

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

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

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

            'eventsource' =>            ['type' => API_INT32, 'in' => implode(',', [EVENT_SOURCE_TRIGGERS, EVENT_SOURCE_DISCOVERY, EVENT_SOURCE_AUTOREGISTRATION, EVENT_SOURCE_INTERNAL, EVENT_SOURCE_SERVICE]), 'default' => EVENT_SOURCE_TRIGGERS],

            'eventobject' =>            ['type' => API_INT32, 'in' => implode(',', [EVENT_OBJECT_TRIGGER, EVENT_OBJECT_DHOST, EVENT_OBJECT_DSERVICE, EVENT_OBJECT_AUTOREGHOST, EVENT_OBJECT_ITEM, EVENT_OBJECT_LLDRULE, EVENT_OBJECT_SERVICE]), 'default' => EVENT_OBJECT_TRIGGER],

            'time_from' =>              ['type' => API_TIMESTAMP, 'flags' => API_ALLOW_NULL, 'default' => null],

            'time_till' =>              ['type' => API_TIMESTAMP, 'flags' => API_ALLOW_NULL, 'default' => null],

            // output

            'output' =>                 ['type' => API_OUTPUT, 'in' => implode(',', self::OUTPUT_FIELDS), 'default' => API_OUTPUT_EXTEND],

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

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

            'selectHosts' =>            ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL, 'in' => implode(',', CHost::OUTPUT_FIELDS), 'default' => null],

            'selectMediatypes' =>       ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL, 'in' => implode(',', $media_type_output_fields), 'default' => null],

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

            'filter' =>                 ['type' => API_FILTER, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => ['alertid', 'actionid', 'eventid', 'userid', 'mediatypeid', 'status', 'acknowledgeid']],

            'search' =>                 ['type' => API_FILTER, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => ['sendto', 'subject', 'message', 'error']],

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

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

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

            'searchWildcardsEnabled' => ['type' => API_BOOLEAN, '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],

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

        ]];

​

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

            self::exception(ZBX_API_ERROR_PARAMETERS, $error);