@flun/windows 2.0.1

package/lib/eventlog.js

@@ -0,0 +1,226 @@
+import { exec, execSync, promisify, isPermissionError } from './shared.js';
+import { elevate } from './binaries.js';
+
+const execAsync = promisify(exec),
+  eventLogs = ['APPLICATION', 'SYSTEM', 'SECURITY'], validTypes = ['ERROR', 'WARNING', 'INFORMATION', 'SUCCESSAUDIT', 'FAILUREAUDIT'];
+
+/**
+ * 事件日志记录器类,用于向Windows事件查看器写入日志
+ * - 提供记录信息、警告、错误和审计成功、审计失败事件的方法
+ * >查看定义:@see {@link EventLogger}、{@link info}、{@link warn}、{@link error}、{@link auditSuccess}、{@link auditFailure}
+ * @class EventLogger
+ * @example
+ *  // 配置示例
+ *  import { EventLogger } from '@flun/windows';
+ *
+ *  // 创建日志实例
+ *  const log = new EventLogger('服务名称');
+ *  log.info('基本信息');
+ *  log.warn('警告信息');
+ *  log.error('错误信息');
+ *  log.auditSuccess('审计成功');
+ *  log.auditFailure('审计失败');
+ *
+ *  // 自定义事件代码
+ *  log.error('特殊事件', 1002, ()=>{
+ *      console.log('日志已写入');
+ *  });
+ */
+class EventLogger {
+  /**
+   * @constructor
+   * @param {string|Object} [config] - 配置字符串（作为 source）或配置对象
+   * @param {string} [config.source='Node.js'] - 事件源名称
+   * @param {string} [config.eventLog='APPLICATION'] - 事件日志名称（APPLICATION, SYSTEM, SECURITY）
+   */
+  constructor(config = {}) {
+    if (typeof config === 'string') config = { source: config };
+    this.#initializeProperties(config);
+  }
+
+  #logname = 'APPLICATION';
+  #usePowerShellForAudit = false;
+
+  // 初始化属性
+  #initializeProperties(config) {
+    const { source = 'Node.js', eventLog = 'APPLICATION' } = config;
+    this.source = source, this.eventLog = eventLog;
+    this.#usePowerShellForAudit = false, this.#checkPowerShellAvailable();
+  }
+
+  // 同步检测PowerShell是否可用
+  #checkPowerShellAvailable() {
+    try {
+      execSync('powershell -Command "exit 0"', { stdio: 'ignore' }), this.#usePowerShellForAudit = true;
+    } catch (error) {
+      this.#usePowerShellForAudit = false;
+    }
+  }
+
+  /**
+   * 获取当前事件日志名称（大写）
+   * @returns {string}
+   */
+  get eventLog() {
+    return this.#logname.toUpperCase();
+  }
+
+  /**
+   * 设置事件日志名称,仅允许 APPLICATION, SYSTEM, SECURITY
+   * @param {string} value - 事件日志名称
+   */
+  set eventLog(value) {
+    if (value) this.#logname = eventLogs.includes(value.toUpperCase()) ? value.toUpperCase() : 'APPLICATION';
+  }
+
+  /**
+   * info方法的别名
+   * @returns {(message: string, code?: number, callback?: (error?: Error|null) => void) => Promise<void>}
+   */
+  get information() {
+    return this.info.bind(this);
+  }
+
+  /**
+   * warn方法的别名
+   * @returns {(message: string, code?: number, callback?: (error?: Error|null) => void) => Promise<void>}
+   */
+  get warning() {
+    return this.warn.bind(this);
+  }
+
+  /**
+   * 判断是否需要使用PowerShell写入日志
+   * @private
+   * @param {string} logType - 日志类型
+   * @param {number} eventId - 事件ID
+   * @returns {boolean}
+   */
+  #shouldUsePowerShell(logType, eventId) {
+    // 审计类型或事件ID超过1000时使用PowerShell
+    const isAuditType = logType === 'SUCCESSAUDIT' || logType === 'FAILUREAUDIT', isEventIdOverLimit = eventId > 1000;
+    return this.#usePowerShellForAudit && (isAuditType || isEventIdOverLimit);
+  }
+
+  /**
+   * 将消息写入日志;如果日志不存在,则创建;
+   * @private
+   * @param {string} [log='APPLICATION'] - 日志名称
+   * @param {string} [src='未知应用程序'] - 事件来源
+   * @param {string} [type='INFORMATION'] - 日志类型
+   * @param {string} msg - 消息内容
+   * @param {number} [id=1000] - 事件ID
+   * @param {(error?: Error|null) => void} [callback] - 完成后的回调函数
+   * @returns {Promise<void>}
+   */
+  async #write(log = 'APPLICATION', src = '未知应用程序', type = 'INFORMATION', msg, id = 1000, callback) {
+    if (!msg || msg.trim().length === 0) return;
+
+    const pMsg = msg.replace(/\r\n|\n\r|\r|\n/g, "\f"),  // 替换换行符
+      vLog = eventLogs.includes(log.toUpperCase()) ? log : 'APPLICATION',
+      vType = validTypes.includes(type.toUpperCase()) ? type : 'INFORMATION',
+      vId = parseInt(id) || 1000, vSrc = src.trim();
+
+    let command;
+    // 判断是否需要使用PowerShell
+    if (this.#shouldUsePowerShell(vType, vId)) {
+      // 使用PowerShell的Write-EventLog命令
+      const entryTypeMap = { 'ERROR': 'Error', 'WARNING': 'Warning', 'SUCCESSAUDIT': 'SuccessAudit', 'FAILUREAUDIT': 'FailureAudit' },
+        entryType = entryTypeMap[vType] || 'Information', escapedMsg = pMsg.replace(/"/g, '""'),
+        powHad = 'powershell -Command "Write-EventLog -LogName';
+      command = `${powHad} '${vLog}' -Source '${vSrc}' -EventId ${vId} -EntryType ${entryType} -Message \\\"${escapedMsg}\\\""`;
+    } else {
+      const eventCreateId = Math.min(Math.max(1, vId), 1000); // 限制在1-1000范围内
+      command = `eventcreate /L ${vLog} /T ${vType} /SO "${vSrc}" /D "${pMsg}" /ID ${eventCreateId}`;
+    }
+
+    // 执行命令
+    try {
+      await execAsync(command), callback?.();
+    } catch (error) {
+      if (isPermissionError(error?.message)) await this.#elevateCommand(command, callback);
+      else {
+        callback?.(error);
+        throw error;
+      }
+    }
+  }
+
+  /**
+   * 使用提升权限执行命令
+   * @private
+   * @param {string} command - 要执行的命令
+   * @param {(error?: Error|null) => void} [callback] - 完成回调
+   * @returns {Promise<void>}
+   */
+  async #elevateCommand(command, callback) {
+    return new Promise((resolve, reject) => {
+      elevate(command, error => {
+        if (error) callback?.(error), reject(error);
+        else callback?.(), resolve();
+      });
+    });
+  }
+
+  /**
+   * 记录一条信息性消息
+   * >查看定义:@see {@link info}
+   * @param {string} message - 日志消息的内容
+   * @param {number} [code=1000] - 分配给消息的事件代码
+   * @param {(error?: Error|null) => void} [callback] - 消息记录后运行的可选回调函数
+   * @returns {Promise<void>}
+   */
+  async info(message, code = 1000, callback) {
+    await this.#write(this.eventLog, this.source, 'INFORMATION', message, code, callback);
+  }
+
+  /**
+   * 记录一条警告消息
+   * >查看定义:@see {@link warn}
+   * @param {string} message - 日志消息的内容
+   * @param {number} [code=1000] - 分配给消息的事件代码
+   * @param {(error?: Error|null) => void} [callback] - 消息记录后运行的可选回调函数
+   * @returns {Promise<void>}
+   */
+  async warn(message, code = 1000, callback) {
+    await this.#write(this.eventLog, this.source, 'WARNING', message, code, callback);
+  }
+
+  /**
+   * 记录一条错误消息
+   * >查看定义:@see {@link error}
+   * @param {string} message - 日志消息的内容
+   * @param {number} [code=1000] - 分配给消息的事件代码
+   * @param {(error?: Error|null) => void} [callback] - 消息记录后运行的可选回调函数
+   * @returns {Promise<void>}
+   */
+  async error(message, code = 1000, callback) {
+    await this.#write(this.eventLog, this.source, 'ERROR', message, code, callback);
+  }
+
+  /**
+   * 记录一条审计成功消息
+   * >查看定义:@see {@link auditSuccess}
+   * @param {string} message - 日志消息的内容
+   * @param {number} [code=1000] - 分配给消息的事件代码
+   * @param {(error?: Error|null) => void} [callback] - 消息记录后运行的可选回调函数
+   * @returns {Promise<void>}
+   */
+  async auditSuccess(message, code = 1000, callback) {
+    await this.#write(this.eventLog, this.source, 'SUCCESSAUDIT', message, code, callback);
+  }
+
+  /**
+   * 记录一条审计失败消息
+   * >查看定义:@see {@link auditFailure}
+   * @param {string} message - 日志消息的内容
+   * @param {number} [code=1000] - 分配给消息的事件代码
+   * @param {(error?: Error|null) => void} [callback] - 消息记录后运行的可选回调函数
+   * @returns {Promise<void>}
+   */
+  async auditFailure(message, code = 1000, callback) {
+    await this.#write(this.eventLog, this.source, 'FAILUREAUDIT', message, code, callback);
+  }
+}
+
+export { EventLogger };

