@zhin.js/plugin-group-suite 0.1.0

package/src/stats.ts

@@ -0,0 +1,288 @@
+import { formatCompact, MessageCommand, type Plugin } from "zhin.js";
+import type { GroupSuiteConfig } from "./config.js";
+import { getMessageContextKey, todayStr, ts } from "./shared.js";
+
+export function weekStartStr(): string {
+  const d = new Date();
+  const day = d.getDay() || 7;
+  d.setDate(d.getDate() - day + 1);
+  return `${d.getFullYear()}-${String(d.getMonth() + 1).padStart(2, "0")}-${String(d.getDate()).padStart(2, "0")}`;
+}
+
+export function monthStartStr(): string {
+  const d = new Date();
+  return `${d.getFullYear()}-${String(d.getMonth() + 1).padStart(2, "0")}-01`;
+}
+
+let _db: any = null;
+
+function getModel(): any {
+  return _db?.models?.get("message_stats") ?? null;
+}
+
+interface PendingIncrement {
+  user_id: string;
+  user_name: string;
+  group_id: string;
+  date: string;
+  count: number;
+}
+
+const buffer = new Map<string, PendingIncrement>();
+
+function bufferKey(userId: string, groupId: string, date: string): string {
+  return `${userId}:${groupId}:${date}`;
+}
+
+function getGroupId(message: { $channel?: { type?: string; id?: string } }): string {
+  if (message.$channel?.type === "group") {
+    return String(message.$channel.id ?? "");
+  }
+  return "";
+}
+
+async function flushBuffer(): Promise<void> {
+  const M = getModel();
+  if (!M || buffer.size === 0) return;
+  const entries = [...buffer.values()];
+  buffer.clear();
+  for (const entry of entries) {
+    try {
+      const existing: any[] = await M.select().where({
+        user_id: entry.user_id,
+        group_id: entry.group_id,
+        date: entry.date,
+      });
+      if (existing.length > 0) {
+        await M.update({
+          count: (existing[0].count || 0) + entry.count,
+          user_name: entry.user_name,
+          updated_at: ts(),
+        }).where({ id: existing[0].id });
+      } else {
+        await M.insert({
+          user_id: entry.user_id,
+          user_name: entry.user_name,
+          group_id: entry.group_id,
+          date: entry.date,
+          count: entry.count,
+          updated_at: ts(),
+        });
+      }
+    } catch {
+      /* single row failure */
+    }
+  }
+}
+
+async function queryStats(
+  groupId: string,
+  fromDate: string,
+): Promise<Map<string, { name: string; count: number }>> {
+  const M = getModel();
+  if (!M) return new Map();
+  const all: any[] = groupId
+    ? await M.select().where({ group_id: groupId })
+    : await M.select();
+  const result = new Map<string, { name: string; count: number }>();
+  for (const row of all) {
+    if (row.date < fromDate) continue;
+    const existing = result.get(row.user_id);
+    if (existing) {
+      existing.count += row.count || 0;
+      if (row.user_name) existing.name = row.user_name;
+    } else {
+      result.set(row.user_id, {
+        name: row.user_name || row.user_id,
+        count: row.count || 0,
+      });
+    }
+  }
+  return result;
+}
+
+function formatRank(
+  stats: Map<string, { name: string; count: number }>,
+  title: string,
+  size: number,
+  myUserId?: string,
+): string {
+  const sorted = [...stats.entries()].sort((a, b) => b[1].count - a[1].count);
+  const total = sorted.reduce((s, [, v]) => s + v.count, 0);
+  const top = sorted.slice(0, size);
+  if (top.length === 0) return `${title}\n暂无数据`;
+  const medals = ["🥇", "🥈", "🥉"];
+  const lines = top.map(([, v], i) => {
+    const prefix = i < 3 ? medals[i] : `${i + 1}.`;
+    return `${prefix} ${v.name} — ${v.count}条`;
+  });
+  let footer = `\n共 ${stats.size} 人, ${total} 条消息`;
+  if (myUserId) {
+    const myRank = sorted.findIndex(([uid]) => uid === myUserId);
+    if (myRank >= 0) {
+      footer += ` | 你第${myRank + 1}名 (${sorted[myRank][1].count}条)`;
+    }
+  }
+  return `${title}\n${lines.join("\n")}${footer}`;
+}
+
+export function registerStats(plugin: Plugin, cfg: GroupSuiteConfig): void {
+  const { logger, addCommand, addMiddleware, useContext, onDispose } = plugin;
+
+  useContext("database", (db: any) => {
+    _db = db;
+    db.define("message_stats", {
+      user_id: { type: "text", nullable: false },
+      user_name: { type: "text", default: "" },
+      group_id: { type: "text", default: "" },
+      date: { type: "text", nullable: false },
+      count: { type: "integer", default: 0 },
+      updated_at: { type: "text", default: "" },
+    });
+    logger.info(formatCompact({ op: "stats_model" }));
+  });
+
+  const flushTimer = setInterval(flushBuffer, 10_000);
+  onDispose(async () => {
+    clearInterval(flushTimer);
+    await flushBuffer();
+    buffer.clear();
+  });
+
+  addMiddleware(async (message, next) => {
+    const userId = String(message.$sender?.id || "");
+    if (!userId) return next();
+    const key = bufferKey(userId, getGroupId(message), todayStr());
+    const pending = buffer.get(key);
+    if (pending) {
+      pending.count++;
+      pending.user_name = String(message.$sender?.name || "");
+    } else {
+      buffer.set(key, {
+        user_id: userId,
+        user_name: String(message.$sender?.name || ""),
+        group_id: getGroupId(message),
+        date: todayStr(),
+        count: 1,
+      });
+    }
+    return next();
+  });
+
+  addCommand(
+    new MessageCommand("stats")
+      .desc("消息统计", "查看今日消息统计")
+      .action(async (message) => {
+        await flushBuffer();
+        const groupId = getGroupId(message);
+        const stats = await queryStats(groupId, todayStr());
+        const title = groupId ? "今日本群消息统计" : "今日全局消息统计";
+        return formatRank(
+          stats,
+          title,
+          cfg.rankSize,
+          String(message.$sender?.id || ""),
+        );
+      }),
+  );
+
+  addCommand(
+    new MessageCommand("stats-week")
+      .desc("周消息统计", "查看本周消息统计")
+      .action(async (message) => {
+        await flushBuffer();
+        const groupId = getGroupId(message);
+        const stats = await queryStats(groupId, weekStartStr());
+        const title = groupId ? "本周本群消息统计" : "本周全局消息统计";
+        return formatRank(
+          stats,
+          title,
+          cfg.rankSize,
+          String(message.$sender?.id || ""),
+        );
+      }),
+  );
+
+  addCommand(
+    new MessageCommand("stats-rank")
+      .desc("话唠排行", "查看活跃度排行榜")
+      .action(async (message) => {
+        await flushBuffer();
+        const groupId = getGroupId(message);
+        const stats = await queryStats(groupId, monthStartStr());
+        const title = groupId ? "本月话唠排行" : "全局话唠排行";
+        return formatRank(
+          stats,
+          title,
+          cfg.rankSize,
+          String(message.$sender?.id || ""),
+        );
+      }),
+  );
+
+  addCommand(
+    new MessageCommand("mystats")
+      .desc("我的统计", "查看个人消息统计")
+      .action(async (message) => {
+        await flushBuffer();
+        const M = getModel();
+        if (!M) return "统计数据库尚未就绪";
+        const userId = String(message.$sender?.id || "");
+        if (!userId) return "无法获取用户信息";
+        const groupId = getGroupId(message);
+        const rows: any[] = groupId
+          ? await M.select().where({ user_id: userId, group_id: groupId })
+          : await M.select().where({ user_id: userId });
+        if (rows.length === 0) return "暂无你的消息记录";
+        const today = todayStr();
+        const weekStart = weekStartStr();
+        const monthStart = monthStartStr();
+        let todayCount = 0;
+        let weekCount = 0;
+        let monthCount = 0;
+        let totalCount = 0;
+        for (const row of rows) {
+          const c = row.count || 0;
+          totalCount += c;
+          if (row.date >= monthStart) monthCount += c;
+          if (row.date >= weekStart) weekCount += c;
+          if (row.date === today) todayCount += c;
+        }
+        const scope = groupId ? "本群" : "全局";
+        return [
+          `${message.$sender?.name || "你"} 的${scope}消息统计`,
+          `今日: ${todayCount} 条`,
+          `本周: ${weekCount} 条`,
+          `本月: ${monthCount} 条`,
+          `总计: ${totalCount} 条`,
+          `活跃天数: ${rows.length} 天`,
+        ].join("\n");
+      }),
+  );
+
+  const cleanupTimer = setInterval(async () => {
+    const M = getModel();
+    if (!M) return;
+    try {
+      const cutoff = new Date();
+      cutoff.setDate(cutoff.getDate() - cfg.statsRetentionDays);
+      const cutoffStr = `${cutoff.getFullYear()}-${String(cutoff.getMonth() + 1).padStart(2, "0")}-${String(cutoff.getDate()).padStart(2, "0")}`;
+      const all: any[] = await M.select();
+      for (const row of all.filter((r) => r.date < cutoffStr)) {
+        await M.delete().where({ id: row.id });
+      }
+    } catch {
+      /* ignore */
+    }
+  }, 24 * 60 * 60_000);
+
+  onDispose(() => clearInterval(cleanupTimer));
+
+  logger.info(
+    formatCompact({
+      op: "stats_load",
+      rank_size: cfg.rankSize,
+      retention_days: cfg.statsRetentionDays,
+    }),
+  );
+}

