Added two-way push messaging support.

This commit is contained in:
Ylian Saint-Hilaire 2021-01-31 02:44:08 -08:00
parent 5a154b752e
commit 2248cb0a6d
6 changed files with 104 additions and 32 deletions

View File

@ -97,6 +97,7 @@
<Compile Include="amt\amt-xml.js" /> <Compile Include="amt\amt-xml.js" />
<Compile Include="amt\amt.js" /> <Compile Include="amt\amt.js" />
<Compile Include="exeHandler.js" /> <Compile Include="exeHandler.js" />
<Compile Include="firebase.js" />
<Compile Include="letsencrypt.js" /> <Compile Include="letsencrypt.js" />
<Compile Include="mcrec.js" /> <Compile Include="mcrec.js" />
<Compile Include="meshaccelerator.js" /> <Compile Include="meshaccelerator.js" />
@ -618,25 +619,31 @@
<Folder Include="translate\" /> <Folder Include="translate\" />
<Folder Include="typings\" /> <Folder Include="typings\" />
<Folder Include="typings\globals\" /> <Folder Include="typings\globals\" />
<Folder Include="typings\globals\ajv\" />
<Folder Include="typings\globals\connect-redis\" /> <Folder Include="typings\globals\connect-redis\" />
<Folder Include="typings\globals\cookie-session\" /> <Folder Include="typings\globals\cookie-session\" />
<Folder Include="typings\globals\express-handlebars\" /> <Folder Include="typings\globals\express-handlebars\" />
<Folder Include="typings\globals\express-session\" /> <Folder Include="typings\globals\express-session\" />
<Folder Include="typings\globals\jsbn\" />
<Folder Include="typings\globals\node-forge\" /> <Folder Include="typings\globals\node-forge\" />
<Folder Include="typings\globals\nodemailer\" /> <Folder Include="typings\globals\nodemailer\" />
<Folder Include="typings\globals\node\" /> <Folder Include="typings\globals\node\" />
<Folder Include="typings\globals\passport\" /> <Folder Include="typings\globals\passport\" />
<Folder Include="typings\globals\uuid\" />
<Folder Include="views\" /> <Folder Include="views\" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<TypeScriptCompile Include="typings\globals\ajv\index.d.ts" />
<TypeScriptCompile Include="typings\globals\connect-redis\index.d.ts" /> <TypeScriptCompile Include="typings\globals\connect-redis\index.d.ts" />
<TypeScriptCompile Include="typings\globals\cookie-session\index.d.ts" /> <TypeScriptCompile Include="typings\globals\cookie-session\index.d.ts" />
<TypeScriptCompile Include="typings\globals\express-handlebars\index.d.ts" /> <TypeScriptCompile Include="typings\globals\express-handlebars\index.d.ts" />
<TypeScriptCompile Include="typings\globals\express-session\index.d.ts" /> <TypeScriptCompile Include="typings\globals\express-session\index.d.ts" />
<TypeScriptCompile Include="typings\globals\jsbn\index.d.ts" />
<TypeScriptCompile Include="typings\globals\node-forge\index.d.ts" /> <TypeScriptCompile Include="typings\globals\node-forge\index.d.ts" />
<TypeScriptCompile Include="typings\globals\nodemailer\index.d.ts" /> <TypeScriptCompile Include="typings\globals\nodemailer\index.d.ts" />
<TypeScriptCompile Include="typings\globals\node\index.d.ts" /> <TypeScriptCompile Include="typings\globals\node\index.d.ts" />
<TypeScriptCompile Include="typings\globals\passport\index.d.ts" /> <TypeScriptCompile Include="typings\globals\passport\index.d.ts" />
<TypeScriptCompile Include="typings\globals\uuid\index.d.ts" />
<TypeScriptCompile Include="typings\index.d.ts" /> <TypeScriptCompile Include="typings\index.d.ts" />
</ItemGroup> </ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.Common.targets" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" /> <Import Project="$(MSBuildToolsPath)\Microsoft.Common.targets" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />

72
firebase.js Normal file
View File

