mm_os 2.8.0 → 2.8.2

package/demo/app/sys/plugin/main/api_client/translate/index.js

@@ -0,0 +1,21 @@
+// 集合路由、导航，不开发前端的情况下可以将以下2行注释掉
+// const nav = $.nav_admin('{0}');
+// nav.update();
+
+/**
+ * 接口主函数
+ * @param {Object} ctx HTTP上下文
+ * @param {Object} db 数据管理器,如: { next: async function{}, ret: {} }
+ * @return {Object} 执行结果
+ */
+async function main(ctx, db) {
+	// 获取请求参数
+	var req = ctx.request;
+	var q = req.query;
+	return "hello world" + JSON.stringify(q);
+	// 操作sql模板
+	// var ret = await this.sql.run(req.query, req.body, db);
+	// return ret;
+};
+
+exports.main = main;

package/demo/app/sys/plugin/main/api_client/translate/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"
+			}
+		}
+	]
+}

package/demo/app/sys/plugin/main/api_client/translate/sql.json

@@ -0,0 +1,62 @@
+{
+	// SQL模板标题
+	"title": "示例sql模板",
+	// 调用的数据表
+	"table": "user_account",
+	// 表主键，用于getObj查询时
+	"key": "user_id",
+	// 排序方式，{0}表示支持前端传值来排序，传值方式例如：orderby=user_id
+	"orderby": "{0}",
+	// 默认排序方式，当前端没有传值的情况下，采用默认传值方式
+	"orderby_default": "`user_id` desc",
+	// 查询列表时返回的字段，{0}表示支持前端传值
+	"field": "{0}",
+	// 查询对象时返回的字段
+	"field_obj": "{0}",
+	// 默认返回字段
+	"field_default": "`username`, `phone`",
+	// 需要过滤的字段，*代表泛匹配 前面*表示以xxx结尾，后面*表示以xxx开头，前后*表示包含xxx的过滤
+	"field_hide": ["*password*", "*token*"],
+	// 传值分隔符，如果允许多个值，可以通过这个来分割，如果不允许传多个值则设置为空
+	"separator": "|",
+	// 关键词，用于过滤掉这些值不会写到查询条件中，同时用来识别传的参数
+	"keyword": {
+		// 数据表名，当"table":"{0}", 允许识别表明
+		"table": "table",
+		// 排序方式
+		"orderby": "orderby",
+		// 查询的字段
+		"field": "field",
+		// 页码
+		"page": "page",
+		// 页面大小
+		"size": "size",
+		// 总计，返回查询结果总数
+		"count": "count",
+		// 调用方式
+		"method": "method"
+	},
+	// 调用方式 add增 del删 set改 get查 import导入 export导出, 支持什么方式就传什么值，支持多个用空格分隔
+	"method": "add del set get import export",
+	// 查询条件转换
+	"query": {
+		// 当username=xx时，转为`username` like '%xxx%'的SQL语法
+		"username": "`username` like '%{0}%'"
+	},
+	// 修改时的查询条件
+	"where": {
+		// 当修改查询条件出现user_id=xx时，转为`user_id` = 'xxx'的SQL语法
+		"user_id": "`user_id` = '{0}'"
+	},
+	// 修改时值转换
+	"update": {
+		// 当修改的正文中出现username是转换为指定格式
+		"username": "`username` = '{0}'"
+	},
+	// SQL执行脚本，当设置js文件名后, 执行该SQL还将调用这个脚本
+	"func_file": "",
+	// 导入导出格式，转换导入、导出Eexcel时字段名和字段值
+	"format": [],
+	// 去重条件，需要查重、并去重的字段在这里写
+	"del_repeat": {}
+}

package/demo/app/sys/plugin/main/api_upload/image/api.json

@@ -0,0 +1,15 @@
+{
+    "name": "upload_image",
+    "title": "上传图片",
+    "description": "用于上传图片",
+    "path": "/upload/image",
+    "type": "api",
+    "func_file": "./index.js",
+    "func_name": "",
+    "method": "POST",
+    "cache": 0,
+    "client_cache": false,
+    "param_path": "./param.json",
+    "sql_path": "",
+    "check_param": true
+}

package/demo/app/sys/plugin/main/api_upload/image/index.js

@@ -0,0 +1,62 @@
+const path = require('path');
+const fs = require('fs');
+var dir = '/app/sys/static/img/';
+var url_path = "/sys/img/";
+/**
+ * @description 接口主函数
+ * @param {Object} ctx HTTP上下文
+ * @param {Object} db 数据管理器,如: { next: async function{}, ret: {} }
+ * @return {Object} 执行结果
+ */
+async function main(ctx, db) {
+	var req = ctx.request;
+	var query = req.query;
+	var url = "";
+	if (req.files && req.files.file) {
+		var f = req.files.file;
+		// 创建可读流
+		const render = fs.createReadStream(f.path);
+		var stamp = Date.now();
+		var name = "image_" + stamp + '.' + f.name.split('.').pop();
+		let file = path.join($.runPath, dir, name);
+		const fileDir = path.join($.runPath, dir);
+		if (!fs.existsSync(fileDir)) {
+			fs.mkdirSync(fileDir, err => {
+				console.log(err)
+				console.log('创建失败')
+			});
+		}
+		// 创建写入流
+		try {
+			const upStream = fs.createWriteStream(file);
+			render.pipe(upStream);
+			url =  url_path + name;
+		} catch (e) {
+			fs.closeSync(file);
+			console.log(e);
+		}
+	} else if (req.body['image']) {
+		var data = req.body['image'];
+		var extension = data.between('image/', ';');
+		if(!extension){
+			extension = req.body['filename'].split('.').pop();
+		}
+		data = data.replace(/^data:image\/\w+;base64,/, "");
+		var bf = Buffer.from(data, 'base64');
+		var stamp = Date.now();
+		var name = "image_" + stamp + "." + extension;
+		var file = path.join($.runPath, dir, name);
+		try {
+			fs.writeFileSync(file, bf);
+			url = url_path + name;
+		} catch (e) {
+			fs.closeSync(file);
+			console.log(e);
+		}
+	}
+	return $.ret.obj({
+		url
+	});
+};
+
+exports.main = main;

package/demo/app/sys/plugin/main/api_upload/image/param.json

@@ -0,0 +1,9 @@
+{
+    "name": "upload_image",
+    "filter": true,
+    "method": "post",
+    "list": [],
+    "func_file": "",
+    "func_name": "",
+    "title": "上传图片"
+}

package/demo/app/sys/plugin/main/task/task_demo/index.js

@@ -0,0 +1,37 @@
+/**
+ * 定时任务函数
+ */
+exports.main = async function main() {
+	$.log.debug('定时任务, 执行中...');
+};
+
+/**
+ * 执行结果通知
+ * @param {String} name 任务名称
+ * @param {String} state 状态
+ */
+exports.notify = async function(name, state) {
+	// switch (state) {
+	// 	case "init":
+	// 		$.log.debug('初始化');
+	// 		break;
+	// 	case "start":
+	// 		$.log.debug('开始执行');
+	// 		break;
+	// 	case "stop":
+	// 		$.log.debug('已暂停');
+	// 		break;
+	// 	case "suspend":
+	// 		// 主动中断
+	// 		$.log.debug('已中断');
+	// 		break;
+	// 	case "time_end":
+	// 		$.log.debug('已到期');
+	// 		break;
+	// 	case "completed":
+	// 		$.log.debug('已完成');
+	// 		break;
+	// 	default:
+	// 		break;
+	// }
+};

package/demo/app/sys/plugin/main/task/task_demo/task.json

@@ -0,0 +1,24 @@
+{
+	// 任务标题
+	"title": "示例任务",
+	// 任务描述
+	"description": "描述任务使用方法",
+	// 任务名称，用于动态增删改查
+	"name": "demo",
+	// 任务驱动的脚本文件
+	"func_file": "./index.js",
+	// 任务执行次数，执行次数达标后不再执行。0为不限次数，一直执行
+	"num": 2,
+	// 任务间隔时长，单位：毫秒
+	"interval": 1000,
+	// 任务启动等待时长，单位：毫秒
+	"wait": 0,
+	// 任务触发的时间，可设置的格式分别为: yyyy-MM-dd hh:mm:ss, MM-dd hh:mm:ss, dd hh:mm:ss, hh:mm:ss, hh:mm, mm 例如: 08:00, 则为每天8点触发
+	"time": "",
+	// 任务开始日期，例如：2020-10-01开始执行，为空则不限制
+	"date_start": "",
+	// 任务结束日期，例如：2020-10-07不再执行，为空则不限制
+	"date_end": "",
+	// 任务排序，决定多个任务的执行优先顺序
+	"sort": 100
+}

package/demo/app/sys/plugin/user/index.js

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

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