package/src/teach.ts

@@ -0,0 +1,259 @@
+import { MessageCommand, type Plugin } from "zhin.js";
+import type { GroupSuiteConfig } from "./config.js";
+import { getMessageContextKey, ts } from "./shared.js";
+
+const cooldownMap = new Map<string, number>();
+
+function isSafeRegex(pattern: string): boolean {
+  if (pattern.length > 200) return false;
+  if (/(\+|\*|\{)\)?(\+|\*|\{)/.test(pattern)) return false;
+  if (/\([^)]*(\+|\*)[^)]*(\+|\*)[^)]*\)[\+\*]/.test(pattern)) return false;
+  const altGroups = pattern.match(/\([^)]*\|[^)]*\)/g) || [];
+  for (const g of altGroups) {
+    if ((g.match(/\|/g) || []).length > 10) return false;
+  }
+  return true;
+}
+
+function processAnswer(
+  answer: string,
+  message: { $sender?: { name?: string; id?: string } },
+  match?: RegExpMatchArray,
+): string {
+  let result = answer;
+  result = result.replace(/\{sender\}/g, message.$sender?.name || "你");
+  result = result.replace(/\{sender\.id\}/g, message.$sender?.id || "");
+  result = result.replace(/\{time\}/g, new Date().toLocaleTimeString("zh-CN"));
+  result = result.replace(/\{date\}/g, new Date().toLocaleDateString("zh-CN"));
+  if (match) {
+    for (let i = 1; i < match.length; i++) {
+      result = result.replace(new RegExp(`\\$${i}`, "g"), match[i] || "");
+    }
+  }
+  return result;
+}
+
+let _db: any = null;
+
+function getQA(): any {
+  return _db?.models?.get("teach_qa") ?? null;
+}
+
+export function registerTeach(plugin: Plugin, cfg: GroupSuiteConfig): void {
+  const { addCommand, addMiddleware, useContext, onDispose } = plugin;
+
+  useContext("database", (db: any) => {
+    _db = db;
+    db.define("teach_qa", {
+      question: { type: "text", nullable: false },
+      answer: { type: "text", nullable: false },
+      is_regex: { type: "integer", default: 0 },
+      context_type: { type: "text", default: "global" },
+      context_id: { type: "text", default: "" },
+      creator_id: { type: "text", default: "" },
+      creator_name: { type: "text", default: "" },
+      hit_count: { type: "integer", default: 0 },
+      created_at: { type: "text", default: "" },
+      updated_at: { type: "text", default: "" },
+    });
+  });
+
+  const cooldownCleanup = setInterval(() => {
+    const now = Date.now();
+    for (const [key, time] of cooldownMap) {
+      if (now - time > cfg.teachCooldownMs * 2) cooldownMap.delete(key);
+    }
+  }, 60_000);
+  onDispose(() => clearInterval(cooldownCleanup));
+
+  async function findMatch(
+    content: string,
+    ctxType: string,
+    ctxId: string,
+  ): Promise<any | null> {
+    const QA = getQA();
+    if (!QA) return null;
+    const allItems: any[] = await QA.select();
+    const candidates = allItems.filter(
+      (item) =>
+        item.context_type === "global" ||
+        (item.context_type === ctxType && item.context_id === ctxId),
+    );
+    for (const item of candidates) {
+      if (!item.is_regex && item.question === content) return item;
+    }
+    if (cfg.teachAllowRegex) {
+      for (const item of candidates) {
+        if (!item.is_regex) continue;
+        try {
+          if (new RegExp(item.question, "i").test(content)) return item;
+        } catch {
+          continue;
+        }
+      }
+    }
+    return null;
+  }
+
+  addMiddleware(async (message, next) => {
+    const content = (message.$raw || "").trim();
+    if (!content) return next();
+    const { type: ctxType, id: ctxId } = getMessageContextKey(message);
+    const matched = await findMatch(content, ctxType, ctxId);
+    if (!matched) return next();
+    const cooldownKey = `${matched.id}:${ctxType}:${ctxId}`;
+    const last = cooldownMap.get(cooldownKey);
+    if (last && Date.now() - last < cfg.teachCooldownMs) return next();
+    cooldownMap.set(cooldownKey, Date.now());
+    const QA = getQA();
+    if (QA) {
+      try {
+        await QA.update({
+          hit_count: (matched.hit_count || 0) + 1,
+          updated_at: ts(),
+        }).where({ id: matched.id });
+      } catch {
+        /* ignore */
+      }
+    }
+    let answer = matched.answer;
+    if (matched.is_regex) {
+      try {
+        const m = content.match(new RegExp(matched.question, "i"));
+        answer = processAnswer(answer, message, m || undefined);
+      } catch {
+        /* ignore */
+      }
+    } else {
+      answer = processAnswer(answer, message);
+    }
+    await message.$reply(answer);
+  });
+
+  addCommand(
+    new MessageCommand("teach <question:text> <answer:text>")
+      .desc("教我问答", "教会 Bot 一个新的问答对")
+      .action(async (message, result) => {
+        const QA = getQA();
+        if (!QA) return "问答数据库尚未就绪，请稍后重试";
+        const question = result.params.question?.trim();
+        const answer = result.params.answer?.trim();
+        if (!question || !answer) return "请提供问题和回答";
+        const { type: ctxType, id: ctxId } = getMessageContextKey(message);
+        if (ctxType === "group") {
+          const existing: any[] = await QA.select().where({
+            context_type: ctxType,
+            context_id: ctxId,
+          });
+          if (existing.length >= cfg.teachMaxPerGroup) {
+            return `该群问答数已达上限 (${cfg.teachMaxPerGroup})`;
+          }
+        }
+        const duplicate: any[] = await QA.select().where({
+          question,
+          context_type: ctxType,
+          context_id: ctxId,
+        });
+        if (duplicate.length > 0) {
+          await QA.update({ answer, updated_at: ts() }).where({
+            id: duplicate[0].id,
+          });
+          return `已更新问答：「${question}」→「${answer}」`;
+        }
+        await QA.insert({
+          question,
+          answer,
+          is_regex: 0,
+          context_type: ctxType,
+          context_id: ctxId,
+          creator_id: message.$sender?.id || "",
+          creator_name: message.$sender?.name || "",
+          hit_count: 0,
+          created_at: ts(),
+          updated_at: ts(),
+        });
+        return `学会了！发送「${question}」我会回复「${answer}」`;
+      }),
+  );
+
+  addCommand(
+    new MessageCommand("teach-regex <pattern:text> <answer:text>")
+      .desc("教我正则问答", "用正则匹配")
+      .action(async (message, result) => {
+        const QA = getQA();
+        if (!QA) return "问答数据库尚未就绪";
+        if (!cfg.teachAllowRegex) return "管理员已禁用正则问答";
+        const pattern = result.params.pattern?.trim();
+        const answer = result.params.answer?.trim();
+        if (!pattern || !answer) return "请提供正则和回答";
+        try {
+          new RegExp(pattern, "i");
+        } catch (e) {
+          return `正则表达式不合法: ${(e as Error).message}`;
+        }
+        if (!isSafeRegex(pattern)) return "该正则可能导致性能问题，请简化";
+        const { type: ctxType, id: ctxId } = getMessageContextKey(message);
+        await QA.insert({
+          question: pattern,
+          answer,
+          is_regex: 1,
+          context_type: ctxType,
+          context_id: ctxId,
+          creator_id: message.$sender?.id || "",
+          creator_name: message.$sender?.name || "",
+          hit_count: 0,
+          created_at: ts(),
+          updated_at: ts(),
+        });
+        return `学会了！匹配 /${pattern}/ 的消息我会回复「${answer}」`;
+      }),
+  );
+
+  addCommand(
+    new MessageCommand("forget <question:text>")
+      .desc("忘记问答", "删除问答对")
+      .action(async (message, result) => {
+        const QA = getQA();
+        if (!QA) return "问答数据库尚未就绪";
+        const question = result.params.question?.trim();
+        if (!question) return "请提供要删除的问题";
+        const { type: ctxType, id: ctxId } = getMessageContextKey(message);
+        const items: any[] = await QA.select().where({
+          question,
+          context_type: ctxType,
+          context_id: ctxId,
+        });
+        if (items.length === 0) return `没有找到问题「${question}」`;
+        await QA.delete().where({ id: items[0].id });
+        return `已忘记「${question}」的回答`;
+      }),
+  );
+
+  addCommand(
+    new MessageCommand("teach-list [page:number]")
+      .desc("问答列表", "查看问答对")
+      .action(async (message, result) => {
+        const QA = getQA();
+        if (!QA) return "问答数据库尚未就绪";
+        const page = Math.max(1, result.params.page || 1);
+        const { type: ctxType, id: ctxId } = getMessageContextKey(message);
+        const allItems: any[] = await QA.select().where(
+          ctxType === "global"
+            ? { context_type: "global" }
+            : { context_type: ctxType, context_id: ctxId },
+        );
+        if (allItems.length === 0) return "还没有教过任何问答哦～";
+        const totalPages = Math.ceil(allItems.length / cfg.teachPageSize);
+        const safePage = Math.min(page, totalPages);
+        const start = (safePage - 1) * cfg.teachPageSize;
+        const pageItems = allItems.slice(start, start + cfg.teachPageSize);
+        const lines = pageItems.map((item, i) => {
+          const prefix = item.is_regex ? "[正则]" : "[精确]";
+          const q = item.is_regex ? `/${item.question}/` : item.question;
+          return `${start + i + 1}. ${prefix} ${q} → ${item.answer}`;
+        });
+        const header = ctxType === "global" ? "全局问答列表" : "本群问答列表";
+        return `${header}\n${lines.join("\n")}\n第 ${safePage}/${totalPages} 页 · 共 ${allItems.length} 条`;
+      }),
+  );
+}

