clean database name and fix fields that start with _ in the document

Author: lgfa29

77-cloudant-cf.html

@@ -186,7 +186,7 @@
             service: { value: "", required: true },
             cloudant: { type: "cloudant", validate: validateServer},
             name: { value: "" },
-            database: { value: "", required: true },
+            database: { value: "", required: true, validate: validateDatabase },
             payonly: { value: false },
             operation: { value: "insert" }
         },
@@ -208,7 +208,7 @@
             service : { value: "", required: true },
             cloudant: { type: "cloudant", validate: validateServer },
             name    : { value: "" },
-            database: { value: "", required: true },
+            database: { value: "", required: true, validate: validateDatabase },
             search  : { value: "_id_", required: true },
             design  : { value: "" },
             index   : { value: "" }
@@ -286,6 +286,12 @@
     function validateServer(v) {
         return this.service != "_ext_" || v != "_ADD_";
     }
+
+    // https://wiki.apache.org/couchdb/HTTP_database_API#Naming_and_Addressing
+    function validateDatabase(v) {
+        return (v.indexOf('_') !== 0) &&
+               (v.search(/[A-Z\s\\/]/g) < 0)
+    }
 </script>
 
 <script type="text/x-red" data-help-name="cloudant out">
@@ -307,11 +313,25 @@
     </p>
     <p>
         It is also possible to <b>delete</b> documents from the database by
-        providing values for <code>_id</b> and <code>_rev</code> and selecting
+        providing values for <code>_id</code> and <code>_rev</code> and selecting
         the <b>remove</b> option for the node. You can pass these values in the
         <code>msg</code> object itself or as an object in the
         <code>msg.payload</code>.
     </p>
+    <p>
+        The <b>database name</b> must follow these rules:
+        <ul>
+            <li>No spaces</li>
+            <li>All letters in small caps</li>
+            <li>The first character can't be <code>_</code></li>
+        </ul>
+    </p>
+    <p>
+        Your document should avoid having top-level fields that start with
+        <code>_</code>, with exceptions for <code>_id</code>, <code>_rev</code>
+        and other <a href="https://wiki.apache.org/couchdb/HTTP_Document_API#Special_Fields">
+        CouchDB reserved words</a>.
+    </p>
 </script>
 
 <script type="text/x-red" data-help-name="cloudant in">
@@ -338,15 +358,29 @@
     </p>
     <p>
         When querying using a <b>Search Index</b> you can pass the search
-        parameters as an object in <code>msg.payload</code>. For example, you
-        can pass an object like this: <code>{ query: "abc*", limit: 100 }</code>
+        parameters as an object in <code>msg.payload</code>.
+    </p>
+    <p>
+        For example, you can pass an object like this:
+    <p>
+        <code>{ query: "abc*", limit: 100 }</code>
+    </p>
+    <p>
         to change the value of <code>limit</code>. You can find more information
-        on the accepted parameters in the <a
+        about <b>Search Index</b> parameters in the <a
         href="https://docs.cloudant.com/api.html?http#queries" target="_blank">
         official Cloudant documentation</a>.
     </p>
     <p>
         The last method to retrieve documents is to simply get all of them by
         selecting the option <b>all documents</b>.
     </p>
+    <p>
+        The <b>database name</b> must follow these rules:
+        <ul>
+            <li>No spaces</li>
+            <li>All letters in small caps</li>
+            <li>The first character can't be <code>_</code></li>
+        </ul>
+    </p>
 </script>

77-cloudant-cf.js

@@ -116,7 +116,7 @@ module.exports = function(RED) {
 
         this.operation      = n.operation;
         this.payonly        = n.payonly || false;
-        this.database       = n.database;
+        this.database       = _cleanDatabaseName(n.database, this);
         this.cloudantConfig = _getCloudantConfig(n);
 
         var node = this;
@@ -187,9 +187,36 @@ module.exports = function(RED) {
                     msg = JSON.parse('{"' + root + '":"' + msg + '"}');
                 }
             }
+            return cleanMessage(msg);
+        }
+
+        // fix field values that start with _
+        // https://wiki.apache.org/couchdb/HTTP_Document_API#Special_Fields
+        function cleanMessage(msg) {
+            for (var key in msg) {
+                if (msg.hasOwnProperty(key) && !isFieldNameValid(key)) {
+                    // remove _ from the start of the field name
+                    var newKey = key.substring(1, msg.length);
+
+                    msg[newKey] = msg[key];
+                    delete msg[key];
+
+                    node.warn("Property '" + key + "' renamed to '" + newKey + "'.");
+                }
+            }
+
             return msg;
         }
 
+        function isFieldNameValid(key) {
+            var allowedWords = [
+                '_id', '_rev', '_attachments', '_deleted', '_revisions',
+                '_revs_info', '_conflicts', '_deleted_conflicts', '_local_seq'
+            ];
+
+            return key[0] !== '_' || allowedWords.indexOf(key) >= 0;
+        }
+
         // Inserts a document +doc+ in a database +db+ that migh not exist
         // beforehand. If the database doesn't exist, it will create one
         // with the name specified in +db+. To prevent loops, it only tries
@@ -214,7 +241,7 @@ module.exports = function(RED) {
         RED.nodes.createNode(this,n);
 
         this.cloudantConfig = _getCloudantConfig(n);
-        this.database       = n.database;
+        this.database       = _cleanDatabaseName(n.database, this);
         this.search         = n.search;
         this.design         = n.design;
         this.index          = n.index;
@@ -245,7 +272,7 @@ module.exports = function(RED) {
                         options.query = options.query || options.q || formatSearchQuery(msg.payload);
                         options.include_docs = options.include_docs || true;
                         options.limit = options.limit || 200;
-                        
+
                         if (options.sort) {
                             options.sort = JSON.stringify(options.sort);
                         }
@@ -331,4 +358,23 @@ module.exports = function(RED) {
             return appEnv.getService(n.service);
         }
     }
+
+    // remove invalid characters from the database name
+    // https://wiki.apache.org/couchdb/HTTP_database_API#Naming_and_Addressing
+    function _cleanDatabaseName(database, node) {
+        var newDatabase = database;
+
+        // caps are not allowed
+        newDatabase = newDatabase.toLowerCase();
+        // remove trailing underscore
+        newDatabase = newDatabase.replace(/^_/, '');
+        // remove spaces and slashed
+        newDatabase = newDatabase.replace(/[\s\\/]+/g, '-');
+
+        if (newDatabase !== database) {
+            node.warn("Database renamed  as '" + newDatabase + "'.");
+        }
+
+        return newDatabase;
+    }
 };