mm_os 2.9.9 → 3.0.1

package/core/com/app/README.md

@@ -0,0 +1,3 @@
+## 插件框架
+用于实现应用结构和应用插件结构，实现了一个mm系统多个应用、一个应用多个插件的系统结构。
+确保应用和插件是可以动态安装、卸载、重置，便捷功能拓展。

package/core/com/app/com.json

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

package/core/com/app/config.tpl.json

@@ -0,0 +1,16 @@
+{
+	// 应用名称，应用的唯一标识
+	"name": "{0}",
+	// 应用标题，用于检索和识别
+	"title": "示例应用",
+	// 应用描述，介绍改应用是做什么用的
+	"description": "描述该应用是做什么用的",
+	// 应用版本号，用于升级迭代
+	"version": "1.0.0",
+	// 应用语言包文件路径
+	"lang_path": "./lang/",
+	// 是否中断执行
+	"end": true,
+	// 排序，表示多个应用时在应用下执行的先后顺序
+	"sort": 10
+}

package/core/com/app/drive.js

@@ -0,0 +1,317 @@
+const compressing = require('compressing');
+const Item = require('mm_machine').Item;
+const conf = require('mm_config');
+
+/**
+ * APP应用驱动类
+ * @extends {Item}
+ * @class 
+ */
+class Drive extends Item {
+	/**
+	 * 构造函数
+	 * @param {String} dir 当前目录
+	 * @constructor
+	 */
+	constructor(dir) {
+		super(dir, __dirname);
+		this.default_file = "./app.json";
+		// 默认启用热更新
+		this.mode = 3;
+		/**
+		 * 当前语言
+		 */
+		this.lang_now = "zh_CN";
+		/**
+		 * 语言包
+		 */
+		this.lang = {};
+
+		/* 通用项 */
+		// 配置参数
+		this.config = {
+			// 名称, 由中英文和下“_”组成, 用于修改或卸载 例如: demo
+			// 同时也是版本唯一标识，当商城有两个应用名称相同时，可以通过版本号查询和下载
+			"name": "",
+			// 标题, 介绍事件作用
+			"title": "",
+			// 描述, 用于描述该事件有什么用的
+			"description": "",
+			// 版本号
+			"version": "1.0.0",
+			// 状态 0未启用，1启用
+			"state": 1,
+			// 文件路径, 当调用函数不存在时，会先从文件中加载
+			"func_file": "./app.js",
+			// 回调函数名 用于决定调用脚本的哪个函数
+			"func_name": "",
+			// 语言包路径
+			"lang_path": "./lang/",
+			// 指令前缀
+			"cmd": "",
+			// 是否中断执行
+			"end": true,
+			// 排序
+			"sort": 10,
+			// 配置
+			"options": []
+		};
+		// 配置
+		this.options = {};
+	}
+}
+
+/**
+ * 设置配置
+ * @param {Object} config 配置
+ */
+Drive.prototype.set_config = function(config) {
+	var file = this.filename;
+	var cg = Object.assign({}, this.config, config || {});
+	this.config = conf(cg, file);
+}
+
+/**
+ * 新建脚本
+ * @param {String} 文件
+ */
+Drive.prototype.new_script = function(file) {
+	var fl = __dirname + "/script.js";
+	if (fl.hasFile()) {
+		var text = fl.loadText();
+		if (text) {
+			var l = $.slash;
+			var name = file.between('app' + l, l) || 'sys';
+			text = text.replaceAll('{0}', name)
+			file.saveText(text);
+		}
+	}
+};
+
+/**
+ * 新建配置
+ * @param {String} file 文件
+ */
+Drive.prototype.new_config = function(file) {
+	var fl = __dirname + "/config.tpl.json";
+	if (fl.hasFile()) {
+		var text = fl.loadText();
+		if (text) {
+			var l = $.slash;
+			var name = file.between('app' + l, l) || 'sys';
+			text = text.replaceAll('{0}', name);
+			file.saveText(text);
+		}
+	}
+};
+
+/**
+ * 设置语言
+ * @param {Sting} lang
+ * @return {String} 成功返回null,否则返回错误提示
+ */
+Drive.prototype.set_lang = function(lang) {
+	var msg = null;
+	if (!lang) {
+		lang = "zh_CN"
+	}
+	var file = this.config.lang_path + ".json";
+	if (file.hasFile()) {
+		var obj = file.loadJson();
+		if (obj) {
+			this.lang = obj;
+		} else {
+			msg = "语言包不是正确的json格式";
+		}
+	} else {
+		msg = "语言包文件不存在";
+	}
+	return msg;
+};
+
+/**
+ * 安装
+ * @param {Object} option 配置参数
+ * @return {String} 成功返回null,否则返回错误提示
+ */
+Drive.prototype.install = function(option) {
+	var msg = null;
+	return msg;
+};
+
+/**
+ * 重启设备
+ * @param {Object} option 配置
+ */
+Drive.prototype.restart = async function(option) {
+	await this.exec('stop');
+	await this.exec('start');
+}
+
+/**
+ * 初始化之前
+ * @param {Object} option
+ */
+Drive.prototype.init_before = async function(option) {
+	this.plugin = $.plugin_admin(this.config.name, this.config.title);
+	await this.plugin.update();
+	await this.plugin.exec(null, 'init');
+}
+
+/**
+ * 初始化
+ * @param {Object} option 配置参数
+ * @return {String} 成功返回null, 否则返回错误提示
+ */
+Drive.prototype.init = function(option) {
+	var msg = null;
+	return msg;
+};
+
+/**
+ * 更新
+ * @param {Object} option 配置参数
+ * @return {String} 成功返回null, 否则返回错误提示
+ */
+Drive.prototype.update = function(option) {
+	var msg = null;
+	return msg;
+};
+
+/**
+ * 卸载
+ * @param {Object} option 配置参数
+ * @return {String} 成功返回null,否则返回错误提示
+ */
+Drive.prototype.uninstall = function(option) {
+	var msg = null;
+	return msg;
+};
+
+/**
+ * 启动
+ * @param {Object} opiton 配置参数
+ * @return {String} 成功返回null,否则返回错误提示
+ */
+Drive.prototype.start = function(opiton) {
+	var msg = null;
+	return msg;
+};
+
+/**
+ * 启动之后，启动插件
+ * @param {Object} opiton 配置参数
+ * @return {String} 成功返回null,否则返回错误提示
+ */
+Drive.prototype.start_after = async function(opiton) {
+	var msg = null;
+	var list = this.plugin;
+	for (var i = 0; i < list.length; i++) {
+		var o = list[i];
+		if (o.config.state) {
+			await o.run('start');
+			// 等待0.5秒
+			await $.sleep(500);
+		}
+	}
+	return msg;
+};
+
+/**
+ * 暂停
+ * @param {Object} opiton 配置参数
+ * @return {String} 成功返回null,否则返回错误提示
+ */
+Drive.prototype.stop = function(opiton) {
+	var msg = null;
+	return msg;
+};
+
+/**
+ * 结束
+ * @param {Object} opiton 配置参数
+ * @return {String} 成功返回null,否则返回错误提示
+ */
+Drive.prototype.end = function(opiton) {
+	var msg = null;
+	return msg;
+};
+
+/**
+ * 商店（用于下载应用相关模块）
+ * @param {String} item 应用项
+ * @return {String} 成功返回null,否则返回错误提示
+ */
+Drive.prototype.store = function(item) {
+	var msg = null;
+	return msg;
+};
+
+/**
+ * 帮助（讲解应用使用方法）
+ * @param {String} item 帮助项
+ * @return {String} 返回使用方法明细
+ */
+Drive.prototype.help = function(item) {
+	var body = "";
+	return body;
+};
+
+/**
+ * 主程序
+ * @param {Object} param1 参数1
+ * @param {Object} param2 参数2
+ * @return {Object} 返回执行结果
+ */
+Drive.prototype.main = function(param1, param2) {
+	return null;
+};
+
+/**
+ * 指令（类似命令提示符）
+ * @param {String} content 指令内容
+ * @return {String} 执行结果
+ */
+Drive.prototype.cmd = function(content) {
+	var body = "";
+	return body;
+};
+
+/**
+ * 指令（类似命令提示符）
+ * @param {String} content 指令内容
+ * @return {String} 执行结果
+ */
+Drive.prototype.run_cmd = async function(content) {
+	if (!content) {
+		content = "";
+	}
+	var ret;
+	try {
+		ret = this.cmd(content);
+	} catch (err) {
+		$.log.error("运行应用指令失败！", this.config.name, err);
+	}
+	if (!ret) {
+		ret = "";
+	}
+	return ret;
+};
+
+/**
+ * 压缩应用
+ * @param {String} 要压缩的目录
+ * @returns {String} 打包成功返回压缩包文件地址
+ */
+Drive.prototype.zip = async function(zip_dir = "/static/file/zip/") {
+	var dir = this.filename.dirname();
+	var file = ("./" + this.config.name + '.zip').fullname(zip_dir);
+	file.addDir();
+	var done = await compressing.zip.compressDir(dir, file);
+	if (file.hasFile()) {
+		return file;
+	}
+	return null;
+}
+
+module.exports = Drive;