package/tools/checkin-query/checkin-query.tool.md

@@ -0,0 +1,11 @@
+---
+name: checkin_query
+description: 查询用户的签到积分信息
+parameters:
+  user_id:
+    type: string
+    description: 用户ID（可选，不填则返回统计摘要）
+tags: [签到, 积分, 查询]
+keywords: [签到, 积分, 查询积分]
+handler: ./handler.ts
+---

package/tools/checkin-query/handler.ts

@@ -0,0 +1,21 @@
+import { getModel, todayStr } from '../../src/index.js';
+
+export default async function (args: { user_id?: string }) {
+  const M = getModel();
+  if (!M) return '签到数据库尚未就绪';
+
+  const userId = args.user_id;
+  if (userId) {
+    const rows: any[] = await M.select().where({ user_id: userId });
+    if (rows.length === 0) return `用户 ${userId} 没有签到记录`;
+    const u = rows[0];
+    return `${u.user_name}: 积分=${u.points}, 累计=${u.total_checkins}天, 连续=${u.streak}天, 最长=${u.max_streak}天, 上次=${u.last_checkin}`;
+  }
+
+  const all: any[] = await M.select();
+  const totalUsers = all.length;
+  const totalPoints = all.reduce((s: number, u: any) => s + (u.points || 0), 0);
+  const today = todayStr();
+  const todayCount = all.filter((u: any) => u.last_checkin === today).length;
+  return `签到系统统计\n总用户: ${totalUsers}\n总积分: ${totalPoints}\n今日签到: ${todayCount}人`;
+}

