From 0b49b2cdda7a182d8d4edd184c30f75c1c2279dd Mon Sep 17 00:00:00 2001
From: Dave C-J <dave@conway-jones.co.uk>
Date: Tue, 29 Apr 2014 17:01:30 +0100
Subject: [PATCH] Add parser function nodes for XML, JSON and CSV. Each is dual
 function - pass in (for example) and get out a js object, pass in a js object
 and get back out the xml string. The CSV node must be configured with a
 column template that specifys the required property names for that column
 (csv->js), or the properties of the object that should be made into the csv
 (js->csv)

---
 nodes/core/parsers/70-CSV.html  | 67 ++++++++++++++++++++++++++++
 nodes/core/parsers/70-CSV.js    | 78 +++++++++++++++++++++++++++++++++
 nodes/core/parsers/70-JSON.html | 47 ++++++++++++++++++++
 nodes/core/parsers/70-JSON.js   | 44 +++++++++++++++++++
 nodes/core/parsers/70-XML.html  | 48 ++++++++++++++++++++
 nodes/core/parsers/70-XML.js    | 50 +++++++++++++++++++++
 6 files changed, 334 insertions(+)
 create mode 100644 nodes/core/parsers/70-CSV.html
 create mode 100644 nodes/core/parsers/70-CSV.js
 create mode 100644 nodes/core/parsers/70-JSON.html
 create mode 100644 nodes/core/parsers/70-JSON.js
 create mode 100644 nodes/core/parsers/70-XML.html
 create mode 100644 nodes/core/parsers/70-XML.js

