midway-fatcms 0.0.1-beta.42 → 0.0.1-beta.45

package/dist/configuration.js

@@ -20,7 +20,7 @@ const view = require("@midwayjs/view-ejs");
 const redis = require("@midwayjs/redis");
 const crossDomain = require("@midwayjs/cross-domain");
 const _ = require("lodash");
-const path_1 = require("path");
+const node_path_1 = require("node:path");
 // import { DefaultErrorFilter } from './filter/default.filter';
 // import { NotFoundFilter } from './filter/notfound.filter';
 const global_middleware_1 = require("./middleware/global.middleware");
@@ -107,7 +107,7 @@ ContainerLifeCycle = __decorate([
                 component: info,
             },
         ],
-        importConfigs: [(0, path_1.join)(__dirname, './config')],
+        importConfigs: [(0, node_path_1.join)(__dirname, './config')],
     })
 ], ContainerLifeCycle);
 exports.ContainerLifeCycle = ContainerLifeCycle;

package/dist/controller/manage/CrudStandardDesignApi.d.ts

@@ -35,4 +35,12 @@ export declare class CrudStandardDesignApi extends BaseApiController {
     private getTableListOfPostgreSQL;
     private getTableFieldsOfSqlServer;
     private getTableFieldsOfPostgreSQL;
+    /**
+     * 获取PostgreSQL建表语句的注释
+     * @param dbName
+     * @param schemaname
+     * @param tableName
+     * @returns
+     */
+    private getTableFieldsCommentsMapOfPostgreSQL;
 }

package/dist/controller/manage/CrudStandardDesignApi.js

@@ -254,14 +254,14 @@ let CrudStandardDesignApi = class CrudStandardDesignApi extends BaseApiControlle
             throw new exceptions_1.CommonException('DB_NOT_FOUND', '数据库配置没有找到：' + dbName);
         }
         const schemaname = 'public';
-        const columnArraySql = `
-
-    SELECT
-      *
-      FROM information_schema.columns
-      WHERE table_schema = $1 and table_name = $2
-      ORDER BY ordinal_position;
-
+        const columnArraySql = `
+
+    SELECT
+      *
+      FROM information_schema.columns
+      WHERE table_schema = $1 and table_name = $2
+      ORDER BY ordinal_position;
+
     `.trim();
         const dbType = keys_1.SqlDbType.postgres;
         const columnArray = await this.curdMixService.executeSQL({
@@ -271,11 +271,12 @@ let CrudStandardDesignApi = class CrudStandardDesignApi extends BaseApiControlle
             crudType: keys_1.KeyOfCrudTypes.SYS_QUERY,
             executeSqlArgs: [schemaname, tableName],
         });
+        const commentMap = await this.getTableFieldsCommentsMapOfPostgreSQL(dbName, schemaname, tableName);
         const fields = columnArray.map(columnObj => {
             const { column_name, is_nullable, column_default, data_type, is_identity, ...others } = columnObj;
             return {
                 fieldIndex: column_name || '',
-                fieldTitle: column_name || '',
+                fieldTitle: commentMap[column_name] || column_name || '',
                 isNullable: is_nullable,
                 defaultValue: column_default || '',
                 extra: others,
@@ -293,6 +294,50 @@ let CrudStandardDesignApi = class CrudStandardDesignApi extends BaseApiControlle
             },
         };
     }
+    /**
+     * 获取PostgreSQL建表语句的注释
+     * @param dbName
+     * @param schemaname
+     * @param tableName
+     * @returns
+     */
+    async getTableFieldsCommentsMapOfPostgreSQL(dbName, schemaname, tableName) {
+        const commentArraySql = `
+            SELECT
+                n.nspname AS schema_name,
+                c.relname AS table_name,  
+                a.attname AS column_name,  
+                d.description AS column_comment 
+            FROM
+                pg_class c
+            JOIN
+                pg_namespace n ON c.relnamespace = n.oid
+            JOIN
+                pg_attribute a ON c.oid = a.attrelid
+            LEFT JOIN
+                pg_description d ON c.oid = d.objoid AND a.attnum = d.objsubid
+            WHERE
+                n.nspname = $1 
+                AND c.relname = $2  
+                AND a.attnum > 0  
+            ORDER BY
+                a.attnum
+    `;
+        const dbType = keys_1.SqlDbType.postgres;
+        const commentArray = await this.curdMixService.executeSQL({
+            executeSql: commentArraySql,
+            sqlDatabase: dbName,
+            sqlDbType: dbType,
+            crudType: keys_1.KeyOfCrudTypes.SYS_QUERY,
+            executeSqlArgs: [schemaname, tableName],
+        });
+        const map = {};
+        commentArray.forEach(commentObj => {
+            const { column_name, column_comment } = commentObj;
+            map[column_name] = (0, parseCreateSql_1.parseTableFieldTitleFromComment)(column_comment);
+        });
+        return map;
+    }
 };
 __decorate([
     (0, core_1.Config)('mysql2'),

package/dist/controller/manage/UserAccountManageApi.js

@@ -28,7 +28,7 @@ function checkAccountCreateBlacklist(value) {
         throw new exceptions_1.CommonException(exceptions_1.Exceptions.VALIDATE_EXCEPTION, '用户名或昵称不能使用具有管理员歧义的词语');
     }
 }
-const LOGIN_NAME_VALIDATE = [keys_1.KeysOfValidators.STRING, keys_1.KeysOfValidators.NAME, 'length:6,50', checkAccountCreateBlacklist];
+const LOGIN_NAME_VALIDATE = [keys_1.KeysOfValidators.STRING, keys_1.KeysOfValidators.NAME, 'length:5,50', checkAccountCreateBlacklist];
 let UserAccountManageApi = class UserAccountManageApi extends BaseApiController_1.BaseApiController {
     async getUserAccountList() {
         return this.executeSysSimpleSQL(SystemTables_1.SystemTables.sys_user_account, keys_1.KeysOfSimpleSQL.SIMPLE_QUERY_PAGE, {

package/dist/index.d.ts

@@ -41,6 +41,7 @@ export * from './middleware/forbidden.middleware';
 export * from './middleware/global.middleware';
 export * from './middleware/tx.middleware';
 export * from './middleware/permission.middleware';
+export * from './middleware/redislock.middleware';
 export * from './service/AuthService';
 export * from './service/EnumInfoService';
 export * from './service/FileCenterService';

package/dist/index.js

@@ -59,6 +59,7 @@ __exportStar(require("./middleware/forbidden.middleware"), exports);
 __exportStar(require("./middleware/global.middleware"), exports);
 __exportStar(require("./middleware/tx.middleware"), exports);
 __exportStar(require("./middleware/permission.middleware"), exports);
+__exportStar(require("./middleware/redislock.middleware"), exports);
 __exportStar(require("./service/AuthService"), exports);
 __exportStar(require("./service/EnumInfoService"), exports);
 __exportStar(require("./service/FileCenterService"), exports);

package/dist/libs/global-config/global-config.d.ts

@@ -1,13 +1,24 @@
+import { IRequestCfgModel, IRequestModel } from '../crud-pro/interfaces';
+import { ExecuteContext } from '../crud-pro/models/ExecuteContext';
 import { SqlDbType } from '../crud-pro/models/keys';
+import { Context } from '@midwayjs/koa';
 interface IGlobalStaticConfig {
     /**
-     * CrudStd: 业务系统自定义的修改cfgModel
+     * CrudStd: 业务系统自定义的修改：查询前的查询条件：cfgModel
      * @param reqJson
      * @param cfgModel
      * @param appInfo
      * @param ctx
      */
-    bizUpdateCfgModelForCrudStd(reqJson: any, cfgModel: any, appInfo: any, ctx: any): Promise<any>;
+    bizUpdateCfgModelForCrudStd(reqJson: IRequestModel, cfgModel: IRequestCfgModel, appInfo: any, ctx: Context): Promise<any>;
+    /**
+     * CrudStd:  业务系统自定义的修改：查询后的返回值。
+     * @param reqJson
+     * @param cfgModel
+     * @param appInfo
+     * @param ctx
+     */
+    bizUpdateExecuteContextForCrudStd(reqJson: IRequestModel, cfgModel: IRequestCfgModel, appInfo: any, ctx: Context, executeContext: ExecuteContext): Promise<any>;
     /**
      * CrudMtd: 业务系统自定义的修改cfgModel
      * @param reqJson

package/dist/libs/global-config/global-config.js

@@ -9,6 +9,7 @@ class GlobalStaticConfig {
     constructor() {
         this.configObject = {
             bizUpdateCfgModelForCrudStd: noop,
+            bizUpdateExecuteContextForCrudStd: noop,
             bizUpdateCfgModelForCrudMtd: noop,
             bizUpdateCfgModelForCrudPro: noop,
             generateUserAccountId: null,
@@ -17,7 +18,7 @@ class GlobalStaticConfig {
             },
             SystemDbName: 'fatcms',
             SystemDbType: keys_1.SqlDbType.mysql,
-            maxPageSizeOfExportExcel: 1000
+            maxPageSizeOfExportExcel: 1000,
         };
     }
     getConfig() {

package/dist/libs/utils/parseCreateSql.d.ts

@@ -1,5 +1,10 @@
+/**
+ * 移除引号
+ * @param s
+ */
+declare function parseTableFieldTitleFromComment(s: string): string;
 declare function parseCreateSqlToTitleMap(createSqlStr: string): {
     tableTitle: string;
     fieldsTitleMap: {};
 };
-export { parseCreateSqlToTitleMap };
+export { parseCreateSqlToTitleMap, parseTableFieldTitleFromComment };

package/dist/libs/utils/parseCreateSql.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseCreateSqlToTitleMap = void 0;
+exports.parseTableFieldTitleFromComment = exports.parseCreateSqlToTitleMap = void 0;
 function isChineseChar(char) {
     const reg = /[\u4e00-\u9fff]/;
     return reg.test(char);
@@ -34,6 +34,7 @@ function parseTableFieldTitleFromComment(s) {
     }
     return arr.join('');
 }
+exports.parseTableFieldTitleFromComment = parseTableFieldTitleFromComment;
 /**
  * 从最后一行中提取表格的标题
  * @param arr

package/dist/middleware/forbidden.middleware.js

@@ -20,7 +20,7 @@ let ForbiddenMiddleware = class ForbiddenMiddleware {
         if (path === '/') {
             return false;
         }
-        if (path.startsWith('/ns/')) {
+        if (path.startsWith('/ns/') || path.startsWith('/pages/')) {
             return false;
         }
         for (let i = 0; i < blackEqualList.length; i++) {
@@ -35,7 +35,7 @@ let ForbiddenMiddleware = class ForbiddenMiddleware {
                 return true;
             }
         }
-        return !!(path.includes('/wp-includes/') || path.endsWith('.php') || path.endsWith('/.git/config'));
+        return !!(path.includes('/wp-includes/') || path.includes('/wp-admin/') || path.includes('/wp-content/') || path.endsWith('.php') || path.endsWith('/.git/config'));
     }
     resolve() {
         return async (ctx, next) => {

package/dist/middleware/rediscache.middleware.d.ts

@@ -0,0 +1,3 @@
+import { NextFunction, Context } from '@midwayjs/koa';
+declare function redisCache(cacheKeyConfigList: string[], cacheTimeSecond: number): (ctx: Context, next: NextFunction) => Promise<any>;
+export { redisCache };

package/dist/middleware/rediscache.middleware.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redisCache = void 0;
+const redis_1 = require("@midwayjs/redis");
+const _ = require("lodash");
+const md5 = require("md5");
+const RedisKeys_1 = require("../models/RedisKeys");
+const exceptions_1 = require("../libs/crud-pro/exceptions");
+const getRedisService = async (ctx) => {
+    const service = await ctx.requestContext.getAsync(redis_1.RedisService);
+    if (!service) {
+        return await ctx.requestContext.getAsync('redisService');
+    }
+};
+const createError = () => {
+    return new exceptions_1.CommonException('redis_cache_middleware_error_config', 'redisCache中间件的第一个参数必须是一个字符串数组, 并且以“query.”或“body.”开头');
+};
+const checkCacheKeyConfigList = (cacheKeyConfigList) => {
+    if (!Array.isArray(cacheKeyConfigList)) {
+        throw createError();
+    }
+    for (let i = 0; i < cacheKeyConfigList.length; i++) {
+        const cacheKeyConfig = cacheKeyConfigList[i];
+        if (typeof cacheKeyConfig !== 'string') {
+            throw createError();
+        }
+        if (!cacheKeyConfig.startsWith('query.') && !cacheKeyConfig.startsWith('body.')) {
+            throw createError();
+        }
+    }
+};
+// {middleware:[redisCache(['query.id'， 'body.id'])]}
+const toCacheKey = (ctx, cacheKeyConfigList) => {
+    checkCacheKeyConfigList(cacheKeyConfigList);
+    const path = ctx.path;
+    const query = ctx.query || {};
+    const body = ctx.request.body || {};
+    const newCtx = { path, query, body };
+    // 至少要根据path缓存
+    const cacheKeyConfigList2 = ['path', ...cacheKeyConfigList];
+    const strArray = cacheKeyConfigList2.map((key) => {
+        const value = _.get(newCtx, key);
+        return { key, value };
+    });
+    const strArrayStr = JSON.stringify(strArray);
+    const strMd5 = md5(strArrayStr);
+    return RedisKeys_1.RedisKeys.REDIS_LOCK_MIDDILEWARE + strMd5;
+};
+function toCacheDataString(resData) {
+    throw new Error('Function not implemented.');
+}
+function parseCacheData(cacheData) {
+    throw new Error('Function not implemented.');
+}
+function redisCache(cacheKeyConfigList, cacheTimeSecond) {
+    return async (ctx, next) => {
+        const redisService = await getRedisService(ctx);
+        const cacheKey = toCacheKey(ctx, cacheKeyConfigList);
+        let cacheTime = typeof cacheTimeSecond === 'number' ? cacheTimeSecond : 60; // 默认缓存1分钟
+        cacheTime = Math.max(cacheTimeSecond, 1); // 至少缓存1秒。
+        cacheTime = Math.min(cacheTimeSecond, 60 * 60); // 最长缓存1小时
+        const cacheData = await redisService.get(cacheKey);
+        if (cacheData) {
+            return parseCacheData(cacheData);
+        }
+        try {
+            const resData = await next();
+            const resDataStr = toCacheDataString(resData);
+            await redisService.set(cacheKey, resDataStr, 'EX', cacheTime);
+            return resData;
+        }
+        catch (e) {
+            console.error('redisCache', e);
+        }
+    };
+}
+exports.redisCache = redisCache;

package/dist/middleware/redislock.middleware.d.ts

@@ -0,0 +1,7 @@
+import { NextFunction, Context } from '@midwayjs/koa';
+declare function redisLock(lockKeyConfigList: string[], lockTimeSecond: number): (ctx: Context, next: NextFunction) => Promise<{
+    success: boolean;
+    message: string;
+    code: string;
+}>;
+export { redisLock };

package/dist/middleware/redislock.middleware.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redisLock = void 0;
+const redis_1 = require("@midwayjs/redis");
+const _ = require("lodash");
+const md5 = require("md5");
+const RedisKeys_1 = require("../models/RedisKeys");
+const exceptions_1 = require("../libs/crud-pro/exceptions");
+const getRedisService = async (ctx) => {
+    const service = await ctx.requestContext.getAsync(redis_1.RedisService);
+    if (!service) {
+        return await ctx.requestContext.getAsync('redisService');
+    }
+};
+const createError = () => {
+    return new exceptions_1.CommonException('redis_lock_middleware_error_config', 'redisLock中间件的第一个参数必须是一个字符串数组, 并且以“query.”或“body.”开头');
+};
+const checkLockKeyConfigList = (lockKeyConfigList) => {
+    if (!Array.isArray(lockKeyConfigList)) {
+        throw createError();
+    }
+    for (let i = 0; i < lockKeyConfigList.length; i++) {
+        const lockKeyConfig = lockKeyConfigList[i];
+        if (typeof lockKeyConfig !== 'string') {
+            throw createError();
+        }
+        if (!lockKeyConfig.startsWith('query.') && !lockKeyConfig.startsWith('body.')) {
+            throw createError();
+        }
+    }
+};
+// {middleware:[redisLock(['query.id'， 'body.id'])]}
+const toLockKey = (ctx, lockKeyConfigList) => {
+    checkLockKeyConfigList(lockKeyConfigList);
+    const path = ctx.path;
+    const query = ctx.query || {};
+    const body = ctx.request.body || {};
+    const newCtx = { path, query, body };
+    // 至少要根据path锁
+    const lockKeyConfigList2 = ['path', ...lockKeyConfigList];
+    const strArray = lockKeyConfigList2.map((key) => {
+        const value = _.get(newCtx, key);
+        return { key, value };
+    });
+    const strArrayStr = JSON.stringify(strArray);
+    const strMd5 = md5(strArrayStr);
+    return RedisKeys_1.RedisKeys.REDIS_LOCK_MIDDILEWARE + strMd5;
+};
+function redisLock(lockKeyConfigList, lockTimeSecond) {
+    return async (ctx, next) => {
+        const redisService = await getRedisService(ctx);
+        const lockKey = toLockKey(ctx, lockKeyConfigList);
+        let lockTime = typeof lockTimeSecond === 'number' ? lockTimeSecond : 60; // 默认锁住1分钟（失败的情况）
+        lockTime = Math.max(lockTimeSecond, 1); // 至少锁一秒 （失败的情况）
+        lockTime = Math.min(lockTimeSecond, 5 * 60); // 最长锁 5分钟（失败的情况）
+        const lock = await redisService.set(lockKey, 1, 'EX', lockTime, 'NX');
+        if (lock !== 'OK') {
+            return {
+                success: false,
+                message: '您请求的接口当前正在处理中，请稍后再试',
+                code: 'redis_lock_middleware_error_locked',
+            };
+        }
+        try {
+            await next();
+        }
+        finally {
+            await redisService.del(lockKey); // 正常运行完成，立即释放锁。
+        }
+    };
+}
+exports.redisLock = redisLock;

package/dist/models/RedisKeys.d.ts

@@ -10,5 +10,6 @@ declare const RedisKeys: {
     LINK_TO_CUSTOM_PREFIX: string;
     CURD_MIX_BY_DICT_PREFIX: string;
     QUERY_ENUM_INFO_PREFIX: string;
+    REDIS_LOCK_MIDDILEWARE: string;
 };
 export { RedisKeys };

package/dist/models/RedisKeys.js

@@ -13,5 +13,6 @@ const RedisKeys = {
     LINK_TO_CUSTOM_PREFIX: 'FatLinkToCustom@@',
     CURD_MIX_BY_DICT_PREFIX: 'FatCurdMixByDict@@',
     QUERY_ENUM_INFO_PREFIX: 'FatQueryEnum@@',
+    REDIS_LOCK_MIDDILEWARE: 'FatRedisLock@@',
 };
 exports.RedisKeys = RedisKeys;

package/dist/models/bizmodels.d.ts

@@ -66,6 +66,7 @@ export interface IVisitorExt extends IVisitor {
     workbenchCode: string;
     avatar: string;
     accountType: string;
+    bizExt?: any;
 }
 export declare const FILE_GET_TYPES: string[];
 /**

package/dist/models/userSession.d.ts

@@ -17,6 +17,7 @@ interface ISessionInfo {
     accountId: string;
     workbenchCode: string;
     accountType: string;
+    bizExt?: any;
 }
 interface IConsumerUserInfo {
     workbenchCode: string;

package/dist/service/UserSessionService.d.ts

@@ -10,7 +10,8 @@ export declare class UserSessionService {
      */
     private getSessionKeepTimeSecond;
     /**
-     * 保存用户会话信息
+     * 保存用户会话信息。
+     * 用户登录后，在业务的项目中，可以调用此函数，更新bizExt字段
      * @param sessionInfo
      */
     saveUserSession(sessionInfo: ISessionInfo): Promise<void>;

package/dist/service/UserSessionService.js

@@ -61,7 +61,8 @@ let UserSessionService = class UserSessionService {
         return SESSION_KEEP_TIME_SECOND;
     }
     /**
-     * 保存用户会话信息
+     * 保存用户会话信息。
+     * 用户登录后，在业务的项目中，可以调用此函数，更新bizExt字段
      * @param sessionInfo
      */
     async saveUserSession(sessionInfo) {

package/dist/service/crudstd/CrudStdService.js

@@ -69,9 +69,12 @@ let CrudStdService = class CrudStdService extends ApiBaseService_1.ApiBaseServic
         await this.crudStdRelationService.addCfgModelColumnsRelation(cfgModel, appInfo);
         // 根据表结构的数据类型，修正数据类型
         await this.fixDataFieldTypeBySqlTableField(params, cfgModel, appInfo, { dbType, dbName });
-        // 业务系统自定义的修改cfgModel
+        // 业务系统自定义的修改：查询前的查询条件：cfgModel
         await global_config_1.GLOBAL_STATIC_CONFIG.getConfig().bizUpdateCfgModelForCrudStd(params, cfgModel, appInfo, this.ctx);
-        return await this.curdMixService.executeCrudByCfg(params, cfgModel);
+        const crudExeCtx = await this.curdMixService.executeCrudByCfg(params, cfgModel);
+        // 业务系统自定义的修改：查询后的返回值。
+        await global_config_1.GLOBAL_STATIC_CONFIG.getConfig().bizUpdateExecuteContextForCrudStd(params, cfgModel, appInfo, this.ctx, crudExeCtx);
+        return crudExeCtx;
     }
     /**
      * 获取appInfo 并且拿到当前settingKey相关的信息

package/dist/service/curd/CurdMixService.d.ts

@@ -1,6 +1,7 @@
 import { ColumnRelation, IRequestCfgModel, IRequestModel, ISqlCfgModel } from '../../libs/crud-pro/interfaces';
 import { IRequestCfgModel2 } from '../../models/bizmodels';
 import { SqlDbType } from '../../libs/crud-pro/models/keys';
+import { ExecuteContext } from '../../libs/crud-pro/models/ExecuteContext';
 export interface ILinkColumnRelationParam {
     columnsRelations: ColumnRelation[];
 }
@@ -12,10 +13,10 @@ export declare class CurdMixService {
     private curdMixByWorkbenchService;
     private curdMixByLinkToCustomService;
     private prepare;
-    executeCrudByCfg(reqJson: IRequestModel, cfgModel: IRequestCfgModel2): Promise<import("../../libs/crud-pro/models/ExecuteContext").ExecuteContext>;
+    executeCrudByCfg(reqJson: IRequestModel, cfgModel: IRequestCfgModel2): Promise<ExecuteContext>;
     getBbUtil(sqlDatabase: string, sqlDbType: SqlDbType, sqlTable?: string): import("./CrudProQuick").CrudProQuick;
     executeSQL(sqlCfgModel: ISqlCfgModel): Promise<any>;
-    executeCrud(reqJson: IRequestModel): Promise<import("../../libs/crud-pro/models/ExecuteContext").ExecuteContext>;
+    executeCrud(reqJson: IRequestModel): Promise<ExecuteContext>;
     getCachedCfgByMethod(method: string): Promise<IRequestCfgModel>;
     /**
      * 根据配置的关联关系，直接关联数据

package/dist/service/curd/CurdProService.js

@@ -37,6 +37,7 @@ function toVisitor(ctx) {
             roleCodes: [],
             functionCodes: [],
             workbenchCode: (workbenchInfo === null || workbenchInfo === void 0 ? void 0 : workbenchInfo.workbench_code) || '',
+            bizExt: {}
         };
     }
     const sessionInfo = userSession.getSessionInfo();
@@ -50,6 +51,7 @@ function toVisitor(ctx) {
         roleCodes: sessionInfo.roleCodes || [],
         functionCodes: sessionInfo.functionCodes || [],
         workbenchCode: (workbenchInfo === null || workbenchInfo === void 0 ? void 0 : workbenchInfo.workbench_code) || '',
+        bizExt: sessionInfo.bizExt || {}
     };
 }
 class MyContextFunc extends ExecuteContextFunc_1.BaseExecuteContextFunc {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "midway-fatcms",
-  "version": "0.0.1-beta.42",
+  "version": "0.0.1-beta.45",
   "description": "This is a midway component sample",
   "main": "dist/index.js",
   "typings": "index.d.ts",