package/tools/checkin-rank/checkin-rank.tool.md

@@ -0,0 +1,11 @@
+---
+name: checkin_rank
+description: 获取积分排行榜数据
+parameters:
+  limit:
+    type: number
+    description: 返回前 N 名（默认10）
+tags: [签到, 排行]
+keywords: [排行, 积分排行, 签到排行]
+handler: ./handler.ts
+---

package/tools/checkin-rank/handler.ts

@@ -0,0 +1,16 @@
+import { getModel } from '../../src/index.js';
+
+export default async function (args: { limit?: number }) {
+  const M = getModel();
+  if (!M) return '签到数据库尚未就绪';
+
+  const limit = Math.min(Math.max(Number(args.limit) || 10, 1), 50);
+  const all: any[] = await M.select();
+  const sorted = all.sort((a: any, b: any) => (b.points || 0) - (a.points || 0)).slice(0, limit);
+
+  if (sorted.length === 0) return '暂无排行数据';
+
+  return sorted
+    .map((u: any, i: number) => `${i + 1}. ${u.user_name || u.user_id} — ${u.points}分 (连续${u.streak}天)`)
+    .join('\n');
+}

package/tools/stats-query/handler.ts

@@ -0,0 +1,25 @@
+import { flushBuffer, queryStats, todayStr, weekStartStr, monthStartStr } from '../../src/index.js';
+
+export default async function (args: { group_id?: string; period?: string }) {
+  await flushBuffer();
+  const groupId = args.group_id || '';
+  const period = args.period || 'today';
+
+  let fromDate: string;
+  switch (period) {
+    case 'week': fromDate = weekStartStr(); break;
+    case 'month': fromDate = monthStartStr(); break;
+    default: fromDate = todayStr(); break;
+  }
+
+  const stats = await queryStats(groupId, fromDate);
+  if (stats.size === 0) return `${period} 暂无消息统计数据`;
+
+  const sorted = [...stats.entries()].sort((a, b) => b[1].count - a[1].count);
+  const total = sorted.reduce((s, [, v]) => s + v.count, 0);
+
+  const top10 = sorted.slice(0, 10);
+  const lines = top10.map(([, v], i) => `${i + 1}. ${v.name} — ${v.count}条`);
+
+  return `消息统计 (${period})\n总消息: ${total}条, 活跃用户: ${stats.size}人\n${lines.join('\n')}`;
+}

