@lf_maple/koishi-plugin-phi-plugin-full 0.1.80

package/core/model/render/puppeteer.js

@@ -0,0 +1,431 @@
+import childProcess from "node:child_process"
+import path from "node:path"
+import { pathToFileURL } from "node:url"
+import puppeteer from "puppeteer"
+import timers from "node:timers/promises"
+import fs from "node:fs/promises"
+import { tempPath } from "../filesystem/path.js"
+import logger from "../../components/Logger.js"
+import platform from "../../components/platform/index.js"
+
+const Renderer = platform.RendererBase
+const botConfig = platform.getBotConfig()
+
+/** @typedef {import('puppeteer').Browser} Browser */
+/** @typedef {import('puppeteer').Page} Page */
+/** @typedef {Record<string, any> & {tplFile?: string, saveId?: string, imgType?: 'jpeg'|'png'|'webp', quality?: number, omitBackground?: boolean, path?: string, multiPage?: boolean, multiPageHeight?: number, pageGotoParams?: Record<string, any>, isRenderTimeout?: boolean}} ScreenshotData */
+
+/**
+ * 渲染器实例对外暴露的公共接口（供 picmodle 等消费方做类型推断）
+ * @typedef {object} PhiRenderer
+ * @property {string} browserId 实例编号
+ * @property {(name: string, data?: any) => Promise<any>} screenshot 截图，返回 Buffer / Buffer[] / false
+ * @property {() => Promise<any>} browserInit 初始化 / 启动浏览器
+ * @property {(force?: boolean) => Promise<any>} restart 重启浏览器
+ * @property {() => Promise<void>} shutdown 永久关闭实例
+ * @property {() => void} forceShutdown 退出阶段同步结束进程树
+ */
+
+/**
+ * 插件独立 Puppeteer 渲染器。
+ *
+ * 不复用宿主渲染器，也不连接外部 WS。每个实例独立启动 Chromium、独立 profile，
+ * 避免和 Bot 主渲染器或其他插件互相抢占 / 关闭浏览器。
+ *
+ * @type {new (config?: any, browserId?: string) => PhiRenderer}
+ */
+class Puppeteer extends Renderer {
+    /**
+     * @param {any} config
+     * @param {string} browserId 实例编号
+     */
+    constructor(config = {}, browserId = "0") {
+        super({
+            id: `phi-puppeteer-${browserId}`,
+            type: "image",
+            render: "screenshot",
+        })
+        this.browserId = browserId
+        this.browser = /** @type {Browser | false} */ (false)
+        this.browserPid = null
+        this.initPromise = /** @type {Promise<Browser | false> | null} */ (null)
+        this.closing = false
+        this.closingPid = null
+        this.shutdownRequested = false
+        /** @type {string[]} */
+        this.shoting = []
+        /** 截图数达到时重启浏览器 避免生成速度越来越慢 */
+        this.restartNum = config.restartNum || 100
+        /** 截图次数 */
+        this.renderNum = 0
+        /** 空闲多久(ms)后自动关闭浏览器释放资源，0 为不关闭 */
+        this.idleTimeout = config.idleTimeout ?? botConfig?.puppeteer_idle ?? 1800000
+        /** 空闲定时器 */
+        this.idleTimer = /** @type {NodeJS.Timeout | null} */ (null)
+        /** 关闭浏览器的超时时间(ms)，超时则强制结束进程 */
+        this.closeTimeout = config.closeTimeout || 8000
+        /** @type {any} */
+        this.config = {
+            userDataDir: path.resolve(tempPath, "puppeteer", browserId),
+            headless: config.headless || "new",
+            args: config.args || ["--disable-gpu", "--disable-setuid-sandbox", "--no-sandbox", "--no-zygote"],
+            handleSIGINT: false,
+            handleSIGTERM: false,
+            handleSIGHUP: false,
+        }
+        if (config.chromiumPath || botConfig?.chromium_path) {
+            this.config.executablePath = config.chromiumPath || botConfig?.chromium_path
+        }
+        /** puppeteer截图超时时间 */
+        this.puppeteerTimeout = config.puppeteerTimeout || botConfig?.puppeteer_timeout || 0
+        this.pageGotoParams = config.pageGotoParams || {
+            timeout: 120000,
+            waitUntil: ["networkidle0", "load", "domcontentloaded"],
+        }
+    }
+
+    /**
+     * 初始化chromium。并发调用会等待同一个启动 Promise，避免首帧撞上启动锁直接失败。
+     * @returns {Promise<Browser | false>}
+     */
+    async browserInit() {
+        if (this.shutdownRequested) return false
+        if (this.browser) return this.browser
+        if (this.initPromise) return this.initPromise
+
+        this.initPromise = this.launchBrowser().finally(() => {
+            this.initPromise = null
+        })
+        return this.initPromise
+    }
+
+    /** @returns {Promise<Browser | false>} */
+    async launchBrowser() {
+        logger.info(`[phi-plugin] puppeteer Chromium(${this.browserId}) 启动中...`)
+
+        const launched = await puppeteer.launch(this.config).catch(async (/** @type {any} */ err) => {
+            const errMsg = String(err)
+            logger.error(err)
+            if (errMsg.includes("Could not find Chromium")) {
+                logger.error("没有正确安装 Chromium，可以尝试执行安装命令：node node_modules/puppeteer/install.js")
+            } else if (errMsg.includes("cannot open shared object file")) {
+                logger.error("没有正确安装 Chromium 运行库")
+            } else if (errMsg.includes(this.config.userDataDir)) {
+                logger.warn(`[phi-plugin] puppeteer profile 被占用，清理后重试：${this.config.userDataDir}`)
+                await fs.rm(this.config.userDataDir, { force: true, recursive: true }).catch(() => { })
+                return puppeteer.launch(this.config).catch(retryErr => {
+                    logger.error(retryErr)
+                    return false
+                })
+            }
+            return false
+        })
+        const browser = /** @type {Browser | false} */ (launched)
+
+        if (!browser) {
+            logger.error(`[phi-plugin] puppeteer Chromium(${this.browserId}) 启动失败`)
+            return false
+        }
+
+        if (this.shutdownRequested) {
+            await this.stop(browser, browser.process()?.pid)
+            return false
+        }
+
+        this.browser = browser
+        this.browserPid = browser.process()?.pid
+        logger.info(`[phi-plugin] puppeteer Chromium(${this.browserId}) 启动成功 ${browser.wsEndpoint()}`)
+
+        browser.once("disconnected", () => this.onDisconnected(browser))
+        return browser
+    }
+
+    /** 浏览器意外断开处理，主动关闭时不做任何动作 */
+    /** @param {Browser} browser */
+    onDisconnected(browser) {
+        if (this.closing || this.browser !== browser) return
+        logger.warn(`[phi-plugin] puppeteer Chromium(${this.browserId}) 连接已断开，将在下次渲染时重新启动`)
+        this.browser = false
+        this.browserPid = null
+        this.clearIdleTimer()
+    }
+
+    /**
+     * `chromium` 截图
+     * @param {string} name
+     * @param {ScreenshotData} data 模板参数
+     * @return img 不做segment包裹
+     */
+    async screenshot(name, data = {}) {
+        this.clearIdleTimer()
+        if (!(await this.browserInit())) return false
+
+        data.saveId = `${data.saveId || name.split("/").pop()}_${this.browserId}`
+        const resolvedPath = (/** @type {any} */ (this.dealTpl))(name, data)
+        if (!resolvedPath) return false
+        const savePath = String(resolvedPath)
+
+        const jobName = `${name}#${Date.now()}`
+        this.shoting.push(jobName)
+        const start = Date.now()
+        /** @type {Page | undefined} */
+        let page
+
+        try {
+            const renderPromise = (async () => {
+                const browser = this.browser
+                if (!browser) throw new Error('浏览器未启动')
+                page = await browser.newPage()
+                return this.renderPage(page, name, savePath, data, start)
+            })()
+            const ret = await this.withTimeout(renderPromise, this.puppeteerTimeout, async () => {
+                logger.error(`[图片生成][${name}] 截图超时，当前等待队列：${this.shoting.join(",")}`)
+                await this.restart(true)
+            })
+
+            this.removeJob(jobName)
+
+            if (ret.length === 0 || !ret[0]) {
+                logger.error(`[图片生成][${name}] 图片生成为空`)
+                return false
+            }
+
+            await this.restart()
+            this.resetIdleTimer()
+            return data.multiPage ? ret : ret[0]
+        } catch (/** @type {any} */ err) {
+            logger.error(`[图片生成][${name}] 图片生成失败`, err)
+            if (!err?.isRenderTimeout) await this.restart(true)
+            return false
+        } finally {
+            this.removeJob(jobName)
+            if (page && !page.isClosed()) {
+                await page.close().catch((/** @type {any} */ err) => logger.error(err))
+            }
+        }
+    }
+
+    /** @param {string} jobName */
+    removeJob(jobName) {
+        const idx = this.shoting.indexOf(jobName)
+        if (idx >= 0) this.shoting.splice(idx, 1)
+    }
+
+    /** @param {Page} page @param {string} name @param {string} savePath @param {ScreenshotData} data @param {number} start */
+    async renderPage(page, name, savePath, data, start) {
+        const pageHeight = Math.max(1, Number(data.multiPageHeight) || 4000)
+        const pageGotoParams = { ...this.pageGotoParams, ...(data.pageGotoParams || {}) }
+        await page.goto(pathToFileURL(path.resolve(savePath)).href, pageGotoParams)
+
+        const body = (await page.$("#container")) || (await page.$("body"))
+        if (!body) throw new Error("未找到可截图的页面节点")
+
+        const boundingBox = await body.boundingBox()
+        if (!boundingBox || boundingBox.width <= 0 || boundingBox.height <= 0) {
+            throw new Error("页面尺寸为空，无法截图")
+        }
+
+        /** @type {any} */
+        const screenshotOptions = {
+            type: data.imgType || "jpeg",
+            omitBackground: data.omitBackground || false,
+            quality: data.quality || 90,
+        }
+        if (data.path) screenshotOptions.path = data.path
+        if (data.multiPage) screenshotOptions.type = "jpeg"
+        if (screenshotOptions.type === "png") delete screenshotOptions.quality
+
+        if (!data.multiPage) {
+            const buff = await this.toBuffer(body.screenshot(screenshotOptions))
+            this.renderNum++
+            const kb = (buff.length / 1024).toFixed(2) + "KB"
+            logger.mark(`[图片生成][${name}][${this.renderNum}次] ${kb} ${logger.green(`${Date.now() - start}ms`)}`)
+            return [buff]
+        }
+
+        const totalHeight = Math.ceil(boundingBox.height)
+        const viewportWidth = Math.max(1, Math.ceil(boundingBox.width))
+        const num = Math.max(1, Math.ceil(totalHeight / pageHeight))
+        const ret = []
+
+        if (num > 1) {
+            await page.setViewport({
+                width: viewportWidth,
+                height: Math.min(pageHeight, totalHeight) + 100,
+            })
+        }
+
+        for (let i = 0; i < num; i++) {
+            const remainHeight = totalHeight - pageHeight * i
+            const currentHeight = Math.max(1, Math.min(pageHeight, remainHeight))
+            if (num > 1) {
+                await page.setViewport({
+                    width: viewportWidth,
+                    height: currentHeight + (i === num - 1 ? 0 : 100),
+                })
+                await page.evaluate(`window.scrollTo(0, ${pageHeight * i})`)
+            }
+
+            const buff = await this.toBuffer(num === 1 ? body.screenshot(screenshotOptions) : page.screenshot(screenshotOptions))
+            if (num > 2) await timers.setTimeout(200)
+            this.renderNum++
+
+            const kb = (buff.length / 1024).toFixed(2) + "KB"
+            logger.mark(`[图片生成][${name}][${i + 1}/${num}] ${kb}`)
+            ret.push(buff)
+        }
+
+        if (num > 1) logger.mark(`[图片生成][${name}] 处理完成`)
+        return ret
+    }
+
+    /** @param {Promise<Uint8Array | Buffer | string>} promise */
+    async toBuffer(promise) {
+        const buff = await promise
+        return Buffer.isBuffer(buff) ? buff : Buffer.from(buff)
+    }
+
+    /** @template T @param {Promise<T>} promise @param {number} timeout @param {() => Promise<void>} onTimeout @returns {Promise<T>} */
+    async withTimeout(promise, timeout, onTimeout) {
+        if (!(timeout > 0)) return promise
+
+        let timeoutId
+        const timeoutPromise = new Promise((_, reject) => {
+            timeoutId = setTimeout(async () => {
+                try {
+                    await onTimeout()
+                } catch (err) {
+                    logger.error(err)
+                }
+                const err = Object.assign(new Error(`截图超时(${timeout}ms)`), { isRenderTimeout: true })
+                reject(err)
+            }, timeout)
+            timeoutId.unref?.()
+        })
+
+        try {
+            return await Promise.race([promise, timeoutPromise])
+        } finally {
+            clearTimeout(timeoutId)
+        }
+    }
+
+    /** 重启 */
+    async restart(force = false) {
+        if (this.shutdownRequested) return false
+        if (!this.browser) return false
+        if (!force && (this.renderNum % this.restartNum !== 0 || this.shoting.length > 0)) return false
+
+        logger.info(`[phi-plugin] puppeteer Chromium(${this.browserId}) ${force ? "强制" : ""}关闭重启...`)
+        const browser = this.browser
+        const pid = this.browserPid
+        this.closingPid = pid
+        this.browser = false
+        this.browserPid = null
+        this.clearIdleTimer()
+        this.closing = true
+        try {
+            await this.stop(browser, pid)
+        } finally {
+            this.closingPid = null
+            this.closing = false
+        }
+        return this.browserInit()
+    }
+
+    /** 空闲定时器：长时间无渲染时关闭浏览器释放资源 */
+    resetIdleTimer() {
+        this.clearIdleTimer()
+        if (this.shutdownRequested || !(this.idleTimeout > 0)) return
+        this.idleTimer = setTimeout(() => {
+            if (this.shoting.length > 0 || !this.browser) return
+            logger.info(`[phi-plugin] puppeteer Chromium(${this.browserId}) 空闲超过 ${this.idleTimeout / 1000}s，自动关闭释放资源`)
+            this.closeBrowser()
+        }, this.idleTimeout)
+        this.idleTimer.unref?.()
+    }
+
+    clearIdleTimer() {
+        if (this.idleTimer) {
+            clearTimeout(this.idleTimer)
+            this.idleTimer = null
+        }
+    }
+
+    /** 主动关闭浏览器且不重启，下次渲染时按需重新启动 */
+    async closeBrowser() {
+        if (!this.browser) return
+        this.clearIdleTimer()
+        const browser = this.browser
+        const pid = this.browserPid
+        this.closingPid = pid
+        this.browser = false
+        this.browserPid = null
+        this.closing = true
+        try {
+            await this.stop(browser, pid)
+        } finally {
+            this.closingPid = null
+            this.closing = false
+        }
+    }
+
+    /** 永久关闭实例；退出清理后不允许再次拉起 Chromium。 */
+    async shutdown() {
+        this.shutdownRequested = true
+        this.clearIdleTimer()
+        if (this.initPromise) {
+            await this.initPromise.catch(() => false)
+        }
+        await this.closeBrowser()
+    }
+
+    /** 退出事件中只能做同步操作，按最后记录的 PID 强制结束进程树。 */
+    forceShutdown() {
+        this.shutdownRequested = true
+        this.clearIdleTimer()
+        const pid = this.browserPid || this.closingPid || (this.browser ? this.browser.process()?.pid : undefined)
+        this.browser = false
+        this.browserPid = null
+        this.closingPid = null
+        this.killProcess(pid)
+    }
+
+    /**
+     * 关闭浏览器实例，close 超时则按 PID 强制结束进程树，杜绝孤儿/僵尸进程
+     * @param browser 浏览器实例
+     * @param pid 浏览器主进程 PID，缺省时取 browser.process()
+     */
+    /** @param {Browser} browser @param {number | null | undefined} pid */
+    async stop(browser, pid) {
+        if (!browser) return
+        pid = pid ?? browser.process()?.pid
+        try {
+            await Promise.race([
+                browser.close(),
+                timers.setTimeout(this.closeTimeout).then(() => Promise.reject(new Error("close 超时"))),
+            ])
+        } catch (err) {
+            logger.error(`[phi-plugin] puppeteer Chromium(${this.browserId}) 正常关闭失败，尝试强制结束进程(${pid})`, err)
+            this.killProcess(pid)
+        }
+    }
+
+    /** 按 PID 强杀进程树（含子渲染进程） */
+    /** @param {number | null | undefined} pid */
+    killProcess(pid) {
+        if (!pid) return
+        try {
+            if (process.platform === "win32") {
+                childProcess.execFileSync("taskkill", ["/pid", `${pid}`, "/T", "/F"], { stdio: "ignore" })
+            } else {
+                process.kill(pid, "SIGKILL")
+            }
+            logger.mark(`[phi-plugin] puppeteer Chromium(${this.browserId}) 进程 ${pid} 已强制结束`)
+        } catch (/** @type {any} */ err) {
+            logger.debug(`[phi-plugin] puppeteer Chromium(${this.browserId}) 进程 ${pid} 结束失败（可能已退出）：${err.message || err}`)
+        }
+    }
+}
+
+export default Puppeteer

