koishi-plugin-chat-patch 3.0.2 → 5.0.1

package/package.json

@@ -1,14 +1,22 @@
 {
   "name": "koishi-plugin-chat-patch",
   "description": "[<ruby>chat-patch<rp>（</rp><rt>点我预览效果</rt><rp>）</rp></ruby>](https://i0.hdslb.com/bfs/openplatform/71074dfc9e5256fc3333d8bd8478bec1af874046.png) 视奸小插件((bushi( (低性能警告)。手机端适配。灵感来自 chat 插件。",
-  "version": "3.0.2",
+  "version": "5.0.1",
+  "scripts": {
+    "build:web": "npm --prefix client/web run build",
+    "prepack": "npm run build:web",
+    "prepublishOnly": "npm run build:web",
+    "yakumo:before:build": "npm --prefix client/web run build"
+  },
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "files": [
     "client",
     "dist",
     "lib",
-    "src"
+    "src",
+    "client/web/dist",
+    "client/web/src"
   ],
   "license": "MIT",
   "homepage": "https://github.com/koishi-shangxue-plugins/koishi-shangxue-apps/",
@@ -34,6 +42,8 @@
   },
   "peerDependencies": {
     "@koishijs/plugin-console": "^5.11.0",
+    "@koishijs/plugin-server": "^3.2.9",
+    "@koishijs/plugin-server-satori": "^2.9.1",
     "koishi": "^4.16.0"
   },
   "devDependencies": {
@@ -47,6 +57,9 @@
     "tailwindcss": "^3.4.17"
   },
   "dependencies": {
+    "file-type": "^16.5.4",
+    "koa-send": "^5.0.1",
+    "level": "^10.0.0",
     "mime-types": "^3.0.2"
   }
 }

package/readme.md

