feat: 支持审计日志，操作日志

packages/ui/certd-server/src/controller/sys/settings/sys-settings-controller.ts

@@ -8,7 +8,7 @@ import { http, logger, utils } from "@certd/basic";
 import { CodeService } from "../../../modules/basic/service/code-service.js";
 import { SmsServiceFactory } from "../../../modules/basic/sms/factory.js";
 import { RuntimeDepsService } from "../../../modules/runtime-deps/runtime-deps-service.js";
-import { AuditType, AuditAction } from "../../modules/sys/enterprise/service/audit-constants.js";
+import { AuditType } from "../../../modules/sys/enterprise/service/audit-constants.js";
 
 /**
  */
@@ -32,63 +32,71 @@ export class SysSettingsController extends CrudController<SysSettingsService> {
     return this.service;
   }
 
-  @Post("/page", { description: "sys:settings:view" })
+  getAuditType(): string {
+    return AuditType.settings;
+  }
+
+  @Post("/page", { description: "sys:settings:view", summary: "查询系统设置分页列表" })
   async page(@Body(ALL) body) {
     return super.page(body);
   }
 
-  @Post("/list", { description: "sys:settings:view" })
+  @Post("/list", { description: "sys:settings:view", summary: "查询系统设置列表" })
   async list(@Body(ALL) body) {
     return super.list(body);
   }
 
-  @Post("/add", { description: "sys:settings:edit" })
+  @Post("/add", { description: "sys:settings:edit", summary: "添加系统设置" })
   async add(@Body(ALL) bean) {
-    return super.add(bean);
+    const res = await super.add(bean);
+    await this.auditLog({ content: "添加了系统设置" });
+    return res;
   }
 
-  @Post("/update", { description: "sys:settings:edit" })
+  @Post("/update", { description: "sys:settings:edit", summary: "更新系统设置" })
   async update(@Body(ALL) bean) {
     await this.service.checkUserId(bean.id, this.getUserId());
-    return super.update(bean);
+    const res = await super.update(bean);
+    await this.auditLog({ content: "更新了系统设置" });
+    return res;
   }
-  @Post("/info", { description: "sys:settings:view" })
+  @Post("/info", { description: "sys:settings:view", summary: "查询系统设置详情" })
   async info(@Query("id") id: number) {
     await this.service.checkUserId(id, this.getUserId());
     return super.info(id);
   }
 
-  @Post("/delete", { description: "sys:settings:edit" })
+  @Post("/delete", { description: "sys:settings:edit", summary: "删除系统设置" })
   async delete(@Query("id") id: number) {
     await this.service.checkUserId(id, this.getUserId());
-    return super.delete(id);
+    const res = await super.delete(id);
+    await this.auditLog({ content: "删除了系统设置" });
+    return res;
   }
 
-  @Post("/save", { description: "sys:settings:edit" })
+  @Post("/save", { description: "sys:settings:edit", summary: "保存系统设置" })
   async save(@Body(ALL) bean: SysSettingsEntity) {
     await this.service.save(bean);
     await this.auditLog({
-      type: AuditType.settings,
-      action: AuditAction.update,
       content: "修改了系统设置",
     });
     return this.ok({});
   }
 
-  @Post("/get", { description: "sys:settings:view" })
+  @Post("/get", { description: "sys:settings:view", summary: "查询系统设置" })
   async get(@Query("key") key: string) {
     const entity = await this.service.getByKey(key);
     return this.ok(entity);
   }
 
   // savePublicSettings
-  @Post("/getEmailSettings", { description: "sys:settings:view" })
+  @Post("/getEmailSettings", { description: "sys:settings:view", summary: "查询邮件服务器设置" })
   async getEmailSettings(@Body(ALL) body) {
     const conf = await getEmailSettings(this.service, this.userSettingsService);
     return this.ok(conf);
   }
 
