├── .github └── FUNDING.yml ├── .gitignore ├── .gitmodules ├── LICENSE ├── README.md ├── index.js ├── package-lock.json └── package.json /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [hardillb] 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "models"] 2 | path = models 3 | url = https://github.com/hardillb/node-red-contrib-mongo-models.git 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # node-red-contrib-storage-mongodb 2 | 3 | A storage plugin for Node-RED that uses MongoDB to store flows, library entries and settings 4 | 5 | ## Setup 6 | 7 | Add the following to `settings.js` 8 | 9 | ``` 10 | ... 11 | storageModule: require('node-red-contrib-storage-mongodb'), 12 | mongodbSettings: { 13 | mongoURI: process.env["MONGO_URL"], 14 | appname: process.env["APP_NAME"] 15 | }, 16 | ... 17 | ``` 18 | 19 | Where `mongoURI` is the location of a MongoDB database and `appname` is a unique identifier for this instance of Node-RED to allow multiple instances to use the same DB. 20 | 21 | It will use a collections with the following names 22 | 23 | - flow 24 | - credentials 25 | - settings 26 | - sessions 27 | - library -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | 2 | const mongoose = require('mongoose'); 3 | 4 | const Flows = require('./models/flows'); 5 | const Credentials = require('./models/credentials'); 6 | const Settings = require('./models/settings'); 7 | const Sessions = require('./models/sessions'); 8 | const Library = require('./models/library'); 9 | 10 | var mongoose_options = { 11 | useNewUrlParser: true, 12 | useUnifiedTopology: true, 13 | useFindAndModify: false, 14 | useCreateIndex: true 15 | }; 16 | 17 | var settings; 18 | var appname; 19 | 20 | const mongoStorage = { 21 | init: function(nrSettings) { 22 | settings = nrSettings.mongodbSettings || {}; 23 | 24 | if (!settings) { 25 | var err = Promise.reject("No MongoDB settings for flow storage found"); 26 | err.catch(err => {}); 27 | return err; 28 | } 29 | 30 | appname = settings.appname; 31 | 32 | return new Promise(function(resolve, reject){ 33 | mongoose.connect(settings.mongoURI, mongoose_options) 34 | .then(() => { 35 | // console.log("connected to storage db"); 36 | resolve(); 37 | }) 38 | .catch(err => { 39 | reject(err); 40 | }); 41 | }) 42 | }, 43 | getFlows: function() { 44 | return new Promise(function(resolve, reject) { 45 | Flows.findOne({appname: appname}, function(err, flows){ 46 | if (err) { 47 | reject(err); 48 | } else { 49 | if (flows){ 50 | resolve(flows.flow); 51 | } else { 52 | resolve([]); 53 | } 54 | } 55 | }) 56 | }) 57 | }, 58 | saveFlows: function(flows) { 59 | return new Promise(function(resolve, reject) { 60 | Flows.findOneAndUpdate({appname: appname},{flow: flows}, {upsert: true}, function(err,flow){ 61 | if (err) { 62 | reject(err) 63 | } else { 64 | resolve(); 65 | } 66 | }) 67 | }) 68 | }, 69 | getCredentials: function() { 70 | return new Promise(function(resolve, reject) { 71 | Credentials.findOne({appname: appname}, function(err, creds){ 72 | if (err) { 73 | reject(err); 74 | } else { 75 | if (creds){ 76 | resolve(JSON.parse(creds.credentials)); 77 | } else { 78 | resolve({}); 79 | } 80 | } 81 | }) 82 | }) 83 | }, 84 | saveCredentials: function(credentials) { 85 | return new Promise(function(resolve, reject) { 86 | Credentials.findOneAndUpdate({appname: appname},{credentials: JSON.stringify(credentials)}, {upsert: true}, function(err,credentials){ 87 | if (err) { 88 | reject(err) 89 | } else { 90 | resolve(); 91 | } 92 | }) 93 | }) 94 | }, 95 | getSettings: function() { 96 | // console.log("looking for settings") 97 | return new Promise(function(resolve, reject) { 98 | Settings.findOne({appname: appname}, function(err, setts){ 99 | if (err) { 100 | reject(err); 101 | } else { 102 | if (setts) { 103 | // console.log("settings found"); 104 | resolve(setts.settings); 105 | } else { 106 | resolve({}); 107 | } 108 | } 109 | }) 110 | }) 111 | }, 112 | saveSettings: function(settings) { 113 | return new Promise(function(resolve, reject) { 114 | Settings.findOneAndUpdate({appname: appname},{settings: settings}, {upsert: true, useFindAndModify: false}, function(err,settings){ 115 | if (err) { 116 | reject(err) 117 | } else { 118 | resolve(); 119 | } 120 | }) 121 | }) 122 | }, 123 | getSessions: function() { 124 | // console.log("looking for session"); 125 | return new Promise(function(resolve, reject) { 126 | Sessions.findOne({appname: appname}, function(err, sessions){ 127 | if (err) { 128 | reject(err); 129 | } else { 130 | if (sessions) { 131 | // console.log("found session") 132 | resolve(sessions.sessions); 133 | } else { 134 | resolve({}); 135 | } 136 | } 137 | }) 138 | }) 139 | }, 140 | saveSessions: function(sessions) { 141 | return new Promise(function(resolve, reject) { 142 | Sessions.findOneAndUpdate({appname: appname},{sessions: sessions}, 143 | {upsert: true, useFindAndModify: false}, 144 | function(err,sessions){ 145 | if (err) { 146 | reject(err) 147 | } else { 148 | resolve(); 149 | } 150 | }) 151 | }) 152 | }, 153 | getLibraryEntry: function(type,name) { 154 | if (name == "") { 155 | name = "/" 156 | } else if (name.substr(0,1) != "/") { 157 | name = "/" + name 158 | } 159 | 160 | return new Promise(function(resolve,reject) { 161 | Library.findOne({appname: appname, type: type, name: name}, function(err, file){ 162 | if (err) { 163 | reject(err); 164 | } else if (file) { 165 | resolve(file.body); 166 | } else { 167 | var reg = new RegExp('^' + name , ""); 168 | Library.find({appname: appname, type: type, name: reg }, function(err, fileList){ 169 | if (err) { 170 | reject(err) 171 | } else { 172 | var dirs = []; 173 | var files = []; 174 | 175 | for (var i=0; i