mm_cmd 0.0.0-stage → 1.1.1

package/lib/cmd.js

@@ -0,0 +1,330 @@
+const path = require('path');
+const Item = require('mm_mod').Base;
+// 指令匹配依赖 mm_matchs 注入的 String.prototype.matchs（需 mm_matchs 环境）
+require('mm_matchs');
+
+/**
+ * 指令驱动类（迁移自 mm_os com/cmd，基于 mm_corejs.Base）
+ * @augments {Item}
+ * @class
+ */
+class Cmd extends Item {
+  /**
+   * 配置参数
+   * @type {object}
+   */
+  static config = {
+    /**
+     * 名称
+     * @type {string}
+     */
+    name: '',
+    /**
+     * 标题
+     * @type {string}
+     */
+    title: '',
+    /**
+     * 描述
+     * @type {string}
+     */
+    description: '',
+    /**
+     * 状态 0未启用，1启用
+     * @type {number}
+     */
+    state: 1,
+    app: 'server',
+    plugin: 'sys',
+    match: [],
+    not: [],
+    end: 1,
+    sort: 100,
+    tense: 'main',
+    params: null,
+    // 主脚本文件路径（相对 dir 解析）
+    main: './index.js',
+    // 回调函数名，决定调用脚本的哪个函数
+    func_name: 'main',
+    // 驱动目录（方案B：手动配置，替代目录扫描）
+    dir: '',
+  };
+
+  /**
+   * 构造函数
+   * @param {object} config 配置参数
+   * @param {object} parent 父对象（管理器实例）
+   */
+  constructor(config, parent) {
+    super({ ...Cmd.config, ...config });
+
+    // 父级管理器引用（用于配置回退与插件查找）
+    this.parent = parent || null;
+    // 脚本方法集合（loadScript 后注册）
+    this.methods = {};
+    // 脚本加载标记
+    this.loaded = false;
+  }
+}
+
+/**
+ * 解析主脚本文件绝对路径（config.main 相对 config.dir 解析，dir 为空时相对本模块目录）
+ * @returns {string} 脚本绝对路径，未配置 main 返回空字符串
+ * @private
+ */
+Cmd.prototype._getScriptFile = function () {
+  var main = this.config.main || '';
+  if (!main) {
+    return '';
+  }
+  if (path.isAbsolute(main)) {
+    return main;
+  }
+  return path.resolve(this.config.dir || __dirname, main);
+};
+
+/**
+ * 加载主脚本文件并注册导出方法（替代旧基类 loadScript + _setMainMethod）
+ * @returns {object|null} 加载的模块对象
+ */
+Cmd.prototype.loadScript = function () {
+  var file = this._getScriptFile();
+  if (!file) {
+    return null;
+  }
+  try {
+    var mod = require(file);
+    this._registerMethods(mod);
+    this.loaded = true;
+    return mod;
+  } catch (err) {
+    this.log('error', '加载脚本文件失败', file, err);
+    return null;
+  }
+};
+
+/**
+ * 注册脚本导出的函数方法
+ * @param {object} mod 脚本模块对象
+ * @returns {void}
+ * @private
+ */
+Cmd.prototype._registerMethods = function (mod) {
+  if (!mod) {
+    return;
+  }
+  for (var key in mod) {
+    if (typeof mod[key] === 'function') {
+      this.methods[key] = mod[key];
+    }
+  }
+};
+
+/**
+ * 卸载脚本（清除模块缓存与方法集合）
+ * @returns {void}
+ */
+Cmd.prototype.unloadScript = function () {
+  var file = this._getScriptFile();
+  if (file) {
+    try {
+      delete require.cache[require.resolve(file)];
+    } catch {
+      // 文件未加载或不存在时忽略
+    }
+  }
+  this.methods = {};
+  this.loaded = false;
+};
+
+/**
+ * 重新加载脚本
+ * @returns {object|null} 加载的模块对象
+ */
+Cmd.prototype.reloadScript = function () {
+  this.unloadScript();
+  return this.loadScript();
+};
+
+/**
+ * 调用脚本方法（支持 xxxBefore / xxxAfter 钩子，保留原基类 call 调用链语义）
+ * @param {string} method 方法名
+ * @param {...*} params 参数列表
+ * @returns {Promise<*>} 执行结果
+ */
+Cmd.prototype.call = async function (method, ...params) {
+  if (!this.loaded) {
+    this.loadScript();
+  }
+  var func = this.methods[method];
+  if (typeof func !== 'function') {
+    throw new Error(`方法 ${method} 未注册，请确保脚本已加载`);
+  }
+  var before_func = this.methods[method + 'Before'];
+  if (typeof before_func === 'function') {
+    var before_result = await before_func.call(this, ...params);
+    if (before_result) {
+      return before_result;
+    }
+  }
+  var result = await func.call(this, ...params);
+  var after_func = this.methods[method + 'After'];
+  if (typeof after_func === 'function') {
+    var after_result = await after_func.call(this, result, ...params);
+    if (after_result !== undefined) {
+      result = after_result;
+    }
+  }
+  return result;
+};
+
+/**
+ * 匹配指令
+ *
+ * 支持三种匹配方式:
+ * 1. 正则表达式 - 以 "/" 开头的字符串, 如 "/[0-9]+/"
+ * 2. 语义占位符 - 含 {xxx} 的字符串, 如 "{数字}"、"{日期}"、"{城市}"、"{手机号码}" 等
+ * 3. 纯字符串 - 默认匹配
+ *
+ * 注意: 匹配调用 String.prototype.matchs，由 mm_matchs 提供（需 mm_matchs 环境）
+ *
+ * @param {string} content 消息内容
+ * @returns {string} 匹配返回关键词字符串, 否则返回空字符串
+ */
+Cmd.prototype.match = function (content) {
+  var match_arr = this.config.match;
+  if (!match_arr || match_arr.length === 0) {
+    return '';
+  }
+  var not_arr = this.config.not;
+  if (not_arr && not_arr.length > 0) {
+    for (var i = 0; i < not_arr.length; i++) {
+      if (content.matchs(not_arr[i])) {
+        return '';
+      }
+    }
+  }
+  for (var i = 0; i < match_arr.length; i++) {
+    var ret = content.matchs(match_arr[i]);
+    if (ret) {
+      return ret;
+    }
+  }
+  return '';
+};
+
+/**
+ * 执行指令
+ * @param {object} msg 消息对象
+ * @param {object} db 数据管理器
+ * @returns {object|string} 返回执行结果, 不匹配返回null
+ */
+Cmd.prototype.run = async function (msg, db) {
+  if (!msg || !msg.content) {
+    return null;
+  }
+  // msg.cmd已设置表示会话恢复, 跳过关键字匹配
+  if (!msg.cmd) {
+    if (!this.match(msg.content)) {
+      return null;
+    }
+    msg.cmd = this.config.name;
+  }
+  try {
+    var ret;
+    if (this.config.params) {
+      ret = this._fillParams(msg);
+      if (ret !== null) {
+        return typeof ret === 'string' ? { content: ret } : ret;
+      }
+    }
+    ret = await this.call('main', msg, db);
+    return typeof ret === 'string' ? { content: ret } : ret;
+  } catch (error) {
+    this.log('error', '指令执行失败', error.message);
+    return null;
+  }
+};
+
+/**
+ * 槽位填充
+ *
+ * 遍历 params.properties, 从 msg.content 中提取参数值。
+ * 已填充的参数跳过, 缺失的必填参数返回 question 提示语。
+ * 全部必填项满足时返回 null, 交由 main() 执行。
+ *
+ * @param {object} msg 消息对象
+ * @returns {string|null} 返回追问内容, 全部满足返回null
+ * @private
+ */
+Cmd.prototype._fillParams = function (msg) {
+  var params = this.config.params;
+  if (!params || !params.properties) {
+    return null;
+  }
+  if (!msg.form) {
+    msg.form = {};
+  }
+  var props = params.properties;
+  for (var k in props) {
+    this._tryExtractParam(msg, k, props[k]);
+  }
+  var required = params.required || [];
+  for (var i = 0; i < required.length; i++) {
+    var name = required[i];
+    if (!msg.form[name]) {
+      msg.end = 0;
+      return props[name].tip || props[name].question || '请填写' + name;
+    }
+  }
+  return null;
+};
+
+/**
+ * 尝试从消息中提取单个参数
+ * @param {object} msg 消息对象
+ * @param {string} name 参数名
+ * @param {object} param 参数配置
+ * @private
+ */
+Cmd.prototype._tryExtractParam = function (msg, name, param) {
+  if (msg.form[name]) {
+    return;
+  }
+  if (param.match) {
+    var val = this._cleanVal(msg.content.matchs(param.match), param);
+    if (val) {
+      var match_arr = this.config.match;
+      if (match_arr && match_arr.indexOf(val) !== -1) {
+        return;
+      }
+      msg.form[name] = val;
+    }
+  }
+  if (!msg.form[name] && param.default != null) {
+    msg.form[name] = param.default;
+  }
+};
+
+/**
+ * 清理提取值: 移除多余部分, 枚举验证
+ * @param {string} val 原始提取值
+ * @param {object} param 参数配置
+ * @returns {string} 清理后的值
+ * @private
+ */
+Cmd.prototype._cleanVal = function (val, param) {
+  if (!val) return '';
+  var result = val;
+  if (param.remove && param.remove.length) {
+    for (var i = 0; i < param.remove.length; i++) {
+      result = result.replace(param.remove[i], '');
+    }
+  }
+  if (param.enum && param.enum.length && param.enum.indexOf(result) === -1) {
+    return '';
+  }
+  return result;
+};
+
+module.exports = Cmd;

