mm_api 1.1.0 → 1.1.1

package/lib/{drive.js → api.js}

@@ -1,7 +1,8 @@
 const fs = require("fs");
 const path = require("path");
-const Item = require("mm_corejs").Base;
-const { string, date } = require("mm_helper");
+const Item = require('mm_machine').Mod;
+const { string, date, object, file } = require("mm_helper");
+const { getRet } = require('mm_ret');
 const Oauth = require("./oauth.js"); // 是MM自带的身份验证机制，基于Oauth2.0，可以不使用
 
 /**
@@ -17,79 +18,14 @@ function loadOptional(id) {
   }
 }
 
-const Param = loadOptional("mm_param/lib/drive.js"); // 是MM自带的参数机制，可以不使用
-const Sql = loadOptional("mm_sql/lib/drive.js"); // 是MM自带的sql机制，可以不使用
+const Param = loadOptional("mm_param/lib/param.js"); // 是MM自带的参数机制，可以不使用
+const Sql = loadOptional("mm_sql/lib/sql.js"); // 是MM自带的sql机制，可以不使用
 
 /** param 实例缓存（模块级，替代原全局 param 模块列表） */
 const PARAM_CACHE = new Map();
 /** sql 实例缓存（模块级，替代原全局 sql 模块列表） */
 const SQL_CACHE = new Map();
 
-/**
- * 补全文件路径（替代原全局路径补全能力，支持相对/绝对路径）
- * @param {string} file 文件路径
- * @param {string} dir 基准目录
- * @returns {string} 完整路径
- */
-function _resolvePath(file, dir) {
-  if (!file) {
-    return process.cwd();
-  }
-  if (path.isAbsolute(file)) {
-    return file;
-  }
-  return path.resolve(dir || process.cwd(), file);
-}
-
-/**
- * 生成XML节点（_toXml 的内部递归辅助）
- * @param {string} name 节点名
- * @param {*} value 节点值
- * @returns {string} XML片段字符串
- */
-function _xmlNode(name, value) {
-  if (value && typeof value === "object") {
-    return "<" + name + ">" + _toXml(value) + "</" + name + ">";
-  }
-  var text = value === undefined || value === null ? "" : String(value);
-  return "<" + name + ">" + text + "</" + name + ">";
-}
-
-/**
- * 对象转XML字符串（替代原全局 toXml 的精简等价实现）
- * @param {object} source 被转换的对象
- * @returns {string} xml格式字符串
- */
-function _toXml(source) {
-  var parts = [];
-  for (var key in source) {
-    var val = source[key];
-    if (Array.isArray(val)) {
-      for (var i = 0; i < val.length; i++) {
-        parts.push(_xmlNode(key, val[i]));
-      }
-    } else {
-      parts.push(_xmlNode(key, val));
-    }
-  }
-  return parts.join("");
-}
-
-/**
- * 构建错误响应体（替代原全局 ret.error，默认 json-rpc 形态）
- * @param {number} code 错误码
- * @param {string} message 错误信息
- * @returns {object} 形如 { error: { code, message } } 的响应体
- */
-function _retError(code, message) {
-  return {
-    error: {
-      code,
-      message,
-    },
-  };
-}
-
 /**
  * 去除 JSON 文本中的注释（支持 // 与整块注释，不处理字符串内部）
  * @param {string} text 原始文本
@@ -169,7 +105,7 @@ function _readJsonConfig(file) {
  * @augments {Item}
  * @class
  */
