koishi-plugin-chat-analyse 0.4.2 → 0.4.4

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/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

@@ -15,6 +15,13 @@ export declare class Stat {
      * @param {Config} config - 插件的配置对象。
      */
     constructor(ctx: Context, config: Config);
+    /**
+     * @private
+     * @method setupCleanupTask
+     * @description 设置一个定时清理任务。
+     * 此任务会根据配置中的 `rankRetentionDays` 定期删除过期的发言排行数据，以防止数据库膨胀。
+     */
+    private setupCleanupTask;
     /**
      * @public
      * @method registerCommands
@@ -93,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/WhoAt.d.ts

@@ -21,7 +21,7 @@ export declare class WhoAt {
      * @private
      * @method setupCleanupTask
      * @description 设置一个定时清理任务。
-     * 此任务会根据配置中的 `retentionDays` 定期删除过期的@记录，以防止数据库膨胀。
+     * 此任务会根据配置中的 `atRetentionDays` 定期删除过期的@记录，以防止数据库膨胀。
      */
     private setupCleanupTask;
     /**

package/lib/index.d.ts

@@ -17,7 +17,8 @@ export interface Config {
     enableRankStat: boolean;
     enableOriRecord: boolean;
     enableWhoAt: boolean;
-    retentionDays: number;
+    atRetentionDays: number;
+    rankRetentionDays: number;
 }
 /**
  * @const {Schema<Config>} Config

package/lib/index.js

@@ -92,10 +92,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 +141,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(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.msgStatBuffer.set(key, { uid, type, count: 1, timestamp: messageTime });
+          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 +295,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)
           }))
         );
       }
@@ -546,11 +546,30 @@ var Stat = class {
     this.ctx = ctx;
     this.config = config;
     this.renderer = new Renderer(ctx);
+    this.setupCleanupTask();
   }
   static {
     __name(this, "Stat");
   }
   renderer;
+  /**
+   * @private
+   * @method setupCleanupTask
+   * @description 设置一个定时清理任务。
+   * 此任务会根据配置中的 `rankRetentionDays` 定期删除过期的发言排行数据，以防止数据库膨胀。
+   */
+  setupCleanupTask() {
+    if (this.config.rankRetentionDays > 0) {
+      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", { timestamp: { $lt: cutoffDate } });
+        } catch (error) {
+          this.ctx.logger.error("清理发言排行历史记录出错:", error);
+        }
+      });
+    }
+  }
   /**
    * @public
    * @method registerCommands
@@ -602,17 +621,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;
@@ -692,8 +711,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}统计`;
   }
   /**
@@ -771,22 +793,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 }]));
@@ -827,13 +853,13 @@ var WhoAt = class {
    * @private
    * @method setupCleanupTask
    * @description 设置一个定时清理任务。
-   * 此任务会根据配置中的 `retentionDays` 定期删除过期的@记录，以防止数据库膨胀。
+   * 此任务会根据配置中的 `atRetentionDays` 定期删除过期的@记录，以防止数据库膨胀。
    */
   setupCleanupTask() {
-    if (this.config.retentionDays > 0) {
+    if (this.config.atRetentionDays > 0) {
       this.ctx.cron("0 0 * * *", async () => {
         try {
-          const cutoffDate = new Date(Date.now() - this.config.retentionDays * import_koishi4.Time.day);
+          const cutoffDate = new Date(Date.now() - this.config.atRetentionDays * import_koishi4.Time.day);
           await this.ctx.database.remove("analyse_at", { timestamp: { $lt: cutoffDate } });
         } catch (error) {
           this.ctx.logger.error("清理 @ 历史记录出错:", error);
@@ -896,12 +922,15 @@ var Config = import_koishi5.Schema.intersect([
   }).description("监听配置"),
   import_koishi5.Schema.object({
     enableCmdStat: import_koishi5.Schema.boolean().default(true).description("启用命令统计"),
-    enableMsgStat: import_koishi5.Schema.boolean().default(true).description("启用消息统计"),
-    enableRankStat: import_koishi5.Schema.boolean().default(true).description("启用发言排行")
-  }).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("记录保留天数")
+  }).description("发言排行配置"),
   import_koishi5.Schema.object({
     enableWhoAt: import_koishi5.Schema.boolean().default(true).description("启用 @ 记录"),
-    retentionDays: import_koishi5.Schema.number().min(0).default(7).description("保留天数")
+    atRetentionDays: import_koishi5.Schema.number().min(0).default(7).description("记录保留天数")
   }).description("@ 记录配置")
 ]);
 function apply(ctx, config) {

package/package.json

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