koishi-plugin-chat-analyse 0.2.6 → 0.3.1

package/lib/Collector.d.ts

@@ -18,13 +18,13 @@ declare module 'koishi' {
         analyse_msg: {
             uid: number;
             type: string;
+            hour: Date;
             count: number;
             timestamp: Date;
         };
         analyse_cache: {
             id: number;
-            channelId: string;
-            userId: string;
+            uid: number;
             content: string;
             timestamp: Date;
         };

package/lib/Stat.d.ts

@@ -17,22 +17,24 @@ export declare class Stat {
     constructor(ctx: Context, config: Config);
     /**
      * @method registerCommands
-     * @description 根据插件配置，动态地将 `.command` 和 `.message` 子命令注册到主 `analyse` 命令下。
+     * @description 根据插件配置，动态地将 `.cmd`, `.msg`, `.rank` 子命令注册到主 `analyse` 命令下。
      * @param {Command} analyse - 主 `analyse` 命令实例。
      */
     registerCommands(analyse: Command): void;
     /**
      * @private
      * @async
-     * @method _generateTitle
-     * @description 通用的标题生成器。根据查询参数 (guildId, userId) 和统计类型动态生成易于理解的图片标题。
-     * @param {Session} session - 当前会话，备用。
+     * @method generateTitle
+     * @description 通用的标题生成器。根据查询参数和类型选项动态生成易于理解的图片标题。
      * @param {string} [guildId] - (可选) 查询的群组 ID。
      * @param {string} [userId] - (可选) 查询的用户 ID。
-     * @param {'命令' | '消息'} type - 统计类型，用于嵌入标题文本中。
+     * @param {object} options - 标题的配置选项。
+     * @param {'命令' | '消息' | '排行'} options.main - 标题主类型。
+     * @param {string} [options.subtype] - (可选) 消息类型的子类型。
+     * @param {number} [options.timeRange] - (可选) 排行的时间范围（小时）。
      * @returns {Promise<string>} 生成的标题字符串。
      */
-    private _generateTitle;
+    private generateTitle;
     /**
      * @private
      * @async
@@ -47,10 +49,31 @@ export declare class Stat {
      * @private
      * @async
      * @method getMessageStats
-     * @description 从数据库中获取并聚合消息类型统计数据。
+     * @description 从数据库中获取并聚合所有消息类型的统计数据。
      * @param {string} [guildId] - (可选) 若提供，则将范围限制在此群组。
      * @param {string} [userId] - (可选) 若提供，则将范围限制在此用户。
      * @returns {Promise<{ list: RenderListItem[], total: number } | string>} 返回一个包含列表和总数的对象，或在无数据时返回提示字符串。
      */
     private getMessageStats;
+    /**
+     * @private
+     * @async
+     * @method getMessageStatsByType
+     * @description 按指定消息类型，从数据库中获取并聚合用户排行数据。
+     * @param {string} type - 要查询的消息类型。
+     * @param {string} [guildId] - (可选) 若提供，则将范围限制在此群组。
+     * @param {string} [userId] - (可选) 若提供，则将范围限制在此用户。
+     * @returns {Promise<{ list: RenderListItem[], total: number } | string>}
+     */
+    private getMessageStatsByType;
+    /**
+     * @private
+     * @async
+     * @method getActiveUserStats
+     * @description 从数据库中获取并聚合活跃用户排行数据。
+     * @param {string} guildId - 要查询的群组 ID。
+     * @param {number} hours - 查询过去的小时数。
+     * @returns {Promise<{ list: RenderListItem[], total: number } | string>}
+     */
+    private getActiveUserStats;
 }

package/lib/index.d.ts

@@ -14,7 +14,8 @@ export interface Config {
     enableListener: boolean;
     enableCmdStat: boolean;
     enableMsgStat: boolean;
-    enableAdvanced: boolean;
+    enableRankStat: boolean;
+    enableOriRecord: boolean;
 }
 /**
  * @const {Schema<Config>} Config

package/lib/index.js

@@ -42,7 +42,7 @@ var Collector = class _Collector {
     this.config = config;
     this.defineModels();
     ctx.on("message", (session) => this.handleMessage(session));
-    if (this.config.enableAdvanced) {
+    if (this.config.enableOriRecord) {
       this.flushInterval = setInterval(() => this.flushCacheBuffer(), _Collector.FLUSH_INTERVAL);
       ctx.on("dispose", () => {
         clearInterval(this.flushInterval);
@@ -86,17 +86,17 @@ var Collector = class _Collector {
     this.ctx.model.extend("analyse_msg", {
       uid: "unsigned",
       type: "string",
+      hour: "timestamp",
       count: "unsigned",
       timestamp: "timestamp"
-    }, { primary: ["uid", "type"] });
-    if (this.config.enableAdvanced) {
+    }, { primary: ["uid", "type", "hour"] });
+    if (this.config.enableOriRecord) {
       this.ctx.model.extend("analyse_cache", {
         id: "unsigned",
-        channelId: "string",
-        userId: "string",
+        uid: "unsigned",
         content: "text",
         timestamp: "timestamp"
-      }, { primary: "id", autoInc: true });
+      }, { primary: "id", autoInc: true, indexes: ["uid", "timestamp"] });
     }
   }
   /**
@@ -113,28 +113,29 @@ var Collector = class _Collector {
       if (!effectiveId || !userId || !timestamp || !content?.trim()) return;
       const uid = await this.getOrCreateUser(session, effectiveId);
       if (!uid) return;
-      const now = /* @__PURE__ */ new Date();
       if (argv?.command) {
         await this.ctx.database.upsert("analyse_cmd", (row) => [{
           uid,
           command: argv.command.name,
           count: import_koishi.$.add(import_koishi.$.ifNull(row.count, import_koishi.$.literal(0)), 1),
-          timestamp: now
+          timestamp: /* @__PURE__ */ new Date()
         }]);
       }
+      const messageTime = new Date(timestamp);
+      const hourStart = new Date(messageTime.getFullYear(), messageTime.getMonth(), messageTime.getDate(), messageTime.getHours());
       const uniqueElementTypes = new Set(elements.map((e) => e.type));
       for (const type of uniqueElementTypes) {
         await this.ctx.database.upsert("analyse_msg", (row) => [{
           uid,
           type,
-          count: import_koishi.$.add(import_koishi.$.ifNull(row.count, import_koishi.$.literal(0)), 1),
-          timestamp: now
+          hour: hourStart,
+          count: import_koishi.$.add(import_koishi.$.ifNull(row.count, 0), 1),
+          timestamp: messageTime
         }]);
       }
-      if (this.config.enableAdvanced) {
+      if (this.config.enableOriRecord) {
         this.cacheBuffer.push({
-          channelId: effectiveId,
-          userId,
+          uid,
           content: this.sanitizeContent(elements),
           timestamp: new Date(timestamp)
         });
@@ -359,29 +360,30 @@ var Stat = class {
   renderer;
   /**
    * @method registerCommands
-   * @description 根据插件配置，动态地将 `.command` 和 `.message` 子命令注册到主 `analyse` 命令下。
+   * @description 根据插件配置，动态地将 `.cmd`, `.msg`, `.rank` 子命令注册到主 `analyse` 命令下。
    * @param {Command} analyse - 主 `analyse` 命令实例。
    */
   registerCommands(analyse) {
     if (this.config.enableCmdStat) {
-      analyse.subcommand(".command", "命令使用统计").option("user", "-u [user:user] 查看指定用户的统计").option("guild", "-g [guildId:string] 查看指定群组的统计 (默认当前群)").usage("查询命令使用统计。支持按用户、按群组或组合查询。").action(async ({ session, options }) => {
+      analyse.subcommand(".cmd", "命令使用统计").option("user", "-u [user:user] 指定用户").option("guild", "-g [guildId:string] 指定群组").usage("查询用户或群组的命令使用统计，默认展示全局统计。").action(async ({ session, options }) => {
         const userId = options.user ? import_koishi3.h.select(options.user, "user")[0]?.attrs.id : void 0;
         let guildId = options.guild;
-        if (options.guild === "" && !options.user) {
-          if (!session.guildId) return "私聊中请使用 -g <群组ID> 指定群组。";
+        if (!userId && !guildId && session.guildId) {
           guildId = session.guildId;
+        } else if (!userId && !guildId && !session.guildId) {
+          return "请指定查询范围";
         }
         try {
           const stats = await this.getCommandStats(guildId, userId);
           if (typeof stats === "string") return stats;
-          const title = await this._generateTitle(session, guildId, userId, "命令");
+          const title = await this.generateTitle(guildId, userId, { main: "命令" });
           const renderData = {
             title,
             time: /* @__PURE__ */ new Date(),
             total: stats.total,
             list: stats.list
           };
-          const headers = ["命令", "次数", "上次使用"];
+          const headers = ["命令", "次数", "最后使用"];
           const result = await this.renderer.renderList(renderData, headers);
           return Buffer.isBuffer(result) ? import_koishi3.Element.image(result, "image/png") : result;
         } catch (error) {
@@ -391,29 +393,74 @@ var Stat = class {
       });
     }
     if (this.config.enableMsgStat) {
-      analyse.subcommand(".message", "消息类型统计").option("user", "-u [user:user] 查看指定用户的统计").option("guild", "-g [guildId:string] 查看指定群组的统计 (默认当前群)").usage("查询消息类型统计。支持按用户、按群组或组合查询。").action(async ({ session, options }) => {
+      analyse.subcommand(".msg", "消息发送统计").option("user", "-u [user:user] 指定用户").option("guild", "-g [guildId:string] 指定群组").option("type", "-t <type:string> 指定类型").usage("查询用户或群组的消息发送统计，默认展示全局统计。").action(async ({ session, options }) => {
         const userId = options.user ? import_koishi3.h.select(options.user, "user")[0]?.attrs.id : void 0;
         let guildId = options.guild;
-        if (options.guild === "" && !options.user) {
-          if (!session.guildId) return "私聊中请使用 -g <群组ID> 指定群组。";
+        if (!userId && !guildId && !options.type && session.guildId) {
           guildId = session.guildId;
+        } else if (!userId && !guildId && !session.guildId) {
+          return "请指定查询范围";
         }
         try {
-          const stats = await this.getMessageStats(guildId, userId);
+          if (options.type) {
+            const stats = await this.getMessageStatsByType(options.type, guildId, userId);
+            if (typeof stats === "string") return stats;
+            const title = await this.generateTitle(guildId, void 0, { main: "消息", subtype: options.type });
+            const renderData = {
+              title,
+              time: /* @__PURE__ */ new Date(),
+              total: stats.total,
+              list: stats.list
+            };
+            const headers = ["用户", "条数", "最后发言"];
+            const result = await this.renderer.renderList(renderData, headers);
+            return Buffer.isBuffer(result) ? import_koishi3.Element.image(result, "image/png") : result;
+          } else {
+            const stats = await this.getMessageStats(guildId, userId);
+            if (typeof stats === "string") return stats;
+            const title = await this.generateTitle(guildId, userId, { main: "消息" });
+            const renderData = {
+              title,
+              time: /* @__PURE__ */ new Date(),
+              total: stats.total,
+              list: stats.list
+            };
+            const headers = ["类型", "条数", "最后发言"];
+            const result = await this.renderer.renderList(renderData, headers);
+            return Buffer.isBuffer(result) ? import_koishi3.Element.image(result, "image/png") : result;
+          }
+        } catch (error) {
+          this.ctx.logger.error("渲染消息统计图片失败:", error);
+          return "渲染消息统计图片失败";
+        }
+      });
+    }
+    if (this.config.enableRankStat) {
+      analyse.subcommand(".rank", "用户发言排行").option("guild", "-g [guildId:string] 指定群组").option("hours", "-h <hours:number> 指定时长", { fallback: 24 }).usage("查询用户或群组的用户发言排行，默认展示全局统计。").action(async ({ session, options }) => {
+        let guildId = options.guild;
+        if (!guildId && session.guildId) guildId = session.guildId;
+        if (!guildId) return "请指定查询范围";
+        try {
+          const stats = await this.getActiveUserStats(guildId, options.hours);
           if (typeof stats === "string") return stats;
-          const title = await this._generateTitle(session, guildId, userId, "消息");
+          const listWithPercentage = stats.list.map((row) => {
+            const count = row[1];
+            const percentage = stats.total > 0 ? `${(count / stats.total * 100).toFixed(2)}%` : "0.00%";
+            return [...row, percentage];
+          });
+          const title = await this.generateTitle(guildId, void 0, { main: "排行", timeRange: options.hours });
           const renderData = {
             title,
             time: /* @__PURE__ */ new Date(),
             total: stats.total,
-            list: stats.list
+            list: listWithPercentage
           };
-          const headers = ["消息类型", "条数", "上次发送"];
+          const headers = ["用户", "总计发言", "占比"];
           const result = await this.renderer.renderList(renderData, headers);
           return Buffer.isBuffer(result) ? import_koishi3.Element.image(result, "image/png") : result;
         } catch (error) {
-          this.ctx.logger.error("渲染消息统计图片失败:", error);
-          return "渲染消息统计图片失败";
+          this.ctx.logger.error("渲染发言排行图片失败:", error);
+          return "渲染发言排行图片失败";
         }
       });
     }
@@ -421,33 +468,45 @@ var Stat = class {
   /**
    * @private
    * @async
-   * @method _generateTitle
-   * @description 通用的标题生成器。根据查询参数 (guildId, userId) 和统计类型动态生成易于理解的图片标题。
-   * @param {Session} session - 当前会话，备用。
+   * @method generateTitle
+   * @description 通用的标题生成器。根据查询参数和类型选项动态生成易于理解的图片标题。
    * @param {string} [guildId] - (可选) 查询的群组 ID。
    * @param {string} [userId] - (可选) 查询的用户 ID。
-   * @param {'命令' | '消息'} type - 统计类型，用于嵌入标题文本中。
+   * @param {object} options - 标题的配置选项。
+   * @param {'命令' | '消息' | '排行'} options.main - 标题主类型。
+   * @param {string} [options.subtype] - (可选) 消息类型的子类型。
+   * @param {number} [options.timeRange] - (可选) 排行的时间范围（小时）。
    * @returns {Promise<string>} 生成的标题字符串。
    */
-  async _generateTitle(session, guildId, userId, type) {
+  async generateTitle(guildId, userId, options) {
+    let scopeText;
     if (userId && guildId) {
       const user = await this.ctx.database.get("analyse_user", { channelId: guildId, userId }, ["userName"]);
       const guild = await this.ctx.database.get("analyse_user", { channelId: guildId }, ["channelName"]);
       const userName = user[0]?.userName || userId;
       const guildName = guild[0]?.channelName || guildId;
-      return `${userName} 在 ${guildName} 的${type}统计`;
-    }
-    if (userId) {
+      scopeText = `${userName} 在 ${guildName}`;
+    } else if (userId) {
       const user = await this.ctx.database.get("analyse_user", { userId }, ["userName"]);
       const userName = user[0]?.userName || userId;
-      return `${userName} 的全局${type}统计`;
-    }
-    if (guildId) {
+      scopeText = `${userName}的全局`;
+    } else if (guildId) {
       const guild = await this.ctx.database.get("analyse_user", { channelId: guildId }, ["channelName"]);
-      const guildName = guild[0]?.channelName || guildId;
-      return `${guildName} 的${type}统计`;
+      scopeText = guild[0]?.channelName || guildId;
+    } else {
+      scopeText = "全局";
+    }
+    switch (options.main) {
+      case "命令":
+        return `${scopeText}的命令统计`;
+      case "消息":
+        if (options.subtype) return `${scopeText}的"${options.subtype}"消息统计`;
+        return `${scopeText}的消息统计`;
+      case "排行":
+        return `${scopeText}的${options.timeRange}小时消息排行`;
+      default:
+        return scopeText;
     }
-    return `全局${type}统计`;
   }
   /**
    * @private
@@ -463,7 +522,7 @@ var Stat = class {
     if (guildId) userQuery.channelId = guildId;
     if (userId) userQuery.userId = userId;
     const users = await this.ctx.database.get("analyse_user", userQuery, ["uid"]);
-    if (users.length === 0) return "暂无目标用户的统计数据";
+    if (users.length === 0) return "暂无目标用户统计数据";
     const uids = users.map((u) => u.uid);
     const aggregatedStats = await this.ctx.database.select("analyse_cmd").where({ uid: { $in: uids } }).groupBy(["command"], {
       count: /* @__PURE__ */ __name((row) => import_koishi3.$.sum(row.count), "count"),
@@ -478,7 +537,7 @@ var Stat = class {
    * @private
    * @async
    * @method getMessageStats
-   * @description 从数据库中获取并聚合消息类型统计数据。
+   * @description 从数据库中获取并聚合所有消息类型的统计数据。
    * @param {string} [guildId] - (可选) 若提供，则将范围限制在此群组。
    * @param {string} [userId] - (可选) 若提供，则将范围限制在此用户。
    * @returns {Promise<{ list: RenderListItem[], total: number } | string>} 返回一个包含列表和总数的对象，或在无数据时返回提示字符串。
@@ -488,7 +547,7 @@ var Stat = class {
     if (guildId) userQuery.channelId = guildId;
     if (userId) userQuery.userId = userId;
     const users = await this.ctx.database.get("analyse_user", userQuery, ["uid"]);
-    if (users.length === 0) return "暂无目标用户的统计数据";
+    if (users.length === 0) return "暂无目标用户统计数据";
     const uids = users.map((u) => u.uid);
     const aggregatedStats = await this.ctx.database.select("analyse_msg").where({ uid: { $in: uids } }).groupBy(["type"], {
       count: /* @__PURE__ */ __name((row) => import_koishi3.$.sum(row.count), "count"),
@@ -499,6 +558,69 @@ var Stat = class {
     const list = aggregatedStats.map((item) => [item.type, item.count, item.lastUsed]);
     return { list, total: totalCount };
   }
+  /**
+   * @private
+   * @async
+   * @method getMessageStatsByType
+   * @description 按指定消息类型，从数据库中获取并聚合用户排行数据。
+   * @param {string} type - 要查询的消息类型。
+   * @param {string} [guildId] - (可选) 若提供，则将范围限制在此群组。
+   * @param {string} [userId] - (可选) 若提供，则将范围限制在此用户。
+   * @returns {Promise<{ list: RenderListItem[], total: number } | string>}
+   */
+  async getMessageStatsByType(type, guildId, userId) {
+    const userQuery = {};
+    if (guildId) userQuery.channelId = guildId;
+    if (userId) userQuery.userId = userId;
+    const users = await this.ctx.database.get("analyse_user", userQuery, ["uid", "userName"]);
+    if (users.length === 0) return "暂无目标用户统计数据";
+    const uids = users.map((u) => u.uid);
+    const userNameMap = new Map(users.map((u) => [u.uid, u.userName]));
+    const aggregatedStats = await this.ctx.database.select("analyse_msg").where({
+      uid: { $in: uids },
+      type
+    }).groupBy(["uid"], {
+      count: /* @__PURE__ */ __name((row) => import_koishi3.$.sum(row.count), "count"),
+      lastUsed: /* @__PURE__ */ __name((row) => import_koishi3.$.max(row.timestamp), "lastUsed")
+    }).orderBy("count", "desc").execute();
+    if (aggregatedStats.length === 0) return `暂无统计数据`;
+    const totalCount = aggregatedStats.reduce((sum, record) => sum + record.count, 0);
+    const list = aggregatedStats.map((item) => [
+      userNameMap.get(item.uid) || `UID ${item.uid}`,
+      item.count,
+      item.lastUsed
+    ]);
+    return { list, total: totalCount };
+  }
+  /**
+   * @private
+   * @async
+   * @method getActiveUserStats
+   * @description 从数据库中获取并聚合活跃用户排行数据。
+   * @param {string} guildId - 要查询的群组 ID。
+   * @param {number} hours - 查询过去的小时数。
+   * @returns {Promise<{ list: RenderListItem[], total: number } | string>}
+   */
+  async getActiveUserStats(guildId, hours) {
+    const since = new Date(Date.now() - hours * 3600 * 1e3);
+    const usersInGuild = await this.ctx.database.get("analyse_user", { channelId: guildId }, ["uid", "userId", "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 aggregatedStats = await this.ctx.database.select("analyse_msg").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();
+    if (aggregatedStats.length === 0) return "暂无统计数据";
+    const totalCount = aggregatedStats.reduce((sum, record) => sum + record.count, 0);
+    const list = aggregatedStats.map((item) => [
+      userNameMap.get(item.uid) || `UID ${item.uid}`,
+      item.count
+    ]);
+    return { list, total: totalCount };
+  }
 };
 
 // src/index.ts
@@ -518,13 +640,14 @@ var name = "chat-analyse";
 var using = ["database", "puppeteer"];
 var Config = import_koishi4.Schema.intersect([
   import_koishi4.Schema.object({
-    enableListener: import_koishi4.Schema.boolean().default(true).description("开启监听")
-  }).description("基本设置"),
+    enableListener: import_koishi4.Schema.boolean().default(true).description("启用消息监听"),
+    enableOriRecord: import_koishi4.Schema.boolean().default(true).description("启用原始记录")
+  }).description("监听配置"),
   import_koishi4.Schema.object({
     enableCmdStat: import_koishi4.Schema.boolean().default(true).description("启用命令统计"),
     enableMsgStat: import_koishi4.Schema.boolean().default(true).description("启用消息统计"),
-    enableAdvanced: import_koishi4.Schema.boolean().default(true).description("启用原始记录")
-  }).description("功能开关")
+    enableRankStat: import_koishi4.Schema.boolean().default(true).description("启用发言排行")
+  }).description("命令配置")
 ]);
 function apply(ctx, config) {
   if (config.enableListener) new Collector(ctx, config);

package/package.json

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