mm_os 3.3.0 → 4.0.0

package/core/model/index.js

@@ -0,0 +1,272 @@
+const {
+  Drive
+} = require('mm_machine');
+const Mod = require('./model.js');
+
+/**
+ * 数据模型基类
+ * 提供数据存储、查询、修改等核心功能
+ */
+class Model extends Drive {
+  static config = {
+    // 模型名称
+    'name': 'default',
+    // 标题
+    'title': '用户账户模型',
+    // 描述
+    'description': '定于用户账户模型的组件',
+    // 主文件
+    'main': '',
+    // 状态 0：禁用 1：启用
+    'state': 1,
+    // 排序，越小越靠前
+    'sort': 100,
+    // 模型包含字段
+    'fields': {}
+  };
+  /**
+   * 构造函数
+   * @param {object} config 配置参数
+   * @param {object} parent 父对象
+   */
+  constructor(config, parent) {
+    super({ ...Model.config, ...config || {} }, parent);
+  }
+}
+
+/**
+ * 获取模板目录
+ * @returns {string} 模板目录
+ */
+Model.prototype.getTplDir = function() {
+  return __dirname;
+};
+
+/**
+ * 初始化核心组件
+ * @param {object} eventer 事件管理器
+ * @param {object} logger 日志管理器
+ */
+Model.prototype._initCore = async function (eventer, logger) {
+  // 初始化依赖项
+  if (logger) {
+    this.setLogger(logger);
+  }
+  if (eventer) {
+    this.getEventer = function () {
+      return eventer;
+    };
+  }
+};
+
+/**
+ * 校验字段值是否在范围内
+ * @param {number} value 要校验的值
+ * @param {object} rule 字段配置对象
+ * @param {string} key 字段名
+ * @throws {TypeError} 校验失败时抛出错误
+ */
+Model.prototype._checkRange = function (value, rule, key) {
+  // 参数校验
+  if (typeof rule !== 'object' || Array.isArray(rule)) {
+    throw new TypeError('字段配置必须是对象');
+  }
+  if (typeof key !== 'string') {
+    throw new TypeError('字段名必须是字符串');
+  }
+
+  if (rule.min !== undefined && value < rule.min) {
+    throw new TypeError(`字段 ${key} 必须大于等于 ${rule.min}`);
+  }
+  if (rule.max !== undefined && value > rule.max) {
+    throw new TypeError(`字段 ${key} 必须小于等于 ${rule.max}`);
+  }
+  // 校验枚举值
+  if (rule.enum !== undefined && !rule.enum.includes(value)) {
+    throw new TypeError(`字段 ${key} 的值必须是 ${rule.enum.join('、')}`);
+  }
+};
+
+/**
+ * 验证必填字段
+ * @param {object} fields 字段配置
+ * @param {object} data 数据
+ */
+Model.prototype._checkRequired = function (fields, data) {
+  for (var key in fields) {
+    var rule = fields[key];
+    if (rule.required && (data[key] === undefined || data[key] === null)) {
+      throw new TypeError(`字段 ${key} 是必填字段`);
+    }
+  }
+};
+
+/**
+ * 验证字段类型
+ * @param {*} value 字段值
+ * @param {object} rule 规则
+ * @param {string} key 字段名
+ */
+Model.prototype._checkType = function (value, rule, key) {
+  const TYPE_CHECKS = {
+    'number': typeof value === 'number',
+    'string': typeof value === 'string',
+    'boolean': typeof value === 'boolean',
+    'object': typeof value === 'object' && !Array.isArray(value),
+    'array': Array.isArray(value)
+  };
+  
+  if (!TYPE_CHECKS[rule.type]) {
+    const TYPE_NAMES = {
+      'number': '数字',
+      'string': '字符串',
+      'boolean': '布尔值',
+      'object': '对象',
+      'array': '数组'
+    };
+    throw new TypeError(`字段 ${key} 必须是${TYPE_NAMES[rule.type]}`);
+  }
+};
+
+/**
+ * 验证字符串长度
+ * @param {string} value 字段值
+ * @param {object} rule 规则
+ * @param {string} key 字段名
+ */
+Model.prototype._checkStringLength = function (value, rule, key) {
+  if (rule.min_length !== undefined && value.length < rule.min_length) {
+    throw new TypeError(`字段 ${key} 长度不能小于 ${rule.min_length}`);
+  }
+  if (rule.max_length !== undefined && value.length > rule.max_length) {
+    throw new TypeError(`字段 ${key} 长度不能大于 ${rule.max_length}`);
+  }
+};
+
+/**
+ * 验证单个字段
+ * @param {*} value 字段值
+ * @param {object} rule 规则
+ * @param {string} key 字段名
+ */
+Model.prototype._checkField = function (value, rule, key) {
+  this._checkType(value, rule, key);
+  if (rule.type === 'string') {
+    this._checkStringLength(value, rule, key);
+    if (rule.pattern && !rule.pattern.test(value)) {
+      throw new TypeError(`字段 ${key} 格式不正确`);
+    }
+  }
+  if (rule.min !== undefined || rule.max !== undefined || rule.enum !== undefined) {
+    this._checkRange(value, rule, key);
+  }
+};
+
+/**
+ * 数据校验方法
+ * @param {object} data 要校验的数据
+ * @param {string} type 校验类型
+ * @returns {boolean} 校验结果
+ * @throws {TypeError} 校验失败时抛出错误
+ */
+Model.prototype._check = function (data, type = 'add') {
+  if (typeof data !== 'object' || Array.isArray(data)) {
+    throw new TypeError('校验数据必须是对象');
+  }
+  if (typeof type !== 'string') {
+    throw new TypeError('校验类型必须是字符串');
+  }
+  var fields = this.config.fields;
+  if (!fields || typeof fields !== 'object') {
+    throw new TypeError('字段配置不存在');
+  }
+  if (type === 'add') {
+    this._checkRequired(fields, data);
+  }
+  for (var key in data) {
+    var rule = fields[key];
+    if (rule) {
+      this._checkField(data[key], rule, key);
+    }
+  }
+  return true;
+};
+
+/**
+ * 创建模型实例
+ * @param {object} data 实例数据
+ * @returns {object} 新实例
+ * @throws {TypeError} 参数类型错误时抛出
+ */
+Model.prototype.create = function (data = {}) {
+  // 参数校验
+  if (typeof data !== 'object' || Array.isArray(data)) {
+    throw new TypeError('实例数据必须是对象');
+  }
+
+  var model = new Mod();
+  var fields = this.config.fields;
+
+  // 数据校验
+  if (this._check(data, 'add')) {
+    for (var key in fields) {
+      model[key] = this._getDefaultValue(data[key], fields[key]);
+    }
+  }
+
+  return model;
+};
+
+/**
+ * 获取默认值
+ * @param {any} dataValue 数据值
+ * @param {object} rule 字段规则
+ * @returns {any} 默认值
+ * @private
+ */
+Model.prototype._getDefaultValue = function (dataValue, rule) {
+  if (dataValue !== undefined) {
+    return dataValue;
+  }
+  if (rule.default !== undefined) {
+    return rule.default;
+  }
+  var typeDefaults = {
+    'number': 0,
+    'string': '',
+    'boolean': false,
+    'object': {},
+    'array': []
+  };
+  return typeDefaults[rule.type] || null;
+};
+
+/**
+ * 更新模型实例
+ * @param {object} model 要更新的模型实例
+ * @param {object} data 更新数据
+ * @returns {object} 更新后的实例
+ * @throws {TypeError} 参数类型错误时抛出
+ */
+Model.prototype.update = function (model, data = {}) {
+  // 参数校验
+  if (typeof model !== 'object' || Array.isArray(model)) {
+    throw new TypeError('模型实例必须是对象');
+  }
+  if (typeof data !== 'object' || Array.isArray(data)) {
+    throw new TypeError('更新数据必须是对象');
+  }
+
+  // 数据校验
+  if (this._check(data, 'update')) {
+    for (var key in data) {
+      if (key in model) {
+        model[key] = data[key];
+      }
+    }
+  }
+
+  return model;
+};
+
+exports.Model = Model;