diff --git a/nodes/core/parsers/70-CSV.html b/nodes/core/parsers/70-CSV.html
new file mode 100644
index 000000000..9429d1387
--- /dev/null
+++ b/nodes/core/parsers/70-CSV.html
@@ -0,0 +1,67 @@
+<!--
+  Copyright 2014 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.
+-->
+
+<script type="text/x-red" data-template-name="csv">
+    <div class="form-row">
+        <label for="node-input-temp"><i class="icon-list"></i> Columns</label>
+        <input type="text" id="node-input-temp" placeholder="A,B,C,D">
+    </div>
+    <div class="form-row">
+        <label for="node-input-sep"><i class="icon-chevron-right"></i> Separator</label>
+        <input type="text" id="node-input-sep" placeholder=','>
+    </div>
+    <!-- <div class="form-row">
+        <label for="node-input-quo"><i class="icon-tag"></i> Escape</label>
+        <input type="text" id="node-input-quo" placeholder='"'>
+    </div> -->
+    <br/>
+    <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>
+    <div id="node-input-tip" class="form-tips">Tip: you can use "\t" for tab separator.</div>
+</script>
+
+<script type="text/x-red" data-help-name="csv">
+    <p>A function that parses the <b>msg.payload</b> to convert csv to/from a javascript object. Places the result in the payload.</p>
+    <p>If the input is a string it tries to parse it as CSV and creates a javascript object.</p>
+    <p>If the input is a javascript object it tries to build a CSV string.</p>
+    <p>A columns template MUST be specified that contains the ordered list of column headers. For csv input these become the property names.
+    For csv output these specify the properties to extract from the object and the order for the csv.</p>
+    <p><b>Note:</b> the columns should always be specified comma separated - even if another separator is chosen for the data.</p>
+    </script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('csv',{
+        category: 'function',
+        color:"#DEBD5C",
+        defaults: {
+            name: {value:""},
+            sep: {value:',',required:true},
+            //quo: {value:'"',required:true},
+            temp: {value:"",required:true}
+        },
+        inputs:1,
+        outputs:1,
+        icon: "arrow-in.png",
+        label: function() {
+            return this.name||"csv";
+        },
+        labelStyle: function() {
+            return this.name?"node_label_italic":"";
+        }
+    });
+</script>
diff --git a/nodes/core/parsers/70-CSV.js b/nodes/core/parsers/70-CSV.js
new file mode 100644
index 000000000..afe83900f
--- /dev/null
+++ b/nodes/core/parsers/70-CSV.js
@@ -0,0 +1,78 @@
+/**
+ * Copyright 2014 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.
+ **/
+
+var RED = require(process.env.NODE_RED_HOME+"/red/red");
+
+function CSVNode(n) {
+    RED.nodes.createNode(this,n);
+    this.template = n.temp.split(",");
+    this.sep = n.sep || ',';
+    this.sep = this.sep.replace("\\n","\n").replace("\\r","\r").replace("\\t","\t");
+    this.quo = '"';
+    var node = this;
+    this.on("input", function(msg) {
+        if (msg.hasOwnProperty("payload")) {
+            if (typeof msg.payload == "object") { // convert to csv
+                try {
+                    var o = "";
+                    for (var i in node.template) {
+                        if (msg.payload.hasOwnProperty(node.template[i])) {
+                            if (msg.payload[node.template[i]].indexOf(node.sep) != -1) {
+                                o += node.quo + msg.payload[node.template[i]] + node.quo + node.sep;
+                            }
+                            else if (msg.payload[node.template[i]].indexOf(node.quo) != -1) {
+                                msg.payload[node.template[i]] = msg.payload[node.template[i]].replace(/"/g, '""');
+                                o += node.quo + msg.payload[node.template[i]] + node.quo + node.sep;
+                            }
+                            else { o += msg.payload[node.template[i]] + node.sep; }
+                        }
+                    }
+                    msg.payload = o.slice(0,-1);
+                    node.send(msg);
+                }
+                catch(e) { node.log(e); }
+            }
+            else if (typeof msg.payload == "string") { // convert to object
+                try {
+                    var f = true;
+                    var j = 0;
+                    var k = [""];
+                    var o = {};
+                    for (var i = 0; i < msg.payload.length; i++) {
+                        if (msg.payload[i] === node.quo) {
+                            f = !f;
+                            if (msg.payload[i-1] === node.quo) { k[j] += '\"'; }
+                        }
+                        else if ((msg.payload[i] === node.sep) && f) {
+                            if ( node.template[j] && (node.template[j] != "") ) { o[node.template[j]] = k[j]; }
+                            j += 1;
+                            k[j] = "";
+                        }
+                        else {
+                            k[j] += msg.payload[i];
+                        }
+                    }
+                    if ( node.template[j] && (node.template[j] != "") ) { o[node.template[j]] = k[j]; }
+                    msg.payload = o;
+                    node.send(msg);
+                }
+                catch(e) { node.log(e); }
+            }
+            else { node.log("This node only handles csv strings or js objects."); }
+        }
+    });
+}
+RED.nodes.registerType("csv",CSVNode);
diff --git a/nodes/core/parsers/70-JSON.html b/nodes/core/parsers/70-JSON.html
new file mode 100644
index 000000000..dee989d63
--- /dev/null
+++ b/nodes/core/parsers/70-JSON.html
@@ -0,0 +1,47 @@
+<!--
+  Copyright 2014 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.
+-->
+
+<script type="text/x-red" data-template-name="json">
+    <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="json">
+    <p>A function that parses the <b>msg.payload</b> to convert a JSON string to/from a javascript object. Places the result back into the payload.</p>
+    <p>If the input is a JSON string it tries to parse it to a javascript object.</p>
+    <p>If the input is a javascript object it creates a JSON string.</p>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('json',{
+        category: 'function',
+        color:"#DEBD5C",
+        defaults: {
+            name: {value:""}
+        },
+        inputs:1,
+        outputs:1,
+        icon: "arrow-in.png",
+        label: function() {
+            return this.name||"json";
+        },
+        labelStyle: function() {
+            return this.name?"node_label_italic":"";
+        }
+    });
+</script>
diff --git a/nodes/core/parsers/70-JSON.js b/nodes/core/parsers/70-JSON.js
new file mode 100644
index 000000000..b807cc2f1
--- /dev/null
+++ b/nodes/core/parsers/70-JSON.js
@@ -0,0 +1,44 @@
+/**
+ * Copyright 2014 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.
+ **/
+
+var RED = require(process.env.NODE_RED_HOME+"/red/red");
+var util = require("util");
+
+function JSONNode(n) {
+    RED.nodes.createNode(this,n);
+    var node = this;
+    this.on("input", function(msg) {
+        if (msg.hasOwnProperty("payload")) {
+            if (typeof msg.payload === "string") {
+                try {
+                    msg.payload = JSON.parse(msg.payload);
+                    node.send(msg);
+                }
+                catch(e) { node.log(e+ "\n"+msg.payload); }
+            }
+            else if (typeof msg.payload === "object") {
+                if (!Buffer.isBuffer(msg.payload) ) {
+                    if (!util.isArray(msg.payload)) {
+                        msg.payload = JSON.stringify(msg.payload);
+                        node.send(msg);
+                    }
+                }
+            }
+            else { node.log("dropped: "+msg.payload); }
+        }
+    });
+}
+RED.nodes.registerType("json",JSONNode);
diff --git a/nodes/core/parsers/70-XML.html b/nodes/core/parsers/70-XML.html
new file mode 100644
index 000000000..a42415047
--- /dev/null
+++ b/nodes/core/parsers/70-XML.html
@@ -0,0 +1,48 @@
+<!--
+  Copyright 2014 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.
+-->
+
+<script type="text/x-red" data-template-name="xml">
+    <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="xml">
+    <p>A function that parses the <b>msg.payload</b> to convert xml to/from a javascript object. Places the result in the payload.</p>
+    <p>If the input is a string it tries to parse it as XML and creates a javascript object.</p>
+    <p>If the input is a javascript object it tries to build an XML string.</p>
+    <p>See <a href="https://github.com/Leonidas-from-XIV/node-xml2js/blob/master/README.md" target="_new">the xml2js docs <i>here</i></a> for more information.</p>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('xml',{
+        category: 'function',
+        color:"#DEBD5C",
+        defaults: {
+            name: {value:""}
+        },
+        inputs:1,
+        outputs:1,
+        icon: "arrow-in.png",
+        label: function() {
+            return this.name||"xml";
+        },
+        labelStyle: function() {
+            return this.name?"node_label_italic":"";
+        }
+    });
+</script>
diff --git a/nodes/core/parsers/70-XML.js b/nodes/core/parsers/70-XML.js
new file mode 100644
index 000000000..52a2e1158
--- /dev/null
+++ b/nodes/core/parsers/70-XML.js
@@ -0,0 +1,50 @@
+/**
+ * Copyright 2014 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.
+ **/
+
+var RED = require(process.env.NODE_RED_HOME+"/red/red");
+var xml2js = require('xml2js');
+var parseString = xml2js.parseString;
+var builder = new xml2js.Builder({renderOpts:{pretty:false}});
+
+function XMLNode(n) {
+    RED.nodes.createNode(this,n);
+    var node = this;
+    this.on("input", function(msg) {
+        if (msg.hasOwnProperty("payload")) {
+            if (typeof msg.payload == "object") {
+                try {
+                    msg.payload = builder.buildObject(msg.payload);
+                    node.send(msg);
+                }
+                catch(e) { node.log(e); }
+            }
+            else if (typeof msg.payload == "string") {
+                try {
+                    parseString(msg.payload, {strict:true,async:true}, function (err, result) {
+                        if (err) { node.error(err); }
+                        else {
+                            msg.payload = result;
+                            node.send(msg);
+                        }
+                    });
+                }
+                catch(e) { node.log(e); }
+            }
+            else { node.log("This node only handles xml strings or js objects."); }
+        }
+    });
+}
+RED.nodes.registerType("xml",XMLNode);