-class Drive extends Item {
+class Api extends Item {
   static config = {
     // 应用名称 例如：demo_app
     app: "server",
@@ -223,7 +159,7 @@ class Drive extends Item {
    * @class
    */
   constructor(config, parent) {
-    super({ ...Drive.config, ...config });
+    super({ ...Api.config, ...config });
 
     // 父级管理器引用（用于缓存、插件与默认配置回退）
     this.parent = parent || null;
@@ -239,7 +175,7 @@ class Drive extends Item {
 /**
  * 预设配置
  */
-Drive.prototype._preset = function () {
+Api.prototype._preset = function () {
   this.save_dir = "./static/file/";
   this.url_path = "/file/";
 
@@ -260,7 +196,7 @@ Drive.prototype._preset = function () {
  * 获取驱动目录（方案B：来自手动配置的 dir，替代旧基类 getDir）
  * @returns {string} 驱动目录
  */
-Drive.prototype.getDir = function () {
+Api.prototype.getDir = function () {
   return this.config.dir || __dirname;
 };
 
@@ -270,7 +206,7 @@ Drive.prototype.getDir = function () {
  * @returns {object|null} 配置对象，文件不存在或解析失败返回 null
  * @private
  */
-Drive.prototype._loadJsonConfig = function (file) {
+Api.prototype._loadJsonConfig = function (file) {
   if (!fs.existsSync(file)) {
     this.log("warn", "配置文件不存在", file);
     return null;
@@ -288,7 +224,7 @@ Drive.prototype._loadJsonConfig = function (file) {
  * @returns {object|null} 缓存实例；未配置返回 null
  * @private
  */
-Drive.prototype._getCache = function () {
+Api.prototype._getCache = function () {
   var fn = this.config.get_cache;
   if (typeof fn !== "function" && this.parent) {
     fn = this.parent.config.get_cache;
@@ -300,7 +236,7 @@ Drive.prototype._getCache = function () {
  * 设置参数对象（写入模块级缓存，替代原全局 param 模块列表）
  * @param {object} param 参数对象
  */
-Drive.prototype.updateParam = function (param) {
+Api.prototype.updateParam = function (param) {
   PARAM_CACHE.set(param.config_file, param);
 };
 
@@ -309,7 +245,7 @@ Drive.prototype.updateParam = function (param) {
  * @param {string} file 文件名
  * @returns {object} 获取的对象
  */
-Drive.prototype.getParam = function (file) {
+Api.prototype.getParam = function (file) {
   return PARAM_CACHE.get(file) || null;
 };
 
@@ -318,11 +254,11 @@ Drive.prototype.getParam = function (file) {
  * @param {string} file_path 参数文件路径
  * @returns {object|null} 参数驱动实例，未配置或加载失败返回 null
  */
-Drive.prototype._loadParam = function (file_path) {
+Api.prototype._loadParam = function (file_path) {
   if (!file_path || !Param) {
     return null;
   }
-  var p = _resolvePath(file_path, this.getDir());
+  var p = file.fullname(file_path, this.getDir());
   var param = this.getParam(p);
   if (param) {
     this.param = param;
@@ -345,7 +281,7 @@ Drive.prototype._loadParam = function (file_path) {
  * @param {string} sql.config_file 文件名
  * @param {object} sql.sql  sql语句
  */
-Drive.prototype.updateSql = function (sql) {
+Api.prototype.updateSql = function (sql) {
   SQL_CACHE.set(sql.config_file, sql);
 };
 
@@ -354,7 +290,7 @@ Drive.prototype.updateSql = function (sql) {
  * @param {string} file 文件名
  * @returns {object} 获取的对象
  */
-Drive.prototype.getSql = function (file) {
+Api.prototype.getSql = function (file) {
   return SQL_CACHE.get(file) || null;
 };
 
@@ -363,11 +299,11 @@ Drive.prototype.getSql = function (file) {
  * @param {string} file_path sql模板文件路径
  * @returns {object|null} sql驱动实例，未配置或加载失败返回 null
  */
-Drive.prototype._loadSql = function (file_path) {
+Api.prototype._loadSql = function (file_path) {
   if (!file_path || !Sql) {
     return null;
   }
-  var p = _resolvePath(file_path, this.getDir());
+  var p = file.fullname(file_path, this.getDir());
   var sql = this.getSql(p);
   if (sql) {
     this.sql = sql;
@@ -388,7 +324,7 @@ Drive.prototype._loadSql = function (file_path) {
 /**
  * 加载身份验证配置
  */
-Drive.prototype._loadOauth = function () {
+Api.prototype._loadOauth = function () {
   var cg = this.config.oauth;
   if (cg) {
     this.oauth = new Oauth({
@@ -406,19 +342,19 @@ Drive.prototype._loadOauth = function () {
  * @returns {string|null} 脚本文件路径，未配置返回null
  * @private
  */
-Drive.prototype._getScriptFile = function () {
+Api.prototype._getScriptFile = function () {
   var main = this.config.main || "";
   if (!main) {
     return null;
   }
-  return _resolvePath(main, this.getDir());
+  return file.fullname(main, this.getDir());
 };
 
 /**
  * 脚本是否已加载（方案B：替代旧基类 isLoaded 机制）
  * @returns {boolean} 是否已加载
  */
-Drive.prototype.isLoaded = function () {
+Api.prototype.isLoaded = function () {
   return this._loaded;
 };
 
@@ -426,7 +362,7 @@ Drive.prototype.isLoaded = function () {
  * 加载主脚本文件（方案B：标准 require，替代旧基类 do("load") 与热重载模式）
  * @returns {object|null} 加载的模块对象
  */
-Drive.prototype.load = function () {
+Api.prototype.load = function () {
   var file = this._getScriptFile();
   if (!file || !fs.existsSync(file)) {
     return null;
@@ -446,7 +382,7 @@ Drive.prototype.load = function () {
  * @param {object} mod 模块对象
  * @private
  */
-Drive.prototype._setMainMethod = function (mod) {
+Api.prototype._setMainMethod = function (mod) {
   if (!mod) {
     return;
   }
@@ -469,7 +405,7 @@ Drive.prototype._setMainMethod = function (mod) {
  * @param {string} files.file 上传的文件对象
  * @returns {object} 返回文件路径和URL
  */
-Drive.prototype.saveFile = function (files) {
+Api.prototype.saveFile = function (files) {
   var file;
   var url;
   if (files.file) {
@@ -477,7 +413,7 @@ Drive.prototype.saveFile = function (files) {
     // 安全处理文件名: 移除路径穿越字符和特殊字符
     var name = f.name || f.originalFilename;
     name = name.replace(/[\\/]|\.\./g, "_");
-    file = _resolvePath("./" + name, this.save_dir);
+    file = file.fullname("./" + name, this.save_dir);
     fs.mkdirSync(path.dirname(file), { recursive: true });
     // 创建写入流
     var read_stream = fs.createReadStream(f.filepath);
@@ -513,7 +449,7 @@ Drive.prototype.saveFile = function (files) {
  * @returns {object|null} 登录态与用户信息
  * @private
  */
-Drive.prototype._getState = async function (db, token) {
+Api.prototype._getState = async function (db, token) {
   var db1 = db.new("user_state", "user_id");
   var state = await db1.getObj(
     {
@@ -552,10 +488,10 @@ Drive.prototype._getState = async function (db, token) {
  * @param {object} db 数据管理器
  * @returns {object} 执行结果
  */
-Drive.prototype.getLoginState = async function (ctx, options) {
+Api.prototype.getLoginState = async function (params, ctx, options) {
   var o = await this._getUserFromSession(ctx);
   if (!o) {
-    o = await this._getUserFromToken(ctx, options);
+    o = await this._getUserFromToken(params, ctx, options);
   }
   return this._processUserInfo(o);
 };
@@ -566,7 +502,7 @@ Drive.prototype.getLoginState = async function (ctx, options) {
  * @returns {object|null} 用户信息
  * @private
  */
-Drive.prototype._getUserFromSession = function (ctx) {
+Api.prototype._getUserFromSession = function (ctx) {
   var u = ctx.session?.user;
   if (u) {
     var o = { ...u };
@@ -583,7 +519,7 @@ Drive.prototype._getUserFromSession = function (ctx) {
  * @returns {object|null} 用户信息
  * @private
  */
-Drive.prototype._getUserFromToken = async function (ctx, options) {
+Api.prototype._getUserFromToken = async function (params, ctx, options) {
   var token = ctx.headers[this.config.token_key];
   if (!token) {
     return null;
@@ -607,7 +543,7 @@ Drive.prototype._getUserFromToken = async function (ctx, options) {
  * @returns {object|null} 用户信息
  * @private
  */
-Drive.prototype._processUserFromCache = async function (u, ctx, options, token) {
+Api.prototype._processUserFromCache = async function (u, ctx, options, token) {
   var o;
   if (typeof u === "string") {
     o = { ...string.toJson(u) };
@@ -628,12 +564,12 @@ Drive.prototype._processUserFromCache = async function (u, ctx, options, token)
  * 从数据库中获取用户信息
  * @param {string} token token
  * @param {object} ctx 请求上下文
- * @param {object} db 数据管理器
+ * @param {object} options 数据管理器
  * @returns {object|null} 用户信息
  * @private
  */
-Drive.prototype._getUserFromDb = async function (token, ctx, options) {
-  var obj = await this._getState(db, token);
+Api.prototype._getUserFromDb = async function (token, ctx, options) {
+  var obj = await this._getState(options, token);
   if (obj) {
     var o = { ...obj.user };
     ctx.session.user = obj.user;
@@ -650,7 +586,7 @@ Drive.prototype._getUserFromDb = async function (token, ctx, options) {
  * @returns {object|null} 处理后的用户信息
  * @private
  */
-Drive.prototype._processUserInfo = function (o) {
+Api.prototype._processUserInfo = function (o) {
   if (o) {
     o.password_pay = o.password_pay ? "******" : "";
     o.password = o.password ? "******" : "";
@@ -663,22 +599,22 @@ Drive.prototype._processUserInfo = function (o) {
 /**
  * 获取登录态
  * @param {object} ctx 请求上下文
- * @param {object} db 数据管理器
+ * @param {object} options 数据管理器
  * @returns {object} 执行结果
  */
-Drive.prototype.before = async function (ctx, options) {
+Api.prototype.before = async function (params, ctx, options) {
   if (this.config.oauth && this.config.oauth.sign_in) {
-    db.user = await this.getLoginState(ctx, options);
+    options.user = await this.getLoginState(params, ctx, options);
   }
 };
 
 /**
  * 主要函数
  * @param {object} ctx 请求上下文
- * @param {object} db 数据管理器
+ * @param {object} options 数据管理器
  * @returns {object} 执行结果
  */
-Drive.prototype.main = async function (ctx, options) {
+Api.prototype.main = async function (params, ctx, options) {
   if (this.sql) {
     var req = ctx.request;
     // 获取文件
@@ -687,10 +623,10 @@ Drive.prototype.main = async function (ctx, options) {
       req.body.file = fobj.file;
       req.body.url = fobj.url;
     }
-    var ret = await this.sql.run(req.query, req.body, db);
+    var ret = await this.sql.run(req.query, req.body, options);
     return ret;
   } else {
-    return _retError(10000, "接口函数未定义");
+    return getRet().error(10000, "接口函数未定义");
   }
 };
 
@@ -700,7 +636,7 @@ Drive.prototype.main = async function (ctx, options) {
  * @param {object} db 数据管理器
  * @returns {object} 执行结果
  */
-Drive.prototype.run = async function (ctx, options) {
+Api.prototype.run = async function (params, ctx, options) {
   try {
     var body = await this.getCache(ctx);
     if (!body) {
@@ -709,14 +645,14 @@ Drive.prototype.run = async function (ctx, options) {
       if (md !== req.method && md !== "ALL") {
         return null;
       }
-      await this.before(ctx, options);
-      var ret = await this.check(ctx, options);
+      await this.before(params, ctx, options);
+      var ret = await this.check(params, ctx, options);
       if (!ret) {
         try {
-          ret = await this.main(ctx, options);
+          ret = await this.main(params, ctx, options);
         } catch (err) {
           this.log("error", "脚本文件错误", req.path, err);
-          ret = _retError(10000, "脚本文件错误：" + err.toString());
+          ret = getRet().error(10000, "脚本文件错误：" + err.toString());
         }
       }
       var res = ctx.response;
@@ -734,7 +670,7 @@ Drive.prototype.run = async function (ctx, options) {
  * @param {object} ctx 请求上下文
  * @returns {string} 响应内容
  */
-Drive.prototype.getCache = async function (ctx) {
+Api.prototype.getCache = async function (ctx) {
   var cg = this.config;
   if (cg.cache) {
     var req = ctx.request;
@@ -769,7 +705,7 @@ Drive.prototype.getCache = async function (ctx) {
  * @param {object} body 正文参数
  * @param {string} type 响应类型
  */
-Drive.prototype.setCache = async function (ctx, body, type = null) {
+Api.prototype.setCache = async function (ctx, body, type = null) {
   var cg = this.config;
   if (cg.cache && ctx.method === "GET") {
     if (cg.client_cache) {
@@ -796,7 +732,7 @@ Drive.prototype.setCache = async function (ctx, body, type = null) {
  * @param {string} t 请求类型
  * @returns {string} 处理后的响应结果
  */
-Drive.prototype.body = function (result, res, t) {
+Api.prototype.body = function (result, res, t) {
   var ret = result;
   var type = res.type;
   if (!ret) {
@@ -821,7 +757,7 @@ Drive.prototype.body = function (result, res, t) {
  * @returns {string} 处理后的类型
  * @private
  */
-Drive.prototype._handleObjectType = function (res, type, t) {
+Api.prototype._handleObjectType = function (res, type, t) {
   var new_type = type;
   if (!new_type) {
     new_type = t.indexOf("xml") !== -1 ? t : "application/json; charset=utf-8";
@@ -839,7 +775,7 @@ Drive.prototype._handleObjectType = function (res, type, t) {
  * @returns {string} 标准化后的类型
  * @private
  */
-Drive.prototype._normType = function (type) {
+Api.prototype._normType = function (type) {
   if (type.indexOf("json") !== -1) {
     return "application/json; charset=utf-8";
   } else if (type.indexOf("html") !== -1) {
@@ -857,8 +793,8 @@ Drive.prototype._normType = function (type) {
  * @returns {string} 转换后的字符串
  * @private
  */
-Drive.prototype._convertObject = function (obj, type) {
-  return type.indexOf("/xml") !== -1 ? _toXml(obj) : JSON.stringify(obj);
+Api.prototype._convertObject = function (obj, type) {
+  return type.indexOf("/xml") !== -1 ? object.toXml(obj) : JSON.stringify(obj);
 };
 
 /**
@@ -868,7 +804,7 @@ Drive.prototype._convertObject = function (obj, type) {
  * @param {string} str 字符串
  * @private
  */
-Drive.prototype._handleStringType = function (res, type, str) {
+Api.prototype._handleStringType = function (res, type, str) {
   if (!type) {
     if (
       (str.startsWith("{") && str.endsWith("}")) ||
@@ -892,17 +828,21 @@ Drive.prototype._handleStringType = function (res, type, str) {
  * @param {string} method 方法
  * @returns {object} 验证结果
  */
-Drive.prototype.checkParam = function (query, body, method) {
+Api.prototype.checkParam = function (query, body, method) {
   if (this.param) {
     var msg = this.param.check(query, body, method);
     if (msg) {
       var code;
-      if (msg.indexOf("必须") !== -1 || msg.indexOf("为空") !== -1) {
+      if (
+        msg.indexOf("必须") !== -1 ||
+        msg.indexOf("必填") !== -1 ||
+        msg.indexOf("为空") !== -1
+      ) {
         code = 30001;
       } else {
         code = 30002;
       }
-      return _retError(code, msg);
+      return getRet().error(code, msg);
     }
   }
   return null;
@@ -910,10 +850,12 @@ Drive.prototype.checkParam = function (query, body, method) {
 
 /**
  * 验证参数
+ * @param {object} params 请求参数
  * @param {object} ctx 内容上下文
+ * @param {object} options 事件运行选项
  * @returns {object} 验证结果
  */
-Drive.prototype.check = async function (ctx) {
+Api.prototype.check = async function (params, ctx, options) {
   var error;
   if (this.config.check_param) {
     var req = ctx.request;
@@ -935,7 +877,7 @@ Drive.prototype.check = async function (ctx) {
  * @param {object} ctx 内容上下文
  * @returns {object} 验证结果
  */
-Drive.prototype.checkOauth = async function (ctx) {
+Api.prototype.checkOauth = async function (ctx) {
   var aouth = this.oauth;
   if (aouth) {
     return await aouth.check(ctx);
@@ -950,7 +892,7 @@ Drive.prototype.checkOauth = async function (ctx) {
  * @param {string} name 插件名称
  * @returns {object} 返回获取到的插件
  */
-Drive.prototype.plugin = function (app, name) {
+Api.prototype.plugin = function (app, name) {
   var l = path.sep;
   var dir = this.config.dir || "";
   var app_name = app || string.between(dir, "app" + l, l);
@@ -968,7 +910,7 @@ Drive.prototype.plugin = function (app, name) {
  * @param {string} type 模型类型
  * @returns {object} 返回获取到的模型
  */
-Drive.prototype.getModel = function (type) {
+Api.prototype.getModel = function (type) {
   let model = { ...this.config };
   let dir = this.getDir();
   let l = path.sep;
@@ -982,4 +924,4 @@ Drive.prototype.getModel = function (type) {
   return model;
 };
 
-module.exports = Drive;
+module.exports = Api;