node-red-contrib-remote 1.3.0 → 1.4.0

package/README.md

@@ -26,7 +26,7 @@ There is a help page describing how the the nodes work together and how to conne
 
 [Help in English](https://www.remote-red.com/en/help/)
 
-[Hilfe in deutsch](https://www.remote-red.com/de/hilfe/)
+[Hilfe in Deutsch](https://www.remote-red.com/de/hilfe/)
 
 
 ## Contact
@@ -36,6 +36,21 @@ You will find more information on [www.remote-red-com](https://www.remote-red.co
 
 ## Version History
 
+Version 1.4.0
+- In addition to the QR code, a link is now generated to add an instance in the app.
+- Sending notifications and questions is prevented if msg.playload.send === false.
+- Error catched if a notification or question does not contain a title and body.
+
+Version 1.3.3:
+- Improved compatibility for Windows.
+
+Version 1.3.2:
+- Changed the method to get the installed node version. Thanks hardillb!
+
+Version 1.3.1:
+- Added timeout handling to the heartbeat function.
+- Catches errors when evaluating the title, body or sound of an notification.
+
 Version 1.3.0:
 - A heartbeat function is added to the remote access node. This will automatically reconnect if the connection is interrupted, e.g. due to an unstable internet connection.
 

package/nodes/locales/de/remote-config.json

@@ -46,6 +46,11 @@
         "apphelp": {
           "title": "App Hilfe",
           "para1": "Lade die Remote-RED App aus dem Apple AppStore oder Google PlayStore herunter. Verwende in der App die Funktion “Node-RED Instanz hinzufügen” um diesen QR-Code zu scannen."
+        },
+        "applink": {
+          "title": "Alternative: Per Link hinzufügen",
+          "para1": "Öffne diesen Link auf Deinem iOS oder Android Gerät, nachdem Du die Remote-RED App installiert hast:",
+          "link": "Link zum hinzufügen"
         }
     }
 }

package/nodes/locales/de/remote-notification.json

@@ -34,7 +34,7 @@
           "title": "Hilfe",
           "para1": "Über diese Node kannst Du eine Push Notification an die Geräte versenden, die mit der gewählten Config-Node verbunden sind. Wähle hierzu eine Config-Node, die Du auch z.B. bereits in einer Access-Node verwendest. Du kannst in mehreren Notification-Nodes die selbe Config-Node verwenden.",
           "para2": "Konfiguriere den Titel und den Text der Benachrichtigung. Die Vorgabewerte gehen davon aus, das im Payload der eingehenden Nachricht die Strings “title” und “body” enthalten sind. Du kannst aber auch feste Texte eingeben oder Flow- bzw. Global-Variablen verwenden.",
-          "para3": "Immer sobald eine Message bei der Notification-Node ankommt, wird eine Notification an Deine Geräte versendet."
+          "para3": "Immer sobald eine Message bei der Notification-Node ankommt, wird eine Notification an Deine Geräte versendet. Es wird kein Versand durchgeführt, wenn msg.payload.send den Boolean-Wert 'false' enthält."
         }
     }
 }

package/nodes/locales/de/remote-question.json

@@ -38,7 +38,7 @@
           "para2": "Wichtig ist, das die Confg-Node auf Deinen lokalen Node-RED Rechner verweist und eine Access-Node damit aktiv ist. Die Basis URL ist dabei irrelevant.",
           "para3": "Konfiguriere den Titel und den Text der Benachrichtigung. Die Vorgabewerte gehen davon aus, das im Payload der eingehenden Nachricht die Strings “title” und “body” enthalten sind. Du kannst aber auch feste Texte eingeben oder Flow- bzw. Global-Variablen verwenden.",
           "para4": "Du kannst bis zu drei Antworten vorgeben. Der Text der Antworten kannst Du direkt als String eingeben oder aus der eingehenden Nachricht übernehmen. Ist der Text leer, wird die Antwort nicht angezeigt. Über den Wert kannst Du angeben, was die Node per msg.payload ausgibt, wenn Du diese Antwort wählst.",
