mm_os 3.3.1 → 4.0.1

package/com/api/index.js

@@ -0,0 +1,198 @@
+const Manager = require('mm_machine').Manager;
+const Drive = require('./drive');
+
+/**
+ * Api接口类
+ * @class
+ * @augments {Manager}
+ */
+class Api extends Manager {
+  /**
+   * 配置参数
+   * @type {object}
+   */
+  static config = {
+    /**
+     * 名称
+     * @type {string}
+     */
+    name: '',
+    /**
+     * 标题
+     * @type {string}
+     */
+    title: 'API接口',
+    /**
+     * 描述
+     * @type {string}
+     */
+    description: '这是API接口管理器',
+    /**
+     * 检索文件名
+     * @type {string}
+     */
+    filename: 'api.json',
+    /**
+     * 模板目录
+     * @type {string}
+     */
+    tpl_dir: __dirname,
+    /**
+     * 基础目录
+     * @type {string}
+     */
+    base_dir: '../common/api'.fullname(__dirname),
+    /**
+     * 自定义目录，加载项目自定义资源
+     * @type {string}
+     */
+    dir: './app'.fullname(),
+    /**
+     * 搜索模式 dir按目录搜索 | file按文件名搜索
+     * @type {string}
+     */
+    search_way: 'dir',
+    /**
+     * 是否懒加载
+     * @type {boolean}
+     */
+    lazy_load: true,
+    /**
+     * 模式
+     * 1.生产模式，改变文件不会重新加载
+     * 2.热更新模式，改变配置文件会重新加载配置，不重新加载脚本
+     * 3.热重载模式，改变配置文件都会加载配置和脚本
+     * 4.重载模式，执行完后重新加载脚本，避免变量污染
+     * 5.热更新+重载模式，改变配置文件重新加载配置和脚本，执行完后重新加载脚本
+     * @type {number}
+     */
+    mode: 3
+  };
+
+  /**
+   * 构造函数
+   * @param {object} config 配置参数
+   * @param {object} parent 父级模块
+   */
+  constructor(config, parent) {
+    super({ ...Api.config, ...config }, parent);
+  }
+}
+
+/**
+ * Api驱动类
+ */
+Api.prototype.Drive = Drive;
+
+/**
+ * 接口排序
+ */
+Api.prototype._sort = function () {
+  let sort_key = this.config.sort_key || 'sort';
+  let infos = this.getInfos();
+  infos.sort((o1, o2) => {
+    let m1 = this.getMod(o1.name);
+    let m2 = this.getMod(o2.name);
+    var p1 = m1.config.path;
+    var p2 = m2.config.path;
+    var n = p2.length - p1.length;
+    if (n) {
+      return n;
+    } else {
+      return m1.config[sort_key] - m2.config[sort_key];
+    }
+  });
+};
+
+/**
+ * 匹配目标
+ * @param {string} str 目标
+ * @param {string} pattern 模式
+ * @returns {boolean} 是否匹配
+ */
+Api.prototype.isMatch = function (str, pattern) {
+  if (str === pattern) {
+    return true;
+  } else if (pattern.startsWith('*')) {
+    const clean = pattern.replaceAll('*', '');
+    if (pattern.endsWith('*')) {
+      return str.indexOf(clean) !== -1;
+    } else {
+      return str.endsWith(clean);
+    }
+  } else if (pattern.endsWith('*')) {
+    const clean = pattern.replaceAll('*', '');
+    return str.startsWith(clean);
+  }
+  else {
+    return false;
+  }
+};
+
+/**
+ * 执行Api
+ * @param {object} ctx 请求上下文
+ * @param {object} db 数据管理器
+ * @returns {object | string} 返回一个对象或字符串
+ */
+Api.prototype.run = async function (ctx, db = {}) {
+  let path = ctx.request.path;
+  let infos = this.getInfos();
+
+  for (var i = 0, info; info = infos[i++];) {
+    if (info.state === 1) {
+      let mod = this.getMod(info.name);
+      if (mod && this.isMatch(path, mod.config.path)) {
+        if (!mod.isLoaded()) {
+          await mod.call('loadScript');
+        }
+        var ret = await mod.run(ctx, db);
+        if (this.config.mode > 4) {
+          mod.do('reload');
+        }
+        if (ret) {
+          db.ret = ret;
+          break;
+        }
+      }
+    }
+  }
+  return db.ret;
+};
+
+/**
+ * @module 导出API类
+ */
+exports.Api = Api;
+
+
+/**
+ * 创建全局管理器
+ */
+if (!$.pool.api) {
+  $.pool.api = {};
+}
+
+/**
+ * API管理器,用于创建缓存
+ * @param {string} scope 作用域
+ * @param {string} title 标题
+ * @returns {object} 返回一个缓存类
+ */
+function apiAdmin(scope, title) {
+  var sc = scope || $.val.scope + '';
+  var obj = $.pool.api[sc];
+  if (!obj) {
+    $.pool.api[sc] = new Api({
+      name: sc,
+      title: title
+    });
+    obj = $.pool.api[sc];
+  }
+  return obj;
+}
+
+/**
+ * @module 导出API管理器
+ */
+$.admin.api = apiAdmin;

package/com/api/oauth.js

@@ -0,0 +1,200 @@
+/**
+ * Oauth身份验证驱动类
+ * @class
+ */
+class Oauth {
+  static config = {
+    // 是否登录
+    'sign_in': false,
+    // 要求会员级别
+    'vip': 0,
+    // 要求管理级别
+    'gm': 0,
+    // 要求商户级别
+    'mc': 0,
+    // 要求用户组
+    'user_group': [],
+    // 要求管理组
+    'user_admin': [],
+    // 文件路径, 当调用函数不存在时，会先从文件中加载
+    'main': ''
+  };
+  /**
+   * 构造函数
+   * @param {string} config 当前路径
+   * @class
+   */
+  constructor(config) {
+    // 配置参数
+    this.config = { ...Oauth.config, ...config };
+  }
+}
+
+/**
+ * 加载配置对象
+ * @param {object} obj 配置对象
+ */
+Oauth.prototype.loadObj = function (obj) {
+  $.push(this.config, obj);
+  var f = this.config.main;
+  if (f) {
+    var file = f.fullname(this._getDir());
+    if (file.hasFile()) {
+      var cs = require(file);
+      if (cs) {
+        $.push(this, cs);
+      }
+    }
+  }
+};
+
+/**
+ * 身份验证主程序
+ * @param {object} ctx HTTP请求上下文
+ * @returns {object} 验证失败返回错误提示，验证通过返回null
+ */
+Oauth.prototype.main = async function (ctx) {
+  return null;
+};
+
+/**
+ * 小校验
+ * @param {object} ctx HTTP请求上下文
+ */
+Oauth.prototype.checkSub = async function (ctx) {
+
+};
+
+/**
+ * 验证身份
+ * @param {object} ctx HTTP请求上下文
+ * @returns {object} 验证失败返回错误提示，验证通过返回null
+ */
+Oauth.prototype.check = async function (ctx) {
+  // 无需登录则不验证身份和权限
+  var cg = this.config;
+  var user = await this._getUser(ctx);
+  if (!cg.signIn) {
+    return null;
+  }
+  var error = await this.main(ctx);
+  if (error) {
+    return error;
+  }
+  if (!user) {
+    return {
+      code: 60000,
+      message: '账户未登录!'
+    };
+  }
+  if (await this._checkAccess(user, cg)) {
+    return {
+      code: 70000,
+      message: '没有访问权限'
+    };
+  }
+  return null;
+};
+
+/**
+ * 获取用户信息
+ * @param {object} ctx HTTP请求上下文
+ * @returns {object|null} 用户信息
+ * @private
+ */
+Oauth.prototype._getUser = async function (ctx) {
+  var user = ctx.session?.user;
+  if (user) {
+    return user;
+  }
+  var token = ctx.headers[$.dict.token];
+  if (!token) {
+    return null;
+  }
+  var u = await $.cache.get($.dict.session_id + '_' + token);
+  if (!u) {
+    return null;
+  }
+  var user_info = this._extractUserFromCache(u);
+  if (user_info) {
+    ctx.session.user = user_info;
+  }
+  return user_info;
+};
+
+/**
+ * 从缓存中提取用户信息
+ * @param {object|string} u 缓存数据
+ * @returns {object|null} 用户信息
+ * @private
+ */
+Oauth.prototype._extractUserFromCache = function (u) {
+  var type = typeof (u);
+  if (type === 'string') {
+    var o = u.toJson();
+    return o.user;
+  } else if (type === 'object' && Object.keys(u).length > 0) {
+    return u.user;
+  }
+  return null;
+};
+
+/**
+ * 检查用户访问权限
+ * @param {object} user 用户信息
+ * @param {object} config 配置信息
+ * @returns {boolean} 是否无权限
+ * @private
+ */
+Oauth.prototype._checkAccess = function (user, config) {
+  return this._checkAccessLevels(user, config) ||
+    this._checkUserGroups(user, config) ||
+    this._checkAdminGroups(user, config);
+};
+
+/**
+ * 检查用户级别权限
+ * @param {object} user 用户信息
+ * @param {object} config 配置信息
+ * @returns {boolean} 是否无权限
+ * @private
+ */
+Oauth.prototype._checkAccessLevels = function (user, config) {
+  return (config.gm !== 0 && user.gm < config.gm) ||
+    (config.vip !== 0 && user.vip < config.vip) ||
+    (config.mc !== 0 && user.mc < config.mc);
+};
+
+/**
+ * 检查用户组权限
+ * @param {object} user 用户信息
+ * @param {object} config 配置信息
+ * @returns {boolean} 是否无权限
+ * @private
+ */
+Oauth.prototype._checkUserGroups = function (user, config) {
+  if (config.user_group.length === 0) {
+    return false;
+  }
+  var user_groups = user.user_group.split(',');
+  var has_group = config.user_group.some(group => user_groups.includes(group));
+  return !has_group;
+};
+
+/**
+ * 检查管理组权限
+ * @param {object} user 用户信息
+ * @param {object} config 配置信息
+ * @returns {boolean} 是否无权限
+ * @private
+ */
+Oauth.prototype._checkAdminGroups = function (user, config) {
+  if (config.user_admin.length === 0) {
+    return false;
+  }
+  var admin_groups = user.user_admin.split(',');
+  var has_admin = config.user_admin.some(group => admin_groups.includes(group));
+  return !has_admin;
+};
+
+module.exports = Oauth;