package/lib/shared.js

@@ -0,0 +1,34 @@
+/**
+ * 共享模块,导出在多个文件中使用的常用函数和模块
+ * >查看定义:@see {@link exec}、{@link execSync}、{@link fork}、{@link promisify}、{@link path}、{@link fs}、{@link EventEmitter}
+ */
+import { exec, execSync, fork } from 'child_process';
+import { promisify } from 'util';
+import path from 'path';
+import fs from 'fs';
+import { EventEmitter } from 'events';
+import { fileURLToPath } from 'url';
+
+/**
+ * 检查错误是否为权限不足的错误
+ * >查看定义:@see {@link isPermissionError}
+ * @param {string|Error} error - 错误信息或错误对象
+ * @returns {boolean} 是否为权限错误
+ */
+const isPermissionError = error => {
+    const errorMessage = error?.message || error?.toString() || String(error),
+        permissionErrors = ['拒绝访问', 'Access is denied', '权限不足', 'Insufficient privileges', 'AccessDenied', '需要提升权限',
+            'requires elevation', 'Administrator', 'admin', '权限被拒绝'],
+        lowerMessage = errorMessage.toLowerCase();
+    return permissionErrors.some(keyword => lowerMessage.includes(keyword.toLowerCase()));
+}
+
+/**
+ * 获取当前模块所在目录的路径（类似 CommonJS 的 __dirname）
+ * >查看定义:@see {@link getDirname}
+ * @param {string} metaUrl - 传入 `import.meta.url`
+ * @returns {string} 当前模块的目录路径
+ */
+const getDirname = metaUrl => path.dirname(fileURLToPath(metaUrl));
+
+export { exec, execSync, fork, promisify, path, fs, EventEmitter, isPermissionError, getDirname };

