koishi-plugin-kkk 1.0.0

package/src/compat/sqlite3.ts

@@ -0,0 +1,123 @@
+/**
+ * `node-karin/sqlite3` 的兼容实现：基于 Node 内置的 node:sqlite。
+ *
+ * 原插件按 node-sqlite3 的回调风格调用：`db.run(sql, params, cb)`、
+ * `db.get/all(sql, params, cb)`，回调里还有 `this.lastID` / `this.changes`，这里逐条对齐。
+ */
+import fs from 'node:fs'
+import path from 'node:path'
+import { DatabaseSync } from 'node:sqlite'
+
+type Callback = (err: Error | null, row?: any) => void
+
+interface RunContext {
+  lastID: number
+  changes: number
+}
+
+class CompatDatabase {
+  private db: DatabaseSync
+  private readonly filename: string
+
+  constructor (filename: string, callback?: (err: Error | null) => void) {
+    this.filename = filename
+    try {
+      fs.mkdirSync(path.dirname(filename), { recursive: true })
+      // node:sqlite 默认开启外键校验（enableForeignKeyConstraints: true），
+      // 而 node-sqlite3 默认关闭；上游表结构的外键（GroupUserSubscriptions.groupId → Groups.id）
+      // 在开启校验时会直接报 "foreign key mismatch"，因此这里显式关掉，与 Karin 版行为一致。
+      this.db = new DatabaseSync(filename, { enableForeignKeyConstraints: false })
+      this.db.exec('PRAGMA journal_mode = WAL')
+      callback?.(null)
+    } catch (error) {
+      callback?.(error as Error)
+      throw error
+    }
+  }
+
+  private normalize (params: any[]): any[] {
+    return (params ?? []).map((item) => {
+      if (item === undefined) return null
+      if (typeof item === 'boolean') return item ? 1 : 0
+      return item as any
+    })
+  }
+
+  run (sql: string, params?: any[] | Callback, callback?: Callback) {
+    const cb = typeof params === 'function' ? params : callback
+    const args = Array.isArray(params) ? params : []
+    try {
+      const stmt = this.db.prepare(sql)
+      const result = stmt.run(...this.normalize(args))
+      const ctx: RunContext = { lastID: Number(result.lastInsertRowid ?? 0), changes: Number(result.changes ?? 0) }
+      cb?.call(ctx, null)
+      return ctx
+    } catch (error) {
+      cb?.call({ lastID: 0, changes: 0 }, error as Error)
+      return { lastID: 0, changes: 0 }
+    }
+  }
+
+  get (sql: string, params?: any[] | Callback, callback?: Callback) {
+    const cb = typeof params === 'function' ? params : callback
+    const args = Array.isArray(params) ? params : []
+    try {
+      const row = this.db.prepare(sql).get(...this.normalize(args))
+      cb?.(null, row)
+      return row
+    } catch (error) {
+      cb?.(error as Error)
+      return undefined
+    }
+  }
+
+  all (sql: string, params?: any[] | Callback, callback?: Callback) {
+    const cb = typeof params === 'function' ? params : callback
+    const args = Array.isArray(params) ? params : []
+    try {
+      const rows = this.db.prepare(sql).all(...this.normalize(args))
+      cb?.(null, rows)
+      return rows
+    } catch (error) {
+      cb?.(error as Error)
+      return []
+    }
+  }
+
+  exec (sql: string, callback?: Callback) {
+    try {
+      this.db.exec(sql)
+      callback?.(null)
+    } catch (error) {
+      callback?.(error as Error)
+    }
+  }
+
+  close (callback?: (err: Error | null) => void) {
+    try {
+      this.db.close()
+      callback?.(null)
+    } catch (error) {
+      callback?.(error as Error)
+    }
+  }
+
+  serialize (callback?: () => void) {
+    callback?.()
+  }
+
+  get path () {
+    return this.filename
+  }
+}
+
+export const sqlite3 = {
+  Database: CompatDatabase,
+  verbose () {
+    return sqlite3
+  }
+}
+
+export default sqlite3
+export type Sqlite3Compat = typeof sqlite3
+export const Database = CompatDatabase

package/src/compat/start.ts

@@ -0,0 +1,3 @@
+/** `node-karin/start` 的兼容实现：Koishi 下由宿主进程负责启动，这里不做任何事 */
+export const start = async () => undefined
+export default start

package/src/compat/syncConfig.ts