@@ -1,25 +1,3 @@
 # koishi-plugin-chat-patch
 
 [![npm](https://img.shields.io/npm/v/koishi-plugin-chat-patch?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-chat-patch)   [![npm downloads](https://img.shields.io/npm/dm/koishi-plugin-chat-patch)](https://www.npmjs.com/package/koishi-plugin-chat-patch)
-
-Koishi 控制台聊天插件，允许用户直接在控制台中管理机器人、频道和消息。
-
-支持消息的收发、图片缓存、频道置顶等。
-
-## ✨ 功能特性
-
-- **聊天界面**：在 Koishi 控制台内直接查看机器人的聊天记录。
-- **消息收发**：支持接收文本、图片等多种类型的消息。
-- **图片缓存**：通过 IndexedDB 缓存图片，优化加载速度并减少网络请求。
-- **手机端优化**：针对手机端进行适配，提供滑动返回等手势操作，并可配置聊天容器高度以防止输入框被遮挡。
-- **平台屏蔽**：可配置屏蔽特定平台的消息，避免不必要的干扰。
-
-## 🛠️ 开发与贡献
-
-欢迎 PR ~
-
-PR 方式请参考 -> <https://github.com/koishi-shangxue-plugins/koishi-shangxue-apps/tree/main?tab=readme-ov-file#%E5%A6%82%E4%BD%95%E5%9C%A8%E9%A1%B9%E7%9B%AE%E6%A8%A1%E6%9D%BF%E4%B8%AD%E5%BC%80%E5%8F%91%E6%AD%A4%E4%BB%93%E5%BA%93>
-
-## 许可证
-
-本项目采用 [MIT 许可证](LICENSE) 开源。

package/src/bootstrap.ts

@@ -0,0 +1,71 @@
+import { Context } from 'koishi'
+import {} from '@koishijs/plugin-server'
+import {} from '@koishijs/plugin-server-satori'
+import {} from '@satorijs/plugin-server'
+
+import { Config } from './config'
+import { ChatDatabase } from './database'
+import { PluginLogger } from './logger'
+import { ContactCacheQuery, ContactCacheResult, HistoryQuery, HistoryResult, PluginConfigPayload, SatoriBootstrap } from './types'
+
+function resolveEndpoint(ctx: Context, config: Config): string {
+  const url = ctx.satori?.server?.url ?? '/satori'
+  const clean = url.startsWith('undefined') ? url.slice(9) : url
+  if (/^https?:\/\//i.test(clean)) return clean
+  const base = ctx.server?.selfUrl ?? ctx.server?.config?.selfUrl ?? ''
+  return `${base}${clean.startsWith('/') ? clean : `/${clean}`}`
+}
+
+export function registerBootstrap(
+  ctx: Context,
+  config: Config,
+  database: ChatDatabase,
+  logger: PluginLogger,
+) {
+  ctx.console.addListener('chat-patch/bootstrap', (): SatoriBootstrap => {
+    logger.logInfo('返回 Satori bootstrap:', {
+      endpoint: resolveEndpoint(ctx, config),
+      basePath: config.basePath,
+    })
+    return {
+      endpoint: resolveEndpoint(ctx, config),
+      token: ctx.satori?.server?.config?.token ?? '',
+      basePath: config.basePath,
+    }
+  }, { authority: 4 })
+
+  ctx.console.addListener('chat-patch/history', async (query: HistoryQuery): Promise<HistoryResult> => {
+    const messages = await database.listMessages(
+      query.platform,
+      query.selfId,
+      query.channelId,
+      query.limit,
+    )
+    return { messages }
+  }, { authority: 4 })
+
+  ctx.console.addListener('chat-patch/config', (): PluginConfigPayload => {
+    return {
+      basePath: config.basePath,
+      maxMessagesPerChannel: config.maxMessagesPerChannel,
+      historyPageSize: config.historyPageSize,
+      maxMediaFiles: config.maxMediaFiles,
+      blockedPlatforms: config.blockedPlatforms ?? [],
+      loggerinfo: config.loggerinfo,
+    }
+  }, { authority: 4 })
+
+  ctx.console.addListener('chat-patch/contact-cache', async (query: ContactCacheQuery): Promise<ContactCacheResult> => {
+    if (query.contacts) {
+      if (query.append) {
+        for (const contact of query.contacts) {
+          await database.appendContact(query.platform, query.selfId, query.type, contact)
+        }
+        return { contacts: await database.getContacts(query.platform, query.selfId, query.type) }
+      }
+      await database.setContacts(query.platform, query.selfId, query.type, query.contacts)
+      return { contacts: query.contacts }
+    }
+    return { contacts: await database.getContacts(query.platform, query.selfId, query.type) }
+  }, { authority: 4 })
+}

package/src/cache.ts

@@ -0,0 +1,319 @@
+import { Bot, Context, Universal } from 'koishi'
+
+import { ChatDatabase } from './database'
+import { ContactCacheItem } from './types'
+import { PluginLogger } from './logger'
+
+function getString(value: unknown): string {
+  return typeof value === 'string' ? value : ''
+}
+
+function isUsableName(value: string, id: string): boolean {
+  return Boolean(value) && value !== id && !/unknown user|unknown guild|unknown channel/i.test(value)
+}
+
+function normalizeGroupId(value: string): string {
+  const raw = value.replace(/^(?:group|room|chat|channel|guild):/i, '').trim()
+  const wrapped = raw.match(/^\[_?([\s\S]+?)_?\]$/)
+  return wrapped ? wrapped[1] : raw || value
+}
+
+function isPrivateChannelType(value: unknown): boolean {
+  const num = Number(value)
+  if (Number.isFinite(num)) return num === 1
+  const text = String(value ?? '').toLowerCase()
+  return text === 'direct' || text === 'private'
+}
+
+function normalizeCacheType(type: string): 'group' | 'friend' {
+  if (type === 'user' || type === 'friend') return 'friend'
+  return 'group'
+}
+
+function encodeKeyPart(value: string): string {
+  return encodeURIComponent(value)
+}
+
+type FetchContact = (bot: Bot<Context>) => Promise<ContactCacheItem | null>
+
+export class ContactCacheService {
+  private inflight = new Map<string, Promise<ContactCacheItem | null>>()
+
+  constructor(
+    private ctx: Context,
+    private database: ChatDatabase,
+    private logger: PluginLogger,
+  ) {}
+
+  // 查询单用户缓存；未命中时由后端调用 bot.getUser，并写入数据库
+  async getUser(
+    platform: string,
+    selfId: string,
+    userId: string,
+    guildId?: string,
+    channelId?: string,
+    fallbackName?: string,
+    fallbackAvatar?: string,
+  ): Promise<ContactCacheItem | null> {
+    if (!userId || userId === '0') return null
+    const guild = guildId && guildId !== '0' ? guildId : undefined
+    const channel = channelId && channelId !== '0' ? channelId : undefined
+    const item = await this.resolve(platform, selfId, 'user', userId, async (bot) => {
+      let user: Universal.User | null = null
+      let member: Universal.GuildMember | null = null
+      try {
+        user = await bot.getUser(userId, guild)
+      } catch (error) {
+        this.logger.logInfo('用户身份回源失败:', userId, error)
+      }
+
+      let name = getString(user?.name)
+        || getString(user?.nick)
+        || getString(user?.username)
+        || getString(user?.nickname)
+      let avatar = getString(user?.avatar)
+
+      if (guild && (!name || !avatar)) {
+        try {
+          member = await bot.getGuildMember(guild, userId)
+        } catch (error) {
+          this.logger.logInfo('群成员身份回源失败:', userId, error)
+        }
+        name = name
+          || getString(member?.name)
+          || getString(member?.nick)
+          || getString(member?.user?.name)
+          || getString(member?.user?.nick)
+        avatar = avatar
+          || getString(member?.avatar)
+          || getString(member?.user?.avatar)
+      }
+
+      const eventName = getString(fallbackName)
+      const eventAvatar = getString(fallbackAvatar)
+      if (!isUsableName(name, userId) && isUsableName(eventName, userId)) {
+        name = eventName
+      }
+      if (!avatar && eventAvatar) avatar = eventAvatar
+
+      if (!name && !avatar) return null
+      this.logger.logInfo('用户身份已回源并写入缓存:', userId, name)
+      return {
+        id: userId,
+        name: name || userId,
+        avatar: avatar || undefined,
+        raw: {
+          id: userId,
+          user_id: userId,
+          name,
+          nickname: name,
+          avatar: avatar || undefined,
+          channel_id: channel || undefined,
+          guild_id: guild || undefined,
+        },
+      }
+    }, {
+      name: fallbackName,
+      avatar: fallbackAvatar,
+    })
+    if (!item) return null
+    const needChannel = Boolean(channel && item.channelId !== channel)
+    const needGuild = Boolean(guild && item.guildId !== guild)
+    if (channel) item.channelId = channel
+    if (guild) item.guildId = guild
+    if (needChannel || needGuild) {
+      if (item.raw && typeof item.raw === 'object') {
+        const raw = item.raw as Record<string, unknown>
+        if (channel) raw.channel_id = channel
+        if (guild) raw.guild_id = guild
+      }
+      await this.database.appendContact(platform, selfId, 'friend', item)
+    }
+    return item
+  }
+
+  // 查询群/频道缓存；未命中时由后端调用 guild.get/channel.get，并写入数据库
+  async getGroup(
+    platform: string,
+    selfId: string,
+    id: string,
+    guildId?: string,
+    channelId?: string,
+    fallbackName?: string,
+    fallbackAvatar?: string,
+    channelType?: unknown,
+  ): Promise<ContactCacheItem | null> {
+    const guild = guildId && guildId !== '0' ? guildId : undefined
+    const channel = channelId && channelId !== '0' ? channelId : undefined
+    if (isPrivateChannelType(channelType)) return null
+    if (channelType === undefined
+      && (/^(?:private|direct):/i.test(id) || /^(?:private|direct):/i.test(channel || ''))) return null
+    const rawId = id && id !== '0' ? normalizeGroupId(id) : ''
+    const cacheId = rawId || guild || normalizeGroupId(channel || '') || ''
+    if (!cacheId) return null
+    const item = await this.resolve(platform, selfId, 'group', cacheId, async (bot) => {
+      const [guildData, channelData] = await Promise.all([
+        guild
+          ? this.safeGet(() => bot.getGuild(guild))
+          : cacheId
+            ? this.safeGet(() => bot.getGuild(cacheId))
+            : Promise.resolve(null),
+        channel
+          ? this.safeGet(() => bot.getChannel(channel, guild))
+          : Promise.resolve(null),
+      ])
+
+      let name = getString(guildData?.name) || getString(channelData?.name)
+      let avatar = getString(guildData?.avatar) || getString(channelData?.avatar)
+      const eventName = getString(fallbackName)
+      const eventAvatar = getString(fallbackAvatar)
+      if (!isUsableName(name, cacheId) && isUsableName(eventName, cacheId)) {
+        name = eventName
+      }
+      if (!avatar && eventAvatar) avatar = eventAvatar
+      if (!name && !avatar) return null
+      this.logger.logInfo('群组身份已回源并写入缓存:', cacheId, name)
+      return {
+        id: cacheId,
+        name: name || cacheId,
+        avatar: avatar || undefined,
+        raw: {
+          id: cacheId,
+          group_id: cacheId,
+          name,
+          group_name: name,
+          avatar: avatar || undefined,
+          channel_id: channel || undefined,
+          channel_type: channelType ?? undefined,
+          guild_id: guild || undefined,
+        },
+      }
+    }, {
+      name: fallbackName,
+      avatar: fallbackAvatar,
+    })
+    if (!item) return null
+    const needChannel = Boolean(channel && item.channelId !== channel)
+    const needGuild = Boolean(guild && item.guildId !== guild)
+    if (channel) item.channelId = channel
+    if (guild) item.guildId = guild
+    if (needChannel || needGuild) {
+      if (item.raw && typeof item.raw === 'object') {
+        const raw = item.raw as Record<string, unknown>
+        if (channel) raw.channel_id = channel
+        if (guild) raw.guild_id = guild
+      }
+      await this.database.appendContact(platform, selfId, 'group', item)
+    }
+    return item
+  }
+
+  // 收到群消息时更新该群对应的群友表
+  async recordGroupMember(
+    platform: string,
+    selfId: string,
+    groupId: string,
+    member: ContactCacheItem,
+  ) {
+    if (!platform || !selfId || !groupId || !member.id) return
+    await this.database.appendGroupMember(platform, selfId, groupId, member)
+  }
+
+  // 同一身份的并发请求合并，避免首条消息同时触发多个回源
+  private resolve(
+    platform: string,
+    selfId: string,
+    type: string,
+    id: string,
+    fetcher: FetchContact,
+    fallback?: { name?: string; avatar?: string },
+  ): Promise<ContactCacheItem | null> {
+    const canonical = normalizeCacheType(type)
+    const key = [platform, selfId, canonical, id].map(encodeKeyPart).join(':')
+    const existing = this.inflight.get(key)
+    if (existing) return existing
+
+    const task = this.resolveUncached(platform, selfId, canonical, id, fetcher, fallback)
+      .finally(() => this.inflight.delete(key))
+    this.inflight.set(key, task)
+    return task
+  }
+
+  private async resolveUncached(
+    platform: string,
+    selfId: string,
+    type: 'group' | 'friend',
+    id: string,
+    fetcher: FetchContact,
+    fallback?: { name?: string; avatar?: string },
+  ): Promise<ContactCacheItem | null> {
+    const cached = await this.database.getContact(platform, selfId, type, id)
+    if (cached && !this.shouldRefreshWithFallback(cached, id, fallback)) {
+      return this.publicContact(cached)
+    }
+
+    const bot = this.ctx.bots.find((item) => {
+      return item.platform === platform && item.selfId === selfId
+    })
+    if (!bot) {
+      const fallbackItem = this.toFallbackContact(id, fallback)
+      if (fallbackItem) {
+        await this.database.appendContact(platform, selfId, type, fallbackItem)
+        return this.publicContact(fallbackItem)
+      }
+      return null
+    }
+
+    const item = await fetcher(bot)
+    if (!item) return null
+    await this.database.appendContact(platform, selfId, type, item)
+    return this.publicContact(item)
+  }
+
+  private shouldRefreshWithFallback(
+    cached: ContactCacheItem,
+    id: string,
+    fallback?: { name?: string; avatar?: string },
+  ): boolean {
+    if (!fallback) return false
+    const cachedNameUsable = isUsableName(cached.name, id)
+    const fallbackNameUsable = isUsableName(getString(fallback.name), id)
+    const hasCachedAvatar = Boolean(cached.avatar)
+    const hasFallbackAvatar = Boolean(getString(fallback.avatar))
+    return (!cachedNameUsable && fallbackNameUsable) || (!hasCachedAvatar && hasFallbackAvatar)
+  }
+
+  private toFallbackContact(
+    id: string,
+    fallback?: { name?: string; avatar?: string },
+  ): ContactCacheItem | null {
+    const name = isUsableName(getString(fallback?.name), id) ? getString(fallback.name) : ''
+    const avatar = getString(fallback?.avatar)
+    if (!name && !avatar) return null
+    return {
+      id,
+      name: name || id,
+      avatar: avatar || undefined,
+    }
+  }
+
+  private async safeGet<T>(getter: () => Promise<T>): Promise<T | null> {
+    try {
+      return await getter()
+    } catch (error) {
+      this.logger.logInfo('群组身份回源失败:', error)
+      return null
+    }
+  }
+
+  private publicContact(item: ContactCacheItem): ContactCacheItem {
+    return {
+      id: item.id,
+      name: item.name,
+      avatar: item.avatar || undefined,
+      channelId: item.channelId || undefined,
+      guildId: item.guildId || undefined,
+      raw: item.raw ?? undefined,
+    }
+  }
+}

package/src/config.ts

@@ -1,47 +1,35 @@
 import { Schema } from 'koishi'
 
+export interface BlockedPlatform {
+  platformName: string
+  exactMatch: boolean
+}
+
 export interface Config {
   loggerinfo: boolean
-  clearIndexedDBOnStart: boolean
+  basePath: string
   maxMessagesPerChannel: number
-  messageChunkSize: number
-  channelCacheLimit: number
-  maxPersistImages: number
-  blockedPlatforms: Array<{
-    platformName: string
-    exactMatch: boolean
-  }>
+  historyPageSize: number
+  maxMediaFiles: number
+  blockedPlatforms: BlockedPlatform[]
 }
 
 export const Config: Schema<Config> = Schema.intersect([
   Schema.object({
-    maxMessagesPerChannel: Schema.number().default(500).description('每个群组最大保存消息数量').min(50).max(1500).step(1),
-    messageChunkSize: Schema.number().default(100).description('单个消息分块文件最大消息数量').min(20).max(500).step(1),
-    channelCacheLimit: Schema.number().default(50).description('内存中最多缓存的频道消息数量').min(1).max(200).step(1),
-    maxPersistImages: Schema.number().default(100).description('持久化存储的图片缓存数量').min(10).max(500).step(1),
-    blockedPlatforms: Schema.array(Schema.object({
-      platformName: Schema.string().description('平台名称或关键词'),
-      exactMatch: Schema.boolean().default(false).description('完全匹配？如果关闭，包含关键词即屏蔽').default(true)
-    })).role('table').description('屏蔽的平台列表').default(
-      [
-        {
-          "platformName": "qq",
-          "exactMatch": true
-        },
-        {
-          "platformName": "qqguild",
-          "exactMatch": true
-        },
-        {
-          "platformName": "sandbox",
-          "exactMatch": false
-        }
-      ]
-    ),
+    basePath: Schema.string().default('/chat-patch').description('Web 聊天室挂载路径'),
+    maxMessagesPerChannel: Schema.number().default(500).min(50).max(5000).step(1).description('每个频道最多保存的历史消息数'),
+    historyPageSize: Schema.number().default(50).min(10).max(500).step(1).description('历史消息分页大小'),
+    maxMediaFiles: Schema.number().default(200).min(20).max(2000).step(1).description('媒体缓存文件上限'),
   }).description('基础设置'),
-
   Schema.object({
-    clearIndexedDBOnStart: Schema.boolean().default(true).description('启动时强制清空IndexedDB缓存（适用于紧急情况，防止浏览器卡死）'),
-    loggerinfo: Schema.boolean().default(false).description('日志调试模式').experimental(),
-  }).description('开发者选项'),
+    blockedPlatforms: Schema.array(Schema.object({
+      platformName: Schema.string(),
+      exactMatch: Schema.boolean().default(true),
+    })).role('table').description('不记录历史的平台').default([
+      { platformName: 'qq', exactMatch: true },
+      { platformName: 'qqguild', exactMatch: true },
+      { platformName: 'sandbox', exactMatch: false },
+    ]),
+    loggerinfo: Schema.boolean().default(false).description('调试日志开关').hidden().experimental(),
+  }).description('高级设置'),
 ])