mm_os/core/com/plugin/drive.js

这是超级美眉服务端框架，用于快速构建应用程序。

const compressing = require('compressing');
const Item = require('mm_machine').Item;
const conf = require('mm_config');

/**
 * Plugin插件驱动类
 * @extends {Item}
 * @class 
 */
class Drive extends Item {
	/**
	 * 构造函数
	 * @param {String} dir 当前目录
	 * @constructor
	 */
	constructor(dir) {
		super(dir, __dirname);
		this.default_file = "./plugin.json";
		// 默认启用热更新
		this.mode = 3;
		/**
		 * 当前语言
		 */
		this.lang_now = "zh_CN";
		/**
		 * 语言包
		 */
		this.lang = {};

		/* 通用项 */
		// 配置参数
		this.config = {
			// 应用域
			"app": "",
			// 名称, 由中英文和下“_”组成, 用于修改或卸载 例如: demo
			// 同时也是版本唯一标识，当商城有两个插件名称相同时，可以通过版本号查询和下载
			"name": "",
			// 标题, 介绍事件作用
			"title": "",
			// 描述, 用于描述该事件有什么用的
			"description": "",
			// 版本号
			"version": "1.0.0",
			// 作者
			"author": "",
			// 官网
			"web": "",
			// 状态 0未启用，1启用
			"state": 1,
			// 显示 0不显示，1显示
			"show": 0,
			// 文件路径, 当调用函数不存在时，会先从文件中加载
			"func_file": "./index.js",
			// 回调函数名 用于决定调用脚本的哪个函数
			"func_name": "",
			// 语言包路径
			"lang_path": "./lang/",
			// 插件图标
			"icon": "/img/logo.png",
			// 指令前缀
			"cmd": "",
			// 是否中断执行
			"end": true,
			// 排序
			"sort": 10,
			// 配置
			"options": []
		};
		// 配置
		this.options = {};
	}
}

/**
 * 设置配置
 * @param {Object} config 配置
 */
Drive.prototype.set_config = function(config) {
	var file = this.filename;
	var cg = Object.assign({}, this.config, config || {});
	this.config = conf(cg, file);
}

/**
 * 插件初始化之后
 */
Drive.prototype.set_config_after = function() {
	var options = this.get_config_options();
	this.options = this.merge_options(options);
	this.backup_options();
}

/**
 * 更新配置
 */
Drive.prototype.update_options = function(options = []) {
	var op = this.config.options;
	var list = [];
	for (var i = options.length - 1; i >= 0; i--) {
		var o = options[i];
		var obj = op.get({
			name: o.name
		});
		if (obj) {
			Object.assign(obj, o);
		} else {
			list.push(o);
		}
	}
	for (var i = 0; i < options.length; i++) {
		var o = options[i];
		op.push(o);
	}
}

/**
 * 更新配置后
 * @param {Object} options
 */
Drive.prototype.update_options_after = function(options) {
	// if (this.config.state) {
	// 	this.restart();
	// }
}

/**
 * 获取配置参数
 * @return {Object} 返回配置参数
 */
Drive.prototype.get_options = function() {
	return this.options;
}

/**
 * 获取配置参数
 * @return {Object} 返回配置参数
 */
Drive.prototype.get_config_options = 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} 返回配置参数
 */
Drive.prototype.design_option = 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;
	}
}

/**
 * 保存配置
 */
Drive.prototype.save_option = function(options) {
	this.options = options;
	this.backup_options();
}

/**
 * 保存配置
 */
Drive.prototype.backup_options = function() {
	var l = $.slash;
	var file = "/cache/" + l + l + this.filename.right("app" + l).replaceAll(l + "plugin", "").replace(".json",
		"/config.json");
	file = file.fullname();
	file.addDir();
	file.saveJson(this.options);
}

/**
 * 合并配置
 * @param {Object} cg 配置
 */
Drive.prototype.merge_options = function(options) {
	var l = $.slash;
	var file = "/cache/" + l + l + this.filename.right("app" + l).replaceAll(l + "plugin", "").replace(".json",
		"/config.json");
	var options_cache = file.loadJson();
	if (options_cache) {
		$.push(options, options_cache);
	}
	return options;
}

/**
 * 新建脚本
 * @param {String} 文件
 */
Drive.prototype.new_script = function(file) {
	var fl = __dirname + "/script.js";
	if (fl.hasFile()) {
		var text = fl.loadText();
		if (text) {
			var name = 'sys';
			var l = $.slash;
			if (file.indexOf('plugin' + l) !== -1) {
				name = file.between('plugin' + l, l);
				if (file.indexOf('app' + l) !== -1) {
					var app = file.between('app' + l, l);
					text = text.replaceAll('{1}', app);
				}
				text = text.replaceAll('{0}', name);
			} else if (file.indexOf('app' + l) !== -1) {
				name = file.between('app' + l, l);
				text = text.replaceAll('{0}', name)
			}
			file.saveText(text);
		}
	}
};

/**
 * 新建配置
 * @param {String} 文件
 */
Drive.prototype.new_config = function(file) {
	var fl = __dirname + "/config.tpl.json";
	if (fl.hasFile()) {
		var text = fl.loadText();
		if (text) {
			var name = 'sys';
			var l = $.slash;
			if (file.indexOf('plugin' + l) !== -1) {
				name = file.between('plugin' + l, l);
				if (file.indexOf('app' + l) !== -1) {
					var app = file.between('app' + l, l);
					text = text.replaceAll('{1}', app).replaceAll('{2}', app + '.' + name);
				}
				text = text.replaceAll('{0}', name);
			} else if (file.indexOf('app' + l) !== -1) {
				name = file.between('app' + l, l);
				text = text.replaceAll('{0}', name).replaceAll('\r\n	"app": "{1}",', '').replaceAll('插件', '应用')
					.replaceAll('{2}', name);
			}
			file.saveText(text);
		}
	}
};

