mm_os 2.8.0 → 2.8.1

package/demo/app/route/app.js

@@ -0,0 +1,131 @@
+/**
+ * @fileOverview route
+ * @author <a href="作者主页地址">应用作者</a>
+ * @version 1.0
+ */
+
+/**
+ * 应用对象
+ */
+module.exports = {
+	/**
+	 * 初始化
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null, 否则返回错误提示
+	 */
+	init(option) {
+		// 创建插件
+		this.plugin = $.plugin_admin('route');
+		this.plugin.update(__dirname);
+		var msg = null;
+		return msg;
+	},
+	
+	/**
+	 * 销毁
+	 * @param {Object} opiton 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示
+	 */
+	destroy(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 安装
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示
+	 */
+	install(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 卸载
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示
+	 */
+	uninstall(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 更新
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null, 否则返回错误提示
+	 */
+	update(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 启动
+	 * @param {Object} opiton 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示
+	 */
+	start(option) {
+		this.plugin.init();
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 暂停
+	 * @param {Object} opiton 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示
+	 */
+	stop(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 结束
+	 * @param {Object} opiton 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示
+	 */
+	end(option) {
+		var msg = null;
+		return msg;
+	},
+	
+	/**
+	 * 插件
+	 * @param {String} item 插件项
+	 * @return {Object} 旗下插件和信息
+	 */
+	help(item) {
+		var tip = "";
+		switch (item) {
+			case "run":
+				break;
+			default:
+				break;
+		}
+		return tip;
+	},
+
+	/**
+	 * 主程序
+	 * @param {Object} param1 参数1
+	 * @param {Object} param2 参数2
+	 * @return {Object} 返回执行结果
+	 */
+	main(param1, param2) {
+		var ret = null;
+		return ret;
+	},
+
+	/**
+	 * 指令（类似命令提示符）
+	 * @param {String} content 指令内容
+	 * @return {String} 执行结果
+	 */
+	cmd(content) {
+		var ret = "";
+		return ret;
+	}
+};

package/demo/app/route/app.json

@@ -0,0 +1,11 @@
+{
+    "name": "route",
+    "title": "路由管理",
+    "description": "用于连接路由",
+    "version": "1.0",
+    "lang_path": "/route/lang/",
+    "icon": "/route/img/logo.png",
+    "script": "./app.js",
+    "sort": 10,
+    "state": 1
+}

package/demo/app/route/event_api/client/event.json

@@ -0,0 +1,10 @@
+{
+	"target": "/api/route/*",
+	"name": "route_client",
+	"title": "路由管理接口",
+	"description": "用于匹配用户访问的路由",
+	"stage": "main",
+	"func_file": "./main.js",
+	"sort": 99,
+	"end": true
+}

package/demo/app/route/event_api/client/main.js

@@ -0,0 +1,19 @@
+var api = $.api_admin('route_client', '路由客户端');
+// 首次启动更新api接口;
+api.update('route/');
+
+var sql = $.mysql_admin('sys', __dirname);
+
+/**
+ * @description 接口主函数
+ * @param {Object} ctx HTTP上下文
+ * @param {Object} db 数据管理器,如: { next: async function{}, ret: {} }
+ * @return {Object} 执行结果
+ */
+async function main(ctx, db) {
+	// 在这定义要访问的数据库 (分布式开发时设置不同的数据库名)
+	$.push(db, sql.db(), true);
+	return api.run(ctx, db);
+};
+
+exports.main = main;

package/demo/app/route/event_api/manage/event.json

@@ -0,0 +1,18 @@
+[{
+	// 目标对象
+	"target": "/apis/route*",
+	// 事件名称, 用于动态增删改
+	"name": "route_manage",
+	// 标题, 用于开发者查看事件
+	"title": "示例事件",
+	// 描述, 用于介绍该事件是做什么用的
+	"description": "描述事件使用方法",
+	// 阶段, 分执行前before、验证check、主要main、渲染render、执行后after阶段
+	"stage": "main",
+	// 响应方法 GET请求、POST请求、ALL所有请求，如果非API事件可自定义
+	"method": "ALL",
+	// 函数文件, 当事件触发时执行指定的脚本
+	"func_file": "./main.js",
+	// 执行顺序, 数值越小越优先执行
+	"sort": 100
+}]

package/demo/app/route/event_api/manage/main.js

@@ -0,0 +1,70 @@
+if ($.routes) {
+	$.routes = {};
+	$.clients = {};
+}
+
+/**
+ * 订阅路由
+ * @param {String} clientId 客户端ID
+ * @param {Object} param 参数
+ */
+function subscribe(clientId, param) {
+	return $.ret.bl(true, "订阅成功！");
+}
+
+/**
+ * 退订路由
+ * @param {String} clientId 客户端ID
+ * @param {Object} param 参数 
+ */
+function unsubscribe(clientId, param) {
+	return $.ret.bl(true, "退订成功！");
+}
+
+function help() {
+	var list = [{
+			name: "订阅路由",
+			path: "/apis/route/subscribe?clientId=客户端ID",
+			param: {
+				"path": "路由路径",
+				"method": "请求方式",
+				"query": "查询参数",
+				"body": "提交参数"
+			}
+		},
+		{
+			name: "退订路由",
+			path: "/apis/route/subsubscribe?clientId=客户端ID",
+			param: {
+				"path": "路由路径"
+			}
+		}
+	];
+	return $.ret.list(list);
+}
+
+/**
+ * @description 接口主函数
+ * @param {Object} ctx HTTP上下文
+ * @param {Object} db 数据管理器,如: { next: async function{}, ret: {} }
+ * @return {Object} 执行结果
+ */
+async function main(ctx, db) {
+	var req = ctx.request;
+	var method = ctx.path.replace("/apis/route/", "");
+	var ret;
+	switch (method) {
+		case "subscribe":
+			ret = subscribe(req.query.clientId, req.body);
+			break;
+		case "unsubscribe":
+			ret = unsubscribe(req.query.clientId, req.body);
+			break;
+		default:
+			ret = help();
+			break;
+	}
+	return ret;
+};
+
+exports.main = main;

package/demo/app/route/plugin/main/api_route_client/pass/api.json

@@ -0,0 +1,37 @@
+{
+	// 路由路径
+	"path": "/api/route/pass",
+	// 名称, 用于动态增删改API配置
+	"name": "route_pass",
+	// 标题, 用于开发文档显示
+	"title": "路由访问密码",
+	// 描述, 用于介绍该路由的作用
+	"description": "用于判断用户是否有权访问",
+	// 函数文件, 用于驱动脚本, 实现业务 
+	"func_file": "./index.js",
+	// 请求方法, 选填 GET, POST, ALL。 ALL指同时支持GET/POST
+	"method": "ALL",
+	// 开放域, 如果域未开放, 则只有特定的协议头才能访问该API, 同时API文档不接见
+	"scope": true,
+	// 缓存时长, 单位: 分钟。使用缓存后, 二次访问API直接从缓存读取, 不重复执行业务脚本
+	"cache": 0,
+	// 是否客户端缓存, 使用客户端则不再访问服务器, 直接从浏览器中拿; 使用服务端缓存则会访问服务器   
+	"client_cache": false,
+	// 参数配置路径, 用于校验API请求参数是否正确, 同时显示在API文档中 
+	"param_path": "./param.json",
+	/* 授权协议 */
+	"oauth": {
+		// 是否需要登录, true表示需要登录才能访问该接口
+		"signIn": false,
+		// 会员权限级别, 如果小于该值, 则无法访问, 0为不限制
+		"vip": 0,
+		// 管理员权限级别, 如果小于该值, 则无法访问, 0为不限制
+		"gm": 0,
+		// 商户/第三方权限级别, 如果小于该值, 则无法访问, 0为不限制
+		"mc": 0,
+		// 用户组, 允许访问该接口的普通用户群体, 传ID数组，例如: [1,5]
+		"user_group": [],
+		// 管理组, 允许访问该接口的管理员群体, 传ID数组，例如: [1,5]
+		"user_admin": []
+	}
+}

package/demo/app/route/plugin/main/api_route_client/pass/index.js

@@ -0,0 +1,33 @@
+
+/**
+ * 接口主函数
+ * @param {Object} ctx HTTP上下文
+ * @param {Object} db 数据管理器,如: { next: async function{}, ret: {} }
+ * @return {Object} 执行结果
+ */
+async function main(ctx, db) {
+	// 获取请求参数
+	var req = ctx.request;
+	var {
+		query,
+		body
+	} = req;
+	
+	var { route, password } = body;
+	
+	db.table = "sys_config";
+	var obj = await db.getObj({name: "route_pass_" + route}, "", "name, value");
+	if(!obj){
+		// 路由错误的情况下返回该地址
+		var err = await db.getObj({name: "route_error"}, "", "name, value");
+		return $.ret.body({ path: err.value });
+	}
+	else if(obj.value && password === obj.value.md5()){
+		// 路由密码正确的情况下返回该地址
+		var su = await db.getObj({name: "route_" + route}, "", "name, value");
+		return $.ret.body({ path: su.value });
+	}
+	return $.ret.error(10000, '频道错误');
+};
+
+exports.main = main;

package/demo/app/route/plugin/main/api_route_client/pass/param.json

@@ -0,0 +1,50 @@
+{
+	// 是否启用过滤, 启用过滤后, 不符合的参数会被过滤掉
+	"filter": true,
+	// 校验脚本文件, 可以使用脚本的方式加一步进行校验, 让传参更加安全
+	"func_file": "",
+	// get请求
+	"get": {
+		// 查询参数校验项
+		"query": [],
+		// 查询必填参数
+		"query_required": []
+	},
+	// post请求
+	"post": {
+		// 查询参数校验项
+		"query": [],
+		// 查询必填参数
+		"query_required": [],
+		// 正文参数校验项
+		"body": ["route", "password"],
+		// 正文必填参数
+		"body_required": []
+	},
+	// 校验列表
+	"list": [{
+			// 参数key名
+			"name": "route",
+			// 参数中文名
+			"title": "路由线路",
+			// 数据类型
+			"type": "number",
+			// 数字类型时设置
+			"number": {
+				// 最小数值
+				"min": 1,
+				"max": 4
+			},
+			// 分隔参数，允许传多个值，为空则限制1个值
+			"splitter": "|"
+		},
+		{
+			"name": "password",
+			"title": "密码",
+			"type": "string",
+			"string": {
+				"format": "password"
+			}
+		}
+	]
+}

package/demo/app/route/plugin/main/index.js

@@ -0,0 +1,144 @@
+/**
+ * @fileOverview main
+ * @author <a href="作者主页地址">插件作者</a>
+ * @version 1.0
+ */
+
+/**
+ * 插件对象
+ */
+module.exports = {
+	/**
+	 * 初始化
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null, 否则返回错误提示
+	 */
+	init(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 安装
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示
+	 */
+	install(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 卸载
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示
+	 */
+	uninstall(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 更新
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null, 否则返回错误提示
+	 */
+	update(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 启动
+	 * @param {Object} opiton 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示
+	 */
+	start(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 暂停
+	 * @param {Object} opiton 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示
+	 */
+	stop(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 结束
+	 * @param {Object} opiton 配置参数
+	 * @return {String} 成功返回null,否则返回错误提示
+	 */
+	end(option) {
+		var msg = null;
+		return msg;
+	},
+
+	/**
+	 * 插件
+	 * @param {String} item 插件项
+	 * @return {Object} 旗下插件和信息
+	 */
+	help(item) {
+		var tip = "";
+		switch (item) {
+			case "run":
+				break;
+			default:
+				break;
+		}
+		return tip;
+	},
+
+	/**
+	 * 主程序
+	 * @param {Object} param1 参数1
+	 * @param {Object} param2 参数2
+	 * @return {Object} 返回执行结果
+	 */
+	main(param1, param2) {
+		var ret = null;
+		return ret;
+	},
+
+	/**
+	 * 指令（类似命令提示符）
+	 * @param {String} content 指令内容
+	 * @return {String} 执行结果
+	 */
+	cmd(content) {
+		var ret = "";
+		return ret;
+	},
+
+	/**
+	 * API接口（用于其他插件调用该插件时）
+	 * @param {Object} ctx HTTP上下文
+	 * @param {Object} db 数据库管理器
+	 * @return {Object} 执行结果
+	 */
+	api(ctx, db) {
+		var ret = "";
+		return ret;
+	},
+
+	/**
+	 * 聊天（通过聊天的方式驱动插件, 用于机器人开发）
+	 * @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} 回复内容
+	 */
+	async chat(from_user, to_user, group, content, type, msg_type, db) {
+		var ret = "";
+		return ret;
+	}
+};

package/demo/app/route/plugin/main/plugin.json

@@ -0,0 +1,20 @@
+{
+	// 应用名称，表示该插件用在什么应用里的
+	"app": "route",
+	// 插件名称，插件的唯一标识
+	"name": "main",
+	// 插件标题，用于检索和识别
+	"title": "示例插件",
+	// 插件描述，介绍改插件是做什么用的
+	"description": "描述该插件是做什么用的",
+	// 插件版本号，用于升级迭代
+	"version": "1.0",
+	// 插件语言包文件路径
+	"lang_path": "./lang/",
+	// 插件图标
+	"icon": "/route/main/img/logo.png",
+	// 插件指令，通过指令方式调用插件
+	"cmd": "route.main",
+	// 排序，表示多个插件时在应用下执行的先后顺序
+	"sort": 10
+}