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

package/core/components/ProcessCleanup.js

@@ -0,0 +1,113 @@
+const cleanupManagerSymbol = Symbol.for('phi-plugin.processCleanupManager')
+const globalStore = /** @type {Record<symbol, any>} */ (globalThis)
+
+const signalExitCode = /** @type {Partial<Record<NodeJS.Signals, number>>} */ ({
+    SIGHUP: 129,
+    SIGINT: 130,
+    SIGTERM: 143,
+    SIGBREAK: 149,
+})
+
+export class ProcessCleanupManager {
+    /**
+     * @param {NodeJS.Process} [target]
+     * @param {number} [timeout]
+     */
+    constructor(target = process, timeout = 10000) {
+        this.target = target
+        this.timeout = timeout
+        this.cleanup = /** @type {() => Promise<unknown>} */ (async () => {})
+        this.emergencyCleanup = () => {}
+        this.installed = false
+        this.handlingSignal = false
+        /** @type {Partial<Record<NodeJS.Signals, () => void>>} */
+        this.signalHandlers = {}
+        this.exitHandler = () => {
+            try {
+                this.emergencyCleanup()
+            } catch { }
+        }
+    }
+
+    /**
+     * @param {() => Promise<unknown>} cleanup
+     * @param {() => void} emergencyCleanup
+     */
+    register(cleanup, emergencyCleanup) {
+        const oldCleanup = this.cleanup
+        this.cleanup = cleanup
+        this.emergencyCleanup = emergencyCleanup
+        if (this.installed && oldCleanup !== cleanup) {
+            void Promise.resolve().then(() => oldCleanup()).catch(() => {})
+        }
+        if (!this.installed) this.install()
+    }
+
+    install() {
+        this.installed = true
+        this.target.once('exit', this.exitHandler)
+        /** @type {NodeJS.Signals[]} */
+        const signals = ['SIGHUP', 'SIGINT', 'SIGTERM']
+        if (process.platform === 'win32') signals.push('SIGBREAK')
+        for (const signal of signals) {
+            const handler = () => { void this.handleSignal(signal, handler) }
+            this.signalHandlers[signal] = handler
+            this.target.on(signal, handler)
+        }
+    }
+
+    /**
+     * @param {NodeJS.Signals} signal
+     * @param {() => void} handler
+     */
+    async handleSignal(signal, handler) {
+        if (this.handlingSignal) return
+        this.handlingSignal = true
+        const shouldRelaySignal = this.target.listenerCount(signal) === 1
+        let timeoutId
+        try {
+            await Promise.race([
+                Promise.resolve().then(() => this.cleanup()),
+                new Promise(resolve => { timeoutId = setTimeout(resolve, this.timeout) }),
+            ])
+        } catch {
+            // The synchronous fallback below still runs when graceful cleanup fails.
+        } finally {
+            if (timeoutId) clearTimeout(timeoutId)
+            try {
+                this.emergencyCleanup()
+            } catch { }
+        }
+
+        if (!shouldRelaySignal) return
+        this.target.removeListener(signal, handler)
+        try {
+            this.target.kill(this.target.pid, signal)
+        } catch {
+            this.target.exit(signalExitCode[signal] || 1)
+        }
+    }
+
+    dispose() {
+        this.target.removeListener('exit', this.exitHandler)
+        for (const [signal, handler] of Object.entries(this.signalHandlers)) {
+            if (handler) this.target.removeListener(/** @type {NodeJS.Signals} */ (signal), handler)
+        }
+        this.signalHandlers = {}
+        this.installed = false
+    }
+}
+
+const processCleanupManager = /** @type {ProcessCleanupManager} */ (
+    globalStore[cleanupManagerSymbol] ||= new ProcessCleanupManager()
+)
+
+/**
+ * @param {() => Promise<unknown>} cleanup
+ * @param {() => void} emergencyCleanup
+ */
+export function registerProcessCleanup(cleanup, emergencyCleanup) {
+    processCleanupManager.register(cleanup, emergencyCleanup)
+}
+
+export default processCleanupManager

