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

**/

​

​

/**

 * Class containing methods for operations with tasks.

 */

class CTask extends CApiService {

​

    public const ACCESS_RULES = [

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

        'create' => ['min_user_type' => USER_TYPE_SUPER_ADMIN]

    ];

​

    protected $tableName = 'task';

    protected $tableAlias = 't';

    protected $sortColumns = ['taskid'];

​

    private $item_cache = [];

​

    const RESULT_STATUS_ERROR = -1;

​

    /**

     * Get results of requested ZBX_TM_TASK_DATA task.

     *

     * @param array         $options

     * @param string|array  $options['output']

     * @param string|array  $options['taskids']       Task IDs to select data about.

     * @param bool          $options['preservekeys']  Use IDs as keys in the resulting array.

     *

     * @return array | boolean

     */

    public function get(array $options): array {

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

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

        }

​

        $output_fields = ['taskid', 'type', 'status', 'clock', 'ttl', 'proxyid', 'request', 'result'];

​

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

            // filter

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

            // output

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

            // flags

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

        ]];

​

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

            self::exception(ZBX_API_ERROR_PARAMETERS, $error);

        }

​

        $options += [

            'sortfield' => 'taskid',

            'sortorder' => ZBX_SORT_DOWN,

            'limit'     => CSettingsHelper::get(CSettingsHelper::SEARCH_LIMIT)

        ];

​

        $sql_parts = [

            'select'    => ['task' => 't.taskid'],

            'from'      => ['task' => 'task t'],

            'where'     => [

                'type'      => 't.type='.ZBX_TM_TASK_DATA

            ],

            'order'     => [],

            'group'     => []

        ];

​

        if ($options['taskids'] !== null) {

            $sql_parts['where']['taskid'] = dbConditionInt('t.taskid', $options['taskids']);

        }

​

        $db_tasks = [];

​

        $sql_parts = $this->applyQueryOutputOptions($this->tableName(), $this->tableAlias(), $options, $sql_parts);

        $sql_parts = $this->applyQuerySortOptions($this->tableName(), $this->tableAlias(), $options, $sql_parts);

​

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

​