koishi-plugin-chat-analyse 0.4.3 → 0.4.5

package/lib/Collector.d.ts

@@ -23,7 +23,7 @@ declare module 'koishi' {
         };
         analyse_rank: {
             uid: number;
-            hour: Date;
+            type: string;
             count: number;
             timestamp: Date;
         };

package/lib/Data.d.ts

@@ -0,0 +1,19 @@
+import { Context, Command } from 'koishi';
+/**
+ * @class Data
+ * @description
+ * 提供数据备份、恢复和清理的管理功能，恢复逻辑采用分批处理以优化性能。
+ * 清理功能支持按表、时间范围和用户范围进行精确操作。
+ */
+export declare class Data {
+    private ctx;
+    private dataDir;
+    constructor(ctx: Context);
+    /**
+     * @public
+     * @method registerCommands
+     * @description 在 'analyse.admin' 命令下注册所有数据管理相关的子命令。
+     * @param {Command} analyse - '.admin' 命令实例。
+     */
+    registerCommands(analyse: Command): void;
+}

package/lib/Manager.d.ts

@@ -0,0 +1,56 @@
+import { Context, Command } from 'koishi';
+import { Config } from './index';
+/**
+ * @class Manager
+ * @description
+ * 提供数据管理功能，包括导入、导出和清除插件产生的所有数据。
+ * 这些命令通常需要较高的权限才能执行。
+ */
+export declare class Manager {
+    private ctx;
+    private config;
+    private readonly tableNames;
+    private readonly userRelatableTables;
+    /**
+     * Manager 类的构造函数。
+     * @param {Context} ctx - Koishi 的插件上下文。
+     * @param {Config} config - 插件的配置对象。
+     */
+    constructor(ctx: Context, config: Config);
+    /**
+     * @public
+     * @method registerCommands
+     * @description 在主 `analyse` 命令下注册 `.import`, `.export`, 和 `.clear` 子命令。
+     * @param {Command} analyse - 主 `analyse` 命令实例。
+     */
+    registerCommands(analyse: Command): void;
+    /**
+     * @private
+     * @async
+     * @method handleClearAll
+     * @description 处理清空所有数据的逻辑，包括用户确认。
+     */
+    private handleClearAll;
+    /**
+     * @private
+     * @async
+     * @method clearSingleTable
+     * @description 清空单个指定表的数据。
+     */
+    private clearSingleTable;
+    /**
+     * @private
+     * @async
+     * @method clearScopedData
+     * @description 清除指定范围（用户/群组）的数据。
+     */
+    private clearScopedData;
+    /**
+     * @private
+     * @async
+     * @method clearAllData
+     * @description 清空所有由本插件创建的表中的数据。
+     * @returns {Promise<Record<string, number>>} 返回一个对象，键为表名，值为被删除的行数。
+     */
+    private clearAllData;
+}

package/lib/Stat.d.ts

