mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
31e8557930
* Add support for Webex max message length. Webex limits messages to just over 7 KB. Some alerts might be longer than this. So truncate the message with ellipses. While here switch to using the new API URL. * Use spaces. Formatting got messed up on the transfer from test to dev. * Do the truncation after the message is massaged. This may yield a few more allowed characters. --------- Co-authored-by: Joe Clarke <jclarke@cisco.com>
91 lines
2.8 KiB
PHP
91 lines
2.8 KiB
PHP
<?php
|
|
/*
|
|
* LibreNMS
|
|
*
|
|
* Copyright (c) 2017 Søren Friis Rosiak <sorenrosiak@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. Please see LICENSE.txt at the top level of
|
|
* the source code distribution for details.
|
|
*/
|
|
|
|
namespace LibreNMS\Alert\Transport;
|
|
|
|
use LibreNMS\Alert\Transport;
|
|
use LibreNMS\Exceptions\AlertTransportDeliveryException;
|
|
use LibreNMS\Util\Http;
|
|
|
|
class Ciscospark extends Transport
|
|
{
|
|
protected string $name = 'Cisco Webex Teams';
|
|
// This is the total length minus 4 bytes for ellipses.
|
|
private static int $MAX_MSG_SIZE = 7435;
|
|
|
|
public function deliverAlert(array $alert_data): bool
|
|
{
|
|
$room_id = $this->config['room-id'];
|
|
$token = $this->config['api-token'];
|
|
$url = 'https://webexapis.com/v1/messages';
|
|
$data = [
|
|
'roomId' => $room_id,
|
|
];
|
|
|
|
if ($this->config['use-markdown'] === 'on') {
|
|
// Remove blank lines as they create weird markdown behaviors.
|
|
$msg = preg_replace('/^\s+/m', '', $alert_data['msg']);
|
|
$mtype = 'markdown';
|
|
} else {
|
|
$msg = strip_tags($alert_data['msg']);
|
|
$mtype = 'text';
|
|
}
|
|
|
|
if (strlen($msg) > Ciscospark::$MAX_MSG_SIZE) {
|
|
$msg = substr($msg, 0, Ciscospark::$MAX_MSG_SIZE) . '...';
|
|
}
|
|
|
|
$data[$mtype] = $msg;
|
|
|
|
$res = Http::client()
|
|
->withToken($token)
|
|
->post($url, $data);
|
|
|
|
if ($res->successful()) {
|
|
return true;
|
|
}
|
|
|
|
throw new AlertTransportDeliveryException($alert_data, $res->status(), $res->body(), $data['text'] ?? $data['markdown'], $data);
|
|
}
|
|
|
|
public static function configTemplate(): array
|
|
{
|
|
return [
|
|
'config' => [
|
|
[
|
|
'title' => 'API Token',
|
|
'name' => 'api-token',
|
|
'descr' => 'CiscoSpark API Token',
|
|
'type' => 'password',
|
|
],
|
|
[
|
|
'title' => 'RoomID',
|
|
'name' => 'room-id',
|
|
'descr' => 'CiscoSpark Room ID',
|
|
'type' => 'text',
|
|
],
|
|
[
|
|
'title' => 'Use Markdown?',
|
|
'name' => 'use-markdown',
|
|
'descr' => 'Use Markdown when sending the alert',
|
|
'type' => 'checkbox',
|
|
'default' => false,
|
|
],
|
|
],
|
|
'validation' => [
|
|
'api-token' => 'required|string',
|
|
'room-id' => 'required|string',
|
|
],
|
|
];
|
|
}
|
|
}
|