@ -0,0 +1,72 @@
/**
* @description MeshCentral Firebase communication module
* @author Ylian Saint-Hilaire
* @copyright Intel Corporation 2018-2021
* @license Apache-2.0
* @version v0.0.1
*/
/*xjslint node: true */
/*xjslint plusplus: true */
/*xjslint maxlen: 256 */
/*jshint node: true */
/*jshint strict: false */
/*jshint esversion: 6 */
"use strict";
// Construct the Firebase object
module.exports.CreateFirebase = function (parent, senderid, serverkey) {
var obj = {};
obj.messageId = 1;
const Sender = require('node-xcs').Sender;
const Message = require('node-xcs').Message;
const Notification = require('node-xcs').Notification;
const xcs = new Sender(senderid, serverkey);
// Messages received from client (excluding receipts)
xcs.on('message', function (messageId, from, data, category) {
console.log('Firebase-Message', messageId, from, data, category);
});
// Only fired for messages where options.delivery_receipt_requested = true
/*
xcs.on('receipt', function (messageId, from, data, category) { console.log('Firebase-Receipt', messageId, from, data, category); });
xcs.on('connected', function () { console.log('Connected'); });
xcs.on('disconnected', function () { console.log('disconnected'); });
xcs.on('online', function () { console.log('online'); });
xcs.on('error', function (e) { console.log('error', e); });
xcs.on('message-error', function (e) { console.log('message-error', e); });
*/
xcs.start();
//var payload = { notification: { title: command.title, body: command.msg }, data: { url: obj.msgurl } };
//var options = { priority: 'High', timeToLive: 5 * 60 }; // TTL: 5 minutes, priority 'Normal' or 'High'
// Send an outbound push notification
obj.sendToDevice = function (token, payload, options, func) {
// Built the on-screen notification
var notification = null;
if (payload.notification) {
var notification = new Notification('ic_launcher')
.title(payload.notification.title)
.body(payload.notification.body)
.build();
}
// Build the message
var message = new Message('msg_' + (++obj.messageId));
if (options.priority) { message.priority(options.priority); }
if (payload.data) { for (var i in payload.data) { message.addData(i, payload.data[i]); } }
if (notification) { message.notification(notification) }
message.build();
// Send the message
function callback(result) { callback.func(result.getMessageId(), result.getError(), result.getErrorDescription()) }
callback.func = func;
xcs.sendNoRetry(message, token, callback);
}
return obj;
};

View File

@ -1545,15 +1545,8 @@ function CreateMeshCentralServer(config, args) {
} }
// Setup Firebase // Setup Firebase
if (config.firebase != null) { if ((config.firebase != null) && (typeof config.firebase.senderid == 'string') && (typeof config.firebase.serverkey == 'string')) {
try { obj.firebase = require('./firebase').CreateFirebase(this, config.firebase.senderid, config.firebase.serverkey);
obj.firebase = require('firebase-admin');
var firebaseServiceAccount = require(obj.path.join(obj.datapath, config.firebase.serviceaccountkeyfile));
obj.firebase.initializeApp({ credential: obj.firebase.credential.cert(firebaseServiceAccount) });
} catch (ex) {
console.log('Unable to setup Firebase: ' + ex);
delete obj.firebase;
}
} }
// Start periodic maintenance // Start periodic maintenance
@ -3066,7 +3059,7 @@ function mainStart() {
} }
// Firebase Support // Firebase Support
if (config.firebase != null) { modules.push('firebase-admin'); } if (config.firebase != null) { modules.push('node-xcs'); }
// Syslog support // Syslog support
if ((require('os').platform() != 'win32') && (config.settings.syslog || config.settings.syslogjson)) { modules.push('modern-syslog'); } if ((require('os').platform() != 'win32') && (config.settings.syslog || config.settings.syslogjson)) { modules.push('modern-syslog'); }

View File

@ -414,11 +414,12 @@ function CreateMeshRelayEx(parent, ws, req, domain, user, cookie) {
} }
} }
}); });
parent.wsrelays[obj.id] = { peer1: obj, state: 1 }; // No timeout on connections with push notification.
} else { } else {
ws._socket.pause(); // Hold traffic until the other connection ws._socket.pause(); // Hold traffic until the other connection
parent.parent.debug('relay', 'Relay holding: ' + obj.id + ' (' + obj.req.clientIp + ') ' + (obj.authenticated ? 'Authenticated' : '')); parent.parent.debug('relay', 'Relay holding: ' + obj.id + ' (' + obj.req.clientIp + ') ' + (obj.authenticated ? 'Authenticated' : ''));
parent.wsrelays[obj.id] = { peer1: obj, state: 1, timeout: setTimeout(closeBothSides, 60000) };
} }
parent.wsrelays[obj.id] = { peer1: obj, state: 1, timeout: setTimeout(closeBothSides, 30000) };
// Check if a peer server has this connection // Check if a peer server has this connection
if (parent.parent.multiServer != null) { if (parent.parent.multiServer != null) {
@ -485,15 +486,15 @@ function CreateMeshRelayEx(parent, ws, req, domain, user, cookie) {
command.title = (domain.title ? domain.title : 'MeshCentral'); command.title = (domain.title ? domain.title : 'MeshCentral');
var payload = { notification: { title: command.title, body: command.msg }, data: { url: obj.msgurl } }; var payload = { notification: { title: command.title, body: command.msg }, data: { url: obj.msgurl } };
var options = { priority: 'High', timeToLive: 5 * 60 }; // TTL: 5 minutes, priority 'Normal' or 'High' var options = { priority: 'High', timeToLive: 5 * 60 }; // TTL: 5 minutes, priority 'Normal' or 'High'
parent.parent.firebase.messaging().sendToDevice(obj.pmt, payload, options) parent.parent.firebase.sendToDevice(obj.pmt, payload, options, function (id, err, errdesc) {
.then(function (response) { if (err == null) {
parent.parent.debug('email', 'Successfully send push message to device ' + obj.nodename + ', title: ' + command.title + ', msg: ' + command.msg); parent.parent.debug('email', 'Successfully send push message to device ' + obj.nodename + ', title: ' + command.title + ', msg: ' + command.msg);
try { ws.send(JSON.stringify({ action: 'ctrl', value: 1 })); } catch (ex) { } // Push notification success try { ws.send(JSON.stringify({ action: 'ctrl', value: 1 })); } catch (ex) { } // Push notification success
}) } else {
.catch(function (error) { parent.parent.debug('email', 'Failed to send push message to device ' + obj.nodename + ', title: ' + command.title + ', msg: ' + command.msg + ', error: ' + errdesc);
parent.parent.debug('email', 'Failed to send push message to device ' + obj.nodename + ', title: ' + command.title + ', msg: ' + command.msg + ', error: ' + error);
try { ws.send(JSON.stringify({ action: 'ctrl', value: 2 })); } catch (ex) { } // Push notification failed try { ws.send(JSON.stringify({ action: 'ctrl', value: 2 })); } catch (ex) { } // Push notification failed
}); }
});
} }
} }
}); });