package/core/components/Version.js

@@ -0,0 +1,56 @@
+
+import fs from 'fs'
+import { pluginRoot } from '../model/filesystem/path.js'
+import logger from './Logger.js'
+import fileWatcherRegistry from './FileWatcherRegistry.js'
+import platform from './platform/index.js'
+const README_path = `${pluginRoot}/README.md`
+const yunzai_ver = `v${platform.getPackageVersion()}`
+
+let currentVersion = ''
+let phigrosVer = ''
+let phigrosVerNum = 0
+
+try {
+    if (fs.existsSync(README_path)) {
+        const logs = fs.readFileSync(README_path, 'utf8')
+        currentVersion = 'v' + (/插件版本\-([0-9\.]+)/.exec(logs)?.[1] ?? '')
+        phigrosVer = /Phigros\-([0-9\.]+)/.exec(logs)?.[1] ?? ''
+        phigrosVerNum = Number(/PhigrosVer\-([0-9]+)/.exec(logs)?.[1] ?? 0)
+    }
+} catch (e) {
+    logger.error(e)
+    // do nth
+}
+
+let Version = {
+    /** @type {string} 插件版本 v1.0.0 */
+    ver: currentVersion,
+    /** @type {string} Phigros版本 1.0.0 */
+    phigros: phigrosVer,
+    /** @type {number} Phigros版本号 */
+    phigrosVerNum: phigrosVerNum,
+    /** @type {string} 云崽版本 */
+    yunzai: yunzai_ver,
+};
+
+const versionWatcher = fileWatcherRegistry.watch('version:readme', README_path, () => {
+    try {
+        const logs = fs.readFileSync(README_path, 'utf8')
+        currentVersion = 'v' + (/插件版本\-([0-9\.]+)/.exec(logs)?.[1] ?? '')
+        phigrosVer = /Phigros\-([0-9\.]+)/.exec(logs)?.[1] ?? ''
+        phigrosVerNum = Number(/PhigrosVer\-([0-9]+)/.exec(logs)?.[1] ?? 0)
+        Version.ver = currentVersion
+        Version.phigros = phigrosVer
+        Version.phigrosVerNum = phigrosVerNum
+    } catch (e) {
+        logger.error(e)
+    }
+})
+
+Object.defineProperty(Version, 'close', {
+    value: () => versionWatcher.close(),
+    enumerable: false,
+})
+
+export default Version

package/core/components/YamlReader.js