-          "para5": "Immer sobald eine Message bei der Question-Node ankommt, wird eine Notification an Deine Geräte versendet."
+          "para5": "Immer sobald eine Message bei der Question-Node ankommt, wird eine Notification an Deine Geräte versendet. Es wird kein Versand durchgeführt, wenn msg.payload.send den Boolean-Wert 'false' enthält."
         }
     }
 }

package/nodes/locales/en-US/remote-config.json

@@ -46,6 +46,11 @@
         "apphelp": {
           "title": "App Help",
           "para1": "Download the Remote-RED app from the Apple AppStore or Google PlayStore. Use the function “Add Node-RED Instance” in the app to scan this QR Code."
+        },
+        "applink": {
+          "title": "Alternative: Add via link",
+          "para1": "Open this link on your iOS or Android device after installing the Remote-RED app:",
+          "link": "Link to add"
         }
     }
 }

package/nodes/locales/en-US/remote-notification.json

@@ -34,7 +34,7 @@
           "title": "Help",
           "para1": "With this node you can send a push notification to the devices connected to the selected config node. Select a config node that you already use in an access node. You can use the same config node in several notification nodes.",
           "para2": "Configure the title and the text of the notification. The default values assume that the payload of the incoming message contains the strings “title” and “body”. You can also enter fixed texts or use flow or global variables.",
-          "para3": "Whenever a message arrives at the notification node, a notification is sent to your devices."
+          "para3": "Whenever a message arrives at the notification node, a notification is sent to your devices. No send is performed if msg.payload.send contains the boolean value 'false'."
         }
     }
 }

package/nodes/locales/en-US/remote-question.json

@@ -38,7 +38,7 @@
           "para2": "It is important that the confg node points to your local Node-RED computer and that an access node is active with it. The base URL is irrelevant.",
           "para3": "Configure the title and the text of the notification. The default values assume that the payload of the incoming message contains the strings “title” and “body”. You can also enter fixed texts or use flow or global variables.",
           "para4": "You can specify up to three answers. The text of the answers can be entered directly as an string or taken from the incoming message. If the text is empty, the answer is not displayed. You can use the value to specify what the node outputs in msg.payload when you select this answer.",
-          "para5": "Whenever a message arrives at the question node, a notification is sent to your devices."
+          "para5": "Whenever a message arrives at the question node, a notification is sent to your devices. No send is performed if msg.payload.send contains the boolean value 'false'."
         }
     }
 }

package/nodes/remote-access.html

@@ -10,6 +10,8 @@
     inputs: 0,
     outputs: 1,
     outputLabels: ["action output"],
