143 lines
4.6 KiB
PHP
143 lines
4.6 KiB
PHP
<?php
|
|
/**
|
|
* Discord.php
|
|
*
|
|
* LibreNMS Discord API Tranport
|
|
*
|
|
* 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/>.
|
|
*
|
|
* @link https://www.librenms.org
|
|
* @copyright 2018 Ryan Finney
|
|
* @author https://github.com/theherodied/
|
|
* @contributer f0o, sdef2
|
|
* Thanks to F0o <f0o@devilcode.org> for creating the Slack transport which is the majority of this code.
|
|
* Thanks to sdef2 for figuring out the differences needed to make Discord work.
|
|
*/
|
|
|
|
namespace LibreNMS\Alert\Transport;
|
|
|
|
use LibreNMS\Alert\Transport;
|
|
|
|
class Discord extends Transport
|
|
{
|
|
const ALERT_FIELDS_TO_DISCORD_FIELDS = [
|
|
'timestamp' => 'Timestamp',
|
|
'severity' => 'Severity',
|
|
'hostname' => 'Hostname',
|
|
'name' => 'Rule Name',
|
|
'rule' => 'Rule',
|
|
];
|
|
|
|
public function deliverAlert($obj, $opts)
|
|
{
|
|
$discord_opts = [
|
|
'url' => $this->config['url'],
|
|
'options' => $this->parseUserOptions($this->config['options']),
|
|
];
|
|
|
|
return $this->contactDiscord($obj, $discord_opts);
|
|
}
|
|
|
|
public function contactDiscord($obj, $discord_opts)
|
|
{
|
|
$host = $discord_opts['url'];
|
|
$curl = curl_init();
|
|
$discord_title = '#' . $obj['uid'] . ' ' . $obj['title'];
|
|
$discord_msg = strip_tags($obj['msg']);
|
|
$color = self::getColorForState($obj['state']);
|
|
|
|
// Special handling for the elapsed text in the footer if the elapsed is not set.
|
|
$footer_text = $obj['elapsed'] ? 'alert took ' . $obj['elapsed'] : '';
|
|
|
|
$data = [
|
|
'embeds' => [
|
|
[
|
|
'title' => $discord_title,
|
|
'color' => hexdec($color),
|
|
'description' => $discord_msg,
|
|
'fields' => $this->createDiscordFields($obj, $discord_opts),
|
|
'footer' => [
|
|
'text' => $footer_text,
|
|
],
|
|
],
|
|
],
|
|
];
|
|
if (! empty($discord_opts['options'])) {
|
|
$data = array_merge($data, $discord_opts['options']);
|
|
}
|
|
|
|
$alert_message = json_encode($data);
|
|
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
|
|
set_curl_proxy($curl);
|
|
curl_setopt($curl, CURLOPT_URL, $host);
|
|
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
|
|
curl_setopt($curl, CURLOPT_POST, true);
|
|
curl_setopt($curl, CURLOPT_POSTFIELDS, $alert_message);
|
|
|
|
$ret = curl_exec($curl);
|
|
$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
|
|
if ($code != 204) {
|
|
var_dump("API '$host' returned Error"); //FIXME: propper debuging
|
|
var_dump('Params: ' . $alert_message); //FIXME: propper debuging
|
|
var_dump('Return: ' . $ret); //FIXME: propper debuging
|
|
|
|
return 'HTTP Status code ' . $code;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
public function createDiscordFields($obj, $discord_opts)
|
|
{
|
|
$result = [];
|
|
|
|
foreach (self::ALERT_FIELDS_TO_DISCORD_FIELDS as $objKey => $discordKey) {
|
|
// Skip over keys that do not exist so Discord does not give us a 400.
|
|
if (! $obj[$objKey]) {
|
|
continue;
|
|
}
|
|
|
|
array_push($result, [
|
|
'name' => $discordKey,
|
|
'value' => $obj[$objKey],
|
|
]);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
public static function configTemplate()
|
|
{
|
|
return [
|
|
'config' => [
|
|
[
|
|
'title' => 'Discord URL',
|
|
'name' => 'url',
|
|
'descr' => 'Discord URL',
|
|
'type' => 'text',
|
|
],
|
|
[
|
|
'title' => 'Options',
|
|
'name' => 'options',
|
|
'descr' => 'Enter the config options (format: option=value separated by new lines)',
|
|
'type' => 'textarea',
|
|
],
|
|
],
|
|
'validation' => [
|
|
'url' => 'required|url',
|
|
],
|
|
];
|
|
}
|
|
}
|