midway-fatcms 0.0.1-beta.6 → 0.0.1-beta.60

package/src/controller/gateway/AsyncTaskController.ts

@@ -0,0 +1,157 @@
+import * as fs from 'fs';
+import * as fs2 from 'node:fs/promises';
+import { Controller, Inject, Post, Query, Get } from '@midwayjs/core';
+import { Context } from '@midwayjs/koa';
+import { BaseApiController } from '../base/BaseApiController';
+import { AsyncTaskService } from '@/service/asyncTask/AsyncTaskService';
+import { SysAsyncTaskEntity, SysAsyncTaskStatus } from '@/models/AsyncTaskModel';
+import { KeysOfSimpleSQL } from '@/libs/crud-pro/models/keys';
+import { SystemTables } from '@/models/SystemTables';
+import { CommonException } from '@/libs/crud-pro/exceptions';
+import { checkLogin } from '@/middleware/permission.middleware';
+import { parseJsonObject } from '@/libs/utils/functions';
+
+function fixMyTasksCondition(body: any, ctx: Context) {
+  if (!body.condition) {
+    throw new CommonException('参数不正确');
+  }
+  body.condition.created_by = ctx.userSession.getSessionInfo().accountId;
+}
+
+function fixCancelBodyData(body: any, id: number) {
+  if (!body.data || !body.condition) {
+    throw new CommonException('参数不正确');
+  }
+
+  // fix condition
+  const conditionObj: SysAsyncTaskEntity = (body.condition || {}) as any;
+  conditionObj.id = id;
+  body.condition = conditionObj;
+
+  // fix data
+  const dataObj: SysAsyncTaskEntity = (body.data || {}) as any;
+  dataObj.task_status = SysAsyncTaskStatus.CANCELLED;
+  body.data = dataObj;
+}
+
+function fixCreateBodyData(body: any, ctx: Context) {
+  if (!body.data) {
+    throw new CommonException('参数不正确');
+  }
+
+  const sessionInfo = ctx.userSession.getSessionInfo();
+  // fix data
+  const dataObj: SysAsyncTaskEntity = (body.data || {}) as any;
+  const input_params = parseJsonObject(dataObj.input_params) || {};
+  const headers = ctx.headers || {};
+  input_params.headers = {
+    fatcmscsrftoken: headers.fatcmscsrftoken,
+    host: headers.host,
+    origin: headers.origin,
+  };
+  dataObj.task_status = SysAsyncTaskStatus.PENDING;
+  dataObj.created_by = sessionInfo.accountId;
+  dataObj.created_user_session = JSON.stringify(sessionInfo); // 创建人的session信息。用于执行时的鉴权。
+  dataObj.input_params = JSON.stringify(input_params);
+}
+
+/**
+ * 异步任务框架
+ */
+@Controller('/ns/gw/AsyncTask', { middleware: [checkLogin()] })
+export class AsyncTaskController extends BaseApiController {
+  @Inject()
+  protected ctx: Context;
+
+  @Inject()
+  private asyncTaskService: AsyncTaskService;
+
+  // 获取任务列表
+  @Post('/getMyTasks')
+  async getMyTasks() {
+    fixMyTasksCondition(this.ctx.request.body, this.ctx);
+    return this.executeSysSimpleSQL(SystemTables.sys_async_tasks, KeysOfSimpleSQL.SIMPLE_QUERY_PAGE);
+  }
+
+  // 创建任务
+  @Post('/createTask')
+  async createTask() {
+    //每个用户：5秒内只能创建1次任务
+    await this.checkUserActionTimeLimit('AsyncTaskController_createTask', 5);
+
+    fixCreateBodyData(this.ctx.request.body, this.ctx);
+    const res = await this.executeSysSimpleSQL(SystemTables.sys_async_tasks, KeysOfSimpleSQL.SIMPLE_INSERT);
+    await this.asyncTaskService.startTask();
+    return res;
+  }
+
+  // 取消任务
+  @Post('/cancelTask')
+  async cancelTask(@Query('id') id: number) {
+    fixCancelBodyData(this.ctx.request.body, id);
+    await this.asyncTaskService.cancelTask(id);
+    await this.executeSysSimpleSQL(SystemTables.sys_async_tasks, KeysOfSimpleSQL.SIMPLE_UPDATE);
+    return { success: true };
+  }
+
+  // 下载异步任务的导出文件
+  @Get('/downloadExportFile')
+  async downloadExportFile(@Query('task_uuid') task_uuid: string, @Query('id') id: string) {
+    if (!task_uuid) {
+      throw new CommonException('task_uuid is not exist');
+    }
+    if (!id) {
+      throw new CommonException('id is not exist');
+    }
+
+    this.ctx.request.body = {
+      condition: {
+        task_uuid: task_uuid,
+        id: id,
+      },
+    };
+    const res = await this.executeSysSimpleSQL(SystemTables.sys_async_tasks, KeysOfSimpleSQL.SIMPLE_QUERY_ONE);
+    const taskObj: SysAsyncTaskEntity = res.getOneObj();
+    if (!taskObj) {
+      throw new CommonException('任务不存在');
+    }
+
+    const output_file_path = taskObj.output_file_path;
+    if (!output_file_path) {
+      throw new CommonException('导出文件不存在, 可能是任务没有执行完成');
+    }
+
+    try {
+      await fs2.access(output_file_path);
+    } catch (e) {
+      throw new CommonException('导出文件不存在，可能是文件被删除了。');
+    }
+
+    await this.responseLocalFileForAsyncTask(taskObj);
+
+    return undefined;
+  }
+
+  /**
+   * 响应异步任务的导出文件
+   * @param taskObj
+   */
+  private async responseLocalFileForAsyncTask(taskObj: SysAsyncTaskEntity): Promise<void> {
+    const output_file_path = taskObj.output_file_path;
+    const outputFileName = taskObj.task_name + '_' + taskObj.id + '.' + taskObj.output_file_format;
+
+    const stat = await fs2.stat(output_file_path);
+    const headers = {
+      'content-length': '' + stat.size,
+      'content-type': 'application/octet-stream',
+      'content-disposition': `attachment; filename*=UTF-8''${encodeURIComponent(outputFileName)}`,
+    };
+
+    const stream = fs.createReadStream(output_file_path);
+    stream.setMaxListeners(50);
+    this.logInfo(`[AsyncTaskController]返回本地文件: ${output_file_path}`);
+    this.ctx.status = 200;
+    this.ctx.set(headers);
+    this.ctx.body = stream;
+  }
+}

