mm_tpl 2.7.0 → 2.7.2

package/index.js

@@ -1,471 +1,46 @@
-const engine = require('art-template');
-const {
-	Base
-} = require('mm_expand');
-const Hook = require('./hook.js');
-const {
-	nativeRule,
-	artRule,
-	htmlRule,
-	jsRule,
-	pyRule,
-	pyRule2
-} = require('./tpl_rule');
-
-if (!$.globalBag) {
-	$.globalBag = {};
-}
-
-if (!$.hook) {
-	$.hook = new Hook();
-}
-
-/**
- * 模板类
- * @class
- */
-class Tpl extends Base {
-	static config = {
-		/**
-		 * 模板根目录
-		 */
-		root: $.run_path + '',
-		/**
-		 * 默认模板目录
-		 */
-		default_dir: "./static/template/",
-		/**
-		 * 默认主题
-		 */
-		default_theme: 'default',
-		/**
-		 * 模板文件扩展名
-		 */
-		extname: ".html",
-		/**
-		 * 模板规则
-		 */
-		rules: [nativeRule, artRule, htmlRule, jsRule, pyRule, pyRule2],
-		/**
-		 * 缓存根目录
-		 */
-		cache_root: './cache'.fullname(),
-		/**
-		 * 缓存文件扩展名
-		 */
-		cache_extname: '.cache.html',
-		/**
-		 * 变换字符串
-		 */
-		change_str: ['\\#', '\\<', '\\${', '\\*', '\\"""'],
-	};
-	/**
-	 * 创建模板实例
-	 * @param {Object} config - 配置选项
-	 */
-	constructor(config) {
-		super(config);
-
-		/**
-		 * 模板引擎
-		 */
-		this.engine = engine;
-
-		/**
-		 * 视图数据
-		 */
-		this.viewBag = {};
-
-		/**
-		 * 模板根目录
-		 */
-		this.dir = './static/template/';
-
-		/**
-		 * 当前主题
-		 */
-		this.current_theme = this.config.default_theme;
-
-		/**
-		 * 错误提示
-		 */
-		this.error = null;
-
-		this.regex_in = [];
-		this.str_in = [];
-
-		this.regex_out = [];
-		this.str_out = [];
-
-		/**
-		 * 初始化
-		 */
-		this._init();
-	}
-}
-
-/**
- * 初始化模板
- */
-Tpl.prototype._initTpl = function () {
-	var cg = this.config;
-	for (var key in cg) {
-		this.engine.defaults[key] = cg[key];
-	}
-	if (!cg.cache_root.hasDir()) {
-		cg.cache_root.addDir()
-	}
-};
-
-/**
- * 执行钩子函数
- * @param {string} name - 钩子名称
- * @param {Object} req - 请求参数
- * @param {...any} args - 附加参数
- * @returns {any} 执行结果
- */
-Tpl.prototype.runFunc = function (name, req, ...args) {
-	return $.hook.runFunc(name, this.viewBag, req, ...args);
-}
-
-/**
- * 执行钩子函数
- * @param {string} name - 钩子名称
- * @param {Object} req - 请求参数
- * @param {...any} args - 附加参数
- * @returns {any} 执行结果
- */
-Tpl.prototype.runHook = Tpl.prototype.runFunc;
-
-/**
- * 初始化前处理
- * @param {Object} config - 配置参数
- */
-Tpl.prototype._initBefore = function (config) { }
-
-/**
- * 初始化主处理
- * @param {Object} config - 配置参数
- */
-Tpl.prototype._initMain = function (config) {
-	this.setConfig(config);
-	this._initTpl();
-};
-
-/**
- * 初始化后处理
- * @param {Object} config - 配置参数
- */
-Tpl.prototype._initAfter = function (config) {
-	var lt = this.config.change_str;
-	for (var i = 0; i < lt.length; i++) {
-		var str = lt[i];
-		var rx_in = str.replace("\\", "\\\\").replace("$", "\\$").replace("[", "\\[").replace("]", "\\]").replace(
-			"{", "\\{").replace("}", "\\}").replace("/", "\\/").replace("*", "\\*");
-		this.regex_in.push(new RegExp(rx_in, "gi"));
-		var str_in = str.split("").join("·") + "·";
-		this.str_in.push(str_in);
-		var rx_out = str_in.replace("\\", "\\\\").replace("$", "\\$").replace("[", "\\[").replace("]", "\\]").replace(
-			"{", "\\{").replace("}", "\\}").replace("/", "\\/").replace("*", "\\*");
-		this.regex_out.push(new RegExp(rx_out, "gi"));
-		this.str_out.push(str.replace("\\", ""));
-	}
-};
-
-/**
- * 初始化模板
- * @param {Object} config - 配置参数
- */
-Tpl.prototype._init = function (config) {
-	this._initBefore(config);
-	this._initMain(config);
-	this._initAfter(config);
-};
-
-/**
- * 转义字符
- * @param {string} body - 字符串
- * @param {boolean} restore - 是否还原 
- * @returns {string} 转义后的字符串
- */
-Tpl.prototype.escape = function (body, restore) {
-	if (!body) {
-		return body
-	}
-	if (restore) {
-		for (var i = 0; i < this.regex_out.length; i++) {
-			body = body.replace(this.regex_out[i], this.str_out[i]);
-		}
-	} else {
-		for (var i = 0; i < this.regex_in.length; i++) {
-			body = body.replace(this.regex_in[i], this.str_in[i]);
-		}
-	}
-	return body;
-}
-
-/**
- * 渲染前处理
- * @param {string} body - 模板内容
- * @param {Object} model - 数据模型
- * @param {Object} options - 配置参数
- * @returns {string} 渲染结果
- */
-Tpl.prototype._renderBefore = function (body, model, options) {
-	var ret = "";
-	if (options && options.cache) {
-		var f = options.cache_filename;
-		if (f) {
-			if (f.replace('./', '').indexOf('.') == -1 && !f.endsWith(this.config.cache_extname)) {
-				f += this.config.cache_extname;
-			}
-			var file = f.fullname(this.config.cache_root);
-			// 如果文件存在
-			if (file.hasFile()) {
-				ret = file.loadText();
-			}
-		}
-	}
-	return ret;
-};
-
-/**
- * 注入全局函数前处理
- * @param {Object} m - 模型对象
- * @returns {Object} 处理后的模型
- */
-Tpl.prototype._loadFuncBefore = function (m) {
-	// m.$i18n = function(key) {
-	// 	return $.i18n(key);
-	// }
-	return m;
-}
-
-/**
- * 加载函数到模型
- * @param {Object} m - 模型对象
- * @returns {Object} 处理后的模型
- */
-Tpl.prototype.loadFunc = function (m) {
-	this._loadFuncBefore(m);
-	var _this = this;
-	m.view = function (file, model, options) {
-		return _this.view(file, Object.assign({}, m, model), options);
-	}
-	m.render = function (body, model, options) {
-		return _this.render(body, Object.assign({}, m, model), options);
-	}
-	m.hookAction = function (name, ...args) {
-		return $.hook.runAction(name, m, ...args);
-	}
-	m.hookFilter = function (name, content, ...args) {
-		if (!content) {
-			content = "";
-		}
-		return $.hook.runFilter(name, m, content, ...args);
-	}
-	if (global.$ && $.lang) {
-		m.$t = function (key, ...args) {
-			return $.lang.get(key, ...args);
-		}
-	}
-	return m;
-}
-
-/**
- * 渲染主处理
- * @param {string} body - 模板内容
- * @param {Object} model - 数据模型
- * @param {Object} options - 配置参数
- * @returns {string} 渲染结果
- */
-Tpl.prototype._renderMain = function (body, model, options) {
-	var ret = "";
-	if (body) {
-		var m = Object.assign({}, {
-			viewBag: this.viewBag,
-			globalBag: $.globalBag
-		}, model);
-		this.loadFunc(m);
-		ret = this.engine.render(body, m, options);
-	}
-	return ret;
-};
-
-/**
- * 渲染后处理
- * @param {string} body - 模板内容
- * @param {Object} model - 数据模型
- * @param {Object} options - 配置参数
- * @returns {string} 渲染结果
- */
-Tpl.prototype._renderAfter = function (body, model, options) {
-	if (body) {
-		if (options) {
-			var f = options.cache_filename;
-			if (f) {
-				if (f.replace('./', '').indexOf('.') == -1 && !f.endsWith(this.config.cache_extname)) {
-					f += this.config.cache_extname;
-				}
-				var file = f.fullname(this.config.cache_root);
-				file.saveText(body);
-			}
-		}
-	}
-	return body;
-};
-
-/**
- * 渲染子模板
- * @param {string} body - 模板内容
- * @param {Object} model - 数据模型
- * @param {Object} options - 配置参数
- * @returns {string} 渲染结果
- */
-Tpl.prototype._renderSub = function (body, model, options) {
-	var ret = this._renderBefore(body, model, options);
-	if (!ret) {
-		ret = this._renderMain(body, model, options);
-		if (ret) {
-			ret = this._renderAfter(ret, model, options);
-		}
-	}
-	return ret;
-};
-
-/**
- * 渲染模板
- * @param {string} body - 模板内容
- * @param {Object} model - 数据模型
- * @param {Object} options - 配置参数
- * @returns {string} 渲染结果
- */
-Tpl.prototype.render = function (body, model, options) {
-	body = this.escape(body);
-	body = this._renderSub(body, model, options);
-	return this.escape(body, true);
-};
-
-/**
- * 编译模板
- * @param {string} body - 模板内容
- * @param {Object} options - 配置参数
- * @returns {Function} 渲染函数
- */
-Tpl.prototype.compile = function (body, options) {
-	return this.engine.compile(body, options);
-};
-
-/**
- * 获取模板文件
- * @param {string} file - 模板文件路径
- * @returns {string} 模板文件路径
- */
-Tpl.prototype.getFile = function (file) {
-	if (typeof (file) !== 'string') {
-		throw new Error('模板文件路径必须是字符串');
-	}
-	if (file.replace('./', '').indexOf('.') === -1 && !file.endsWith(this.config.extname)) {
-		file += this.config.extname;
-	}
-	var f = file.fullname('diy'.fullname(this.dir));
-	if (!f.hasFile()) {
-		f = file.fullname('diy'.fullname(this.config.default_dir));
-		if (!f.hasFile()) {
-			f = file.fullname(this.current_theme.fullname(this.dir));
-			if (!f.hasFile()) {
-				f = file.fullname(this.config.default_theme.fullname(this.dir));
-				if (!f.hasFile()) {
-					f = file.fullname(this.current_theme.fullname(this.config.default_dir));
-					if (!f.hasFile()) {
-						f = file.fullname(this.config.default_theme.fullname(this.config.default_dir));
-					}
-				}
-			}
-		}
-	}
-	return f;
-};
-
-/**
- * 渲染模板文件
- * @param {string} file - 模板文件路径
- * @param {Object} model - 数据模型
- * @param {Object} options - 配置参数
- * @returns {string} 渲染结果
- */
-Tpl.prototype.view = function (file, model, options) {
-	var f = this.getFile(file);
-	if (!f.hasFile()) {
-		this.error = {
-			code: 10000,
-			message: f + "文件不存在！"
-		};
-	}
-	else {
-		var body = f.loadText();
-		if (body) {
-			body = this.escape(body);
-			body = this._renderSub(body, model, options);
-			body = this.escape(body, true);
-			return body;
-		}
-	}
-	return "";
-};
-
-/**
- * 设置视图数据
- * @param {Object} obj - 要设置的数据对象
- */
-Tpl.prototype.set = function (obj) {
-	$.push(this.viewBag, obj, true);
-};
-
-/**
- * 删除视图数据
- * @param {Array|string} keys - 要删除的键或键数组
- */
-Tpl.prototype.del = function (keys) {
-	if (typeof (keys) == 'string') {
-		delete this.viewBag[keys];
-	} else {
-		keys.map(function (k) {
-			delete this.viewBag[k];
-		});
-	}
-};
-
-/**
- * 获取视图数据
- * @param {string} key - 数据键名
- * @returns {any} 数据值
- */
-Tpl.prototype.get = function (key) {
-	return this.viewBag[key];
-};
-
-/**
- * 清除缓存
- * @param {string} path - 缓存路径
- * @param {string} file - 文件名
- */
-Tpl.prototype.clearCache = function (path, file) {
-	var cg = this.config;
-	var root = cg.cache_root;
-	var dir = path ? path.fullname(root) : root;
-	var keyword = file || '*' + cg.cache_extname;
-	var list_file = $.file.getAll(dir, keyword);
-	list_file.forEach((f) => {
-		f.delFile(root);
-	});
-};
-
-if (global.$ && !$.Tpl) {
-	$.Tpl = Tpl;
-	$.tpl = new Tpl();
-}
-
-module.exports = {
-	Tpl
-};
+const Hook = require('./lib/hook.js');
+const {
+  Engine
+} = require('./lib/engine.js');
+const {
+  Memory
+} = require('./lib/memory.js');
+
+/**
+ * SQLite 存储
+ * 依赖 Node 内置的 node:sqlite（Node 22.5 起提供），低版本加载失败时仅不导出，其余功能不受影响
+ */
+let Sqlite = null;
+
+try {
+  Sqlite = require('./lib/sqlite.js').Sqlite;
+} catch {
+  Sqlite = null;
+}
+
+if (!$.globalBag) {
+  $.globalBag = {};
+}
+
+if (!$.hook) {
+  $.hook = new Hook();
+}
+
+/**
+ * 模板类
+ * 对外主类与模块入口，在引擎实例基础上供业务侧扩展
+ * 渲染、主题/风格/语言编排与派生实例见 lib/engine.js，默认配置项由 Engine 提供
+ * @class
+ */
+class Tpl extends Engine { }
+
+if (global.$ && !$.Tpl) {
+  $.Tpl = Tpl;
+  $.tpl = new Tpl();
+}
+
+module.exports = {
+  Tpl,
+  Memory,
+  Sqlite
+};