@@ -0,0 +1,157 @@
+import fs from 'fs'
+import YAML from 'yaml'
+import lodash from 'lodash'
+import chokidar from 'chokidar'
+// import Constant from '../server/constant/Constant.js'
+
+const Constant = {
+    CONFIG_INTEGER_KEY: '__yaml_integer_key__',
+}
+
+export default class YamlReader {
+    /**
+     * 读写yaml文件
+     *
+     * @param {string} yamlPath yaml文件绝对路径
+     * @param {boolean} [isWatch] 是否监听文件变化
+     */
+    constructor(yamlPath, isWatch = false) {
+        this.yamlPath = yamlPath
+        this.isWatch = isWatch
+        /** @type {YAML.Document.Parsed | undefined} */
+        this.document = undefined
+        /** @type {import('chokidar').FSWatcher | undefined} */
+        this.watcher = undefined
+        this.isSave = false
+        this.initYaml()
+    }
+
+    initYaml() {
+        try {
+            // parseDocument 将会保留注释
+            this.document = YAML.parseDocument(fs.readFileSync(this.yamlPath, 'utf8'))
+        } catch (error) {
+            throw error
+        }
+        if (this.isWatch && !this.watcher) {
+            this.watcher = chokidar.watch(this.yamlPath).on('change', () => {
+                if (this.isSave) {
+                    this.isSave = false
+                    return
+                }
+                this.initYaml()
+            })
+        }
+    }
+
+    /**返回读取的对象 */
+    get jsonData() {
+        if (!this.document) {
+            return null
+        }
+        return this.document.toJSON()
+    }
+
+    /*检查集合是否包含key的值*/
+    /**
+     * @param {string} keyPath
+     */
+    has(keyPath) {
+        return this.document?.hasIn(keyPath.split('.')) ?? false
+    }
+    /*返回key的值*/
+    /**
+     * @param {string} keyPath
+     */
+    get(keyPath) {
+        return lodash.get(this.jsonData, keyPath)
+    }
+    /*修改某个key的值*/
+    /**
+     * @param {string} keyPath
+     * @param {unknown} value
+     */
+    set(keyPath, value) {
+        this.document?.setIn(keyPath.split('.'), value)
+        this.save()
+    }
+    /*删除key*/
+    /**
+     * @param {string} keyPath
+     */
+    delete(keyPath) {
+        this.document?.deleteIn(keyPath.split('.'))
+        this.save()
+    }
+    //数组添加数据
+    /**
+     * @param {string} keyPath
+     * @param {unknown} value
+     */
+    addIn(keyPath, value) {
+        this.document?.addIn(keyPath.split('.'), value)
+        this.save()
+    }
+    /**
+     * 设置 document 的数据（递归式）
+     * @param {unknown} data 要写入的数据
+     */
+    setData(data) {
+        this.setDataRecursion(data, [])
+        this.save()
+    }
+
+    /**
+     * @param {unknown} data
+     * @param {string[]} parentKeys
+     */
+    setDataRecursion(data, parentKeys) {
+        if (Array.isArray(data)) {
+            this.document?.setIn(this.mapParentKeys(parentKeys), data)
+        } else if (typeof data === 'object' && data !== null) {
+            for (const [key, value] of Object.entries(data)) {
+                this.setDataRecursion(value, parentKeys.concat([key]))
+            }
+        } else {
+            const mappedParentKeys = this.mapParentKeys(parentKeys)
+            this.document?.setIn(mappedParentKeys, data)
+        }
+    }
+
+    // 将数字key转为number类型，防止出现引号
+    /**
+     * @param {string[]} parentKeys
+     * @returns {(string | number)[]}
+     */
+    mapParentKeys(parentKeys) {
+        return parentKeys.map((k) => {
+            if (k.startsWith(Constant.CONFIG_INTEGER_KEY)) {
+                return Number.parseInt(k.replace(Constant.CONFIG_INTEGER_KEY, ''))
+            }
+            return k
+        })
+    }
+
+    // 彻底删除某个key
+    /**
+     * @param {string} keyPath
+     */
+    deleteKey(keyPath) {
+        const keys = this.mapParentKeys(keyPath.split('.'))
+        this.document?.deleteIn(keys)
+        this.save()
+    }
+
+    save() {
+        this.isSave = true
+        let yaml = this.document?.toString() ?? ''
+        fs.writeFileSync(this.yamlPath, yaml, 'utf8')
+    }
+
+    /** 关闭可选的文件监听器。 */
+    async close() {
+        const watcher = this.watcher
+        this.watcher = undefined
+        if (watcher) await watcher.close()
+    }
+}

package/core/components/baseClass.js