package/src/controller/gateway/CrudMtdGatewayController.ts

@@ -1,107 +1,116 @@
-import * as _ from 'lodash';
-import { decamelizeKeys } from 'humps';
-import { Controller, Inject, Param, All } from '@midwayjs/core';
-import { Context } from '@midwayjs/koa';
-import { CommonResult } from '../../libs/utils/common-dto';
-import { WorkbenchService } from '../../service/WorkbenchService';
-import { API_BASE_TYPE, ApiBaseService } from '../../service/base/ApiBaseService';
-import { CurdProService } from '../../service/curd/CurdProService';
-import { CurdMixService } from '../../service/curd/CurdMixService';
-import { IRequestCfgModel2 } from '../../models/bizmodels';
-import {parseDatabaseName} from "../../libs/crud-pro/utils/DatabaseName";
-
-const QUERY_AS_LIST = ['condition', 'data'];
-
-function pickAsQuery(query_as_pick: string, query: any): any {
-  if (query_as_pick && typeof query_as_pick === 'string') {
-    const pickArray = query_as_pick.split(',');
-    return _.pick(query, pickArray);
-  }
-  return query;
-}
-
-// /ns/gw/api/crudMtd/getUser?__query_as_condition__=id&_query_as_data__=name&&id=1&name=22
-/**
- *    query形式1：GET: /ns/gw/api/crudMtd/getUser?__query_json__=%7B%22condition%22%3A%7B%22id%22%3A2%7D%7D
- *    query形式2：GET: /ns/gw/api/crudMtd/getUser?__query_as__=condition&id=1&name=22
- *    query形式3：GET: /ns/gw/api/crudMtd/createUser?__query_as__=data&__query_pick__=id,name&id=1&name=22
- *
- * 执行单个配置的接口
- */
-@Controller('/ns/gw/crudApi')
-export class CrudMtdGatewayController extends ApiBaseService {
-  @Inject()
-  protected ctx: Context;
-
-  @Inject()
-  protected workbenchService: WorkbenchService;
-
-  @Inject()
-  private curdProService: CurdProService;
-
-  @Inject()
-  private curdMixService: CurdMixService;
-
-  /**
-   * 执行配置出来的接口的接口。此接口本身不需要鉴权。鉴权信息在配置中由curdPro底层进行鉴权
-   */
-  @All('/execute/:methodCode')
-  async executeCrudMethod(@Param('methodCode') methodCode: string) {
-    if (!methodCode) {
-      return CommonResult.errorRes('method参数不存在');
-    }
-
-    const methodInfo = (await this.curdProService.getCachedCfgByMethod(methodCode)) as any;
-    if (!methodInfo || methodInfo.status !== 1) {
-      return CommonResult.errorRes('接口不存在或已下线: ' + methodCode);
-    }
-
-    this.logInfo("methodInfo=== ", methodInfo)
-
-    const workbench_code_array = methodInfo.workbench_code_array || methodInfo.workbenchCodeArray;
-    const isSupport = await this.workbenchService.isSupportCurrentWorkbench(workbench_code_array);
-    if (!isSupport) {
-      return CommonResult.errorRes('此接口不支持在当前站点打开');
-    }
-
-    // 权限等校验\服务降级\限流令牌桶
-    const entity = decamelizeKeys(methodInfo) as any;
-    await super.beforeCheckApiAccessibility(API_BASE_TYPE.CRUD_METHOD, entity);
-
-    const reqJson: any = {};
-
-    const body = this.ctx.request.body as any;
-    if (body && typeof body === 'object') {
-      Object.assign(reqJson, body);
-    }
-
-    const query = this.ctx.query || {};
-
-    const query_json = query['__query_json__'];
-    const query_as = query['__query_as__'] as string;
-    const query_pick = query['__query_pick__'] as string; // 以逗号分割的字段列表。只部分字段作为参数。。
-
-    delete query['__query_json__'];
-    delete query['__query_as__'];
-    delete query['__query_pick__'];
-
-    if (query_json && typeof query_json === 'string') {
-      const queryJson = JSON.parse(query_json);
-      Object.assign(reqJson, queryJson);
-    }
-
-    if (query_as && QUERY_AS_LIST.includes(query_as)) {
-      const pickedQuery = pickAsQuery(query_pick, query);
-      _.set(reqJson, query_as, pickedQuery);
-    }
-
-    Object.assign(reqJson, { method: methodCode });
-
-    const cfgModel = methodInfo as IRequestCfgModel2;
-    const { dbType, dbName } = parseDatabaseName(cfgModel.sqlDatabase);
-    cfgModel.sqlDatabase = dbName;
-    cfgModel.sqlDdType = dbType;
-
-    return this.curdMixService.executeCrudByCfg(reqJson, cfgModel);
-  }
-}
+import * as _ from 'lodash';
+import { decamelizeKeys } from 'humps';
+import { Controller, Inject, Param, All } from '@midwayjs/core';
+import { Context } from '@midwayjs/koa';
+import { CommonResult } from '@/libs/utils/common-dto';
+import { WorkbenchService } from '@/service/WorkbenchService';
+import { API_BASE_TYPE, ApiBaseService } from '@/service/base/ApiBaseService';
+import { CurdProService } from '@/service/curd/CurdProService';
+import { CurdMixService } from '@/service/curd/CurdMixService';
+import { IRequestCfgModel2 } from '@/models/bizmodels';
+import { parseDatabaseName } from '@/libs/crud-pro/utils/DatabaseName';
+import { GLOBAL_STATIC_CONFIG } from '@/libs/global-config/global-config';
+
+const QUERY_AS_LIST = ['condition', 'data'];
+
+function pickAsQuery(query_as_pick: string, query: any): any {
+  if (query_as_pick && typeof query_as_pick === 'string') {
+    const pickArray = query_as_pick.split(',');
+    return _.pick(query, pickArray);
+  }
+  return query;
+}
+
+// /ns/gw/crudApi/getUser?__query_as_condition__=id&_query_as_data__=name&&id=1&name=22
+/**
+ *    query形式1：GET: /ns/gw/crudApi/getUser?__query_json__=%7B%22condition%22%3A%7B%22id%22%3A2%7D%7D
+ *    query形式2：GET: /ns/gw/crudApi/getUser?__query_as__=condition&id=1&name=22
+ *    query形式3：GET: /ns/gw/crudApi/createUser?__query_as__=data&__query_pick__=id,name&id=1&name=22
+ *
+ * 执行单个配置的接口
+ */
+@Controller('/ns/gw/crudApi')
+export class CrudMtdGatewayController extends ApiBaseService {
+  @Inject()
+  protected ctx: Context;
+
+  @Inject()
+  protected workbenchService: WorkbenchService;
+
+  @Inject()
+  private curdProService: CurdProService;
+
+  @Inject()
+  private curdMixService: CurdMixService;
+
+  /**
+   * 执行配置出来的接口的接口。此接口本身不需要鉴权。鉴权信息在配置中由curdPro底层进行鉴权
+   */
+  @All('/execute/:methodCode')
+  async executeCrudMethod(@Param('methodCode') methodCode: string) {
+    if (!methodCode) {
+      return CommonResult.errorRes('method参数不存在');
+    }
+
+    const methodInfo = (await this.curdProService.getCachedCfgByMethod(methodCode)) as any;
+    if (!methodInfo || methodInfo.status !== 1) {
+      return CommonResult.errorRes('接口不存在或已下线: ' + methodCode);
+    }
+
+    this.logInfo('methodInfo=== ', methodInfo);
+
+    const workbench_code_array = methodInfo.workbench_code_array || methodInfo.workbenchCodeArray;
+    const isSupport = await this.workbenchService.isSupportCurrentWorkbench(workbench_code_array);
+    if (!isSupport) {
+      return CommonResult.errorRes('此接口不支持在当前站点打开');
+    }
+
+    // 权限等校验\服务降级\限流令牌桶
+    const entity = decamelizeKeys(methodInfo) as any;
+    await super.beforeCheckApiAccessibility(API_BASE_TYPE.CRUD_METHOD, entity);
+
+    const reqJson: any = {};
+
+    const body = this.ctx.request.body as any;
+    if (body && typeof body === 'object') {
+      Object.assign(reqJson, body);
+    }
+
+    const query = this.ctx.query || {};
+
+    const query_json = query['__query_json__'];
+    const query_as = query['__query_as__'] as string;
+    const query_pick = query['__query_pick__'] as string; // 以逗号分割的字段列表。只部分字段作为参数。。
+
+    delete query['__query_json__'];
+    delete query['__query_as__'];
+    delete query['__query_pick__'];
+
+    if (query_json && typeof query_json === 'string') {
+      const queryJson = JSON.parse(query_json);
+      Object.assign(reqJson, queryJson);
+    }
+
+    if (query_as && QUERY_AS_LIST.includes(query_as)) {
+      const pickedQuery = pickAsQuery(query_pick, query);
+      _.set(reqJson, query_as, pickedQuery);
+    }
+
+    Object.assign(reqJson, { method: methodCode });
+
+    const cfgModel = methodInfo as IRequestCfgModel2;
+    const { dbType, dbName } = parseDatabaseName(cfgModel.sqlDatabase);
+    cfgModel.sqlDatabase = dbName;
+    cfgModel.sqlDbType = dbType;
+
+    // 业务系统自定义的修改cfgModel
+    await GLOBAL_STATIC_CONFIG.getConfig().bizUpdateCfgModelForCrudMtd(reqJson, cfgModel, methodInfo, this.ctx);
+
+    const result = await this.curdMixService.executeCrudByCfg(reqJson, cfgModel);
+
+    // 业务系统自定义的修改cfgModel
+    await GLOBAL_STATIC_CONFIG.getConfig().bizUpdateExecuteContextForCrudMtd(reqJson, cfgModel, methodInfo, this.ctx, result);
+
+    return result;
+  }
+}