@@ -0,0 +1,64 @@
+/**
+ * 把「插件自己写进 config.json 的配置」反向同步到 Koishi 侧配置（koishi.yml）。
+ *
+ * kkk 有两套配置：
+ *   - Koishi 控制台改的 `upstream` 字段 → 启动时由 configBridge 合并进
+ *     `<数据目录>/koishi-plugin-kkk/config/config.json`（单向）
+ *   - 插件运行时读写的是 config.json 本身
+ *
+ * 所以扫码登录这类「插件主动写入」的值（例如 B站 Cookie）在控制台里永远看不到，
+ * 必须回写一次 koishi.yml，控制台表单才会显示真实取值。
+ */
+import { logger } from './logger'
+import { tryGetRuntime } from './runtime'
+
+const isPlainObject = (value: unknown): value is Record<string, any> =>
+  !!value && typeof value === 'object' && !Array.isArray(value)
+
+/** 深合并：纯对象递归，其余（含数组）整体替换 */
+function deepMerge<T extends Record<string, any>> (target: T, patch: Record<string, any>): T {
+  const result: Record<string, any> = { ...target }
+  for (const [key, value] of Object.entries(patch)) {
+    if (value === undefined) continue
+    if (isPlainObject(value) && isPlainObject(result[key])) {
+      result[key] = deepMerge(result[key], value)
+    } else {
+      result[key] = value
+    }
+  }
+  return result as T
+}
+
+/**
+ * 把一段配置合并进插件在 koishi.yml 里的 `upstream` 字段。
+ * @param patch 要同步的内容，例如 `{ amagi: { cookies: { bilibili: 'SESSDATA=...' } } }`
+ * @returns 是否同步成功（没有 scope / 写失败时返回 false，调用方降级即可）
+ */
+/** 日志本身也可能不可用（例如兼容层还没绑定 ctx），这里绝不能因为它再抛一次 */
+const warn = (message: string) => {
+  try {
+    logger.warn(message)
+  } catch {
+    /* 忽略：同步失败本身不应该影响登录流程 */
+  }
+}
+
+export async function syncUpstreamToKoishi (patch: Record<string, any>): Promise<boolean> {
+  try {
+    const ctx: any = tryGetRuntime()?.ctx
+    const scope = ctx?.scope
+    if (!scope || typeof scope.update !== 'function') {
+      warn('[kkk] 当前环境不支持回写控制台配置（ctx.scope.update 不存在）')
+      return false
+    }
+    const current: Record<string, any> = isPlainObject(scope.config) ? scope.config : {}
+    const upstream = deepMerge(isPlainObject(current.upstream) ? current.upstream : {}, patch)
+    await scope.update({ ...current, upstream })
+    return true
+  } catch (error: any) {
+    warn('[kkk] 回写控制台配置失败: ' + (error?.message ?? error))
+    return false
+  }
+}
+
+export { deepMerge }

package/src/compat/template-react.ts

@@ -0,0 +1,54 @@
+/**
+ * `@karinjs/template-react` 的最小兼容实现（Koishi 迁移补充）。
+ *
+ * 上游模板通过 ktr 约定注册：`export default defineTemplate({ name, description, component, validate })`，
+ * 由 ktr 的构建产物（SSR 外壳）负责按路由装配与渲染。
+ * 这里不需要 ktr 的构建管线，只要把注册对象原样返回，渲染由 `module/utils/Render` 直接做 React SSR。
+ */
+
+/** 模板上下文（ktr 的 RenderContext 子集，模板只读这几个字段） */
+export interface RenderContext {
+  /** 渲染缩放，由外壳施加到 #container */
+  scale?: number
+  /** 主题，明暗只走 theme.mode */
+  theme?: { mode?: 'light' | 'dark' }
+  /** 版本信息，模板页脚展示 */
+  version?: {
+    plugin?: string
+    pluginName?: string
+    pluginVersion?: string
+    releaseType?: string
+    poweredBy?: string
+    frameworkVersion?: string
+    hasUpdate?: boolean
+  }
+  /** 封面氛围背景参数 */
+  ambientCover?: Record<string, unknown>
+  [key: string]: unknown
+}
+
+export interface TemplateDefinition<T = any> {
+  name?: string
+  description?: string
+  component: (props: any) => any
+  validate?: (data: unknown) => data is T
+  [key: string]: unknown
+}
+
+/** 模板注册：原样返回即可 */
+export function defineTemplate<T = any> (options: TemplateDefinition<T>): TemplateDefinition<T> {
+  return options
+}
+
+/** ktr 里负责拼 HTML 外壳的类，这里仅保留类型占位（预览工具用到） */
+export class HtmlWrapper {
+  constructor (public options?: Record<string, unknown>) {}
+  loadInlineCss (_path: string): string { return '' }
+}
+
+/** ktr 里解析模板样式的辅助函数 */
+export function resolveTemplateStyle (options?: Record<string, unknown>): string {
+  return String((options as any)?.cssPath ?? '')
+}
+
+export default { defineTemplate, HtmlWrapper, resolveTemplateStyle }

