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

package/core/components/Config.js

@@ -0,0 +1,249 @@
+
+import YAML from 'yaml'
+import fs from 'node:fs'
+import path from 'node:path'
+import YamlReader from './YamlReader.js'
+import fileWatcherRegistry from './FileWatcherRegistry.js'
+import { pluginRoot } from '../model/filesystem/path.js'
+import logger from './Logger.js'
+import platform from './platform/index.js'
+
+const Plugin_Name = 'phi-plugin'
+const Plugin_Path = pluginRoot
+
+/**
+ * Koishi 移植专用：用户可写配置目录。
+ * 非 Koishi 环境与原本一致（插件根目录/config/config），
+ * Koishi 环境指向 `<ctx.baseDir>/data/<plugin>/config/config`。
+ */
+const koishiRoot = process.env.PHI_PLUGIN_KOISHI_ROOT
+  ? path.resolve(process.env.PHI_PLUGIN_KOISHI_ROOT)
+  : null
+
+/** 默认配置（随包分发，只读来源） */
+const DefaultConfigDir = path.join(Plugin_Path, 'config', 'default_config')
+
+/** 用户可写配置目录 */
+const UserConfigDir = koishiRoot
+  ? path.join(koishiRoot, 'config', 'config')
+  : path.join(Plugin_Path, 'config', 'config')
+
+/**
+ * 根据配置类别返回 yaml 文件路径
+ * @param {'config'|'default_config'} type
+ * @param {string} name
+ * @returns {string}
+ */
+function configFile(type, name) {
+  if (type === 'default_config') return path.join(DefaultConfigDir, `${name}.yaml`)
+  return path.join(UserConfigDir, `${name}.yaml`)
+}
+
+class Config {
+    constructor() {
+        /** @type {Record<string, any>} */
+        this.config = {}
+
+        /** 监听文件 */
+        /** @type {Record<string, any>} */
+        this.watcher = {}
+
+        this.initCfg()
+    }
+
+    /** 初始化配置 */
+    initCfg() {
+        fs.mkdirSync(UserConfigDir, { recursive: true })
+        const files = fs.readdirSync(DefaultConfigDir).filter(file => file.endsWith('.yaml'))
+        for (let file of files) {
+            if (!fs.existsSync(path.join(UserConfigDir, file))) {
+                fs.copyFileSync(path.join(DefaultConfigDir, file), path.join(UserConfigDir, file))
+            }
+            this.watch(path.join(UserConfigDir, file), file.replace('.yaml', ''), 'config')
+        }
+    }
+
+    /** 群配置 */
+    getGroup(groupId = '') {
+        let config = this.getConfig('whole')
+        let group = this.getConfig('group')
+        let defCfg = this.getdefSet('whole')
+
+        if (group[groupId]) {
+            return { ...defCfg, ...config, ...group[groupId] }
+        }
+        return { ...defCfg, ...config }
+    }
+
+    /**
+     * @overload
+     * @param {'config'} name 文件名
+     * @param {configName} style key值
+     * @returns {any} 配置值
+     */
+    /**
+     * @overload
+     * @param {'nickconfig'} name 文件名
+     * @param {string} mic 别名
+     * @returns {idString[]} 原曲id
+     */
+    /**
+     * @overload
+     * @param {'nickconfig'} name 文件名
+     * @returns {Record<string, idString[]>} <别名: 原曲id[]>
+     */
+    /**
+     * @overload
+     * @param {'otherinfo'} name 文件名
+     * @returns {any} 其他信息
+     */
+    /** 
+     * @param {'config'|'nickconfig'|'otherinfo'} name 文件名
+     * @param {any} [style] key值
+     * @description 默认配置和用户配置
+    */
+    getUserCfg(name, style = undefined) {
+        let def = this.getdefSet(name)
+        let config = this.getConfig(name)
+        if (name == 'otherinfo' && config) {
+            for (let i in config) {
+                config[i].sp_vis = true;
+            }
+        }
+        if (style) {
+            if (typeof config[style] != 'undefined') {
+                return config[style]
+            } else {
+                /**对设置进行补全 */
+                if (name == 'config') {
+                    this.modify(name, style, def[style])
+                }
+                return def[style]
+            }
+        }
+        else
+            return (config ? config : def)
+    }
+
+    /** 默认配置 */
+    /**
+     * @param {string} name
+     * @returns {Record<string, any>}
+     */
+    getdefSet(name) {
+        return this.getYaml('default_config', name)
+    }
+
+    /** 用户配置 */
+    /**
+     * @param {string} name
+     * @returns {Record<string, any>}
+     */
+    getConfig(name) {
+        return this.getYaml('config', name)
+    }
+
+    /**
+     * 获取配置yaml
+     * @param {'config'|'default_config'} type 默认配置-defSet，用户配置-config
+     * @param {string} name 名称
+     * @returns {Record<string, any>}
+     */
+    getYaml(type, name) {
+        let file = configFile(type, name)
+        let key = `${type}.${name}`
+
+        if (this.config[key]) return this.config[key]
+
+        this.config[key] = YAML.parse(
+            fs.readFileSync(file, 'utf8')
+        )
+
+        this.watch(file, name, type)
+
+        return this.config[key]
+    }
+
+    /** 监听配置文件 */
+    /**
+     * @param {string} file
+     * @param {string} name
+     * @param {'config'|'default_config'} [type]
+     */
+    watch(file, name, type = 'default_config') {
+        let key = `${type}.${name}`
+
+        if (this.watcher[key]) return
+
+        const watcherKey = `config:${key}`
+        const watcher = fileWatcherRegistry.watch(watcherKey, file, path => {
+            delete this.config[key]
+            if (!platform.isBotReady()) return
+            logger.mark(`[phi修改配置文件][${type}][${name}]`)
+            const changeHandler = /** @type {Record<string, any>} */ (this)[`change_${name}`]
+            if (typeof changeHandler === 'function') {
+                changeHandler.call(this)
+            }
+        })
+
+        this.watcher[key] = watcher
+    }
+
+    /** 关闭当前配置实例创建的全部监听器。 */
+    async close() {
+        const entries = Object.entries(this.watcher)
+        this.watcher = {}
+        await Promise.allSettled(entries.map(([, lease]) => lease.close()))
+    }
+
+    /**
+     * @overload
+     * @param {'config'} name 文件名
+     * @param {configName} key 修改的key值
+     * @param {String|Number|boolean} value 修改的value值
+     * @param {'config'|'default_config'} [type] 配置或默认，默认为配置
+     * @returns {void}
+     */
+    /**
+     * @overload
+     * @param {'nickconfig'} name 文件名
+     * @param {any} key 别名
+     * @param {String|Number|any[]} value 修改的value值
+     * @param {'config'|'default_config'} [type] 配置或默认，默认为配置
+     * @returns {void}
+     */
+    /**
+     * @description: 修改设置
+     * @param {'config'|'nickconfig'} name 文件名
+     * @param {any} key 修改的key值
+     * @param {String|Number|boolean|any[]} value 修改的value值
+     * @param {'config'|'default_config'} [type] 配置或默认
+     */
+    modify(name, key, value, type = 'config') {
+        let file = configFile(type, name)
+        new YamlReader(file).set(key, value)
+        delete this.config[`${type}.${name}`]
+    }
+
+    /**
+     * @description: 修改配置数组
+     * @param {'config'|'nickconfig'} name 文件名
+     * @param {string | number} key key值
+     * @param {String|Number} value value
+     * @param {'add'|'del'} category 类别 add or del
+     * @param {'config'|'default_config'} type 配置或默认
+     */
+    modifyarr(name, key, value, category = 'add', type = 'config') {
+        let file = configFile(type, name)
+        let yaml = new YamlReader(file)
+        const keyPath = String(key)
+        if (category == 'add') {
+            yaml.addIn(keyPath, value)
+        } else {
+            let index = yaml.jsonData[keyPath].indexOf(value)
+            yaml.delete(`${keyPath}.${index}`)
+        }
+    }
+}
+
+export default new Config()

package/core/components/Data.js

@@ -0,0 +1,304 @@
+import lodash from 'lodash'
+import fs from 'fs'
+import { pluginRoot } from '../model/filesystem/path.js'
+import logger from './Logger.js'
+import { redis } from './platform/index.js'
+
+/**
+ * @param {string} [root]
+ * @returns {string}
+ */
+const getRoot = (root = '') => {
+    if (root === 'root' || root === 'yunzai') {
+        root = `${process.cwd()}/`
+    } else if (!root) {
+        root = `${pluginRoot}/`
+    }
+    return root
+}
+
+/**
+ * @typedef {object} DataPickOptions
+ * @property {Record<string, any>} [defaultData]
+ * @property {boolean} [lowerFirstKey]
+ * @property {string} [keyPrefix]
+ */
+
+/** @type {Record<string, any>} */
+let Data = {
+
+    /*
+    * 根据指定的path依次检查与创建目录
+    * */
+    createDir(path = '', root = '', includeFile = false) {
+        root = getRoot(root)
+        let pathList = path.split('/')
+        let nowPath = root
+        pathList.forEach((name, idx) => {
+            name = name.trim()
+            if (!includeFile && idx <= pathList.length - 1) {
+                nowPath += name + '/'
+                if (name) {
+                    if (!fs.existsSync(nowPath)) {
+                        fs.mkdirSync(nowPath)
+                    }
+                }
+            }
+        })
+    },
+
+    /** 读取json */
+    readJSON(file = '', root = '') {
+        root = getRoot(root)
+        if (fs.existsSync(`${root}/${file}`)) {
+            try {
+                return JSON.parse(fs.readFileSync(`${root}/${file}`, 'utf8'))
+            } catch (e) {
+                logger.error(e)
+            }
+        }
+        return {}
+    },
+
+    /** 写JSON */
+    /**
+     * @param {string} file
+     * @param {unknown} data
+     * @param {string} [root]
+     * @param {string | number} [space]
+     */
+    writeJSON(file, data, root = '', space = '\t') {
+        // 检查并创建目录
+        Data.createDir(file, root, true)
+        root = getRoot(root)
+        // delete data._res
+        try {
+            fs.writeFileSync(`${root}/${file}`, JSON.stringify(data, null, space))
+            return true
+        } catch (err) {
+            logger.error(err)
+            return false
+        }
+    },
+
+    /**
+     * @param {string} key
+     */
+    async getCacheJSON(key) {
+        try {
+            let txt = await redis.get(key)
+            if (txt) {
+                return JSON.parse(txt)
+            }
+        } catch (e) {
+            logger.error(e)
+        }
+        return {}
+    },
+
+    /**
+     * @param {string} key
+     * @param {unknown} data
+     * @param {number} [EX]
+     */
+    async setCacheJSON(key, data, EX = 3600 * 24 * 90) {
+        await redis.set(key, JSON.stringify(data), { EX })
+    },
+
+    /**
+     * @param {string} file
+     * @param {string} [root]
+     */
+    async importModule(file, root = '') {
+        root = getRoot(root)
+        if (!/\.js$/.test(file)) {
+            file = file + '.js'
+        }
+        if (fs.existsSync(`${root}/${file}`)) {
+            try {
+                let data = await import(`file://${root}/${file}?t=${Date.now()}`)
+                return data || {}
+            } catch (e) {
+                logger.error(e)
+            }
+        }
+        return {}
+    },
+
+    /**
+     * @param {string} file
+     * @param {string} [root]
+     */
+    async importDefault(file, root) {
+        let ret = await Data.importModule(file, root)
+        return ret.default || {}
+    },
+
+    /**
+     * @param {string} name
+     */
+    async import(name) {
+        return await Data.importModule(`components/optional-lib/${name}.js`)
+    },
+
+    /**
+     * @param {string} key
+     */
+    async importCfg(key) {
+        let sysCfg = await Data.importModule(`config/system/${key}_system.js`)
+        let diyCfg = await Data.importModule(`config/${key}.js`)
+        if (diyCfg.isSys) {
+            logger.error(`phi-plugin: config/${key}.js无效，已忽略`)
+            logger.error(`如需配置请复制config/${key}_default.js为config/${key}.js，请勿复制config/system下的系统文件`)
+            diyCfg = {}
+        }
+        return {
+            sysCfg,
+            diyCfg
+        }
+    },
+
+    /*
+    * 返回一个从 target 中选中的属性的对象
+    *
+    * keyList : 获取字段列表，逗号分割字符串
+    *   key1, key2, toKey1:fromKey1, toKey2:fromObj.key
+    *
+    * defaultData: 当某个字段为空时会选取defaultData的对应内容
+    * toKeyPrefix：返回数据的字段前缀，默认为空。defaultData中的键值无需包含toKeyPrefix
+    *
+    * */
+
+    /**
+     * @param {Record<string, any>} target
+     * @param {string | string[]} [keyList]
+     * @param {DataPickOptions} [cfg]
+     */
+    getData(target, keyList = '', cfg = {}) {
+        target = target || {}
+        let defaultData = cfg.defaultData || {}
+        /** @type {Record<string, any>} */
+        let ret = {}
+        // 分割逗号
+        if (typeof (keyList) === 'string') {
+            keyList = keyList.split(',')
+        }
+
+        lodash.forEach(keyList, (keyCfg) => {
+            // 处理通过:指定 toKey & fromKey
+            let _keyCfg = keyCfg.split(':')
+            let keyTo = _keyCfg[0].trim()
+            let keyFrom = (_keyCfg[1] || _keyCfg[0]).trim()
+            let keyRet = keyTo
+            if (cfg.lowerFirstKey) {
+                keyRet = lodash.lowerFirst(keyRet)
+            }
+            if (cfg.keyPrefix) {
+                keyRet = cfg.keyPrefix + keyRet
+            }
+            // 通过Data.getVal获取数据
+            ret[keyRet] = Data.getVal(target, keyFrom, defaultData[keyTo], cfg)
+        })
+        return ret
+    },
+
+    /**
+     * @param {Record<string, any>} target
+     * @param {string} keyFrom
+     * @param {unknown} defaultValue
+     */
+    getVal(target, keyFrom, defaultValue) {
+        return lodash.get(target, keyFrom, defaultValue)
+    },
+
+    // 异步池，聚合请求
+    /**
+     * @template T, R
+     * @param {number} poolLimit
+     * @param {T[]} array
+     * @param {(item: T, array: T[]) => R | Promise<R>} iteratorFn
+     * @returns {Promise<R[]>}
+     */
+    async asyncPool(poolLimit, array, iteratorFn) {
+        /** @type {Promise<R>[]} */
+        const ret = [] // 存储所有的异步任务
+        /** @type {Promise<void>[]} */
+        const executing = [] // 存储正在执行的异步任务
+        for (const item of array) {
+            // 调用iteratorFn函数创建异步任务
+            const p = Promise.resolve().then(() => iteratorFn(item, array))
+            // 保存新的异步任务
+            ret.push(p)
+
+            // 当poolLimit值小于或等于总任务个数时，进行并发控制
+            if (poolLimit <= array.length) {
+                // 当任务完成后，从正在执行的任务数组中移除已完成的任务
+                const e = p.then(() => undefined)
+                executing.push(e) // 保存正在执行的异步任务
+                void e.then(() => {
+                    const index = executing.indexOf(e)
+                    if (index >= 0) executing.splice(index, 1)
+                })
+                if (executing.length >= poolLimit) {
+                    // 等待较快的任务执行完成
+                    await Promise.race(executing)
+                }
+            }
+        }
+        return Promise.all(ret)
+    },
+
+    // sleep
+    /**
+     * @param {number} ms
+     */
+    sleep(ms) {
+        return new Promise((resolve) => setTimeout(resolve, ms))
+    },
+
+    // 获取默认值
+    def() {
+        for (let idx in arguments) {
+            if (!lodash.isUndefined(arguments[idx])) {
+                return arguments[idx]
+            }
+        }
+    },
+
+    // 循环字符串回调
+    /**
+     * @param {string | number | Array<string | number>} arr
+     * @param {(value: string | number, index: number | string) => void} fn
+     */
+    eachStr: (arr, fn) => {
+        if (lodash.isString(arr)) {
+            arr = arr.replace(/\s*(;|；|、|，)\s*/, ',')
+            arr = arr.split(',')
+        } else if (lodash.isNumber(arr)) {
+            arr = [arr.toString()]
+        }
+        lodash.forEach(arr, (str, idx) => {
+            if (!lodash.isUndefined(str)) {
+                const value = typeof str === 'string' ? str.trim() : str
+                fn(value, idx)
+            }
+        })
+    },
+
+    /**
+     * @param {RegExp} reg
+     * @param {string} txt
+     * @param {number} idx
+     */
+    regRet(reg, txt, idx) {
+        if (reg && txt) {
+            let ret = reg.exec(txt)
+            if (ret && ret[idx]) {
+                return ret[idx]
+            }
+        }
+        return false
+    }
+}
+
+export default Data

package/core/components/FileWatcherRegistry.js

@@ -0,0 +1,102 @@
+import path from 'node:path'
+import chokidar from 'chokidar'
+
+const registrySymbol = Symbol.for('phi-plugin.fileWatcherRegistry')
+const globalStore = /** @type {Record<symbol, any>} */ (globalThis)
+
+/**
+ * @typedef {object} FileWatcherLease
+ * @property {import('chokidar').FSWatcher} watcher
+ * @property {Promise<void>} ready
+ * @property {() => Promise<void>} close
+ */
+
+export class FileWatcherRegistry {
+    constructor() {
+        /** @type {Map<string, {file: string, watcher: import('chokidar').FSWatcher, ready: Promise<void>, onChange: (...args: any[]) => void, lease: FileWatcherLease}>} */
+        this.entries = new Map()
+    }
+
+    /**
+     * 同一个 key 在热重载后复用 watcher，只替换回调以释放旧模块引用。
+     * @param {string} key
+     * @param {string} file
+     * @param {(...args: any[]) => void} onChange
+     * @param {string[]} [events=['change']] 需要监听的 chokidar 事件（change/add/unlink/addDir/unlinkDir…）
+     * @param {import('chokidar').ChokidarOptions} [watchOptions]
+     * @returns {FileWatcherLease}
+     */
+    watch(key, file, onChange, events = ['change'], watchOptions = {}) {
+        const normalizedFile = path.resolve(file)
+        const current = this.entries.get(key)
+        if (current?.file === normalizedFile) {
+            current.onChange = onChange
+            current.lease = this.createLease(key, current.watcher, current.ready)
+            return current.lease
+        }
+
+        if (current) {
+            this.entries.delete(key)
+            void current.watcher.close()
+        }
+
+        /** @type {{file: string, watcher: import('chokidar').FSWatcher, ready: Promise<void>, onChange: (...args: any[]) => void, lease: FileWatcherLease}} */
+        const entry = {
+            file: normalizedFile,
+            watcher: /** @type {any} */ (null),
+            ready: /** @type {any} */ (null),
+            onChange,
+            lease: /** @type {any} */ (null),
+        }
+        entry.watcher = chokidar.watch(normalizedFile, watchOptions)
+        entry.ready = new Promise(resolve => entry.watcher.once('ready', () => resolve()))
+        const watcher = /** @type {any} */ (entry.watcher)
+        for (const event of events) {
+            watcher.on(event, /** @type {(...args: any[]) => void} */ ((...args) => entry.onChange(...args)))
+
+        }
+        entry.lease = this.createLease(key, entry.watcher, entry.ready)
+        this.entries.set(key, entry)
+        return entry.lease
+    }
+
+    /**
+     * @param {string} key
+     * @param {import('chokidar').FSWatcher} watcher
+     * @param {Promise<void>} ready
+     * @returns {FileWatcherLease}
+     */
+    createLease(key, watcher, ready) {
+        /** @type {FileWatcherLease} */
+        const lease = {
+            watcher,
+            ready,
+            close: () => this.close(key, lease),
+        }
+        return lease
+    }
+
+    /**
+     * @param {string} key
+     * @param {FileWatcherLease} [expectedLease]
+     */
+    async close(key, expectedLease) {
+        const entry = this.entries.get(key)
+        if (!entry) return
+        if (expectedLease && entry.lease !== expectedLease) return
+        this.entries.delete(key)
+        await entry.watcher.close()
+    }
+
+    async closeAll() {
+        const entries = [...this.entries.values()]
+        this.entries.clear()
+        await Promise.allSettled(entries.map(entry => entry.watcher.close()))
+    }
+}
+
+const fileWatcherRegistry = /** @type {FileWatcherRegistry} */ (
+    globalStore[registrySymbol] ||= new FileWatcherRegistry()
+)
+
+export default fileWatcherRegistry

package/core/components/Logger.js

@@ -0,0 +1,11 @@
+import platform from './platform/index.js'
+
+const logger = /** @type {import('./platform/types.js').PlatformLogger} */ (new Proxy({}, {
+    get(_target, prop) {
+        if (typeof prop === 'symbol') return undefined
+        const value = platform.logger?.[prop]
+        return typeof value === 'function' ? value.bind(platform.logger) : value
+    },
+}))
+
+export default logger