@xiaozhi-client/cli 1.9.4-beta.5

package/src/utils/FormatUtils.ts

@@ -0,0 +1,198 @@
+/**
+ * 格式化工具
+ */
+
+/**
+ * 格式化工具类
+ */
+export class FormatUtils {
+  /**
+   * 格式化运行时间
+   */
+  static formatUptime(ms: number): string {
+    const seconds = Math.floor(ms / 1000);
+    const minutes = Math.floor(seconds / 60);
+    const hours = Math.floor(minutes / 60);
+    const days = Math.floor(hours / 24);
+
+    if (days > 0) {
+      return `${days}天 ${hours % 24}小时 ${minutes % 60}分钟`;
+    }
+    if (hours > 0) {
+      return `${hours}小时 ${minutes % 60}分钟`;
+    }
+    if (minutes > 0) {
+      return `${minutes}分钟 ${seconds % 60}秒`;
+    }
+    return `${seconds}秒`;
+  }
+
+  /**
+   * 格式化文件大小
+   */
+  static formatFileSize(bytes: number): string {
+    const units = ["B", "KB", "MB", "GB", "TB"];
+    let size = bytes;
+    let unitIndex = 0;
+
+    while (size >= 1024 && unitIndex < units.length - 1) {
+      size /= 1024;
+      unitIndex++;
+    }
+
+    return `${size.toFixed(unitIndex === 0 ? 0 : 1)} ${units[unitIndex]}`;
+  }
+
+  /**
+   * 格式化时间戳
+   */
+  static formatTimestamp(
+    timestamp: number,
+    format: "full" | "date" | "time" = "full"
+  ): string {
+    const date = new Date(timestamp);
+
+    switch (format) {
+      case "date":
+        return date.toLocaleDateString("zh-CN");
+      case "time":
+        return date.toLocaleTimeString("zh-CN");
+      default:
+        return date.toLocaleString("zh-CN");
+    }
+  }
+
+  /**
+   * 格式化进程 ID
+   */
+  static formatPid(pid: number): string {
+    return `PID: ${pid}`;
+  }
+
+  /**
+   * 格式化端口号
+   */
+  static formatPort(port: number): string {
+    return `端口: ${port}`;
+  }
+
+  /**
+   * 格式化 URL
+   */
+  static formatUrl(
+    protocol: string,
+    host: string,
+    port: number,
+    path?: string
+  ): string {
+    const url = `${protocol}://${host}:${port}`;
+    return path ? `${url}${path}` : url;
+  }
+
+  /**
+   * 格式化配置键值对
+   */
+  static formatConfigPair(key: string, value: any): string {
+    if (typeof value === "object") {
+      return `${key}: ${JSON.stringify(value, null, 2)}`;
+    }
+    return `${key}: ${value}`;
+  }
+
+  /**
+   * 格式化错误消息
+   */
+  static formatError(error: Error, includeStack = false): string {
+    let message = `错误: ${error.message}`;
+
+    if (includeStack && error.stack) {
+      message += `\n堆栈信息:\n${error.stack}`;
+    }
+
+    return message;
+  }
+
+  /**
+   * 格式化列表
+   */
+  static formatList(items: string[], bullet = "•"): string {
+    return items.map((item) => `${bullet} ${item}`).join("\n");
+  }
+
+  /**
+   * 格式化表格数据
+   */
+  static formatTable(data: Record<string, any>[]): string {
+    if (data.length === 0) return "";
+
+    const keys = Object.keys(data[0]);
+    const maxWidths = keys.map((key) =>
+      Math.max(key.length, ...data.map((row) => String(row[key]).length))
+    );
+
+    // 表头
+    const header = keys.map((key, i) => key.padEnd(maxWidths[i])).join(" | ");
+    const separator = maxWidths.map((width) => "-".repeat(width)).join("-|-");
+
+    // 数据行
+    const rows = data.map((row) =>
+      keys.map((key, i) => String(row[key]).padEnd(maxWidths[i])).join(" | ")
+    );
+
+    return [header, separator, ...rows].join("\n");
+  }
+
+  /**
+   * 格式化进度条
+   */
+  static formatProgressBar(current: number, total: number, width = 20): string {
+    const percentage = Math.min(current / total, 1);
+    const filled = Math.floor(percentage * width);
+    const empty = width - filled;
+
+    const bar = "█".repeat(filled) + "░".repeat(empty);
+    const percent = Math.floor(percentage * 100);
+
+    return `[${bar}] ${percent}% (${current}/${total})`;
+  }
+
+  /**
+   * 格式化命令行参数
+   */
+  static formatCommandArgs(command: string, args: string[]): string {
+    const quotedArgs = args.map((arg) =>
+      arg.includes(" ") ? `"${arg}"` : arg
+    );
+    return `${command} ${quotedArgs.join(" ")}`;
+  }
+
+  /**
+   * 截断长文本
+   */
+  static truncateText(text: string, maxLength: number, suffix = "..."): string {
+    if (text.length <= maxLength) return text;
+    return text.substring(0, maxLength - suffix.length) + suffix;
+  }
+
+  /**
+   * 格式化 JSON
+   */
+  static formatJson(obj: any, indent = 2): string {
+    try {
+      return JSON.stringify(obj, null, indent);
+    } catch (error) {
+      return String(obj);
+    }
+  }
+
+  /**
+   * 格式化布尔值
+   */
+  static formatBoolean(
+    value: boolean,
+    trueText = "是",
+    falseText = "否"
+  ): string {
+    return value ? trueText : falseText;
+  }
+}