View File

@ -5207,13 +5207,13 @@ module.exports.CreateMeshUser = function (parent, db, ws, req, args, domain, use
// Send out a push message to the device // Send out a push message to the device
var payload = { notification: { title: command.title, body: command.msg } }; var payload = { notification: { title: command.title, body: command.msg } };
var options = { priority: "Normal", timeToLive: 5 * 60 }; // TTL: 5 minutes var options = { priority: "Normal", timeToLive: 5 * 60 }; // TTL: 5 minutes
parent.parent.firebase.messaging().sendToDevice(node.pmt, payload, options) parent.parent.firebase.sendToDevice(node.pmt, payload, options, function (id, err, errdesc) {
.then(function (response) { if (err == null) {
parent.parent.debug('email', 'Successfully send push message to device ' + node.name + ', title: ' + command.title + ', msg: ' + command.msg); parent.parent.debug('email', 'Successfully send push message to device ' + node.name + ', title: ' + command.title + ', msg: ' + command.msg);
}) } else {
.catch(function (error) { parent.parent.debug('email', 'Failed to send push message to device ' + node.name + ', title: ' + command.title + ', msg: ' + command.msg + ', error: ' + errdesc);
parent.parent.debug('email', 'Failed to send push message to device ' + node.name + ', title: ' + command.title + ', msg: ' + command.msg + ', error: ' + error); }
}); });
} }
} }
}); });
@ -5231,14 +5231,14 @@ module.exports.CreateMeshUser = function (parent, db, ws, req, args, domain, use
// Send out a push message to the device // Send out a push message to the device
var payload = { data: { console: command.console, session: ws.sessionId } }; var payload = { data: { console: command.console, session: ws.sessionId } };
var options = { priority: "Normal", timeToLive: 60 }; // TTL: 1 minutes, priority 'Normal' or 'High' var options = { priority: "Normal", timeToLive: 60 }; // TTL: 1 minutes, priority 'Normal' or 'High'
parent.parent.firebase.messaging().sendToDevice(node.pmt, payload, options) parent.parent.firebase.sendToDevice(node.pmt, payload, options, function (id, err, errdesc) {
.then(function (response) { if (err == null) {
try { ws.send(JSON.stringify({ action: 'msg', type: 'console', nodeid: node._id, value: 'OK' })); } catch (ex) { } try { ws.send(JSON.stringify({ action: 'msg', type: 'console', nodeid: node._id, value: 'OK' })); } catch (ex) { }
}) } else {
.catch(function (error) { try { ws.send(JSON.stringify({ action: 'msg', type: 'console', nodeid: node._id, value: 'Failed: ' + errdesc })); } catch (ex) { }
try { ws.send(JSON.stringify({ action: 'msg', type: 'console', nodeid: node._id, value: 'Failed: ' + error })); } catch (ex) { } parent.parent.debug('email', 'Failed to send push console message to device ' + node.name + ', command: ' + command.console + ', error: ' + errdesc);
parent.parent.debug('email', 'Failed to send push console message to device ' + node.name + ', command: ' + command.console + ', error: ' + error); }
}); });
} }
} }
}); });

View File

@ -18,7 +18,7 @@
"author": "Ylian Saint-Hilaire <ylianst@gmail.com>", "author": "Ylian Saint-Hilaire <ylianst@gmail.com>",
"main": "meshcentral.js", "main": "meshcentral.js",
"bin": { "bin": {
"meshcentral": "./bin/meshcentral" "meshcentral": "bin/meshcentral"
}, },
"license": "Apache-2.0", "license": "Apache-2.0",
"files": [ "files": [
@ -53,7 +53,6 @@
"xmldom": "^0.1.27", "xmldom": "^0.1.27",
"yauzl": "^2.10.0" "yauzl": "^2.10.0"
}, },
"devDependencies": {},
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/Ylianst/MeshCentral.git" "url": "https://github.com/Ylianst/MeshCentral.git"