From 909afe9fed2e8cef4809fa4cdbb57a0dd4a05d01 Mon Sep 17 00:00:00 2001 From: dceejay Date: Sat, 13 Jun 2015 18:47:00 +0100 Subject: [PATCH] Add mongo to node-red-node, fix lint etc --- storage/mongodb/66-mongodb.html | 231 +++++++++++++++++++++++++++++ storage/mongodb/66-mongodb.js | 250 ++++++++++++++++++++++++++++++++ storage/mongodb/LICENSE | 177 ++++++++++++++++++++++ storage/mongodb/README.md | 86 +++++++++++ storage/mongodb/package.json | 24 +++ 5 files changed, 768 insertions(+) create mode 100644 storage/mongodb/66-mongodb.html create mode 100644 storage/mongodb/66-mongodb.js create mode 100644 storage/mongodb/LICENSE create mode 100644 storage/mongodb/README.md create mode 100644 storage/mongodb/package.json diff --git a/storage/mongodb/66-mongodb.html b/storage/mongodb/66-mongodb.html new file mode 100644 index 00000000..1b448de9 --- /dev/null +++ b/storage/mongodb/66-mongodb.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + diff --git a/storage/mongodb/66-mongodb.js b/storage/mongodb/66-mongodb.js new file mode 100644 index 00000000..e5ed3238 --- /dev/null +++ b/storage/mongodb/66-mongodb.js @@ -0,0 +1,250 @@ +/** + * Copyright 2013,2015 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. + **/ + +module.exports = function(RED) { + "use strict"; + var mongo = require('mongodb'); + var MongoClient = mongo.MongoClient; + + function MongoNode(n) { + RED.nodes.createNode(this,n); + this.hostname = n.hostname; + this.port = n.port; + this.db = n.db; + this.name = n.name; + + var url = "mongodb://"; + if (this.credentials && this.credentials.user && this.credentials.password) { + url += this.credentials.user+":"+this.credentials.password+"@"; + } + url += this.hostname+":"+this.port+"/"+this.db; + + this.url = url; + } + + RED.nodes.registerType("mongodb",MongoNode,{ + credentials: { + user: {type:"text"}, + password: {type: "password"} + } + }); + + function ensureValidSelectorObject(selector) { + if (selector != null && (typeof selector != 'object' || Buffer.isBuffer(selector))) { + return {}; + } + return selector; + } + + + function MongoOutNode(n) { + RED.nodes.createNode(this,n); + this.collection = n.collection; + this.mongodb = n.mongodb; + this.payonly = n.payonly || false; + this.upsert = n.upsert || false; + this.multi = n.multi || false; + this.operation = n.operation; + this.mongoConfig = RED.nodes.getNode(this.mongodb); + + if (this.mongoConfig) { + var node = this; + MongoClient.connect(this.mongoConfig.url, function(err, db) { + if (err) { + node.error(err); + } else { + node.clientDb = db; + var coll; + if (node.collection) { + coll = db.collection(node.collection); + } + node.on("input",function(msg) { + if (!node.collection) { + if (msg.collection) { + coll = db.collection(msg.collection); + } else { + node.error("No collection defined",msg); + return; + } + } + delete msg._topic; + delete msg.collection; + if (node.operation === "store") { + if (node.payonly) { + if (typeof msg.payload !== "object") { + msg.payload = {"payload": msg.payload}; + } + if (msg.hasOwnProperty("_id") && !msg.payload.hasOwnProperty("_id")) { + msg.payload._id = msg._id; + } + coll.save(msg.payload,function(err, item) { + if (err) { + node.error(err,msg); + } + }); + } else { + coll.save(msg,function(err, item) { + if (err) { + node.error(err,msg); + } + }); + } + } else if (node.operation === "insert") { + if (node.payonly) { + if (typeof msg.payload !== "object") { + msg.payload = {"payload": msg.payload}; + } + if (msg.hasOwnProperty("_id") && !msg.payload.hasOwnProperty("_id")) { + msg.payload._id = msg._id; + } + coll.insert(msg.payload, function(err, item) { + if (err) { + node.error(err,msg); + } + }); + } else { + coll.insert(msg, function(err,item) { + if (err) { + node.error(err,msg); + } + }); + } + } else if (node.operation === "update") { + if (typeof msg.payload !== "object") { + msg.payload = {"payload": msg.payload}; + } + var query = msg.query || {}; + var payload = msg.payload || {}; + var options = { + upsert: node.upsert, + multi: node.multi + }; + + coll.update(query, payload, options, function(err, item) { + if (err) { + node.error(err,msg); + } + }); + } else if (node.operation === "delete") { + coll.remove(msg.payload, function(err, items) { + if (err) { + node.error(err,msg); + } + }); + } + }); + } + }); + } else { + this.error("missing mongodb configuration"); + } + + this.on("close", function() { + if (this.clientDb) { + this.clientDb.close(); + } + }); + } + RED.nodes.registerType("mongodb out",MongoOutNode); + + function MongoInNode(n) { + RED.nodes.createNode(this,n); + this.collection = n.collection; + this.mongodb = n.mongodb; + this.operation = n.operation || "find"; + this.mongoConfig = RED.nodes.getNode(this.mongodb); + + if (this.mongoConfig) { + var node = this; + MongoClient.connect(this.mongoConfig.url, function(err,db) { + if (err) { + node.error(err); + } else { + node.clientDb = db; + var coll; + if (node.collection) { + coll = db.collection(node.collection); + } + node.on("input", function(msg) { + if (!node.collection) { + if (msg.collection) { + coll = db.collection(msg.collection); + } else { + node.error("No collection defined"); + return; + } + } + var selector; + if (node.operation === "find") { + msg.projection = msg.projection || {}; + selector = ensureValidSelectorObject(msg.payload); + var limit = msg.limit; + if (typeof limit === "string" && !isNaN(limit)) { + limit = Number(limit); + } + var skip = msg.skip; + if (typeof skip === "string" && !isNaN(skip)) { + skip = Number(skip); + } + + coll.find(selector,msg.projection).sort(msg.sort).limit(limit).skip(skip).toArray(function(err, items) { + if (err) { + node.error(err); + } else { + msg.payload = items; + delete msg.projection; + delete msg.sort; + delete msg.limit; + delete msg.skip; + node.send(msg); + } + }); + } else if (node.operation === "count") { + selector = ensureValidSelectorObject(msg.payload); + coll.count(selector, function(err, count) { + if (err) { + node.error(err); + } else { + msg.payload = count; + node.send(msg); + } + }); + } else if (node.operation === "aggregate") { + msg.payload = (Array.isArray(msg.payload)) ? msg.payload : []; + coll.aggregate(msg.payload, function(err, result) { + if (err) { + node.error(err); + } else { + msg.payload = result; + node.send(msg); + } + }); + } + }); + } + }); + } else { + this.error("missing mongodb configuration"); + } + + this.on("close", function() { + if (this.clientDb) { + this.clientDb.close(); + } + }); + } + RED.nodes.registerType("mongodb in",MongoInNode); +} diff --git a/storage/mongodb/LICENSE b/storage/mongodb/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/storage/mongodb/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/storage/mongodb/README.md b/storage/mongodb/README.md new file mode 100644 index 00000000..727bbee2 --- /dev/null +++ b/storage/mongodb/README.md @@ -0,0 +1,86 @@ +node-red-node-mongodb +===================== + +A Node-RED node to save data in a MongoDB database. + +**Note** : This is the same node as is/was in the core of Node-RED. If you already +have it installed you do NOT need this node. + +Pre-requisite +------------- + +To run this you need a local MongoDB server running. For details see +the MongoDB site. + +Install +------- + +Run the following command in the root directory of your Node-RED install. +Usually this is `~/.node-red` . + + npm install node-red-node-mongodb + +Usage +----- + +Nodes to save and retrieve data in a local MongoDB instance. + +###Input + +Calls a MongoDB collection method based on the selected operator. + +*Find* queries a collection using the **msg.payload** as the query statement as +per the *.find()* function. + +Optionally, you may also (via a function) set + +- a **msg.projection** object to constrain the returned fields, +- a **msg.sort** object, +- a **msg.limit** number, +- a **msg.skip** number. + +*Count* returns a count of the number of documents in a collection or matching a +query using the **msg.payload** as the query statement. + +*Aggregate* provides access to the aggregation pipeline using the **msg.payload** as the pipeline array. + +You can either set the collection method in the node config or on **msg.collection**. +Setting it in the node will override **msg.collection**. + +See the *MongoDB collection methods docs* for examples. + +The result is returned in **msg.payload**. + +###Output + +A simple MongoDB output node. Can save, insert, update and remove objects from a chosen collection. + +MongoDB only accepts objects. + +Save and insert can either store **msg** or **msg.payload**. If msg.payload is +selected it should contain an object. If not it will be wrapped in an object with a name of payload. + +*Save* will update an existing object or insert a new object if one does not already exist. + +*Insert* will insert a new object. + +*Update* will modify an existing object or objects. The query to select objects +to update uses **msg.query** and the update to the element uses **msg.payload**. +Update can add a object if it does not exist or update multiple objects. + +*Remove* will remove objects that match the query passed in on **msg.payload**. +A blank query will delete *all of the objects* in the collection. + +You can either set the collection method in the node config or on **msg.collection**. +Setting it in the node will override **msg.collection**. + +By default MongoDB creates an **msg._id** property as the primary key - so +repeated injections of the same **msg** will result in many database entries. +If this is NOT the desired behaviour - ie. you want repeated entries to overwrite, +then you must set the **msg._id** property to be a constant by the use of a previous function node. +This must be done at the correct level. If only writing msg.payload then payload must contain the \_id property. +If writing the whole msg object then it must contain an \_id property. + +This could be a unique constant or you could create one based on some other msg property. + +Currently we do not limit or cap the collection size at all... diff --git a/storage/mongodb/package.json b/storage/mongodb/package.json new file mode 100644 index 00000000..32cfb177 --- /dev/null +++ b/storage/mongodb/package.json @@ -0,0 +1,24 @@ +{ + "name" : "node-red-node-mongodb", + "version" : "0.0.1", + "description" : "Node-RED nodes to talk to an Mongo database", + "dependencies" : { + "mongodb" : "1.3.6" + }, + "repository" : { + "type":"git", + "url":"https://github.com/node-red/node-red-nodes/tree/master/storage/mongodb" + }, + "license": "Apache-2.0", + "keywords": [ "node-red", "mongodb" ], + "node-red" : { + "nodes" : { + "mongo": "66-mongodb.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +}