node-karin 0.0.3

package/lib/utils/common.js

@@ -0,0 +1,413 @@
+import fs from 'fs'
+import path from 'path'
+import axios from 'axios'
+import { promisify } from 'util'
+import logger from '../utils/logger.js'
+import segment from '../utils/segment.js'
+import { pipeline, Readable } from 'stream'
+import lodash from 'lodash'
+import { fileURLToPath } from 'url'
+/**
+ * 常用方法
+ */
+export default new (class Common {
+  streamPipeline
+  constructor () {
+    this.streamPipeline = promisify(pipeline)
+  }
+
+  /**
+     * 休眠函数
+     * @param ms 毫秒
+     */
+  sleep (ms) {
+    return new Promise(resolve => setTimeout(resolve, ms))
+  }
+
+  /**
+     * 下载保存文件
+     * @param  fileUrl 下载地址
+     * @param  savePath 保存路径
+     * @param param axios参数
+     */
+  async downFile (fileUrl, savePath, param = {}) {
+    try {
+      this.mkdir(path.dirname(savePath))
+      logger && logger.info(`[下载文件] ${fileUrl}`)
+      const response = await axios.get(fileUrl, { ...param, responseType: 'stream' })
+      await this.streamPipeline(response.data, fs.createWriteStream(savePath))
+      return true
+    } catch (err) {
+      logger && logger.error(`下载文件错误：${err}`)
+      return false
+    }
+  }
+
+  /**
+     * 递归创建目录
+     * @param dirname - 要创建的文件夹路径
+     */
+  mkdir (dirname) {
+    if (fs.existsSync(dirname)) { return true }
+    /** 递归自调用 */
+    if (this.mkdir(path.dirname(dirname))) { fs.mkdirSync(dirname) }
+    return true
+  }
+
+  /**
+     * 标准化文件路径
+     * @param file - 相对路径
+     * @param isDir - 返回绝对路径
+     * @param isFile - 添加file://前缀
+     * @returns 标准化后的路径
+     */
+  absPath (file, isDir = true, isFile = false) {
+    file = file.replace(/\\/g, '/')
+    if (file.startsWith('file://')) {
+      /** linux */
+      if (path.sep === '/') {
+        file = file.replace('file://', '')
+      } else {
+        /** windows */
+        file = file.replace(/^file:[/]{2,3}/g, '')
+      }
+    }
+    file = path.normalize(file)
+    /** 判断路径是否为绝对路径 否则转为绝对路径 */
+    if (isDir && !path.isAbsolute(file)) {
+      file = path.resolve(file)
+    }
+    if (isFile) { file = 'file://' + file }
+    file = file.replace(/\\/g, '/')
+    return file
+  }
+
+  /**
+     * 判断是否为文件夹
+     * @param path - 路径
+     * @returns 返回true为文件夹
+     */
+  isDir (path) {
+    try {
+      return fs.statSync(path).isDirectory()
+    } catch {
+      return false
+    }
+  }
+
+  /**
+     * 判断是否为插件包
+     * @param path - 路径
+     * @returns 返回true为插件包
+     */
+  isPlugin (path) {
+    return this.exists(`${path}/package.json`)
+  }
+
+  /**
+     * 判断路径是否存在
+     * @param path - 路径
+     * @returns 返回true为存在
+     */
+  exists (path) {
+    try {
+      return fs.existsSync(path)
+    } catch {
+      return false
+    }
+  }
+
+  /**
+     * 根据文件后缀名从指定路径下读取符合要求的文件
+     * @param path - 路径
+     * @param ext - 后缀名、或后缀名列表
+     * @example common.readDir('./plugins', '.js')
+     * @example common.readDir('./plugins', ['.js', '.ts'])
+     */
+  readDir (_path, ext) {
+    if (!this.isDir(_path)) { return null }
+    const files = fs.readdirSync(_path, { withFileTypes: true })
+    const list = []
+    if (!Array.isArray(ext)) { ext = [ext] }
+    // 排除文件夹 和不符合后缀名的文件
+    files.forEach(v => {
+      if (v.isDirectory()) { return }
+      if (ext.includes(path.extname(v.name))) { list.push(v.name) }
+    })
+    return list
+  }
+
+  /**
+     * 传入 import.meta.url 自动构建../
+     * @param url - import.meta.url
+     */
+  urlToPath (url) {
+    // 获取当前文件的绝对路径
+    const filePath = fileURLToPath(url)
+    // 获取当前文件所在目录的绝对路径
+    const dirPath = path.dirname(filePath)
+    // 获取项目根目录
+    const rootPath = process.cwd()
+    // 计算当前文件到项目根目录的相对路径
+    const relativePath = path.relative(dirPath, rootPath)
+    // 计算返回上一级目录的数量
+    const upLevelsCount = relativePath.split(path.sep).length
+    // 生成相应数量的 '../'
+    const upPath = lodash.repeat('../', upLevelsCount)
+    return upPath
+  }
+
+  /**
+     * 将文件转换为不带前缀的base64字符串
+     * @param file - 文件路径或Buffer对象、可读流对象、http地址、base64://字符串
+     * @param - 附加数据
+     * @param - 为true时，http地址会直接返回，否则会下载文件并转换为base64字符串
+     * @returns 返回base64字符串
+     */
+  async base64 (file, options = { http: false }) {
+    /** 先判断是否非字符串情况 */
+    if (typeof file !== 'string') {
+      /** buffer */
+      if (Buffer.isBuffer(file)) {
+        return file.toString('base64')
+      }
+      /** 可读流 */
+      if (file instanceof Readable) {
+        const data_1 = await this.stream(file)
+        return data_1.toString('base64')
+      }
+      /** 未知类型 */
+      throw new Error('未知类型')
+    }
+    /** base64:// */
+    if (file.startsWith('base64://')) {
+      return file.replace('base64://', '')
+    }
+    /** url */
+    if (file.startsWith('http://') || file.startsWith('https://')) {
+      if (options.http) { return file }
+      const response = await axios.get(file, { responseType: 'arraybuffer' })
+      return Buffer.from(response.data, 'binary').toString('base64')
+    }
+    /** file:/// */
+    if (fs.existsSync(file.replace(/^file:\/\/\//, ''))) {
+      file = file.replace(/^file:\/\/\//, '')
+      return fs.readFileSync(file).toString('base64')
+    }
+    /** file:// */
+    if (fs.existsSync(file.replace(/^file:\/\//, ''))) {
+      file = file.replace(/^file:\/\//, '')
+      return fs.readFileSync(file).toString('base64')
+    }
+    /** 无前缀base64:// */
+    const buffer = Buffer.from(file, 'base64').toString('base64') === file
+    if (buffer) { return file }
+    throw new Error('未知类型')
+  }
+
+  /**
+     * 将数据流对象转换为Buffer对象
+     * @param {stream.Readable} stream - 要转换的数据流对象
+     * @returns {Promise<Buffer>} - 返回Buffer
+     */
+  stream (stream) {
+    return new Promise((resolve, reject) => {
+      const chunks = []
+      stream.on('data', chunk => chunks.push(chunk))
+      stream.on('end', () => resolve(Buffer.concat(chunks)))
+      stream.on('error', error => reject(error))
+    })
+  }
+
+  /**
+     * 将文件转换为Buffer对象
+     * @param {string|Buffer|http|stream.Readable} file - 文件路径或Buffer对象、可读流对象、http地址、base64://字符串
+     * @param {object} options - 附加数据
+     * @param {boolean} options.http - 为true时，http地址会直接返回，否则会下载文件并转换为Buffer对象
+     * @returns {Promise<Buffer>} - 返回Buffer对象
+     */
+  async buffer (file, options = { http: false }) {
+    if (typeof file !== 'string') {
+      if (Buffer.isBuffer(file)) { return file }
+      if (file instanceof Readable) { return this.stream(file) }
+      throw new Error('未知文件类型：' + file)
+    }
+    if (file.startsWith('base64://')) { return Buffer.from(file.replace('base64://', ''), 'base64') }
+    if (file.startsWith('http://') || file.startsWith('https://')) {
+      if (options.http) { return file }
+      const response = await axios.get(file, { responseType: 'arraybuffer' })
+      return Buffer.from(response.data)
+    }
+    /** file:/// */
+    if (fs.existsSync(file.replace(/^file:\/\/\//, ''))) {
+      file = file.replace(/^file:\/\/\//, '')
+      return fs.readFileSync(file)
+    }
+    /** file:// */
+    if (fs.existsSync(file.replace(/^file:\/\//, ''))) {
+      file = file.replace(/^file:\/\//, '')
+      return fs.readFileSync(file)
+    }
+    /** 无前缀base64:// */
+    const buffer = Buffer.from(file, 'base64')
+    if (buffer.toString('base64') === file) { return buffer }
+    throw new Error('未知类型')
+  }
+
+  /**
+     * 标准化发送的消息内容
+     * @param elements - 消息内容
+     */
+  makeMessage (elements) {
+    /** 将msg格式化为数组 */
+    if (!Array.isArray(elements)) { elements = [elements] }
+    const message = []
+    elements.forEach(v => {
+      if (typeof v === 'string') {
+        message.push(segment.text(v))
+      } else {
+        message.push(v)
+      }
+    })
+    return message
+  }
+
+  /**
+     * 制作简单转发，返回segment.node[]。仅简单包装node，也可以自己组装
+     * @param {Array<{object}> | object} elements
+     * @param fakeUin 用户id
+     * @param fakeNick 用户昵称
+     * @return {Array<KarinNodeElement>}
+     */
+  makeForward (elements, fakeUin, fakeNick) {
+    if (!Array.isArray(elements)) { elements = [elements] }
+    return elements.map(element => {
+      const NodeElement = this.makeMessage(element)
+      return segment.node(fakeUin, fakeNick, NodeElement)
+    })
+  }
+
+  /**
+     * 获取所有插件列表
+     * @param isDir - 返回绝对路径
+     * @param isPack - 屏蔽不带packageon的插件
+     */
+  getPlugins (isDir = false, isPack = false) {
+    const dir = this.absPath('./plugins', isDir)
+    let list = fs.readdirSync(dir, { withFileTypes: true })
+    // 忽略非文件夹、非 karin-plugin-、karin-adapter- 开头的文件夹
+    list = list.filter(v => v.isDirectory() && v.name.startsWith('karin-plugin-'))
+    if (isPack) { list = list.filter(v => fs.existsSync(`${dir}/${v.name}/packageon`)) }
+    const arr = []
+    list.map(v => arr.push(v.name))
+    return arr
+  }
+
+  /**
+     * 获取运行时间
+     */
+  uptime () {
+    const time = process.uptime()
+    const day = Math.floor(time / 86400)
+    const hour = Math.floor((time % 86400) / 3600)
+    const min = Math.floor((time % 3600) / 60)
+    const sec = Math.floor(time % 60)
+    const parts = [day ? `${day}天` : '', hour ? `${hour}小时` : '', min ? `${min}分钟` : '', !day && sec ? `${sec}秒` : '']
+    return parts.filter(Boolean).join('')
+  }
+
+  /**
+     * 构建消息体日志
+     * @param - 消息体
+     */
+  makeMessageLog (message) {
+    const logs = []
+    for (const val of message) {
+      switch (val.type) {
+        case 'text':
+          logs.push(val.text)
+          break
+        case 'face':
+          logs.push(`[face:${val.id}]`)
+          break
+        case 'video':
+        case 'image':
+        case 'voice':
+        case 'record':
+        case 'file': {
+          let file
+          if (Buffer.isBuffer(val.file)) {
+            file = 'Buffer://...'
+          } else if (/^http|^file/.test(val.file)) {
+            file = val.file
+          } else {
+            file = 'base64://...'
+          }
+          logs.push(`[${val.type}:${file}]`)
+          break
+        }
+        case 'at':
+          logs.push(`[at:${val.uid}]`)
+          break
+        case 'rps':
+          logs.push(`[rps:${val.id}]`)
+          break
+        case 'dice':
+          logs.push(`[dice:${val.id}]`)
+          break
+        case 'poke':
+          logs.push(`[poke:${val.id}]`)
+          break
+        case 'share':
+          logs.push(`[share:${JSON.stringify(val)}]`)
+          break
+        case 'contact':
+          logs.push(`[contact:${JSON.stringify(val)}]`)
+          break
+        case 'location':
+          logs.push(`[location:${JSON.stringify(val)}]`)
+          break
+        case 'music':
+          logs.push(`[music:${JSON.stringify(val)}]`)
+          break
+        case 'reply':
+          logs.push(`[reply:${val.message_id}]`)
+          break
+        case 'forward':
+          logs.push(`[forward:${val.res_id}]`)
+          break
+        case 'xml':
+          logs.push(`[xml:${val.data}]`)
+          break
+        case 'json':
+          logs.push(`[json:${val.data}]`)
+          break
+        case 'markdown': {
+          if (val.content) {
+            logs.push(`[markdown:${val.content}]`)
+          } else {
+            const content = { id: val.custom_template_id }
+            for (const v of val.params) { content[v.key] = v.values[0] }
+            logs.push(`[markdown:${JSON.stringify(content)}]`)
+          }
+          break
+        }
+        case 'rows': {
+          const rows = []
+          for (const v of val.rows) { rows.push(JSON.stringify(v.data)) }
+          logs.push(`[rows:${JSON.stringify(rows)}]`)
+          break
+        }
+        case 'button':
+          logs.push(`[button:${JSON.stringify(val.data)}]`)
+          break
+        case 'long_msg':
+          logs.push(`[long_msg:${val.id}]`)
+          break
+        default:
+          logs.push(`[未知:${JSON.stringify(val)}]`)
+      }
+    }
+    return logs.join('')
+  }
+})()

package/lib/utils/config.d.ts

@@ -0,0 +1,72 @@
+import { Redis, App, Config, Server, Package, GroupCfg } from '../types/config.js';
+import { Logger } from 'log4js';
+/** 配置文件 */
+declare const _default: {
+    dir: string;
+    _path: string;
+    _pathDef: string;
+    change: Map<string, any>;
+    watcher: Map<string, any>;
+    review: boolean;
+    loggger: Logger;
+    /** 初始化配置 */
+    initCfg(): Promise<void>;
+    getPlugins(): string[];
+    /**
+     * 为每一个插件建立对应的文件夹
+     */
+    dirPath(name: string, plugins: string[]): Promise<void>;
+    /**
+     * 超时时间
+     */
+    timeout(type?: 'ws' | 'grpc'): number;
+    /**
+     * Redis 配置
+     * 采用实时读取优化性能
+     */
+    readonly redis: Redis;
+    /**
+     * 主人列表
+     * @returns {string[]}
+     */
+    readonly master: string[];
+    /**
+     * 管理员列表
+     */
+    readonly admin: string[];
+    /** App管理 */
+    readonly App: App;
+    /**
+     * 基本配置
+     */
+    readonly Config: Config;
+    /**
+     * Server 配置文档
+     */
+    readonly Server: Server;
+    /**
+     * packageon
+     * 实时获取packageon文件
+     */
+    readonly package: Package;
+    /**
+     * 获取群配置
+     */
+    group(group_id?: string): GroupCfg;
+    /**
+     * 获取配置yaml
+     */
+    getYaml(type: 'defSet' | 'config', name: string, isWatch?: boolean): any;
+    /**
+     * 监听配置文件
+     * @param {'defSet'|'config'} type 类型
+     * @param {string} name 文件名称 不带后缀
+     * @param {string} file 文件路径
+     */
+    watch(type: 'defSet' | 'config', name: string, file: string): Promise<true | undefined>;
+    change_App(): Promise<void>;
+    change_config(): Promise<void>;
+    change_group(): Promise<void>;
+    "__#1@#review"(): Promise<void>;
+};
+export default _default;