feat: add firebase-access-controller

License: MIT
Signed-off-by: Vaibhav Saini <[email protected]>

Author: vasa-develop

src/firebase-access-controller.js

@@ -0,0 +1,108 @@
+"use strict";
+
+const EventEmitter = require("events").EventEmitter;
+const io = require("orbit-db-io");
+/**
+ * A Firebase based AccessController for AvionDB & OrbitDB
+ *
+ * A demo app using FirebaseAccessController
+ * https://github.com/dappkit/aviondb-firebase
+ *
+ */
+class FirebaseAccessController extends EventEmitter {
+  constructor(ipfs, options) {
+    super();
+    this._ipfs = ipfs;
+    this.firebase = options.firebase;
+    this.firebaseConfig = options.firebaseConfig;
+    if (this.firebase.apps.length === 0) {
+      this.firebase.initializeApp(this.firebaseConfig);
+    }
+  }
+
+  /*
+    Every AC needs to have a 'Factory' method
+    that creates an instance of the AccessController
+  */
+  static async create(orbitdb, options) {
+    console.log(options);
+    if (!options.firebaseConfig) {
+      throw new Error("you need to pass a firebaseConfig Object");
+    }
+    return new FirebaseAccessController(orbitdb._ipfs, options);
+  }
+
+  /* Return the type for this controller */
+  static get type() {
+    return "firebase-access-controller";
+  }
+
+  /*
+    Return the type for this controller
+  */
+  get type() {
+    return this.constructor.type;
+  }
+
+  /*
+    Called by the databases (the log) to see if entry should
+    be allowed in the database. Return true if the entry is allowed,
+    false is not allowed
+  */
+  async canAppend(entry, identityProvider) {
+    return new Promise((resolve, reject) => {
+      this.firebase.auth().onAuthStateChanged(async (user) => {
+        if (user) {
+          // A user is signed in
+          const verifiedIdentity = await identityProvider.verifyIdentity(
+            entry.identity
+          );
+          // Allow access if identity verifies
+          return resolve(verifiedIdentity);
+        } else {
+          // No user is signed in
+          return resolve(false);
+        }
+      });
+    });
+  }
+
+  /* Add access */
+  async grant(user) {
+    await this.firebase.auth().createUser(user);
+  }
+  /* Remove access */
+  async revoke() {
+    await this.firebase.auth().currentUser.delete();
+  }
+
+  /* AC creation and loading */
+  async load(address) {
+    if (address) {
+      try {
+        if (address.indexOf("/ipfs") === 0) {
+          address = address.split("/")[2];
+        }
+        const access = await io.read(this._ipfs, address);
+        this.firebaseConfig = access.firebaseConfig;
+      } catch (e) {
+        console.log("FirebaseAccessController.load ERROR:", e);
+      }
+    }
+  }
+  /* Returns AC manifest parameters object */
+  async save() {
+    let cid;
+    try {
+      cid = await io.write(this._ipfs, "dag-cbor", {
+        firebaseConfig: this.firebaseConfig,
+      });
+    } catch (e) {
+      console.log("FirebaseAccessController.save ERROR:", e);
+    }
+    // return the manifest data
+    return { address: cid };
+  }
+}
+
+export default FirebaseAccessController;