package/src/controller/gateway/CrudStdGatewayController.ts

@@ -1,101 +1,87 @@
-import { Controller, Inject, Post } from '@midwayjs/core';
-import { Context } from '@midwayjs/koa';
-import { BaseApiController } from '../base/BaseApiController';
-import { CrudStdService, SPECIAL_SETTING_KEY } from '../../service/crudstd/CrudStdService';
-import { KeysOfSimpleSQL } from '../../libs/crud-pro/models/keys';
-import { IRequestModel } from '../../libs/crud-pro/interfaces';
-import { CommonResult } from '../../libs/utils/common-dto';
-
-interface ICrudStdActionParams {
-  appCode: string;
-  settingKey?: string;
-}
-
-type ICrudStdParams = { stdAction: ICrudStdActionParams } & IRequestModel;
-
-/**
- * 零代码配置的界面，相关的接口的执行
- */
-@Controller('/ns/gw/api/crudStd')
-export class CrudStdGatewayController extends BaseApiController {
-  @Inject()
-  protected ctx: Context;
-
-  @Inject()
-  private crudStdService: CrudStdService;
-
-  /**
-   * 获取零代码应用基本信息
-   */
-  @Post('/getParsedCrudStdAppInfo')
-  async getParsedCrudStdAppInfo(): Promise<CommonResult> {
-    const body = this.ctx.request.body as ICrudStdParams;
-    const appCode = body.stdAction.appCode;
-    const parsedAppInfo = await this.crudStdService.getParsedCrudStdAppInfo(appCode);
-    return CommonResult.successNotNull(parsedAppInfo);
-  }
-
-  /**
-   * 列表查询: 分页查询
-   */
-  @Post('/getObjectList')
-  async getObjectList() {
-    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
-    const appCode = stdAction.appCode;
-    return this.crudStdService.executeStdQuery(appCode, SPECIAL_SETTING_KEY.QUERY_LIST, otherParams, KeysOfSimpleSQL.SIMPLE_QUERY_PAGE);
-  }
-
-  /**
-   * 单个查询
-   */
-  @Post('/getObjectOne')
-  async getObjectOne() {
-    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
-    const appCode = stdAction.appCode;
-    return this.crudStdService.executeStdQuery(appCode, SPECIAL_SETTING_KEY.QUERY_ONE, otherParams, KeysOfSimpleSQL.SIMPLE_QUERY_ONE);
-  }
-
-  /**
-   * 单个删除
-   */
-  @Post('/deleteObject')
-  async deleteObject() {
-    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
-    const appCode = stdAction.appCode;
-    const settingKey = stdAction.settingKey;
-    return this.crudStdService.executeStdQuery(appCode, settingKey, otherParams, KeysOfSimpleSQL.SIMPLE_DELETE);
-  }
-
-  /**
-   * 单个创建
-   */
-  @Post('/createObject')
-  async createObject() {
-    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
-    const appCode = stdAction.appCode;
-    const settingKey = stdAction.settingKey;
-    return this.crudStdService.executeStdQuery(appCode, settingKey, otherParams, KeysOfSimpleSQL.SIMPLE_INSERT);
-  }
-
-  /**
-   * 单个更新
-   */
-  @Post('/updateObject')
-  async updateObject() {
-    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
-    const appCode = stdAction.appCode;
-    const settingKey = stdAction.settingKey;
-    return this.crudStdService.executeStdQuery(appCode, settingKey, otherParams, KeysOfSimpleSQL.SIMPLE_UPDATE);
-  }
-
-  /**
-   * 执行操作
-   */
-  @Post('/executeStdAction')
-  async executeStdAction() {
-    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
-    const appCode = stdAction.appCode;
-    const settingKey = stdAction.settingKey;
-    return await this.crudStdService.executeStdActionByReq(appCode, settingKey, otherParams);
-  }
-}
+import { Controller, Inject, Post } from '@midwayjs/core';
+import { Context } from '@midwayjs/koa';
+import { BaseApiController } from '../base/BaseApiController';
+import { CrudStdService, SPECIAL_SETTING_KEY, ICrudStdActionParams, IRequestModelCrudProExt } from '@/service/crudstd/CrudStdService';
+import { KeysOfSimpleSQL } from '@/libs/crud-pro/models/keys';
+import { CommonResult } from '@/libs/utils/common-dto';
+
+type ICrudStdParams = { stdAction: ICrudStdActionParams } & IRequestModelCrudProExt;
+
+/**
+ * 零代码配置的界面，相关的接口的执行
+ */
+@Controller('/ns/gw/api/crudStd')
+export class CrudStdGatewayController extends BaseApiController {
+  @Inject()
+  protected ctx: Context;
+
+  @Inject()
+  private crudStdService: CrudStdService;
+
+  /**
+   * 获取零代码应用基本信息
+   */
+  @Post('/getParsedCrudStdAppInfo')
+  async getParsedCrudStdAppInfo(): Promise<CommonResult> {
+    const body = this.ctx.request.body as ICrudStdParams;
+    const appCode = body.stdAction.appCode;
+    const parsedAppInfo = await this.crudStdService.getParsedCrudStdAppInfo(appCode);
+    return CommonResult.successNotNull(parsedAppInfo);
+  }
+
+  /**
+   * 列表查询: 分页查询
+   */
+  @Post('/getObjectList')
+  async getObjectList() {
+    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
+    stdAction.settingKey = SPECIAL_SETTING_KEY.QUERY_LIST;
+    return this.crudStdService.executeStdQuery(stdAction, otherParams, KeysOfSimpleSQL.SIMPLE_QUERY_PAGE);
+  }
+
+  /**
+   * 单个查询
+   */
+  @Post('/getObjectOne')
+  async getObjectOne() {
+    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
+    stdAction.settingKey = SPECIAL_SETTING_KEY.QUERY_ONE;
+    return this.crudStdService.executeStdQuery(stdAction, otherParams, KeysOfSimpleSQL.SIMPLE_QUERY_ONE);
+  }
+
+  /**
+   * 单个删除
+   */
+  @Post('/deleteObject')
+  async deleteObject() {
+    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
+    return this.crudStdService.executeStdQuery(stdAction, otherParams, KeysOfSimpleSQL.SIMPLE_DELETE);
+  }
+
+  /**
+   * 单个创建
+   */
+  @Post('/createObject')
+  async createObject() {
+    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
+    return this.crudStdService.executeStdQuery(stdAction, otherParams, KeysOfSimpleSQL.SIMPLE_INSERT);
+  }
+
+  /**
+   * 单个更新
+   */
+  @Post('/updateObject')
+  async updateObject() {
+    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
+    return this.crudStdService.executeStdQuery(stdAction, otherParams, KeysOfSimpleSQL.SIMPLE_UPDATE);
+  }
+
+  /**
+   * 执行操作
+   */
+  @Post('/executeStdAction')
+  async executeStdAction() {
+    const { stdAction, ...otherParams } = this.ctx.request.body as ICrudStdParams;
+    return await this.crudStdService.executeStdActionByReq(stdAction, otherParams);
+  }
+}