package/core/model/model.js

@@ -0,0 +1,27 @@
+/**
+ * 模型基类
+ */
+class Model {
+  #is_dirty = false;
+
+  /**
+   * 模型构造函数
+   */
+  constructor() {
+
+  }
+
+  /**
+   * 检查模型是否脏数据
+   * @param {boolean} is_dirty 是否脏数据
+   * @returns {boolean} 是否脏数据
+   */
+  isDirty(is_dirty) {
+    if (is_dirty !== undefined) {
+      this.#is_dirty = is_dirty;
+    }
+    return this.#is_dirty;
+  }
+}
+
+module.exports = Model;

package/core/model/script.tpl.js

@@ -0,0 +1,20 @@
+/**
+ * 富血模型
+ */
+module.exports = {
+  /**
+   * 添加消息模型方法
+   * @param {object} model 消息模型实例
+   */
+  addMethods(model) {
+    // /**
+    //  * 发送消息
+    //  * @param {string} content 消息内容
+    //  * @param {string} priority 消息优先级
+    //  */
+    // model.send = function (content, priority = $.const.PRIORITIES.normal) {
+    //   this.log('debug', '发送消息', { content, priority });
+    //   // 实际发送消息的逻辑
+    // };
+  }
+};

package/core/notifier/config.tpl.json

