@node-red/nodes 4.0.0-beta.3-1 → 4.0.0

package/core/common/60-link.html

@@ -194,27 +194,46 @@
                 nodeMap[node.links[i]].new = true;
             }
         }
-        var n;
-        for (var id in nodeMap) {
+
+        let editHistories = []
+        let n;
+        for (let id in nodeMap) {
             if (nodeMap.hasOwnProperty(id)) {
                 n = RED.nodes.node(id);
                 if (n) {
+                    editHistories.push({
+                        t:'edit',
+                        node: n,
+                        changes: {
+                            links: [...n.links]
+                        },
+                        changed: n.changed
+                    })
                     if (nodeMap[id].old && !nodeMap[id].new) {
                         // Removed id
                         i = n.links.indexOf(node.id);
                         if (i > -1) {
                             n.links.splice(i,1);
+                            n.changed = true
+                            n.dirty = true
                         }
                     } else if (!nodeMap[id].old && nodeMap[id].new) {
                         // Added id
                         i = n.links.indexOf(id);
                         if (i === -1) {
                             n.links.push(node.id);
+                            n.changed = true
+                            n.dirty = true
                         }
                     }
                 }
             }
         }
+        if (editHistories.length > 0) {
+            return {
+                history: editHistories
+            }
+        }
     }
 
     function onAdd() {
@@ -254,13 +273,14 @@
             onEditPrepare(this,"link out");
         },
         oneditsave: function() {
-            onEditSave(this);
+            const result = onEditSave(this);
             // In case the name has changed, ensure any link call nodes on this
             // tab are redrawn with the updated name
             var localCallNodes = RED.nodes.filterNodes({z:RED.workspaces.active(), type:"link call"});
             localCallNodes.forEach(function(node) {
                 node.dirty = true;
             });
+            return result
         },
         onadd: onAdd,
         oneditresize: resizeNodeList
@@ -329,7 +349,7 @@
             onEditPrepare(this,"link in");
         },
         oneditsave: function() {
-            onEditSave(this);
+            return onEditSave(this);
         },
         oneditresize: resizeNodeList
     });
@@ -373,7 +393,7 @@
 
         },
         oneditsave: function() {
-            onEditSave(this);
+            return onEditSave(this);
         },
         onadd: onAdd,
         oneditresize: resizeNodeList

package/core/function/10-function.js

