node-red-contrib-remote 1.3.3 → 1.5.0

package/README.md

@@ -1,6 +1,6 @@
 # Remote-RED
 
-Remote-RED is an ecosystem to bring remote access and push notifications to Node-RED. It consists of several parts:
+Remote-RED is an ecosystem to bring remote access, push notification and geofencing to Node-RED. There are also additional functions like directly answer on a notification and homescreen widgets. It consists of several parts:
 - node-red-contrib-remote: The Node-RED nodes of Remote-RED. Published in this repro.
 - Remote-RED servers: Several servers used for proxying the remote access traffic and sending push notifications.
 - Remote-RED apps: Apps to access the services published by the Remote-RED remote-access node and receiving the push notifications of the remote-notification node. Available or Android, iOS and iPadOS.
@@ -36,6 +36,18 @@ You will find more information on [www.remote-red-com](https://www.remote-red.co
 
 ## Version History
 
+Version 1.5.0
+- Geofencing! You can add geofences in the apps. Entering and leaving them will trigger a message on the new output of the remote access node.
+- Adding server location in Asia.
+- New instances will have the base url '/ui' again.
+- Error with "Multiple requests" after a missing internet connection fixed.
+- iOS App: Links with target '_blank' will be redirected to iOS.
+
+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.
 

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

@@ -17,7 +17,8 @@
           "commerror": "Fehler bei der Kommunikation mit dem Server.",
           "noconfig": "Keine Konfiguration gefunden.",
           "incompleteconfig": "Konfiguration unvollständig.",
-          "backupconfig": "Konfiguration aus Backup."
+          "backupconfig": "Konfiguration aus Backup.",
+          "banned": "Die Instanz wurde deaktiviert. Möglicherweise aufgrund einer DDOS-Attacke. Wenn Sie dieses System nicht missbrauchen, erstelle bitte eine neuen Konfig Node, um Remote-RED wieder zu verwenden. Andernfalls suchen Sie nach falschen Weiterleitungen oder Proxy Fehlern. Diese IP wird für 10 Minuten gesperrt."
         },
         "help": {
           "title": "Hilfe",

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

@@ -12,6 +12,7 @@
           "region": "Standort Server",
           "region_us": "Amerika (USA)",
           "region_de": "Europa (Deutschland)",
+          "region_sg": "Asien (Singapur)",
           "region_dev": "Entwicklung",
           "region_desc": "Der Standort kann nicht mehr geändert werden, sobald eine App registriert wurde.",
           "change_info": "Wenn Du Einstellungen änderst, musst Du die App neu verbinden.",
@@ -46,6 +47,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-access.json

@@ -17,7 +17,8 @@
           "commerror": "Error communicating with server.",
           "noconfig": "No configuration found.",
           "incompleteconfig": "Configuration incomplete.",
-          "backupconfig": "Configuration from backup."
+          "backupconfig": "Configuration from backup.",
+          "banned": "Instance is deactivated. Maybe due DDOS attacks. If you are not missusing this system, please create new config node to use Remote-RED again. Otherwise look for incorrect redirects or such errors. Banning IP for 10 minutes."
         },
         "help": {
           "title": "Help",

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

@@ -12,6 +12,7 @@
           "region": "Server location",
           "region_us": "America (USA)",
           "region_de": "Europe (Germany)",
+          "region_sg": "Asia (Singapur)",
           "region_dev": "Development host",
           "region_desc": "The region can´t be changed after registering an app.",
           "change_info": "If you change settings, you need to reconnect the app.",
@@ -46,6 +47,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

@@ -8,8 +8,8 @@
       verbose: {value:0}
     },
     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

