hola-server 0.6.8 → 0.6.10

package/core/meta.js

@@ -1,6 +1,6 @@
 const { is_undefined } = require('./validate');
 const { get_type } = require('./type');
-const { is_valid_role } = require('../setting');
+const { validate_meta_role } = require('./role');
 
 const meta_manager = {};
 /**
@@ -191,6 +191,7 @@ const get_all_metas = () => {
     return Object.keys(meta_manager);
 }
 
+
 /**
  * Wrap the meta info from user side:
  * 1) validate the meta structure and keep it is valid
@@ -212,6 +213,17 @@ class EntityMeta {
         this.exportable = is_undefined(meta.exportable) ? false : meta.exportable;
         this.editable = this.creatable || this.updatable;
 
+        //b:batch mode, c:create, d:delete, e:export, i:import, o:clone, p:page, r: refresh, s:search, u:update
+        const modes = [];
+        this.creatable && (modes.push("c"));
+        this.readable && (modes.push("rps"));
+        this.updatable && (modes.push("u"));
+        this.deleteable && (modes.push("db"));
+        this.cloneable && (modes.push("o"));
+        this.importable && (modes.push("i"));
+        this.exportable && (modes.push("e"));
+        this.mode = modes.join("");
+
         this.ref_label = this.meta.ref_label;
         this.ref_filter = this.meta.ref_filter;
         this.ref_fields = this.meta.fields.filter(field => field.ref);
@@ -287,10 +299,11 @@ class EntityMeta {
             if (!Array.isArray(this.roles)) {
                 throw new Error("roles of meta [" + this.collection + "] should be array");
             }
+
             this.roles.forEach(role => {
                 const role_config = role.split(":");
                 const role_name = role_config[0];
-                if (!is_valid_role(role_name)) {
+                if (!validate_meta_role(role_name)) {
                     throw new Error("role [" + role_name + "] not defined in setting");
                 }
             });

package/core/role.js

@@ -0,0 +1,69 @@
+const { get_settings } = require("../setting");
+
+const validate_meta_role = (role_name) => {
+    const settings = get_settings();
+    if (!settings.roles) {
+        return false;
+    }
+    return is_valid_role(role_name);
+}
+
+const is_valid_role = (role_name) => {
+    const settings = get_settings();
+    const roles = settings.roles.filter(role => role.name == role_name);
+    return roles.length == 1;
+}
+
+const is_root_role = (role_name) => {
+    const settings = get_settings();
+    //no role defined, then every one is root
+    if (!settings.roles) {
+        return true;
+    }
+
+    if (is_valid_role(role_name)) {
+        return settings.roles.filter(role => role.name == role_name)[0].root == true;
+    } else {
+        return false;
+    }
+}
+
+const get_session_user_role = (req) => {
+    const user = req && req.session ? req.session.user : null;
+    return user ? user.role : null;
+}
+
+const get_user_role_mode = (req, meta) => {
+    const settings = get_settings();
+    //no role defined in settings or no roles defined in meta, use meta mode
+    if (!settings.roles || !meta.roles) {
+        return meta.mode;
+    }
+
+    const user_role = get_session_user_role(req);
+    if (!user_role) {
+        return "";
+    }
+
+    if (is_valid_role(user_role)) {
+        const roles = meta.roles;
+        for (let i = 0; i < roles.length; i++) {
+            const role = roles[i];
+            const role_settings = role.split(":");
+            const role_name = role_settings[0];
+            const role_mode = role_settings[1];
+            if (user_role == role_name) {
+                return role_mode;
+            }
+        }
+    }
+
+    return "";
+}
+
+const check_user_role = (req, meta, mode) => {
+    const role_mode = get_user_role_mode(req, meta);
+    return role_mode.includes(mode);
+}
+
+module.exports = { is_root_role, validate_meta_role, check_user_role, get_user_role_mode };

package/http/session.js

@@ -1,6 +1,6 @@
 const express_session = require('express-session');
 const MongoStore = require('connect-mongo');
-const { get_settings, is_valid_role, is_root_role } = require('../setting');
+const { get_settings } = require('../setting');
 
 const init_session = (app) => {
     const server = get_settings().server;
@@ -24,54 +24,9 @@ const get_session_userid = (req) => {
     return user ? user.id : null;
 }
 
-const get_session_user_role = (req) => {
-    const user = req && req.session ? req.session.user : null;
-    return user ? user.role : null;
-}
-
-//b:batch mode, c:create, d:delete, e:export, i:import, o:clone, p:page, r: refresh, s:search, u:update
-const mode_all = "bcdeiorsu";
-
-const get_user_role_mode = (req, roles) => {
-    const server = get_settings().server;
-    if (server.check_user == false) {
-        return mode_all;
-    }
-
-    const user_role = get_session_user_role(req);
-    if (!user_role) {
-        return "";
-    }
-
-    if (is_root_role(user_role)) {
-        return mode_all;
-    } else if (is_valid_role(user_role)) {
-        for (let i = 0; i < roles.length; i++) {
-            const role = roles[i];
-            const role_settings = role.split(":");
-            const role_name = role_settings[0];
-            const role_mode = role_settings[1];
-            if (user_role == role_name) {
-                if (role_mode == "*") {
-                    return mode_all;
-                } else {
-                    return role_mode;
-                }
-            }
-        }
-    }
-
-    return "";
-}
-
-const check_user_role = (req, roles, mode) => {
-    const role_mode = get_user_role_mode(req, roles);
-    return role_mode.includes(mode);
-}
-
 const get_session_user_groups = (req) => {
     const group = req && req.session ? req.session.group : null;
     return group && Array.isArray(group) ? group : null;
 }
 
-module.exports = { init_session, get_session_userid, get_session_user_role, get_session_user_groups, check_user_role, get_user_role_mode };
+module.exports = { init_session, get_session_userid, get_session_user_groups };

package/index.js

@@ -5,6 +5,7 @@ const { init_router } = require('./http/router');
 const { init_express_server } = require('./http/express');
 const { register_type, get_type } = require('./core/type');
 const { EntityMeta, get_entity_meta } = require('./core/meta');
+const { is_root_role } = require('./core/role');
 
 
 const array = require('./core/array');
@@ -30,7 +31,7 @@ const { gen_i18n } = require('./tool/gen_i18n');
 const { log_debug, log_info, log_warn, log_error, is_log_debug, is_log_info, is_log_warn, is_log_error, get_session_userid, oid_queries, oid_query } = require('./db/db');
 
 module.exports = {
-    init_settings, init_express_server, init_router, register_type, get_type, get_db,
+    init_settings, is_root_role, init_express_server, init_router, register_type, get_type, get_db,
     Entity, EntityMeta, get_entity_meta, array, bash, chart, cron, date, file, lhs, msg, number, obj, random, thread, validate, code, err, params, context, gridfs, gen_i18n,
     log_debug, log_info, log_warn, log_error, is_log_debug, is_log_info, is_log_warn, is_log_error, get_session_userid, oid_queries, oid_query
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hola-server",
-  "version": "0.6.8",
+  "version": "0.6.10",
   "description": "a meta programming framework used to build nodejs restful api",
   "main": "index.js",
   "scripts": {

package/router/clone.js

@@ -1,9 +1,10 @@
 const { set_file_fields, save_file_fields_to_db } = require('../db/gridfs');
 const { SUCCESS, NO_PARAMS, NO_RIGHTS } = require('../http/code');
-const { get_session_userid, check_user_role } = require('../http/session');
+const { get_session_userid } = require('../http/session');
 const { wrap_http } = require('../http/error');
 const { post_params, required_post_params } = require('../http/params');
 const { has_value } = require('../core/validate');
+const { check_user_role } = require('../core/role');
 const { Entity } = require('../db/entity');
 
 const multer = require('multer');
@@ -19,12 +20,10 @@ const init_clone_router = function (router, meta) {
     const cp_upload = meta.upload_fields.length > 0 ? upload_file.fields(meta.upload_fields) : upload_file.none();
 
     router.post('/clone', cp_upload, wrap_http(async function (req, res) {
-        if (meta.roles) {
-            const has_right = check_user_role(req, meta.roles, "o");
-            if (!has_right) {
-                res.json({ code: NO_RIGHTS, err: "no rights error" });
-                return;
-            }
+        const has_right = check_user_role(req, meta, "o");
+        if (!has_right) {
+            res.json({ code: NO_RIGHTS, err: "no rights error" });
+            return;
         }
 
         let params = required_post_params(req, ["_id"]);

package/router/create.js

@@ -1,9 +1,10 @@
 const { set_file_fields, save_file_fields_to_db } = require('../db/gridfs');
 const { SUCCESS, NO_RIGHTS } = require('../http/code');
-const { get_session_userid, check_user_role } = require('../http/session');
+const { get_session_userid } = require('../http/session');
 const { wrap_http } = require('../http/error');
 const { post_params } = require('../http/params');
 const { has_value } = require('../core/validate');
+const { check_user_role } = require('../core/role');
 const { Entity } = require('../db/entity');
 
 const multer = require('multer');
@@ -19,12 +20,10 @@ const init_create_router = function (router, meta) {
     const cp_upload = meta.upload_fields.length > 0 ? upload_file.fields(meta.upload_fields) : upload_file.none();
 
     router.post('/create', cp_upload, wrap_http(async function (req, res) {
-        if (meta.roles) {
-            const has_right = check_user_role(req, meta.roles, "c");
-            if (!has_right) {
-                res.json({ code: NO_RIGHTS, err: "no rights error" });
-                return;
-            }
+        const has_right = check_user_role(req, meta, "c");
+        if (!has_right) {
+            res.json({ code: NO_RIGHTS, err: "no rights error" });
+            return;
         }
 
         const param_obj = post_params(req, meta.field_names);

package/router/delete.js

@@ -1,7 +1,7 @@
 const { required_post_params } = require('../http/params');
 const { has_value } = require('../core/validate');
 const { NO_PARAMS, NO_RIGHTS } = require('../http/code');
-const { check_user_role } = require('../http/session');
+const { check_user_role } = require('../core/role');
 const { wrap_http } = require('../http/error');
 const { Entity } = require('../db/entity');
 
@@ -14,12 +14,10 @@ const init_delete_router = function (router, meta) {
     const entity = new Entity(meta);
 
     router.post('/delete', wrap_http(async function (req, res) {
-        if (meta.roles) {
-            const has_right = check_user_role(req, meta.roles, "d");
-            if (!has_right) {
-                res.json({ code: NO_RIGHTS, err: "no rights error" });
-                return;
-            }
+        const has_right = check_user_role(req, meta, "d");
+        if (!has_right) {
+            res.json({ code: NO_RIGHTS, err: "no rights error" });
+            return;
         }
 
         const params = required_post_params(req, ["ids"]);

package/router/read.js

@@ -1,7 +1,8 @@
 const { required_post_params, get_params } = require('../http/params');
 const { has_value } = require('../core/validate');
 const { NO_PARAMS, SUCCESS, NO_RIGHTS } = require('../http/code');
-const { get_session_userid, get_session_user_groups, check_user_role, get_user_role_mode } = require('../http/session');
+const { check_user_role, get_user_role_mode } = require('../core/role');
+const { get_session_userid, get_session_user_groups } = require('../http/session');
 const { wrap_http } = require('../http/error');
 const { Entity } = require('../db/entity');
 
@@ -14,12 +15,10 @@ const init_read_router = function (router, meta) {
     const entity = new Entity(meta);
 
     router.get('/meta', wrap_http(async function (req, res) {
-        if (meta.roles) {
-            const has_right = check_user_role(req, meta.roles, "r");
-            if (!has_right) {
-                res.json({ code: NO_RIGHTS, err: "no rights error" });
-                return;
-            }
+        const has_right = check_user_role(req, meta, "r");
+        if (!has_right) {
+            res.json({ code: NO_RIGHTS, err: "no rights error" });
+            return;
         }
 
         const entity_meta = {
@@ -38,24 +37,20 @@ const init_read_router = function (router, meta) {
     }));
 
     router.get('/mode', wrap_http(async function (req, res) {
-        if (meta.roles) {
-            const has_right = check_user_role(req, meta.roles, "r");
-            if (!has_right) {
-                res.json({ code: NO_RIGHTS, err: "no rights error" });
-                return;
-            }
+        const has_right = check_user_role(req, meta, "r");
+        if (!has_right) {
+            res.json({ code: NO_RIGHTS, err: "no rights error" });
+            return;
         }
 
-        res.json({ code: SUCCESS, data: get_user_role_mode(req, meta.roles) });
+        res.json({ code: SUCCESS, data: get_user_role_mode(req, meta) });
     }));
 
     router.get('/ref', wrap_http(async function (req, res) {
-        if (meta.roles) {
-            const has_right = check_user_role(req, meta.roles, "r");
-            if (!has_right) {
-                res.json({ code: NO_RIGHTS, err: "no rights error" });
-                return;
-            }
+        const has_right = check_user_role(req, meta, "r");
+        if (!has_right) {
+            res.json({ code: NO_RIGHTS, err: "no rights error" });
+            return;
         }
 
         const { ref_by_entity } = get_params(req, ["ref_by_entity"]);
@@ -65,12 +60,10 @@ const init_read_router = function (router, meta) {
     }));
 
     router.post('/list', wrap_http(async function (req, res) {
-        if (meta.roles) {
-            const has_right = check_user_role(req, meta.roles, "r");
-            if (!has_right) {
-                res.json({ code: NO_RIGHTS, err: "no rights error" });
-                return;
-            }
+        const has_right = check_user_role(req, meta, "r");
+        if (!has_right) {
+            res.json({ code: NO_RIGHTS, err: "no rights error" });
+            return;
         }
 
         const query_params = required_post_params(req, ["_query"]);
@@ -107,12 +100,10 @@ const init_read_router = function (router, meta) {
     }));
 
     router.post('/read_entity', wrap_http(async function (req, res) {
-        if (meta.roles) {
-            const has_right = check_user_role(req, meta.roles, "r");
-            if (!has_right) {
-                res.json({ code: NO_RIGHTS, err: "no rights error" });
-                return;
-            }
+        const has_right = check_user_role(req, meta, "r");
+        if (!has_right) {
+            res.json({ code: NO_RIGHTS, err: "no rights error" });
+            return;
         }
 
         let params = required_post_params(req, ["_id", "attr_names"]);
@@ -130,12 +121,10 @@ const init_read_router = function (router, meta) {
     }));
 
     router.post('/read_property', wrap_http(async function (req, res) {
-        if (meta.roles) {
-            const has_right = check_user_role(req, meta.roles, "r");
-            if (!has_right) {
-                res.json({ code: NO_RIGHTS, err: "no rights error" });
-                return;
-            }
+        const has_right = check_user_role(req, meta, "r");
+        if (!has_right) {
+            res.json({ code: NO_RIGHTS, err: "no rights error" });
+            return;
         }
 
         let params = required_post_params(req, ["_id", "attr_names"]);

package/setting.js

@@ -43,26 +43,4 @@ const get_settings = () => {
     return settings;
 }
 
-const is_valid_role = (role_name) => {
-    //no role defined, then no role check
-    if (!settings.roles) {
-        return true;
-    }
-    const roles = settings.roles.filter(role => role.name == role_name);
-    return roles.length == 1;
-}
-
-const is_root_role = (role_name) => {
-    //no role defined, then every one is root
-    if (!settings.roles) {
-        return true;
-    }
-
-    if (!is_valid_role(role_name)) {
-        return false;
-    }
-
-    return settings.roles.filter(role => role.name == role_name)[0].root == true;
-}
-
-module.exports = { init_settings, get_settings, is_root_role, is_valid_role };
+module.exports = { init_settings, get_settings };