@@ -25,19 +25,19 @@ module.exports = function(RED) {
     function sendResults(node,send,_msgid,msgs,cloneFirstMessage) {
         if (msgs == null) {
             return;
-        } else if (!util.isArray(msgs)) {
+        } else if (!Array.isArray(msgs)) {
             msgs = [msgs];
         }
         var msgCount = 0;
         for (var m=0; m<msgs.length; m++) {
             if (msgs[m]) {
-                if (!util.isArray(msgs[m])) {
+                if (!Array.isArray(msgs[m])) {
                     msgs[m] = [msgs[m]];
                 }
                 for (var n=0; n < msgs[m].length; n++) {
                     var msg = msgs[m][n];
                     if (msg !== null && msg !== undefined) {
-                        if (typeof msg === 'object' && !Buffer.isBuffer(msg) && !util.isArray(msg)) {
+                        if (typeof msg === 'object' && !Buffer.isBuffer(msg) && !Array.isArray(msg)) {
                             if (msgCount === 0 && cloneFirstMessage !== false) {
                                 msgs[m][n] = RED.util.cloneMessage(msgs[m][n]);
                                 msg = msgs[m][n];
@@ -47,7 +47,7 @@ module.exports = function(RED) {
                         } else {
                             var type = typeof msg;
                             if (type === 'object') {
-                                type = Buffer.isBuffer(msg)?'Buffer':(util.isArray(msg)?'Array':'Date');
+                                type = Buffer.isBuffer(msg)?'Buffer':(Array.isArray(msg)?'Array':'Date');
                             }
                             node.error(RED._("function.error.non-message-returned",{ type: type }));
                         }

package/core/network/10-mqtt.js

@@ -16,6 +16,7 @@
 
 module.exports = function(RED) {
     "use strict";
+    const { getProxyForUrl } = require('./lib/proxyHelper');
     var mqtt = require("mqtt");
     var isUtf8 = require('is-utf8');
     var HttpsProxyAgent = require('https-proxy-agent');
@@ -617,17 +618,8 @@ 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, 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(","); }
-                        if (process.env.NO_PROXY) { noprox = process.env.NO_PROXY.split(","); }
-                        if (noprox) {
-                            for (var i = 0; i < noprox.length; i += 1) {
-                                if (node.brokerurl.indexOf(noprox[i].trim()) !== -1) { noproxy = true; }
-                            }
-                        }
-                        if (prox && !noproxy) {
+                        const prox = getProxyForUrl(node.brokerurl, RED.settings.proxyOptions);
+                        if (prox) {
                             var parsedUrl = url.parse(node.brokerurl);
                             var proxyOpts = url.parse(prox);
                             // true for wss

package/core/network/21-httprequest.js

@@ -16,6 +16,7 @@
 
 module.exports = async function(RED) {
     "use strict";
+    const { getProxyForUrl, parseUrl } = require('./lib/proxyHelper');
     const { got } = await import('got')
     const {CookieJar} = require("tough-cookie");
     const { HttpProxyAgent, HttpsProxyAgent } = require('hpagent');
@@ -101,18 +102,18 @@ in your Node-RED user directory (${RED.settings.userDir}).
 
         node.insecureHTTPParser = n.insecureHTTPParser
 
-        var prox, noprox;
-        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(","); }
-        if (process.env.NO_PROXY) { noprox = process.env.NO_PROXY.split(","); }
-
-        var proxyConfig = null;
-        if (n.proxy) {
-            proxyConfig = RED.nodes.getNode(n.proxy);
-            prox = proxyConfig.url;
-            noprox = proxyConfig.noproxy;
+        let proxyConfig = n.proxy ? RED.nodes.getNode(n.proxy) || {} : null
+        const getProxy = (url) => {
+            const proxyOptions = Object.assign({}, RED.settings.proxyOptions);
+            if (n.proxy && proxyConfig) {
+                proxyOptions.env = {
+                    no_proxy: (proxyConfig.noproxy || []).join(','),
+                    http_proxy: (proxyConfig.url)
+                }
+            }
+            return getProxyForUrl(url, proxyOptions)
         }
+        let prox = getProxy(nodeUrl || '')
 
         let timingLog = false;
         if (RED.settings.hasOwnProperty("httpRequestTimingLog")) {
@@ -141,7 +142,15 @@ in your Node-RED user directory (${RED.settings.userDir}).
                 });
             }
         }
-
+        /**
+         * @param {Object} headersObject
+         * @param {string} name
+         * @return {any} value
+        */
+        const getHeaderValue = (headersObject, name) => {
+            const asLowercase = name.toLowercase();
+            return headersObject[Object.keys(headersObject).find(k => k.toLowerCase() === asLowercase)];
+        }
         this.on("input",function(msg,nodeSend,nodeDone) {
             checkNodeAgentPatch();
             //reset redirectList on each request
@@ -177,7 +186,11 @@ in your Node-RED user directory (${RED.settings.userDir}).
                     url = "http://"+url;
                 }
             }
-
+            // before any parameters are appended to the `url`, lets check see if the proxy needs a refresh
+            let proxyUrl = prox; // The proxyUrl determined for `nodeUrl`
+            if(url !== nodeUrl) {
+                proxyUrl = getProxy(url)
+            }
             // The Request module used in Node-RED 1.x was tolerant of query strings that
             // were partially encoded. For example - "?a=hello%20there&b=20%"
             // The GOT module doesn't like that.
@@ -521,49 +534,43 @@ in your Node-RED user directory (${RED.settings.userDir}).
                 opts.headers[clSet] = opts.headers['content-length'];
                 delete opts.headers['content-length'];
             }
-
-            var noproxy;
-            if (noprox) {
-                for (var i = 0; i < noprox.length; i += 1) {
-                    if (url.indexOf(noprox[i]) !== -1) { noproxy=true; }
-                }
+            if (!opts.headers.hasOwnProperty('user-agent')) {
+                opts.headers['user-agent'] = 'Mozilla/5.0 (Node-RED)';
             }
-            if (prox && !noproxy) {
-                var match = prox.match(/^(https?:\/\/)?(.+)?:([0-9]+)?/i);
+            if (proxyUrl) {
+                const match = proxyUrl.match(/^(https?:\/\/)?(.+)?:([0-9]+)?/i);
                 if (match) {
-                    let proxyAgent;
-                    let proxyURL = new URL(prox);
+                    const proxyURL = parseUrl(proxyUrl)
                     //set username/password to null to stop empty creds header
+                    /** @type {import('hpagent').HttpProxyAgentOptions} */
                     let proxyOptions = {
-                        proxy: {
-                            protocol: proxyURL.protocol,
-                            hostname: proxyURL.hostname,
-                            port: proxyURL.port,
-                            username: null,
-                            password: null
-                        },
+                        proxy: proxyUrl,
+                        scheduling: 'lifo',
                         maxFreeSockets: 256,
                         maxSockets: 256,
                         keepAlive: true
                     }
                     if (proxyConfig && proxyConfig.credentials) {
-                        let proxyUsername = proxyConfig.credentials.username || '';
-                        let proxyPassword = proxyConfig.credentials.password || '';
+                        const proxyUsername = proxyConfig.credentials.username || '';
+                        const proxyPassword = proxyConfig.credentials.password || '';
                         if (proxyUsername || proxyPassword) {
+                            proxyOptions.proxy = proxyURL
                             proxyOptions.proxy.username = proxyUsername;
                             proxyOptions.proxy.password = proxyPassword;
                         }
                     } else if (proxyURL.username || proxyURL.password){
-                        proxyOptions.proxy.username = proxyURL.username;
-                        proxyOptions.proxy.password = proxyURL.password;
+                        proxyOptions.proxy = proxyURL
+                        // proxyOptions.proxy.username = proxyURL.username;
+                        // proxyOptions.proxy.password = proxyURL.password;
                     }
                     //need both incase of http -> https redirect
                     opts.agent = {
                         http: new HttpProxyAgent(proxyOptions),
-                        https: new HttpsProxyAgent(proxyOptions)
-                    }
+                        https: new HttpProxyAgent(proxyOptions)
+                    };
+
                 } else {
-                    node.warn("Bad proxy url: "+ prox);
+                    node.warn("Bad proxy url: " + proxyUrl);
                 }
             }
             if (useKeepAlive && !opts.agent) {

package/core/network/22-websocket.js

@@ -20,7 +20,7 @@ module.exports = function(RED) {
     var inspect = require("util").inspect;
     var url = require("url");
     var HttpsProxyAgent = require('https-proxy-agent');
-
+    const { getProxyForUrl } = require('./lib/proxyHelper');
 
     var serverUpgradeAdded = false;
     function handleServerUpgrade(request, socket, head) {
@@ -69,21 +69,9 @@ module.exports = function(RED) {
 
         function startconn() {    // Connect to remote endpoint
             node.tout = null;
-            var prox, noprox;
-            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(","); }
-            if (process.env.NO_PROXY) { noprox = process.env.NO_PROXY.split(","); }
-
-            var noproxy = false;
-            if (noprox) {
-                for (var i in noprox) {
-                    if (node.path.indexOf(noprox[i].trim()) !== -1) { noproxy=true; }
-                }
-            }
-
-            var agent = undefined;
-            if (prox && !noproxy) {
+            const prox = getProxyForUrl(node.brokerurl, RED.settings.proxyOptions);
+            let agent = undefined;
+            if (prox) {
                 agent = new HttpsProxyAgent(prox);
             }
 

package/core/network/lib/proxyHelper.js

@@ -0,0 +1,219 @@
+/*
+The MIT License
+
+Copyright (C) 2016-2018 Rob Wu <rob@robwu.nl>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+*/
+
+/* 
+This proxy helper is heavily based on the proxy helper from Rob Wu as detailed above.
+It has been modified to work with the Node-RED runtime environment.
+The license for the original code is reproduced above.
+*/
+
+
+/**
+ * Parse a URL into its components.
+ * @param {String} url The URL to parse
+ * @returns {URL}
+ */
+const parseUrl = (url) => {
+    let parsedUrl = {
+        protocol: null,
+        host: null,
+        port: null,
+        hostname: null,
+        query: null,
+        href: null
+    }
+    try {
+        if (!url) { return parsedUrl }
+        parsedUrl = new URL(url)
+    } catch (error) {
+        // dont throw error
+    }
+    return parsedUrl
+}
+
+const DEFAULT_PORTS = {
+    ftp: 21,
+    gopher: 70,
+    http: 80,
+    https: 443,
+    ws: 80,
+    wss: 443,
+    mqtt: 1880,
+    mqtts: 8883
+}
+
+const modeOverride = getEnv('NR_PROXY_MODE', {})
+
+/**
+ * @typedef {Object} ProxyOptions
+ * @property {'strict'|'legacy'} [mode] - Legacy mode is for non-strict previous proxy determination logic (for node-red <= v3.1 compatibility) (default 'strict')
+ * @property {boolean} [favourUpperCase] - Favour UPPER_CASE *_PROXY env vars (default false)
+ * @property {boolean} [lowerCaseOnly] - Prevent UPPER_CASE *_PROXY env vars being used. (default false)
+ * @property {boolean} [excludeNpm] - Prevent npm_config_*_proxy env vars being used. (default false)
+ * @property {object} [env] - The environment object to use (defaults to process.env)
+ */
+
+/**
+ * Get the proxy URL for a given URL.
+ * @param {string|URL} url - The URL, or the result from url.parse.
+ * @param {ProxyOptions} [options] - The options object (optional)
+ * @return {string} The URL of the proxy that should handle the request to the
+ *  given URL. If no proxy is set, this will be an empty string.
+ */
+function getProxyForUrl(url, options) {
+    url = url || ''
+    const defaultOptions = {
+        mode: 'strict',
+        lowerCaseOnly: false,
+        favourUpperCase: false,
+        excludeNpm: false,
+    }
+    options = Object.assign({}, defaultOptions, options)
+
+    if (modeOverride === 'legacy' || modeOverride === 'strict') {
+        options.mode = modeOverride
+    }
+
+    if (options.mode === 'legacy') {
+        return legacyGetProxyForUrl(url, options.env || process.env)
+    }
+   
+    const parsedUrl = typeof url === 'string' ? parseUrl(url) : url || {}
+    let proto = parsedUrl.protocol
+    let hostname = parsedUrl.host
+    let port = parsedUrl.port
+    if (typeof hostname !== 'string' || !hostname || typeof proto !== 'string') {
+        return ''  // Don't proxy URLs without a valid scheme or host.
+    }
+
+    proto = proto.split(':', 1)[0]
+    // Stripping ports in this way instead of using parsedUrl.hostname to make
+    // sure that the brackets around IPv6 addresses are kept.
+    hostname = hostname.replace(/:\d*$/, '')
+    port = parseInt(port) || DEFAULT_PORTS[proto] || 0
+    if (!shouldProxy(hostname, port, options)) {
+        return ''  // Don't proxy URLs that match NO_PROXY.
+    }
+
+    let proxy =
+        getEnv('npm_config_' + proto + '_proxy', options) ||
+        getEnv(proto + '_proxy', options) ||
+        getEnv('npm_config_proxy', options) ||
+        getEnv('all_proxy', options)
+    if (proxy && proxy.indexOf('://') === -1) {
+        // Missing scheme in proxy, default to the requested URL's scheme.
+        proxy = proto + '://' + proxy
+    }
+    return proxy
+}
+
+/**
+ * Get the proxy URL for a given URL.
+ * For node-red < v3.1 or compatibility mode
+ * @param {string} url The URL to check for proxying
+ * @param {object} [env] The environment object to use (default process.env)
+ * @returns 
+ */
+function legacyGetProxyForUrl(url, env) {
+    env = env || process.env
+    let prox, noprox;
+    if (env.http_proxy) { prox = env.http_proxy; }
+    if (env.HTTP_PROXY) { prox = env.HTTP_PROXY; }
+    if (env.no_proxy) { noprox = env.no_proxy.split(","); }
+    if (env.NO_PROXY) { noprox = env.NO_PROXY.split(","); }
+
+    let noproxy = false;
+    if (noprox) {
+        for (let i in noprox) {
+            if (url.indexOf(noprox[i].trim()) !== -1) { noproxy=true; }
+        }
+    }
+    if (prox && !noproxy) {
+        return prox
+    }
+    return ""
+}
+
+/**
+ * Determines whether a given URL should be proxied.
+ *
+ * @param {string} hostname - The host name of the URL.
+ * @param {number} port - The effective port of the URL.
+ * @returns {boolean} Whether the given URL should be proxied.
+ * @private
+ */
+function shouldProxy(hostname, port, options) {
+    const NO_PROXY =
+        (getEnv('npm_config_no_proxy', options) || getEnv('no_proxy', options)).toLowerCase()
+    if (!NO_PROXY) {
+        return true  // Always proxy if NO_PROXY is not set.
+    }
+    if (NO_PROXY === '*') {
+        return false  // Never proxy if wildcard is set.
+    }
+
+    return NO_PROXY.split(/[,\s]/).every(function (proxy) {
+        if (!proxy) {
+            return true  // Skip zero-length hosts.
+        }
+        const parsedProxy = proxy.match(/^(.+):(\d+)$/)
+        let parsedProxyHostname = parsedProxy ? parsedProxy[1] : proxy
+        const parsedProxyPort = parsedProxy ? parseInt(parsedProxy[2]) : 0
+        if (parsedProxyPort && parsedProxyPort !== port) {
+            return true  // Skip if ports don't match.
+        }
+
+        if (!/^[.*]/.test(parsedProxyHostname)) {
+            // No wildcards, so stop proxying if there is an exact match.
+            return hostname !== parsedProxyHostname
+        }
+
+        if (parsedProxyHostname.charAt(0) === '*') {
+            // Remove leading wildcard.
+            parsedProxyHostname = parsedProxyHostname.slice(1)
+        }
+        // Stop proxying if the hostname ends with the no_proxy host.
+        return !hostname.endsWith(parsedProxyHostname)
+    })
+}
+
+/**
+ * Get the value for an environment constiable.
+ *
+ * @param {string} key - The name of the environment constiable.
+ * @param {ProxyOptions} options - The name of the environment constiable.
+ * @return {string} The value of the environment constiable.
+ * @private
+ */
+function getEnv(key, options) {
+    const env = (options && options.env) || process.env
+    if (options && options.excludeNpm === true) {
+        if (key.startsWith('npm_config_')) {
+            return ''
+        }
+    }
+    if (options && options.lowerCaseOnly === true) {
+        return env[key.toLowerCase()] || ''
+    } else if (options && options.favourUpperCase === true) {
+        return env[key.toUpperCase()] ||  env[key.toLowerCase()] || ''
+    }
+    return env[key.toLowerCase()] || env[key.toUpperCase()] || ''
+}
+
+module.exports = {
+    getProxyForUrl,
+    parseUrl
+}

package/locales/de/function/89-delay.html

@@ -20,12 +20,26 @@
         <dt class="optional">delay <span class="property-type">number</span></dt>
         <dd>Legt die Verzögerung in Millisekunden fest, die auf die Nachricht angewendet werden soll.
             Zur Nutzung dieser Option muss <i>Verzög. mit msg.delay überschreibbar</i> aktiviert sein.</dd>
+        <dt class="optional">rate <span class="property-type">number</span></dt>
+        <dd>Setzt die Verzögerung in Millisekunden zwischen den Nachrichten. Diese Node überschreibt die
+            bestehende Verzögerung die in der Node konfiguration, wenn die empfangende Nachricht <code>msg.rate</code>
+            in Millisekunden enthält. Dies trifft nur zu, wenn in der Node konfiguriert ist, das empfangene
+            Nachrichten den konfigurierten Wert überschreiben können.</dd>
         <dt class="optional">reset</dt>
         <dd>Wenn bei der empfangenen Nachricht diese Eigenschaft auf einen beliebigen Wert gesetzt ist,
             werden alle im Node gepufferten Nachrichten gelöscht.</dd>
         <dt class="optional">flush</dt>
         <dd>Wenn bei der empfangenen Nachricht diese Eigenschaft auf einen beliebigen Wert gesetzt ist,
             werden alle im Node gepufferten Nachrichten sofort gesendet.</dd>
+        <dt class="optional">flush</dt>
+        <dd>Wenn bei der empfangenen Nachricht diese Eigenschaft auf einen numerischen Wert gesetzt ist,
+            wird diese Anzahl an Nachrichten sofort gesendet. Wenn ein anderer Typ gesetzt ist (z.B. Boolean),
+            werden alle in der Node gepufferten Nachrichten gesendet.</dd>
+        <dt class="optional">toFront</dt>
+        <dd>Wenn diese Eigenschaft im Ratenbegrenzungsmodus für die empfangene Nachricht auf den booleschen Wert
+            <code>true</code> gesetzt ist, Anschließend wird die Nachricht an den Anfang der Warteschlange verschoben
+            und als nächstes freigegeben. Dies kann in Kombination mit <code>msg.flush=1</code> verwendet werden, um sofort erneut zu senden.
+        </dd>
     </dl>
     <h3>Details</h3>
     <p>Wenn Verzögerung als Nachrichtenaktion eingestellt ist, kann die Verzögerungszeit ein fixer Wert,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@node-red/nodes",
-    "version": "4.0.0-beta.3-1",
+    "version": "4.0.0",
     "license": "Apache-2.0",
     "repository": {
         "type": "git",
@@ -15,19 +15,19 @@
         }
     ],
     "dependencies": {
-        "acorn": "8.8.2",
-        "acorn-walk": "8.2.0",
-        "ajv": "8.12.0",
+        "acorn": "8.11.3",
+        "acorn-walk": "8.3.2",
+        "ajv": "8.14.0",
         "body-parser": "1.20.2",
         "cheerio": "1.0.0-rc.10",
         "content-type": "1.0.5",
         "cookie-parser": "1.4.6",
-        "cookie": "0.5.0",
+        "cookie": "0.6.0",
         "cors": "2.8.5",
         "cronosjs": "1.7.1",
         "denque": "2.1.0",
         "form-data": "4.0.0",
-        "fs-extra": "11.1.1",
+        "fs-extra": "11.2.0",
         "got": "12.6.0",
         "hash-sum": "2.0.0",
         "hpagent": "1.2.0",
@@ -35,15 +35,15 @@
         "is-utf8": "0.2.1",
         "js-yaml": "4.1.0",
         "media-typer": "1.1.0",
-        "mqtt": "4.3.7",
+        "mqtt": "5.7.0",
         "multer": "1.4.5-lts.1",
         "mustache": "4.2.0",
         "node-watch": "0.7.4",
         "on-headers": "1.0.2",
         "raw-body": "2.5.2",
-        "tough-cookie": "4.1.3",
-        "uuid": "9.0.0",
-        "ws": "7.5.6",
+        "tough-cookie": "4.1.4",
+        "uuid": "9.0.1",
+        "ws": "7.5.10",
         "xml2js": "0.6.2",
         "iconv-lite": "0.6.3"
     }

package/core/network/lib/mqtt.js

@@ -1,257 +0,0 @@
-/**
- * Copyright JS Foundation and other contributors, http://js.foundation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- **/
-var util = require("util");
-var mqtt = require("mqtt");
-var events = require("events");
-
-util.log("[warn] nodes/core/io/lib/mqtt.js is deprecated and will be removed in a future release of Node-RED. Please report this usage to the Node-RED mailing list.");
-
-//var inspect = require("util").inspect;
-
-//var Client = module.exports.Client = function(
-
-var port = 1883;
-var host = "localhost";
-
-function MQTTClient(port,host) {
-   this.port = port||1883;
-   this.host = host||"localhost";
-   this.messageId = 1;
-   this.pendingSubscriptions = {};
-   this.inboundMessages = {};
-   this.lastOutbound = (new Date()).getTime();
-   this.lastInbound = (new Date()).getTime();
-   this.connected = false;
-
-   this._nextMessageId = function() {
-      this.messageId += 1;
-      if (this.messageId > 0xFFFF) {
-         this.messageId = 1;
-      }
-      return this.messageId;
-   }
-   events.EventEmitter.call(this);
-}
-util.inherits(MQTTClient, events.EventEmitter);
-
-MQTTClient.prototype.connect = function(options) {
-   if (!this.connected) {
-       var self = this;
-       options = options||{};
-       self.options = options;
-       self.options.keepalive = options.keepalive||15;
-       self.options.clean = self.options.clean||true;
-       self.options.protocolId = 'MQIsdp';
-       self.options.protocolVersion = 3;
-
-       self.client = mqtt.createConnection(this.port,this.host,function(err,client) {
-             if (err) {
-                self.connected = false;
-                clearInterval(self.watchdog);
-                self.connectionError = true;
-                //util.log('[mqtt] ['+self.uid+'] connection error 1 : '+inspect(err));
-                self.emit('connectionlost',err);
-                return;
-             }
-             client.on('close',function(e) {
-                   //util.log('[mqtt] ['+self.uid+'] on close');
-                   clearInterval(self.watchdog);
-                   if (!self.connectionError) {
-                       if (self.connected) {
-                          self.connected = false;
-                          self.emit('connectionlost',e);
-                       } else {
-                          self.emit('disconnect');
-                       }
-                   }
-             });
-             client.on('error',function(e) {
-                   //util.log('[mqtt] ['+self.uid+'] on error : '+inspect(e));
-                   clearInterval(self.watchdog);
-                   if (self.connected) {
-                      self.connected = false;
-                      self.emit('connectionlost',e);
-                   }
-             });
-             client.on('connack',function(packet) {
-                   if (packet.returnCode === 0) {
-                      self.watchdog = setInterval(function(self) {
-                            var now = (new Date()).getTime();
-
-                            //util.log('[mqtt] ['+self.uid+'] watchdog '+inspect({connected:self.connected,connectionError:self.connectionError,pingOutstanding:self.pingOutstanding,now:now,lastOutbound:self.lastOutbound,lastInbound:self.lastInbound}));
-
-                            if (now - self.lastOutbound > self.options.keepalive*500 || now - self.lastInbound > self.options.keepalive*500) {
-                               if (self.pingOutstanding) {
-                                  //util.log('[mqtt] ['+self.uid+'] watchdog pingOustanding - disconnect');
-                                  try {
-                                     self.client.disconnect();
-                                  } catch (err) {
-                                  }
-                               } else {
-                                  //util.log('[mqtt] ['+self.uid+'] watchdog pinging');
-                                  self.lastOutbound = (new Date()).getTime();
-                                  self.lastInbound = (new Date()).getTime();
-                                  self.pingOutstanding = true;
-                                  self.client.pingreq();
-                               }
-                            }
-
-                      },self.options.keepalive*500,self);
-                      self.pingOutstanding = false;
-                      self.lastInbound = (new Date()).getTime()
-                      self.lastOutbound = (new Date()).getTime()
-                      self.connected = true;
-                      self.connectionError = false;
-                      self.emit('connect');
-                   } else {
-                      self.connected = false;
-                      self.emit('connectionlost');
-                   }
-             });
-             client.on('suback',function(packet) {
-                   self.lastInbound = (new Date()).getTime()
-                   var topic = self.pendingSubscriptions[packet.messageId];
-                   self.emit('subscribe',topic,packet.granted[0]);
-                   delete self.pendingSubscriptions[packet.messageId];
-             });
-             client.on('unsuback',function(packet) {
-                   self.lastInbound = (new Date()).getTime()
-                   var topic = self.pendingSubscriptions[packet.messageId];
-                   self.emit('unsubscribe',topic);
-                   delete self.pendingSubscriptions[packet.messageId];
-             });
-             client.on('publish',function(packet) {
-                   self.lastInbound = (new Date()).getTime();
-                   if (packet.qos < 2) {
-                      var p = packet;
-                      self.emit('message',p.topic,p.payload,p.qos,p.retain);
-                   } else {
-                      self.inboundMessages[packet.messageId] = packet;
-                      this.lastOutbound = (new Date()).getTime()
-                      self.client.pubrec(packet);
-                   }
-                   if (packet.qos == 1) {
-                      this.lastOutbound = (new Date()).getTime()
-                      self.client.puback(packet);
-                   }
-             });
-
-             client.on('pubrel',function(packet) {
-                   self.lastInbound = (new Date()).getTime()
-                   var p = self.inboundMessages[packet.messageId];
-                   if (p) {
-                       self.emit('message',p.topic,p.payload,p.qos,p.retain);
-                       delete self.inboundMessages[packet.messageId];
-                   }
-                   self.lastOutbound = (new Date()).getTime()
-                   self.client.pubcomp(packet);
-             });
-
-             client.on('puback',function(packet) {
-                   self.lastInbound = (new Date()).getTime()
-                   // outbound qos-1 complete
-             });
-
-             client.on('pubrec',function(packet) {
-                   self.lastInbound = (new Date()).getTime()
-                   self.lastOutbound = (new Date()).getTime()
-                   self.client.pubrel(packet);
-             });
-             client.on('pubcomp',function(packet) {
-                   self.lastInbound = (new Date()).getTime()
-                   // outbound qos-2 complete
-             });
-             client.on('pingresp',function(packet) {
-                   //util.log('[mqtt] ['+self.uid+'] received pingresp');
-                   self.lastInbound = (new Date()).getTime()
-                   self.pingOutstanding = false;
-             });
-
-             this.lastOutbound = (new Date()).getTime()
-             this.connectionError = false;
-             client.connect(self.options);
-       });
-   }
-}
-
-MQTTClient.prototype.subscribe = function(topic,qos) {
-   var self = this;
-   if (self.connected) {
-      var options = {
-         subscriptions:[{topic:topic,qos:qos}],
-         messageId: self._nextMessageId()
-      };
-      this.pendingSubscriptions[options.messageId] = topic;
-      this.lastOutbound = (new Date()).getTime();
-      self.client.subscribe(options);
-      self.client.setPacketEncoding('binary');
-   }
-}
-MQTTClient.prototype.unsubscribe = function(topic) {
-   var self = this;
-   if (self.connected) {
-      var options = {
-         unsubscriptions:[topic],
-         messageId: self._nextMessageId()
-      };
-      this.pendingSubscriptions[options.messageId] = topic;
-      this.lastOutbound = (new Date()).getTime()
-      self.client.unsubscribe(options);
-   }
-}
-
-MQTTClient.prototype.publish = function(topic,payload,qos,retain) {
-   var self = this;
-   if (self.connected) {
-
-      if (!Buffer.isBuffer(payload)) {
-         if (typeof payload === "object") {
-            payload = JSON.stringify(payload);
-         } else if (typeof payload !== "string") {
-            payload = ""+payload;
-         }
-      }
-      var options = {
-         topic: topic,
-         payload: payload,
-         qos: qos||0,
-         retain:retain||false
-      };
-      if (options.qos !== 0) {
-         options.messageId = self._nextMessageId();
-      }
-      this.lastOutbound = (new Date()).getTime()
-      self.client.publish(options);
-   }
-}
-
-MQTTClient.prototype.disconnect = function() {
-   var self = this;
-   if (this.connected) {
-       this.connected = false;
-       try {
-           this.client.disconnect();
-       } catch(err) {
-       }
-   }
-}
-MQTTClient.prototype.isConnected = function() {
-    return this.connected;
-}
-module.exports.createClient = function(port,host) {
-   var mqtt_client = new MQTTClient(port,host);
-   return mqtt_client;
-}