package/lib/winsw.js

@@ -0,0 +1,111 @@
+import { fs, path, getDirname } from './shared.js';
+import xmlBuilder from 'xml';
+
+
+const __dirname = getDirname(import.meta.url);
+/**
+ * @method generateXml 生成 winsw 配置文件的 XML;
+ * >查看定义:@see {@link generateXml}
+ * @param {Object} config - 配置对象,必须包含以下必需属性：
+ *   - *id* 服务的标识符,只能包含字母和数字,不能有空格
+ *   - *name* 服务的描述性名称
+ *   - *execPath* Node.js 可执行文件的绝对路径（如：C:\Program Files\nodejs\node.exe）
+ *   - *script* Node.js 服务器脚本的绝对路径（包装脚本）
+ *   - *workingdirectory* 服务运行的工作目录
+ * @param {string} [config.description] - 在服务管理器中显示的描述信息
+ * @param {string|string[]} [config.nodeOptions] - Node.js 选项（数组或空格分隔的字符串）
+ * @param {string} [config.wrapperArgs] - 传递给包装脚本的额外参数
+ * @param {string} [config.logmode] - 日志模式(老式):'rotate'(默认), 'reset', 'roll', 'append'
+ * @param {Object} [config.logging] - 日志配置对象,可替代 logmode
+ * @param {string} [config.logging.mode] - 日志模式(现代),支持 'append', 'reset', 'none', 'roll-by-time', 'roll-by-size'
+ * @param {string} [config.logging.pattern] - roll-by-time 模式的时间格式模式（默认:'yyyyMMdd'）
+ * @param {number} [config.logging.sizeThreshold] - roll-by-size 模式的大小阈值（默认:10240）
+ * @param {number} [config.logging.keepFiles] - roll-by-size 模式保留的文件数（默认:8）
+ * @param {string} [config.logpath] - 日志存储目录的绝对路径（默认:当前目录）
+ * @param {string|string[]} [config.dependencies] - 进程依赖项的逗号分隔列表或数组
+ * @param {{ name: string, value: string }[]|Object<string, string>} [config.env] - 环境变量配置（键/值对象或对象数组）
+ * @param {Object} [config.logOnAs] - 服务登录凭据配置
+ * @param {string} [config.logOnAs.account] - 登录账户名
+ * @param {string} [config.logOnAs.password] - 登录密码
+ * @param {string} [config.logOnAs.domain] - 账户所在域
+ * @param {boolean} [config.allowServiceLogon] - 是否允许服务登录
+ * @param {boolean} [config.stopparentfirst] - 是否先停止父进程
+ * @param {number} [config.stoptimeout] - 停止超时时间（秒）
+ * @returns {string} 生成的 XML 字符串
+ * @throws {string} 当缺少必需配置时抛出错误
+ */
+const generateXml = config => {
+  const {
+    id, name, script, description = '', nodeOptions, wrapperArgs, logmode = 'rotate', logging, logpath, dependencies,
+    env, logOnAs, allowServiceLogon, workingdirectory, stopparentfirst, stoptimeout, execPath
+  } = config;
+
+  // 验证必需配置项是否存在
+  if (!id || !name || !script || !execPath || !workingdirectory) throw "id,name,script,execPath,workingdirectory为必需配置项";
+
+  let xml = [{ id }, { name }, { description }, { executable: execPath }]; // 基础 XML 结构
+
+  // 多值处理
+  const multi = (tag, input, splitter = ',') => {
+    if (!input) return;
+    const items = Array.isArray(input) ? input : input.split(splitter); // 标准化为数组
+    items.forEach(val => xml.push({ [tag]: String(val).trim() }));      // 添加到 XML 结构
+  };
+
+  multi('argument', nodeOptions, ' ');                    // 添加 Node.js 选项参数
+  xml.push({ argument: script.trim() });                  // 添加主脚本路径参数
+  multi('argument', wrapperArgs, ' ');                    // 添加包装脚本参数
+
+  // 日志配置处理:优先使用 logging 对象,其次使用 logmode
+  if (logging) {
+    const { mode = 'append', pattern = 'yyyyMMdd', sizeThreshold = 10240, keepFiles = 8 } = logging, logContent = [{ _attr: { mode } }];
+    if (mode === 'roll-by-time') logContent.push({ pattern });               // 按时间滚动日志
+    else if (mode === 'roll-by-size') logContent.push({ sizeThreshold }), logContent.push({ keepFiles }); // 按大小滚动日志
+    xml.push({ log: logContent });
+  }
+  else xml.push({ logmode });
+
+  if (logpath) xml.push({ logpath });                                         // 添加日志路径
+  if (stopparentfirst) xml.push({ stopparentprocessfirst: stopparentfirst }); // 添加停止父进程优先选项
+  if (stoptimeout) xml.push({ stoptimeout: `${stoptimeout} sec` });           // 添加停止超时设置
+
+  multi('depend', dependencies);                                              // 添加依赖项
+  env && xml.push(...[].concat(env).map(({ name, value }) => ({ env: { _attr: { name, value } } }))); // 添加环境变量
+
+  // 添加服务登录凭据
+  if (logOnAs) {
+    const { domain = 'NT AUTHORITY', account = 'LocalSystem', password = '' } = logOnAs,
+      serviceaccount = [{ domain }, { user: account }, { password }];
+    if (allowServiceLogon) serviceaccount.push({ allowservicelogon: 'true' }); // 允许服务登录
+    xml.push({ serviceaccount });
+  }
+
+  xml.push({ workingdirectory });                                               // 添加工作目录
+  return xmlBuilder({ service: xml }, { indent: '\t' }).replace(/\n/g, '\r\n'); // 格式化为 Windows 风格的换行符
+};
+
+/**
+ * @method createExe 创建 winsw 可执行文件及其配置文件
+  * >查看定义:@see {@link createExe}
+ * @param {string} name - 可执行文件名称(不含扩展名);
+ * @param {string} dir - 输出目录（默认:当前工作目录）
+ * @param {() => void} [callback] - 完成后的回调函数
+ * @description 将 winsw.exe 的安装版本复制为根据服务id重命名的特定版本,
+ * 并复制 .exe.config 文件以支持 .NET 4+ 运行时环境;
+ */
+const createExe = (name, dir, callback) => {
+  if (!name || !dir) throw "createExe 方法需要 name 和 dir 两个参数!";
+
+  const binaryOptions = { encoding: 'binary' }, basePath = path.join(__dirname, '../bin/winsw'),
+    files = [{ src: 'winsw.exe', dest: `${name}.exe` }, { src: 'winsw.exe.config', dest: `${name}.exe.config` }];
+
+  // 复制文件到目标目录
+  files.forEach(file => {
+    const srcPath = path.join(basePath, file.src), destPath = path.join(dir, file.dest);
+    fs.writeFileSync(destPath, fs.readFileSync(srcPath, binaryOptions), binaryOptions);
+  });
+
+  callback?.();
+};
+
+export { generateXml, createExe };