@fengye_nobug/dsh-qq-bot 0.0.0-stage → 0.2.4

package/stickers.js

@@ -0,0 +1,237 @@
+// stickers.js — 表情包登记表：纯函数 + 文件读写，导出以便测试。
+//
+// 登记表把“群里出现过的一张图”变成可复用的资产：
+//   * 图片本体复制到 `qq-bridge-stickers/<hash>.<ext>`；
+//   * 元数据（mood / description / 来源 / 发送次数）写在 `qq-bridge-stickers.json`。
+//   * 商城表情另外带一份 mface（emoji_id / emoji_package_id / key / summary）。
+//     四字段齐全时出站发 OneBot mface；缺了就仍发图片。
+//
+// hash 取图片字节 sha256 的**前 16 位十六进制**（小写）—— 与 `qq-bridge-images/` 的文件名同构，
+// 因此登记的图能直接命中宿主的图片描述缓存（省一次多模态调用）。
+//
+// 本文件不依赖 index.js，也不碰任何宿主服务：读不到、坏了都返回空表，绝不抛。
+
+import { createHash } from 'node:crypto'
+import { copyFileSync, existsSync, mkdirSync, readFileSync, renameSync, writeFileSync } from 'node:fs'
+import { basename, dirname, extname, join } from 'node:path'
+
+/** 登记表的文件名（放在 statePath 同一个目录）。 */
+export const STICKERS_FILE = 'qq-bridge-stickers.json'
+/** 图片本体目录名（同样放在 statePath 同一个目录）。 */
+export const STICKERS_DIR = 'qq-bridge-stickers'
+/** hash 位数（sha256 十六进制的前 16 位）。 */
+export const HASH_LEN = 16
+/** 短哈希位数（正文占位符与工具里显示的是它）。 */
+export const SHORT_HASH_LEN = 6
+
+/**
+ * 把入站段或登记项上的商城表情字段收成一份干净对象。
+ * 只有 summary（普通图片也会带简介）不算商城表情，返回 null。
+ * `emoji_package_id` 收成非负整数；带不来的字段直接不写。
+ */
+export function normalizeMface(raw) {
+  if (!raw || typeof raw !== 'object' || Array.isArray(raw)) return null
+  const emojiId = String(raw.emoji_id ?? raw.emojiId ?? '').trim()
+  const key = String(raw.key ?? '').trim()
+  const summary = String(raw.summary ?? '').trim()
+  const pkg = packageIdOf(raw.emoji_package_id ?? raw.emojiPackageId)
+  if (emojiId === '' && key === '' && pkg === undefined) return null
+  const out = {}
+  if (emojiId !== '') out.emoji_id = emojiId
+  if (pkg !== undefined) out.emoji_package_id = pkg
+  if (key !== '') out.key = key
+  if (summary !== '') out.summary = summary
+  return out
+}
+
+/** 非负安全整数。数字或纯数字字符串都可以，别的（含小数）丢掉。 */
+function packageIdOf(value) {
+  if (typeof value === 'number') {
+    if (Number.isInteger(value) && value >= 0 && Number.isSafeInteger(value)) return value
+    return undefined
+  }
+  const text = String(value ?? '').trim()
+  if (!/^[0-9]+$/.test(text)) return undefined
+  const n = Number(text)
+  if (!Number.isSafeInteger(n)) return undefined
+  return n
+}
+
+/** 四字段都在，才能发 OneBot mface。缺任何一个就当普通图片。 */
+export function isCompleteMface(raw) {
+  const m = normalizeMface(raw)
+  return Boolean(m && m.emoji_id && m.key && m.summary && Number.isInteger(m.emoji_package_id))
+}
+
+/**
+ * 登记项 → 出站 mface 的 data。不齐就返回 null，调用方改发图片。
+ * `emoji_package_id` 是数字，跟 NapCat 当前的消息段定义一致。
+ */
+export function mfaceSendData(entry) {
+  const m = normalizeMface(entry?.mface)
+  if (!isCompleteMface(m)) return null
+  return {
+    emoji_package_id: m.emoji_package_id,
+    emoji_id: m.emoji_id,
+    key: m.key,
+    summary: m.summary,
+  }
+}
+
+/** 发给模型看的种类：四字段齐全是 mface，否则是 image。 */
+export function stickerKind(entry) {
+  return isCompleteMface(entry?.mface) ? 'mface' : 'image'
+}
+
+/** 图片字节 → 16 位小写十六进制 hash。 */
+export function hashOfBuffer(buffer) {
+  return createHash('sha256').update(buffer).digest('hex').slice(0, HASH_LEN)
+}
+
+/** 长哈希 → 短哈希。传进来空值时返回空串（调用方据此退回不带 hash 的占位符）。 */
+export function shortHash(hash) {
+  return String(hash ?? '')
+    .trim()
+    .toLowerCase()
+    .slice(0, SHORT_HASH_LEN)
+}
+
+/** 空登记表。 */
+export function emptyStore() {
+  return { version: 1, stickers: {} }
+}
+
+/** 把任意输入收敛成 `{ version: 1, stickers }`，坏结构当空表。 */
+function normalizeStore(data) {
+  if (!data || typeof data !== 'object') return emptyStore()
+  const stickers =
+    data.stickers && typeof data.stickers === 'object' && !Array.isArray(data.stickers) ? data.stickers : {}
+  return { version: 1, stickers }
+}
+
+/** 读登记表。文件不存在、不是 JSON、结构不对 → 返回空表，绝不抛。 */
+export function loadStickers(path) {
+  try {
+    return normalizeStore(JSON.parse(readFileSync(path, 'utf8')))
+  } catch {
+    return emptyStore()
+  }
+}
+
+/** 原子写：先写 `*.tmp` 再 rename。失败返回 false，绝不抛。 */
+export function saveStickers(path, data) {
+  try {
+    mkdirSync(dirname(path), { recursive: true })
+    const tmp = `${path}.tmp`
+    writeFileSync(tmp, `${JSON.stringify(normalizeStore(data), null, 2)}\n`, 'utf8')
+    renameSync(tmp, path)
+    return true
+  } catch {
+    return false
+  }
+}
+
+/**
+ * 登记或更新一条（按 hash 合并）。
+ *
+ * 没有显式给值时保留旧的 `addedAt` / `sentCount` / `lastSentAt`：
+ * 重存同一张图只该换 mood 与描述，不该把累计发送次数清零。
+ */
+export function upsertSticker(store, entry) {
+  // 就地改传进来的那个对象：调用方（宿主半）把它当“内存里的登记表”持有，
+  // 拿一份新对象回写会让它悄悄丢失这次登记。
+  const s = store && typeof store === 'object' ? store : emptyStore()
+  if (!s.stickers || typeof s.stickers !== 'object' || Array.isArray(s.stickers)) s.stickers = {}
+  s.version = 1
+  const hash = String(entry?.hash ?? '')
+    .trim()
+    .toLowerCase()
+  if (hash === '') return null
+  const prev = s.stickers[hash] && typeof s.stickers[hash] === 'object' ? s.stickers[hash] : {}
+  const next = { ...prev, ...entry, hash }
+  if (entry?.addedAt === undefined && prev.addedAt !== undefined) next.addedAt = prev.addedAt
+  if (entry?.sentCount === undefined && prev.sentCount !== undefined) next.sentCount = prev.sentCount
+  if (entry?.lastSentAt === undefined && prev.lastSentAt !== undefined) next.lastSentAt = prev.lastSentAt
+  s.stickers[hash] = next
+  return next
+}
+
+/** 列出登记项（可只列某个 mood）。按登记时间**从新到旧**排序，`limit` 为 0 时返回空数组。 */
+export function listStickers(store, { mood, limit } = {}) {
+  const s = normalizeStore(store)
+  const m = String(mood ?? '').trim()
+  let items = Object.values(s.stickers).filter((e) => e && typeof e === 'object')
+  if (m !== '') items = items.filter((e) => String(e.mood ?? '') === m)
+  items.sort((a, b) => Number(b.addedAt ?? 0) - Number(a.addedAt ?? 0))
+  const n = Number(limit)
+  return Number.isFinite(n) && n >= 0 ? items.slice(0, n) : items
+}
+
+/**
+ * 查一条。`hash` 可以是短哈希或全哈希（按前缀匹配）；只给 `mood` 时返回该情绪里最近登记的一条。
+ * 查不到返回 null。
+ */
+export function findSticker(store, { hash, mood } = {}) {
+  const s = normalizeStore(store)
+  const want = String(hash ?? '')
+    .trim()
+    .toLowerCase()
+  if (want !== '') {
+    if (s.stickers[want]) return s.stickers[want]
+    for (const [h, e] of Object.entries(s.stickers)) {
+      if (h.toLowerCase().startsWith(want)) return e
+    }
+    return null
+  }
+  const m = String(mood ?? '').trim()
+  if (m === '') return null
+  return listStickers(s, { mood: m, limit: 1 })[0] ?? null
+}
+
+/**
+ * 把一张本地图片收进登记表：算 hash → 按需复制进 destDir → 登记并返回条目。
+ *
+ * 源文件读不到时**抛错**（由调用方翻成一句给模型看的提示）。落盘由调用方负责
+ * （宿主半统一 `saveStickers`），这样本函数保持“输入进、条目出”的纯形状。
+ * `mface` 可选：有商城表情字段就合并进条目；这次没给就留着上次的。
+ */
+export function importSticker({ store, srcPath, destDir, mood, description, source, mface }) {
+  const data = readFileSync(srcPath)
+  const hash = hashOfBuffer(data)
+  const rawExt = extname(String(srcPath ?? ''))
+    .replace(/^\./, '')
+    .toLowerCase()
+  const ext = rawExt === '' ? 'png' : rawExt
+  const name = `${hash}.${ext}`
+  const destPath = join(destDir, name)
+  mkdirSync(destDir, { recursive: true })
+  if (!existsSync(destPath)) copyFileSync(srcPath, destPath)
+
+  const prev = findSticker(store, { hash })
+  // 新来的字段盖住旧的；没带来的字段留着。这次没传 mface 就不写这个键，
+  // upsert 会保住登记表里已有的那份（重存普通图不该把商城表情信息抹掉）。
+  // 只带 summary 时：没有旧记录就不把普通图片简介当成商城表情；有旧记录就只改表情名。
+  let merged = null
+  if (mface !== undefined) {
+    const prevM = normalizeMface(prev?.mface) ?? {}
+    const incoming = normalizeMface(mface)
+    if (incoming) merged = { ...prevM, ...incoming }
+    else {
+      const summary = String(mface?.summary ?? '').trim()
+      if (summary !== '' && Object.keys(prevM).length > 0) merged = { ...prevM, summary }
+    }
+  }
+  const entry = {
+    hash,
+    mood: String(mood ?? '').trim(),
+    description: String(description ?? '').trim(),
+    // file 相对 statePath 所在目录 —— 宿主的出站按它读回图片本体。
+    file: `${basename(destDir)}/${name}`,
+    ext,
+    source: String(source ?? '').trim(),
+    // 新条目给全字段；已登记的图只换 mood / 描述，保留累计次数与首次登记时间。
+    ...(prev ? {} : { addedAt: Date.now(), sentCount: 0, lastSentAt: null }),
+    ...(merged ? { mface: merged } : {}),
+  }
+  return upsertSticker(store, entry)
+}

