Added Pushover messaging integration (#4691)
Ylian Saint-Hilaire committed
Oct 30, 2022 at 11:28 UTC
e59fac488410d40f8fcd61b89ebc896568ea8de9
5 files changed
+43
-7
meshcentral.js
+1
@@ -4031,6 +4031,7 @@ function mainStart() {
4031
if (config.messaging.telegram != null) { modules.push('telegram'); modules.push('input'); }
4032
if (config.messaging.discord != null) { if (nodeVersion >= 17) { modules.push('discord.js@14.6.0'); } else { delete config.messaging.discord; addServerWarning('This NodeJS version does not support Discord.js.', 26); } }
4033
if (config.messaging.xmpp != null) { modules.push('@xmpp/client'); }
4034
+ if (config.messaging.pushover != null) { modules.push('node-pushover'); }
4035
}
4036
4037
// Setup web based push notifications
meshmessaging.js
+31
-4
@@ -62,19 +62,29 @@
62
}
63
}
64
65
+// For Pushover
66
+{
67
+ "messaging": {
68
+ "pushover": {
69
+ "token": "xxxxxxx"
70
+ }
71
+ }
72
+}
73
+
74
*/
75
76
// Construct a messaging server object
77
module.exports.CreateServer = function (parent) {
78
var obj = {};
79
obj.parent = parent;
71
- obj.providers = 0; // 1 = Telegram, 2 = Signal, 4 = Discord, 8 = XMPP, 16 = CallMeBot
80
+ obj.providers = 0; // 1 = Telegram, 2 = Signal, 4 = Discord, 8 = XMPP, 16 = CallMeBot, 32 = Pushover
81
obj.telegramClient = null;
82
obj.discordClient = null;
83
obj.discordUrl = null;
84
obj.xmppClient = null;
85
var xmppXml = null;
86
obj.callMeBotClient = null;
87
+ obj.pushoverClient = null;
88
89
// Telegram client setup
90
if (parent.config.messaging.telegram) {
@@ -192,6 +202,19 @@ module.exports.CreateServer = function (parent) {
202
obj.providers += 16; // Enable CallMeBot messaging
203
}
204
205
+ // Pushover client setup (https://pushover.net)
206
+ if (parent.config.messaging.pushover) {
207
+ // Validate Pushover configuration values
208
+ var pushoverOK = true;
209
+ if (typeof parent.config.messaging.pushover.token != 'string') { console.log('Invalid or missing Pushover token.'); pushoverOK = false; }
210
+
211
+ if (pushoverOK) {
212
+ // Setup PushOver
213
+ obj.pushoverClient = true;
214
+ obj.providers += 32; // Enable Pushover messaging
215
+ }
216
+ }
217
+
218
// Send a direct message to a specific userid
219
async function discordSendMsg(userId, message) {
220
const user = await obj.discordClient.users.fetch(userId).catch(function () { return null; });
@@ -221,7 +244,7 @@ module.exports.CreateServer = function (parent) {
244
}
245
246
// Send an user message
224
- obj.sendMessage = function(to, msg, func) {
247
+ obj.sendMessage = function(to, msg, domain, func) {
248
if ((to.startsWith('telegram:')) && (obj.telegramClient != null)) { // Telegram
249
async function sendTelegramMessage(to, msg, func) {
250
if (obj.telegramClient == null) return;
@@ -251,6 +274,10 @@ module.exports.CreateServer = function (parent) {
274
var url = 'https://api.callmebot.com/facebook/send.php?apikey=' + encodeURIComponent(toData[1]) + '&text=' + encodeURIComponent(msg);
275
require('https').get(url, function (r) { if (func != null) { func(r.statusCode == 200); } });
276
}
277
+ } else if ((to.startsWith('pushover:')) && (obj.pushoverClient != null)) { // Pushover
278
+ const Pushover = require('node-pushover');
279
+ const push = new Pushover({ token: parent.config.messaging.pushover.token, user: to.substring(9) });
280
+ push.send(domain.title ? domain.title : 'MeshCentral', msg, function (err, res) { if (func != null) { func(err == null); } });
281
} else {
282
// No providers found
283
func(false, "No messaging providers found for this message.");
@@ -324,7 +351,7 @@ module.exports.CreateServer = function (parent) {
351
sms = sms.split('[[1]]').join(verificationCode);
352
353
// Send the message
327
- obj.sendMessage(to, sms, func);
354
+ obj.sendMessage(to, sms, domain, func);
355
};
356
357
// Send 2FA verification
@@ -339,7 +366,7 @@ module.exports.CreateServer = function (parent) {
366
sms = sms.split('[[1]]').join(verificationCode);
367
368
// Send the message
342
- obj.sendMessage(to, sms, func);
369
+ obj.sendMessage(to, sms, domain, func);
370
};
371
372
return obj;
meshuser.js
+4
-2
@@ -6570,7 +6570,7 @@ module.exports.CreateMeshUser = function (parent, db, ws, req, args, domain, use
6570
6571
if (errMsg != null) { displayNotificationMessage(errMsg); return; }
6572
6573
- parent.parent.msgserver.sendMessage(msguser.msghandle, command.msg, function (success, msg) {
6573
+ parent.parent.msgserver.sendMessage(msguser.msghandle, command.msg, domain, function (success, msg) {
6574
if (success) {
6575
displayNotificationMessage("Message succesfuly sent.", null, null, null, 32);
6576
} else {
@@ -6701,6 +6701,7 @@ module.exports.CreateMeshUser = function (parent, db, ws, req, args, domain, use
6701
if ((command.service == 4) && ((parent.parent.msgserver.providers & 4) != 0)) { handle = 'discord:' + command.handle; }
6702
if ((command.service == 8) && ((parent.parent.msgserver.providers & 8) != 0)) { handle = 'xmpp:' + command.handle; }
6703
if ((command.service == 16) && ((parent.parent.msgserver.providers & 16) != 0)) { handle = parent.parent.msgserver.callmebotUrlToHandle(command.handle); }
6704
+ if ((command.service == 32) && ((parent.parent.msgserver.providers & 32) != 0)) { handle = 'pushover:' + command.handle; }
6705
if (handle == null) return;
6706
6707
// Send a verification message
@@ -6844,9 +6845,10 @@ module.exports.CreateMeshUser = function (parent, db, ws, req, args, domain, use
6845
if ((parent.parent.msgserver.providers & 2) != 0) { r.push("Usage: MSG \"signal:UserHandle\" \"Message\"."); }
6846
if ((parent.parent.msgserver.providers & 4) != 0) { r.push("Usage: MSG \"discord:Username#0000\" \"Message\"."); }
6847
if ((parent.parent.msgserver.providers & 8) != 0) { r.push("Usage: MSG \"xmpp:username@server.com\" \"Message\"."); }
6848
+ if ((parent.parent.msgserver.providers & 32) != 0) { r.push("Usage: MSG \"pushover:userkey\" \"Message\"."); }
6849
cmdData.result = r.join('\r\n');
6850
} else {
6849
- parent.parent.msgserver.sendMessage(cmdData.cmdargs['_'][0], cmdData.cmdargs['_'][1], function (status, msg) {
6851
+ parent.parent.msgserver.sendMessage(cmdData.cmdargs['_'][0], cmdData.cmdargs['_'][1], domain, function (status, msg) {
6852
if (typeof msg == 'string') {
6853
try { ws.send(JSON.stringify({ action: 'serverconsole', value: status ? ('Success: ' + msg) : ('Failed: ' + msg), tag: cmdData.command.tag })); } catch (ex) { }
6854
} else {
package.json
+2
-1
@@ -37,6 +37,7 @@
37
"sample-config-advanced.json"
38
],
39
"dependencies": {
40
+ "@yetzt/nedb": "^1.8.0",
41
"archiver": "^5.3.1",
42
"body-parser": "^1.19.0",
43
"cbor": "~5.2.0",
@@ -48,8 +49,8 @@
49
"ipcheck": "^0.1.0",
50
"minimist": "^1.2.5",
51
"multiparty": "^4.2.1",
51
- "@yetzt/nedb": "^1.8.0",
52
"node-forge": "^1.0.0",
53
+ "node-pushover": "^1.0.0",
54
"ws": "^5.2.3",
55
"yauzl": "^2.10.0"
56
},
views/default.handlebars
+5
@@ -11986,6 +11986,7 @@
11986
if ((serverinfo.userMsgProviders & 4) != 0) { y += '<option value=4>' + "Discord" + '</option>'; }
11987
if ((serverinfo.userMsgProviders & 8) != 0) { y += '<option value=8>' + "XMPP" + '</option>'; }
11988
if ((serverinfo.userMsgProviders & 16) != 0) { y += '<option value=16>' + "CallMeBot" + '</option>'; }
11989
+ if ((serverinfo.userMsgProviders & 32) != 0) { y += '<option value=32>' + "Pushover" + '</option>'; }
11990
y += '</select>';
11991
x += '<table><tr><td>' + "Service" + '<td>' + y;
11992
x += '<tr><td>' + "Handle" + '<td><input maxlength=1024 style=width:160px;margin-left:8px id=d2handleinput onKeyUp=account_manageMessagingValidate() onkeypress="if (event.key==\'Enter\') account_manageMessagingValidate(1)">';
@@ -12004,6 +12005,7 @@
12005
if (Q('d2serviceselect').value == 4) { Q('d2handleinput')['placeholder'] = "Username:0000"; }
12006
else if (Q('d2serviceselect').value == 8) { Q('d2handleinput')['placeholder'] = "username@server.com"; }
12007
else if (Q('d2serviceselect').value == 16) { Q('d2handleinput')['placeholder'] = "https://api.callmebot.com/..."; }
12008
+ else if (Q('d2serviceselect').value == 32) { Q('d2handleinput')['placeholder'] = "User key"; }
12009
else { Q('d2handleinput')['placeholder'] = "Username"; }
12010
var ok = (Q('d2handleinput').value.length > 0); QE('idx_dlgOkButton', ok); if ((x == 1) && ok) { dialogclose(1); }
12011
}
@@ -15867,6 +15869,7 @@
15869
if ((serverinfo.userMsgProviders & 4) != 0) { y += '<option value=4>' + "Discord" + '</option>'; }
15870
if ((serverinfo.userMsgProviders & 8) != 0) { y += '<option value=8>' + "XMPP" + '</option>'; }
15871
if ((serverinfo.userMsgProviders & 16) != 0) { y += '<option value=16>' + "CallMeBot" + '</option>'; }
15872
+ if ((serverinfo.userMsgProviders & 32) != 0) { y += '<option value=32>' + "Pushover" + '</option>'; }
15873
y += '</select>';
15874
x += '<table style=margin-top:12px><tr><td>' + "Service" + '<td>' + y;
15875
x += '<tr><td>' + "Handle" + '<td><input maxlength=1024 style=width:160px;margin-left:8px id=d2handleinput onKeyUp=p30editMessagingValidate() onkeypress="if (event.key==\'Enter\') p30editMessagingValidate(1)">';
@@ -15886,6 +15889,7 @@
15889
if ((toData[0] == 'whatsapp') && (toData.length == 3)) { Q('d2handleinput').value = 'https://api.callmebot.com/whatsapp.php?phone=' + decodeURIComponent(toData[1]) + '&apikey=' + decodeURIComponent(toData[2]); }
15890
if ((toData[0] == 'facebook') && (toData.length == 2)) { Q('d2handleinput').value = 'https://api.callmebot.com/facebook/send.php?apikey=' + decodeURIComponent(toData[1]); }
15891
}
15892
+ if (userinfo.msghandle.startsWith('pushover:') && ((serverinfo.userMsgProviders & 32) != 0)) { Q('d2serviceselect').value = 32; Q('d2handleinput').value = userinfo.msghandle.substring(9); }
15893
}
15894
p30editMessagingValidate();
15895
}
@@ -15898,6 +15902,7 @@
15902
else if (Q('d2serviceselect').value == 4) { Q('d2handleinput')['placeholder'] = "Username:0000"; }
15903
else if (Q('d2serviceselect').value == 8) { Q('d2handleinput')['placeholder'] = "username@server.com"; }
15904
else if (Q('d2serviceselect').value == 16) { Q('d2handleinput')['placeholder'] = "https://api.callmebot.com/..."; }
15905
+ else if (Q('d2serviceselect').value == 32) { Q('d2handleinput')['placeholder'] = "User key"; }
15906
else { Q('d2handleinput')['placeholder'] = "Username"; }
15907
if (x == 1) { dialogclose(1); }
15908
}