mm_os 2.9.1 → 2.9.3

package/core/com/plugin/script.js

@@ -1,5 +1,5 @@
 /**
- * @fileOverview {0}
+ * @fileOverview {0}
  * @author <a href="作者主页地址">插件作者</a>
  * @version 1.0
  */
@@ -9,87 +9,119 @@
  */
 module.exports = {
 	/**
-	 * 初始化
+	 * 安装，把插件安装到系统中，在安装时执行
 	 * @param {Object} option 配置参数
-	 * @return {String} 成功返回null, 否则返回错误提示
+	 * @param {String} option.path 插件安装路径
+	 * @param {Object} option.config 插件配置信息
+	 * @param {String} option.version 插件版本号
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：路径不存在、版本不兼容、依赖缺失等
 	 */
-	init(option) {
+	install(option) {
 		var msg = null;
+		// 此处常用于更新文件和导入数据库等操作。通常为一次操作
 		return msg;
 	},
-
 	/**
-	 * 安装
+	 * 加载插件，当脚本被引入时会执行
 	 * @param {Object} option 配置参数
-	 * @return {String} 成功返回null,否则返回错误提示
+	 * @return {String} 成功返回null, 否则返回错误提示。常见错误：依赖模块加载失败、模块冲突等
 	 */
-	install(option) {
+	load(option) {
 		var msg = null;
+		// 此处通常用于require加载其他相关模块（不在脚本文件中直接require模块,可提高启动速度，可根据插件优先级优先加载模块）
 		return msg;
 	},
-
 	/**
-	 * 卸载
+	 * 初始化插件，设置全局变量、路由规则和定时任务等
 	 * @param {Object} option 配置参数
-	 * @return {String} 成功返回null,否则返回错误提示
+	 * @return {String} 成功返回null, 否则返回错误提示。常见错误：配置格式错误、路由冲突等
 	 */
-	uninstall(option) {
+	init(option) {
 		var msg = null;
+		// 此处主要用于重置全局变量和配置，更新路由和更新定时任务等操作
 		return msg;
 	},
 
 	/**
-	 * 更新
+	 * 启动插件，开启路由监听和定时任务
 	 * @param {Object} option 配置参数
-	 * @return {String} 成功返回null, 否则返回错误提示
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：端口被占用、服务启动超时等
 	 */
-	update(option) {
+	start(option) {
 		var msg = null;
+		// 此处主要用于开启路由和定时任务
 		return msg;
 	},
-
 	/**
-	 * 启动
-	 * @param {Object} opiton 配置参数
-	 * @return {String} 成功返回null,否则返回错误提示
+	 * 重启插件，在配置更改或插件更新时执行
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：重启超时、服务未完全停止等
 	 */
-	start(option) {
+	restart(option) {
 		var msg = null;
+		this.stop();
+		this.start();
 		return msg;
 	},
-
 	/**
-	 * 暂停
-	 * @param {Object} opiton 配置参数
-	 * @return {String} 成功返回null,否则返回错误提示
+	 * 暂停插件，临时停止路由和定时任务的执行
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：有未完成的任务、停止超时等
 	 */
 	stop(option) {
 		var msg = null;
+		// 此处主要用于关闭路由和定时任务
 		return msg;
 	},
 	/**
-	 * 重启，如果插件处于开启状态，当配置发生更改时或插件更新时会执行重启
+	 * 结束插件，清理路由、定时任务和连接
 	 * @param {Object} option 配置参数
-	 * @return {String} 成功返回null,否则返回错误提示
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：资源释放失败、清理超时等
 	 */
-	restart(option) {
+	end(option) {
 		var msg = null;
-		this.stop();
-		this.start();
+		// 主要用于移除注册的路由、 定时任务连接
 		return msg;
 	},
 	/**
-	 * 结束
-	 * @param {Object} opiton 配置参数
-	 * @return {String} 成功返回null,否则返回错误提示
+	 * 卸载已加载的模块，释放内存资源
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：模块正在使用、依赖关系阻止卸载等
 	 */
-	end(option) {
+	unload(option) {
+		var msg = null;
+		// 主要用于移除加载的模块，释放内存（卸载require的模块,降低系统运行内存）
+		return msg;
+	},
+	/**
+	 * 插件版本更新，包括下载、安装和重启
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null, 否则返回错误提示。常见错误：网络问题、版本冲突、空间不足等
+	 */
+	update(option) {
+		var msg = null;
+		// 下载最新版本，重新安装、重新加载并初始化，如果本身程序属于启动状态，将重新启动
+		this.install(option);
+		if (this.config.state == 1) {
+			this.load(option);
+			this.init(option);
+			this.start(option);
+		}
+		return msg;
+	},
+	/**
+	 * 卸载插件，完全移除插件及其相关资源
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：文件删除失败、数据库清理失败等
+	 */
+	uninstall(option) {
 		var msg = null;
+		// 此处从系统中完全删除程序及其所有相关文件和配置。卸载后，该插件不会在系统中留下任何痕迹‌
 		return msg;
 	},
 	/**
-	 * 更新配置后，当用户在后台更改配置时触发
-	 * @param {Object} options
+	 * 配置更新后的处理函数
+	 * @param {Object} options 更新后的配置对象
 	 */
 	update_options_after(options) {
 		if (this.config.state) {
@@ -97,9 +129,13 @@ module.exports = {
 		}
 	},
 	/**
-	 * 插件
-	 * @param {String} item 插件项
-	 * @return {Object} 旗下插件和信息
+	 * 获取插件使用帮助信息
+	 * @param {String} item 查询的功能项，如"install"、"api"等
+	 * @return {Object} 返回帮助信息对象
+	 * @example
+	 * // 获取安装相关帮助
+	 * help("install") 
+	 * // 返回: {title: "安装说明", steps: ["步骤1...", "步骤2..."], examples: [...]}
 	 */
 	help(item) {
 		var tip = "";
@@ -113,10 +149,13 @@ module.exports = {
 	},
 
 	/**
-	 * 主程序
-	 * @param {Object} param1 参数1
-	 * @param {Object} param2 参数2
-	 * @return {Object} 返回执行结果
+	 * 插件主程序，处理核心业务逻辑
+	 * @param {Object} param1 业务参数对象
+	 * @param {Object} param2 配置参数对象
+	 * @return {Object} 返回执行结果对象 {code: 0, msg: "success", data: {}}
+	 * @example
+	 * main({action: "process", data: {id: 1}}, {options: {async: true}})
+	 * // 返回: {code: 0, msg: "处理成功", data: {result: "..."}} 
 	 */
 	main(param1, param2) {
 		var ret = null;
@@ -124,9 +163,12 @@ module.exports = {
 	},
 
 	/**
-	 * 指令（类似命令提示符）
-	 * @param {String} content 指令内容
-	 * @return {String} 执行结果
+	 * 执行命令行指令
+	 * @param {String} content 指令内容，格式为"命令 参数1 参数2..."
+	 * @return {String} 执行结果文本
+	 * @example
+	 * cmd("status --detail") 
+	 * // 返回: "运行状态: 正常\n内存使用: 80MB\n已运行时间: 2h"
 	 */
 	cmd(content) {
 		var ret = "";
@@ -134,10 +176,16 @@ module.exports = {
 	},
 
 	/**
-	 * API接口（用于其他插件调用该插件时）
-	 * @param {Object} ctx HTTP上下文
-	 * @param {Object} db 数据库管理器
-	 * @return {Object} 执行结果
+	 * 插件API接口，供其他插件调用
+	 * @param {Object} ctx HTTP上下文对象
+	 * @param {String} ctx.method 请求方法
+	 * @param {Object} ctx.query 查询参数
+	 * @param {Object} ctx.body 请求体数据
+	 * @param {Object} db 数据库管理器实例
+	 * @return {Object} 返回API执行结果 {code: 200, data: {}, msg: ""}
+	 * @example
+	 * api({method: "GET", query: {id: 1}}, db)
+	 * // 返回: {code: 200, data: {name: "test"}, msg: "success"}
 	 */
 	api(ctx, db) {
 		var ret = "";
@@ -145,15 +193,18 @@ module.exports = {
 	},
 
 	/**
-	 * 聊天（通过聊天的方式驱动插件, 用于机器人开发）
-	 * @param {String} from_user 发送消息人
-	 * @param {String} to_user 接收消息人
-	 * @param {String} content 内容
-	 * @param {String} group 群组 如果是个人，群组为空
-	 * @param {Number} type 群类型, 1永久会话/群、2临时会话/群
-	 * @param {String} msg_type 消息类型, event事件型、message消息型。默认消息型
-	 * @param {Object} 数据管理器
-	 * @return {String} 回复内容
+	 * 聊天消息处理函数，用于机器人开发
+	 * @param {String} from_user 发送消息用户的唯一标识
+	 * @param {String} to_user 接收消息用户的唯一标识
+	 * @param {String} content 消息内容
+	 * @param {String} group 群组ID，个人聊天时为空
+	 * @param {Number} type 会话类型: 1-永久会话/群、2-临时会话/群
+	 * @param {String} msg_type 消息类型: event-事件消息、message-普通消息(默认)
+	 * @param {Object} db 数据管理器实例
+	 * @return {String} 回复消息内容
+	 * @example
+	 * chat("user1", "user2", "你好", "", 1, "message", db)
+	 * // 返回: "你好，我是智能助手，有什么可以帮你的吗？"
 	 */
 	async chat(from_user, to_user, group, content, type, msg_type, db) {
 		var ret = "";

package/core/com/rpc/com.json

@@ -0,0 +1,4 @@
+{
+	"name": "rpc通讯管理器",
+	"script": "./index.js"
+}

package/core/com/rpc/drive.js

@@ -0,0 +1,160 @@
+const Item = require('mm_machine').Item;
+
+/**
+ * Api接口驱动类
+ * @extends {Item}
+ * @class
+ */
+class Drive extends Item {
+	/**
+	 * 构造函数
+	 * @param {String} dir 当前目录
+	 * @constructor
+	 */
+	constructor(dir) {
+		/**
+		 * 定义当前RPC文件路径
+		 */
+		this.rpc_file_now = "";
+		
+		/**
+		 * 定义rpc 方法
+		 */
+		this.methods = {};
+	}
+}
+
+/**
+ * 获取现有参数
+ * @param {String} file 文件名
+ * @return {Object} 获取的对象
+ */
+Drive.prototype.getParam = function(file) {
+	if ($.param) {
+		var obj = $.param.list.getObj({
+			filename: file
+		});
+		if (obj) {
+			return obj;
+		}
+	}
+	return null;
+};
+
+/**
+ * 设置参数对象
+ * @param {Object} param 参数对象
+ */
+Drive.prototype.setParam = function(param) {
+	if ($.param) {
+		var lt = $.param.list;
+		if (lt) {
+			var has = false;
+			var len = lt.length;
+			for (var i = 0; i < len; i++) {
+				var o = lt[i];
+				if (param.filename === o.filename) {
+					$.param.list[i] = param;
+					has = true;
+					break;
+				}
+			}
+			if (!has) {
+				$.param.list.push(param);
+			}
+		}
+	}
+};
+
+/**
+ * 加载参数
+ * @param {String} file_path 文件路径
+ */
+Drive.prototype.loadParam = async function(file_path) {
+	if (file_path) {
+		var p = file_path.fullname(this.dir);
+		var param = this.getParam(p);
+		if (param) {
+			this.param = param;
+		} else {
+			this.param = new Param(this.dir);
+			await this.param.exec('load_config', p);
+			this.setParam(this.param);
+			this.param.load('load');
+		}
+	}
+};
+
+/**
+ * 加载完成后执行
+ */
+Drive.prototype.load_after = function() {
+	var cg = this.config;
+	this.loadParam(cg.param_path);
+};
+
+
+/**
+ * 验证参数
+ * @param {Object} query url参数
+ * @param {Object} body 内容参数
+ * @param {String} method 方法
+ * @return {Object} 验证结果
+ */
+Drive.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) {
+				code = 30001;
+			} else {
+				code = 30002;
+			}
+			return $.ret.error(code, msg);
+		}
+	}
+	return null;
+};
+
+
+/**
+ * 运行GRPC方法
+ * @param {Object} db 数据库管理器
+ * @param {String} method 方法名称
+ * @param {Object} query 查询条件
+ * @param {Object} body 增改项
+ * @return {Object} 返回执行结果
+ */
+Drive.prototype.run = async function(db, method, query, body) {
+	var func = this.methods[method];
+	var ret = {};
+	try {
+		if (func) {
+			ret = this.checkParam(query, body, method);
+			if (!ret) {
+				ret = await func(db, query, body);
+			}
+		} else {
+			ret = {
+				error: {
+					code: 60000,
+					message: "方法名称不存在",
+					data: Object.keys(this.methods)
+				}
+			}
+		}
+	} catch (err) {
+		$.log.error("运行RPC方法错误！", method, err);
+		ret = {
+			error: {
+				code: 500,
+				message: "服务端业务逻辑错误"
+			}
+		}
+	}
+	return ret;
+};
+
+/* 导出驱动 */
+module.exports = Drive;

package/core/com/rpc/index.js

@@ -0,0 +1,87 @@
+const Index = require('mm_machine').Index;
+const Drive = require('./drive');
+
+/**
+ * RPC导航类
+ * @extends {Index}
+ * @class
+ */
+class RPC extends Index {
+	/**
+	 * 构造函数
+	 * @param {Object} scope 作用域
+	 * @param {String} title 标题
+	 * @constructor
+	 */
+	constructor(scope, title) {
+		super(scope, __dirname);
+		this.Drive = Drive;
+		this.type = "rpc";
+		this.title = title;
+		this.list = [];
+		// 默认启用热更新
+		this.mode = 3;
+	}
+}
+
+/**
+ * 运行GRPC方法
+ * @param {Object} db 数据库管理器
+ * @param {String} class_name 类名
+ * @param {String} method 方法名称
+ * @param {Object} query 查询条件
+ * @param {Object} body 增改项
+ * @return {Object} 返回执行结果
+ */
+RPC.prototype.run = async function(db, class_name, method, query, body) {
+	if (!db) {
+		db = {
+			ret: null
+		};
+	}
+
+	var lt = this.list;
+	for (var i = 0, o; o = lt[i++];) {
+		if (o.config.state === 1 && class_name == o.config.name) {
+			var ret = await o.run(db, method, query, body);
+			if (ret) {
+				db.ret = ret;
+				break;
+			}
+		}
+	}
+	return db.ret;
+};
+
+/* 导出指令 */
+exports.RPC = RPC;
+
+/**
+ * RPC事件池
+ */
+if (!$.pool.rpc) {
+	$.pool.rpc = {};
+}
+
+/**
+ * RPC管理器，用于创建缓存
+ * @param {String} scope 作用域
+ * @param {string} title 标题
+ * @return {Object} 返回一个缓存类
+ */
+function rpc_admin(scope, title) {
+	if (!scope) {
+		scope = $.val.scope + '';
+	}
+	var obj = $.pool.rpc[scope];
+	if (!obj) {
+		$.pool.rpc[scope] = new RPC(scope, title);
+		obj = $.pool.rpc[scope];
+	}
+	return obj;
+}
+
+/**
+ * @module 导出RPC管理器
+ */
+$.rpc_admin = rpc_admin;

package/core/com/socket/drive.js

@@ -364,7 +364,6 @@ Drive.prototype.init = async function init() {
  * 加载完成时
  */
 Drive.prototype.load_after = function() {
-	this.init();
 	var m = this.methods;
 
 	/**

package/core/com/socket/index.js

@@ -45,7 +45,7 @@ Socket.prototype.run = async function(ctx, next) {
  * @param {String} path 检索路径
  * @param {Boolean} isApp 是否APP
  */
-Socket.prototype.load = function(path) {
+Socket.prototype.update_config_all = async function(path) {
 	if (!path) {
 		path = "./app/";
 	}
@@ -53,20 +53,10 @@ Socket.prototype.load = function(path) {
 	var list_scope = $.dir.getAll(path, "socket");
 
 	// 遍历目录路径
-	var _this = this;
-	list_scope.map(async function(f) {
+	for (var i = 0, f; f = list_scope[i++];) {
 		var list_file = $.file.getAll(f, "*" + _this.type + ".json");
-		list_file.map(async (file) => {
-			var dir = file.dirname();
-			if (file.hasFile()) {
-				var obj = new Drive(dir);
-				obj.load(file);
-				if (obj.config.name) {
-					_this.list.push(obj);
-				}
-			}
-		});
-	});
+		await this.load_list(list_file);
+	}
 }
 
-module.exports = Socket;
+module.exports = Socket;

package/core/com/sql/drive.js

@@ -20,7 +20,7 @@ class Drive extends Item {
 		// 读取文件目录
 		this.url_path = "/file/";
 		// 默认启用热更新
-		this.mode = 2;
+		this.mode = 3;
 		/* 通用项 */
 		this.params = null;
 		// 配置参数

package/core/com/sql/index.js

@@ -19,36 +19,9 @@ class Sql extends Index {
 		this.type = "sql";
 		this.title = title;
 		// 默认启用热更新
-		this.mode = 2;
+		this.mode = 3;
 	}
 }
-
-/**
- * 加载
- * @param {String} path 加载的路径
- */
-Sql.prototype.load = function(path) {
-	if (!path) {
-		path = "./app/";
-	}
-	// 获取所有应用路径
-	var search_dir;
-	var _this = this;
-	if (this.scope && this.scope !== $.val.scope) {
-		search_dir = this.type + '_' + this.scope;
-		var list_scope = $.dir.getAll(path, search_dir);
-		list_scope.map(function(f) {
-			// 获取所有配置文件
-			var list_file = $.file.getAll(f, "*" + _this.type + ".json");
-			_this.load_list(list_file);
-		});
-	} else {
-		// 获取所有配置文件
-		var list_file = $.file.getAll(path, "*" + _this.type + ".json");
-		_this.load_list(list_file);
-	}
-};
-
 /**
  * 排序
  */
@@ -68,8 +41,8 @@ Sql.prototype.run = async function(name, query, body, db) {
 	var obj = this.get(name);
 	if (obj) {
 		var ret = await obj.run(query, body, db);
-		if (this.mode > 2) {
-			o.load(o.filename);
+		if (this.mode > 4) {
+			o.exec('reload', o.filename);
 		}
 		return ret;
 	}
@@ -107,4 +80,4 @@ function sql_admin(scope, title) {
 /**
  * @module 导出Sql管理器
  */
-$.sql_admin = sql_admin;
+$.sql_admin = sql_admin;