@@ -100,6 +100,7 @@ export declare class Stat {
      * @description 从数据库中获取并聚合指定时间范围内的活跃用户排行数据。
      * @param {number} hours - 查询过去的小时数。
      * @param {string} [guildId] - (可选) 要查询的群组 ID。若不提供，则进行全局排行。
+     * @param {string} [type] - (可选) 要筛选的消息类型。
      * @returns {Promise<{ list: RenderListItem[], total: number } | string>} 返回一个包含列表和总数的对象，或在无数据时返回提示字符串。
      */
     private getActiveUserStats;

package/lib/index.d.ts

@@ -17,6 +17,7 @@ export interface Config {
     enableRankStat: boolean;
     enableOriRecord: boolean;
     enableWhoAt: boolean;
+    enableData: boolean;
     atRetentionDays: number;
     rankRetentionDays: number;
 }

package/lib/index.js

@@ -1,6 +1,8 @@
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __export = (target, all) => {
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -27,7 +37,7 @@ __export(src_exports, {
   using: () => using
 });
 module.exports = __toCommonJS(src_exports);
-var import_koishi5 = require("koishi");
+var import_koishi6 = require("koishi");
 
 // src/Collector.ts
 var import_koishi = require("koishi");
@@ -92,10 +102,10 @@ var Collector = class _Collector {
     }, { primary: ["uid", "type"] });
     this.ctx.model.extend("analyse_rank", {
       uid: "unsigned",
-      hour: "timestamp",
+      type: "string",
       count: "unsigned",
       timestamp: "timestamp"
-    }, { primary: ["uid", "hour"] });
+    }, { primary: ["uid", "timestamp", "type"] });
     if (this.config.enableOriRecord) {
       this.ctx.model.extend("analyse_cache", {
         id: "unsigned",
@@ -141,29 +151,29 @@ var Collector = class _Collector {
         }
       }
       const hourStart = new Date(messageTime.getFullYear(), messageTime.getMonth(), messageTime.getDate(), messageTime.getHours());
-      const rankKey = `${uid}:${hourStart.toISOString()}`;
-      const existingRank = this.rankStatBuffer.get(rankKey);
-      if (existingRank) {
-        existingRank.count++;
-        existingRank.timestamp = messageTime;
-      } else {
-        this.rankStatBuffer.set(rankKey, { uid, hour: hourStart, count: 1, timestamp: messageTime });
-      }
       const uniqueElementTypes = new Set(elements.map((e) => e.type));
       for (const type of uniqueElementTypes) {
-        const key = `${uid}:${type}`;
-        const existing = this.msgStatBuffer.get(key);
-        if (existing) {
-          existing.count++;
-          existing.timestamp = messageTime;
+        const msgKey = `${uid}:${type}`;
+        const existingMsg = this.msgStatBuffer.get(msgKey);
+        if (existingMsg) {
+          existingMsg.count++;
+          existingMsg.timestamp = messageTime;
         } else {
-          this.msgStatBuffer.set(key, { uid, type, count: 1, timestamp: messageTime });
+          this.msgStatBuffer.set(msgKey, { uid, type, count: 1, timestamp: messageTime });
+        }
+        const rankKey = `${uid}:${hourStart.toISOString()}:${type}`;
+        const existingRank = this.rankStatBuffer.get(rankKey);
+        if (existingRank) {
+          existingRank.count++;
+        } else {
+          this.rankStatBuffer.set(rankKey, { uid, timestamp: hourStart, type, count: 1 });
         }
       }
       if (this.config.enableWhoAt) {
         const atElements = elements.filter((e) => e.type === "at");
         if (atElements.length > 0) {
-          const sanitizedContent = this.sanitizeContent(elements);
+          const contentElements = elements.filter((e) => e.type !== "at");
+          const sanitizedContent = this.sanitizeContent(contentElements);
           for (const atElement of atElements) {
             const targetId = atElement.attrs.id;
             if (targetId && targetId !== userId) this.whoAtBuffer.push({ uid, target: targetId, content: sanitizedContent, timestamp: messageTime });
@@ -295,9 +305,9 @@ var Collector = class _Collector {
           "analyse_rank",
           (row) => rankBufferToFlush.map((item) => ({
             uid: item.uid,
-            hour: item.hour,
-            count: import_koishi.$.add(import_koishi.$.ifNull(row.count, 0), item.count),
-            timestamp: item.timestamp
+            timestamp: item.timestamp,
+            type: item.type,
+            count: import_koishi.$.add(import_koishi.$.ifNull(row.count, 0), item.count)
           }))
         );
       }
@@ -563,7 +573,7 @@ var Stat = class {
       this.ctx.cron("0 0 * * *", async () => {
         try {
           const cutoffDate = new Date(Date.now() - this.config.rankRetentionDays * import_koishi3.Time.day);
-          await this.ctx.database.remove("analyse_rank", { hour: { $lt: cutoffDate } });
+          await this.ctx.database.remove("analyse_rank", { timestamp: { $lt: cutoffDate } });
         } catch (error) {
           this.ctx.logger.error("清理发言排行历史记录出错:", error);
         }
@@ -621,17 +631,17 @@ var Stat = class {
       });
     }
     if (this.config.enableRankStat) {
-      analyse.subcommand(".rank", "用户发言排行").option("guild", "-g <guildId:string> 指定群组").option("all", "-a 展示全局统计").option("hours", "-h <hours:number> 指定时长", { fallback: 24 }).action(async ({ session, options }) => {
+      analyse.subcommand(".rank", "用户发言排行").option("guild", "-g <guildId:string> 指定群组").option("type", "-t <type:string> 指定类型").option("hours", "-h <hours:number> 指定时长", { fallback: 24 }).option("all", "-a 展示全局统计").action(async ({ session, options }) => {
         const guildId = options.all ? void 0 : options.guild || session.guildId;
         if (!guildId && !options.all) return "请提供查询范围";
         try {
-          const stats = await this.getActiveUserStats(options.hours, guildId);
+          const stats = await this.getActiveUserStats(options.hours, guildId, options.type);
           if (typeof stats === "string") return stats;
           const listWithPercentage = stats.list.map((row) => [
             ...row,
             stats.total > 0 ? `${(row[1] / stats.total * 100).toFixed(2)}%` : "0.00%"
           ]);
-          const title = await this.generateTitle(guildId, void 0, { main: "排行", timeRange: options.hours });
+          const title = await this.generateTitle(guildId, void 0, { main: "排行", timeRange: options.hours, subtype: options.type });
           const renderData = { title, time: /* @__PURE__ */ new Date(), total: stats.total, list: listWithPercentage };
           const result = await this.renderer.renderList(renderData, ["用户", "总计发言", "占比"]);
           return Buffer.isBuffer(result) ? import_koishi3.Element.image(result, "image/png") : result;
@@ -711,8 +721,11 @@ var Stat = class {
       const guild = await this.ctx.database.get("analyse_user", { channelId: guildId }, ["channelName"]);
       scopeText = guild[0]?.channelName || guildId;
     }
-    if (options.main === "排行") return `${scopeText}${options.timeRange}小时消息排行`;
-    if (options.main === "消息" && options.subtype) return `${scopeText}"${options.subtype}"消息统计`;
+    if (options.main === "排行") {
+      const typeText = options.subtype ? `“${options.subtype}”` : "";
+      return `${scopeText}${options.timeRange}小时${typeText}消息排行`;
+    }
+    if (options.main === "消息" && options.subtype) return `${scopeText}“${options.subtype}”消息统计`;
     return `${scopeText}${options.main}统计`;
   }
   /**
@@ -790,22 +803,26 @@ var Stat = class {
    * @description 从数据库中获取并聚合指定时间范围内的活跃用户排行数据。
    * @param {number} hours - 查询过去的小时数。
    * @param {string} [guildId] - (可选) 要查询的群组 ID。若不提供，则进行全局排行。
+   * @param {string} [type] - (可选) 要筛选的消息类型。
    * @returns {Promise<{ list: RenderListItem[], total: number } | string>} 返回一个包含列表和总数的对象，或在无数据时返回提示字符串。
    */
-  async getActiveUserStats(hours, guildId) {
+  async getActiveUserStats(hours, guildId, type) {
     const since = new Date(Date.now() - hours * 3600 * 1e3);
+    const baseQuery = { timestamp: { $gte: since } };
+    if (type) baseQuery.type = type;
     if (guildId) {
       const usersInGuild = await this.ctx.database.get("analyse_user", { channelId: guildId }, ["uid", "userName"]);
       if (usersInGuild.length === 0) return "暂无统计数据";
       const uids = usersInGuild.map((u) => u.uid);
       const userNameMap = new Map(usersInGuild.map((u) => [u.uid, u.userName]));
-      const stats = await this.ctx.database.select("analyse_rank").where({ uid: { $in: uids }, hour: { $gte: since } }).groupBy("uid", { count: /* @__PURE__ */ __name((row) => import_koishi3.$.sum(row.count), "count") }).orderBy("count", "desc").limit(100).execute();
+      const query = { ...baseQuery, uid: { $in: uids } };
+      const stats = await this.ctx.database.select("analyse_rank").where(query).groupBy("uid", { count: /* @__PURE__ */ __name((row) => import_koishi3.$.sum(row.count), "count") }).orderBy("count", "desc").limit(100).execute();
       if (stats.length === 0) return "暂无统计数据";
       const total = stats.reduce((sum, record) => sum + record.count, 0);
       const list = stats.map((item) => [userNameMap.get(item.uid) || `UID ${item.uid}`, item.count]);
       return { list, total };
     } else {
-      const msgStats = await this.ctx.database.select("analyse_rank").where({ hour: { $gte: since } }).project(["uid", "count"]).execute();
+      const msgStats = await this.ctx.database.select("analyse_rank").where(baseQuery).project(["uid", "count"]).execute();
       if (msgStats.length === 0) return "暂无统计数据";
       const allUsers = await this.ctx.database.get("analyse_user", {}, ["uid", "userId", "userName"]);
       const uidToUserMap = new Map(allUsers.map((u) => [u.uid, { userId: u.userId, userName: u.userName }]));
@@ -893,6 +910,165 @@ var WhoAt = class {
   }
 };
 
+// src/Data.ts
+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 Data = class {
+  constructor(ctx) {
+    this.ctx = ctx;
+    this.dataDir = path.join(this.ctx.baseDir, "data", "chat-analyse");
+  }
+  static {
+    __name(this, "Data");
+  }
+  dataDir;
+  /**
+   * @public
+   * @method registerCommands
+   * @description 在 'analyse.admin' 命令下注册所有数据管理相关的子命令。
+   * @param {Command} analyse - '.admin' 命令实例。
+   */
+  registerCommands(analyse) {
+    analyse.subcommand(".backup", "备份统计数据", { authority: 4 }).action(async () => {
+      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) {
+          const filepath = path.join(this.dataDir, `${tableName}.json`);
+          let dataToExport;
+          if (tableName === "analyse_user") {
+            dataToExport = allUsers.map(({ uid, ...rest }) => rest);
+          } else {
+            const records = await this.ctx.database.get(tableName, {});
+            dataToExport = records.map((record) => {
+              const userInfo = uidToUserInfoMap.get(record.uid);
+              if (!userInfo) return null;
+              const { uid, ...restOfRecord } = record;
+              return {
+                userId: userInfo.userId,
+                channelId: userInfo.channelId,
+                ...restOfRecord
+              };
+            }).filter(Boolean);
+          }
+          await fs.writeFile(filepath, JSON.stringify(dataToExport, null, 2));
+        }
+        return `数据备份成功`;
+      } catch (error) {
+        this.ctx.logger.error("数据备份失败:", error);
+        return "数据备份失败";
+      }
+    });
+    analyse.subcommand(".restore", "恢复统计数据", { authority: 4 }).action(async () => {
+      const BATCH_SIZE = 100;
+      try {
+        const userTablePath = path.join(this.dataDir, "analyse_user.json");
+        try {
+          const usersToImport = JSON.parse(await fs.readFile(userTablePath, "utf-8"));
+          if (Array.isArray(usersToImport) && usersToImport.length > 0) {
+            for (let i = 0; i < usersToImport.length; i += BATCH_SIZE) {
+              const batch = usersToImport.slice(i, i + BATCH_SIZE);
+              await this.ctx.database.upsert("analyse_user", batch);
+            }
+          }
+        } catch (e) {
+          if (e.code !== "ENOENT") throw e;
+          this.ctx.logger.warn("无用户数据可恢复");
+        }
+        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 filepath = path.join(this.dataDir, `${tableName}.json`);
+          try {
+            const recordsToImport = JSON.parse(await fs.readFile(filepath, "utf-8"));
+            if (Array.isArray(recordsToImport) && recordsToImport.length > 0) {
+              const recordsWithUid = recordsToImport.map((r) => {
+                const uid = userToUidMap.get(`${r.channelId}:${r.userId}`);
+                if (!uid) return null;
+                const { userId, channelId, ...rest } = r;
+                return { uid, ...rest };
+              }).filter(Boolean);
+              if (recordsWithUid.length > 0) {
+                for (let i = 0; i < recordsWithUid.length; i += BATCH_SIZE) {
+                  const batch = recordsWithUid.slice(i, i + BATCH_SIZE);
+                  await this.ctx.database.upsert(tableName, batch);
+                }
+              }
+            }
+          } catch (e) {
+            if (e.code !== "ENOENT") throw e;
+          }
+        }
+        return `数据恢复成功`;
+      } catch (error) {
+        this.ctx.logger.error("数据恢复失败:", error);
+        return "数据恢复失败";
+      }
+    });
+    analyse.subcommand(".clear", "清理统计数据", { authority: 4 }).option("table", "-t <table:string> 指定表").option("guild", "-g <guildId:string> 指定群组").option("user", "-u <user:string> 指定用户").option("days", "-d <days:number> 指定天数").option("all", "-a 清理全部数据").action(async ({ options }) => {
+      if (!options.table && !options.guild && !options.user && !options.all && !options.days) return "请提供清理条件";
+      try {
+        if (options.all) {
+          for (const tableName of ALL_TABLES) await this.ctx.database.remove(tableName, {});
+          return "已清除所有聊天分析数据";
+        }
+        let tablesToClear;
+        if (options.table) {
+          if (!ALL_TABLES.includes(options.table)) return `无效表名: ${options.table}`;
+          tablesToClear = [options.table];
+        } else {
+          tablesToClear = ALL_TABLES.filter((t) => t !== "analyse_user");
+        }
+        const queryParts = { query: {}, desc: "" };
+        const descParts = [];
+        if (options.guild || options.user) {
+          const uidsToClear = [];
+          const scopeDesc = [];
+          if (options.guild) {
+            uidsToClear.push(...(await this.ctx.database.get("analyse_user", { channelId: options.guild })).map((u) => u.uid));
+            scopeDesc.push(`群组 ${options.guild} `);
+          }
+          if (options.user) {
+            const userId = import_koishi5.Element.select(options.user, "at")[0]?.attrs.id || options.user;
+            uidsToClear.push(...(await this.ctx.database.get("analyse_user", { userId })).map((u) => u.uid));
+            scopeDesc.push(`用户 ${userId} `);
+          }
+          const uniqueUids = [...new Set(uidsToClear)];
+          if (uniqueUids.length === 0) return "未找到该用户";
+          queryParts.query.uid = { $in: uniqueUids };
+          descParts.push(scopeDesc.join("、"));
+        }
+        if (options.days && options.days > 0) {
+          queryParts.query.timestamp = { $lt: new Date(Date.now() - options.days * import_koishi5.Time.day) };
+          descParts.push(`超过 ${options.days} 天`);
+        }
+        for (const tableName of tablesToClear) {
+          const finalQuery = { ...queryParts.query };
+          if (tableName === "analyse_user" && finalQuery.timestamp) delete finalQuery.timestamp;
+          await this.ctx.database.remove(tableName, finalQuery);
+        }
+        const targetStr = options.table ? `表 ${options.table} ` : "所有表";
+        const conditionStr = descParts.join(" 且 ");
+        const finalDescription = conditionStr ? `${targetStr} 中${conditionStr}的数据` : `${targetStr}的全部统计数据`;
+        return `已成功清理${finalDescription}`;
+      } catch (error) {
+        this.ctx.logger.error("数据清理失败:", error);
+        return "数据清理失败";
+      }
+    });
+  }
+};
+
 // src/index.ts
 var usage = `
 <div style="border-radius: 10px; border: 1px solid #ddd; padding: 16px; margin-bottom: 20px; box-shadow: 0 2px 5px rgba(0,0,0,0.1);">
@@ -908,22 +1084,23 @@ var usage = `
 `;
 var name = "chat-analyse";
 var using = ["database", "puppeteer", "cron"];
-var Config = import_koishi5.Schema.intersect([
-  import_koishi5.Schema.object({
-    enableListener: import_koishi5.Schema.boolean().default(true).description("启用消息监听"),
-    enableOriRecord: import_koishi5.Schema.boolean().default(true).description("启用原始记录")
+var Config = import_koishi6.Schema.intersect([
+  import_koishi6.Schema.object({
+    enableListener: import_koishi6.Schema.boolean().default(true).description("启用消息监听"),
+    enableOriRecord: import_koishi6.Schema.boolean().default(true).description("启用原始记录")
   }).description("监听配置"),
-  import_koishi5.Schema.object({
-    enableCmdStat: import_koishi5.Schema.boolean().default(true).description("启用命令统计"),
-    enableMsgStat: import_koishi5.Schema.boolean().default(true).description("启用消息统计")
-  }).description("统计配置"),
-  import_koishi5.Schema.object({
-    enableRankStat: import_koishi5.Schema.boolean().default(true).description("启用发言排行"),
-    rankRetentionDays: import_koishi5.Schema.number().min(0).default(31).description("记录保留天数")
+  import_koishi6.Schema.object({
+    enableCmdStat: import_koishi6.Schema.boolean().default(true).description("启用命令统计"),
+    enableMsgStat: import_koishi6.Schema.boolean().default(true).description("启用消息统计"),
+    enableData: import_koishi6.Schema.boolean().default(false).description("启用数据管理")
+  }).description("功能配置"),
+  import_koishi6.Schema.object({
+    enableRankStat: import_koishi6.Schema.boolean().default(true).description("启用发言排行"),
+    rankRetentionDays: import_koishi6.Schema.number().min(0).default(31).description("记录保留天数")
   }).description("发言排行配置"),
-  import_koishi5.Schema.object({
-    enableWhoAt: import_koishi5.Schema.boolean().default(true).description("启用 @ 记录"),
-    atRetentionDays: import_koishi5.Schema.number().min(0).default(7).description("记录保留天数")
+  import_koishi6.Schema.object({
+    enableWhoAt: import_koishi6.Schema.boolean().default(true).description("启用 @ 记录"),
+    atRetentionDays: import_koishi6.Schema.number().min(0).default(7).description("记录保留天数")
   }).description("@ 记录配置")
 ]);
 function apply(ctx, config) {
@@ -931,6 +1108,7 @@ function apply(ctx, config) {
   const analyse = ctx.command("analyse", "聊天记录分析");
   new Stat(ctx, config).registerCommands(analyse);
   if (config.enableWhoAt) new WhoAt(ctx, config).registerCommand(analyse);
+  if (config.enableData) new Data(ctx).registerCommands(analyse);
 }
 __name(apply, "apply");
 // Annotate the CommonJS export names for ESM import in node:

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-chat-analyse",
   "description": "聊天记录分析",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "contributors": [
     "Yis_Rime <yis_rime@outlook.com>"
   ],