mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
vivia11
e1118b628a
Hello all, I guess this is the second version of a more fully fleshed out alert contact mapping feature. The old one was GH-8507 Transports to convert: - [x] API - [x] Cisco Spark - [x] Elasticsearch - [x] GitLab - [x] Philips Hue - [x] Jira - [x] Mail - [ ] ~~PagerDuty~~ - Requires a callback so leaving for now - [x] Nagios - [x] IRC - [x] Discord - [x] Rocket.chat - [x] Hipchat - [x] Pushover - [x] Boxcar - [x] Telegram - [x] Pushbullet - [x] VictorOps - [x] OpsGenie - [x] Clickatell - [x] PlaySMS - [x] Canopsis - [x] osTicket - [x] Microsoft Teams - [x] SMSEagle - [x] Syslog - [x] Slack The intention is for this feature to have three different levels to it: 1. Alert rule to an alert contact mapping (where the code is at now) 2. Alert rule to an alert group (made up of alert contacts) mapping 3. Alert contact mapping to different transport configurations. There will be three transport configuration types. 1. Default (the configuration that is held in the configs table) 2. None (no transport configuration - will explain later) 3. Other (a configuration that will be defined in a different able) Take Mail transport for example. It can either be of a "default" or "other" configuration. The hope is that in the future, users can send mail from different mail servers if they wish. However, for ciscospark which requires a room ID and an api-token, I've decided that it has no transport configuration. Most likely, every alert contact will contain a different room-id and an api-token - which is why it has the transport config of "none". For other transports : I am not familiar with them, so hopefully the community can add support for these. I can definitely help! To add support for each transport will require several things: - addition to the UI - addition to forms/alert-contacts.inc.php - modifications to its object class Screenshots    I'm not sure if this is the best way to do things, so please let me know if there's a better way to structure the code! Any comments on code/db schema,/UI etc is welcome and encouraged! The UI is heavily based on alert rules (front end is not my strong suit). And parts of the code are based on the code that was written for alert rules. DO NOT DELETE THIS TEXT #### Please note > Please read this information carefully. You can run `./scripts/pre-commit.php` to check your code before submitting. - [x] Have you followed our [code guidelines?](http://docs.librenms.org/Developing/Code-Guidelines/) #### Testers If you would like to test this pull request then please run: `./scripts/github-apply <pr_id>`, i.e `./scripts/github-apply 5926`
110 lines
3.6 KiB
PHP
110 lines
3.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 <http://www.gnu.org/licenses/>.
|
|
*
|
|
* @package LibreNMS
|
|
* @link http://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
|
|
{
|
|
public function deliverAlert($obj, $opts)
|
|
{
|
|
if (empty($this->config)) {
|
|
return $this->deliverAlertOld($obj, $opts);
|
|
}
|
|
$discord_opts['url'] = $this->config['url'];
|
|
foreach (explode(PHP_EOL, $this->config['options']) as $option) {
|
|
list($k,$v) = explode('=', $option);
|
|
$discord_opts['options'][$k] = $v;
|
|
}
|
|
return $this->contactDiscord($obj, $discord_opts);
|
|
}
|
|
|
|
public function deliverAlertOld($obj, $opts)
|
|
{
|
|
foreach ($opts as $discord_opts) {
|
|
$this->contactDiscord($obj, $discord_opts);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public function contactDiscord($obj, $discord_opts)
|
|
{
|
|
$host = $discord_opts['url'];
|
|
$curl = curl_init();
|
|
$discord_msg = strip_tags($obj['msg']);
|
|
$data = [
|
|
'content' => "". $obj['title'] ."\n" . $discord_msg
|
|
];
|
|
if (!empty($discord_opts['options'])) {
|
|
$data = array_merge($data, $discord_opts['options']);
|
|
}
|
|
|
|
$alert_message = json_encode($data);
|
|
curl_setopt($curl, CURLOPT_HTTPHEADER, array('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 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',
|
|
]
|
|
];
|
|
}
|
|
}
|