-  @Post("/getEmailTemplates", { description: "sys:settings:view" })
+  @Post("/getEmailTemplates", { description: "sys:settings:view", summary: "查询邮件模板列表" })
   async getEmailTemplates(@Body(ALL) body) {
     const conf = await getEmailSettings(this.service, this.userSettingsService);
     const templates = conf.templates || {};
@@ -107,15 +115,16 @@ export class SysSettingsController extends CrudController<SysSettingsService> {
     return this.ok(proviers);
   }
 
-  @Post("/saveEmailSettings", { description: "sys:settings:edit" })
+  @Post("/saveEmailSettings", { description: "sys:settings:edit", summary: "保存邮件服务器设置" })
   async saveEmailSettings(@Body(ALL) body) {
     const conf = await getEmailSettings(this.service, this.userSettingsService);
     merge(conf, body);
     await this.service.saveSetting(conf);
+    await this.auditLog({ content: "保存了邮件服务器设置" });
     return this.ok(conf);
   }
 
-  @Post("/getSysSettings", { description: "sys:settings:view" })
+  @Post("/getSysSettings", { description: "sys:settings:view", summary: "查询系统配置" })
   async getSysSettings() {
     const publicSettings = await this.service.getPublicSettings();
     let privateSettings = await this.service.getPrivateSettings();
@@ -124,7 +133,7 @@ export class SysSettingsController extends CrudController<SysSettingsService> {
   }
 
   // savePublicSettings
-  @Post("/saveSysSettings", { description: "sys:settings:edit" })
+  @Post("/saveSysSettings", { description: "sys:settings:edit", summary: "保存系统设置" })
   async saveSysSettings(@Body(ALL) body: { public: SysPublicSettings; private: SysPrivateSettings }) {
     const publicSettings = await this.service.getPublicSettings();
     const privateSettings = await this.service.getPrivateSettings();
@@ -132,16 +141,18 @@ export class SysSettingsController extends CrudController<SysSettingsService> {
     merge(privateSettings, body.private);
     await this.service.savePublicSettings(publicSettings);
     await this.service.savePrivateSettings(privateSettings);
+    await this.auditLog({ content: "保存了系统设置" });
     return this.ok({});
   }
 
-  @Post("/stopOtherUserTimer", { description: "sys:settings:edit" })
+  @Post("/stopOtherUserTimer", { description: "sys:settings:edit", summary: "停止其他用户定时任务" })
   async stopOtherUserTimer(@Body(ALL) body) {
     await this.pipelineService.stopOtherUserPipeline(1);
+    await this.auditLog({ content: "停止了其他用户定时任务" });
     return this.ok({});
   }
 
-  @Post("/testProxy", { description: "sys:settings:edit" })
+  @Post("/testProxy", { description: "sys:settings:edit", summary: "测试代理" })
   async testProxy(@Body(ALL) body) {
     const google = "https://www.google.com/";
     const baidu = "https://www.baidu.com/";
@@ -179,19 +190,19 @@ export class SysSettingsController extends CrudController<SysSettingsService> {
     });
   }
 
-  @Post("/testSms", { description: "sys:settings:edit" })
+  @Post("/testSms", { description: "sys:settings:edit", summary: "测试短信" })
   async testSms(@Body(ALL) body) {
     await this.codeService.sendSmsCode(body.phoneCode, body.mobile);
     return this.ok({});
   }
 
-  @Post("/getSmsTypeDefine", { description: "sys:settings:view" })
+  @Post("/getSmsTypeDefine", { description: "sys:settings:view", summary: "查询短信类型定义" })
   async getSmsTypeDefine(@Body("type") type: string) {
     const define = await SmsServiceFactory.getDefine(type);
     return this.ok(define);
   }
 
-  @Post("/safe/get", { description: "sys:settings:view" })
+  @Post("/safe/get", { description: "sys:settings:view", summary: "查询安全设置" })
   async safeGet() {
     const res = await this.service.getSetting<SysSafeSetting>(SysSafeSetting);
     const clone: SysSafeSetting = cloneDeep(res);
@@ -199,7 +210,7 @@ export class SysSettingsController extends CrudController<SysSettingsService> {
     return this.ok(clone);
   }
 
-  @Post("/safe/save", { description: "sys:settings:edit" })
+  @Post("/safe/save", { description: "sys:settings:edit", summary: "保存安全设置" })
   async safeSave(@Body(ALL) body: any) {
     if (body.hidden.openPassword) {
       body.hidden.openPassword = utils.hash.md5(body.hidden.openPassword);
@@ -211,24 +222,26 @@ export class SysSettingsController extends CrudController<SysSettingsService> {
       throw new Error("首次设置需要填写解锁密码");
     }
     await this.service.saveSetting(blankSetting);
+    await this.auditLog({ content: "保存了安全设置" });
     return this.ok({});
   }
 
-  @Post("/captchaTest", { description: "sys:settings:edit" })
+  @Post("/captchaTest", { description: "sys:settings:edit", summary: "测试验证码" })
   async captchaTest(@Body(ALL) body: any, @RequestIP() remoteIp: string) {
     await this.codeService.checkCaptcha(body, { remoteIp });
     return this.ok({});
   }
 
-  @Post("/oauth/providers", { description: "sys:settings:view" })
+  @Post("/oauth/providers", { description: "sys:settings:view", summary: "查询OAuth提供商列表" })
   async oauthProviders() {
     const list = await addonRegistry.getDefineList("oauth");
     return this.ok(list);
   }
 
-  @Post("/clearRuntimeDeps", { description: "sys:settings:edit" })
+  @Post("/clearRuntimeDeps", { description: "sys:settings:edit", summary: "清除运行时依赖" })
   async clearRuntimeDeps() {
     await this.runtimeDepsService.clearRuntimeDeps();
+    await this.auditLog({ content: "清除了运行时依赖" });
     return this.ok(true);
   }
 }