@@ -0,0 +1,287 @@
+import Config from './Config.js'
+import send from "../model/render/send.js";
+import fCompute from '../model/game/fCompute.js'
+import getInfo from '../model/game/getInfo.js';
+import logger from './Logger.js';
+import platform from './platform/index.js';
+
+/** @import {PlatformEvent, PlatformMessageInput, PlatformPluginConfig, PlatformUserId} from './platform/types.js' */
+
+const HostPlugin = platform.PluginBase
+const wrappedHandlerSymbol = Symbol('phi.wrappedHandler')
+
+
+/**
+ * @typedef {object} botEventObj
+ * @property {string} msg 消息内容
+ * @property {PlatformUserId} user_id 发送者ID
+ * @property {boolean} isGroup 是否群消息
+ * @property {boolean} isPrivate 是否私聊消息 
+ */
+
+/**
+ * @typedef {object} botEventGroup
+ * @property {true} isGroup 是否群消息
+ * @property {PlatformUserId} group_id 群ID
+ */
+
+/**
+ * @typedef {object} botEventPrivate
+ * @property {true} isPrivate 是否私聊消息
+ */
+
+/**@typedef {PlatformEvent & botEventObj & (botEventGroup | botEventPrivate) & Object.<string, any>} botEvent */
+
+/** 
+ * @template {any} T
+ * @typedef {Object} waitToChoseSong
+ * @property {idString[]} ids 待选择的曲目列表
+ * @property {T} options 其他选项
+ * @property {mutiNickCallback<T>} callback 选择后的回调函数
+ * @property {NodeJS.Timeout | undefined} timer 超时清理定时器
+ **/
+
+/** @type {Record<string, waitToChoseSong<any>>} */
+const wait_to_chose_song = {}
+
+/** @param {string} userId */
+function clearMutiNickState(userId) {
+  const state = wait_to_chose_song[userId]
+  if (state?.timer) clearTimeout(state.timer)
+  delete wait_to_chose_song[userId]
+}
+
+/**
+ * @template {any} T
+ * @typedef {(e: botEvent, id: idString, options: T) => void} mutiNickCallback
+ **/
+
+/**
+ * @typedef {object} getMicInfoFromMsgOptionsMap
+ * @property {levelKind} rank 难度
+ */
+
+
+export default class phiPluginBase extends HostPlugin {
+  /** @type {botEvent} */
+  e
+
+
+  /**
+   * @param {PlatformPluginConfig} config 配置项
+   */
+  constructor({
+    name = "your-plugin",
+    dsc = "无",
+    handler,
+    namespace,
+    event = "message",
+    priority = 5000,
+    task = undefined,
+    rule = []
+  }) {
+    super({
+      name, dsc, handler, namespace, event, priority, task,
+      // @ts-ignore
+      rule
+    });
+
+    /** @type {botEvent} */
+    this.e = platform.wrapEvent({ msg: '', user_id: '', isGroup: false, isPrivate: true }) // 占位用;
+    this.wrapPlatformHandlers()
+
+  }
+
+  /** @returns {void} */
+  wrapPlatformHandlers() {
+    for (const item of this.rule || []) {
+      if (item?.fnc) this.wrapPlatformHandler(item.fnc)
+    }
+  }
+
+  /**
+   * @param {string} key
+   * @returns {void}
+   */
+  wrapPlatformHandler(key) {
+    const fn = this[key]
+    if (typeof fn !== 'function') return
+    const typedFn = /** @type {Function & Record<symbol, unknown>} */ (fn)
+    if (typedFn[wrappedHandlerSymbol]) return
+    const wrapped = (/** @type {any[]} */ ...args) => {
+      if (args[0] && typeof args[0] === 'object') {
+        args[0] = this.wrapPlatformEvent(args[0])
+      } else if (this.e) {
+        this.e = this.wrapPlatformEvent(this.e)
+      }
+      return typedFn.apply(this, args)
+    }
+    wrapped[wrappedHandlerSymbol] = true
+    this[key] = wrapped
+  }
+
+  /**
+   * @param {botEvent} e
+   * @returns {botEvent}
+   */
+  wrapPlatformEvent(e) {
+    this.e = platform.wrapEvent(e)
+    return this.e
+  }
+
+  /**
+   * @param {PlatformMessageInput} [msg]
+   * @param {boolean} [quote]
+   * @param {Record<string, unknown>} [data]
+   */
+  reply(msg = '', quote = false, data = {}) {
+    return platform.reply(this.e, msg, { quote, ...data })
+  }
+
+  /**
+   * @param {...any} args
+   */
+  setContext(...args) {
+    if (this.e) this.e = platform.wrapEvent(this.e)
+    if (typeof args[0] === 'string') this.wrapPlatformHandler(args[0])
+    return super.setContext?.(...args)
+  }
+
+  /**
+   * @param {...any} args
+   */
+  finish(...args) {
+    return super.finish?.(...args)
+  }
+
+  /**
+   * @template {object} T
+   * @param {botEvent} e 事件对象
+   * @param {idString[]} idList 
+   * @param {T} options 
+   * @param {mutiNickCallback<T>} callback 
+   */
+  choseMutiNick(e, idList, options, callback) {
+    e = this.wrapPlatformEvent(e)
+    if (idList.length === 0) {
+      send.send_with_At(e, `未找到相关曲目信息QAQ！如果想要提供别名的话请访问 /phihelp 中的别名投稿链接嗷！`, true)
+      return;
+    }
+    if (idList.length === 1) {
+      callback(e, idList[0], options);
+      return;
+    }
+    send.send_with_At(e, fCompute.mutiNick(idList));
+    const userId = String(e.user_id)
+    const timeoutSeconds = Number(Config.getUserCfg('config', 'mutiNickWaitTimeOut')) || 0
+    clearMutiNickState(userId)
+    const state = wait_to_chose_song[userId] = {
+      ids: idList,
+      options,
+      callback,
+      timer: /** @type {NodeJS.Timeout | undefined} */ (undefined),
+    };
+    if (timeoutSeconds > 0) {
+      state.timer = setTimeout(() => {
+        if (wait_to_chose_song[userId] === state) clearMutiNickState(userId)
+      }, timeoutSeconds * 1000)
+      state.timer?.unref?.()
+    }
+    this.setContext('mutiNick', false, timeoutSeconds, '操作超时已取消，请注意@BOT进行回复呐！')
+
+  }
+
+  async mutiNick() {
+    this.e = this.wrapPlatformEvent(this.e)
+    const { msg } = this.e;
+    const num = Number(msg.match(/([0-9]+)/)?.[0]);
+    const userId = String(this.e.user_id)
+    const state = wait_to_chose_song[userId]
+    const ids = state?.ids || [];
+    if (!num) {
+      send.send_with_At(this.e, `请输入正确的序号哦！`);
+    } else if (!ids[num - 1]) {
+      send.send_with_At(this.e, `未找到${num}所对应的曲目哦！`);
+    } else {
+      clearMutiNickState(userId)
+      this.finish('mutiNick', false)
+      state?.callback(this.e, ids[num - 1], state.options);
+      return true;
+    }
+  }
+
+  /**
+   * 提取消息中的曲目与其他信息
+   * @template {keyof getMicInfoFromMsgOptionsMap} T
+   * @template {object} T2
+   * @param {botEvent} e 事件对象
+   * @param {RegExp} fncName 要去掉的命令前缀
+   * @param {T[]} params 需要解析的键集合
+   * @param {T2} options 其他选项
+   * @param {(e: botEvent, id: idString, params: Pick<getMicInfoFromMsgOptionsMap, T> & T2) => void} callback 仅包含声明过的键
+   */
+  async getMicInfoFromMsg(e, fncName, params = [], options, callback) {
+    let msg = e.msg.replace(fncName, '');
+    /** @type {Pick<getMicInfoFromMsgOptionsMap, T>} */
+    const optObj = /** @type {Pick<getMicInfoFromMsgOptionsMap, T>} */ ({});
+    for (let opt of params) {
+      switch (opt) {
+        case 'rank': {
+          let rank = /** @type {levelKind} */((msg.match(/\b(EZ|HD|IN|AT)\b/i)?.[1] || 'IN').toUpperCase())
+          optObj[opt] = rank;
+          msg = msg.replace(/\b(EZ|HD|IN|AT)\b/i, '')
+          break;
+        }
+      }
+    }
+
+    if (!msg) {
+      send.send_with_At(e, `请在命令后添加曲目名称或别名哦~`, true);
+      return;
+    }
+
+    let ids = getInfo.fuzzysongsnick(msg, undefined, true)
+    if (!ids.length) {
+      send.send_with_At(e, `未找到${msg}的相关曲目信息QAQ！如果想要提供别名的话请访问 /phihelp 中的别名投稿链接嗷！`, true)
+      return;
+    }
+
+    if (ids.length > 1) {
+      this.choseMutiNick(e, ids, { ...optObj, ...options }, (e, id, optObj) => {
+
+        let info = getInfo.info(id, true)
+        if (!info) {
+          send.send_with_At(e, `未找到${id}的曲目信息QAQ！请回报管理员！`, true)
+          logger.error(`phi-plugin错误：未找到曲目ID为${id}的曲目信息！`)
+          return;
+        }
+        if ('rank' in optObj) {
+          const { rank } = optObj
+          if (!info.chart[/** @type {levelKind} */(rank)]) {
+            send.send_with_At(e, `${info.song} 没有 ${rank} 这个难度QAQ！`)
+            return;
+          }
+        }
+
+        callback(e, id, optObj)
+      })
+    } else {
+      const id = ids[0];
+      let info = getInfo.info(id, true)
+      if (!info) {
+        send.send_with_At(e, `未找到${id}的曲目信息QAQ！请回报管理员！`, true)
+        logger.error(`phi-plugin错误：未找到曲目ID为${id}的曲目信息！`)
+        return;
+      }
+      if ('rank' in optObj) {
+        const { rank } = optObj
+        if (!info.chart[/** @type {levelKind} */(rank)]) {
+          send.send_with_At(e, `${info.song} 没有 ${rank} 这个难度QAQ！`)
+          return;
+        }
+      }
+      callback(e, id, { ...optObj, ...options })
+    }
+  }
+
+}