package/updates.js

@@ -0,0 +1,272 @@
+// 检查 GitHub Release 上有没有比当前包更新的正式版。
+//
+// 只比较版本、拼白话说明。不下载、不安装、不改配置。
+// 网络细节留在 checkPluginUpdate；界面和测试都吃这里的返回值。
+
+export const UPDATE_REPO = 'yunfengnobug/dsh-qq-bot'
+
+const RELEASES_PER_PAGE = 30
+
+/** @param {string} [repo] */
+export function releasesApiUrl(repo = UPDATE_REPO) {
+  return `https://api.github.com/repos/${repo}/releases?per_page=${RELEASES_PER_PAGE}`
+}
+
+/**
+ * 解析 `v1.2.3` / `1.2.3-rc.1`。对不上返回 null。
+ * @param {unknown} input
+ */
+export function parseSemver(input) {
+  const text = String(input ?? '').trim()
+  const match = text.match(/^v?(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z.-]+))?(?:\+[0-9A-Za-z.-]+)?$/)
+  if (!match) return null
+  return {
+    major: Number(match[1]),
+    minor: Number(match[2]),
+    patch: Number(match[3]),
+    pre: match[4] ? match[4].split('.').filter((part) => part !== '') : [],
+    raw: match[4] ? `${match[1]}.${match[2]}.${match[3]}-${match[4]}` : `${match[1]}.${match[2]}.${match[3]}`,
+  }
+}
+
+function compareIdentifiers(left, right) {
+  const leftNum = /^[0-9]+$/.test(left)
+  const rightNum = /^[0-9]+$/.test(right)
+  if (leftNum && rightNum) {
+    const diff = Number(left) - Number(right)
+    if (diff !== 0) return diff > 0 ? 1 : -1
+    return 0
+  }
+  if (leftNum) return -1
+  if (rightNum) return 1
+  if (left === right) return 0
+  return left > right ? 1 : -1
+}
+
+function comparePre(left, right) {
+  if (left.length === 0 && right.length === 0) return 0
+  if (left.length === 0) return 1
+  if (right.length === 0) return -1
+  const count = Math.max(left.length, right.length)
+  for (let i = 0; i < count; i++) {
+    if (left[i] === undefined) return -1
+    if (right[i] === undefined) return 1
+    const diff = compareIdentifiers(left[i], right[i])
+    if (diff !== 0) return diff
+  }
+  return 0
+}
+
+/**
+ * `a > b` 返回 1，相等返回 0，`a < b` 返回 -1。有一边解析不了返回 null。
+ * 正式版高于同号的预发布版。
+ * @param {unknown} a
+ * @param {unknown} b
+ */
+export function compareSemver(a, b) {
+  const left = typeof a === 'object' && a ? a : parseSemver(a)
+  const right = typeof b === 'object' && b ? b : parseSemver(b)
+  if (!left?.raw || !right?.raw) return null
+  if (left.major !== right.major) return left.major > right.major ? 1 : -1
+  if (left.minor !== right.minor) return left.minor > right.minor ? 1 : -1
+  if (left.patch !== right.patch) return left.patch > right.patch ? 1 : -1
+  return comparePre(left.pre ?? [], right.pre ?? [])
+}
+
+/** 安装命令里的 spec。版本号不带 v 时补上。 */
+export function installSpec(version, repo = UPDATE_REPO) {
+  const parsed = parseSemver(version)
+  const raw = parsed?.raw ?? String(version ?? '').trim().replace(/^v/i, '')
+  return `github:${repo}#v${raw}`
+}
+
+export function installCommand(version, repo = UPDATE_REPO) {
+  return `dsh plugin --profile web add ${installSpec(version, repo)}`
+}
+
+export function releasePage(tag, repo = UPDATE_REPO) {
+  const parsed = parseSemver(tag)
+  const name = parsed ? `v${parsed.raw}` : String(tag ?? '').trim()
+  return `https://github.com/${repo}/releases/tag/${name}`
+}
+
+/**
+ * Release 正文收成一两句白话。去掉围栏代码和链接，避免把整篇更新日志贴进卡片。
+ * @param {unknown} body
+ * @param {number} [maxChars]
+ */
+export function summarizeReleaseNotes(body, maxChars = 240) {
+  const lines = String(body ?? '')
+    .replace(/\r\n/g, '\n')
+    .replace(/```[\s\S]*?```/g, ' ')
+    .replace(/!\[[^\]]*]\([^)]*\)/g, ' ')
+    .replace(/\[([^\]]+)]\([^)]*\)/g, '$1')
+    .replace(/^#{1,6}\s+/gm, '')
+    .split('\n')
+    .map((line) => line.replace(/^[-*]\s+/, '').replace(/[`*_>]/g, '').trim())
+    .filter((line) => line !== '' && !/^[-—]+$/.test(line))
+  const joined = lines.slice(0, 4).join(' ')
+  if (joined.length <= maxChars) return joined
+  return `${joined.slice(0, Math.max(0, maxChars - 1)).trimEnd()}…`
+}
+
+function safeReleaseUrl(rel, tag, repo) {
+  const raw = typeof rel?.html_url === 'string' ? rel.html_url : ''
+  const prefix = `https://github.com/${repo}/`
+  if (raw.startsWith(prefix)) return raw
+  return releasePage(tag, repo)
+}
+
+/**
+ * @param {{ current: unknown, releases: unknown, repo?: string }} input
+ */
+export function assessUpdate({ current, releases, repo = UPDATE_REPO }) {
+  const parsedCurrent = parseSemver(current)
+  if (!parsedCurrent) {
+    return {
+      ok: false,
+      kind: 'bad-current',
+      current: String(current ?? ''),
+      updateAvailable: false,
+      message: '当前版本号读不出来，没法对比。',
+    }
+  }
+  const stable = []
+  for (const rel of Array.isArray(releases) ? releases : []) {
+    if (!rel || typeof rel !== 'object') continue
+    if (rel.draft === true || rel.prerelease === true) continue
+    const tag = String(rel.tag_name ?? '')
+    const parsed = parseSemver(tag)
+    if (!parsed) continue
+    stable.push({ rel, parsed, tag })
+  }
+  if (stable.length === 0) {
+    return {
+      ok: true,
+      kind: 'no-release',
+      current: parsedCurrent.raw,
+      updateAvailable: false,
+      message: 'GitHub 上还没有可用的正式版，没法对比新版本。',
+    }
+  }
+  stable.sort((left, right) => compareSemver(right.parsed, left.parsed) ?? 0)
+  const latest = stable[0]
+  const summary = summarizeReleaseNotes(latest.rel.body)
+  const spec = installSpec(latest.parsed.raw, repo)
+  const command = installCommand(latest.parsed.raw, repo)
+  const url = safeReleaseUrl(latest.rel, latest.tag, repo)
+  const compared = compareSemver(latest.parsed, parsedCurrent)
+  const base = {
+    ok: true,
+    current: parsedCurrent.raw,
+    latest: latest.parsed.raw,
+    tag: `v${latest.parsed.raw}`,
+    summary,
+    install: spec,
+    command,
+    url,
+  }
+  if (compared > 0) {
+    const lines = [`有新版本 ${latest.parsed.raw}（你现在是 ${parsedCurrent.raw}）。`]
+    if (summary) lines.push(`说明：${summary}`)
+    lines.push(`升级命令：${command}`)
+    lines.push('装完请重启 dsh-web。')
+    lines.push(`发布页：${url}`)
+    return { ...base, kind: 'update', updateAvailable: true, message: lines.join('\n') }
+  }
+  if (compared < 0) {
+    return {
+      ...base,
+      kind: 'ahead',
+      updateAvailable: false,
+      message: `你现在的 ${parsedCurrent.raw} 比 GitHub 上最新正式版 ${latest.parsed.raw} 还新，不用按 Release 往回装。`,
+    }
+  }
+  return {
+    ...base,
+    kind: 'current',
+    updateAvailable: false,
+    message: `已经是最新正式版 ${parsedCurrent.raw}，不用更新。`,
+  }
+}
+
+/**
+ * 把 GitHub / 网络失败收成一句白话。不要把英文堆栈或限流正文里的地址回给界面。
+ * @param {unknown} status
+ * @param {unknown} snippet
+ */
+export function failureMessage(status, snippet) {
+  const code = Number(status)
+  const text = String(snippet ?? '')
+  if (code === 403 || code === 429 || /rate limit/i.test(text)) {
+    return 'GitHub 限流了，等一会儿再点「检查更新」。'
+  }
+  if (code === 404) return '没有查到这个仓库的 Release。'
+  return '连不上 GitHub，这次没有检查到更新。稍后再试。'
+}
+
+async function readSnippet(response) {
+  try {
+    if (typeof response?.text === 'function') return String(await response.text()).slice(0, 500)
+  } catch {
+    // 读失败也按连不上处理，不把读取异常的英文抛出去。
+  }
+  return ''
+}
+
+/**
+ * @param {typeof fetch | undefined} fetchImpl
+ * @param {{ repo?: string, timeoutMs?: number }} [options]
+ */
+export async function queryGithubReleases(fetchImpl, options = {}) {
+  // 显式传入 null 表示「不要上网」。只有没传时才用全局 fetch。
+  const fetchFn = fetchImpl === undefined ? globalThis.fetch : fetchImpl
+  if (typeof fetchFn !== 'function') {
+    return { ok: false, error: failureMessage(0, '') }
+  }
+  const repo = options.repo || UPDATE_REPO
+  const timeoutMs = options.timeoutMs ?? 15000
+  let response
+  try {
+    response = await fetchFn(releasesApiUrl(repo), {
+      headers: {
+        accept: 'application/vnd.github+json',
+        'user-agent': 'dsh-qq-bot',
+      },
+      signal: AbortSignal.timeout(timeoutMs),
+    })
+  } catch {
+    return { ok: false, error: failureMessage(0, '') }
+  }
+  if (!response || response.ok !== true) {
+    const snippet = await readSnippet(response)
+    return { ok: false, error: failureMessage(response?.status, snippet), status: response?.status }
+  }
+  let data
+  try {
+    data = await response.json()
+  } catch {
+    return { ok: false, error: 'GitHub 返回的内容读不懂，这次没有检查到更新。' }
+  }
+  if (!Array.isArray(data)) {
+    const message = data && typeof data === 'object' ? data.message : ''
+    return { ok: false, error: failureMessage(response.status, message) }
+  }
+  return { ok: true, releases: data }
+}
+
+/**
+ * @param {{ current: unknown, fetchImpl?: typeof fetch, repo?: string }} [input]
+ */
+export async function checkPluginUpdate(input = {}) {
+  const current = input.current
+  const queried = await queryGithubReleases(input.fetchImpl, { repo: input.repo })
+  if (!queried.ok) {
+    return { ok: false, current: String(current ?? ''), error: queried.error, message: queried.error }
+  }
+  const assessed = assessUpdate({ current, releases: queried.releases, repo: input.repo })
+  if (assessed.ok === false) {
+    return { ok: false, current: assessed.current, error: assessed.message, message: assessed.message }
+  }
+  return assessed
+}