Merge pull request apache#65 from casbin/casbin-next

hsluoyz · web-flow · commit 157f0b5167f0 · 2019-04-29T12:59:08.000+08:00
Make all function to async function in rolemanager interface
diff --git a/src/casbin.ts b/src/casbin.ts
diff --git a/src/coreEnforcer.ts b/src/coreEnforcer.ts
@@ -16,11 +16,10 @@ import { compileAsync } from 'expression-eval';
 import * as _ from 'lodash';
 
 import { DefaultEffector, Effect, Effector } from './effect';
-import { FunctionMap, Model } from './model';
+import { FunctionMap, Model, newModel } from './model';
 import { Adapter, Filter, FilteredAdapter, Watcher } from './persist';
 import { DefaultRoleManager, RoleManager } from './rbac';
 import { generateGFunction } from './util';
-import { newModel } from './casbin';
 import { getLogger, logPrint } from './log';
 
 /**
@@ -242,8 +241,7 @@ export class CoreEnforcer {
    * role inheritance relations.
    */
   public async buildRoleLinks(): Promise<void> {
-    // error intentionally ignored
-    this.rm.clear();
+    await this.rm.clear();
     await this.model.buildRoleLinks(this.rm);
   }
 
diff --git a/src/enforcer.ts b/src/enforcer.ts
@@ -13,9 +13,9 @@
 // limitations under the License.
 
 import { ManagementEnforcer } from './managementEnforcer';
-import { FunctionMap, Model } from './model';
+import { FunctionMap, Model, newModel } from './model';
 import { Adapter, FileAdapter } from './persist';
-import { newModel } from './casbin';
+import { getLogger } from './log';
 
 /**
  * Enforcer = ManagementEnforcer + RBAC API.
@@ -303,3 +303,61 @@ export class Enforcer extends ManagementEnforcer {
     return res;
   }
 }
+
+/**
+ * newEnforcer creates an enforcer via file or DB.
+ *
+ * File:
+ * ```js
+ * const e = new Enforcer('path/to/basic_model.conf', 'path/to/basic_policy.csv');
+ * ```
+ *
+ * MySQL DB:
+ * ```js
+ * const a = new MySQLAdapter('mysql', 'mysql_username:mysql_password@tcp(127.0.0.1:3306)/');
+ * const e = new Enforcer('path/to/basic_model.conf', a);
+ * ```
+ *
+ * @param params
+ */
+export async function newEnforcer(...params: any[]): Promise<Enforcer> {
+  const e = new Enforcer();
+
+  let parsedParamLen = 0;
+  if (params.length >= 1) {
+    const enableLog = params[params.length - 1];
+    if (typeof enableLog === 'boolean') {
+      getLogger().enableLog(enableLog);
+      parsedParamLen++;
+    }
+  }
+
+  if (params.length - parsedParamLen === 2) {
+    if (typeof params[0] === 'string') {
+      if (typeof params[1] === 'string') {
+        await e.initWithFile(params[0].toString(), params[1].toString());
+      } else {
+        await e.initWithAdapter(params[0].toString(), params[1]);
+      }
+    } else {
+      if (typeof params[1] === 'string') {
+        throw new Error('Invalid parameters for enforcer.');
+      } else {
+        await e.initWithModelAndAdapter(params[0], params[1]);
+      }
+    }
+  } else if (params.length - parsedParamLen === 1) {
+    if (typeof params[0] === 'string') {
+      await e.initWithFile(params[0], '');
+    } else {
+      // @ts-ignore
+      await e.initWithModelAndAdapter(params[0], null);
+    }
+  } else if (params.length === parsedParamLen) {
+    await e.initWithFile('', '');
+  } else {
+    throw new Error('Invalid parameters for enforcer.');
+  }
+
+  return e;
+}
diff --git a/src/index.ts b/src/index.ts
@@ -20,6 +20,5 @@ export * from './effect';
 export * from './model';
 export * from './persist';
 export * from './rbac';
-export * from './casbin';
 export * from './log';
 export { Util };
diff --git a/src/model/assertion.ts b/src/model/assertion.ts
@@ -63,6 +63,6 @@ export class Assertion {
     }
 
     logPrint(`Role links for: ${this.key}`);
-    this.rm.printRoles();
+    await this.rm.printRoles();
   }
 }
diff --git a/src/model/model.ts b/src/model/model.ts
@@ -278,3 +278,22 @@ export class Model {
     });
   }
 }
+
+/**
+ * newModel creates a model.
+ */
+export function newModel(...text: string[]): Model {
+  const m = new Model();
+
+  if (text.length === 2) {
+    if (text[0] !== '') {
+      m.loadModel(text[0]);
+    }
+  } else if (text.length === 1) {
+    m.loadModelFromText(text[0]);
+  } else if (text.length !== 0) {
+    throw new Error('Invalid parameters for model.');
+  }
+
+  return m;
+}
diff --git a/src/rbac/defaultRoleManager.ts b/src/rbac/defaultRoleManager.ts
@@ -52,7 +52,7 @@ export class DefaultRoleManager implements RoleManager {
   /**
    * clear clears all stored data and resets the role manager to the initial state.
    */
-  public clear(): void {
+  public async clear() {
     this.allRoles = new Map<string, Role>();
   }
 
@@ -153,7 +153,7 @@ export class DefaultRoleManager implements RoleManager {
   /**
    * printRoles prints all the roles to log.
    */
-  public printRoles(): void {
+  public async printRoles() {
     [...this.allRoles.values()].map(n => {
       logPrint(n.toString());
     });
diff --git a/src/rbac/roleManager.ts b/src/rbac/roleManager.ts
@@ -15,7 +15,7 @@
 // RoleManager provides interface to define the operations for managing roles.
 export interface RoleManager {
   // Clear clears all stored data and resets the role manager to the initial state.
-  clear(): void;
+  clear(): Promise<void>;
   // AddLink adds the inheritance link between two roles. role: name1 and role: name2.
   // domain is a prefix to the roles (can be used for other purposes).
   addLink(name1: string, name2: string, ...domain: string[]): Promise<void>;
@@ -32,5 +32,5 @@ export interface RoleManager {
   // domain is a prefix to the users (can be used for other purposes).
   getUsers(name: string, ...domain: string[]): Promise<string[]>;
   // PrintRoles prints all the roles to log.
-  printRoles(): void;
+  printRoles(): Promise<void>;
 }

Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,6 @@ export class Assertion {`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	logPrint(`Role links for: ${this.key}`);
`66`		`- this.rm.printRoles();`
	`66`	`+ await this.rm.printRoles();`
`67`	`67`	`}`
`68`	`68`	`}`