package/core/components/common.js

@@ -0,0 +1,47 @@
+import platform from './platform/index.js'
+
+export default {
+    /**
+     * @param {import('./platform/types.js').PlatformUserId} userId
+     * @param {import('./platform/types.js').PlatformMessageInput} msg
+     * @param {import('./platform/types.js').PlatformUserId} [botId]
+     */
+    relpyPrivate(userId, msg, botId) {
+        if (platform.relpyPrivate) return platform.relpyPrivate(userId, msg, botId)
+        return false
+    },
+
+    /**
+     * @param {number} ms
+     * @returns {Promise<void>}
+     */
+    sleep(ms) {
+        return platform.sleep(ms)
+    },
+
+    /**
+     * @param {string} url
+     * @param {string} file
+     * @param {unknown} [opts]
+     */
+    downFile(url, file, opts) {
+        return platform.downFile(url, file, opts)
+    },
+
+    /**
+     * @param {string} dirname
+     * @returns {boolean}
+     */
+    mkdirs(dirname) {
+        return platform.mkdirs(dirname)
+    },
+
+    /**
+     * @param {import('./platform/types.js').PlatformEvent} e
+     * @param {import('./platform/types.js').PlatformMessageInput[]} [msg]
+     * @param {string} [dec]
+     */
+    makeForwardMsg(e, msg = [], dec) {
+        return platform.makeForwardMsg(e, msg, dec)
+    },
+}

package/core/components/index.js

@@ -0,0 +1,13 @@
+import Version from './Version.js'
+import Data from './Data.js'
+import Config from './Config.js'
+import YamlReader from './YamlReader.js'
+import { pluginRoot } from '../model/filesystem/path.js'
+import platform from './platform/index.js'
+import logger from './Logger.js'
+import segment from './segment.js'
+const Path = platform.rootPath
+const Display_Plugin_Name = 'Phi-Plugin'
+const Plugin_Name = 'phi-plugin'
+const Plugin_Path = pluginRoot
+export { Config, Data, Version, Path, Plugin_Name, Plugin_Path, Display_Plugin_Name, YamlReader, logger, segment }