koishi-plugin-chat-patch 5.3.0 → 5.5.0

package/lib/self-message.d.ts

@@ -0,0 +1,27 @@
+import { Context } from 'koishi';
+import { Config } from './config';
+import { ChatDatabase } from './database';
+import { MediaManager } from './media';
+import { PluginLogger } from './logger';
+export declare class SelfMessageRecorder {
+    private ctx;
+    private config;
+    private database;
+    private media;
+    private logger;
+    private wrapped;
+    private sequence;
+    constructor(ctx: Context, config: Config, database: ChatDatabase, media: MediaManager, logger: PluginLogger);
+    start(): void;
+    dispose(): void;
+    private isBlocked;
+    private wrapBot;
+    private unwrapBot;
+    private prepareOptions;
+    private recordFromWrapper;
+    private markSelfMessageRevoked;
+    private recordSendEvent;
+    private resolveI18nElement;
+    private buildRecord;
+    private normalizeElements;
+}

package/lib/types.d.ts

@@ -0,0 +1,121 @@
+import type { Awaitable } from 'koishi';
+export interface SatoriBootstrap {
+    endpoint: string;
+    token: string;
+    basePath: string;
+    blockedPlatforms: Array<{
+        platformName: string;
+        exactMatch: boolean;
+    }>;
+}
+export interface MessageRecord {
+    id?: string;
+    sequence?: number;
+    type: string;
+    platform: string;
+    selfId: string;
+    channelId?: string;
+    guildId?: string;
+    userId?: string;
+    timestamp: number;
+    timestampMs?: number;
+    receivedAt?: number;
+    content?: string;
+    elements?: unknown[];
+    raw?: unknown;
+    revoked?: boolean;
+    revokedAt?: number;
+}
+export type SelfMessageChannelType = 'group' | 'user';
+export type SelfMessageSource = 'webui' | 'bot' | 'plugin';
+export interface SelfMessageRecord {
+    id: string;
+    platform: string;
+    selfId: string;
+    channelId: string;
+    guildId?: string;
+    channelType?: SelfMessageChannelType;
+    messageId?: string;
+    content?: string;
+    elements?: unknown[];
+    message?: unknown[];
+    forwardId?: string;
+    forwardContent?: unknown[];
+    sentAt: number;
+    sequence: number;
+    source: SelfMessageSource;
+    kind: string;
+    fingerprint?: string;
+    revoked?: boolean;
+    revokedAt?: number;
+}
+export interface SelfMessagePayload {
+    id?: string;
+    platform: string;
+    selfId: string;
+    channelId: string;
+    guildId?: string;
+    channelType?: SelfMessageChannelType;
+    messageId?: string;
+    content?: string;
+    elements?: unknown[];
+    message?: unknown[];
+    forwardId?: string;
+    forwardContent?: unknown[];
+    sentAt?: number;
+    sequence?: number;
+    source?: SelfMessageSource;
+    kind?: string;
+    revoked?: boolean;
+    revokedAt?: number;
+}
+export interface HistoryQuery {
+    platform: string;
+    selfId: string;
+    channelId: string;
+    limit?: number;
+}
+export interface HistoryResult {
+    messages: MessageRecord[];
+}
+export interface PinnedState {
+    bots: string[];
+    channels: string[];
+}
+export interface PluginConfigPayload {
+    basePath: string;
+    maxMessagesPerChannel: number;
+    historyPageSize: number;
+    maxMediaFiles: number;
+    blockedPlatforms: Array<{
+        platformName: string;
+        exactMatch: boolean;
+    }>;
+    loggerinfo: boolean;
+}
+export interface ContactCacheItem {
+    id: string;
+    name: string;
+    avatar?: string;
+    channelId?: string;
+    guildId?: string;
+    raw?: unknown;
+}
+export interface ContactCacheQuery {
+    platform: string;
+    selfId: string;
+    type: string;
+    contacts?: ContactCacheItem[];
+    append?: boolean;
+}
+export interface ContactCacheResult {
+    contacts?: ContactCacheItem[];
+}
+declare module '@koishijs/console' {
+    interface Events {
+        'chat-patch/bootstrap'(): SatoriBootstrap;
+        'chat-patch/history'(query: HistoryQuery): Awaitable<HistoryResult>;
+        'chat-patch/config'(): PluginConfigPayload;
+        'chat-patch/contact-cache'(query: ContactCacheQuery): Awaitable<ContactCacheResult>;
+    }
+}