package/src/compat/text.ts

@@ -0,0 +1,58 @@
+/**
+ * 消息文本归一化（QQ 平台分享卡片）。
+ *
+ * QQ 官方适配器（koishi-plugin-adapter-qq-crack，platform=\`qqguild\`）解码消息时是
+ * \`message.elements = [h.text(data.content)]\` —— 不做卡片解析，把原始内容整段当文本塞进来。
+ * 于是分享卡片/小程序消息在插件眼里是这样一串：
+ *
+ * \`\`\`text
+ * {"app":"com.tencent.structmsg","meta":{"detail_1":{"qqdocurl":"https:\\/\\/v.douyin.com\\/xxxx\\/"}}}
+ * \`\`\`
+ *
+ * 注意 URL 里的斜杠是 **JSON 转义过的** \`\\/\`，直接拿 \`https?:\\/\\/\` 去匹配当然匹配不到；
+ * 这正是「QQ 卡片解析不了」的原因。这里做两件事：
+ *   1. 还原 JSON 转义（\`\\/\` → \`/\`、\`\\u0026\` → \`&\`、\`\\"\` → \`"\`）；
+ *   2. 把从卡片里挖出来的 URL **追加到文本末尾**，让各平台解析命令的正则能照常命中 ——
+ *      命令本身仍按前缀匹配，不受影响。
+ */
+
+/** 从任意文本里收集 http(s) 链接（会先还原 JSON 转义） */
+export function extractUrls (input: string): string[] {
+  if (!input || !input.includes('http')) return []
+  const unescaped = unescapeJsonText(input)
+  const matched = unescaped.match(/https?:\/\/[^\s"'<>\\\]\[}{]+/gi) ?? []
+  const result: string[] = []
+  for (const raw of matched) {
+    // 去掉 JSON 里常见的尾随符号
+    const url = raw.replace(/[),.;:'"]+$/, '')
+    if (!result.includes(url)) result.push(url)
+  }
+  return result
+}
+
+/** 还原 JSON 字符串里的转义（只处理会影响 URL 识别的几种） */
+export function unescapeJsonText (input: string): string {
+  if (!input || !input.includes('\\')) return input
+  return input
+    .replace(/\\u002[fF]/g, '/')
+    .replace(/\\\//g, '/')
+    .replace(/\\"/g, '"')
+    .replace(/\\u0026/gi, '&')
+}
+
+/**
+ * 归一化一段消息文本：卡片消息会额外附带「从中提取出的链接」。
+ * 普通文本原样返回（不改变已有行为）。
+ */
+export function normalizeMessageText (content: string): string {
+  const text = (content ?? '').trim()
+  if (!text) return ''
+  // 纯文本、里面没有 JSON 转义/花括号时不必处理
+  if (!text.includes('\\') && !text.includes('{')) return text
+  const urls = extractUrls(text)
+  if (!urls.length) return unescapeJsonText(text)
+  const missing = urls.filter((url) => !text.includes(url))
+  return missing.length ? text + ' ' + missing.join(' ') : text
+}
+
+export default normalizeMessageText

package/src/compat/yaml.ts

@@ -0,0 +1,6 @@
+/** `node-karin/yaml` 的兼容实现：复用工作区已有的 js-yaml */
+import yaml from 'js-yaml'
+
+export const parse = (text: string) => yaml.load(text)
+export const stringify = (value: any) => yaml.dump(value)
+export default { parse, stringify }

package/src/configBridge.ts

@@ -0,0 +1,94 @@
+/**
+ * 控制台表单 → 插件 config.json 的落地。
+ *
+ * 用户在 Koishi 控制台改的是 koishi.yml 里的 \`upstream\` 字段，插件真正读取的却是
+ * \`<数据目录>/koishi-plugin-kkk/config/config.json\`（上游 Config 服务的路径）。
+ * 因此 apply 阶段、**在加载上游 apps 之前**把表单里显式填过的值深合并进那个文件：
+ *   - 空数组 / 空对象算没填（Koishi 会给 Schema.array()/object() 补空值）；
+ *   - **与上游默认值相同的也算没填**：Schema 现在带 default()（控制台里能看到真实取值），
+ *     Koishi 会把整份默认值一并填进配置对象，若照单全收，用户直接改 config.json 的内容
+ *     会在下次启动时被表单里的默认值覆盖；
+ *   - 数组整体覆盖（pushlist 这类结构化数据按整块替换更可预期）。
+ *
+ * 代价：在控制台里把某项**改回默认值**不会写回 config.json（与默认值相同 = 视为没动过）。
+ * 真要强制改回去，用插件自带面板 /kkk 或直接编辑那个文件。
+ */
+import fs from 'node:fs'
+import path from 'node:path'
+
+import { PLUGIN_DIR_NAME, getRuntime } from './compat/runtime'
+
+export interface MergeResult {
+  /** 被改写的字段路径，形如 \`douyin.videoQuality\` */
+  changed: string[]
+  /** 实际写入的配置文件路径 */
+  file: string
+}
+
+const isPlainObject = (value: unknown): value is Record<string, unknown> =>
+  !!value && typeof value === 'object' && !Array.isArray(value)
+
+/**
+ * 把控制台里的上游配置合并进 config.json。
+ * @param overrides 控制台里 \`upstream\` 字段的内容
+ */
+export function applyUpstreamOverrides (overrides: unknown): MergeResult {
+  const runtime = getRuntime()
+  const file = path.resolve(runtime.dataRoot, PLUGIN_DIR_NAME, 'config', 'config.json')
+  const defaultFile = path.resolve(runtime.pluginRoot, 'config', 'default_config', 'config.json')
+
+  /** 上游默认配置：用来把「控制台里的默认值」和「用户真的改过」区分开 */
+  let defaults: Record<string, unknown> = {}
+  try {
+    if (fs.existsSync(defaultFile)) defaults = JSON.parse(fs.readFileSync(defaultFile, 'utf8'))
+  } catch {
+    defaults = {}
+  }
+
+  let current: Record<string, unknown> = {}
+  try {
+    if (fs.existsSync(file)) current = JSON.parse(fs.readFileSync(file, 'utf8'))
+    else current = defaults
+  } catch {
+    current = {}
+  }
+
+  if (!isPlainObject(overrides)) return { changed: [], file }
+
+  const changed: string[] = []
+  /**
+   * 「没填」的判定：undefined 之外，**空数组/空对象也算没填**。
+   * 原因是 Koishi 解析配置时会给 Schema.array()/Schema.object() 补上空值，
+   * 于是控制台里没碰过的 sendContent / pushlist 会以 `[]` 的形式传进来；
+   * 若照单全收就会把用户在 config.json 里配好的内容清空。
+   * 代价：想「清空某个列表」请用 /kkk 面板或直接改文件（已在 usage / README 说明）。
+   */
+  const isEmptyContainer = (value: unknown) =>
+    Array.isArray(value) ? value.length === 0 : isPlainObject(value) && Object.keys(value).length === 0
+
+  const merge = (target: Record<string, any>, source: Record<string, unknown>, baseline: Record<string, unknown>, prefix: string) => {
+    for (const [key, value] of Object.entries(source)) {
+      if (value === undefined || isEmptyContainer(value)) continue
+      const base = isPlainObject(baseline) ? baseline[key] : undefined
+      if (isPlainObject(value)) {
+        if (!isPlainObject(target[key])) target[key] = {}
+        merge(target[key], value, isPlainObject(base) ? base : {}, prefix + key + '.')
+        continue
+      }
+      // 与上游默认值相同 → 控制台里没动过这一项，不写回（否则会盖掉用户手改的文件）
+      if (base !== undefined && JSON.stringify(base) === JSON.stringify(value)) continue
+      if (JSON.stringify(target[key]) === JSON.stringify(value)) continue
+      target[key] = value
+      changed.push(prefix + key)
+    }
+  }
+  merge(current, overrides, defaults, '')
+
+  if (changed.length) {
+    fs.mkdirSync(path.dirname(file), { recursive: true })
+    fs.writeFileSync(file, JSON.stringify(current, null, 2), 'utf8')
+  }
+  return { changed, file }
+}
+
+export default applyUpstreamOverrides