+    // outputs: 2,
+    // outputLabels: ["action output", "geofence output"],
     icon: "font-awesome/fa-mobile",
     label: function() {
         return this.name || "remote access";

package/nodes/remote-access.js

@@ -2,6 +2,8 @@ module.exports = function(RED) {
   const commons = require('./remote-commons');
   const child_process = require('child_process');
   const os = require("os");
+  let sshprocess = undefined
+  let statustext = ''
 
   function startSSH(node, server, port) {
     try {
@@ -21,10 +23,10 @@ module.exports = function(RED) {
       if ( node.verbose ) {
         sshparameters.push('-v');
       }
-      const sshprocess = child_process.spawn("ssh", sshparameters);
+      sshprocess = child_process.spawn("ssh", sshparameters);
 
       // Set serving.. if not working, the process will exit or close
-      node.status({fill:"green",shape:"dot",text:"remote-access.status.serving"});
+      setStatus(node, {fill:"green",shape:"dot",text:"remote-access.status.serving"});
       node.serving = true
 
       // Attach to process events
@@ -37,13 +39,17 @@ module.exports = function(RED) {
       });
 
       sshprocess.on('close', (code, signal) => {
-        node.status({fill:"red",shape:"dot",text:"remote-access.status.stopped"});
+        if ( statustext !== "remote-access.status.heartbeaterror" ) {
+          setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.stopped"});
+        }
         node.serving = false
         node.log("ssh process stopped (close: " + code + " / " + signal + ")");
       });
 
       sshprocess.on('exit', (code, signal) => {
-        node.status({fill:"red",shape:"dot",text:"remote-access.status.stopped"});
+        if ( statustext !== "remote-access.status.heartbeaterror" ) {
+          setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.stopped"});
+        }
         node.serving = false
         node.log("ssh process stopped (exit: " + code + " / " + signal + ")");
       });
@@ -53,7 +59,7 @@ module.exports = function(RED) {
       });
 
       node.on('close', function() {
-        node.status({fill:"red",shape:"dot",text:"remote-access.status.stopping"});
+        setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.stopping"});
         node.log("stopping ssh process");
         sshprocess.kill();
       });
@@ -74,6 +80,14 @@ module.exports = function(RED) {
     }
   }
 
+  function setStatus(node, options) {
+    // Set the status, remember text
+    if ( options !== undefined && options.text !== undefined ) {
+      statustext = options.text
+    }
+    node.status(options);
+  }
+
   function requestInstanceSlot(node) {
     // Call API to retrive server and port.
     const axiosInstance = commons.createAxiosInstance();
@@ -95,7 +109,7 @@ module.exports = function(RED) {
       if ( error.response && error.response.data && error.response.data.message ) {
         node.error(`${error.response.data.message}`);
       }
-      node.status({fill:"red",shape:"dot",text:"remote-access.status.commerror"});
+      setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.commerror"});
       return;
     });
   }
@@ -139,6 +153,8 @@ module.exports = function(RED) {
         'instancehash': node.confignode.instancehash,
         'instanceauth': node.confignode.instanceauth,
         'version': commons.getNodeVersion()
+      }, {
+        'timeout': 60*1000
       })
       .then(response => {
         // Remember the status
@@ -150,17 +166,18 @@ module.exports = function(RED) {
         // If the communication is not ok...
         if ( node.lastHeartbeatStatus === 'NOTFOUND' ) {
           // The local endpoint responed a 404...
-          node.status({fill:"yellow",shape:"dot",text:"remote-access.status.heartbeaterrornotfound"});
+          setStatus(node, {fill:"yellow",shape:"dot",text:"remote-access.status.heartbeaterrornotfound"});
           node.log(`Heartbeat detected no valid endpoint, got a 404 response. Please check the base URL in the connection settings.`);
         } else if ( node.lastHeartbeatStatus !== 'OK' ) {
           if ( node.initialHeartbeatStatus === 'OK' ) {
             // If the status before was ok > Restart communication
-            node.status({fill:"red",shape:"dot",text:"remote-access.status.heartbeaterror"});
+            setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.heartbeaterror"});
+            sshprocess.kill();
             node.serving = false
             node.log(`Heartbeat error. Reconnecting soon.`);
           } else {
             // If the status before had also an error > Just change the label.
-            node.status({fill:"yellow",shape:"dot",text:"remote-access.status.heartbeaterroractive"});
+            setStatus(node, {fill:"yellow",shape:"dot",text:"remote-access.status.heartbeaterroractive"});
             node.log(`Heartbeat detected no valid endpoint. Please check your connection settings (Base URL, Serving Port and Protocol).`);
           }
         }
@@ -183,7 +200,7 @@ module.exports = function(RED) {
     node.errorcounter = 0;
 
     // Status
-    node.status({fill:"orange",shape:"dot",text:"remote-access.status.starting"});
+    setStatus(node, {fill:"orange",shape:"dot",text:"remote-access.status.starting"});
 
     // Retrieve the config node
     node.confignode = RED.nodes.getNode(config.confignode);
@@ -191,17 +208,17 @@ module.exports = function(RED) {
       node.log("Server: " + node.confignode.server + " InstanceHash: " + node.confignode.instancehash );
     } else {
       node.log("No configuration found.");
-      node.status({fill:"red",shape:"dot",text:"remote-access.status.noconfig"});
+      setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.noconfig"});
       return;
     }
     if ( node.confignode.instancehash === undefined || node.confignode.instancehash === '' ) {
       node.log("Configuration incomplete.");
-      node.status({fill:"red",shape:"dot",text:"remote-access.status.incompleteconfig"});
+      setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.incompleteconfig"});
       return;
     }
     if ( node.confignode.instancehash !== undefined && node.confignode.instanceauth === undefined ) {
       node.log("Configuration has no instanceauth. Maybe restored backup!");
-      node.status({fill:"red",shape:"dot",text:"remote-access.status.backupconfig"});
+      setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.backupconfig"});
       return;
     }
 
@@ -214,8 +231,8 @@ module.exports = function(RED) {
     tryConnect(node);
 
     // Post URL for action
-    const postUrl = `/contrib-remote/action/${node.confignode.instancehash}`;
-    RED.httpNode.post(postUrl, function(req,res) {
+    const postUrlAction = `/contrib-remote/action/${node.confignode.instancehash}`;
+    RED.httpNode.post(postUrlAction, function(req,res) {
       // Output action as new message
       node.log(`Action '${req.body.action}' received value '${req.body.value}'`);
       const msg = {
@@ -225,7 +242,28 @@ module.exports = function(RED) {
             "value": req.body.value
           }
       }
-      node.send(msg);
+      node.send([msg, null]);
+
+      // Send OK to app
+      const responseData = {
+        'status': 'OK'
+      };
+      res.json(responseData);
+    });
+
+    // Post URL for geofence
+    const postUrlGeofence = `/contrib-remote/geofence/${node.confignode.instancehash}`;
+    RED.httpNode.post(postUrlGeofence, function(req,res) {
+      // Output action as new message
+      node.log(`Geofence '${req.body.name}' received enter value '${req.body.enter}'`);
+      const msg = {
+          "_msgid": RED.util.generateId(),
+          "payload": {
+            "name": req.body.name,
+            "enter": req.body.enter
+          }
+      }
+      node.send([null, msg]);
 
       // Send OK to app
       const responseData = {
@@ -254,7 +292,20 @@ module.exports = function(RED) {
 
       // Remove old routes, without a new deploy would break it..
       RED.httpNode._router.stack.forEach(function(route,i,routes) {
-        if (route.route && (route.route.path === postUrl || route.route.path === getUrl)) {
+        if (route.route && route.route.path === postUrlAction) {
+          node.log(` -> Remove Route '${route.route.path}'`);
+          routes.splice(i,1);
+        }
+      });
+      RED.httpNode._router.stack.forEach(function(route,i,routes) {
+        if (route.route && route.route.path === postUrlGeofence) {
+          node.log(` -> Remove Route '${route.route.path}'`);
+          routes.splice(i,1);
+        }
+      });
+      RED.httpNode._router.stack.forEach(function(route,i,routes) {
+        if (route.route && route.route.path === getUrl) {
+          node.log(` -> Remove Route '${route.route.path}'`);
           routes.splice(i,1);
         }
       });

package/nodes/remote-commons.js

@@ -2,11 +2,13 @@ const https = require('https')
 const axios = require('axios')
 const fs = require('fs');
 const crypto = require('crypto');
+const path = require('path');
 
 module.exports = {
   createAxiosInstance: function() {
+    var filepath = path.join(__dirname, 'resources', 'ca.cer');
     const httpsAgent = new https.Agent({
-      ca: fs.readFileSync(__dirname + '/resources/ca.cer'),
+      ca: fs.readFileSync(filepath),
       checkServerIdentity: function(host, cert) {
         const pubkeyPinned = 'YHGEo54+LKxdpCuSAFt+Zwx/RVSHER96vM/Rh0/zcQ4=';
         const pubkeyServer = crypto.createHash('sha256').update(cert.pubkey).digest('base64');
@@ -19,7 +21,20 @@ module.exports = {
   },
 
   getNodeVersion: function() {
-    var pjson = require(__dirname.replace('/nodes', '') + '/package.json');
+    var filepath = path.join(__dirname, '..', 'package.json');
+    var pjson = require(filepath);
     return pjson.version;
+  },
+
+  evaluateValue: function(RED, value, type, node, msg) {
+    // Evaluates the value
+    let evalValue = ''
+    try {
+      evalValue = RED.util.evaluateNodeProperty(value, type, node, msg);
+    } catch (e) {
+      node.error(`Error evaluating value: ${e}`)
+    }
+    return evalValue;
   }
+
 }

package/nodes/remote-config.html

@@ -130,6 +130,7 @@
       if ( data.error == undefined ) {
         // Show QR Code
         document.getElementById('registerRemoteAppQRCode').src = data.qrcode;
+        document.getElementById('appLink').setAttribute('href', data.link);
         document.getElementById('registerRemoteAppQRCodeContainer').style.removeProperty('visibility');
         document.getElementById('registerRemoteAppQRCodeContainer').style.removeProperty('height');
         document.getElementById('registerRemoteAppButtonText').innerHTML = document.getElementById('registerRemoteAppButton_next_text').innerHTML;
@@ -243,6 +244,11 @@
       <label data-i18n="remote-config.apphelp.title" style="font-weight: bold;"></label>
       <label data-i18n="remote-config.apphelp.para1"></label>
     </div>
+    <div style="max-width: 460px; border-width: 1px; border-style: dashed; border-color: #666; padding: 10px; margin-top: 6px; margin-bottom: 20px;">
+      <label data-i18n="remote-config.applink.title" style="font-weight: bold;"></label>
+      <label data-i18n="remote-config.applink.para1"></label>
+      <a id="appLink" href="" target="_blank"><i><label data-i18n="remote-config.applink.link" style="display: inline; color: #AD1626;"></label></i></a>
+    </div>
   </div>
 
   <div id="remoteInstanceInputs" style="max-height: 0px;">

package/nodes/remote-config.js

@@ -82,9 +82,11 @@ module.exports = function(RED) {
       const qrCodeString = JSON.stringify(qrCodeData);
       const qrCodeStringBuffer = Buffer.from(qrCodeString);
       const qrCodeStringBase64 = qrCodeStringBuffer.toString('base64');
+      const link = 'remotered://add?data=' + qrCodeStringBase64;
       QRCode.toDataURL(qrCodeStringBase64, function (err, url) {
         const responseData = {
-          'qrcode': url
+          'qrcode': url,
+          'link': link
         }
         res.json(responseData);
       });

package/nodes/remote-notification.js

@@ -18,11 +18,17 @@ module.exports = function(RED) {
     // Act on incomming messages
     node.on('input', function(msg) {
       if (node.confignode != undefined) {
+        if (msg.payload.send === false) {
+          node.log(`Notification not send (msg.payload.send = false).`)
+          return;
+        }
         node.limiter.removeTokens(1, function(err, remainingRequests) {
           if (remainingRequests >= 0) {
-            const title = RED.util.evaluateNodeProperty(config.notificationTitle, config.notificationTitleType, node, msg);
-            const body = RED.util.evaluateNodeProperty(config.notificationBody, config.notificationBodyType, node, msg);
-            const notificationEmpty = ((title == undefined || title == '') && (body == undefined || body == ''));
+            let title = commons.evaluateValue(RED, config.notificationTitle, config.notificationTitleType, node, msg);
+            let body = commons.evaluateValue(RED, config.notificationBody, config.notificationBodyType, node, msg);
+            if (title == undefined) title = '';
+            if (body == undefined) body = '';
+            const notificationEmpty = (title == '' && body == '');
             if (!notificationEmpty) {
               // Title and/or body are filled
 
@@ -34,7 +40,7 @@ module.exports = function(RED) {
                 // Sound configured or computed?
                 let sound = config.notificationSound
                 if (sound === 'computed') {
-                  sound = RED.util.evaluateNodeProperty(config.notificationSoundComputed, config.notificationSoundComputedType, node, msg);
+                  sound = commons.evaluateValue(RED, config.notificationSoundComputed, config.notificationSoundComputedType, node, msg);
                 }
 
                 // Call API to send notification

package/nodes/remote-question.js

@@ -18,11 +18,17 @@ module.exports = function(RED) {
     // Act on incomming messages
     node.on('input', function(msg) {
       if (node.confignode != undefined) {
+        if (msg.payload.send === false) {
+          node.log(`Question not send (msg.payload.send = false).`)
+          return;
+        }
         node.limiter.removeTokens(1, function(err, remainingRequests) {
           if (remainingRequests >= 0) {
-            const title = RED.util.evaluateNodeProperty(config.questionTitle, config.questionTitleType, node, msg);
-            const body = RED.util.evaluateNodeProperty(config.questionBody, config.questionBodyType, node, msg);
-            const notificationEmpty = ((title == undefined || title == '') && (body == undefined || body == ''));
+            let title = commons.evaluateValue(RED, config.questionTitle, config.questionTitleType, node, msg);
+            let body = commons.evaluateValue(RED, config.questionBody, config.questionBodyType, node, msg);
+            if (title == undefined) title = '';
+            if (body == undefined) body = '';
+            const notificationEmpty = (title == '' && body == '');
             if (!notificationEmpty) {
               // Title and/or body are filled, generate question data
               let questionData = {
@@ -31,16 +37,16 @@ module.exports = function(RED) {
                 "questiontype" : 1,
                 "answers": [
                   {
-                    "text": RED.util.evaluateNodeProperty(config.questionAnswerOne, config.questionAnswerOneType, node, msg),
-                    "value": RED.util.evaluateNodeProperty(config.questionAnswerOneValue, config.questionAnswerOneValueType, node, msg)
+                    "text": commons.evaluateValue(RED, config.questionAnswerOne, config.questionAnswerOneType, node, msg),
+                    "value": commons.evaluateValue(RED, config.questionAnswerOneValue, config.questionAnswerOneValueType, node, msg)
                   },
                   {
-                    "text": RED.util.evaluateNodeProperty(config.questionAnswerTwo, config.questionAnswerTwoType, node, msg),
-                    "value": RED.util.evaluateNodeProperty(config.questionAnswerTwoValue, config.questionAnswerTwoValueType, node, msg)
+                    "text": commons.evaluateValue(RED, config.questionAnswerTwo, config.questionAnswerTwoType, node, msg),
+                    "value": commons.evaluateValue(RED, config.questionAnswerTwoValue, config.questionAnswerTwoValueType, node, msg)
                   },
                   {
-                    "text": RED.util.evaluateNodeProperty(config.questionAnswerThree, config.questionAnswerThreeType, node, msg),
-                    "value": RED.util.evaluateNodeProperty(config.questionAnswerThreeValue, config.questionAnswerThreeValueType, node, msg)
+                    "text": commons.evaluateValue(RED, config.questionAnswerThree, config.questionAnswerThreeType, node, msg),
+                    "value": commons.evaluateValue(RED, config.questionAnswerThreeValue, config.questionAnswerThreeValueType, node, msg)
                   }
                 ]
               };
@@ -53,7 +59,7 @@ module.exports = function(RED) {
                 // Sound configured or computed?
                 let sound = config.questionSound
                 if (sound === 'computed') {
-                  sound = RED.util.evaluateNodeProperty(config.questionSoundComputed, config.questionSoundComputedType, node, msg);
+                  sound = commons.evaluateValue(RED, config.questionSoundComputed, config.questionSoundComputedType, node, msg);
                 }
 
                 // Call API to send notification

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-remote",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Remote services for Node-RED including remote access, push notifications and questions through push notifications.",
   "author": "Thorsten Heilmann",
   "license": "GPL-3.0",
@@ -16,6 +16,7 @@
     "axios": "^0.21.0",
     "internal-ip": "^6.1.0",
     "limiter": "^1.1.5",
+    "path": "^0.12.7",
     "qrcode": "^1.4.4"
   },
   "main": "remote-config.js",