mm_os 2.9.2 → 2.9.3

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
+}

package/demo/app/sys/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "plugin/mqtt_engine"]
+	path = plugin/mqtt_engine
+	url = https://gitee.com/qiuwenwu91/mm_mqtt_engine.git

package/demo/app/sys/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/demo/app/sys/README.md

@@ -0,0 +1 @@
+## 系统