package/tools/stats-query/stats-query.tool.md

@@ -0,0 +1,16 @@
+---
+name: stats_query
+description: 查询消息统计数据
+parameters:
+  group_id:
+    type: string
+    description: 群ID（可选，不填查全局）
+  period:
+    type: string
+    description: "时段: today/week/month（默认today）"
+    enum: [today, week, month]
+    default: today
+tags: [统计, 消息]
+keywords: [统计, 消息统计, 消息量]
+handler: ./handler.ts
+---

package/tools/stats-user/handler.ts

@@ -0,0 +1,27 @@
+import { flushBuffer, getModel, todayStr, weekStartStr } from '../../src/index.js';
+
+export default async function (args: { user_id: string }) {
+  await flushBuffer();
+  const M = getModel();
+  if (!M) return '统计数据库尚未就绪';
+
+  const userId = args.user_id;
+  if (!userId) return '请提供用户ID';
+
+  const rows: any[] = await M.select().where({ user_id: userId });
+  if (rows.length === 0) return `用户 ${userId} 暂无消息记录`;
+
+  const today = todayStr();
+  const weekStart = weekStartStr();
+  let todayCount = 0, weekCount = 0, totalCount = 0;
+
+  for (const row of rows) {
+    const c = row.count || 0;
+    totalCount += c;
+    if (row.date >= weekStart) weekCount += c;
+    if (row.date === today) todayCount += c;
+  }
+
+  const name = rows[0].user_name || userId;
+  return `${name} 的统计\n今日: ${todayCount}条\n本周: ${weekCount}条\n总计: ${totalCount}条\n活跃天数: ${rows.length}天`;
+}

package/tools/stats-user/stats-user.tool.md

@@ -0,0 +1,12 @@
+---
+name: stats_user
+description: 查询指定用户的消息统计
+parameters:
+  user_id:
+    type: string
+    description: 用户ID
+    required: true
+tags: [统计, 用户]
+keywords: [用户统计, 消息统计, 个人统计]
+handler: ./handler.ts
+---