package/core/com/app/index.js

@@ -0,0 +1,210 @@
+const compressing = require('compressing');
+const Index = require('mm_machine').Index;
+const Drive = require('./drive.js');
+
+/**
+ * App应用类
+ * @extends {Index}
+ * @class 
+ */
+class App extends Index {
+	/**
+	 * 构造函数
+	 * @param {Object} scope 作用域
+	 * @param {String} title 标题
+	 * @constructor
+	 */
+	constructor(scope, title) {
+		super(scope, __dirname);
+		this.Drive = Drive;
+		this.type = "app";
+		this.title = title;
+		// 默认启用热更新
+		this.mode = 3;
+	}
+}
+
+/**
+ * 初始化应用
+ * @param {Object} option 配置参数
+ * @return {String} 执行结果
+ */
+App.prototype.init = function(option) {
+	var ret = "";
+	var lt = this.list;
+	for (var i = 0, o; o = lt[i++];) {
+		ret = o.exec('init', option);
+	}
+	return ret;
+};
+
+/**
+ * 加载应用
+ * @param {String} path 检索路径
+ * @param {Boolean} accurate 是否精确路径
+ */
+App.prototype.update_config_all = async function(path, accurate) {
+	var dir_app;
+	if (accurate) {
+		dir_app = path;
+	} else {
+		if (!path) {
+			if (this.scope == "sys") {
+				path = "";
+			} else {
+				path = "/" + this.scope;
+			}
+		}
+		dir_app = (path + "/app/").fullname();
+	}
+	
+	if (dir_app.hasDir()) {
+		var list_scope = $.dir.get(dir_app);
+		// 遍历目录路径
+		for (var i = 0, o; o = list_scope[i++];) {
+			var file = './app.json'.fullname(o);
+			if (file.hasFile()) {
+				await this.load_file(file, true);
+			}
+		}
+	}
+};
+
+/**
+ * 压缩应用
+ * @param {Object} name 应用名称
+ * @returns {Boolean} 返回压缩路径
+ */
+App.prototype.zip = async function(name) {
+	var plus = this.get(name);
+	if (plus) {
+		return await plus.zip();
+	}
+	return null;
+}
+
+/**
+ * 解压应用
+ * @param {Object} file 应用压缩文件
+ * @returns {Boolean} 返回解压结果
+ */
+App.prototype.unzip = async function(file) {
+	var name = file.basename().left(".");
+	var dir = `/cache/app/${name}`.fullname();
+	dir.addDir();
+	var ret;
+	try {
+		await compressing.zip.uncompress(file, dir);
+		ret = {
+			file,
+			dir
+		};
+	} catch (err) {
+		$.log.error("应用解压失败！", err);
+	}
+	return ret;
+}
+
+/**
+ * 卸载应用
+ * @param {String} name 应用名称
+ * @returns {String} 返回卸载路径
+ */
+App.prototype.uninstall = async function(name) {
+	var plus = this.get(name);
+	if (plus) {
+		await plus.exec('uninstall');
+		var obj = this.del(name, true);
+		if (obj) {
+			var file = obj.filename;
+			// 删除目录
+			file.dirname().delDir();
+			return file
+		}
+	}
+	return null;
+}
+
+/**
+ * 复制目录
+ * @param {String} dir_src 原路径
+ * @param {String} dir 新路径
+ * @returns {Object} 返回复制结果
+ */
+App.prototype.copy_dir = function(dir_src, dir) {
+	return new Promise((resolve, reject) => {
+		$.dir.copy(dir_src, dir, () => {
+			resolve({
+				dir_src,
+				dir
+			});
+		});
+	});
+}
+
+/**
+ * 安装应用
+ * @param {String} file 应用压缩文件
+ * @returns {Object} 返回解压结果
+ */
+App.prototype.install = async function(file) {
+	var ret = await this.unzip(file);
+	if (ret) {
+		var dirs = $.dir.get(ret.dir);
+		if (dirs.length) {
+			var dir_src = dirs[0];
+			var file = "./app.json".fullname(dir_src);
+			var config = file.loadJson();
+			if (config) {
+				var name = config.name;
+				if (name) {
+					var dir = `/app/${name}`;
+					await this.copy_dir(dir_src, dir);
+					var cs = $.pool.app[app];
+					if (cs) {
+						await cs.update(`/app/`.fullname());
+						await cs.exec(name, 'install');
+						setTimeout(() => {
+							ret.dir.delDir();
+						}, 3000)
+					}
+					return {
+						name,
+						dir_src,
+						dir
+					}
+				}
+			}
+		}
+	}
+}
+
+module.exports = App;
+
+
+/**
+ * 创建全局管理器
+ */
+if (!$.pool.app) {
+	$.pool.app = {};
+}
+
+function app_admin(scope, title) {
+	if (!scope) {
+		scope = $.val.scope + '';
+	}
+	var obj = $.pool.app[scope];
+	if (!obj) {
+		$.pool.app[scope] = new App(scope, title);
+		obj = $.pool.app[scope];
+	}
+	return obj;
+}
+
+/**
+ * app管理器, 用于管理应用
+ * @param {string} scope 作用域
+ * @param {string} title 标题
+ * @return {Object} 返回一个缓存类
+ */
+$.app_admin = app_admin;