/**
 * 设置语言
 * @param {Sting} lang
 * @return {String} 成功返回null,否则返回错误提示
 */
Drive.prototype.set_lang = function(lang) {
	var msg = null;
	if (!lang) {
		lang = "zh_CN"
	}
	var file = this.config.lang_path + ".json";
	if (file.hasFile()) {
		var obj = file.loadJson();
		if (obj) {
			this.lang = obj;
		} else {
			msg = "语言包不是正确的json格式";
		}
	} else {
		msg = "语言包文件不存在";
	}
	return msg;
};

/**
 * 安装
 * @param {Object} option 配置参数
 * @return {String} 成功返回null,否则返回错误提示
 */
Drive.prototype.install = function(option) {
	var msg = null;
	return msg;
};

/**
 * 重启设备
 * @param {Object} option 配置
 */
Drive.prototype.restart = async function(option) {
	await this.exec('stop');
	await this.exec('start');
}

/**
 * 初始化
 * @param {Object} option 配置参数
 * @return {String} 成功返回null, 否则返回错误提示
 */
Drive.prototype.init = function(option) {
	var msg = null;
	return msg;
};

/**
 * 更新
 * @param {Object} option 配置参数
 * @return {String} 成功返回null, 否则返回错误提示
 */
Drive.prototype.update = function(option) {
	var msg = null;
	return msg;
};

/**
 * 卸载
 * @param {Object} option 配置参数
 * @return {String} 成功返回null,否则返回错误提示
 */
Drive.prototype.uninstall = function(option) {
	var msg = null;
	return msg;
};

/**
 * 启动
 * @param {Object} opiton 配置参数
 * @return {String} 成功返回null,否则返回错误提示
 */
Drive.prototype.start = function(opiton) {
	var msg = null;
	return msg;
};

/**
 * 暂停
 * @param {Object} opiton 配置参数
 * @return {String} 成功返回null,否则返回错误提示
 */
Drive.prototype.stop = function(opiton) {
	var msg = null;
	return msg;
};

/**
 * 结束
 * @param {Object} opiton 配置参数
 * @return {String} 成功返回null,否则返回错误提示
 */
Drive.prototype.end = function(opiton) {
	var msg = null;
	return msg;
};

/**
 * API接口（用于其他插件调用该插件时）
 * @param {Object} ctx HTTP上下文
 * @param {Object} db 数据库管理器
 * @return {Object} 执行结果
 */
Drive.prototype.api = function(ctx, db) {
	var ret = {};
	return ret;
};

/**
 * 商店（用于下载插件相关模块）
 * @param {String} item 插件项
 * @return {String} 成功返回null,否则返回错误提示
 */
Drive.prototype.store = function(item) {
	var msg = null;
	return msg;
};

/**
 * 插件
 * @param {String} item 插件项
 * @return {Object} 旗下插件和信息
 */
Drive.prototype.plugin = function(item) {

};

/**
 * 帮助（讲解插件使用方法）
 * @param {String} item 帮助项
 * @return {String} 返回使用方法明细
 */
Drive.prototype.help = function(item) {
	var body = "";
	return body;
};

/**
 * 主程序
 * @param {Object} param1 参数1
 * @param {Object} param2 参数2
 * @return {Object} 返回执行结果
 */
Drive.prototype.main = function(param1, param2) {
	return null;
};

/**
 * 指令（类似命令提示符）
 * @param {String} content 指令内容
 * @return {String} 执行结果
 */
Drive.prototype.cmd = function(content) {
	var body = "";
	return body;
};

/**
 * 聊天（通过聊天的方式驱动插件, 用于机器人开发）
 * @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} 回复内容
 */
Drive.prototype.chat = async function(from_user, to_user, group, content, type, msg_type, db) {
	var body = "";
	return body;
};

/**
 * 指令（类似命令提示符）
 * @param {String} content 指令内容
 * @return {String} 执行结果
 */
Drive.prototype.run_cmd = async function(content) {
	if (!content) {
		content = "";
	}
	var ret;
	try {
		ret = this.cmd(content);
	} catch (err) {
		$.log.error("运行插件指令失败！", this.config.name, err);
	}
	if (!ret) {
		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消息型。默认消息型
 * @return {String} 回复内容
 */
Drive.prototype.run_chat = async function(from_user, to_user, content, group, type, msg_type, db) {
	if (!content) {
		content = "";
	}
	if (!msg_type) {
		msg_type = "message";
	}
	if (!group) {
		group = "";
	}
	var ret;
	try {
		ret = this.chat(from_user, to_user, group, content, type, msg_type, db);
	} catch (err) {
		$.log.error("运行插件聊天失败！", this.config.name, err);
	}
	if (!ret) {
		ret = "";
	}
	return ret;
};

/**
 * 压缩插件
 * @param {String} 要压缩的目录
 * @returns {String} 打包成功返回压缩包文件地址
 */
Drive.prototype.zip = async function(zip_dir = "/static/file/zip/") {
	var dir = this.filename.dirname();
	var file = ("./" + this.config.name + '.zip').fullname(zip_dir);
	file.addDir();
	var done = await compressing.zip.compressDir(dir, file);
	if (file.hasFile()) {
		return file;
	}
	return null;
}

module.exports = Drive;