package/com/api/script.tpl.js

@@ -0,0 +1,32 @@
+
+/**
+ * 接口主函数
+ * @param {object} ctx HTTP上下文
+ * @param {object} db 数据管理器,如: { next: async function{}, ret: {} }
+ * @returns {object} 执行结果
+ */
+async function main(ctx, db) {
+  // 获取请求参数
+  var req = ctx.request;
+  var {
+    query,
+    body
+  } = req;
+  // return "hello world" + JSON.stringify(body);
+
+  // 操作sql模板
+  var m = query.method;
+  if (m === 'add') {
+
+  } else if (m === 'del') {
+
+  } else if (m === 'set') {
+
+  } else {
+
+  }
+  var ret = await this.sql.run(query, body, db);
+  return ret;
+};
+
+exports.main = main;

package/com/cmd/README.md

@@ -0,0 +1,11 @@
+## 指令框架
+用于以聊天的方式操作程序。
+前端发送字符串，后端通过字符串判断是否为指令进而执行程序。提高工作效率。
+
+
+## 流程
+1. 前端发送消息，后端接收消息。
+2. 后端先进行基础的指令判断（内容是否匹配有指令关键词），判断消息是否为指令。
+3. 如果是指令，则执行指令处理。
+4. 如果不是指令，再交由AI判断是否为指令。
+5. 如果AI判断为指令，则执行指令处理。

package/com/cmd/com.json

@@ -0,0 +1,5 @@
+{
+    "name": "Cmd",
+    "title": "指令管理器",
+    "state": 1
+}

package/com/cmd/config.tpl.json

