koishi-plugin-chat-analyse 1.4.0 → 1.4.1

package/lib/Data.d.ts

@@ -8,6 +8,12 @@ export declare class Data {
     private config;
     private dataDir;
     constructor(ctx: Context, config: any);
+    /**
+     * @private
+     * @method backupCache
+     * @description 备份 analyse_cache 表到 JSON 文件。
+     */
+    private backupCache;
     /**
      * @public
      * @method registerCommands

package/lib/index.d.ts

@@ -21,6 +21,7 @@ export interface Config {
     enableWordCloud: boolean;
     cacheRetentionDays: number;
     enableSimilarActivity: boolean;
+    enableAutoBackup: boolean;
 }
 /** @description 插件的配置项定义 */
 export declare const Config: Schema<Config>;

package/lib/index.js

@@ -2104,17 +2104,51 @@ var import_koishi5 = require("koishi");
 var fs = __toESM(require("fs/promises"));
 var path = __toESM(require("path"));
 var ALL_TABLES = ["analyse_user", "analyse_cmd", "analyse_msg", "analyse_rank", "analyse_at", "analyse_cache"];
-var BATCH_SIZE = 100;
+var DEFAULT_BACKUP_TABLES = ["analyse_user", "analyse_cmd", "analyse_msg", "analyse_rank"];
+var BATCH_SIZE = 1e3;
 var Data = class {
   constructor(ctx, config) {
     this.ctx = ctx;
     this.config = config;
     this.dataDir = path.join(this.ctx.baseDir, "data", "chat-analyse");
+    if (this.config.enableAutoBackup) this.ctx.cron("0 0 1 * *", () => {
+      this.backupCache();
+    });
   }
   static {
     __name(this, "Data");
   }
   dataDir;
+  /**
+   * @private
+   * @method backupCache
+   * @description 备份 analyse_cache 表到 JSON 文件。
+   */
+  async backupCache() {
+    try {
+      await fs.mkdir(this.dataDir, { recursive: true });
+      const now = /* @__PURE__ */ new Date();
+      const lastMonth = new Date(now.getFullYear(), now.getMonth() - 1, 1);
+      const year = lastMonth.getFullYear();
+      const month = (lastMonth.getMonth() + 1).toString().padStart(2, "0");
+      const filename = `analyse_cache_${year}-${month}.json`;
+      const filepath = path.join(this.dataDir, filename);
+      const allUsers = await this.ctx.database.get("analyse_user", {});
+      if (allUsers.length === 0) return;
+      const uidToUserInfoMap = new Map(allUsers.map((u) => [u.uid, u]));
+      const records = await this.ctx.database.get("analyse_cache", {});
+      if (records.length === 0) return;
+      const dataToExport = records.map((record) => {
+        const userInfo = uidToUserInfoMap.get(record.uid);
+        if (!userInfo) return null;
+        const { id, uid, ...restOfRecord } = record;
+        return { userId: userInfo.userId, channelId: userInfo.channelId, ...restOfRecord };
+      }).filter(Boolean);
+      await fs.writeFile(filepath, JSON.stringify(dataToExport, null, 2));
+    } catch (error) {
+      this.ctx.logger.error("原始记录备份失败:", error);
+    }
+  }
   /**
    * @public
    * @method registerCommands
@@ -2122,12 +2156,13 @@ var Data = class {
    * @param cmd - 主命令实例。
    */
   registerCommands(cmd) {
-    cmd.subcommand(".backup", "备份数据", { authority: 4 }).usage("将所有统计数据导出为 JSON 文件并保存到本地。").action(async () => {
+    cmd.subcommand(".backup", "备份数据", { authority: 4 }).usage("将统计数据导出为 JSON 文件，并保存到本地。").option("all", "-a 全量备份").action(async ({ options }) => {
+      const tablesToProcess = options.all ? ALL_TABLES : DEFAULT_BACKUP_TABLES;
       try {
         await fs.mkdir(this.dataDir, { recursive: true });
         const allUsers = await this.ctx.database.get("analyse_user", {});
         const uidToUserInfoMap = new Map(allUsers.map((u) => [u.uid, u]));
-        for (const tableName of ALL_TABLES) {
+        for (const tableName of tablesToProcess) {
           const filepath = path.join(this.dataDir, `${tableName}.json`);
           let dataToExport;
           if (tableName === "analyse_user") {
@@ -2149,14 +2184,15 @@ var Data = class {
         return "数据备份失败";
       }
     });
-    cmd.subcommand(".restore", "恢复数据", { authority: 4 }).usage(`从本地的 JSON 文件中恢复统计数据。`).action(async () => {
+    cmd.subcommand(".restore", "恢复数据", { authority: 4 }).usage("从本地的 JSON 文件中恢复统计数据。").option("all", "-a 全量恢复").action(async ({ options }) => {
       try {
         const userTablePath = path.join(this.dataDir, "analyse_user.json");
         const usersToImport = JSON.parse(await fs.readFile(userTablePath, "utf-8").catch(() => "[]"));
         if (usersToImport.length) for (let i = 0; i < usersToImport.length; i += BATCH_SIZE) await this.ctx.database.upsert("analyse_user", usersToImport.slice(i, i + BATCH_SIZE));
         const allUsers = await this.ctx.database.get("analyse_user", {});
         const userToUidMap = new Map(allUsers.map((u) => [`${u.channelId}:${u.userId}`, u.uid]));
-        for (const tableName of ALL_TABLES.filter((t) => t !== "analyse_user")) {
+        const tablesToProcess = options.all ? ALL_TABLES.filter((t) => t !== "analyse_user") : DEFAULT_BACKUP_TABLES.filter((t) => t !== "analyse_user");
+        for (const tableName of tablesToProcess) {
           const filepath = path.join(this.dataDir, `${tableName}.json`);
           const recordsToImport = JSON.parse(await fs.readFile(filepath, "utf-8").catch(() => "[]"));
           if (!recordsToImport.length) continue;
@@ -2472,13 +2508,14 @@ var Config3 = import_koishi7.Schema.intersect([
     enableMsgStat: import_koishi7.Schema.boolean().default(true).description("启用消息统计"),
     enableActivity: import_koishi7.Schema.boolean().default(true).description("启用活跃统计"),
     enableRankStat: import_koishi7.Schema.boolean().default(true).description("启用发言排行"),
-    rankRetentionDays: import_koishi7.Schema.number().min(0).default(180).description("排行保留天数"),
+    rankRetentionDays: import_koishi7.Schema.number().min(0).default(365).description("排行保留天数"),
     enableWhoAt: import_koishi7.Schema.boolean().default(true).description("启用提及记录"),
     atRetentionDays: import_koishi7.Schema.number().min(0).default(3).description("提及保留天数")
   }).description("基础分析配置"),
   import_koishi7.Schema.object({
     enableOriRecord: import_koishi7.Schema.boolean().default(true).description("启用原始记录"),
-    cacheRetentionDays: import_koishi7.Schema.number().min(0).default(30).description("记录保留天数"),
+    cacheRetentionDays: import_koishi7.Schema.number().min(0).default(31).description("记录保留天数"),
+    enableAutoBackup: import_koishi7.Schema.boolean().default(false).description("启用自动备份"),
     enableWordCloud: import_koishi7.Schema.boolean().default(true).description("启用词云生成"),
     enableSimilarActivity: import_koishi7.Schema.boolean().default(true).description("启用相似活跃分析")
   }).description("高级分析配置")

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-chat-analyse",
   "description": "强大而全面的聊天数据分析插件。支持多维度统计（命令、发言、消息类型、活跃度），可生成发言排行、词云图，并提供完善的数据管理。",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "contributors": [
     "Yis_Rime <yis_rime@outlook.com>"
   ],

package/readme.md

@@ -150,6 +150,7 @@
 
 `enableOriRecord`: **启用原始记录**。是否记录原始消息内容。这是 `.view` 和 `wordcloud` 功能的基础。 (默认: `true`)
 `cacheRetentionDays`: **原始记录保留天数**。原始消息记录的保留时长（天），`0` 为永久保留。 (默认: `30`)
+`enableAutoBackup`: **启用自动备份记录**。是否开启每月自动备份原始消息记录。 (默认: `false`)
 `enableWordCloud`: **启用词云生成**。
   > **!** 此功能依赖 **`启用原始记录`**。 (默认: `true`)
 `enableSimilarActivity`: **启用相似活跃分析**。