From 88be896f1c0291d7a41ebcded5280ae67c5d6b54 Mon Sep 17 00:00:00 2001
From: Nicholas O'Leary <nick.oleary@gmail.com>
Date: Fri, 22 Nov 2013 21:28:05 +0000
Subject: [PATCH] Add WebSocket nodes

---
 nodes/core/io/22-websocket.html | 130 ++++++++++++++++++++++++++++++++
 nodes/core/io/22-websocket.js   | 124 ++++++++++++++++++++++++++++++
 2 files changed, 254 insertions(+)
 create mode 100644 nodes/core/io/22-websocket.html
 create mode 100644 nodes/core/io/22-websocket.js

diff --git a/nodes/core/io/22-websocket.html b/nodes/core/io/22-websocket.html
new file mode 100644
index 000000000..de306cb20
--- /dev/null
+++ b/nodes/core/io/22-websocket.html
@@ -0,0 +1,130 @@
+<!--
+  Copyright 2013 IBM Corp.
+
+  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.
+-->
+
+<!-- WebSocket Input Node -->
+<script type="text/x-red" data-template-name="websocket in">
+    <div class="form-row">
+        <label for="node-input-server"><i class="icon-bookmark"></i> Path</label>
+        <input type="text" id="node-input-server">
+    </div>
+    <div class="form-row">
+        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="websocket in">
+    <p>WebSocket input node. Uses the specified server configuration and outputs in response to a <i>'message'</i> event.</p>
+    <p>Outputs an object called <b>msg</b> containing <b>msg.payload</b>.</p>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('websocket in',{
+        category: 'input',
+        defaults: {
+            name: {value:""},
+            server: {type:"websocket-listener"}
+        },
+        color:"rgb(215, 215, 160)",
+        inputs:0,
+        outputs:1,
+        icon: "white-globe.png",
+        label: function() {
+            var wsNode = RED.nodes.node(this.server);
+            return this.name||(wsNode?"[ws] "+wsNode.label():"websocket");
+        },
+        labelStyle: function() {
+            return this.name?"node_label_italic":"";
+        }
+    });
+</script>
+
+<!-- WebSocket out Node -->
+<script type="text/x-red" data-template-name="websocket out">
+    <div class="form-row">
+        <label for="node-input-server"><i class="icon-bookmark"></i> Path</label>
+        <input type="text" id="node-input-server">
+    </div>
+    <div class="form-row">
+        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="websocket out">
+    <p>WebSocket out node. Uses the specified server configuration to send the <b>msg.payload</b> to connected clients.</p>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('websocket out',{
+        category: 'output',
+        defaults: {
+            name: {value:""},
+            server: {type:"websocket-listener", required:true}
+        },
+        color:"rgb(215, 215, 160)",
+        inputs:1,
+        outputs:0,
+        icon: "white-globe.png",
+        align: "right",
+        label: function() {
+            var wsNode = RED.nodes.node(this.server);
+            return this.name||(wsNode?"[ws] "+wsNode.label():"websocket");
+        },
+        labelStyle: function() {
+            return this.name?"node_label_italic":"";
+        }
+    });
+</script>
+
+<!-- WebSocket Server configuration node -->
+<script type="text/x-red" data-template-name="websocket-listener">
+    <div class="form-row">
+        <label for="node-config-input-path"><i class="icon-bookmark"></i> Path</label>
+        <input type="text" id="node-config-input-path" placeholder="/ws/example">
+    </div>
+    <div id="node-config-ws-tip" class="form-tips">This path will be relative to <code><span id="node-config-ws-path"></span></code>.</div>
+</script>
+
+<script type="text/x-red" data-help-name="websocket-listener">
+   <p>This configuration node creates a WebSocket Server using the specified path</p>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('websocket-listener',{
+        category: 'config',
+        defaults: {
+            path: {value:"",required:true,validate:RED.validators.regex(/^((?!\/debug\/ws).)*$/) }
+        },
+        inputs:0,
+        outputs:0,
+        label: function() {
+            var root = document.location.pathname.slice(0,-1);
+            root += this.path;
+            return root;
+        },
+        oneditprepare: function() {
+            var root = document.location.pathname.slice(0,-1);
+            if (root == "") {
+                $("#node-config-ws-tip").hide();
+            } else {
+                $("#node-config-ws-path").html(root);
+                $("#node-config-ws-tip").show();
+            }
+            //document.getElementById("node-config-wsdocpath").innerHTML=
+        }
+    });
+</script>
diff --git a/nodes/core/io/22-websocket.js b/nodes/core/io/22-websocket.js
new file mode 100644
index 000000000..09e258926
--- /dev/null
+++ b/nodes/core/io/22-websocket.js
@@ -0,0 +1,124 @@
+/**
+ * Copyright 2013 IBM Corp.
+ *
+ * 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.
+ **/
+
+// Require main module
+var RED = require(process.env.NODE_RED_HOME+"/red/red"),
+    ws = require("ws"),
+    inspect = require("sys").inspect;
+
+// A node red node that sets up a local websocket server
+function WebSocketListenerNode(n) {
+    // Create a RED node
+    RED.nodes.createNode(this,n);
+
+    var node = this;
+
+    // Store local copies of the node configuration (as defined in the .html)
+    node.path = n.path;
+    node._inputNodes = [];    // collection of nodes that want to receive events
+
+    var path = RED.settings.httpRoot || "/";
+    path = path + (path.slice(-1) == "/" ? "":"/") + (node.path.charAt(0) == "/" ? node.path.substring(1) : node.path);
+
+    // Workaround https://github.com/einaros/ws/pull/253
+    // Listen for 'newListener' events from RED.server
+    node._serverListeners = {};
+
+    var storeListener = function(/*String*/event,/*function*/listener){
+        if(event == "error" || event == "upgrade" || event == "listening"){
+            node._serverListeners[event] = listener;
+        }
+    }
+
+    RED.server.addListener('newListener',storeListener);
+
+    // Create a WebSocket Server
+    node.server = new ws.Server({server:RED.server,path:path});
+
+    // Workaround https://github.com/einaros/ws/pull/253
+    // Stop listening for new listener events
+    RED.server.removeListener('newListener',storeListener);
+
+    node.server.on('connection', function(socket){
+        socket.on('message',function(data,flags){
+            node.handleEvent(socket,'message',data,flags);
+        });
+    });
+
+    node.on("close", function() {
+        // Workaround https://github.com/einaros/ws/pull/253
+        // Remove listeners from RED.server
+        var listener = null;
+        for(var event in node._serverListeners){
+            listener = node._serverListeners[event];
+            if(typeof listener === "function"){
+                RED.server.removeListener(event,listener);
+            }
+        }
+        node._serverListeners = {};
+
+        node.server.close();
+        node._inputNodes = [];
+    });
+}
+RED.nodes.registerType("websocket-listener",WebSocketListenerNode);
+
+WebSocketListenerNode.prototype.registerInputNode = function(/*Node*/handler){
+    this._inputNodes.push(handler);
+}
+
+WebSocketListenerNode.prototype.handleEvent = function(/*socket*/socket,/*String*/event,/*Object*/data,/*Object*/flags){
+    for (var i = 0; i < this._inputNodes.length; i++) {
+        this._inputNodes[i].send({payload:data});
+    };
+}
+
+WebSocketListenerNode.prototype.broadcast = function(data){
+    for(var i in this.server.clients){
+        this.server.clients[i].send(data);
+    };
+}
+
+function WebSocketInNode(n) {
+    RED.nodes.createNode(this,n);
+    this.server = n.server;
+    var node = this;
+    this.serverConfig = RED.nodes.getNode(this.server);
+    if (this.serverConfig) {
+        this.serverConfig.registerInputNode(this);
+    } else {
+        this.error("Missing server configuration");
+    }
+}
+RED.nodes.registerType("websocket in",WebSocketInNode);
+
+function WebSocketOutNode(n) {
+    RED.nodes.createNode(this,n);
+    var node = this;
+    this.server = n.server;
+    this.serverConfig = RED.nodes.getNode(this.server);
+    if (!this.serverConfig) {
+        this.error("Missing server configuration");
+    }
+    this.on("input", function(msg) {
+        node.serverConfig.broadcast(msg.payload,function(error){
+            if(!!error){
+                node.warn("An error occurred while sending:" + inspect(error));
+            }
+        });
+    });
+}
+RED.nodes.registerType("websocket out",WebSocketOutNode);