@@ -0,0 +1,14 @@
+{
+  // 名称
+  "name": "${name}",
+  // 标题
+  "title": "${title || '短信通知'}",
+  // 描述
+  "description": "${description || '定义短信通知逻辑'}",
+  // 主文件
+  "main": "${main || 'index.js'}",
+  // 状态 0：禁用 1：启用
+  "state": 1,
+  // 排序，越小越靠前
+  "sort": 100
+}

package/core/notifier/index.js

@@ -0,0 +1,77 @@
+const { Drive } = require('mm_machine');
+
+/**
+ * 通知器
+ * 进行邮箱、短信等通知
+ */
+class Notifier extends Drive {
+  static config = {
+    // 通知器名称
+    name: 'default'
+  };
+  /**
+   * 构造函数
+   * @param {object} config 配置参数
+   */
+  constructor(config) {
+    super({ ...Notifier.config, ...config || {} });
+  }
+}
+
+/**
+ * 获取模板目录
+ * @returns {string} 模板目录
+ */
+Notifier.prototype.getTplDir = function() {
+  return __dirname;
+};
+
+/**
+ * 初始化核心
+ * @param {object} eventer 事件总线
+ * @param {object} logger 日志管理器
+ */
+Notifier.prototype._initCore = async function(eventer, logger) {
+  // 初始化依赖项
+  if (logger) {
+    this.setLogger(logger);
+  }
+  if (eventer) {
+    this.getEventer = function () {
+      return eventer;
+    };
+  }
+};
+
+/**
+ * 启动
+ */
+Notifier.prototype._start = async function() {
+  this.log('info', 'started');
+};
+
+/**
+ * 停止模型
+ */
+Notifier.prototype._stop = async function() {
+  this.log('info', 'stopped');
+};
+
+/**
+ * 销毁
+ */
+Notifier.prototype._destroy = function() {
+  try {
+    // 清理存储引用
+    this._store = {};
+    this._data_validator = null;
+
+    this.log('info', 'destroyed');
+    // 移除所有监听器
+    this.removeAllListeners();
+  } catch (error) {
+    this.log('error', `销毁失败`, error);
+  }
+};
+
+exports.Notifier = Notifier;

package/core/notifier/script.tpl.js

@@ -0,0 +1,20 @@
+/**
+ * 通知器
+ */
+module.exports = {
+  /**
+   * 初始化
+   * @param {object} eventer 事件总线
+   */
+  async _init(eventer) {
+    // this.log('debug', '初始化');
+  },
+  /**
+   * 主要逻辑
+   * @param {...any} args 参数列表
+   */
+  async main(...args) {
+  // 主要代码写在这
+    this.log('debug', 'notifier main 被调用', { args });
+  }
+};

package/core/plugin/config.tpl.json

@@ -0,0 +1,24 @@
+{
+  // 名称
+  "name": "${name}",
+  // 标题
+  "title": "${title || '战斗插件'}",
+  // 描述
+  "description": "${description || '介绍插件的作用'}",
+  // 版本
+  "version": "${version || '1.0.0'}",
+  // 作者
+  "author": "${author || '(匿名)'}",
+	// 用于什么应用
+	"app": "${app || 'sys'}",
+  // 主文件
+  "main": "${main || 'index.js'}",
+  // 状态 0：禁用 1：启用
+  "state": 1,
+  // 排序，越小越靠前
+  "sort": 100,
+  // git仓库地址
+  "git": "${git || ''}",
+  // 依赖的npm module
+  "dependencies": []
+}

package/core/plugin/index.js