@@ -0,0 +1,122 @@
+{
+	// 指令（意图）名称, 用于动态增删改配置
+	"name": "{name || 'demo'}",
+	// 标题, 用于查询指令时
+	"title": "{title || '指令标题'}",
+	// 描述, 用于介绍该指令的作用
+	"description": "{description || '暂无描述'}",
+	// 示例（训练样本）, 用于提示AI该指令的格式，多个样本用分号隔开
+	"example": "{example || '播放一首周杰伦的歌；听音乐，邓紫棋的喜欢你；听歌邓紫棋的《喜欢你》；我想听邓紫棋的《光年之外》'}",
+	// 指令分组, 可以将特有的指令分一个组, 方便用户查询
+	"group": "{group || 'default'}",
+	// 指令分类, 例如: 查询服务类query、执行类execute、管理类admin、控制类control、播放类play、游戏类game
+	"type": "{type || 'control'}",
+	// 时态, 分before之前、check验证、main主要、render渲染、after之后五个时态
+	"tense": "{tense || 'main'}",
+	// 文件名, 用于驱动脚本, 实现业务 
+	"main": "{main || './index.js'}",
+  // 指令状态, 1为启用, 0为禁用
+  "state": 1,
+	// 执行顺序, 数值越小的指令越优先执行
+	"sort": 100,
+	// 匹配关键词组, 当聊天中出现其中一个关键词则会执行该指令 
+	"match": ["播放", "听", "听歌"],
+	// 结束会话 当值为1时，指令触发并返回了内容后不再执行其他指令。为0时，指令触发仍继续执行其他指令
+	"end": 1,
+	// 不包含关键词, 如果匹配后, 出现不应该包含的关键词, 则不会执行指令 
+	"not": [],
+	// 移除关键词, 如果聊天中含这些词, 将会被剔除在执行指令
+	"remove": [],
+	// 提取特定词, 如果聊天中含有特定词, 会被提取出来再执行指令
+	"extract": [],
+	// 阶段（1-9），可用于补全参数fill、过滤参数filter、校验参数check、更新参数update
+	"stage": [
+		// 第一阶段
+		{
+			// 方式 fill为补全，会将本次消息加入到msg.form[name]中
+			"mode": "fill",
+			/* 参数, 用于执行指令行为前抽取关键词进行验证, 然后再执行指令 */
+			"param": [
+				{
+					// 参数名称, 用于提交数据时
+					"name": "music_name",
+					// 参数标题, 用于提示用户什么参数错误
+					"title": "音乐名称",
+					// 是否必填, 1为必填, 0为选填
+					"required": 1,
+					// 参数描述, 用于提示AI该参数的作用
+					"desc": "要播放的音乐名称",
+					// 示例, 用于提示该参数的格式，多个示例用分号隔开，别名用竖线隔开
+					"example": "画；喜欢你；告白气球；来自天堂的魔鬼；",
+					// 抽验顺序, 越小的越优先验证, 并且抽取后排列在前
+					"sort": 10,
+					// 抽取/校验格式, 如果格式不符合, 则表示验证未通过,提示用户
+					"format": "/[a-zA-Z0-9_\u4e00-\u9fa5]+/g",
+					// 缺少参数提示, 如果不包含该参数, 则做出的提示
+					"not_tip": "音乐名称是？",
+					// 错误提示, 提示用户补充参数时, 补充参数错误时做出的提示
+					"error_tip": "音乐名称不正确",
+					// 校验/抽取的函数名, 通过函数的方式抽取/校验参数
+					"func_name": "",
+					// 同义词, 用于训练NLP, 多个同义词用分号隔开
+					"aliases": "音乐；歌曲"
+				},
+				{
+					// 参数名称, 用于提交数据时
+					"name": "author",
+					// 参数标题, 用于提示用户什么参数错误
+					"title": "音乐作者",
+					// 是否必填, 1为必填, 0为选填
+					"required": 0,
+					// 参数描述, 用于提示AI该参数的作用
+					"desc": "写这首歌的人",
+					// 示例, 用于提示该参数的格式，多个示例用分号隔开，别名用竖线隔开
+					"example": "周杰伦|杰伦；邓紫棋|GEM",
+					// 抽验顺序, 越小的越优先验证, 并且抽取后排列在前
+					"sort": 10,
+					// 抽取/校验格式, 如果格式不符合, 则表示验证未通过,提示用户
+					"format": "/[a-zA-Z0-9_\u4e00-\u9fa5]+/g",
+					// 缺少参数提示, 如果不包含该参数, 则做出的提示
+					"not_tip": "音乐作者是？",
+					// 错误提示, 提示用户补充参数时, 补充参数错误时做出的提示
+					"error_tip": "音乐作者不正确",
+					// 校验/抽取的函数名, 通过函数的方式抽取/校验参数
+					"func_name": "",
+					// 同义词, 用于训练NLP, 多个同义词用分号隔开
+					"aliases": "作者；作词人"
+				},
+				{
+					// 参数名称, 用于提交数据时
+					"name": "singer",
+					// 参数标题, 用于提示用户什么参数错误
+					"title": "歌手",
+					// 是否必填, 1为必填, 0为选填
+					"required": 1,
+					// 参数描述, 用于提示AI该参数的作用
+					"desc": "唱歌的人",
+					// 示例, 用于提示该参数的格式，多个示例用分号隔开，别名用竖线隔开
+					"example": "周杰伦|杰伦；邓紫棋|GEM|G.E.M.",
+					// 抽验顺序, 越小的越优先验证, 并且抽取后排列在前
+					"sort": 10,
+					// 抽取/校验格式, 如果格式不符合, 则表示验证未通过,提示用户
+					"format": "/[a-zA-Z0-9_\u4e00-\u9fa5]+/g",
+					// 缺少参数提示, 如果不包含该参数, 则做出的提示
+					"not_tip": "歌手是？",
+					// 错误提示, 提示用户补充参数时, 补充参数错误时做出的提示
+					"error_tip": "歌手不正确",
+					// 校验/抽取的函数名, 通过函数的方式抽取/校验参数
+					"func_name": "",
+					// 同义词, 用于训练NLP, 多个同义词用分号隔开
+					"aliases": "歌手；唱作者"
+				}
+			]
+		},
+		// 第二阶段
+		{
+			// 方式 update为更新，会将本次消息替换掉msg.form[name]的值
+			"mode": "update",
+			// 验证参数集
+			"param": []
+		}
+	]
+}