mm_os 2.8.0 → 2.8.2

package/demo/app/user/app.js

@@ -0,0 +1,148 @@
+/**
+ * @fileOverview user
+ * @author <a href="作者主页地址">应用作者</a>
+ * @version 1.0
+ */
+
+/**
+ * 应用对象
+ */
+module.exports = {
+	/**
+	 * 初始化
+	 * @param {Object} option 配置参数
+	 * @return {String} 成功返回null, 否则返回错误提示
+	 */
+	init(option) {
+		// 创建插件
+		this.plugin = $.plugin_admin('user');
+		this.plugin.update(__dirname);
+		
+		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/user/app.json

@@ -0,0 +1,11 @@
+{
+    "name": "user",
+    "title": "用户",
+    "description": "用于用户身份验证",
+    "version": "1.0",
+    "lang_path": "/user/lang/",
+    "icon": "/user/img/logo.png",
+    "script": "./app.js",
+    "sort": 10,
+    "state": 1
+}

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

@@ -0,0 +1,10 @@
+{
+	"target": "/api/user/*",
+	"name": "user_client",
+	"title": "用户客户端调用的接口事件",
+	"description": "用于用户访问服务端时调用的接口",
+	"stage": "main",
+	"func_file": "./main.js",
+	"sort": 99,
+	"end": true
+}

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

@@ -0,0 +1,18 @@
+var api = $.api_admin('user_client', '用户客户端');
+// 首次启动更新api接口;
+api.update('user/');
+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/user/event_api/manage/event.json

@@ -0,0 +1,10 @@
+{
+	"target": "/apis/user/*",
+	"name": "user_admin_api",
+	"title": "用户管理端调用的接口事件",
+	"description": "用于管理用户时调用的接口",
+	"stage": "main",
+	"func_file": "./main.js",
+	"sort": 99,
+	"end": true
+}

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

@@ -0,0 +1,19 @@
+var api = $.api_admin('user_manage', '用户管理端');
+// 首次启动更新api接口;
+api.update('user/');
+
+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/user/plugin/main/api_user_client/account/api.json

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

package/demo/app/user/plugin/main/api_user_client/account/index.js

@@ -0,0 +1,53 @@
+/**
+ * 接口主函数
+ * @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 user = await this.get_state(ctx, db);
+	query.user_id = user.user_id;
+	// 操作sql模板
+	var m = query.method;
+	delete query.method;
+	db.table = "user_account";
+	if (m === "add") {
+		var bl = await db.add(body);
+		if (bl > 0) {
+			ret = $.ret.bl(true, "添加成功！");
+		} else {
+			ret = $.ret.error(10000, "添加失败！原因：" + db.error.message);
+		}
+	} else if (m === "del") {} else if (m === "set") {
+		if (body.username) {
+			var obj = await db.getObj({
+				username: body.username
+			});
+			if (obj.user_id !== user.user_id) {
+				return $.ret.error(10000, "修改失败！原因：账号已被其他人使用");
+			}
+		}
+		var bl = await db.set(query, body);
+		if (bl > 0) {
+			ret = $.ret.bl(true, "修改成功！");
+		} else {
+			ret = $.ret.error(10000, "修改失败！原因：" + db.error.message);
+		}
+	} else if (m === "get_obj") {
+		db.key = "user_id";
+		var obj = await db.getObj(query);
+		ret = $.ret.obj(obj);
+	} else {
+		var list = await db.get(query);
+		ret = $.ret.list(list);
+	}
+	return ret;
+};
+
+exports.main = main;

package/demo/app/user/plugin/main/api_user_client/account/param.json

@@ -0,0 +1,130 @@
+{
+	// 是否启用过滤, 启用过滤后, 不符合的参数会被过滤掉
+	"filter": true,
+	// 校验脚本文件, 可以使用脚本的方式加一步进行校验, 让传参更加安全
+	"func_file": "",
+	// get请求
+	"get": {
+		// 查询参数校验项
+		"query": ["user_id", "name", "username", "phone", "email"],
+		// 查询必填参数
+		"query_required": []
+	},
+	// post请求
+	"post": {
+		// 查询参数校验项
+		"query": ["user_id", "name", "username", "phone", "email"],
+		// 查询必填参数
+		"query_required": [],
+		// 正文参数校验项
+		"body": ["age", "headImg", "birthday", "password", "confirm_password", "pay_password"],
+		// 正文必填参数
+		"body_required": []
+	},
+	// 校验列表
+	"list": [{
+			// 参数key名
+			"name": "user_id",
+			// 参数中文名
+			"title": "用户ID",
+			// 数据类型
+			"type": "number",
+			// 数字类型时设置
+			"number": {
+				// 最小数值
+				"min": 1
+			},
+			// 分隔参数，允许传多个值，为空则限制1个值
+			"splitter": "|"
+		}, {
+			"name": "name",
+			"title": "姓名",
+			"type": "string",
+			// 字符串类型时设置
+			"string": {
+				// 格式
+				"format": "ch",
+				// 传值范围，字符串时为限制字符长度
+				"range": [2, 6]
+			},
+			"splitter": "|"
+		},
+		{
+			"name": "age",
+			"title": "年龄",
+			"type": "number",
+			"number": {
+				// 传值范围，数字时为最小值和最大值
+				"range": [1, 150]
+			}
+		},
+		{
+			"name": "headImg",
+			"title": "头像",
+			"type": "string",
+			"string": {
+				// 拓展名，用于传媒体（图片、音频、视频）时
+				"extension": "png|gif|jpg|jpeg|bmp"
+			}
+		},
+		{
+			"name": "birthday",
+			"title": "生日",
+			"type": "string",
+			"string": {
+				"format": "dateISO"
+			}
+		},
+		{
+			"name": "username",
+			"title": "用户名",
+			"type": "string",
+			"string": {
+				"format": "username"
+			}
+		},
+		{
+			"name": "password",
+			"title": "密码",
+			"type": "string",
+			"string": {
+				"format": "password",
+				"different": "username"
+			}
+		},
+		{
+			"name": "phone",
+			"title": "手机",
+			"type": "string",
+			"string": {
+				"format": "phone"
+			}
+		},
+		{
+			"name": "email",
+			"title": "邮箱",
+			"type": "string",
+			"string": {
+				"format": "email"
+			}
+		},
+		{
+			"name": "pay_password",
+			"title": "支付密码",
+			"type": "string",
+			"string": {
+				"format": "num",
+				"different": "password"
+			}
+		},
+		{
+			"name": "confirm_password",
+			"title": "确认密码",
+			"type": "string",
+			"string": {
+				"format": "password",
+				"identical": "password"
+			}
+		}
+	]
+}

package/demo/app/user/plugin/main/api_user_client/base/api.json

@@ -0,0 +1,27 @@
+{
+	// 路由路径
+	"path": "/api/user/base",
+	// 名称, 用于动态增删改API配置
+	"name": "user_base",
+	// 标题, 用于开发文档显示
+	"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": true
+	}
+}

package/demo/app/user/plugin/main/api_user_client/base/index.js

@@ -0,0 +1,84 @@
+/**
+ * 获取定位
+ * @param {String} address 详细地址
+ */
+$.get_pos = async function(address) {
+	var http = new $.Http();
+	var url =
+		"https://api.map.baidu.com/geocoder/v2/?output=json&ak=USpWaNuVRhPvCKIFlWESpMOA8PTWESGL&address=" +
+		encodeURIComponent(address);
+	var res = await http.get(url);
+	if(res.body){
+		var json = res.body.toJson();
+		return json.result;
+	}
+	return null;
+}
+
+/**
+ * 接口主函数
+ * @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 {
+		avatar = "",
+		nickname = "",
+		name = "",
+		phone = "",
+		address = "",
+		pos_x = 0,
+		pos_y = 0
+	} = body;
+
+	var user = db.user;
+	
+	if(!user){
+		return $.ret.error(10000, "账户未登录！");
+	}
+	var user_id = user.user_id;
+
+	var obj = {};
+	// 操作sql模板
+	var m = req.method;
+	if (m === "POST") {
+		db.table = "user_account";
+		await db.set({
+			user_id
+		}, {
+			avatar,
+			nickname
+		});
+		
+		user.avatar = avatar;
+		user.nickname = nickname;
+		user.phone = phone;
+		ctx.session.user = user;
+		return $.ret.bl(true, "修改成功！");
+	} else {
+		obj = {
+			avatar,
+			nickname,
+			name,
+			phone,
+			address,
+			pos_x,
+			pos_y
+		};
+		db.table = "user_account";
+		var obj_1 = await db.getObj({
+			user_id
+		});
+		$.push(obj, obj_1);
+		return $.ret.obj(obj);
+	}
+};
+
+exports.main = main;

package/demo/app/user/plugin/main/api_user_client/base/param.json

@@ -0,0 +1,130 @@
+{
+	// 是否启用过滤, 启用过滤后, 不符合的参数会被过滤掉
+	"filter": true,
+	// 校验脚本文件, 可以使用脚本的方式加一步进行校验, 让传参更加安全
+	"func_file": "",
+	// get请求
+	"get": {
+		// 查询参数校验项
+		"query": ["uid", "name", "username", "phone", "email"],
+		// 查询必填参数
+		"query_required": []
+	},
+	// post请求
+	"post": {
+		// 查询参数校验项
+		"query": ["uid", "name", "username", "phone", "email"],
+		// 查询必填参数
+		"query_required": [],
+		// 正文参数校验项
+		"body": ["age", "headImg", "birthday", "password", "confirm_password", "pay_password"],
+		// 正文必填参数
+		"body_required": []
+	},
+	// 校验列表
+	"list": [{
+			// 参数key名
+			"name": "uid",
+			// 参数中文名
+			"title": "用户ID",
+			// 数据类型
+			"type": "number",
+			// 数字类型时设置
+			"number": {
+				// 最小数值
+				"min": 1
+			},
+			// 分隔参数，允许传多个值，为空则限制1个值
+			"splitter": "|"
+		}, {
+			"name": "name",
+			"title": "姓名",
+			"type": "string",
+			// 字符串类型时设置
+			"string": {
+				// 格式
+				"format": "ch",
+				// 传值范围，字符串时为限制字符长度
+				"range": [2, 6]
+			},
+			"splitter": "|"
+		},
+		{
+			"name": "age",
+			"title": "年龄",
+			"type": "number",
+			"number": {
+				// 传值范围，数字时为最小值和最大值
+				"range": [1, 150]
+			}
+		},
+		{
+			"name": "headImg",
+			"title": "头像",
+			"type": "string",
+			"string": {
+				// 拓展名，用于传媒体（图片、音频、视频）时
+				"extension": "png|gif|jpg|jpeg|bmp"
+			}
+		},
+		{
+			"name": "birthday",
+			"title": "生日",
+			"type": "string",
+			"string": {
+				"format": "dateISO"
+			}
+		},
+		{
+			"name": "username",
+			"title": "用户名",
+			"type": "string",
+			"string": {
+				"format": "username"
+			}
+		},
+		{
+			"name": "password",
+			"title": "密码",
+			"type": "string",
+			"string": {
+				"format": "password",
+				"different": "username"
+			}
+		},
+		{
+			"name": "phone",
+			"title": "手机",
+			"type": "string",
+			"string": {
+				"format": "phone"
+			}
+		},
+		{
+			"name": "email",
+			"title": "邮箱",
+			"type": "string",
+			"string": {
+				"format": "email"
+			}
+		},
+		{
+			"name": "pay_password",
+			"title": "支付密码",
+			"type": "string",
+			"string": {
+				"format": "num",
+				"different": "password"
+			}
+		},
+		{
+			"name": "confirm_password",
+			"title": "确认密码",
+			"type": "string",
+			"string": {
+				"format": "password",
+				"identical": "password"
+			}
+		}
+	]
+}