add versions

Author: skadefro

OpenFlow/src/Config.ts

@@ -31,6 +31,7 @@ export class Config {
     public static mongodb_db: string = Config.getEnv("mongodb_db", "openflow");
 
     public static aes_secret: string = Config.getEnv("aes_secret", "");
+    public static skip_history_collections: string = Config.getEnv("skip_history_collections", "");
 
     public static baseurl(): string {
         if (Config.tls_crt != '' && Config.tls_key != '') {

OpenFlow/src/DatabaseConnection.ts

@@ -100,10 +100,10 @@ export class DatabaseConnection {
         if (collectionname === "fs.files") {
             _query = { $and: [query, this.getbasequery(jwt, "metadata._acl", [Rights.read])] };
         } else {
-            if (!collectionname.endsWith("hist")) {
+            if (!collectionname.endsWith("_hist")) {
                 _query = { $and: [query, this.getbasequery(jwt, "_acl", [Rights.read])] };
             } else {
-                // todo: enforcer permissions when fetching hist ?
+                // todo: enforcer permissions when fetching _hist ?
                 _query = query;
             }
         }
@@ -259,12 +259,15 @@ export class DatabaseConnection {
         j = ((j as any) === 'true' || j === true);
         w = parseInt((w as any));
 
+        item._version = await this.SaveDiff(collectionname, null, item);
+
         // var options:CollectionInsertOneOptions = { writeConcern: { w: parseInt((w as any)), j: j } };
         var options: CollectionInsertOneOptions = { w: w, j: j };
         //var options: CollectionInsertOneOptions = { w: "majority" };
         var result: InsertOneWriteOpResult = await this.db.collection(collectionname).insertOne(item, options);
         item = result.ops[0];
 
+
         if (collectionname === "users" && item._type === "user") {
             var users: Role = await Role.FindByNameOrId("users", jwt);
             users.AddMember(item);
@@ -307,13 +310,14 @@ export class DatabaseConnection {
         var user: TokenUser = Crypt.verityToken(q.jwt);
         if (!this.hasAuthorization(user, q.item, "update")) { throw new Error("Access denied"); }
 
+        var original: T = null;
         // assume empty query, means full document, else update document
         if (q.query === null || q.query === undefined) {
             // this will add an _acl so needs to be after we checked old item
             if (!q.item.hasOwnProperty("_id")) {
                 throw Error("Cannot update item without _id");
             }
-            var original: T = await this.getbyid<T>(q.item._id, q.collectionname, q.jwt);
+            original = await this.getbyid<T>(q.item._id, q.collectionname, q.jwt);
             if (!original) { throw Error("item not found!"); }
             q.item._modifiedby = user.name;
             q.item._modifiedbyid = user._id;
@@ -346,8 +350,12 @@ export class DatabaseConnection {
                 if (q.collectionname != "audit") { this._logger.debug("Adding self " + user.username + " to object " + (q.item.name || q.item._name)); }
                 q.item.addRight(user._id, user.name, [Rights.full_control]);
             }
+            q.item._version = await this.SaveDiff(q.collectionname, original, q.item);
         } else {
             itemReplace = false;
+            var _version = await this.SaveUpdateDiff(q, user);
+            if ((q.item["$set"]) === undefined) { (q.item["$set"]) = {} };
+            (q.item["$set"])._version = _version;
         }
 
         if (q.collectionname === "users" && q.item._type === "user" && q.item.hasOwnProperty("newpassword")) {
@@ -365,10 +373,10 @@ export class DatabaseConnection {
         if (q.collectionname === "fs.files") {
             _query = { $and: [q.query, this.getbasequery(q.jwt, "metadata._acl", [Rights.update])] };
         } else {
-            if (!q.collectionname.endsWith("hist")) {
+            if (!q.collectionname.endsWith("_hist")) {
                 _query = { $and: [q.query, this.getbasequery(q.jwt, "_acl", [Rights.update])] };
             } else {
-                // todo: enforcer permissions when fetching hist ?
+                // todo: enforcer permissions when fetching _hist ?
                 _query = q.query;
             }
         }
@@ -386,15 +394,17 @@ export class DatabaseConnection {
                 (q.item["$set"])._modifiedby = user.name;
                 (q.item["$set"])._modifiedbyid = user._id;
                 (q.item["$set"])._modified = new Date(new Date().toISOString());
+                if ((q.item["$inc"]) === undefined) { (q.item["$inc"]) = {} };
+                (q.item["$inc"])._version = 1;
                 q.opresult = await this.db.collection(q.collectionname).updateOne(_query, q.item, options);
             }
             q.item = this.decryptentity<T>(q.item);
             this.traversejsondecode(q.item);
             q.result = q.item;
-            return q;
         } catch (error) {
             throw error;
         }
+        return q;
     }
     /**
     * Update multiple documents in database based on update document
@@ -429,10 +439,10 @@ export class DatabaseConnection {
         if (q.collectionname === "fs.files") {
             _query = { $and: [q.query, this.getbasequery(q.jwt, "metadata._acl", [Rights.read])] };
         } else {
-            if (!q.collectionname.endsWith("hist")) {
+            if (!q.collectionname.endsWith("_hist")) {
                 _query = { $and: [q.query, this.getbasequery(q.jwt, "_acl", [Rights.read])] };
             } else {
-                // todo: enforcer permissions when fetching hist ?
+                // todo: enforcer permissions when fetching _hist ?
                 _query = q.query;
             }
         }
@@ -540,8 +550,6 @@ export class DatabaseConnection {
         this._logger.debug("deleting " + id + " in database");
         var res: DeleteWriteOpResultObject = await this.db.collection(collectionname).deleteOne(_query);
 
-
-
         // var res:DeleteWriteOpResultObject = await this.db.collection(collectionname).deleteOne({_id:id});
         // var res:DeleteWriteOpResultObject = await this.db.collection(collectionname).deleteOne(id);
         if (res.deletedCount === 0) { throw Error("item not found!"); }
@@ -780,4 +788,129 @@ export class DatabaseConnection {
 
     }
 
+    async SaveUpdateDiff<T extends Base>(q: UpdateOneMessage<T>, user: TokenUser) {
+        var _skip_array: string[] = Config.skip_history_collections.split(",");
+        var skip_array: string[] = [];
+        _skip_array.forEach(x => skip_array.push(x.trim()));
+        if (skip_array.indexOf(q.collectionname) > -1) { return 0; }
+        var res = await this.query<T>(q.query, null, 1, 0, null, q.collectionname, q.jwt);
+        if (res.length > 0) {
+            var _version = 1;
+            var original = res[0];
+
+            delete original._modifiedby;
+            delete original._modifiedbyid;
+            delete original._modified;
+            if (original._version != undefined && original._version != null) {
+                _version = original._version + 1;
+            }
+        }
+        var updatehist = {
+            _modified: new Date(new Date().toISOString()),
+            _modifiedby: user.name,
+            _modifiedbyid: user._id,
+            _created: new Date(new Date().toISOString()),
+            _createdby: user.name,
+            _createdbyid: user._id,
+            name: original.name,
+            id: original._id,
+            update: q.item,
+            _version: _version,
+            reason: ""
+        }
+        await this.db.collection(q.collectionname + '_hist').insertOne(updatehist);
+    }
+    async SaveDiff(collectionname: string, original: any, item: any) {
+        if (item._type == 'instance' && collectionname == 'workflows') return 0;
+        if (item._type == 'instance' && collectionname == 'workflows') return 0;
+        var _modified = item._modified;
+        var _modifiedby = item._modifiedby;
+        var _modifiedbyid = item._modifiedbyid;
+        var _version = 0;
+        var _acl = item._acl;
+        var _type = item._type;
+        var reason = item._updatereason;
+        try {
+            var _skip_array: string[] = Config.skip_history_collections.split(",");
+            var skip_array: string[] = [];
+            _skip_array.forEach(x => skip_array.push(x.trim()));
+            if (skip_array.indexOf(collectionname) > -1) { return 0; }
+
+            if (original != null) {
+                delete original._modifiedby;
+                delete original._modifiedbyid;
+                delete original._modified;
+                if (original._version != undefined && original._version != null) {
+                    _version = original._version + 1;
+                }
+            }
+            var jsondiffpatch = require('jsondiffpatch').create({
+                objectHash: function (obj, index) {
+                    // try to find an id property, otherwise just use the index in the array
+                    return obj.name || obj.id || obj._id || '$$index:' + index;
+                }
+            });
+            var delta: any = null;
+            // for backward comp, we cannot assume all objects have an history
+            // we create diff from version 0
+            // var delta_collections = Config.history_delta_collections.split(',');
+            // var full_collections = Config.history_full_collections.split(',');
+            // if (delta_collections.indexOf(collectionname) == -1 && full_collections.indexOf(collectionname) == -1) return 0;
+
+            item._version = _version;
+            delete item._modifiedby;
+            delete item._modifiedbyid;
+            delete item._modified;
+            delete item._updatereason;
+
+            // if (original != null && _version > 0 && delta_collections.indexOf(collectionname) > -1) {
+            if (original != null && _version > 0) {
+                delta = jsondiffpatch.diff(original, item);
+                if (delta == undefined || delta == null) return 0;
+                var deltahist = {
+                    _acl: _acl,
+                    _type: _type,
+                    _modified: _modified,
+                    _modifiedby: _modifiedby,
+                    _modifiedbyid: _modifiedbyid,
+                    _created: _modified,
+                    _createdby: _modifiedby,
+                    _createdbyid: _modifiedbyid,
+                    name: item.name,
+                    id: item._id,
+                    item: original,
+                    delta: delta,
+                    _version: _version,
+                    reason: reason
+                }
+                await this.db.collection(collectionname + '_hist').insertOne(deltahist);
+            }
+            else {
+                var fullhist = {
+                    _acl: _acl,
+                    _type: _type,
+                    _modified: _modified,
+                    _modifiedby: _modifiedby,
+                    _modifiedbyid: _modifiedbyid,
+                    _created: _modified,
+                    _createdby: _modifiedby,
+                    _createdbyid: _modifiedbyid,
+                    name: item.name,
+                    id: item._id,
+                    item: item,
+                    _version: _version,
+                    reason: reason
+                }
+                await this.db.collection(collectionname + '_hist').insertOne(fullhist);
+            }
+            item._modifiedby = _modifiedby;
+            item._modifiedbyid = _modifiedbyid;
+            item._modified = _modified;
+        } catch (error) {
+            this._logger.error(error);
+        }
+        return _version;
+    }
+
+
 }

OpenFlow/src/base.ts

@@ -9,7 +9,7 @@ export class WellknownIds {
     static nodered_users: string = "5a23f18a2e8987292ddbe061";
     static nodered_admins: string = "5a17f157c4815318c8536c20";
     static nodered_api_users: string = "5a17f157c4815318c8536c22";
-    
+
     static filestore_users: string = "5b6ab63c8d4a64b7c47f4a8f";
     static filestore_admins: string = "5b6ab63c8d4a64b7c47f4a8e";
     static robot_users: string = "5aef0142f3683977b0aa3dd3";
@@ -25,28 +25,28 @@ export class Rights {
     static full_control = -1;
 }
 interface IBase {
-    _id:string;
-    _type:string;
-    name:string;
-    getRight(_id:string, deny:boolean):Ace;
-    addRight(_id:string,name:string, Rights:number[],deny:boolean):void;
-    removeRight(_id:string,Rights:number[],deny:boolean):void;
+    _id: string;
+    _type: string;
+    name: string;
+    getRight(_id: string, deny: boolean): Ace;
+    addRight(_id: string, name: string, Rights: number[], deny: boolean): void;
+    removeRight(_id: string, Rights: number[], deny: boolean): void;
 }
 export class Base implements IBase {
-    _id:string;
-    _type:string = "unknown";
-    _acl:Ace[] = [];
-    name:string;
-    _name:string;
-    _encrypt:string[] = [];
+    _id: string;
+    _type: string = "unknown";
+    _acl: Ace[] = [];
+    name: string;
+    _name: string;
+    _encrypt: string[] = [];
 
     _createdbyid: string;
     _createdby: string;
     _created: Date;
     _modifiedbyid: string;
     _modifiedby: string;
     _modified: Date;
-    _version: Number = 0;
+    _version: number = 0;
     constructor() {
         this.addRight(WellknownIds.admins, "admins", [Rights.full_control]);
     }
@@ -55,7 +55,7 @@ export class Base implements IBase {
      * @param  {T} o Base object
      * @returns T New object as Type
      */
-    static assign<T>(o:T): T {
+    static assign<T>(o: T): T {
         return Object.assign(new Base(), o);
     }
     /**
@@ -64,16 +64,16 @@ export class Base implements IBase {
      * @param  {boolean=false} deny look for deny or allow permission
      * @returns Ace Ace if found, else null
      */
-    getRight(_id:string, deny:boolean=false):Ace {
-        var result:Ace = null;
-        if(!this._acl) { this._acl = []; }
+    getRight(_id: string, deny: boolean = false): Ace {
+        var result: Ace = null;
+        if (!this._acl) { this._acl = []; }
         this._acl.forEach((a, index) => {
-            if(a._id===_id && a.deny===deny) {
+            if (a._id === _id && a.deny === deny) {
                 this._acl[index] = Ace.assign(a);
                 result = this._acl[index];
             }
         });
-        if(result) {
+        if (result) {
             result = Ace.assign(result);
         }
         return result;
@@ -83,10 +83,10 @@ export class Base implements IBase {
      * @param  {Ace} x
      * @returns void
      */
-    setRight(x:Ace): void {
-        if(!this._acl) { this._acl = []; }
+    setRight(x: Ace): void {
+        if (!this._acl) { this._acl = []; }
         this._acl.forEach((a, index) => {
-            if(a._id===x._id && a.deny===x.deny) {
+            if (a._id === x._id && a.deny === x.deny) {
                 this._acl[index] = x;
             }
         });
@@ -99,10 +99,10 @@ export class Base implements IBase {
      * @param  {boolean=false} deny Deny the right
      * @returns void
      */
-    addRight(_id:string,name:string, rights:number[],deny:boolean=false):void {
-        var right:Ace = this.getRight(_id, deny);
-        if(!right) { right = new Ace(); this._acl.push(right); }
-        right.deny = deny;right._id = _id; right.name = name;
+    addRight(_id: string, name: string, rights: number[], deny: boolean = false): void {
+        var right: Ace = this.getRight(_id, deny);
+        if (!right) { right = new Ace(); this._acl.push(right); }
+        right.deny = deny; right._id = _id; right.name = name;
         rights.forEach(bit => {
             right.setBit(bit);
         });
@@ -115,10 +115,10 @@ export class Base implements IBase {
      * @param  {boolean=false} deny Deny right
      * @returns void
      */
-    removeRight(_id:string,rights:number[]=null,deny:boolean=false): void {
-        if(!this._acl) { this._acl = []; }
-        var right:Ace = this.getRight(_id, deny);
-        if(!right) { return; }
+    removeRight(_id: string, rights: number[] = null, deny: boolean = false): void {
+        if (!this._acl) { this._acl = []; }
+        var right: Ace = this.getRight(_id, deny);
+        if (!right) { return; }
         rights.forEach(bit => {
             right.unsetBit(bit);
         });