@xyit/wellspring 0.0.0-stage → 1.1.0

package/src/plugin/paths.ts

@@ -0,0 +1,19 @@
+/*
+ * 插件目录与命名规则。
+ */
+
+import { join } from "node:path"
+
+import { getPaths, type ResolvedPaths } from "../platform/path.ts"
+
+/** 插件目录名/包名：字母数字开头，允许 . _ -，最长 64 */
+export const PLUGIN_NAME = /^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$/
+
+/** 插件根目录：<dataDir>/plugins */
+export function pluginsRoot(paths: ResolvedPaths = getPaths()): string {
+    return join(paths.dataDir, "plugins")
+}
+
+export function isValidPluginName(name: string): boolean {
+    return PLUGIN_NAME.test(name)
+}

package/src/plugin/registry.ts

@@ -0,0 +1,103 @@
+/*
+ * 插件命令注册表。
+ * 内置命令保留，插件命令挂在顶级；重名拒绝，别名同样参与冲突检查。
+ */
+
+import type { PluginCommand } from "../api/host/plugin.ts"
+
+/** 内置命令名，插件不可占用 */
+export const RESERVED_COMMANDS: ReadonlySet<string> = new Set([
+    "chat",
+    "run",
+    "session",
+    "config",
+    "plugin",
+    "doctor",
+    "version",
+    "help",
+])
+
+const COMMAND_NAME = /^[a-z][a-z0-9-]*$/
+
+export interface RegisteredPluginCommand {
+    readonly pluginName: string
+    readonly command: PluginCommand
+}
+
+export class PluginRegistry {
+    readonly #reserved: ReadonlySet<string>
+    readonly #commands = new Map<string, RegisteredPluginCommand>()
+    readonly #aliases = new Map<string, RegisteredPluginCommand>()
+    readonly #pluginNames = new Set<string>()
+
+    constructor(reserved: ReadonlySet<string> = RESERVED_COMMANDS) {
+        this.#reserved = reserved
+    }
+
+    /** 注册插件命令；非法、保留名或重名时抛错 */
+    register(pluginName: string, command: PluginCommand): void {
+        if (
+            !COMMAND_NAME.test(command.name) ||
+            command.name.length < 2 ||
+            command.name.length > 32
+        ) {
+            throw new Error(`插件命令名不合法：${command.name}`)
+        }
+        if (this.#reserved.has(command.name)) {
+            throw new Error(`插件不能覆盖内置命令：${command.name}`)
+        }
+        if (this.#commands.has(command.name) || this.#aliases.has(command.name)) {
+            throw new Error(`插件命令重名：${command.name}`)
+        }
+        if (typeof command.summary !== "string" || command.summary.trim() === "") {
+            throw new Error(`插件命令缺少 summary：${command.name}`)
+        }
+        if (typeof command.run !== "function") {
+            throw new Error(`插件命令缺少 run：${command.name}`)
+        }
+
+        const record: RegisteredPluginCommand = { pluginName, command }
+        this.#commands.set(command.name, record)
+        this.#pluginNames.add(pluginName)
+
+        for (const alias of command.aliases ?? []) {
+            if (!COMMAND_NAME.test(alias) || alias.length < 2 || alias.length > 32) {
+                throw new Error(`插件命令别名不合法：${alias}`)
+            }
+            if (
+                this.#reserved.has(alias) ||
+                this.#commands.has(alias) ||
+                this.#aliases.has(alias)
+            ) {
+                throw new Error(`插件命令别名冲突：${alias}`)
+            }
+            this.#aliases.set(alias, record)
+        }
+    }
+
+    resolve(name: string): RegisteredPluginCommand | undefined {
+        return this.#commands.get(name) ?? this.#aliases.get(name)
+    }
+
+    list(): readonly RegisteredPluginCommand[] {
+        return [...this.#commands.values()]
+    }
+
+    removePlugin(pluginName: string): void {
+        for (const [name, record] of this.#commands) {
+            if (record.pluginName === pluginName) {
+                this.#commands.delete(name)
+            }
+        }
+        for (const [alias, record] of this.#aliases) {
+            if (record.pluginName === pluginName) {
+                this.#aliases.delete(alias)
+            }
+        }
+        this.#pluginNames.delete(pluginName)
+    }
+
+    pluginNames(): readonly string[] {
+        return [...this.#pluginNames]
+    }
+}

package/src/plugin/runtime.ts

@@ -0,0 +1,57 @@
+/*
+ * 插件运行时目录：
+ * - 数据：<dataDir>/plugin-data/<id>/
+ * - 配置：<configDir>/plugins/<id>.json（插件自己的 JSON 配置）
+ */
+
+import { join } from "node:path"
+
+import type { PluginConfig } from "../api/host/plugin.ts"
+import { ensureDir, readJsonIfExists } from "../platform/file.ts"
+import { getPaths, type ResolvedPaths } from "../platform/path.ts"
+import { PLUGIN_NAME } from "./paths.ts"
+
+// eslint-disable-next-line no-control-regex
+const CONTROL_CHARS = /[\u0000-\u001f\u007f]/
+
+function assertPluginId(id: string): void {
+    if (!PLUGIN_NAME.test(id) || CONTROL_CHARS.test(id)) {
+        throw new Error(`插件 id 不合法：${id}`)
+    }
+}
+
+/** 插件专属数据目录，平台会确保存在 */
+export function pluginDataDir(id: string, paths: ResolvedPaths = getPaths()): string {
+    assertPluginId(id)
+    return join(paths.dataDir, "plugin-data", id)
+}
+
+/** 插件专属配置文件 */
+export function pluginConfigFile(id: string, paths: ResolvedPaths = getPaths()): string {
+    assertPluginId(id)
+    return join(paths.configDir, "plugins", `${id}.json`)
+}
+
+export async function ensurePluginDataDir(
+    id: string,
+    paths: ResolvedPaths = getPaths(),
+): Promise<string> {
+    const dir = pluginDataDir(id, paths)
+    await ensureDir(dir)
+    return dir
+}
+
+/** 读取插件配置；文件不存在时返回空对象 */
+export async function loadPluginConfig(
+    id: string,
+    paths: ResolvedPaths = getPaths(),
+): Promise<PluginConfig> {
+    const value = await readJsonIfExists<unknown>(pluginConfigFile(id, paths))
+    if (value === null) {
+        return {}
+    }
+    if (typeof value !== "object" || value === null || Array.isArray(value)) {
+        throw new Error(`插件配置必须是 JSON 对象：${pluginConfigFile(id, paths)}`)
+    }
+    return value as Record<string, unknown>
+}

package/src/plugin/scaffold.ts

@@ -0,0 +1,158 @@
+/*
+ * 插件脚手架：生成可加载的最小插件目录。
+ */
+
+import { join, resolve } from "node:path"
+
+import {
+    ensureDir,
+    removePath,
+    statIfExists,
+    writeJsonAtomic,
+    writeTextAtomic,
+} from "../platform/file.ts"
+import { PLUGIN_NAME } from "./paths.ts"
+
+export interface ScaffoldPluginOptions {
+    readonly name: string
+    /** 生成到哪个父目录，默认当前工作目录 */
+    readonly parentDir?: string
+    readonly force?: boolean
+}
+
+export interface ScaffoldPluginResult {
+    readonly dir: string
+    readonly commandName: string
+}
+
+/** 插件名 → 合法命令名；名字不适用时回落到 hello */
+export function commandNameOf(pluginName: string): string {
+    let slug = pluginName
+        .toLowerCase()
+        .replace(/[^a-z0-9-]+/g, "-")
+        .replace(/-+/g, "-")
+        .replace(/^-+|-+$/g, "")
+    if (!/^[a-z][a-z0-9-]*$/.test(slug) || slug.length < 2) {
+        slug = "hello"
+    }
+    return slug.slice(0, 32).replace(/-+$/, "")
+}
+
+function template(pluginName: string, commandName: string): string {
+    return [
+        'import { onMessage, onInit, onShutdown } from "wellspring/api/host/index.ts"',
+        'import type { WellspringPlugin } from "wellspring/api/host/index.ts"',
+        "",
+        "// 钩子可以放在模块顶层；平台在 import 时会把它们归属到当前插件",
+        "onMessage(({ phase, prompt }) => {",
+        '    if (phase === "before") prompt.push("你是一个运行在 Wellspring 里的助手")',
+        "})",
+        "",
+        "export function setup() {",
+        "    onInit(() => {",
+        "        // wellspring start 时触发",
+        "    })",
+        "    onShutdown(() => {",
+        "        // wellspring start 关闭时触发",
+        "    })",
+        "",
+        "    const plugin = {",
+        `        id: ${JSON.stringify(pluginName)},`,
+        `        name: ${JSON.stringify(pluginName)},`,
+        '        version: "0.1.0",',
+        '        status: "ok",',
+        "        deps: [],",
+        "        commands: [",
+        "            {",
+        `                name: ${JSON.stringify(commandName)},`,
+        `                summary: ${JSON.stringify(`${pluginName} 示例命令`)},`,
+        "                run: (ctx) => {",
+        '                    ctx.output.info("argv=" + ctx.argv.join(","))',
+        "                    return 0",
+        "                },",
+        "            },",
+        "        ],",
+        "    } satisfies WellspringPlugin",
+        "",
+        "    return plugin",
+        "}",
+        "",
+    ].join("\n")
+}
+
+function readmeTemplate(pluginName: string, commandName: string): string {
+    return [
+        `# ${pluginName}`,
+        "",
+        "## 开发",
+        "",
+        "编辑器 / tsc 解析 `wellspring/api/host/index.ts` 需要先把 Wellspring 链接进来：",
+        "",
+        "```bash",
+        "pnpm link /path/to/Wellspring",
+        "pnpm add -D typescript @types/node   # 如果还没有",
+        "pnpm exec tsc --noEmit",
+        "```",
+        "",
+        "运行时不需要链接：通过 `wellspring plugin link <this-dir>` 加载时，平台会解析宿主 API。",
+        "",
+        "## 依赖",
+        "",
+        "`package.json` 的 `packageManager` 声明插件使用哪个包管理器（`npm@11.20.0`、`pnpm@10` 等）。",
+        "安装 zip 或目录时，有 `dependencies` 会按这个声明自动安装；没有声明时按 lockfile 推断。",
+        "",
+        "## 加载",
+        "",
+        "```bash",
+        `wellspring plugin link \"$PWD\"`,
+        "wellspring plugin list",
+        `wellspring ${commandName}`,
+        "```",
+        "",
+    ].join("\n")
+}
+
+export async function scaffoldPlugin(
+    options: ScaffoldPluginOptions,
+): Promise<ScaffoldPluginResult> {
+    const name = options.name.trim()
+    if (!PLUGIN_NAME.test(name)) {
+        throw new Error(`插件名不合法：${name}`)
+    }
+    const parentDir = resolve(options.parentDir ?? process.cwd())
+    const dir = join(parentDir, name)
+    const existing = await statIfExists(dir)
+    if (existing !== null) {
+        if (options.force !== true) {
+            throw new Error(`目录已存在：${dir}`)
+        }
+        await removePath(dir)
+    }
+    await ensureDir(dir)
+
+    const commandName = commandNameOf(name)
+    await writeJsonAtomic(join(dir, "package.json"), {
+        name,
+        version: "0.1.0",
+        packageManager: "npm@11.20.0",
+        type: "module",
+        main: "index.ts",
+        wellspring: { apiVersion: 1 },
+    })
+    await writeTextAtomic(join(dir, "index.ts"), template(name, commandName))
+    await writeJsonAtomic(join(dir, "tsconfig.json"), {
+        compilerOptions: {
+            target: "ES2024",
+            module: "NodeNext",
+            moduleResolution: "NodeNext",
+            strict: true,
+            noEmit: true,
+            allowImportingTsExtensions: true,
+            skipLibCheck: true,
+            types: ["node"],
+        },
+        include: ["index.ts"],
+    })
+    await writeTextAtomic(join(dir, "README.md"), readmeTemplate(name, commandName))
+    return { dir, commandName }
+}

package/src/plugin/state.ts

@@ -0,0 +1,52 @@
+/*
+ * 插件启用状态：<dataDir>/plugins-state.json。
+ * 以插件目录名为 key，禁用后 loader 不再 import 该插件。
+ */
+
+import { join } from "node:path"
+
+import { readJsonIfExists, writeJsonAtomic } from "../platform/file.ts"
+import { getPaths, type ResolvedPaths } from "../platform/path.ts"
+
+interface PluginStateFile {
+    readonly version?: number
+    readonly disabled?: readonly string[]
+}
+
+export function pluginStateFile(paths: ResolvedPaths = getPaths()): string {
+    return join(paths.dataDir, "plugins-state.json")
+}
+
+/** 读取被禁用的插件目录名集合 */
+export async function readPluginState(
+    paths: ResolvedPaths = getPaths(),
+): Promise<ReadonlySet<string>> {
+    const value = await readJsonIfExists<PluginStateFile>(pluginStateFile(paths))
+    if (value === null || !Array.isArray(value.disabled)) {
+        return new Set()
+    }
+    return new Set(value.disabled.filter((item): item is string => typeof item === "string"))
+}
+
+/** 设置插件启用/禁用，返回是否发生变化 */
+export async function setPluginEnabled(
+    name: string,
+    enabled: boolean,
+    paths: ResolvedPaths = getPaths(),
+): Promise<boolean> {
+    const disabled = new Set(await readPluginState(paths))
+    const had = disabled.has(name)
+    if (enabled) {
+        disabled.delete(name)
+    } else {
+        disabled.add(name)
+    }
+    if (had === !enabled) {
+        return false
+    }
+    await writeJsonAtomic(pluginStateFile(paths), {
+        version: 1,
+        disabled: [...disabled].sort(),
+    })
+    return true
+}

package/src/plugin/zip.ts

@@ -0,0 +1,156 @@
+/*
+ * 最小 ZIP 读取器，只服务本地插件安装。
+ * 支持 store/deflate 两种压缩方式，拒绝加密、ZIP64、符号链接与路径穿越。
+ */
+
+import { inflateRawSync } from "node:zlib"
+
+import { ensureDir, writeBytesAtomic } from "../platform/file.ts"
+import { dirname, resolve, sep } from "node:path"
+
+const EOCD_SIGNATURE = 0x06054b50
+const CENTRAL_SIGNATURE = 0x02014b50
+const LOCAL_SIGNATURE = 0x04034b50
+const MAX_ENTRIES = 10_000
+const MAX_ENTRY_BYTES = 100 * 1024 * 1024
+const MAX_TOTAL_BYTES = 200 * 1024 * 1024
+
+export interface ZipEntry {
+    readonly name: string
+    readonly data: Buffer
+}
+
+function fail(message: string): never {
+    throw new Error(`zip 包非法：${message}`)
+}
+
+function validateName(name: string): void {
+    if (name === "" || name.startsWith("/") || name.includes("\\") || /^[A-Za-z]:/.test(name)) {
+        fail(`非法路径：${name}`)
+    }
+    for (const segment of name.split("/")) {
+        if (segment === ".." || segment === ".") {
+            fail(`非法路径：${name}`)
+        }
+    }
+}
+
+function findEocd(buffer: Buffer): number {
+    const minimum = Math.max(0, buffer.length - 65_557)
+    for (let offset = buffer.length - 22; offset >= minimum; offset -= 1) {
+        if (buffer.readUInt32LE(offset) === EOCD_SIGNATURE) {
+            return offset
+        }
+    }
+    return fail("找不到中央目录")
+}
+
+export function readZip(buffer: Buffer): ZipEntry[] {
+    if (buffer.length < 22) {
+        fail("文件过短")
+    }
+    const eocd = findEocd(buffer)
+    const entries = buffer.readUInt16LE(eocd + 10)
+    const centralOffset = buffer.readUInt32LE(eocd + 16)
+    if (entries > MAX_ENTRIES) {
+        fail("文件条目过多")
+    }
+    if (centralOffset === 0xffffffff) {
+        fail("不支持 ZIP64")
+    }
+
+    const result: ZipEntry[] = []
+    let total = 0
+    let offset = centralOffset
+
+    for (let index = 0; index < entries; index += 1) {
+        if (offset + 46 > buffer.length || buffer.readUInt32LE(offset) !== CENTRAL_SIGNATURE) {
+            fail("中央目录损坏")
+        }
+        const flags = buffer.readUInt16LE(offset + 8)
+        const method = buffer.readUInt16LE(offset + 10)
+        const compressedSize = buffer.readUInt32LE(offset + 20)
+        const uncompressedSize = buffer.readUInt32LE(offset + 24)
+        const nameLength = buffer.readUInt16LE(offset + 28)
+        const extraLength = buffer.readUInt16LE(offset + 30)
+        const commentLength = buffer.readUInt16LE(offset + 32)
+        const externalAttributes = buffer.readUInt32LE(offset + 38)
+        const localOffset = buffer.readUInt32LE(offset + 42)
+        const name = buffer.subarray(offset + 46, offset + 46 + nameLength).toString("utf8")
+        offset += 46 + nameLength + extraLength + commentLength
+
+        validateName(name)
+        if ((flags & 0x1) !== 0) {
+            fail(`不支持加密条目：${name}`)
+        }
+        if (compressedSize === 0xffffffff || uncompressedSize === 0xffffffff) {
+            fail("不支持 ZIP64 条目")
+        }
+        if (uncompressedSize > MAX_ENTRY_BYTES) {
+            fail(`单文件过大：${name}`)
+        }
+        total += uncompressedSize
+        if (total > MAX_TOTAL_BYTES) {
+            fail("解压后总大小超限")
+        }
+
+        if (name.endsWith("/")) {
+            result.push({ name, data: Buffer.alloc(0) })
+            continue
+        }
+        if (((externalAttributes >>> 16) & 0o170000) === 0o120000) {
+            fail(`不支持符号链接：${name}`)
+        }
+        if (
+            localOffset + 30 > buffer.length ||
+            buffer.readUInt32LE(localOffset) !== LOCAL_SIGNATURE
+        ) {
+            fail(`本地文件头损坏：${name}`)
+        }
+        const localNameLength = buffer.readUInt16LE(localOffset + 26)
+        const localExtraLength = buffer.readUInt16LE(localOffset + 28)
+        const dataStart = localOffset + 30 + localNameLength + localExtraLength
+        const end = dataStart + compressedSize
+        if (end > buffer.length) {
+            fail(`数据越界：${name}`)
+        }
+        const compressed = buffer.subarray(dataStart, end)
+
+        let data: Buffer
+        if (method === 0) {
+            data = Buffer.from(compressed)
+        } else if (method === 8) {
+            try {
+                data = inflateRawSync(compressed)
+            } catch (error) {
+                fail(
+                    `解压失败：${name}（${error instanceof Error ? error.message : String(error)}）`,
+                )
+            }
+        } else {
+            fail(`不支持的压缩方式 ${method}：${name}`)
+        }
+        if (data.length !== uncompressedSize) {
+            fail(`解压大小不符：${name}`)
+        }
+        result.push({ name, data })
+    }
+    return result
+}
+
+/** 解压到目标目录；调用方负责临时目录与清理 */
+export async function extractZip(buffer: Buffer, destination: string): Promise<void> {
+    const root = resolve(destination)
+    for (const entry of readZip(buffer)) {
+        const target = resolve(root, entry.name)
+        if (target !== root && !target.startsWith(`${root}${sep}`)) {
+            fail(`路径穿越：${entry.name}`)
+        }
+        if (entry.name.endsWith("/")) {
+            await ensureDir(target)
+            continue
+        }
+        await ensureDir(dirname(target))
+        await writeBytesAtomic(target, entry.data)
+    }
+}

package/src/sandbox/audit.ts

@@ -0,0 +1,38 @@
+/*
+ * sandbox 审计日志：<logDir>/sandbox-audit.log，JSONL。
+ */
+
+import { appendFile } from "node:fs/promises"
+import { dirname, join } from "node:path"
+
+import { ensureDir } from "../platform/file.ts"
+import type { ResolvedPaths } from "../platform/path.ts"
+
+export interface SandboxAuditEvent {
+    readonly type: string
+    readonly sandboxId: string
+    readonly pluginId?: string
+    readonly backend?: string
+    readonly decision?: "allowed" | "denied"
+    readonly reason?: string
+    readonly [key: string]: unknown
+}
+
+let queue: Promise<void> = Promise.resolve()
+
+export function auditSandbox(paths: ResolvedPaths, event: SandboxAuditEvent): void {
+    const file = join(paths.logDir, "sandbox-audit.log")
+    queue = queue
+        .then(async () => {
+            await ensureDir(dirname(file))
+            await appendFile(
+                file,
+                `${JSON.stringify({ time: new Date().toISOString(), ...event })}\n`,
+            )
+        })
+        .catch(() => undefined)
+}
+
+export async function flushSandboxAudit(): Promise<void> {
+    await queue
+}