@@ -0,0 +1,232 @@
+const {
+  Drive
+} = require('mm_machine');
+
+/**
+ * 插件基类
+ * 负责管理插件的生命周期、资源加载和依赖管理
+ */
+class Plugin extends Drive {
+  static config = {
+    // 插件名称
+    name: '',
+    // 插件标题
+    title: '插件',
+    // 插件描述
+    description: '介绍插件的作用',
+    // 插件版本
+    version: '1.0.0',
+    // 用于什么应用
+    app: 'tool',
+    // 作者
+    author: 'qww',
+    // 主文件
+    main: './index.js',
+    // git仓库地址
+    git: '',
+    // 依赖的npm模块
+    dependencies: []
+  };
+  /**
+   * 构造函数
+   * @param {object} config 配置参数
+   * @param {object} parent 父对象
+   */
+  constructor(config, parent) {
+    super({ ...Plugin.config, ...config || {} }, parent);
+    this.options = {};
+  }
+}
+
+
+/**
+ * 获取模板目录
+ * @returns {string} 模板目录
+ */
+Plugin.prototype.getTplDir = function () {
+  return __dirname;
+};
+
+/**
+ * 初始化核心
+ * @param {object} app 应用实例
+ * @param {object} eventer 事件管理器
+ * @param {object} logger 日志管理器
+ * @private
+ */
+Plugin.prototype._initCore = async function (app, eventer, logger) {
+  // 初始化依赖项
+  if (logger) {
+    this.setLogger(logger);
+  }
+  if (eventer) {
+    this.getEventer = function () {
+      return eventer;
+    };
+  }
+  if (app) {
+    this.getApp = function () {
+      return app;
+    };
+    this._db = app.db;
+    this._cache = app.cache;
+    this._filer = app.filer;
+  }
+  // // 初始化管理
+  // await this._initManager();
+  // // 加载资源
+  // await this._loadSources();
+  // // 初始化资源
+  // await this._initSources();
+  // 初始化配置
+  this._initOptions();
+};
+
+/**
+ * 获取插件配置
+ * @returns {object} 插件配置
+ */
+Plugin.prototype.getOptions = function () {
+  return this.options;
+};
+
+/**
+ * 插件初始化之后
+ */
+Plugin.prototype._initOptions = function () {
+  var options = this.getConfigOptions();
+  this.options = this.mergeOptions(options);
+  this.backupOptions();
+};
+
+/**
+ * 获取配置参数
+ * @return {Object} 返回配置参数
+ */
+Plugin.prototype.getConfigOptions = function () {
+  var op = this.config.options || [];
+  var dict = {};
+  for (var i = 0; i < op.length; i++) {
+    var o = op[i];
+    if (o.type === "number") {
+      var val = o.value === 'null' ? '0' : o.value;
+      dict[o.name] = Number(val || '0');
+    } else if (o.type === "boolean") {
+      var val = false;
+      if (o.value) {
+        if (typeof (o.value) == "string") {
+          if (o.value == '1' || o.value == 'true') {
+            val = true;
+          }
+        } else if (typeof (o.value) == "boolean") {
+          val = o.value;
+        }
+      }
+      dict[o.name] = val;
+    } else if (o.type === "object") {
+      var val = o.value === 'null' ? '{}' : o.value;
+      dict[o.name] = o.value.toJSON();
+    } else if (o.type === "array") {
+      var val = o.value === 'null' ? '[]' : o.value;
+      dict[o.name] = o.value.toJSON();
+    } else if (o.value === "null") {
+      dict[o.name] = null;
+    } else if (o.type === "string") {
+      dict[o.name] = o.value || "";
+    } else {
+      dict[o.name] = o.value;
+    }
+  }
+  return dict;
+};
+
+/**
+ * 设计配置
+ * @param {Object} 设置配置
+ * @return {Object} 返回配置参数
+ */
+Plugin.prototype.designOptions = function (body) {
+  var cg = this.config;
+  if (Array.isArray(body)) {
+    cg.options = body;
+  } else {
+    var options = cg.options || [];
+    var option = options.getObj({
+      name: body.name
+    });
+    if (option) {
+      Object.assign(option, body);
+    } else {
+      options.push(body);
+    }
+    cg.options = options;
+  }
+};
+
+/**
+ * 保存配置
+ */
+Plugin.prototype.saveOptions = function (options) {
+  this.options = options;
+  this.backupOptions();
+};
+
+/**
+ * 保存配置
+ */
+Plugin.prototype.backupOptions = function () {
+  var file = this._getCacheOptionsFile();
+  file = file.fullname();
+  file.addDir();
+  file.saveJson(this.options);
+};
+
+/**
+ * 合并配置
+ * @param {Object} cg 配置
+ */
+Plugin.prototype.mergeOptions = function (options) {
+  var file = this._getCacheOptionsFile();
+  var options_cache = file.loadJson();
+  if (options_cache) {
+    $.push(options, options_cache);
+  }
+  return options;
+};
+
+/**
+ * 获取缓存配置文件
+ * @returns {string} 缓存配置文件
+ */
+Plugin.prototype._getCacheOptionsFile = function () {
+  // let app = this.getApp();
+  // let app_name = app.config.name;
+  // let plugin_name = this.config.name;
+  var l = $.slash;
+  let plugin_name = this.config.name;
+  let app_name = this.getApp().config.name;
+  var file = `/cache/${app_name}/${plugin_name}/config.json`.fullname();
+  return file;
+};
+
+
+/**
+ * 获取模型
+ * @param {string} type 模型类型
+ * @returns {object} 返回获取到的模型
+ */
+Drive.prototype.getModel = function (type) {
+  let model = { ...this.config };
+  let dir = this._getDir();
+  let l = $.slash;
+  let app_name = dir.between('app' + l, l);
+  let plugin_name = dir.between('plugin' + l, l);
+  let name = dir.basename();
+  model.app = app_name;
+  model.plugin = plugin_name;
+  model.name = model.name || name;
+  model.path = "/" + app_name + "/" + name;
+  return model;
+};
+
+exports.Plugin = Plugin;