package/core/com/app/script.js

@@ -0,0 +1,155 @@
+/**
+ * @fileOverview {0}
+ * @author <a href="作者主页地址">应用作者</a>
+ * @version 1.0
+ */
+
+/**
+ * 应用对象
+ */
+module.exports = {
+	/**
+	 * 安装，把应用安装到系统中，在安装时执行
+	 * @param {Object} option 配置参数
+	 * @param {String} option.path 应用安装路径
+	 * @param {Object} option.config 应用配置信息
+	 * @param {String} option.version 应用版本号
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：路径不存在、版本不兼容、依赖缺失等
+	 */
+	install(option) {
+		var msg = null;
+		// 此处常用于更新文件和导入数据库等操作。通常为一次操作
+		return msg;
+	},
+	/**
+	 * 加载应用，当脚本被引入时会执行
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null, 否则返回错误提示。常见错误：依赖模块加载失败、模块冲突等
+	 */
+	load(option) {
+		var msg = null;
+		// 此处通常用于require加载其他相关模块（不在脚本文件中直接require模块,可提高启动速度，可根据应用优先级优先加载模块）
+		return msg;
+	},
+	/**
+	 * 初始化应用，设置全局变量、路由规则和定时任务等
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null, 否则返回错误提示。常见错误：配置格式错误、路由冲突等
+	 */
+	init(option) {
+		var msg = null;
+		// 此处主要用于重置全局变量和配置，更新路由和更新定时任务等操作
+		return msg;
+	},
+
+	/**
+	 * 启动应用，开启路由监听和定时任务
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：端口被占用、服务启动超时等
+	 */
+	start(option) {
+		var msg = null;
+		// 此处主要用于开启路由和定时任务
+		return msg;
+	},
+	/**
+	 * 重启应用，在配置更改或应用更新时执行
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：重启超时、服务未完全停止等
+	 */
+	restart(option) {
+		var msg = null;
+		this.stop();
+		this.start();
+		return msg;
+	},
+	/**
+	 * 暂停应用，临时停止路由和定时任务的执行
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：有未完成的任务、停止超时等
+	 */
+	stop(option) {
+		var msg = null;
+		// 此处主要用于关闭路由和定时任务
+		return msg;
+	},
+	/**
+	 * 结束应用，清理路由、定时任务和连接
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：资源释放失败、清理超时等
+	 */
+	end(option) {
+		var msg = null;
+		// 主要用于移除注册的路由、 定时任务连接
+		return msg;
+	},
+	/**
+	 * 卸载已加载的模块，释放内存资源
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示。常见错误：模块正在使用、依赖关系阻止卸载等
+	 */
+	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 {String} item 查询的功能项，如"install"、"api"等
+	 * @return {Object} 返回帮助信息对象
+	 * @example
+	 * // 获取安装相关帮助
+	 * help("install") 
+	 * // 返回: {title: "安装说明", steps: ["步骤1...", "步骤2..."], examples: [...]}
+	 */
+	help(item) {
+		var tip = "";
+		switch (item) {
+			case "run":
+				break;
+			default:
+				break;
+		}
+		return tip;
+	},
+
+	/**
+	 * 应用主程序，处理核心业务逻辑
+	 * @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;
+		return ret;
+	}
+};