From 7ef175962101cf7479a79af258e03a1672c7d9b5 Mon Sep 17 00:00:00 2001 From: Dave C-J Date: Fri, 4 Jul 2014 16:12:00 +0100 Subject: [PATCH] Add sqlite node to node-red-nodes (and npm) --- storage/sqlite/LICENSE | 201 ++++++++++++++++++++++++++ storage/sqlite/README.md | 16 ++ storage/sqlite/nodes/icons/sqlite.png | Bin 0 -> 1124 bytes storage/sqlite/nodes/sqlite.html | 77 ++++++++++ storage/sqlite/nodes/sqlite.js | 80 ++++++++++ storage/sqlite/package.json | 24 +++ 6 files changed, 398 insertions(+) create mode 100644 storage/sqlite/LICENSE create mode 100644 storage/sqlite/README.md create mode 100644 storage/sqlite/nodes/icons/sqlite.png create mode 100644 storage/sqlite/nodes/sqlite.html create mode 100644 storage/sqlite/nodes/sqlite.js create mode 100644 storage/sqlite/package.json diff --git a/storage/sqlite/LICENSE b/storage/sqlite/LICENSE new file mode 100644 index 00000000..ad410e11 --- /dev/null +++ b/storage/sqlite/LICENSE @@ -0,0 +1,201 @@ +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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + 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. \ No newline at end of file diff --git a/storage/sqlite/README.md b/storage/sqlite/README.md new file mode 100644 index 00000000..0ac7335d --- /dev/null +++ b/storage/sqlite/README.md @@ -0,0 +1,16 @@ +node-red-contrib-sqlite +======================= +A Node-Red node to read and write a local sqlite database. + +Install +------- + +Run the following command in the root directory of your Node-RED install + + npm install node-red-contrib-sqlite + + +Usage +----- + +tbd diff --git a/storage/sqlite/nodes/icons/sqlite.png b/storage/sqlite/nodes/icons/sqlite.png new file mode 100644 index 0000000000000000000000000000000000000000..c4a82f949ff8e89f6f3ac90c8f84d9fb8bf6157d GIT binary patch literal 1124 zcmV-q1e^PbP)C3<00001b5ch_0Itp) z=>Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01FcU01FcV0GgZ_000B`NkliGaw34F(K+k7siDecW#Uyw7(FI3C0b<6}WI?Oe7}iXpk{P z1hfYRn1P<2>N#%CO-{<8tGfHr<4r16UEN*v)O+4@?x`y>3^NmeBr~(mfIYy&KpWTq z`jWbJ*HI1-N#@620f&5h#DB5{TmpWV^zj3ONg%GqlfVnW0#K%(04?9I0Kbk>s67o# z067Lc3v>cVdf070eh#=Y>UzbrJ^}UtOAe9% zwvZjhK|Tjw2Ij-f(lz_QbxFqpoH7Q>~!xpOW78@RSwR zl4mx6^;`xnytqXl2)O4y`N6}(4#lqkt_SZ-1`|^GAh1}upatodb_h=zrPrO4Q^BMe z*(bp=c*THH(ko_mAtZw;u!S4|Jw(e8ZQtkOL3yc@I_|ye3 zko3BleFr=?qDAQgmn$Kk*fXcSQBvi9zxeT?5ylj7C8-iZJ|0YXiUYtymHA~|(pzTs zt*c^{jZkq{#!1&Y<1U1nLd7dDx+hfG%nRX9l0K;mPoprI*_V~lFW`=(H_hyu(5qM_ zgId5;xy9ey|8*ccy!&PSY$PIrj`A1TBoDkK*nAv4Xht2GUtFq)@%?CBMfi+1- z@Ap2HOPPJ4igx@a=e-(l0hM9_|Ffj-xFAgoyy>d6!z8%qpUs=8o|)b8bHAnV zOw#BVHIw9lP-Fh~{S&_5V`jJf`z_#tq>m;EPm>DV3t7~WblkIOZijcIWng{WR367O z9Wz_?@FeK{ejNMTtKR8#nR1K@Qwl*lG}6xmkhae~%j1;%NtL+R^UVmP}^_Gw?>d qwW}~*`cH;6xm{N#tt1R*0rM};3dp;J@DR=b0000 + + + + + + + + + + + diff --git a/storage/sqlite/nodes/sqlite.js b/storage/sqlite/nodes/sqlite.js new file mode 100644 index 00000000..9a7e3b34 --- /dev/null +++ b/storage/sqlite/nodes/sqlite.js @@ -0,0 +1,80 @@ +/** + * 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. + **/ + +module.exports = function(RED) { + "use strict"; + var reconnect = RED.settings.sqliteReconnectTime || 20000; + var sqlite3 = require('sqlite3'); + + function SqliteNodeDB(n) { + RED.nodes.createNode(this,n); + + this.dbname = n.db; + var node = this; + + node.doConnect = function() { + node.db = new sqlite3.Database(node.dbname); + node.db.on('open',function(err) { + if (node.tick) { clearTimeout(node.tick); } + node.log("opened "+node.dbname+" ok"); + }); + node.db.on('error', function(err) { + node.warn(err); + node.log("failed to open "+node.dbname); + node.tick = setTimeout(doConnect, reconnect); + }); + } + + node.on('close', function () { + if (node.tick) { clearTimeout(node.tick); } + if (node.db) { node.db.close(); } + }); + } + RED.nodes.registerType("sqlitedb",SqliteNodeDB); + + + function SqliteNodeIn(n) { + RED.nodes.createNode(this,n); + this.mydb = n.mydb; + this.mydbConfig = RED.nodes.getNode(this.mydb); + + if (this.mydbConfig) { + this.mydbConfig.doConnect(); + var node = this; + node.on("input", function(msg) { + if (typeof msg.topic === 'string') { + //console.log("query:",msg.topic); + node.mydbConfig.db.all(msg.topic, function(err, row) { + if (err) { node.warn(err); } + else { + msg.payload = row; + node.send(msg); + } + }); + } + else { + if (typeof msg.topic !== 'string') { + node.error("msg.topic : the query is not defined as a string"); + } + } + }); + } + else { + this.error("Sqlite database not configured"); + } + } + RED.nodes.registerType("sqlite",SqliteNodeIn); +} diff --git a/storage/sqlite/package.json b/storage/sqlite/package.json new file mode 100644 index 00000000..e5fcd20b --- /dev/null +++ b/storage/sqlite/package.json @@ -0,0 +1,24 @@ +{ + "name" : "node-red-contrib-sqlite", + "version" : "0.0.2", + "description" : "A sqlite node for Node-RED", + "dependencies" : { + "sqlite3" : "2.x" + }, + "repository" : { + "type":"git", + "url":"https://github.com/dceejay/node-red-contrib-sqlite.git" + }, + "license": "Apache", + "keywords": [ "node-red", "sqlite" ], + "node-red" : { + "nodes" : { + "sqlite": "nodes/sqlite.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +}