midway-fatcms 0.0.1-beta.55 → 0.0.1-beta.57

package/src/service/crudstd/CrudStdRelationService.ts

@@ -0,0 +1,118 @@
+/* eslint-disable prettier/prettier */
+import { Inject, Provide } from '@midwayjs/core';
+import { Context } from '@midwayjs/koa';
+import * as _ from 'lodash';
+import { CurdMixService } from '../curd/CurdMixService';
+import { IRequestCfgModel } from '../../libs/crud-pro/interfaces';
+import { ICrudStdAppInfoForSettingKey } from '../../models/bizmodels';
+import { BaseService } from '../base/BaseService';
+import { tableColumnRenders, fieldLinkToTypes } from './CrudStdConstant';
+import { RelatedType } from '../curd/CurdMixUtils';
+
+
+class ColumnsRelationMaker {
+  private cfgModel: IRequestCfgModel;
+  private appInfo: ICrudStdAppInfoForSettingKey;
+  constructor(cfgModel: IRequestCfgModel, appInfo: ICrudStdAppInfoForSettingKey) {
+    cfgModel.columnsRelation = [];
+    this.cfgModel = cfgModel;
+    this.appInfo = appInfo;
+  }
+
+  addColumnRelationByAccount(dataIndex: string) {
+    const columnsRelation = this.cfgModel.columnsRelation;
+    columnsRelation.push({
+      relatedType: RelatedType.accountBasic,
+      sourceColumn: dataIndex,
+      targetColumns: [], // 使用默认
+    });
+  }
+
+  addColumnRelationByDictEnumStatus(dataIndex: string) {
+    const appInfo = this.appInfo;
+    const tableFields = appInfo?.stdCrudCfgObj?.tableFields || [];
+    const columnsRelation = this.cfgModel.columnsRelation;
+    const fieldCfg = tableFields.find(f => {
+      return f.fieldIndex === dataIndex;
+    });
+
+    if (fieldCfg && fieldCfg.linkToType === fieldLinkToTypes.linkToCustom) {
+      columnsRelation.push({
+        relatedType: RelatedType.linkToCustom,
+        relatedCode: fieldCfg.linkToCustom,
+        sourceColumn: dataIndex,
+        targetColumns: [], // 使用默认
+      });
+    }
+
+    if (fieldCfg && fieldCfg.linkToType === fieldLinkToTypes.linkToSysCfgEnum) {
+      columnsRelation.push({
+        relatedType: RelatedType.sysCfgEnum,
+        relatedCode: fieldCfg.linkToSysCfgEnumCode,
+        sourceColumn: dataIndex,
+        targetColumns: [], // 使用默认
+      });
+    }
+
+    if (fieldCfg && fieldCfg.linkToType === fieldLinkToTypes.linkToDict) {
+      columnsRelation.push({
+        relatedType: RelatedType.dict,
+        relatedCode: fieldCfg.linkToDictCode,
+        sourceColumn: dataIndex,
+        targetColumns: [], // 使用默认
+      });
+    }
+  }
+
+
+}
+
+
+@Provide()
+export class CrudStdRelationService extends BaseService {
+  @Inject()
+  protected ctx: Context;
+
+  @Inject()
+  protected curdMixService: CurdMixService;
+
+  async addCfgModelColumnsRelation(cfgModel: IRequestCfgModel, appInfo: ICrudStdAppInfoForSettingKey) {
+    const tableColumns = appInfo?.stdCrudCfgObj?.tableColumns;
+
+    if (!Array.isArray(tableColumns) || tableColumns.length === 0) {
+      return;
+    }
+
+    const maker = new ColumnsRelationMaker(cfgModel, appInfo);
+
+    for (let i = 0; i < tableColumns.length; i++) {
+      const tableColumn = tableColumns[i];
+      const dataIndex = _.get(tableColumn, 'dataIndex');
+      const componentName = _.get(tableColumn, 'component.componentName');
+
+      // 关联用户信息
+      if (componentName === tableColumnRenders.RenderUserInfo) {
+        maker.addColumnRelationByAccount(dataIndex);
+      }
+
+      // 关联枚举文案/状态标签颜色
+      if (componentName === tableColumnRenders.RenderDictEnumText || componentName === tableColumnRenders.RenderDictEnumStatus) {
+        maker.addColumnRelationByDictEnumStatus(dataIndex);
+      }
+
+      // 子属性的配置
+      const balloonTipFields = _.get(tableColumn, 'component.props.balloonTipFields');
+      if (Array.isArray(balloonTipFields) && balloonTipFields.length > 0) {
+        for (let j = 0; j < balloonTipFields.length; j++) {
+          const { component, name } = balloonTipFields[j] || {};
+          if (component === tableColumnRenders.RenderUserInfo) {
+            maker.addColumnRelationByAccount(name);
+          }
+        }
+      }
+
+
+
+    }
+  }
+}