package/lib/web.d.ts

@@ -0,0 +1,7 @@
+import { Context } from 'koishi';
+import { Config } from './config';
+import { ContactCacheService } from './cache';
+import { ChatDatabase } from './database';
+import { MediaManager } from './media';
+import { PluginLogger } from './logger';
+export declare function registerWeb(ctx: Context, config: Config, database: ChatDatabase, contactCache: ContactCacheService, media: MediaManager, logger: PluginLogger): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "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": "5.3.0",
+  "version": "5.5.0",
   "scripts": {
     "build:web": "npm --prefix client/web run build",
     "prepack": "npm run build:web",

package/src/bootstrap.ts

@@ -31,6 +31,7 @@ export function registerBootstrap(
       endpoint: resolveEndpoint(ctx, config),
       token: ctx.satori?.server?.config?.token ?? '',
       basePath: config.basePath,
+      blockedPlatforms: config.blockedPlatforms ?? [],
     }
   }, { authority: 4 })
 

package/src/cache.ts

@@ -13,9 +13,7 @@ function isUsableName(value: string, id: string): boolean {
 }
 
 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
+  return String(value)
 }
 
 function isPrivateChannelType(value: unknown): boolean {
@@ -146,8 +144,6 @@ export class ContactCacheService {
     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

package/src/config.ts

@@ -25,7 +25,7 @@ export const Config: Schema<Config> = Schema.intersect([
     blockedPlatforms: Schema.array(Schema.object({
       platformName: Schema.string(),
       exactMatch: Schema.boolean().default(true),
-    })).role('table').description('不记录历史的平台').default([
+    })).role('table').description('屏蔽消息接收的平台').default([
       { platformName: 'qq', exactMatch: true },
       { platformName: 'qqguild', exactMatch: true },
       { platformName: 'sandbox', exactMatch: false },

package/src/database.ts

@@ -58,10 +58,6 @@ function legacyGroupMemberKey(platform: string, selfId: string, groupId: string)
   return `gm:${platform}:${selfId}:${groupId}`
 }
 
-function isPrivateChannelId(value: unknown): boolean {
-  return typeof value === 'string' && /^(?:private|direct):/i.test(value)
-}
-
 function isPrivateChannelType(value: unknown): boolean {
   const num = Number(value)
   if (Number.isFinite(num)) return num === 1
@@ -70,16 +66,17 @@ function isPrivateChannelType(value: unknown): boolean {
 }
 
 function isUsableGroupContact(item: ContactCacheItem): boolean {
-  if (isPrivateChannelId(item.channelId)) return false
   if (typeof item.raw === 'object' && item.raw !== null) {
     const raw = item.raw as Record<string, unknown>
-    if (isPrivateChannelType(raw.channel_type)
-      || isPrivateChannelId(raw.channel_id)
-      || isPrivateChannelId(raw.channelId)) return false
+    if (isPrivateChannelType(raw.channel_type)) return false
   }
   return true
 }
 
+type CompactableLevel = Level<string, string> & {
+  compactRange(start: string, end: string): Promise<void>
+}
+
 export class ChatDatabase {
   private db: Level<string, string>
   private opened = false
@@ -106,6 +103,14 @@ export class ChatDatabase {
     this.logger.logInfo('LevelDB closed')
   }
 
+  async clearAll() {
+    // 先清空记录，再强制压缩，让旧 .ldb 文件也能被回收
+    await this.db.clear()
+    const db = this.db as unknown as CompactableLevel
+    await db.compactRange('', '\uffff')
+    this.logger.logInfo('数据库缓存已全部清空并完成压缩')
+  }
+
   async appendMessage(record: MessageRecord) {
     await this.db.put(messageKey(record), JSON.stringify(record))
     await this.trimMessages(record.platform, record.selfId, record.channelId || '')
@@ -193,6 +198,45 @@ export class ChatDatabase {
     return false
   }
 
+  async updateMessageRevoked(
+    platform: string,
+    selfId: string,
+    channelId: string,
+    messageId: string,
+    patch: { revoked: boolean; revokedAt: number },
+  ): Promise<boolean> {
+    const operations: Array<{ type: 'put'; key: string; value: string }> = []
+    for (const prefix of [messagePrefix(platform, selfId, channelId), legacyMessagePrefix(platform, selfId, channelId)]) {
+      for await (const [key, value] of this.db.iterator<string, string>({
+        gte: prefix,
+        lte: `${prefix}\uffff`,
+      })) {
+        try {
+          const parsed = JSON.parse(value) as unknown
+          if (typeof parsed !== 'object' || parsed === null) continue
+          const record = parsed as Partial<MessageRecord>
+          const raw = typeof record.raw === 'object' && record.raw !== null
+            ? record.raw as Record<string, unknown>
+            : {}
+          const rawMessage = typeof raw.message === 'object' && raw.message !== null
+            ? raw.message as Record<string, unknown>
+            : {}
+          const id = String(record.id ?? rawMessage.id ?? '')
+          if (!id || id !== messageId) continue
+          operations.push({
+            type: 'put',
+            key,
+            value: JSON.stringify({ ...parsed, ...patch }),
+          })
+        } catch {
+          // 单条解析失败不影响其他消息
+        }
+      }
+    }
+    if (operations.length) await this.db.batch(operations)
+    return operations.length > 0
+  }
+
   async findSelfForwardContent(
     platform: string,
     selfId: string,

package/src/index.ts

@@ -49,21 +49,21 @@ export async function apply(ctx: Context, config: Config) {
   const recorder = new Recorder(ctx, config, database, media, contactCache, pluginLogger)
   recorder.start()
 
-  const selfMessages = new SelfMessageRecorder(ctx, config, database, pluginLogger)
+  const selfMessages = new SelfMessageRecorder(ctx, config, database, media, pluginLogger)
   selfMessages.start()
 
   registerBootstrap(ctx, config, database, pluginLogger)
-  registerWeb(ctx, config, database, contactCache, pluginLogger)
+  registerWeb(ctx, config, database, contactCache, media, pluginLogger)
 
   ctx.console.addEntry({
     dev: path.resolve(__dirname, '../client/index.ts'),
     prod: path.resolve(__dirname, '../dist'),
   })
 
-  ctx.on('dispose', () => {
+  ctx.on('dispose', async () => {
     selfMessages.dispose()
     media.dispose()
-    void database.dispose()
+    await database.dispose()
     pluginLogger.logInfo('chat-patch 已卸载')
   })
 }

package/src/media.ts

@@ -27,6 +27,82 @@ function toLocalFilePath(value: string): string | null {
   return null
 }
 
+const MEDIA_TYPES = new Set([
+  'img',
+  'image',
+  'face',
+  'mface',
+  'audio',
+  'record',
+  'video',
+  'file',
+])
+
+function isCacheableMediaUrl(value: unknown): string {
+  const url = String(value ?? '').trim()
+  if (!url
+    || url.startsWith('data:')
+    || url.startsWith('blob:')
+    || url.startsWith('base64://')) return ''
+  return url
+}
+
+function isUrlLike(value: string): boolean {
+  return /^(?:https?:\/\/|file:\/\/|[a-z]:[\\/]|\\\\)/i.test(value)
+}
+
+function decodeMarkupValue(value: string): string {
+  return value
+    .replace(/&/g, '&')
+    .replace(/"/g, '"')
+    .replace(/'/g, "'")
+    .replace(/&lt;/g, '<')
+    .replace(/&gt;/g, '>')
+}
+
+function collectMarkupMediaUrls(markup: string, result: Set<string>) {
+  const pattern = /<(?:img|image|face|mface|audio|record|video|file)\b[^>]*?\b(?:src|url|file|href)\s*=\s*(["'])([\s\S]*?)\1/gi
+  let match: RegExpExecArray | null
+  while ((match = pattern.exec(markup)) !== null) {
+    const url = isCacheableMediaUrl(decodeMarkupValue(match[2]))
+    if (url) result.add(url)
+  }
+}
+
+function collectMediaUrls(source: unknown, result: Set<string>) {
+  if (typeof source === 'string') {
+    const direct = isCacheableMediaUrl(source)
+    if (direct && isUrlLike(direct)) result.add(direct)
+    collectMarkupMediaUrls(source, result)
+    try {
+      collectMediaUrls(JSON.parse(source) as unknown, result)
+    } catch {
+      // 普通文本或非 JSON markup 不需要二次解析
+    }
+    return
+  }
+  if (Array.isArray(source)) {
+    for (const item of source) collectMediaUrls(item, result)
+    return
+  }
+  if (typeof source !== 'object' || source === null) return
+
+  const record = source as Record<string, unknown>
+  const attrs = typeof record.attrs === 'object' && record.attrs !== null
+    ? record.attrs as Record<string, unknown>
+    : {}
+  if (MEDIA_TYPES.has(String(record.type ?? ''))) {
+    for (const key of ['src', 'url', 'file', 'href', 'path']) {
+      const url = isCacheableMediaUrl(attrs[key])
+      if (url) result.add(url)
+    }
+  }
+
+  for (const key of ['elements', 'children', 'content', 'data', 'html', 'message'] as const) {
+    collectMediaUrls(attrs[key] ?? record[key], result)
+  }
+}
+
 export class MediaManager {
   private mediaDir: string
   private uploadDir: string
@@ -109,6 +185,16 @@ export class MediaManager {
     this.cleanupTimer?.()
   }
 
+  async clearAll() {
+    const root = path.resolve(this.ctx.baseDir, 'data', 'chat-patch')
+    for (const dir of [this.mediaDir, this.uploadDir]) {
+      const resolved = path.resolve(dir)
+      if (resolved !== root && !resolved.startsWith(`${root}${path.sep}`)) continue
+      await fs.rm(resolved, { recursive: true, force: true })
+    }
+    this.logger.logInfo('媒体缓存目录已全部清空')
+  }
+
   async cacheUrl(url: string, channelId = ''): Promise<string | null> {
     try {
       const filePath = await this.resolveAndDownload(url, channelId)
@@ -122,6 +208,17 @@ export class MediaManager {
     }
   }
 
+  // 收到或发送消息时立即预缓存富媒体，避免等前端渲染时原 URL 已过期
+  async cacheMessageMedia(source: unknown, channelId = ''): Promise<string[]> {
+    const urls = new Set<string>()
+    collectMediaUrls(source, urls)
+    await Promise.allSettled([...urls].map((url) => this.cacheUrl(url, channelId)))
+    if (urls.size) {
+      this.logger.logInfo('消息媒体已预缓存:', urls.size, '个 URL')
+    }
+    return [...urls]
+  }
+
   private async resolveAndDownload(url: string, channelId: string): Promise<string | null> {
     try {
       await fs.mkdir(this.mediaDir, { recursive: true })

package/src/recorder.ts

@@ -10,9 +10,7 @@ import { PluginLogger } from './logger'
 const MESSAGE_TYPES = new Set(['message', 'message-created'])
 
 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
+  return String(value)
 }
 
 export class Recorder {
@@ -27,6 +25,12 @@ export class Recorder {
 
   start() {
     this.ctx.on('internal/session', (session: Session) => {
+      if (session.type === 'message-deleted') {
+        void this.handleMessageDeleted(session).catch((error) => {
+          this.logger.warn('处理消息撤回失败:', error)
+        })
+        return
+      }
       void this.handleSession(session)
     })
   }
@@ -41,8 +45,8 @@ export class Recorder {
 
   private async handleSession(session: Session) {
     const platform = session.platform || 'unknown'
-    if (this.isBlocked(platform)) return
     if (!MESSAGE_TYPES.has(session.type)) return
+    if (this.isBlocked(platform)) return
 
     const event = session.toJSON()
     const message = event.message
@@ -65,15 +69,35 @@ export class Recorder {
 
     try {
       await this.database.appendMessage(record)
-      void this.cacheMessageContacts(event).catch((error) => {
-        this.logger.warn('缓存消息联系人失败:', error)
-      })
-      void this.cacheMessageMedia(event).catch((error) => {
-        this.logger.warn('异步缓存消息媒体失败:', error)
-      })
     } catch (error) {
       this.logger.warn('写入历史消息失败:', error)
     }
+    void this.cacheMessageContacts(event).catch((error) => {
+      this.logger.warn('缓存消息联系人失败:', error)
+    })
+    void this.cacheMessageMedia(event).catch((error) => {
+      this.logger.warn('异步缓存消息媒体失败:', error)
+    })
+  }
+
+  private async handleMessageDeleted(session: Session) {
+    const platform = session.platform || 'unknown'
+    if (this.isBlocked(platform)) return
+    const event = session.toJSON()
+    const rawMessage = typeof event.message === 'object' && event.message !== null
+      ? event.message as Record<string, unknown>
+      : {}
+    const messageId = session.messageId || String(rawMessage.id ?? '')
+    const channelId = String(
+      event.channel?.id
+      || event.guild?.id
+      || session.channelId
+      || '',
+    )
+    if (!messageId || !channelId) return
+    const patch = { revoked: true, revokedAt: Date.now() }
+    await this.database.updateMessageRevoked(platform, session.selfId, channelId, messageId, patch)
+    await this.database.updateSelfMessageByMessageId(platform, session.selfId, channelId, messageId, patch)
   }
 
   private async cacheMessageContacts(event: ReturnType<Session['toJSON']>) {
@@ -89,7 +113,6 @@ export class Recorder {
     const channelType = String(channel?.type ?? '')
     const isPrivateChannel = channelType === '1'
       || ['direct', 'private'].includes(channelType.toLowerCase())
-      || (!channelType && /^private:/i.test(channelId))
     const groupId = guildId || (isPrivateChannel ? '' : normalizeGroupId(channelId)) || ''
     const userName = user?.name || user?.nick || member?.nick || member?.name || ''
     const userAvatar = user?.avatar || member?.avatar || ''
@@ -151,25 +174,11 @@ export class Recorder {
   }
 
   private async cacheMessageMedia(event: ReturnType<Session['toJSON']>) {
-    const elements = Array.isArray(event.message?.elements) ? event.message.elements : []
     const channelId = String(
       event.channel?.id
       || event.guild?.id
       || '',
     )
-    const urls: string[] = []
-    const collect = (list: unknown[]) => {
-      for (const raw of list) {
-        const element = typeof raw === 'object' && raw !== null ? raw as Record<string, unknown> : {}
-        const attrs = typeof element.attrs === 'object' && element.attrs !== null ? element.attrs as Record<string, unknown> : {}
-        if (['img', 'image', 'mface', 'audio', 'video', 'file'].includes(String(element.type))) {
-          const url = String(attrs.src ?? attrs.url ?? attrs.file ?? '')
-          if (url) urls.push(url)
-        }
-        if (Array.isArray(element.children)) collect(element.children)
-      }
-    }
-    collect(elements)
-    await Promise.allSettled(urls.map((url) => this.media.cacheUrl(url, channelId)))
+    await this.media.cacheMessageMedia(event.message, channelId)
   }
 }