@@ -4,6 +4,7 @@ module.exports = function(RED) {
   const os = require("os");
   let sshprocess = undefined
   let statustext = ''
+  let instanceIsBanned = false
 
   function startSSH(node, server, port) {
     try {
@@ -18,7 +19,7 @@ module.exports = function(RED) {
       if ( host === 'localhost' && os.platform() === 'win32' ) {
         host = '127.0.0.1'
       }
-      //node.log('ssh -o StrictHostKeyChecking=no -R ' + port.toString() + ':' + host + ':' + node.confignode.port.toString() + ' forward@proxy-' + server + ' -N');
+      // node.log('ssh -o StrictHostKeyChecking=no -R ' + port.toString() + ':' + host + ':' + node.confignode.port.toString() + ' forward@proxy-' + server + ' -N');
       var sshparameters = ['-o StrictHostKeyChecking=no', '-R', port.toString() + ':' + host + ':' + node.confignode.port.toString(), 'forward@proxy-' + server, '-N'];
       if ( node.verbose ) {
         sshparameters.push('-v');
@@ -36,6 +37,9 @@ module.exports = function(RED) {
 
       sshprocess.stderr.on('data', (data) => {
         logSSHBuffer(node, data, 'ssh process stderr');
+        if ( data.toString().includes('Connection timed out')) {
+          node.error(`SSH connection timeout. Please check if port 22 is open for outgoing connections.`);
+        }
       });
 
       sshprocess.on('close', (code, signal) => {
@@ -89,6 +93,11 @@ module.exports = function(RED) {
   }
 
   function requestInstanceSlot(node) {
+    // Is this instance banned?
+    if ( instanceIsBanned ) {
+      return;
+    }
+
     // Call API to retrive server and port.
     const axiosInstance = commons.createAxiosInstance();
     axiosInstance.post(`https://api-${node.confignode.server}/instanceSlotRequest`, {
@@ -105,10 +114,22 @@ module.exports = function(RED) {
       startSSH(node, node.confignode.server, port);
     })
     .catch((error) => {
-      node.error('requestInstanceSlot: ' + error);
-      if ( error.response && error.response.data && error.response.data.message ) {
-        node.error(`${error.response.data.message}`);
+      // Log error
+      node.error('requestInstanceSlot: ' + commons.getNetworkErrorString(error))
+      if ( commons.getNetworkErrorCustomString(error) !== undefined) {
+        node.error(commons.getNetworkErrorCustomString(error));
       }
+
+      // Wenn gebannt -> Merken
+      if ( error.response && error.response.status ) {
+        if ( error.response.status === 403 ) {
+          setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.banned"});
+          instanceIsBanned = true;
+          return;
+        }
+      }
+
+      // Set status
       setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.commerror"});
       return;
     });
@@ -183,10 +204,10 @@ module.exports = function(RED) {
         }
       })
       .catch((error) => {
-        // Error on api call > Just log
-        node.error('heartbeat: ' + error);
-        if ( error.response && error.response.data && error.response.data.message ) {
-          node.error(`${error.response.data.message}`);
+        // Error on api call > Log error
+        node.error('heartbeat: ' + commons.getNetworkErrorString(error))
+        if ( commons.getNetworkErrorCustomString(error) !== undefined) {
+          node.error(commons.getNetworkErrorCustomString(error));
         }
       });
     }
@@ -231,8 +252,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 = {
@@ -242,7 +263,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 = {
@@ -271,7 +313,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

@@ -17,7 +17,7 @@ module.exports = {
         }
       }
     });
-    return axios.create({ httpsAgent: httpsAgent });
+    return axios.create({ httpsAgent: httpsAgent, timeout: 5000 });
   },
 
   getNodeVersion: function() {
@@ -35,6 +35,27 @@ module.exports = {
       node.error(`Error evaluating value: ${e}`)
     }
     return evalValue;
+  },
+
+  getNetworkErrorString: function(error) {
+    // Trys to get a error message
+    let errorString = `` + error;
+    if ( error.response && error.response.data && error.response.data.message ) {
+      errorString = `${error.response.data.message}`;
+    }
+    return errorString;
+  },
+
+  getNetworkErrorCustomString: function(error) {
+    // Custom error messages for common errors
+    let errorString = undefined;
+    if ( error.code === 'ECONNABORTED' ) {
+      errorString = `Error during https call. Please check Internet connection on your Node-RED server. Please check if a firewall blocks outgoing port 443.`;
+    }
+    if ( error.code === 'EAI_AGAIN' ) {
+      errorString = `Error during DNS queries. Please check Internet connection on your Node-RED server. Please check if a firewall blocks your DNS queries.`;
+    }
+    return errorString;
   }
 
 }

package/nodes/remote-config.html

@@ -103,6 +103,9 @@
       } else {
         // Show error
         alert('Error while registering instance: ' + data.error);
+
+        // Enable button again
+        document.getElementById('registerRemoteAppButton').disabled = false;
       }
     });
   }
@@ -130,6 +133,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;
@@ -213,6 +217,7 @@
     <select id="node-config-input-region">
         <option value="us" data-i18n="remote-config.label.region_us"></option>
         <option value="de" data-i18n="remote-config.label.region_de"></option>
+        <option value="sg" data-i18n="remote-config.label.region_sg"></option>
         <!-- <option value="dev" data-i18n="remote-config.label.region_dev"></option> -->
     </select>
   </div>
@@ -243,6 +248,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

@@ -27,7 +27,7 @@ module.exports = function(RED) {
     // Return the internal IP and the mountpath
     const ipData = {
       'ipv4': internalIp.v4.sync(),
-      'baseurl': RED.httpNode.mountpath + ((RED.settings.ui !== undefined && RED.settings.ui.path !== undefined) ? RED.settings.ui.path : ''),
+      'baseurl': RED.httpNode.mountpath + ((RED.settings.ui !== undefined && RED.settings.ui.path !== undefined) ? RED.settings.ui.path : 'ui'),
       'port': (RED.settings.uiPort !== undefined) ? String(RED.settings.uiPort) : '1880'
     }
     console.log(`${JSON.stringify(ipData)}`);
@@ -48,6 +48,9 @@ module.exports = function(RED) {
       if ( error.response && error.response.data && error.response.data.message ) {
         errorMessage = errorMessage + " / " + error.response.data.message;
       }
+      if ( commons.getNetworkErrorCustomString(error) !== undefined) {
+        errorMessage = commons.getNetworkErrorCustomString(error);
+      }
       res.json({ 'error': errorMessage });
     });
   });
