@node-red/nodes 2.2.2 → 3.0.0-beta.3

package/core/network/10-mqtt.js

@@ -20,7 +20,30 @@ module.exports = function(RED) {
     var isUtf8 = require('is-utf8');
     var HttpsProxyAgent = require('https-proxy-agent');
     var url = require('url');
-
+    const knownMediaTypes = {
+        "text/css":"string",
+        "text/html":"string",
+        "text/plain":"string",
+        "text/html":"string",
+        "application/json":"json",
+        "application/octet-stream":"buffer",
+        "application/pdf":"buffer",
+        "application/x-gtar":"buffer",
+        "application/x-gzip":"buffer",
+        "application/x-tar":"buffer",
+        "application/xml":"string",
+        "application/zip":"buffer",
+        "audio/aac":"buffer",
+        "audio/ac3":"buffer",
+        "audio/basic":"buffer",
+        "audio/mp4":"buffer",
+        "audio/ogg":"buffer",
+        "image/bmp":"buffer",
+        "image/gif":"buffer",
+        "image/jpeg":"buffer",
+        "image/tiff":"buffer",
+        "image/png":"buffer",
+    }
     //#region "Supporting functions"
     function matchTopic(ts,t) {
         if (ts == "#") {
@@ -68,12 +91,21 @@ module.exports = function(RED) {
     }
 
     /**
-     * Test a topic string is valid
+     * Test a topic string is valid for subscription
      * @param {string} topic
      * @returns `true` if it is a valid topic
      */
     function isValidSubscriptionTopic(topic) {
-        return /^(#$|(\+|[^+#]*)(\/(\+|[^+#]*))*(\/(\+|#|[^+#]*))?$)/.test(topic)
+        return /^(#$|(\+|[^+#]*)(\/(\+|[^+#]*))*(\/(\+|#|[^+#]*))?$)/.test(topic);
+    }
+
+    /**
+     * Test a topic string is valid for publishing
+     * @param {string} topic
+     * @returns `true` if it is a valid topic
+     */
+    function isValidPublishTopic(topic) {
+        return !/[\+#\b\f\n\r\t\v\0]/.test(topic);
     }
 
     /**
@@ -103,7 +135,7 @@ module.exports = function(RED) {
             if(src[propName] === "true" || src[propName] === true) {
                 dst[propName] = true;
             } else if(src[propName] === "false" || src[propName] === false) {
-                dst[propName] = true;
+                dst[propName] = false;
             }
         } else {
             if(def != undefined) dst[propName] = def;
@@ -188,6 +220,19 @@ module.exports = function(RED) {
      */
     function subscriptionHandler(node, datatype ,topic, payload, packet) {
         const v5 = node.brokerConn.options && node.brokerConn.options.protocolVersion == 5;
+        var msg = {topic:topic, payload:null, qos:packet.qos, retain:packet.retain};
+        if(v5 && packet.properties) {
+            setStrProp(packet.properties, msg, "responseTopic");
+            setBufferProp(packet.properties, msg, "correlationData");
+            setStrProp(packet.properties, msg, "contentType");
+            setIntProp(packet.properties, msg, "messageExpiryInterval", 0);
+            setBoolProp(packet.properties, msg, "payloadFormatIndicator");
+            setStrProp(packet.properties, msg, "reasonString");
+            setUserProperties(packet.properties.userProperties, msg);
+        }
+        const v5isUtf8 = v5 ? msg.payloadFormatIndicator === true : null;
+        const v5HasMediaType = v5 ? !!msg.contentType : null;
+        const v5MediaTypeLC = v5 ? (msg.contentType + "").toLowerCase() : null;
 
         if (datatype === "buffer") {
             // payload = payload;
@@ -196,25 +241,65 @@ module.exports = function(RED) {
         } else if (datatype === "utf8") {
             payload = payload.toString('utf8');
         } else if (datatype === "json") {
-            if (isUtf8(payload)) {
-                payload = payload.toString();
-                try { payload = JSON.parse(payload); }
-                catch(e) { node.error(RED._("mqtt.errors.invalid-json-parse"),{payload:payload, topic:topic, qos:packet.qos, retain:packet.retain}); return; }
+            if (v5isUtf8 || isUtf8(payload)) {
+                try {
+                    payload = JSON.parse(payload.toString());
+                } catch (e) {
+                    node.error(RED._("mqtt.errors.invalid-json-parse"), { payload: payload, topic: topic, qos: packet.qos, retain: packet.retain }); return;
+                }
+            } else {
+                node.error((RED._("mqtt.errors.invalid-json-string")), { payload: payload, topic: topic, qos: packet.qos, retain: packet.retain }); return;
             }
-            else { node.error((RED._("mqtt.errors.invalid-json-string")),{payload:payload, topic:topic, qos:packet.qos, retain:packet.retain}); return; }
         } else {
-            if (isUtf8(payload)) { payload = payload.toString(); }
-        }
-        var msg = {topic:topic, payload:payload, qos:packet.qos, retain:packet.retain};
-        if(v5 && packet.properties) {
-            setStrProp(packet.properties, msg, "responseTopic");
-            setBufferProp(packet.properties, msg, "correlationData");
-            setStrProp(packet.properties, msg, "contentType");
-            setIntProp(packet.properties, msg, "messageExpiryInterval", 0);
-            setBoolProp(packet.properties, msg, "payloadFormatIndicator");
-            setStrProp(packet.properties, msg, "reasonString");
-            setUserProperties(packet.properties.userProperties, msg);
+            //"auto" (legacy) or "auto-detect" (new default)
+            if (v5isUtf8 || v5HasMediaType) {
+                const outputType = knownMediaTypes[v5MediaTypeLC]
+                switch (outputType) {
+                    case "string":
+                        payload = payload.toString();
+                        break;
+                    case "buffer":
+                        //no change
+                        break;
+                    case "json":
+                        try {
+                            //since v5 type states this should be JSON, parse it & error out if NOT JSON
+                            payload = payload.toString()
+                            const obj = JSON.parse(payload);
+                            if (datatype === "auto-detect") {
+                                payload = obj; //as mode is "auto-detect", return the parsed JSON
+                            }
+                        } catch (e) {
+                            node.error(RED._("mqtt.errors.invalid-json-parse"), { payload: payload, topic: topic, qos: packet.qos, retain: packet.retain }); return;
+                        }
+                        break;
+                    default:
+                        if (v5isUtf8 || isUtf8(payload)) {
+                            payload = payload.toString(); //auto String
+                            if (datatype === "auto-detect") {
+                                try {
+                                    payload = JSON.parse(payload); //auto to parsed object (attempt)
+                                } catch (e) {
+                                    /* mute error - it simply isnt JSON, just leave payload as a string */
+                                }
+                            }
+                        }
+                        break;
+                }
+            } else if (isUtf8(payload)) {
+                payload = payload.toString(); //auto String
+                if (datatype === "auto-detect") {
+                    try {
+                        payload = JSON.parse(payload);
+                    } catch (e) {
+                        /* mute error - it simply isnt JSON, just leave payload as a string */
+                    }
+                }
+            } //else { 
+                //leave as buffer
+            //}
         }
+        msg.payload = payload;
         if ((node.brokerConn.broker === "localhost")||(node.brokerConn.broker === "127.0.0.1")) {
             msg._topic = topic;
         }
@@ -264,38 +349,15 @@ module.exports = function(RED) {
                     msg.messageExpiryInterval = node.messageExpiryInterval;
                 }
             }
-            if (msg.userProperties && typeof msg.userProperties !== "object") {
-                delete msg.userProperties;
-            }
-            if (hasProperty(msg, "topicAlias") && !isNaN(msg.topicAlias) && (msg.topicAlias === 0 || bsp.topicAliasMaximum === 0 || msg.topicAlias > bsp.topicAliasMaximum)) {
-                delete msg.topicAlias;
-            }
-
             if (hasProperty(msg, "payload")) {
-
-                //check & sanitise topic
-                let topicOK = hasProperty(msg, "topic") && (typeof msg.topic === "string") && (msg.topic !== "");
-
-                if (!topicOK && v5) {
-                    //NOTE: A value of 0 (in server props topicAliasMaximum) indicates that the Server does not accept any Topic Aliases on this connection
-                    if (hasProperty(msg, "topicAlias") && !isNaN(msg.topicAlias) && msg.topicAlias >= 0 && bsp.topicAliasMaximum && bsp.topicAliasMaximum >= msg.topicAlias) {
-                        topicOK = true;
-                        msg.topic = ""; //must be empty string
-                    } else if (hasProperty(msg, "responseTopic") && (typeof msg.responseTopic === "string") && (msg.responseTopic !== "")) {
-                        //TODO: if topic is empty but responseTopic has a string value, use that instead. Is this desirable?
-                        topicOK = true;
-                        msg.topic = msg.responseTopic;
-                        //TODO: delete msg.responseTopic - to prevent it being resent?
+                // send the message
+                node.brokerConn.publish(msg, function(err) {
+                    if(err && err.warn) {
+                        node.warn(err);
+                        return;
                     }
-                }
-                topicOK = topicOK && !/[\+#\b\f\n\r\t\v\0]/.test(msg.topic);
-
-                if (topicOK) {
-                    node.brokerConn.publish(msg, done); // send the message
-                } else {
-                    node.warn(RED._("mqtt.errors.invalid-topic"));
-                    done();
-                }
+                    done(err);
+                }); 
             } else {
                 done();
             }
@@ -391,6 +453,7 @@ module.exports = function(RED) {
         node.options = {};
         node.queue = [];
         node.subscriptions = {};
+        node.clientListeners = []
         /** @type {mqtt.MqttClient}*/ this.client;
         node.setOptions = function(opts, init) {
             if(!opts || typeof opts !== "object") {
@@ -415,8 +478,12 @@ module.exports = function(RED) {
             setIfHasProperty(opts, node, "topicAliasMaximum", init);
             setIfHasProperty(opts, node, "maximumPacketSize", init);
             setIfHasProperty(opts, node, "receiveMaximum", init);
-            setIfHasProperty(opts, node, "userProperties", init);//https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901116
-            setIfHasProperty(opts, node, "userPropertiesType", init);
+            //https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901116
+            if (hasProperty(opts, "userProperties")) {
+                node.userProperties = opts.userProperties;
+            } else if (hasProperty(opts, "userProps")) {
+                node.userProperties = opts.userProps;
+            }
 
             function createLWT(topic, payload, qos, retain, v5opts, v5SubPropName) {
                 let message = undefined;
@@ -465,7 +532,7 @@ module.exports = function(RED) {
                 };
                 if(hasProperty(opts, "willTopic")) {
                     //will v5 properties must be set in the "properties" sub object
-                    node.options.will = createLWT(opts.willTopic, opts.willPayload, opts.willQos, opts.willRetain, opts.willMsg, "properies");
+                    node.options.will = createLWT(opts.willTopic, opts.willPayload, opts.willQos, opts.willRetain, opts.willMsg, "properties");
                 };
             } else {
                 //update options
@@ -525,7 +592,7 @@ module.exports = function(RED) {
                     // Only for ws or wss, check if proxy env var for additional configuration
                     if (node.brokerurl.indexOf("wss://") > -1 || node.brokerurl.indexOf("ws://") > -1) {
                         // check if proxy is set in env
-                        let prox, noprox;
+                        let prox, noprox, noproxy;
                         if (process.env.http_proxy) { prox = process.env.http_proxy; }
                         if (process.env.HTTP_PROXY) { prox = process.env.HTTP_PROXY; }
                         if (process.env.no_proxy) { noprox = process.env.no_proxy.split(","); }
@@ -652,11 +719,16 @@ module.exports = function(RED) {
                 setStatusConnecting(node, true);
                 try {
                     node.serverProperties = {};
+                    if(node.client) {
+                        //belt and braces to avoid left over clients
+                        node.client.end(true);
+                        node._clientRemoveListeners();
+                    }
                     node.client = mqtt.connect(node.brokerurl, node.options);
                     node.client.setMaxListeners(0);
-                    let callbackDone = false; //prevent re-connects causing node.client.on('connect' firing callback multiple times
+                    let callbackDone = false; //prevent re-connects causing node._clientOn('connect' firing callback multiple times
                     // Register successful connect or reconnect handler
-                    node.client.on('connect', function (connack) {
+                    node._clientOn('connect', function (connack) {
                         node.closing = false;
                         node.connecting = false;
                         node.connected = true;
@@ -688,7 +760,7 @@ module.exports = function(RED) {
                         }
                         setStatusConnected(node, true);
                         // Remove any existing listeners before resubscribing to avoid duplicates in the event of a re-connection
-                        node.client.removeAllListeners('message');
+                        node._clientRemoveListeners('message');
 
                         // Re-subscribe to stored topics
                         for (var s in node.subscriptions) {
@@ -700,7 +772,7 @@ module.exports = function(RED) {
                                     if (node.subscriptions[s].hasOwnProperty(r)) {
                                         qos = Math.max(qos,node.subscriptions[s][r].qos);
                                         _options = node.subscriptions[s][r].options;
-                                        node.client.on('message',node.subscriptions[s][r].handler);
+                                        node._clientOn('message',node.subscriptions[s][r].handler);
                                     }
                                 }
                                 _options.qos = _options.qos || qos;
@@ -713,11 +785,11 @@ module.exports = function(RED) {
                             node.publish(node.birthMessage);
                         }
                     });
-                    node.client.on("reconnect", function() {
+                    node._clientOn("reconnect", function() {
                         setStatusConnecting(node, true);
                     });
                     //Broker Disconnect - V5 event
-                    node.client.on("disconnect", function(packet) {
+                    node._clientOn("disconnect", function(packet) {
                         //Emitted after receiving disconnect packet from broker. MQTT 5.0 feature.
                         const rc = (packet && packet.properties && packet.reasonCode) || packet.reasonCode;
                         const rs = packet && packet.properties && packet.properties.reasonString || "";
@@ -731,7 +803,7 @@ module.exports = function(RED) {
                         setStatusDisconnected(node, true);
                     });
                     // Register disconnect handlers
-                    node.client.on('close', function () {
+                    node._clientOn('close', function () {
                         if (node.connected) {
                             node.connected = false;
                             node.log(RED._("mqtt.state.disconnected",{broker:(node.clientid?node.clientid+"@":"")+node.brokerurl}));
@@ -743,39 +815,59 @@ module.exports = function(RED) {
 
                     // Register connect error handler
                     // The client's own reconnect logic will take care of errors
-                    node.client.on('error', function (error) {
+                    node._clientOn('error', function (error) {
                     });
                 }catch(err) {
                     console.log(err);
                 }
             }
         };
+
         node.disconnect = function (callback) {
-            const _callback = function (resetNodeConnectedState) {
-                setStatusDisconnected(node, true);
-                if(resetNodeConnectedState) {
-                    node.closing = true;
-                    node.connecting = false;
-                    node.connected = false;
+            const _callback = function () {
+                if(node.connected || node.connecting) {
+                    setStatusDisconnected(node, true);
                 }
+                if(node.client) { node._clientRemoveListeners(); }
+                node.connecting = false;
+                node.connected = false;
                 callback && typeof callback == "function" && callback();
             };
+            if(!node.client) { return _callback(); }
+            if(node.closing) { return _callback(); }
 
-            if(node.closing) {
-                return _callback(false);
-            }
-            var endCallBack = function endCallBack() {
-            }
+            let waitEnd = (client, ms) => {
+                return new Promise( (resolve, reject) => {
+                    node.closing = true;
+                    if(!client) { 
+                        resolve();
+                     } else {
+                        const t = setTimeout(() => {
+                            //clean end() has exceeded WAIT_END, lets force end!
+                            client && client.end(true);
+                            reject();
+                        }, ms);
+                        client.end(() => {
+                             clearTimeout(t);
+                             resolve()
+                         });
+                     }
+                });
+            };
             if(node.connected && node.closeMessage) {
                 node.publish(node.closeMessage, function (err) {
-                    node.client.end(endCallBack);
-                    _callback(true);
+                    waitEnd(node.client, 2000).then(() => {
+                        _callback();
+                    }).catch((e) => {
+                        _callback();
+                    })
                 });
-            } else if(node.connected) {
-                node.client.end(endCallBack);
-                _callback(true);
             } else {
-                _callback(false);
+                waitEnd(node.client, 2000).then(() => {
+                    _callback();
+                }).catch((e) => {
+                    _callback();
+                })
             }
         }
         node.subscriptionIds = {};
@@ -812,7 +904,7 @@ module.exports = function(RED) {
             };
             node.subscriptions[topic][ref] = sub;
             if (node.connected) {
-                node.client.on('message',sub.handler);
+                node._clientOn('message',sub.handler);
                 node.client.subscribe(topic, options);
             }
         };
@@ -823,7 +915,7 @@ module.exports = function(RED) {
             if (sub) {
                 if (sub[ref]) {
                     if(node.client) {
-                        node.client.removeListener('message',sub[ref].handler);
+                        node._clientRemoveListeners('message',sub[ref].handler);
                     }
                     delete sub[ref];
                 }
@@ -857,8 +949,18 @@ module.exports = function(RED) {
                     qos: msg.qos || 0,
                     retain: msg.retain || false
                 };
+                let topicOK = hasProperty(msg, "topic") && (typeof msg.topic === "string") && (isValidPublishTopic(msg.topic));
                 //https://github.com/mqttjs/MQTT.js/blob/master/README.md#mqttclientpublishtopic-message-options-callback
                 if(node.options.protocolVersion == 5) {
+                    const bsp = node.serverProperties || {};
+                    if (msg.userProperties && typeof msg.userProperties !== "object") {
+                        delete msg.userProperties;
+                    }
+                    if (hasProperty(msg, "topicAlias") && !isNaN(Number(msg.topicAlias))) {
+                        msg.topicAlias = parseInt(msg.topicAlias);
+                    } else {
+                        delete msg.topicAlias;
+                    }
                     options.properties = options.properties || {};
                     setStrProp(msg, options.properties, "responseTopic");
                     setBufferProp(msg, options.properties, "correlationData");
@@ -868,31 +970,75 @@ module.exports = function(RED) {
                     setIntProp(msg, options.properties, "topicAlias", 1, node.serverProperties.topicAliasMaximum || 0);
                     setBoolProp(msg, options.properties, "payloadFormatIndicator");
                     //FUTURE setIntProp(msg, options.properties, "subscriptionIdentifier", 1, 268435455);
-                    if (options.properties.topicAlias) {
-                        if (!node.topicAliases.hasOwnProperty(options.properties.topicAlias) && msg.topic == "") {
+
+                    //check & sanitise topic
+                    if (topicOK && options.properties.topicAlias) {
+                        let aliasValid = (bsp.topicAliasMaximum && bsp.topicAliasMaximum >= options.properties.topicAlias);
+                        if (!aliasValid) {
                             done("Invalid topicAlias");
                             return
                         }
                         if (node.topicAliases[options.properties.topicAlias] === msg.topic) {
-                            msg.topic = ""
+                            msg.topic = "";
                         } else {
-                            node.topicAliases[options.properties.topicAlias] = msg.topic
+                            node.topicAliases[options.properties.topicAlias] = msg.topic;
                         }
+                    } else if (!msg.topic && options.properties.responseTopic) {
+                        msg.topic = msg.responseTopic;
+                        topicOK = isValidPublishTopic(msg.topic);
+                        delete msg.responseTopic; //prevent responseTopic being resent?
                     }
                 }
 
-                node.client.publish(msg.topic, msg.payload, options, function(err) {
-                    done && done(err);
-                    return
-                });
+                if (topicOK) {
+                    node.client.publish(msg.topic, msg.payload, options, function(err) {
+                        done && done(err);
+                        return
+                    });
+                } else {
+                    const error = new Error(RED._("mqtt.errors.invalid-topic"));
+                    error.warn = true;
+                    done(error);
+                }
             }
         };
 
         node.on('close', function(done) {
-            node.closing = true;
-            node.disconnect(done);
+            node.disconnect(function() {
+                done();
+            });
         });
 
+        /**
+         * Add event handlers to the MQTT.js client and track them so that
+         * we do not remove any handlers that the MQTT client uses internally.  
+         * Use {@link node._clientRemoveListeners `node._clientRemoveListeners`} to remove handlers
+         * @param {string} event The name of the event
+         * @param {function} handler The handler for this event
+         */
+         node._clientOn = function(event, handler) {
+            node.clientListeners.push({event, handler})
+            node.client.on(event, handler)
+        } 
+
+        /**
+         * Remove event handlers from the MQTT.js client & only the events 
+         * that we attached in {@link node._clientOn `node._clientOn`}.  
+         * * If `event` is omitted, then all events matching `handler` are removed
+         * * If `handler` is omitted, then all events named `event` are removed
+         * * If both parameters are omitted, then all events are removed
+         * @param {string} [event] The name of the event (optional)
+         * @param {function} [handler] The handler for this event (optional)
+         */
+         node._clientRemoveListeners = function(event, handler) {
+            node.clientListeners = node.clientListeners.filter((l) => {
+                if (event && event !== l.event) { return true; }
+                if (handler && handler !== l.handler) { return true; }
+                node.client.removeListener(l.event, l.handler)
+                return false; //found and removed, filter out this one
+            })
+        }
+
     }
 
     RED.nodes.registerType("mqtt-broker",MQTTBrokerNode,{
@@ -1067,6 +1213,7 @@ module.exports = function(RED) {
                         node.brokerConn.unsubscribe(node.topic,node.id, removed);
                     }
                     node.brokerConn.deregister(node, done);
+                    node.brokerConn = null;
                 } else {
                     done();
                 }
@@ -1131,6 +1278,7 @@ module.exports = function(RED) {
             node.on('close', function(done) {
                 if (node.brokerConn) {
                     node.brokerConn.deregister(node,done);
+                    node.brokerConn = null;
                 } else {
                     done();
                 }

package/core/network/21-httpin.html

@@ -70,7 +70,8 @@
         color:"rgb(231, 231, 174)",
         defaults: {
             name: {value:""},
-            url: {value:"",required:true},
+            url: {value:"", required:true,
+                  label:RED._("node-red:httpin.label.url")},
             method: {value:"get",required:true},
             upload: {value:false},
             swaggerDoc: {type:"swagger-doc", required:false}
@@ -128,7 +129,7 @@
     var headerTypes = [
         {value:"content-type",label:"Content-Type",hasValue: false},
         {value:"location",label:"Location",hasValue: false},
-        {value:"other",label:RED._("node-red:httpin.label.other"),icon:"red/images/typedInput/az.png"}
+        {value:"other",label:RED._("node-red:httpin.label.other"),icon:"red/images/typedInput/az.svg"}
        ]
     var contentTypes = [
         {value:"application/json",label:"application/json",hasValue: false},
@@ -138,7 +139,7 @@
         {value:"text/plain",label:"text/plain",hasValue: false},
         {value:"image/gif",label:"image/gif",hasValue: false},
         {value:"image/png",label:"image/png",hasValue: false},
-        {value:"other",label:RED._("node-red:httpin.label.other"),icon:"red/images/typedInput/az.png"}
+        {value:"other",label:RED._("node-red:httpin.label.other"),icon:"red/images/typedInput/az.svg"}
     ];
 
     RED.nodes.registerType('http response',{
@@ -146,7 +147,10 @@
         color:"rgb(231, 231, 174)",
         defaults: {
             name: {value:""},
-            statusCode: {value:"",validate: RED.validators.number(true)},
+            statusCode: {
+                value:"",
+                label: RED._("node-red:httpin.label.status"),
+                validate: RED.validators.number(true)},
             headers: {value:{}}
         },
         inputs:1,
@@ -176,7 +180,7 @@
                     var propertyValue = $('<input/>',{class:"node-input-header-value",type:"text",style:"width: 100%"})
                         .appendTo(propertyValueCell)
                         .typedInput({types:
-                            header.h === 'content-type'?contentTypes:[{value:"other",label:"other",icon:"red/images/typedInput/az.png"}]
+                            header.h === 'content-type'?contentTypes:[{value:"other",label:"other",icon:"red/images/typedInput/az.svg"}]
                         });
 
                     var matchedType = headerTypes.filter(function(ht) {
@@ -219,7 +223,7 @@
                         if (type === 'content-type') {
                             propertyValue.typedInput('types',contentTypes);
                         } else {
-                            propertyValue.typedInput('types',[{value:"other",label:"other",icon:"red/images/typedInput/az.png"}]);
+                            propertyValue.typedInput('types',[{value:"other",label:"other",icon:"red/images/typedInput/az.svg"}]);
                         }
                     });
                 },