package/src/utils/PathUtils.ts

@@ -0,0 +1,255 @@
+/**
+ * 路径处理工具
+ */
+
+import { realpathSync } from "node:fs";
+import { tmpdir } from "node:os";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import {
+  CONFIG_CONSTANTS,
+  PATH_CONSTANTS,
+  SERVICE_CONSTANTS,
+} from "../Constants";
+import { FileUtils } from "./FileUtils";
+
+/**
+ * 路径工具类
+ */
+
+export class PathUtils {
+  /**
+   * 获取 PID 文件路径
+   */
+  static getPidFile(): string {
+    // 优先使用环境变量中的配置目录，否则使用当前工作目录
+    const configDir =
+      process.env[CONFIG_CONSTANTS.DIR_ENV_VAR] || process.cwd();
+    return path.join(configDir, `.${SERVICE_CONSTANTS.NAME}.pid`);
+  }
+
+  /**
+   * 获取日志文件路径
+   */
+  static getLogFile(projectDir?: string): string {
+    const baseDir = projectDir || process.cwd();
+    return path.join(baseDir, SERVICE_CONSTANTS.LOG_FILE);
+  }
+
+  /**
+   * 获取配置目录路径
+   */
+  static getConfigDir(): string {
+    return process.env[CONFIG_CONSTANTS.DIR_ENV_VAR] || process.cwd();
+  }
+
+  /**
+   * 获取工作目录路径
+   */
+  static getWorkDir(): string {
+    const configDir = PathUtils.getConfigDir();
+    return path.join(configDir, PATH_CONSTANTS.WORK_DIR);
+  }
+
+  /**
+   * 获取模板目录路径
+   */
+  static getTemplatesDir(): string[] {
+    // 在 ES 模块环境中获取当前目录
+    const __filename = fileURLToPath(import.meta.url);
+    const scriptDir = path.dirname(__filename);
+
+    return [
+      // 构建后的环境：dist/cli.js -> dist/templates
+      path.join(scriptDir, PATH_CONSTANTS.TEMPLATES_DIR),
+      // 构建环境：dist/cli/index.js -> dist/backend/templates
+      path.join(scriptDir, "..", "backend", PATH_CONSTANTS.TEMPLATES_DIR),
+      // npm 全局安装
+      path.join(
+        scriptDir,
+        "..",
+        "..",
+        "..",
+        "..",
+        PATH_CONSTANTS.TEMPLATES_DIR
+      ),
+    ];
+  }
+
+  /**
+   * 查找模板目录
+   */
+  static findTemplatesDir(): string | null {
+    const possiblePaths = PathUtils.getTemplatesDir();
+
+    for (const templatesDir of possiblePaths) {
+      if (FileUtils.exists(templatesDir)) {
+        return templatesDir;
+      }
+    }
+
+    return null;
+  }
+
+  /**
+   * 获取模板路径
+   */
+  static getTemplatePath(templateName: string): string | null {
+    const templatesDir = PathUtils.findTemplatesDir();
+    if (!templatesDir) {
+      return null;
+    }
+
+    const templatePath = path.join(templatesDir, templateName);
+    return FileUtils.exists(templatePath) ? templatePath : null;
+  }
+
+  /**
+   * 获取脚本目录路径
+   */
+  static getScriptDir(): string {
+    const __filename = fileURLToPath(import.meta.url);
+    return path.dirname(__filename);
+  }
+
+  /**
+   * 获取项目根目录路径
+   */
+  static getProjectRoot(): string {
+    const scriptDir = PathUtils.getScriptDir();
+    // 从 src/cli/utils 回到项目根目录
+    return path.join(scriptDir, "..", "..", "..");
+  }
+
+  /**
+   * 获取构建输出目录路径
+   */
+  static getDistDir(): string {
+    const projectRoot = PathUtils.getProjectRoot();
+    return path.join(projectRoot, "dist");
+  }
+
+  /**
+   * 获取相对于项目根目录的路径
+   */
+  static getRelativePath(filePath: string): string {
+    const projectRoot = PathUtils.getProjectRoot();
+    return path.relative(projectRoot, filePath);
+  }
+
+  /**
+   * 解析配置文件路径
+   */
+  static resolveConfigPath(format?: "json" | "json5" | "jsonc"): string {
+    const configDir = PathUtils.getConfigDir();
+
+    if (format) {
+      return path.join(configDir, `xiaozhi.config.${format}`);
+    }
+
+    // 按优先级查找配置文件
+    for (const fileName of CONFIG_CONSTANTS.FILE_NAMES) {
+      const filePath = path.join(configDir, fileName);
+      if (FileUtils.exists(filePath)) {
+        return filePath;
+      }
+    }
+
+    // 返回默认配置文件路径
+    return path.join(configDir, CONFIG_CONSTANTS.FILE_NAMES[2]); // xiaozhi.config.json
+  }
+
+  /**
+   * 获取默认配置文件路径
+   */
+  static getDefaultConfigPath(): string {
+    const projectRoot = PathUtils.getProjectRoot();
+    return path.join(projectRoot, CONFIG_CONSTANTS.DEFAULT_FILE);
+  }
+
+  /**
+   * 验证路径安全性（防止路径遍历攻击）
+   */
+  static validatePath(inputPath: string): boolean {
+    const normalizedPath = path.normalize(inputPath);
+    return !normalizedPath.includes("..");
+  }
+
+  /**
+   * 确保路径在指定目录内
+   */
+  static ensurePathWithin(inputPath: string, baseDir: string): string {
+    const resolvedPath = path.resolve(baseDir, inputPath);
+    const resolvedBase = path.resolve(baseDir);
+
+    if (!resolvedPath.startsWith(resolvedBase)) {
+      throw new Error(`路径 ${inputPath} 超出了允许的范围`);
+    }
+
+    return resolvedPath;
+  }
+
+  /**
+   * 获取可执行文件路径
+   */
+  static getExecutablePath(name: string): string {
+    // 获取当前执行的 CLI 脚本路径
+    const cliPath = process.argv[1];
+
+    // 处理 cliPath 为 undefined 的情况
+    if (!cliPath) {
+      // 如果没有脚本路径，使用当前工作目录
+      return path.join(process.cwd(), `${name}.js`);
+    }
+
+    // 解析符号链接，获取真实路径
+    let realCliPath: string;
+    try {
+      realCliPath = realpathSync(cliPath);
+    } catch (error) {
+      // 如果无法解析符号链接，使用原路径
+      realCliPath = cliPath;
+    }
+
+    // 获取 dist 目录
+    const distDir = path.dirname(realCliPath);
+    return path.join(distDir, `${name}.js`);
+  }
+
+  /**
+   * 获取 Web 服务器启动器路径
+   */
+  static getWebServerLauncherPath(): string {
+    return PathUtils.getExecutablePath("WebServerLauncher");
+  }
+
+  /**
+   * 创建安全的文件路径
+   */
+  static createSafePath(...segments: string[]): string {
+    const joinedPath = path.join(...segments);
+    const normalizedPath = path.normalize(joinedPath);
+
+    // 检查路径是否包含危险字符
+    if (normalizedPath.includes("..") || normalizedPath.includes("~")) {
+      throw new Error(`不安全的路径: ${normalizedPath}`);
+    }
+
+    return normalizedPath;
+  }
+
+  /**
+   * 获取临时目录路径
+   */
+  static getTempDir(): string {
+    // 使用 Node.js 的 os.tmpdir() 来获取跨平台的临时目录
+    return process.env.TMPDIR || process.env.TEMP || tmpdir();
+  }
+
+  /**
+   * 获取用户主目录路径
+   */
+  static getHomeDir(): string {
+    return process.env.HOME || process.env.USERPROFILE || "";
+  }
+}