package/lib/asset.js

@@ -0,0 +1,129 @@
+/**
+ * 资源加载基类
+ * 样式与脚本同属「引用多个文件」类资源：按目录优先级收集，同名文件只保留优先级最高的一份
+ * 输出顺序按目录优先级从低到高排列，使高优先级资源位于后方，覆盖与依赖关系才成立
+ * @class
+ */
+class Asset {
+  /**
+   * 创建资源加载器
+   * @param {Object} tpl - 所属模板实例
+   * @param {string} extname - 资源扩展名，如 .css、.js
+   */
+  constructor(tpl, extname) {
+    /**
+     * 所属模板实例
+     */
+    this.tpl = tpl;
+
+    /**
+     * 资源扩展名
+     */
+    this.extname = extname;
+  }
+}
+
+/**
+ * 获取资源目录列表
+ * 由子类按资源类型实现，返回顺序为优先级从高到低
+ * @param {string} theme - 主题名称
+ * @param {string} style - 风格名称
+ * @returns {Array<string>} 目录列表
+ */
+Asset.prototype.getDirs = function (theme, style) {
+  throw new Error('资源加载器必须实现 getDirs 方法');
+};
+
+/**
+ * 匹配单个目录下的资源文件
+ * @param {string} dir - 目录路径
+ * @param {string} keyword - 文件名或通配符
+ * @returns {Array<string>} 资源文件路径列表，同目录内按文件名排序
+ */
+Asset.prototype._matchDir = function (dir, keyword) {
+  if (!dir || !dir.hasDir()) {
+    return [];
+  }
+  // 排序保证同目录内的层叠与执行顺序稳定，不依赖文件系统的枚举顺序
+  var files = $.file.get(dir, keyword).sort();
+  var list = [];
+  for (var i = 0; i < files.length; i++) {
+    if (files[i].extname() === this.extname) {
+      list.push(files[i]);
+    }
+  }
+  return list;
+};
+
+/**
+ * 按名称或通配符匹配资源文件
+ * 名称支持 * 通配：*后缀 为结尾匹配，前缀* 为开头匹配，*包含* 为包含匹配
+ * 从高优先级到低优先级收集，同名文件只保留优先级最高的一份
+ * 结果按优先级升序输出，低优先级在前、高优先级在后，便于直接按序引用
+ * @param {string} pattern - 资源文件名或通配符，为空时等同于全部资源
+ * @param {string} theme - 主题名称，不传时取当前主题
+ * @param {string} style - 风格名称，不传时取当前风格
+ * @returns {Array<string>} 命中的资源文件全路径列表
+ */
+Asset.prototype.matchFiles = function (pattern, theme, style) {
+  var dirs = this.getDirs(theme, style);
+  var keyword = pattern || '*' + this.extname;
+  var map = {};
+  for (var i = 0; i < dirs.length; i++) {
+    var files = this._matchDir(dirs[i], keyword);
+    for (var j = 0; j < files.length; j++) {
+      var name = files[j].basename();
+      // 高优先级目录已收录同名文件时跳过，实现同名覆盖
+      if (map[name]) {
+        continue;
+      }
+      map[name] = {
+        file: files[j],
+        name: name,
+        level: i
+      };
+    }
+  }
+  var list = [];
+  for (var key in map) {
+    list.push(map[key]);
+  }
+  list.sort(function (a, b) {
+    // level 越大优先级越低，因此排在越前面
+    if (a.level !== b.level) {
+      return b.level - a.level;
+    }
+    return a.name < b.name ? -1 : (a.name > b.name ? 1 : 0);
+  });
+  return list.map(function (item) {
+    return item.file;
+  });
+};
+
+/**
+ * 获取单个资源文件的路径
+ * 名称精确匹配，同名文件由高优先级目录胜出，因此结果至多一个
+ * @param {string} name - 资源文件名，如 main.css
+ * @param {string} theme - 主题名称，不传时取当前主题
+ * @param {string} style - 风格名称，不传时取当前风格
+ * @returns {string|null} 资源文件全路径，不存在时返回 null
+ */
+Asset.prototype.getFile = function (name, theme, style) {
+  if (!name || typeof (name) !== 'string') {
+    return null;
+  }
+  var list = this.matchFiles(name, theme, style);
+  return list.length ? list[0] : null;
+};
+
+/**
+ * 获取全部资源文件路径列表
+ * @returns {Array<string>} 资源文件全路径列表
+ */
+Asset.prototype.getFiles = function () {
+  return this.matchFiles('*' + this.extname);
+};
+
+module.exports = {
+  Asset
+};

package/lib/css.js

@@ -0,0 +1,34 @@
+const {
+  Asset
+} = require('./asset.js');
+
+/**
+ * 样式文件加载器
+ * 样式放主题下的 style/{风格}/ 目录，与模板不同目录：样式按风格分层，模板不按风格分层
+ * 按目录优先级引用（只回退主题，不回退风格），同名文件只保留优先级最高的一份
+ * @class
+ */
+class Css extends Asset {
+  /**
+   * 创建样式文件加载器
+   * @param {Object} tpl - 所属模板实例
+   */
+  constructor(tpl) {
+    super(tpl, '.css');
+  }
+}
+
+/**
+ * 获取样式目录列表
+ * 由引擎的 getStyleDirs 给出，含风格与基础风格两级；返回顺序为优先级从高到低
+ * @param {string} theme - 主题名称，不传时取当前主题
+ * @param {string} style - 风格名称，不传时取当前风格
+ * @returns {Array<string>} 样式目录列表
+ */
+Css.prototype.getDirs = function (theme, style) {
+  return this.tpl.getStyleDirs(theme, style);
+};
+
+module.exports = {
+  Css
+};