librenms / librenms

LibreNMS/Alert/Transport/Jira.php

<?php
/* Copyright (C) 2015 Aldemir Akpinar <aldemir.akpinar@gmail.com>
 * 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 3 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, see <https://www.gnu.org/licenses/>. */

/**
 * Jira API Transport
 *
 * @author  Aldemir Akpinar <aldemir.akpinar@gmail.com>
 * @copyright 2017 Aldemir Akpinar, LibreNMS
 * @license GPL
 */

namespace LibreNMS\Alert\Transport;

use LibreNMS\Alert\Transport;

class Jira extends Transport
{
    public function deliverAlert($obj, $opts)
    {
        if (! empty($this->config)) {
            $opts['username'] = $this->config['jira-username'];
            $opts['password'] = $this->config['jira-password'];
            $opts['prjkey'] = $this->config['jira-key'];
            $opts['issuetype'] = $this->config['jira-type'];
            $opts['url'] = $this->config['jira-url'];
        }

        return $this->contactJira($obj, $opts);
    }

    public function contactJira($obj, $opts)
    {
        // Don't create tickets for resolutions
        if ($obj['severity'] == 'recovery' && $obj['msg'] != 'This is a test alert') {
            return true;
        }

        $device = device_by_id_cache($obj['device_id']); // for event logging

        $username = $opts['username'];
        $password = $opts['password'];
        $prjkey = $opts['prjkey'];
        $issuetype = $opts['issuetype'];
        $details = 'Librenms alert for: ' . $obj['hostname'];
        $description = $obj['msg'];
        $url = $opts['url'] . '/rest/api/latest/issue';
        $curl = curl_init();

        $data = ['project' => ['key' => $prjkey],
            'summary' => $details,
            'description' => $description,
            'issuetype' => ['name' => $issuetype], ];
        $postdata = ['fields' => $data];
        $datastring = json_encode($postdata);

        set_curl_proxy($curl);

        $headers = ['Accept: application/json', 'Content-Type: application/json'];

        curl_setopt($curl, CURLOPT_URL, $url);
        curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($curl, CURLOPT_USERPWD, "$username:$password");
        curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_VERBOSE, 1);
        curl_setopt($curl, CURLOPT_POSTFIELDS, $datastring);

        $ret = curl_exec($curl);
        $code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
        if ($code == 200) {
            $jiraout = json_decode($ret, true);

It seems like $ret can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

            d_echo('Created jira issue ' . $jiraout['key'] . ' for ' . $device);

            return true;
        } else {
            d_echo('Jira connection error: ' . serialize($ret));

            return false;
        }
    }

    public static function configTemplate()
    {
        return [
            'config' => [
                [
                    'title' => 'URL',
                    'name' => 'jira-url',
                    'descr' => 'Jira URL',
                    'type' => 'text',
                ],
                [
                    'title' => 'Project Key',
                    'name' => 'jira-key',
                    'descr' => 'Jira Project Key',
                    'type' => 'text',
                ],
                [
                    'title' => 'Issue Type',
                    'name' => 'jira-type',
                    'descr' => 'Jira Issue Type',
                    'type' => 'text',
                ],
                [
                    'title' => 'Jira Username',
                    'name' => 'jira-username',
                    'descr' => 'Jira Username',
                    'type' => 'text',
                ],
                [
                    'title' => 'Jira Password',
                    'name' => 'jira-password',
                    'descr' => 'Jira Password',
                    'type' => 'text',
                ],
            ],
            'validation' => [
                'jira-key' => 'required|string',
                'jira-url' => 'required|string',
                'jira-type' => 'required|string',
                'jira-username' => 'required|string',
                'jira-password' => 'required|string',
            ],
        ];
    }
}