package/lib/local_cache.js

@@ -0,0 +1,61 @@
+
+
+/**
+ * 内置会话缓存类（替代原框架注入的全局缓存服务，进程内 Map + 过期时间）
+ * @class
+ */
+class LocalCache {
+  /**
+   * 构造函数
+   * @class
+   */
+  constructor() {
+    /**
+     * 缓存存储（key => { value, expire }）
+     * @type {Map}
+     */
+    this.store = new Map();
+  }
+
+  /**
+   * 读取缓存（过期自动删除）
+   * @param {string} key 缓存键
+   * @returns {*} 缓存值，不存在返回 undefined
+   */
+  get(key) {
+    var item = this.store.get(key);
+    if (!item) {
+      return undefined;
+    }
+    if (item.expire && item.expire < Date.now()) {
+      this.store.delete(key);
+      return undefined;
+    }
+    return item.value;
+  }
+
+  /**
+   * 写入缓存
+   * @param {string} key 缓存键
+   * @param {*} value 缓存值
+   * @param {number} timeout 有效期秒数，0 或不传为不过期
+   * @returns {void}
+   */
+  set(key, value, timeout = 0) {
+    this.store.set(key, {
+      value,
+      expire: timeout > 0 ? Date.now() + timeout * 1000 : 0,
+    });
+  }
+
+  /**
+   * 删除缓存
+   * @param {string} key 缓存键
+   * @returns {boolean} 是否删除成功
+   */
+  del(key) {
+    return this.store.delete(key);
+  }
+}
+
+module.exports = LocalCache;