package/src/service/crudstd/CrudStdService.ts

@@ -0,0 +1,462 @@
+/* eslint-disable prettier/prettier */
+import * as _ from 'lodash';
+import * as ejs from 'ejs';
+import { Inject, Provide } from '@midwayjs/core';
+import { Context } from '@midwayjs/koa';
+import { CurdMixService } from '../curd/CurdMixService';
+import { IRequestCfgModel, IRequestModel } from '@/libs/crud-pro/interfaces';
+import { KeysOfAuthType, KeysOfSimpleSQL, SqlDbType } from '@/libs/crud-pro/models/keys';
+import { parseJsonObject } from '@/libs/utils/functions';
+import { ICrudStdAppInfo, ICrudStdAppInfoForSettingKey } from '@/models/bizmodels';
+import { BizException } from '@/models/devops';
+import { ExecuteContext } from '@/libs/crud-pro/models/ExecuteContext';
+import { SystemTables } from '@/models/SystemTables';
+import { CrudStdActionService } from './CrudStdActionService';
+import { CrudStdRelationService } from './CrudStdRelationService';
+import { ApiBaseService } from '../base/ApiBaseService';
+import { parseDatabaseName } from '@/libs/crud-pro/utils/DatabaseName';
+import { GLOBAL_STATIC_CONFIG } from '@/libs/global-config/global-config';
+import { MixinUtils } from '@/libs/crud-pro/utils/MixinUtils';
+
+
+export const SPECIAL_SETTING_KEY = {
+  QUERY_LIST: 'QUERY_LIST',
+  QUERY_ONE: 'QUERY_ONE',
+};
+
+export interface ICrudStdActionParams {
+  appCode: string;
+  settingKey?: string;
+  buttonSettingKey?: string;
+}
+
+
+export interface IRequestModelCrudProExt extends IRequestModel {
+  filterValue: string | number;
+}
+
+
+
+function getExecuteTableNameBySettingKey(appInfo: ICrudStdAppInfoForSettingKey, stdAction: ICrudStdActionParams): string {
+  const { settingKey } = stdAction || {};
+
+  const stdCrudCfgObj = appInfo.stdCrudCfgObj;
+  const actionsMap = appInfo.actionsMap || {};
+
+  const actionCfg = actionsMap[settingKey];
+  if (actionCfg) {
+    const mainTableName = _.get(actionCfg, 'component.props.mainTableName');
+    if (typeof mainTableName === 'string' && mainTableName.trim().length > 0) {
+      return mainTableName.trim();
+    }
+  }
+
+  return stdCrudCfgObj.tableBaseInfo.tableName;
+}
+
+@Provide()
+export class CrudStdService extends ApiBaseService {
+
+  @Inject()
+  protected ctx: Context;
+
+  @Inject()
+  protected curdMixService: CurdMixService;
+
+  @Inject()
+  protected crudStdActionService: CrudStdActionService;
+
+  @Inject()
+  protected crudStdRelationService: CrudStdRelationService;
+
+  /**
+   * 执行普通CRUD
+   */
+  public async executeStdQuery(stdAction: ICrudStdActionParams, params: IRequestModelCrudProExt, sqlSimpleName: KeysOfSimpleSQL): Promise<ExecuteContext> {
+    const appCode = stdAction.appCode;
+    const appInfo = await this.getParsedCrudStdAppForSettingKey(stdAction);
+    const stdCrudCfgObj = appInfo.stdCrudCfgObj;
+
+    if (!appInfo || appInfo.status !== 1) {
+      throw new BizException('应用不存在或已下线：' + appCode);
+    }
+
+    const databaseName = stdCrudCfgObj.tableBaseInfo.databaseName;
+
+    const { dbType, dbName } = parseDatabaseName(databaseName);
+
+    const cfgModel: IRequestCfgModel = {
+      sqlDatabase: dbName,
+      sqlDbType: dbType,
+      sqlTable: getExecuteTableNameBySettingKey(appInfo, stdAction),
+      sqlSimpleName,
+      updateCfg: {}
+    };
+
+    // 接口返回最大值
+    const maxLimit = _.get(stdCrudCfgObj, 'othersSetting.values.maxLimit');
+
+    if (typeof maxLimit === 'number' && maxLimit > 0) {
+      cfgModel.maxLimit = maxLimit;
+    }
+
+    if (!appInfo.settingKeyActionCfg.hasOperationPerm) {
+      throw new BizException('没有权限');
+    }
+
+    // 软删除操作。
+    await this.fixCfgModelAndParamBySoftDelete(params, cfgModel, appInfo, sqlSimpleName);
+
+    // 根据用户配置，设置关联查询的数据信息。
+    await this.crudStdRelationService.addCfgModelColumnsRelation(cfgModel, appInfo);
+
+    // 根据FilterValue参数，设置updateCfg
+    await this.fixCfgModelByFilterValue(params, cfgModel, appInfo, { dbType, dbName });
+
+    // 根据用户配置的keepSubmitData字段修改提交的数据
+    await this.fixSubmitDataByKeepSubmitData(params, cfgModel, appInfo, { dbType, dbName });
+
+    // 根据表结构的数据类型，修正数据类型
+    await this.fixDataFieldTypeBySqlTableField(params, cfgModel, appInfo, { dbType, dbName });
+
+    // 业务系统自定义的修改：查询前的查询条件：cfgModel
+    await GLOBAL_STATIC_CONFIG.getConfig().bizUpdateCfgModelForCrudStd(params, cfgModel, appInfo, this.ctx);
+
+    const crudExeCtx = await this.curdMixService.executeCrudByCfg(params, cfgModel);
+
+    // 处理结果
+    await this.handleResult(stdAction, params, cfgModel, appInfo, crudExeCtx);
+
+    // 业务系统自定义的修改：查询后的返回值。
+    await GLOBAL_STATIC_CONFIG.getConfig().bizUpdateExecuteContextForCrudStd(params, cfgModel, appInfo, this.ctx, crudExeCtx);
+
+    return crudExeCtx;
+  }
+
+
+  private async handleResult(stdAction: ICrudStdActionParams, params: IRequestModelCrudProExt, cfgModel: IRequestCfgModel, appInfo: ICrudStdAppInfoForSettingKey, crudExeCtx: ExecuteContext) {
+    await this.handleResultDataPermissionBySettingKey(stdAction, params, cfgModel, appInfo, crudExeCtx);
+  }
+
+  private async handleResultDataPermissionBySettingKey(stdAction: ICrudStdActionParams, params: IRequestModelCrudProExt, cfgModel: IRequestCfgModel, appInfo: ICrudStdAppInfoForSettingKey, crudExeCtx: ExecuteContext) {
+    const { settingKey } = stdAction || {};
+
+    if (settingKey !== SPECIAL_SETTING_KEY.QUERY_LIST && settingKey !== SPECIAL_SETTING_KEY.QUERY_ONE) {
+      return;
+    }
+
+    const rows = crudExeCtx.getResRows();
+    if (!Array.isArray(rows)) {
+      return;
+    }
+
+    const actionColumns: any[] = _.get(appInfo, 'stdCrudCfgObj.actionColumns');
+
+
+    const checkDataPermissionObjBySettingKey = (record: any): any => {
+      const permissionObj = {};
+      let count = 0;
+      const sessionInfo = (this.ctx?.userSession?.getSessionInfo()) || {};
+      for (let index = 0; index < actionColumns.length; index++) {
+        const column = actionColumns[index];
+        const rowAuthCfg = parseJsonObject(column.rowAuthCfg);
+        if (rowAuthCfg && typeof rowAuthCfg.authByExpress === 'string') {
+          const authByExpress = rowAuthCfg.authByExpress.trim();
+          if (authByExpress) {
+            const authResult = ejs.render(authByExpress, { record, sessionInfo, params, _ });
+            permissionObj[column.settingKey] = authResult;
+            count++;
+          }
+        }
+      }
+      if (count > 0) {
+        return permissionObj;
+      }
+      return null;
+    }
+
+
+    if (Array.isArray(actionColumns) && actionColumns.length > 0) {
+      for (let index = 0; index < rows.length; index++) {
+        const row = rows[index];
+        const dataPermissionObjBySettingKey = checkDataPermissionObjBySettingKey(row);
+        if (dataPermissionObjBySettingKey) {
+          row['__dataPermissionObjBySettingKey'] = dataPermissionObjBySettingKey;
+        }
+      }
+    }
+
+  }
+
+
+
+
+  /**
+   * 获取appInfo 并且拿到当前settingKey相关的信息
+   * @param appCode
+   * @param settingKey
+   * @private
+   */
+  private async getParsedCrudStdAppForSettingKey(stdAction: ICrudStdActionParams): Promise<ICrudStdAppInfoForSettingKey> {
+    const { appCode, settingKey, buttonSettingKey } = stdAction || {};
+    if (!appCode) {
+      throw new BizException('缺少参数:curdStdAppCode');
+    }
+    const appInfo: ICrudStdAppInfoForSettingKey = await this.getParsedCrudStdAppInfo(appCode);
+    if (!appInfo) {
+      return null;
+    }
+
+    const actionsMap = appInfo.actionsMap;
+    const appSchema = appInfo.stdCrudCfgObj;
+
+    if (settingKey === SPECIAL_SETTING_KEY.QUERY_LIST || settingKey === SPECIAL_SETTING_KEY.QUERY_ONE) {
+      const authSettingValues = _.get(appSchema, 'authSetting.values');
+      const { auth_type, auth_config_by_func_code, auth_config_by_role_code } = authSettingValues || {};
+      const authConfig = auth_type === 'byFuncCode' ? auth_config_by_func_code : auth_config_by_role_code;
+      const hasOperationPerm = this.ctx.userSession.isAuthPass(auth_type as any, authConfig);
+      appInfo.settingKeyActionCfg = { settingKey, hasOperationPerm };
+    } else {
+      const actionCfg = actionsMap[settingKey];
+      if (!actionCfg) {
+        throw new BizException('没有找到相关配置:' + JSON.stringify({ appCode, settingKey }));
+      }
+      const componentNameCfg = _.get(actionCfg, 'component.componentName');
+      if (!componentNameCfg) {
+        throw new BizException('没有配置动作组件:' + JSON.stringify({ appCode, settingKey }));
+      }
+      appInfo.settingKeyActionCfg = actionCfg;
+    }
+
+    if (buttonSettingKey) {
+      appInfo.buttonSettingKeyActionCfg = actionsMap[buttonSettingKey];
+    }
+
+    return appInfo;
+  }
+
+  /**
+   * 执行动作
+   * @param stdAction
+   * @param params
+   */
+  public async executeStdActionByReq(stdAction: ICrudStdActionParams, params: IRequestModelCrudProExt): Promise<ExecuteContext> {
+    const appInfo = await this.getParsedCrudStdAppForSettingKey(stdAction);
+    if (!appInfo || appInfo.status !== 1) {
+      throw new BizException('应用不存在或已下线：' + stdAction.appCode);
+    }
+
+    const actionsMap = appInfo.actionsMap;
+    const actionCfg = appInfo.settingKeyActionCfg;
+
+    return this.crudStdActionService.handleStdActionByReq({ appInfo, params, actionsMap, actionCfg });
+  }
+
+  /**
+   * 查询APP信息
+   * @param appCode
+   * @private
+   */
+  private async getCrudStdAppInfo(appCode?: string) {
+    const { SystemDbName, SystemDbType } = GLOBAL_STATIC_CONFIG.getConfig();
+
+    this.logInfo('getCrudStdAppInfo', appCode);
+
+    const ss = {
+      sqlTable: SystemTables.sys_app,
+      sqlSimpleName: KeysOfSimpleSQL.SIMPLE_QUERY_ONE,
+      sqlDatabase: SystemDbName,
+      sqlDbType: SystemDbType,
+    };
+    return await this.curdMixService.executeCrudByCfg({ condition: { app_code: appCode } }, ss);
+  }
+
+
+  /**
+ * 查询APP信息
+ * @param appCode
+ * @private
+ */
+  public async getParsedCrudStdAppInfo(appCode: string): Promise<ICrudStdAppInfo> {
+    const cacheKey = 'getParsedCrudStdAppInfo:' + appCode;
+    let appInfo: ICrudStdAppInfo = this.getFromCtxCache(cacheKey) as any;
+    if (!appInfo) {
+      appInfo = await this.getParsedCrudStdAppInfoPrivate(appCode);
+      this.setToCtxCache(cacheKey, appInfo);
+    }
+    return appInfo;
+  }
+
+
+  /**
+   * 查询APP信息
+   * @param appCode
+   * @private
+   */
+  private async getParsedCrudStdAppInfoPrivate(appCode: string): Promise<ICrudStdAppInfo> {
+    const a = await this.getCrudStdAppInfo(appCode);
+    const { row } = a.getResModel();
+    if (!row) {
+      return null;
+    }
+    const { app_schema, ...others } = row;
+    const stdCrudCfgObj = parseJsonObject(app_schema);
+
+    const handleArrayCfg = (arrayCfg: any[]) => {
+      if (Array.isArray(arrayCfg)) {
+        for (let j = 0; j < arrayCfg.length; j++) {
+          const actionCfg = arrayCfg[j];
+          actionCfg.hasOperationPerm = this.hasOperationPerm(actionCfg);
+          if (actionCfg.settingKey) {
+            actionsMap[actionCfg.settingKey] = actionCfg;
+          }
+          const submitButtonCfg = _.get(actionCfg, 'component.props.submitButtonCfg');
+          handleArrayCfg(submitButtonCfg);
+        }
+      }
+    };
+
+    // 为了方便查找到action对象
+    const actionsMap = {};
+    const keys = Object.keys(stdCrudCfgObj);
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      const arrayCfg = stdCrudCfgObj[key];
+      handleArrayCfg(arrayCfg);
+    }
+
+    return { ...others, stdCrudCfgObj, actionsMap };
+  }
+
+  private hasOperationPerm(actionCfg: any): boolean {
+    const permissionCode = _.get(actionCfg, 'permissionCode');
+    if (permissionCode) {
+      return this.ctx.userSession.isAuthPass(KeysOfAuthType.byFuncCode, permissionCode);
+    }
+    return true; // 无需鉴权
+  }
+
+
+
+  private async fixCfgModelAndParamBySoftDelete(params: IRequestModelCrudProExt, cfgModel: IRequestCfgModel, appInfo: ICrudStdAppInfoForSettingKey, sqlSimpleName: KeysOfSimpleSQL) {
+    const stdCrudCfgObj = appInfo.stdCrudCfgObj;
+    //删除策略
+    const deleteStrategy = _.get(stdCrudCfgObj, 'othersSetting.values.deleteStrategy');
+  
+    if(deleteStrategy !== 'soft') {
+      return;
+    }
+
+    // 删除操作，如果是软删除修改为update语句。
+    // 标准软删除：deleted_at 字段为0代表未删除，有任意时间字段代表已删除。
+    if(KeysOfSimpleSQL.SIMPLE_DELETE === sqlSimpleName) {
+      const userSession =  this.ctx?.userSession?.getSessionInfo();
+      if(!params.data) {
+        params.data = {};
+      }
+      params.data.deleted_at = Date.now(); // 默认值为 0； 0代表未删除
+      params.data.deleted_by = userSession?.accountId || "";
+
+      // 执行update操作
+      cfgModel.sqlSimpleName = KeysOfSimpleSQL.SIMPLE_UPDATE;
+
+      if(!params.condition || Object.keys(params.condition).length === 0) {
+        throw new Error('执行删除操作，必须指定删除条件')
+      }
+    }
+
+    // 查询操作。强制查询未删除的。
+    if (KeysOfSimpleSQL.SIMPLE_QUERY_ONE === sqlSimpleName || KeysOfSimpleSQL.SIMPLE_QUERY_PAGE === sqlSimpleName) {
+      if(!params.condition) {
+        params.condition = {};
+      }
+      params.condition.deleted_at = 0; // 未删除
+    }
+
+
+  }
+
+  private async fixCfgModelByFilterValue(params: IRequestModelCrudProExt, cfgModel: IRequestCfgModel, appInfo: ICrudStdAppInfoForSettingKey, arg3: { dbType: SqlDbType; dbName: string }) {
+
+    const { filterValue } = params || {};
+
+    if (!filterValue && filterValue !== 0) {
+      return;
+    }
+
+    const filterList: any[] = _.get(appInfo, 'stdCrudCfgObj.filterList');
+    if (!Array.isArray(filterList) || filterList.length === 0) {
+      this.logWarn('filterValue存在，但是filterList没有设置')
+      return;
+    }
+
+    const filterItem = filterList.find(item => item.value === filterValue);
+    if (!filterItem) {
+      this.logWarn('filterValue存在，但是filterList中没有找到此配置项')
+      return;
+    }
+    const partialCondition = _.get(filterItem, 'partialCondition');
+    if (!partialCondition) {
+      this.logWarn('filterValue存在，但是filterList中的配置项没有设置partialCondition')
+      return;
+    }
+
+    const partialConditionObj = parseJsonObject(partialCondition);
+    if (Object.keys(partialConditionObj).length > 0) {
+      // partialConditionObj 配置的是 condition.xxxx = xx的形式
+      _.merge(cfgModel.updateCfg, partialConditionObj);
+    }
+
+  }
+
+
+  private async fixSubmitDataByKeepSubmitData(params: IRequestModelCrudProExt, cfgModel: IRequestCfgModel, appInfo: ICrudStdAppInfoForSettingKey, arg3: { dbType: SqlDbType; dbName: string }) {
+
+    if (cfgModel.sqlSimpleName === KeysOfSimpleSQL.SIMPLE_INSERT || cfgModel.sqlSimpleName === KeysOfSimpleSQL.SIMPLE_UPDATE) {
+      const submitData: any = params.data || {};
+
+      //1. 按钮中配置的keepSubmitData
+      const buttonActionCfg = appInfo.buttonSettingKeyActionCfg || {};
+      const keepSubmitDataByButtonStr = _.get(buttonActionCfg, 'keepSubmitData');
+      const keepSubmitDataByButton = parseJsonObject(keepSubmitDataByButtonStr);
+
+
+      //2. 全局配置的keepSubmitData
+      const keepSubmitDataByGlobalStr = _.get(appInfo, 'stdCrudCfgObj.othersSetting.values.keepSubmitData');
+      const keepSubmitDataByGlobal = parseJsonObject(keepSubmitDataByGlobalStr);
+
+      //3. 合并
+      _.merge(submitData, keepSubmitDataByButton);
+      _.merge(submitData, keepSubmitDataByGlobal);
+    }
+
+  }
+
+
+  private async fixDataFieldTypeBySqlTableField(params: IRequestModel, cfgModel: IRequestCfgModel, appInfo: ICrudStdAppInfoForSettingKey, arg3: { dbType: SqlDbType; dbName: string }) {
+    const tableFields = _.get(appInfo, 'stdCrudCfgObj.tableFields');
+
+    const tableFieldMap = MixinUtils.toMap(tableFields, (e: any) => {
+      return e.fieldIndex;
+    });
+
+    if (arg3.dbType === SqlDbType.postgres) {
+      if (cfgModel.sqlSimpleName === KeysOfSimpleSQL.SIMPLE_INSERT || cfgModel.sqlSimpleName === KeysOfSimpleSQL.SIMPLE_UPDATE) {
+        const data = params.data || {};
+        const dataKeys = Object.keys(data);
+        for (let index = 0; index < dataKeys.length; index++) {
+          const dataKey = dataKeys[index];
+          const dataValue = data[dataKey];
+          const fieldInfo = tableFieldMap[dataKey];
+          const fieldType = ('' + _.get(fieldInfo, 'type')).toUpperCase();
+          if (fieldType === 'ARRAY') {
+            const dataValueArray = parseJsonObject(dataValue);
+            if (Array.isArray(dataValueArray)) {
+              data[dataKey] = `{${dataValueArray.map(v => `"${v}"`).join(',')}}`;
+            }
+          }
+        }
+      }
+    }
+  }
+}