package/src/utils/PlatformUtils.ts

@@ -0,0 +1,217 @@
+/**
+ * 平台相关工具
+ */
+
+import { execSync } from "node:child_process";
+import { TIMEOUT_CONSTANTS } from "../Constants";
+import type { Platform } from "../Types";
+import { ProcessError } from "../errors/index";
+
+/**
+ * 平台工具类
+ */
+export class PlatformUtils {
+  /**
+   * 获取当前平台
+   */
+  static getCurrentPlatform(): Platform {
+    return process.platform as Platform;
+  }
+
+  /**
+   * 检查是否为 Windows 平台
+   */
+  static isWindows(): boolean {
+    return process.platform === "win32";
+  }
+
+  /**
+   * 检查是否为 macOS 平台
+   */
+  static isMacOS(): boolean {
+    return process.platform === "darwin";
+  }
+
+  /**
+   * 检查是否为 Linux 平台
+   */
+  static isLinux(): boolean {
+    return process.platform === "linux";
+  }
+
+  /**
+   * 检查是否为类 Unix 系统
+   */
+  static isUnixLike(): boolean {
+    return !PlatformUtils.isWindows();
+  }
+
+  /**
+   * 检查进程是否为 xiaozhi-client 进程
+   */
+  static isXiaozhiProcess(pid: number): boolean {
+    try {
+      // 在容器环境或测试环境中，使用更宽松的检查策略
+      if (
+        process.env.XIAOZHI_CONTAINER === "true" ||
+        process.env.NODE_ENV === "test"
+      ) {
+        // 容器环境或测试环境中，如果 PID 存在就认为是有效的
+        // 因为容器通常只运行一个主要应用，测试环境中mock了进程检查
+        process.kill(pid, 0);
+        return true;
+      }
+
+      // 非容器环境中，尝试更严格的进程检查
+      try {
+        let cmdline = "";
+        if (PlatformUtils.isWindows()) {
+          // Windows 系统
+          const result = execSync(`tasklist /FI "PID eq ${pid}" /FO CSV /NH`, {
+            encoding: "utf8",
+            timeout: TIMEOUT_CONSTANTS.PROCESS_STOP,
+          });
+          cmdline = result.toLowerCase();
+        } else {
+          // Unix-like 系统
+          const result = execSync(`ps -p ${pid} -o comm=`, {
+            encoding: "utf8",
+            timeout: TIMEOUT_CONSTANTS.PROCESS_STOP,
+          });
+          cmdline = result.toLowerCase();
+        }
+
+        // 检查是否包含 node 或 xiaozhi 相关关键词
+        return cmdline.includes("node") || cmdline.includes("xiaozhi");
+      } catch (error) {
+        // 如果无法获取进程信息，回退到简单的 PID 检查
+        process.kill(pid, 0);
+        return true;
+      }
+    } catch (error) {
+      return false;
+    }
+  }
+
+  /**
+   * 杀死进程
+   */
+  static async killProcess(
+    pid: number,
+    signal: NodeJS.Signals = "SIGTERM"
+  ): Promise<void> {
+    try {
+      process.kill(pid, signal);
+
+      // 等待进程停止
+      let attempts = 0;
+      const maxAttempts = 30; // 3秒超时
+
+      while (attempts < maxAttempts) {
+        await new Promise((resolve) => setTimeout(resolve, 100));
+
+        try {
+          process.kill(pid, 0);
+          attempts++;
+        } catch {
+          // 进程已停止
+          return;
+        }
+      }
+
+      // 如果还在运行，强制停止
+      try {
+        process.kill(pid, 0);
+        process.kill(pid, "SIGKILL");
+        await new Promise((resolve) => setTimeout(resolve, 500));
+      } catch {
+        // 进程已停止
+      }
+    } catch (error) {
+      throw new ProcessError(
+        `无法终止进程: ${error instanceof Error ? error.message : String(error)}`,
+        pid
+      );
+    }
+  }
+
+  /**
+   * 检查进程是否存在
+   */
+  static processExists(pid: number): boolean {
+    try {
+      process.kill(pid, 0);
+      return true;
+    } catch {
+      return false;
+    }
+  }
+
+  /**
+   * 获取系统信息
+   */
+  static getSystemInfo(): {
+    platform: Platform;
+    arch: string;
+    nodeVersion: string;
+    isContainer: boolean;
+  } {
+    return {
+      platform: PlatformUtils.getCurrentPlatform(),
+      arch: process.arch,
+      nodeVersion: process.version,
+      isContainer: process.env.XIAOZHI_CONTAINER === "true",
+    };
+  }
+
+  /**
+   * 获取环境变量
+   */
+  static getEnvVar(name: string, defaultValue?: string): string | undefined {
+    return process.env[name] || defaultValue;
+  }
+
+  /**
+   * 设置环境变量
+   */
+  static setEnvVar(name: string, value: string): void {
+    process.env[name] = value;
+  }
+
+  /**
+   * 检查是否在容器环境中运行
+   */
+  static isContainerEnvironment(): boolean {
+    return process.env.XIAOZHI_CONTAINER === "true";
+  }
+
+  /**
+   * 检查是否在测试环境中运行
+   */
+  static isTestEnvironment(): boolean {
+    return process.env.NODE_ENV === "test";
+  }
+
+  /**
+   * 检查是否在开发环境中运行
+   */
+  static isDevelopmentEnvironment(): boolean {
+    return process.env.NODE_ENV === "development";
+  }
+
+  /**
+   * 获取合适的 tail 命令
+   */
+  static getTailCommand(filePath: string): { command: string; args: string[] } {
+    if (PlatformUtils.isWindows()) {
+      return {
+        command: "powershell",
+        args: ["-Command", `Get-Content -Path "${filePath}" -Wait`],
+      };
+    }
+    return {
+      command: "tail",
+      args: ["-f", filePath],
+    };
+  }
+}