package/core/model/render/renderPressureHistory.js

@@ -0,0 +1,71 @@
+const MINUTE_MS = 60_000
+const HISTORY_WINDOW_MS = 30 * MINUTE_MS
+
+/**
+ * 保存最近 30 分钟的绘图压力分钟桶。
+ * 同一分钟内发生重连或手动同步时合并窗口，避免重复上报。
+ */
+export class RenderPressureHistory {
+    constructor() {
+        /** @type {Array<{
+         *  startedAt: string, endedAt: string, capacity: number, active: number, queued: number,
+         *  maxActive: number, maxQueued: number, completed: number, failed: number, timedOut: number
+         * }>} */
+        this.samples = []
+    }
+
+    /**
+     * @param {{
+     *  windowStartedAt: string, capacity: number, active: number, queued: number,
+     *  maxActive: number, maxQueued: number, completed: number, failed: number, timedOut: number
+     * }} snapshot
+     * @param {string} [endedAt]
+     */
+    record(snapshot, endedAt = new Date().toISOString()) {
+        const endedMs = Date.parse(endedAt)
+        if (!Number.isFinite(endedMs)) return this.snapshot()
+
+        const minute = Math.floor(endedMs / MINUTE_MS)
+        const previous = this.samples.find(sample => Math.floor(Date.parse(sample.endedAt) / MINUTE_MS) === minute)
+        if (previous) {
+            previous.startedAt = Date.parse(snapshot.windowStartedAt) < Date.parse(previous.startedAt)
+                ? snapshot.windowStartedAt
+                : previous.startedAt
+            previous.endedAt = endedAt
+            previous.capacity = snapshot.capacity
+            previous.active = snapshot.active
+            previous.queued = snapshot.queued
+            previous.maxActive = Math.max(previous.maxActive, snapshot.maxActive, snapshot.active)
+            previous.maxQueued = Math.max(previous.maxQueued, snapshot.maxQueued, snapshot.queued)
+            previous.completed += snapshot.completed
+            previous.failed += snapshot.failed
+            previous.timedOut += snapshot.timedOut
+        } else {
+            this.samples.push({
+                startedAt: snapshot.windowStartedAt,
+                endedAt,
+                capacity: snapshot.capacity,
+                active: snapshot.active,
+                queued: snapshot.queued,
+                maxActive: Math.max(snapshot.maxActive, snapshot.active),
+                maxQueued: Math.max(snapshot.maxQueued, snapshot.queued),
+                completed: snapshot.completed,
+                failed: snapshot.failed,
+                timedOut: snapshot.timedOut,
+            })
+        }
+
+        const cutoff = endedMs - HISTORY_WINDOW_MS
+        this.samples = this.samples
+            .filter(sample => Date.parse(sample.endedAt) > cutoff && Date.parse(sample.endedAt) <= endedMs)
+            .sort((a, b) => Date.parse(a.endedAt) - Date.parse(b.endedAt))
+            .slice(-30)
+        return this.snapshot()
+    }
+
+    snapshot() {
+        return this.samples.map(sample => ({ ...sample }))
+    }
+}
+
+export default RenderPressureHistory

package/core/model/render/send.js

@@ -0,0 +1,94 @@
+import Config from '../../components/Config.js'
+import { UserCredentials } from '../user/userCredentials.js';
+import Save from "../save/Save.js";
+import logger from "../../components/Logger.js";
+import { canUseApi } from '../user/apiPermission.js';
+import platform from "../../components/platform/index.js";
+
+class send {
+
+    /**
+     * 普通回复，统一经过平台接口。
+     * @param {*} e
+     * @param {*} msg
+     * @param {boolean} [quote=false]
+     * @param {{}} [data={}]
+     */
+    static async reply(e, msg, quote = false, data = {}) {
+        e = platform.wrapEvent(e)
+        return platform.reply(e, msg, { quote, ...data })
+    }
+
+    /**
+     * 私聊省略@
+     * @param {*} e 
+     * @param {*} msg 
+     * @param {boolean} [quote=false] 是否引用回复
+     * @param {{}} [data={}] recallMsg等
+     */
+    static async send_with_At(e, msg, quote = false, data = {}) {
+        e = platform.wrapEvent(e)
+        return platform.sendWithAt(e, msg, quote, data)
+    }
+
+    /**
+     * 检查存档部分
+     * @param {*} e 
+     * @param {Number} [ver] 存档版本
+     * @param {boolean} [send=true] 是否发送提示
+     * @returns {Promise<Save|false>} 存档对象或false
+     */
+    static async getsave_result(e, ver = undefined, send = true) {
+
+        let user_save = null
+        const credentials = UserCredentials.fromEvent(e)
+        let sessionToken = await credentials.getSessionToken()
+        const allowApi = await canUseApi(e)
+        if (allowApi) {
+            try {
+                user_save = await credentials.getUpdatedSaveFromApi()
+                if (user_save) return user_save.save
+            } catch (/**@type {any} */ err) {
+                logger.warn(`[phi-plugin] getUpdatedSaveFromApi `, err)
+            }
+        }
+
+        if (!sessionToken) {
+            if (send) {
+                this.send_with_At(e, `请先绑定sessionToken哦！如果不知道自己的sessionToken可以尝试扫码绑定嗷！\n帮助：/${Config.getUserCfg('config', 'cmdhead')} tk help\n获取二维码：/${Config.getUserCfg('config', 'cmdhead')} bind qrcode\n普通绑定：/${Config.getUserCfg('config', 'cmdhead')} bind <sessionToken>`)
+            }
+            return false
+        }
+
+        user_save = (await credentials.getUpdatedSaveFromLocal(sessionToken))?.save
+
+
+        if (!user_save || (ver && (!user_save.Recordver || user_save.Recordver < ver))) {
+            if (send) {
+                this.send_with_At(e, `请先更新数据哦！\n格式：/${Config.getUserCfg('config', 'cmdhead')} update`)
+            }
+            return false
+        }
+
+        return user_save
+    }
+
+    /**
+     * 转发到私聊
+     * @param {any} e 消息数组e
+     * @param {any} msg 发送内容
+     */
+    static async pick_send(e, msg) {
+        try {
+            e = platform.wrapEvent(e)
+            await platform.sendPrivate(e, msg)
+            await platform.sleep(500)
+        } catch (err) {
+            logger.error(err)
+            this.send_with_At(e, `转发失败QAQ！请尝试在私聊触发命令！`)
+        }
+    }
+
+}
+
+export default send