mm_machine 2.9.3 → 2.9.5

package/dir_scanner.js

@@ -0,0 +1,262 @@
+var fs = require('fs');
+var path = require('path');
+
+/**
+ * DirScanner 目录检索器
+ * 独立工具类，负责扫描目录查找 JSON 配置文件
+ * 不依赖 Manager 或 Registry，可独立使用
+ */
+class DirScanner {
+  /**
+   * 构造函数
+   * @param {object} [cfg] 配置参数
+   * @param {number} [cfg.cache_ttl=30000] 缓存有效期（毫秒），默认 30 秒
+   */
+  constructor(cfg) {
+    var opts = cfg || {};
+    this._cache = new Map();
+    this._cache_ttl = opts.cache_ttl || 30000;
+  }
+}
+
+/**
+ * 规范化扫描参数
+ * 处理参数重载：options 可选，force 可以是第三个参数
+ * @param {object|boolean} opts_in 配置对象或 force 标志
+ * @param {boolean} force_in force 标志
+ * @returns {{options: object, force: boolean}} 规范化后的参数对象
+ * @private
+ */
+DirScanner.prototype._normScanOpts = function (opts_in, force_in) {
+  var opts = opts_in;
+  var force = force_in;
+  if (typeof opts === 'boolean') {
+    force = opts;
+    opts = null;
+  }
+  return { options: opts || {}, force: force || false };
+};
+
+/**
+ * 获取缓存结果
+ * @param {string} key 缓存键
+ * @returns {Array|null} 缓存结果，不存在或已过期返回 null
+ * @private
+ */
+DirScanner.prototype._getCache = function (key) {
+  var entry = this._cache.get(key);
+  if (!entry) return null;
+  if (Date.now() - entry.time > this._cache_ttl) {
+    this._cache.delete(key);
+    return null;
+  }
+  return entry.results;
+};
+
+/**
+ * 设置缓存
+ * @param {string} key 缓存键
+ * @param {Array} results 扫描结果
+ * @private
+ */
+DirScanner.prototype._setCache = function (key, results) {
+  this._cache.set(key, { results: results, time: Date.now() });
+};
+
+/**
+ * 递归扫描指定目录，查找匹配的 JSON 配置文件
+ * @param {string} dir 要扫描的目录路径
+ * @param {string} pattern 文件匹配模式（如 '*.json'）
+ * @param {object} [opts_in] 可选项
+ * @param {string[]} [opts_in.exclude=['node_modules', '.git']] 排除的目录名列表
+ * @param {Function} [opts_in.filter] 自定义过滤器，接收 {file, name} 对象，返回 true 表示保留
+ * @param {boolean} [force_in] 是否强制重新扫描（忽略缓存）
+ * @returns {Array<{file: string, name: string}>} 扫描结果数组
+ */
+DirScanner.prototype.scanDir = function (dir, pattern, opts_in, force_in) {
+  if (typeof dir !== 'string' || !dir) {
+    throw new TypeError('目录路径必须是字符串');
+  }
+  if (typeof pattern !== 'string' || !pattern) {
+    throw new TypeError('文件匹配模式必须是字符串');
+  }
+
+  var opts = this._normScanOpts(opts_in, force_in);
+  var force = opts.force;
+  var options = opts.options;
+
+  // 缓存检查
+  var cache_key = dir + '::' + pattern;
+  if (!force) {
+    var cached = this._getCache(cache_key);
+    if (cached) return cached;
+  }
+
+  var exclude = options.exclude || ['node_modules', '.git'];
+  var filter = options.filter || null;
+  var results = [];
+  var abs_dir = path.resolve(dir);
+
+  // 检查目录是否存在
+  if (!fs.existsSync(abs_dir)) {
+    return results;
+  }
+
+  this._scanDirRecu(abs_dir, pattern, exclude, filter, results);
+
+  // 设置缓存
+  this._setCache(cache_key, results);
+  return results;
+};
+
+/**
+ * 递归扫描目录内部方法
+ * @param {string} dir 当前目录
+ * @param {string} pattern 匹配模式
+ * @param {string[]} exclude 排除目录
+ * @param {Function|null} filter 自定义过滤器
+ * @param {Array} results 结果数组
+ * @private
+ */
+DirScanner.prototype._scanDirRecu = function (dir, pattern, exclude, filter, results) {
+  var items;
+  try {
+    // eslint-disable-next-line mm_eslint/variable-name
+    items = fs.readdirSync(dir, { withFileTypes: true });
+  } catch {
+    return;
+  }
+
+  for (var i = 0; i < items.length; i++) {
+    var item = items[i];
+    var cur_path = path.join(dir, item.name);
+
+    if (item.isDirectory()) {
+      // 跳过排除目录
+      if (exclude.indexOf(item.name) !== -1) {
+        continue;
+      }
+      this._scanDirRecu(cur_path, pattern, exclude, filter, results);
+    } else if (item.isFile()) {
+      // 检查文件是否匹配模式
+      if (!this._matchPattern(item.name, pattern)) {
+        continue;
+      }
+
+      var name = this._extractName(cur_path);
+      var entry = { file: cur_path, name: name };
+
+      // 应用自定义过滤器
+      if (filter) {
+        if (!filter(entry)) {
+          continue;
+        }
+      }
+
+      results.push(entry);
+    }
+  }
+};
+
+/**
+ * 检查文件名是否匹配模式
+ * @param {string} filename 文件名
+ * @param {string} pattern 匹配模式（如 *.json）
+ * @returns {boolean} 是否匹配
+ * @private
+ */
+DirScanner.prototype._matchPattern = function (filename, pattern) {
+  // 简单通配符匹配
+  if (pattern === '*') return true;
+  if (pattern === '*' + path.extname(filename)) return true;
+  if (pattern === filename) return true;
+
+  // 将 * 转换为正则
+  var regex_str = '^' + pattern.replace(/\./g, '\\.').replace(/\*/g, '.*') + '$';
+  return new RegExp(regex_str).test(filename);
+};
+
+/**
+ * 从 JSON 文件提取 name
+ * 优先读取 JSON 文件中的 name 字段，失败则从文件名去扩展名
+ * @param {string} file_path 文件路径
+ * @returns {string} 模块名称
+ * @private
+ */
+DirScanner.prototype._extractName = function (file_path) {
+  try {
+    var content = fs.readFileSync(file_path, 'utf8');
+    var config = JSON.parse(content);
+    if (config && config.name) {
+      return config.name;
+    }
+  } catch {
+    // JSON 解析失败，忽略
+  }
+  // 从文件名去扩展名
+  return path.basename(file_path, path.extname(file_path));
+};
+
+/**
+ * 扫描并解析 JSON 配置文件
+ * @param {string} dir 要扫描的目录路径
+ * @param {string} pattern 文件匹配模式
+ * @param {object} [options] 可选项（同 scanDir）
+ * @param {boolean} [force] 是否强制重新扫描
+ * @returns {Array<{file: string, config: object}>} 扫描结果数组，JSON 解析失败时跳过该文件
+ */
+DirScanner.prototype.scanAndParse = function (dir, pattern, options, force) {
+  var files = this.scanDir(dir, pattern, options, force);
+  var results = [];
+
+  for (var i = 0; i < files.length; i++) {
+    var entry = files[i];
+    try {
+      var content = fs.readFileSync(entry.file, 'utf8');
+      var config = JSON.parse(content);
+      results.push({ file: entry.file, config: config });
+    } catch {
+      // JSON 解析失败时跳过该文件
+      continue;
+    }
+  }
+
+  return results;
+};
+
+/**
+ * 扫描目录并一键注册到 Manager
+ * @param {string} dir 要扫描的目录路径
+ * @param {object} manager Manager 实例
+ * @param {boolean} [force] 是否强制重新扫描
+ * @returns {number} 成功注册的模块数量
+ */
+DirScanner.prototype.scanAndRegister = function (dir, manager, force) {
+  if (!manager || typeof manager.registerMod !== 'function') {
+    throw new TypeError('manager 必须包含 registerMod 方法');
+  }
+  var entries = this.scanAndParse(dir, '*.json', null, force);
+  var count = 0;
+
+  for (var i = 0; i < entries.length; i++) {
+    var entry = entries[i];
+    try {
+      manager.registerMod(entry.file, entry.config);
+      count++;
+    } catch {
+      // 单个模块注册失败不影响其他模块
+      continue;
+    }
+  }
+
+  return count;
+};
+
+/**
+ * 清除所有扫描缓存
+ */
+DirScanner.prototype.clearCache = function () {
+  this._cache.clear();
+};
+
+module.exports = { DirScanner };