@@ -82,9 +85,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);
       });
@@ -95,6 +100,9 @@ module.exports = function(RED) {
       if ( error.response && error.response.data && error.response.data.message ) {
         errorMessage = errorMessage + " / " + error.response.data.message;
       }
+      if ( commons.getNetworkErrorCustomString(error) !== undefined) {
+        errorMessage = commons.getNetworkErrorCustomString(error);
+      }
       res.json({ 'error': errorMessage });
     });
   });

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 !== undefined && 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 = commons.evaluateValue(RED, config.notificationTitle, config.notificationTitleType, node, msg);
-            const body = commons.evaluateValue(RED, 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
 
@@ -57,7 +63,11 @@ module.exports = function(RED) {
                   }
                 })
                 .catch((error) => {
-                  node.error("ERROR: " + error);
+                  // Log error
+                  node.error('sendNotification: ' + commons.getNetworkErrorString(error))
+                  if ( commons.getNetworkErrorCustomString(error) !== undefined) {
+                    node.error(commons.getNetworkErrorCustomString(error));
+                  }
 
                   // Output status if configured so
                   if ( config.output == 2 ) {

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 !== undefined && 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 = commons.evaluateValue(RED, config.questionTitle, config.questionTitleType, node, msg);
-            const body = commons.evaluateValue(RED, 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 = {
@@ -71,7 +77,11 @@ module.exports = function(RED) {
                   node.debug(`Question send successfull`)
                 })
                 .catch((error) => {
-                  node.error("ERROR: " + error);
+                  // Log error
+                  node.error('sendNotification: ' + commons.getNetworkErrorString(error))
+                  if ( commons.getNetworkErrorCustomString(error) !== undefined) {
+                    node.error(commons.getNetworkErrorCustomString(error));
+                  }
 
                   // Output Error
                   const msg = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-red-contrib-remote",
-  "version": "1.3.3",
-  "description": "Remote services for Node-RED including remote access, push notifications and questions through push notifications.",
+  "version": "1.5.0",
+  "description": "Remote-RED is an ecosystem to bring remote access, push notification and geofencing to Node-RED. There are also additional functions like directly answer on a notification and homescreen widgets.",
   "author": "Thorsten Heilmann",
   "license": "GPL-3.0",
   "node-red": {