1 Commits
Author SHA1 Message Date
zhongluofeng b018abd922 终端模块初版 2026-09-18 18:28:13 +08:00
63 changed files with 26695 additions and 185 deletions
+3
View File
@@ -9,6 +9,9 @@ lerna-debug.log*
.trae
.workbuddy
.npm-cache
.bun-tmp
.uploads
temp/
release_stage/
musicdl_outputs/
+841
View File
@@ -0,0 +1,841 @@
# 终端模块规划(Terminal Module Plan
> 状态:**P0 骨架已落地;P1 进行中**(Rust 侧:cwd 跟踪 / 状态事件 / GBK 编码 / SFTP 后端已完成并编译通过)
> 定位:Thing 工具集的第 11 个模块,`id = terminal``category = 'tool'`
> 作者:砚 | 日期:2026-09-17
> 关联文档:`AI_DEV_GUIDE.md`(模块注册机制 / IPC / 进程管理范式)
>
> **实施进度与踩坑记录见文末 §9(P0)与 §10(P1)**(含与本规划不一致之处,以 §9 / §10 为准)
---
## 0. 结论先行
三个关键判断,先摆在这里,后文展开论证:
1. **终端模块不应复用 `ProcessManager`**。它是为「单例常驻守护进程(mihomo)」设计的:一个模块 ID 对应一个进程,崩溃即重启。而终端要的是「N 个会话、每个会话生命周期独立、能挂起能重连、能写 stdin」——语义不同,硬套会把这套抽象撑坏。正确做法是**新建独立的 `TerminalManager`**,与 `ClipboardManager` / `MusicManager` / `TranslateManager` 平级,`manage()` 进 Tauri State。
2. **会话进程必须跑在 Rust 侧,不能是前端 shell**。这是 Windows 上的硬约束,且与已有基建同构:`ProcessManager``download_engine` 都在 Rust 侧管进程。理由有三——(a) WebView2 无 PTY 访问;(b) 前端持有的子进程会在页面重载时变孤儿;(c) 多标签、后台保活、断线重连都需要一个独立于 UI 生命周期的宿主。
3. **SSH 走「自研客户端 + 真实 PTY」,而不是「拼接 ssh.exe + ConPTY」**。后者实现快但天花板低:无法做 SFTP 复用连接、无法读主机密钥指纹、无法做跳板机链、无法统一错误模型、`ssh.exe` 的输出会与 ConPTY 的 ANSI 处理打架。代价是 Ruffles/ssh2 的移植与 ConPTY 绑定要自己写,收益是整个能力面没有上限。
**总工作量估算**:P0 骨架(本地 Shell + 多会话 + 密钥管理)约 8~12 个工作日;P1(SSH/SFTP 完整能力)约 15~20 个工作日;P2(高级能力)按需。**建议按 P0 先行落地可用版本,再迭代。**
> **收官状态(2026-09-18**P0P2 全部落地(ZMODEM 经评估放弃,见实施记录),
> 并完成一轮全链路审查(修复键盘输入失效、切标签丢缓冲、连接期关闭竞态等 7 项)。
> 单测 91/91、`cargo check` 与 `vue-tsc` 零错误。实施记录见 §9-11(精编版)。
---
## 1. 需求解构
用户提出的四条主干,拆成可执行的规格:
| 用户原话 | 解构为 | 落点 |
|---|---|---|
| 「主要是 ssh」 | SSH2 客户端、主机密钥校验、认证(密钥/密码/Agent/键盘交互/2FA)、跳板机、端口转发、连接复用 | §4.2 / §5.1 |
| 「多会话」 | 多标签 + 分屏、会话持久化(切页不断连)、状态栏、会话恢复、会话模板 | §4.3 |
| 「密钥管理」 | SSH 密钥生成/导入/列举、passphrase 托管、known_hosts 管理、ssh-agent 集成、私钥不进明文 | §4.4 |
| 「文件快捷管理」 | SFTP 双栏文件管理器、拖拽上传下载、跟随终端 cwd、内联 `rz/sz`、文件编辑器 | §4.5 |
| 「方便的快捷键」 | 终端键盘映射(复制粘贴/搜索/新建标签/分屏/跳转)、可配置、与全局面板联动 | §4.6 |
| (我补充) | **本地 Shell**PowerShell/cmd/WSL/Git-Bash)、**命令补全与历史**、**命令片段库**、**AI 命令助手**、**日志与审计**、**快速面板联动** | §4.1 / §4.7 / §4.8 |
---
## 2. 现状勘察(论证依据)
以下为 2026-09-17 从仓库实际读取的结果,作为设计约束的来源。
### 2.1 已具备的基建
| 能力 | 现有实现 | 终端模块可复用的部分 |
|---|---|---|
| 模块注册 | `src/modules/registry.ts` + `src/modules/index.ts` 静态导入 | 直接沿用,新增一行导入 + 图标映射 |
| 类型绑定 | `tauri-specta` 自动生成 `src/lib/bindings.ts`debug 构建时导出 | **必须复用**,终端命令量较大,手写 `invoke` 类型不可接受 |
| 凭据存储 | `src-tauri/src/secrets.rs``keyring` + Windows 凭据管理器(DPAPI),服务名固定 `"Thing"` | **直接复用**,见 §4.4 |
| 全局快捷键 | `src-tauri/src/shortcut.rs`:原子化注册 + 应用内冲突检测 + 占用表 | **直接复用**,见 §4.6 |
| 托盘 | `src-tauri/src/tray_menu.rs` | 可挂「新建会话」入口(P2) |
| 日志 | `src-tauri/src/logger.rs``log_info` / `log_warn` / `log_error`) | 继承统一日志,日志页可过滤 |
| 窗口常量 | `src-tauri/src/constants.rs``windows` / `events` | 需新增窗口与事件常量 |
| 弹窗范式 | `translate-popup` 的 NOACTIVATE 预创建窗口 + `capabilities/translate-popup.json` | 终端「快速会话/命令补全」浮层可参照 |
### 2.2 关键缺口(需要新增依赖)
| 缺口 | 现状 | 方案 |
|---|---|---|
| ConPTY 绑定 | 无。`windows-sys` 未开启 `Win32_System_Console` | 开启该 feature;或引入 `portable-pty`(见 §3.1 取舍) |
| SSH 客户端 | 无 | 引入 `russh`(纯 Rust)或 `ssh2`libssh2 绑定) |
| SFTP | 无 | 随 SSH 库一并引入 |
| 终端渲染 | 无。`node_modules` 中**不存在** `@xterm/*` | 引入 `@xterm/xterm` + `@xterm/addon-fit` + `@xterm/addon-webgl` + `@xterm/addon-search` + `@xterm/addon-web-links` |
| 前端代码编辑器 | 无 | 按需引入 `codemirror` 或复用纯 `<textarea>`(见 §4.5 |
| 密码短语输入 | 无安全输入通道 | 用 Tauri 原生窗口 + 一次性输入,不经 IPC 明文回传 |
> **注意**:仓库 `Cargo.toml` 存在**编码损坏**(多处注释已是乱码,如第 64、70、120、121、127 行)。新增依赖时建议顺带修复该文件编码,否则后续 diff 会持续污染。这是一个独立的清理项,不阻塞终端模块。
---
## 3. 技术选型
### 3.1 终端进程层:ConPTY
Windows 10 1809+ 提供 **ConPTY**`CreatePseudoConsole`),是 Windows Terminal 的底层机制。三条路径:
| 方案 | 优势 | 代价 | 判断 |
|---|---|---|---|
| `portable-pty`(wezterm 提取库) | 跨平台、API 干净、久经考验 | 引入一个非 Tauri 生态的大依赖;其 Windows 后端同样走 ConPTY,出问题时要下钻 | 可接受 |
| **直接绑 `windows-sys` 的 ConPTY** | 零额外依赖、完全可控、与项目已有 `windows-sys` 姿态一致 | 需自行处理 pseudo console handle 生命周期、read/write 线程、resize 时序 | **推荐** |
| `conpty` 窄封装 crate | 上手快 | 维护活跃度不确定 | 备选 |
**推荐直接绑定 `windows-sys`**,理由:项目已有大量原生 Win32 调用(`win32_util.rs``screenshot/wgc_capture.rs``translate/capture/uia_capture.rs`),团队对该路径熟悉;且 ConPTY 的坑(下述)无论如何都要踩,多一层封装只增加定位难度。
ConPTY 的三个已知陷阱,必须在设计阶段规避:
1. **`ClosePseudoConsole` 会阻塞**,直到所有引用该 PTY 的句柄关闭。必须在独立线程调用,且先取消挂起的 `ReadFile`
2. **`ResizePseudoConsole` 有竞态**:进程刚创建、还没开始读 stdout 时 resize 可能被吞掉。需要在首帧输出后再应用队列中的尺寸。
3. **进程退出不等于 PTY 关闭**:要等 `ReadFile` 返回 0 或 `ERROR_BROKEN_PIPE`,才算真正结束,否则会漏掉尾部输出。
### 3.2 SSH 层:`russh` vs `ssh2`
| 维度 | `russh`(纯 Rust,基于 `thrussh` | `ssh2`libssh2 绑定) |
|---|---|---|
| 构建 | 纯 Rust,无 C 依赖,交叉编译友好 | 需 libssh2Windows 下常走 vendored 编译 |
| async | 原生 async,与现有 `tokio` 运行时契合 | 同步阻塞,需 `spawn_blocking` 包装 |
| 算法覆盖 | 新算法跟进快(如 `chacha20-poly1305``sntrup761x25519` | 受 libssh2 版本限制 |
| 稳定性 | API 演进较快,偶有破坏性变更 | 老牌稳定,几乎不再变化 |
| 与 `tokio` 集成 | 直接 | 需额外线程池,与 `ProcessManager` 的线程模型并存会增加心智负担 |
**推荐 `russh`**。决定性理由是 **async 契合度**Cargo.toml 已启用 `tokio``rt-multi-thread` / `sync` / `net` / `fs`,而终端会话本质是「一个长连接 + 多个并发数据流(shell channel、SFTP channel、port forward)」,用 async 表达最自然;`ssh2` 的同步模型会迫使每个会话占一个 OS 线程,多会话场景下线程数线性增长。
`russh` 在实际接入中出现阻塞性问题,回落方案是 `ssh2` + `spawn_blocking`,本规划的结构(`SessionHandle` 抽象)可容纳这次替换。
### 3.3 前端渲染:xterm.js
`@xterm/xterm` 是事实标准(VS Code 终端同源)。必须装的插件:
| 包 | 用途 |
|---|---|
| `@xterm/xterm` | 核心 VT 解析与渲染 |
| `@xterm/addon-fit` | 容器尺寸 → 行列数,配合 ConPTY resize |
| `@xterm/addon-webgl` | GPU 渲染,大量输出时的性能关键(无它时大 `tail` 会卡) |
| `@xterm/addon-search` | 终端内搜索 |
| `@xterm/addon-web-links` | 链接可点击 |
| `@xterm/addon-unicode11` | 宽字符 / emoji 正确宽度(中文场景重要) |
| `@xterm/addon-serialize`(P1) | 会话快照序列化,用于恢复 |
### 3.4 数据流架构
```
┌──────────────────────── WebView (Vue 3) ────────────────────────┐
│ TerminalModule.vue │
│ ├── SessionSidebar.vue 会话/标签/分组 │
│ ├── TerminalTabs.vue 多标签 + 分屏容器 │
│ │ └── TerminalPane.vue xterm 实例(每个会话一个) │
│ ├── SftpPanel.vue 文件管理器(P1) │
│ ├── KeyManagerPanel.vue 密钥管理 │
│ └── SnippetsPanel.vue 命令片段库 │
│ stores/terminal.ts Pinia:会话元数据 / 布局 / 设置 │
└───────────────┬─────────────────────────────────────────────────┘
│ invoke(命令,请求-响应)
│ listen(事件,流式输出)
┌───────────────▼──────────────── Rust ───────────────────────────┐
│ TerminalManager (Tauri State, manage()) │
│ ├── sessions: DashMap<SessionId, Arc<Mutex<Session>>> │
│ ├── local: ConPtyBackend 本地 Shell 后端 │
│ ├── remote: SshBackend SSH 后端(russh
│ │ ├── shell channel → 终端 I/O │
│ │ ├── sftp subsystem → 文件管理 │
│ │ └── port forward → 隧道(P2
│ └── known_hosts: HostKeyStore 主机密钥校验 │
│ secrets.rs ← 复用:passphrase / 密码 / 代理凭据 │
│ shortcut.rs ← 复用:全局快捷键 │
└─────────────────────────────────────────────────────────────────┘
```
**关键设计**`Session` 是一层 trait 抽象,`ConPtyBackend``SshBackend` 都实现它(`write` / `resize` / `kill` / `subscribe_output`)。这样上层命令层(`terminal_write``terminal_resize`)无需区分本地与远程,多会话管理逻辑只需写一遍。
---
## 4. 功能规格
### 4.1 本地 ShellP0
- **Shell 探测**:启动时枚举可用 Shell,按顺序探测——
- PowerShell 7+`pwsh.exe`,优先)
- Windows PowerShell`powershell.exe`
- cmd`cmd.exe`
- Git Bash`bash.exe`,从 `git --exec-path` 反推)
- WSL 发行版(`wsl.exe -l -q` 枚举)
- **Shell 配置**:每个 Shell 可配可执行路径、启动参数、工作目录、环境变量覆盖、启动时执行命令(如 `cd /d/project && claude`)。
- **默认工作目录**:记住上次 cwd;新建会话时可选「跟随当前项目目录」。
- **注意 cwd 同步**ConPTY 拿不到子进程的真实 cwd(`GetCurrentDirectory` 只反映父进程)。需要**注入 shell hook**PowerShell 用 `$PROMPT` 包装输出 OSC 7bash 用 `PS1` 输出 OSC 7)来跟踪 `cwd`。这是 SFTP「跟随终端目录」的前提,P0 就要做进去。
### 4.2 SSH 连接(P0 骨架 / P1 完整)
**连接管理**
- 主机条目 CRUD:别名、host、port、user、认证方式、私钥、跳板机、分组、备注、标签色。
- **从 `~/.ssh/config` 导入**(P0 就做——用户已有配置不该被要求重录)。
- 连接超时、keep-alive 间隔、重试次数可配。
- 连接状态机:`idle → connecting → auth → established → degraded → closed`,每态可观测。
**认证方式**P0 覆盖前两项,P1 补齐)
1. **公钥认证**P0):支持 RSA / ECDSA / Ed25519,私钥来自文件或导入的存储。
2. **密码认证**P0):密码存 `secrets.rs`,键名 `terminal-ssh-password-{hostId}`
3. **ssh-agent 集成**P1):Windows OpenSSH Agent 命名管道 `\\.\pipe\openssh-ssh-agent`
4. **键盘交互 / 2FA**(P1):需要前端弹窗接收一次性输入,走「弹窗 → 回传 → 继续握手」的异步流程,不能阻塞握手线程。
5. **证书认证**P2)。
**主机密钥校验(安全基线,P0 必须做)**
- 首次连接展示指纹,要求用户显式确认(**不允许 TOFU 静默接受**)。
- 维护 `known_hosts`(放在 `{app_data_dir}/terminal/known_hosts.json`),格式与 OpenSSH 兼容以便导出。
- 指纹变更时**红色告警 + 阻断连接**,要求用户明确选择「接受新指纹」或「中止」。这是防 MITM 的核心开关,不能省。
- 支持 SHA256 / MD5 双格式展示(SHA256 为主,MD5 兼容老文档)。
**高级能力(P2**
- 跳板机链(ProxyJump,多级)。
- 端口转发:本地转发 `-L`、远程转发 `-R`、动态转发 `-D`SOCKS5)。
- 连接复用(ControlMaster 式):同主机多会话共享 TCP 连接,第二次开标签秒开。
### 4.3 多会话(P0
**组织形态**
- **左侧会话侧栏**:树形结构,支持「收藏 / 按主机分组 / 按项目分组」,支持拖拽排序(复用 `vue-draggable-plus`)。
- **标签页**:会话标签可关闭、可拖动重排、可重命名、可固定(pin)。
- **分屏**:水平/垂直切分,最多 2×2(4 格)。**每个格子是独立会话**,而非同一会话的两视图(后者需要 SSH 多 channel,复杂度高收益低)。
- **会话持久化**:切换到别的模块时**会话不断开**(进程在 Rust 侧活着),回来时重新 attach,用 `@xterm/addon-serialize` 恢复可视区快照。
**会话状态可视化**
- 侧栏与标签上显示状态点:绿=已连接、黄=连接中、灰=已断开、红=异常。
- 状态栏展示:会话类型(Local/SSH)、用户@主机、cwd、编码、终端尺寸、连接延迟。
**会话恢复(P2**
- 应用重启后,提供「恢复上次会话」——本地会话重建 shell 并 `cd` 到原目录;SSH 会话重连(**不恢复进程态**,这点要在 UI 上说明,避免误解)。
- 会话模板:把「一组会话 + 布局」存为模板(如「后端开发环境」= 3 个 SSH 会话横向分屏),一键拉起。
### 4.4 密钥管理(P0
**密钥生命周期**
- **生成**Ed25519(推荐默认)/ RSA2048/3072/4096/ ECDSAP-256/P-384/P-521)。可设注释、可设 passphrase。
- **导入**:支持 OpenSSH 格式、PEM、PKCS#8;支持带 passphrase 的私钥;**支持 PuTTY `.ppk`**Windows 用户存量多,P1)。
- **导出**:导出公钥到剪贴板(一键复制 `ssh-ed25519 AAAA... comment`,配合用户自己贴到服务器)。
- **删除**:二次确认 + 提示「该密钥还关联 N 个主机」。
**存储策略(安全姿态必须与本项目既有约定对齐)**
参照 `secrets.rs` 头部注释里明确批判过的历史问题——「同样是可冒充身份的凭据,不该区别对待」。据此定:
| 数据 | 存放位置 | 理由 |
|---|---|---|
| 私钥**文件本身** | `{app_data_dir}/terminal/keys/` 目录,文件权限收紧 | 私钥可能几 KB,塞进凭据管理器(单条上限约 2.5KB)不可靠;且用户需要用其他工具引用该路径 |
| 私钥 **passphrase** | `secrets.rs` → 系统凭据管理器 | 是「可冒充身份的凭据」,必须 DPAPI 保护,键名 `terminal-key-passphrase-{keyId}` |
| SSH 密码 | `secrets.rs` | 同上,键名 `terminal-ssh-password-{hostId}` |
| 代理密码(P2 | `secrets.rs` | 同上 |
| 主机密钥指纹 / known_hosts | JSON 文件 | 非机密,需要人可读、可导出 |
| 主机配置 / 会话元数据 / 设置 | `{app_data_dir}/terminal/settings.json` | 非机密;`#[serde(default)]` 容器级默认,保证向后兼容 |
**明文禁令**(写入代码注释与评审清单):
- 私钥明文**只允许**存在于内存与 `keys/` 目录,禁止回写 `settings.json`
- 私钥 passphrase / SSH 密码禁止进入 localStorage、禁止进入任何日志行。
- 前端**不存在读取凭据明文的命令**——参照 `translate` 模块的姿态:列表接口只回传 `hasPassphrase: bool` + 掩码串。
**ssh-agent 集成(P1**
- 检测 Windows OpenSSH Agent 服务是否运行。
- 「添加到 agent」/「从 agent 移除」操作。
- 指明哪些密钥由 agent 托管(UI 上区分展示)。
**known_hosts 管理(P1**
- 列表查看所有已知主机,支持搜索、删除单条、批量导入导出。
- 变更告警历史留档。
### 4.5 文件快捷管理(P1
**SFTP 双栏文件管理器**
- 左侧本地、右侧远程(或双远程,支持拖拽跨栏传输)。
- 列视图:名称 / 大小 / 类型 / 权限 / 修改时间 / 所有者。支持排序、多选、框选。
- 路径面包屑 + 可直接编辑路径 + 前进后退历史。
- 权限可视化与编辑(`rwxr-xr-x``755` 双向互转)。
**文件操作**
- 新建目录 / 新建文件 / 重命名 / 删除(二次确认)/ 复制 / 移动。
- 上传 / 下载:目录递归、进度显示、**并发分片**(多小文件并行,大文件单流)、断点续传、失败重试、队列管理。
- 拖拽:从 Windows 资源管理器拖入上传;从远程栏拖出到本地栏下载。
- 编辑远程文件:双击打开内置编辑器,保存时上传(P1 用 `<textarea>`P2 换 CodeMirror 带语法高亮)。
**与终端的联动(这是本模块区别于普通 SFTP 客户端的核心)**
- **跟随 cwd**:终端里 `cd` 后,SFTP 面板自动跟随(依赖 §4.1 的 OSC 7 hook)。
- **`rz` / `sz` 内联传输**:拦截终端里的 `sz <file>`,自动弹出「保存到本地」对话框;拦截 `rz`,弹出「选择本地文件上传」。需要实现 ZMODEM 协议或调用 `lrzsz`P2,但价值高)。
- **选中即操作**:终端里双击路径(如 `/var/log/nginx/error.log`)→ 右键菜单「用 SFTP 打开所在目录」。
**本地文件管理(附带)**
- 「本地 Shell」会话同样挂载文件面板,可当轻量双栏文件管理器用(与快速面板的文件能力形成互补,不重复:快速面板面向「搜索定位」,这里面向「浏览操作」)。
### 4.6 快捷键体系(P0
分三层,边界清晰:
**第一层:全局快捷键**(走 `shortcut.rs`,与系统级冲突检测)
| 功能 | 默认值 | 说明 |
|---|---|---|
| 唤起快速会话菜单 | `Ctrl+Alt+T` | 类「新建终端」语义,弹浮层选主机/Shell |
| 打开终端模块 | 无(不抢占) | 建议不设,避免与用户既有习惯冲突 |
> 注意:`shortcut.rs` 的应用内冲突检测会拒绝「已被其他模块占用」的组合。截图默认 `Ctrl+Alt+A`、翻译面板默认 `Ctrl+2`。终端默认值需与此避让。
**第二层:终端内快捷键**xterm `attachCustomKeyEventHandler` 拦截,仅在终端聚焦时生效)
| 功能 | Windows 键位 | 说明 |
|---|---|---|
| 复制 | `Ctrl+Shift+C` | Windows Terminal 惯例。**不拦 `Ctrl+C`**(必走 SIGINT |
| 粘贴 | `Ctrl+Shift+V` | |
| 选中即复制 | 可开关 | 习惯问题,默认关 |
| 新建标签 | `Ctrl+Shift+T` | |
| 关闭标签 | `Ctrl+Shift+W` | 有活动进程时二次确认 |
| 下一个/上一个标签 | `Ctrl+Tab` / `Ctrl+Shift+Tab` | |
| 跳转到第 N 标签 | `Alt+1..9` | |
| 垂直/水平分屏 | `Ctrl+Shift+D` / `Ctrl+Shift+E` | |
| 关闭分屏 | `Ctrl+Shift+Q` | |
| 终端内搜索 | `Ctrl+Shift+F` | 走 `addon-search` |
| 清屏 | `Ctrl+Shift+K` | 发送 `clear``cls`(按 shell 判断) |
| 字体放大/缩小/复位 | `Ctrl+=` / `Ctrl+-` / `Ctrl+0` | |
| 打开 SFTP 面板 | `Ctrl+Shift+P` | |
| 命令片段库 | `Ctrl+Shift+S` | |
| 重命名标签 | `F2` | |
| 会话切换器(快速跳转) | `Ctrl+Shift+O` | 模糊搜索所有会话 |
**第三层:Shell 内快捷键**(终端原生,不改)
- `Ctrl+L``Ctrl+R``Ctrl+A/E/U/K` 等一律透传给 shell,终端不拦截。
**可配置性**
- 第二层全部可自定义,配置存 `terminal/settings.json`
- 冲突检测:同一组合被两个动作占用时高亮提示。
- 提供「重置为默认」。
### 4.7 命令增强(P1,体现「全能」)
- **命令历史搜索**:跨会话聚合历史(本地 shell 从 PowerShell 历史文件读,SSH 会话抓取输出流),`Ctrl+R` 增强版,模糊搜索 + 频次排序。
- **命令片段库(Snippets)**:保存常用命令模板,支持 `{{变量}}` 占位符,选择时弹窗填参;支持分类与搜索;支持一键发送到当前会话。
- **命令补全**(P1):基于历史 + 片段做行内补全(类似 fish 的灰字建议),在 xterm 上叠加一层浮层实现。
- **AI 命令助手(P2)**:复用 `translate` 模块已配置的 AI 引擎(`translate/settings.rs` 里的 `TranslateEngineConfig`),把自然语言转成命令。「复用引擎配置而非另配一套」是关键——用户在翻译模块填过的 API Key 不该再填一遍。
### 4.8 与既有模块联动(P1/P2
| 联动对象 | 联动方式 |
|---|---|
| **快速面板** | (a) 快速面板搜索里出现「打开 SSHprod-web-01」条目;(b) 快速面板输入 `> ssh prod` 直接建会话 |
| **剪贴板模块** | 终端内复制的内容进入剪贴板历史,可回溯找回;剪贴板历史的「粘贴到目标」支持终端 |
| **翻译模块** | 终端选中文本 → `Ctrl+Alt+T` 之类触发划词翻译(**注意**:需把终端进程加进 `SelectionSettings.blacklist` 的思考——实际上终端不在黑名单里,因为终端内 `Ctrl+C` 是复制语义由 xterm 处理,不会误触发;但需实测确认) |
| **代理模块** | SSH 连接可走 mihomo 代理(读 `proxy/settings.json``mixedPort`,参照 `translate/mod.rs::read_mixed_port` 的写法:**只读文件不依赖 Manager 状态** |
| **日志模块** | 连接失败、认证失败、主机密钥变更等关键事件写统一日志 |
| **下载器** | SFTP 传输是否复用下载器的队列/进度 UI?(**建议不复用**——传输语义与 HTTP 下载差异大,共享 UI 会两边受限) |
### 4.9 其他工程能力(补充项)
- **终端外观**:主题(跟随应用亮/暗 + 内置若干配色)、字体族与字号、行高、光标样式(块/竖线/下划线 + 闪烁)、滚动缓冲区行数(默认 10000)、背景透明度。
- **编码**:默认 UTF-8;SSH 老服务器可能是 GBK,需支持按会话指定编码(`encoding_rs` crate)。中文环境下这是刚需,不是可选项。
- **日志与审计(P2)**:可开启「记录会话输入输出到文件」(合规场景),提供脱敏正则。
- **安全基线**
- 禁止在日志中出现私钥、passphrase、密码。
- 会话命令回显中若匹配到疑似密钥(如 `-----BEGIN`),提示用户。
- 危险命令(`rm -rf /``dd`)不做拦截(越权),但可做**高亮提示**(可选功能)。
---
## 5. 工程实现
### 5.1 Rust 侧目录结构
```
src-tauri/src/terminal/
├── mod.rs # TerminalManagerTauri State+ 设置读写
├── settings.rs # 设置数据模型(#[serde(default)] 容器级默认)
├── commands.rs # Tauri 命令层(薄:参数整形 / 校验 / 错误归类)
├── session.rs # Session trait + SessionRegistryDashMap
├── pty/
│ ├── mod.rs
│ └── conpty.rs # ConPTY 绑定、read/write 线程、resize 时序处理
├── shell.rs # 本地 Shell 探测与启动参数组装
├── ssh/
│ ├── mod.rs # SshBackend(实现 Session
│ ├── auth.rs # 认证方式(公钥/密码/agent/键盘交互)
│ ├── hostkey.rs # known_hosts 与指纹校验
│ ├── sftp.rs # SFTP 客户端与传输队列
│ ├── forward.rs # 端口转发(P2)
│ └── config.rs # ~/.ssh/config 解析
├── keys.rs # 密钥生成/导入/列举(含 passphrase 走 secrets.rs
├── snippets.rs # 命令片段库
├── history.rs # 命令历史(SQLite,参照 translate/history.rs
└── encoding.rs # 编码转换(UTF-8 / GBK 等)
```
**命令命名**`terminal_*` 前缀,snake_case。预计 P0 约 30 个、P1 约 45 个命令。
**注册顺序**(严格按此,缺一不可):
1. `lib.rs` `mod terminal;` + `use terminal::{...}` 导入命令
2. `lib.rs` `manage(TerminalManager::new(...))``setup.rs` 中构造,与 `TranslateManager` 同法)
3. `lib.rs` `invoke_handler![...]` 追加命令
4. `lib.rs` `export_bindings()``collect_commands![...]` 追加同名命令 —— **漏掉这步前端就没有 `commands.terminalXxx` 类型**
5. `RunEvent::ExitRequested` 中追加 `terminal.cleanup_on_exit()`(关闭所有会话与 PTY
6. `constants.rs` 新增 `windows::TERMINAL_*``events::TERMINAL_*`
### 5.2 前端目录结构
```
src/modules/terminal/
├── index.ts # ModuleConfig(含 searchItems / lifecycle / order
├── TerminalModule.vue # 主组件(布局容器)
├── components/
│ ├── SessionSidebar.vue # 会话树(拖拽排序)
│ ├── TerminalTabs.vue # 标签 + 分屏管理
│ ├── TerminalPane.vue # xterm 实例宿主(单个会话)
│ ├── TerminalToolbar.vue # 顶部工具条
│ ├── TerminalStatusBar.vue # 底部状态栏
│ ├── HostEditorDialog.vue # 主机编辑
│ ├── KeyManagerPanel.vue # 密钥管理
│ ├── SftpPanel.vue # 文件管理器(P1)
│ ├── SnippetsPanel.vue # 命令片段
│ └── QuickSessionPopup.vue # 全局快捷键唤起的快速会话浮层
├── composables/
│ ├── useXterm.ts # xterm 实例创建 / 插件装配 / 尺寸同步
│ ├── useSessionStream.ts # 事件订阅 → 写入 xterm(含背压处理)
│ └── useTerminalKeys.ts # 快捷键拦截与分发
└── settings/TerminalSettings.vue # 设置页(挂进 settings 模块)
```
**store**`src/stores/terminal.ts` — 会话元数据(不持有 xterm 实例)、布局树、当前激活会话、设置缓存。
**事件常量**`constants.ts` 对应前端 `src/lib/constants.ts`):
| 事件名 | 负载 | 触发时机 |
|---|---|---|
| `terminal-output` | `{ sessionId, data: Vec<u8>base64 , seq }` | 会话有输出 |
| `terminal-exit` | `{ sessionId, code, signal }` | 会话进程/连接结束 |
| `terminal-state` | `{ sessionId, state }` | 状态机变更 |
| `terminal-cwd` | `{ sessionId, cwd }` | OSC 7 报告目录变化 |
| `terminal-sftp-progress` | `{ taskId, transferred, total, speed }` | 传输进度 |
> **背压是重点**:大量输出(如 `cat` 大文件)时,事件频率会压垮 WebView。设计上用**批次聚合**——Rust 侧 8~16ms 窗口聚合一次,前端按 `seq` 校验无丢包;xterm 侧用 `write(data, callback)` 的回调控制写入节奏,配合 `addon-webgl` 提升渲染吞吐。
### 5.3 设置模型(`terminal/settings.json`
```rust
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)] // 容器级默认:字段增减向后兼容
pub struct TerminalSettings {
pub version: u32, // 结构版本,用于迁移判断(参照 translate 的 heal 模式)
pub shells: Vec<ShellProfile>, // 本地 Shell 配置
pub hosts: Vec<SshHost>, // SSH 主机条目
pub layout: LayoutSettings, // 标签/分屏默认行为
pub appearance: AppearanceSettings, // 主题/字体/光标/缓冲区
pub shortcuts: Vec<ShortcutBinding>, // 可自定义快捷键
pub selection: SelectionSettings, // 终端内选中行为(复制/粘贴策略)
pub sftp: SftpSettings, // 传输并发、覆盖策略、时间戳保留
pub history: HistorySettings, // 命令历史开关与条数
pub security: SecuritySettings, // 主机密钥策略、代理开关、编码默认值
}
```
**`version` + `heal()` 模式必须沿用**:参照 `translate/settings.rs::heal` ——老配置缺字段取默认值、失效引用自动回落、版本号推进。这是本项目已确立的向后兼容约定。
### 5.4 权限与窗口
- 主窗口已具备 `core:default` 等权限,终端模块**无需新增 capabilities**(全部通过自定义命令走 IPC)。若做独立的快速会话浮层窗口,则需新增 `capabilities/terminal-quick.json`,参照 `translate-popup.json`NOACTIVATE + 预创建)。
- 若后续要做「终端独立窗口」(P2),同样需要独立 capability。
### 5.5 依赖清单
**Rust`Cargo.toml`** —— 以下为**实施后的实际形态**(本节的规划值已被 §9/§10 修正,以这里为准)
```toml
# ===== SSH =====
russh = "0.63" # 规划写 0.5;实际落地版本 0.63.3(见 §9.2 偏差表)
russh-sftp = "3.0" # 【规划遗漏】russh 不含 SFTP,协议在独立 crate 里
# 版本配套:russh-sftp 3.0.0 依赖 `russh ^0.63.2`,与上面同源。
# 这一点是硬约束——SFTP 通道必须从**已认证的同一个
# Session** 上开,跨 patch 版本的类型不互通。
# ===== 编码 =====
encoding_rs = "0.8" # GBK/GB18030/Big5/Shift_JIS/EUC-KR/latin1
# 依赖树里已存在(reqwest → encoding_rs 0.8.35),
# 提升为直接依赖**不新增编译单元**
# ===== 已存在可直接用 =====
# tokio / serde / serde_json / base64 / sha2 / rand / rusqlite / dirs / keyring / dashmap
# ===== 需开启 feature =====
windows-sys = { version = "0.52", features = ["Win32_System_Console", "Win32_System_Pipes",
"Win32_System_Threading", "Win32_Foundation", ...] }
# 注意:InitializeProcThreadAttributeList / UpdateProcThreadAttribute /
# DeleteProcThreadAttributeList 虽属 Win32_System_Threading,但 0.52 未随 feature 导出,
# 用 `unsafe extern "system"` 自行声明(见 conpty.rs 尾部),
# 避免为三个函数开启一个大 feature 而显著拖长编译时间。
```
**前端(`package.json`**
```
@xterm/xterm
@xterm/addon-fit
@xterm/addon-webgl
@xterm/addon-search
@xterm/addon-web-links
@xterm/addon-unicode11
@xterm/addon-serialize # P1
```
### 5.5.1 依赖数量校验(实施后)
`cargo metadata --no-deps` 结果:**50 个直接依赖,0 重复**。重点确认了两件事:
1. `russh` 只有一份(`russh-sftp` 3.0.0 把 `russh` 列为 dev-dependency,不会重复引入)。
2. `encoding_rs` 不会引入第二个 `iconv` 类 C 依赖——它是纯 Rust 实现。
### 5.6 模块注册
```typescript
// src/modules/terminal/index.ts
export const moduleConfig: ModuleConfig = {
id: 'terminal',
name: '终端',
icon: 'terminal', // 需在 icons.ts 加映射 → lucide 的 SquareTerminal
description: 'SSH 与本地 Shell 多会话终端,含密钥管理与文件传输',
category: 'tool',
defaultEnabled: true,
loader: () => import('./TerminalModule.vue'),
searchItems, // 见下方搜索项设计
order: 18 // 建议:proxy=10 / music=15 / terminal=18 / clipboard=20 / translate=25
}
```
`src/modules/icons.ts` 新增:
```typescript
import { SquareTerminal } from '@lucide/vue'
// moduleIconMap 中追加
terminal: SquareTerminal
```
**全局搜索项**`searchItems`)建议覆盖:终端、本地 Shell、SSH 主机(动态)、密钥管理、known_hosts、命令片段、终端设置、外观、编码、快捷键。
---
## 6. 分期路线图
### P0 — 骨架可跑(目标:本地 Shell + SSH 基本连得上 + 密钥管理)
**Rust**
- [ ] `TerminalManager` 骨架 + `Session` trait + `SessionRegistry`
- [ ] ConPTY 绑定(含 resize 时序、阻塞关闭、EOF 处理三个坑)
- [ ] 本地 Shell 探测(PowerShell 7 / Windows PowerShell / cmd / Git Bash / WSL
- [ ] 输出读线程 + 事件聚合(8~16ms 批处理)
- [ ] OSC 7 cwd hook 注入与解析
- [ ] `secrets.rs` 复用:密码 / passphrase 存取
- [ ] 密钥生成(Ed25519 / RSA / ECDSA)、导入、列举、删除
- [ ] SSH 连接(russh):公钥认证 + 密码认证
- [ ] 主机密钥校验 + known_hosts 存储 + 指纹变更阻断
- [ ] 设置模型 + `heal()` 迁移骨架
- [ ] `lib.rs` 六处注册(含 `collect_commands!`+ `cleanup_on_exit`
- [ ] `constants.rs` 窗口/事件常量
**前端**
- [ ] 模块注册(`index.ts` / `modules/index.ts` / `icons.ts`
- [ ] `useXterm.ts`:实例装配(fit + webgl + unicode11 + search + web-links
- [ ] `TerminalPane.vue`I/O 绑定、尺寸同步、焦点管理
- [ ] `TerminalTabs.vue`:多标签 + 关闭确认
- [ ] `SessionSidebar.vue`:会话列表 + 状态点
- [ ] 主机编辑对话框 + 密码短语输入
- [ ] `KeyManagerPanel.vue`
- [ ] 三层快捷键(第二层可配置)
- [ ] 设置页(外观 / Shell / 快捷键)
- [ ] `stores/terminal.ts`
**P0 验收标准**:能开 3 个本地 PowerShell 标签 + 2 个 SSH 会话(一个公钥、一个密码),秒级切换不卡顿,切到其他模块再回来会话仍在,`Ctrl+Shift+C/V` 可复制粘贴,关闭应用无残留进程。
### P1 — 完整能力
- [ ] SFTP 双栏文件管理器(浏览 / 上传 / 下载 / 目录递归 / 并发分片 / 断点续传)
- [ ] 分屏(2×2
- [ ] ssh-agent 集成
- [ ] 键盘交互认证 / 2FA
- [ ] `~/.ssh/config` 导入
- [ ] 命令历史聚合 + 增强搜索
- [ ] 命令片段库
- [ ] 会话侧栏拖拽分组、收藏
- [ ] 会话快照序列化与恢复
- [ ] 全局快捷键「快速会话浮层」
- [ ] 快速面板联动(搜索项 + `> ssh` 语法)
- [ ] SFTP 跟随 cwd
- [ ] 编码支持(GBK
- [ ] 终端内搜索、链接点击
### P2 — 高级与生态
- [x] 端口转发(`-L` / `-R`)(2026-09-18 第五轮,见 §11.3`-D` SOCKS5 留作后续)
- [x] 跳板机链(ProxyJump)(2026-09-18 第四轮,见 §11.2
- [x] 连接复用(2026-09-18 第八轮,见 §11.8
- [x] AI 命令助手(复用 translate 引擎配置)(2026-09-18 第七轮,见 §11.7
- [x] `rz` / `sz` ZMODEM 内联传输 —— **已放弃**2026-09-18 评审:SFTP 已覆盖主场景,
协议成本 600–800 行且无法单测主流程;详见实施记录 §11.9 评估)
- [x] 会话模板(一键拉起一组会话 + 布局)(2026-09-18 第六轮,见 §11.6
- [x] 终端独立窗口(P1 已交付 detach/attach;「拖出标签成窗」手势留后续)
- [x] 会话日志与审计(2026-09-18 第五轮,见 §11.4
- [x] PuTTY `.ppk` 导入(2026-09-18 第四轮,见 §11.1
- [x] 主机分组同步(导入导出配置)(2026-09-18 第六轮,见 §11.5
---
## 7. 风险清单
| # | 风险 | 影响 | 缓解 |
|---|---|---|---|
| 1 | ConPTY resize 竞态导致 TUI 程序(vim/htop)花屏 | 中 | 首帧后延迟应用尺寸;监听 `WINDOW_BUFFER_SIZE_EVENT` 校正;实测 vim/top/less |
| 2 | `ClosePseudoConsole` 阻塞导致退出卡死 | **高** | 独立线程 + 先取消 `ReadFile``cleanup_on_exit` 带超时(参照 `MonitorKernel` 的 3s `recv_timeout` 写法) |
| 3 | 输出洪流压垮 WebView`cat` 大文件) | **高** | Rust 侧 8~16ms 批次聚合 + `seq` 校验;xterm `write` 回调节流;`addon-webgl` |
| 4 | `russh` API 破坏性变更 | 中 | 锁定小版本;`Session` trait 隔离,必要时可换 `ssh2` |
| 5 | 主机密钥校验被用户习惯性点过(TOFU 疲劳) | **高(安全)** | 首次连接突出展示指纹;变更时红色阻断而非黄色提示;提供「仅本次接受」与「永久接受」区分 |
| 6 | 多会话内存占用(每个 xterm 实例 + 滚动缓冲) | 中 | 默认缓冲 10000 行;会话数量上限提示;非激活标签暂停渲染 |
| 7 | 中文宽字符对齐错乱 | 中 | 必装 `addon-unicode11`;实测 `ls -l` 中文文件名的列对齐 |
| 8 | SSH 老服务器 GBK 编码乱码 | 中 | `encoding_rs` 按会话转码;默认 UTF-8 可选 GBK |
| 9 | 私钥文件被其他进程读取 | 中(安全) | `keys/` 目录权限收紧;passphrase 存凭据管理器;UI 提示用户优先使用带 passphrase 的密钥 |
| 10 | `Cargo.toml` 编码损坏影响新增依赖的 diff | 低 | 独立清理项,建议在动工前修复 |
| 11 | 分屏 × 标签 × 会话的组合复杂度爆炸 | 中 | 分屏上限 2×2;布局用树结构表达并单测 |
| 12 | 全局快捷键与应用内快捷键语义混淆 | 低 | 明确三层边界,UI 上一处分开展示;不做「全局拦截 Ctrl+C」这类危险映射 |
---
## 8. 待确认决策项
动工前需要拍板的四项,我给出倾向但需要用户确认:
1. **SSH 库**:倾向 `russh`(async 契合)。若用户更看重稳定性与既有经验,可改 `ssh2`
2. **ConPTY**:倾向直接绑定 `windows-sys`(与项目现有原生态一致)。若更看重开发速度,可用 `portable-pty`
3. **P0 范围**:本规划把「SSH + 密钥管理 + 多会话 + 快捷键」全放进 P0,工作量偏大(8~12 天)。若希望更快见到可用版本,可将 SSH 拆到 P0.5,先交付「本地 Shell + 多会话 + 快捷键」。
4. **是否需要终端独立窗口**:影响窗口与 capability 设计,早定早省事。
---
## 附录 A:与既有模块的范式对照
| 范式 | 既有实现 | 终端模块对应 |
|---|---|---|
| 模块 ID / 分类 | `translate``category: 'tool'` | 同 |
| 设置持久化 | `{app_data_dir}/<module>/settings.json` | `{app_data_dir}/terminal/settings.json` |
| 设置兼容 | 容器级 `#[serde(default)]` + `heal()` + `version` | 完全沿用 |
| 凭据存储 | `secrets.rs` + 服务名 `"Thing"` | 完全复用,仅新增键名约定 |
| 命令层姿态 | `translate/commands.rs`「薄」:整形/校验/归类 | 同 |
| 类型绑定 | `tauri-specta``src/lib/bindings.ts` | 必须复用 |
| 事件命名 | `kebab-case``translate-stream-chunk` | `terminal-output` / `terminal-exit` / ... |
| 快捷键 | `shortcut.rs` 原子注册 + 冲突检测 | 完全复用 |
| 退出清理 | `RunEvent::ExitRequested` 逐个 `cleanup_on_exit` | 追加 `TerminalManager` |
| 历史存储 | `translate/history.rs`SQLite | `terminal/history.rs` 同法 |
| 原生浮层窗口 | `translate-popup`NOACTIVATE 预创建) | 快速会话浮层参照 |
## 附录 B:命名规范落点
| 类型 | 规范 | 示例 |
|---|---|---|
| 前端组件 | PascalCase | `TerminalPane.vue` |
| 前端文件 | kebab-case | `use-session-stream.ts`composable 目录内用 camelCase 前缀 `use` |
| Pinia store | camelCase 文件 | `src/stores/terminal.ts` |
| Rust 模块 | snake_case | `terminal/pty/conpty.rs` |
| Tauri 命令 | `terminal_` + snake_case | `terminal_open_session` |
| Tauri 事件 | kebab-case | `terminal-output` |
| 凭据键名 | `terminal-<用途>-<id>` | `terminal-key-passphrase-{keyId}` |
| 设置字段 | camelCaseserde rename_all | `maxScrollback` |
---
## 9-11. 实施记录(P0P2 精编)
> 本节为 2026-09-18 全链路审查时按「精简」要求压缩的版本:保留全部**架构决策、
> 坑记录与语义备忘**,省略逐轮的过程性叙述与重复的验证表。按阶段分节的原始
> 详版(P0 §9 / P1 §10 / P2 §11,共 8 轮)记录在 git 历史与当日工作日志中。
### 交付总览
| 阶段 | 交付 | 状态 |
|---|---|---|
| P0 | 本地 ShellConPTY)、SSH 连接、多标签、密钥管理、快捷键骨架 | ✅ |
| P1 | SFTP 双栏、分屏 2×2、命令片段库、命令历史(OSC 133)、编码切换、Cargo.toml 修复 | ✅ |
| P2 | `.ppk` 导入、ProxyJump 跳板链、端口转发 -L/-R、会话日志与审计、主机导入导出、会话模板、AI 命令助手、连接复用 | ✅ |
| P2 | 终端独立窗口 | ✅(P1 交付 detach/attach |
| P2 | ZMODEM | ❌ 已放弃(评估见下) |
| 审查 | 全链路审查:修复 2 个 P0 级前端缺陷 + 1 个后端竞态 + 4 个中低问题 | ✅ |
### 分阶段决策摘要
**P0(骨架)**
- ConPTY 直接用 `windows-sys``CreatePseudoConsole` 三函数自行声明(避免拖入大 feature)。
- 会话抽象 `Session` trait:本地/SSH 双后端共用命令层;`ProcessManager` 不适用(N 会话 + 双向流 + 退出不重启)。
- `SessionId` 用短序号(`s1`…),会出现在窗口 label 与日志。
- 密码/密钥 passphrase 分离存储:密码进系统凭据管理器(按 id 键名),私钥本体落 `keys/` 目录。
**P1(完整能力)**
- SFTPrussh 不含 SFTP → 引入 `russh-sftp`;通道挂在会话连接上(非独立连接)。
- 分屏 = 新建会话 + 并排渲染(tmux 语义),上限 4(WebGL 上下文约束);CSS Grid 布局。
- 命令片段:占位符 `${name}` 语法只在 Rust 侧实现一份(前端自己写正则必分叉);两步执行(填入 vs 执行)。
- 命令历史:OSC 133 + 1337 提取命令边界;本地用 shell hook 上报 cwd;不做 DROP 重建式迁移。
- 编码切换:解码在前端(用户可切编码重看历史),读写两侧都从会话状态现取。
**P2(高级与生态,共 8 轮)**
- `.ppk` 导入:`ssh-key``ppk` feature(russh 不转发 → 自己声明同版本号 `=0.7.0-rc.11`);PPK 解析后统一转 OpenSSH 落盘。
- ProxyJumprussh 无内置 → 逐跳手搭(`direct-tcpip` 通道流 + `connect_stream`);跳板与直连同权校验。
- 端口转发 -L/-R`direct-tcpip` + `copy_bidirectional` / `tcpip_forward` + Handler 白名单回调;规则挂会话不持久化。
- 会话日志:双后端 `flush_output` 单点挂钩;记原始字节含 ANSI;只记输出不记输入(密码安全)。
- 主机同步:JSON 备份只含配置不含密码/私钥;导入重编 id(凭据键名冲突)+ 重写跳板链 + 三元组去重。
- 会话模板:捕获当前可见面板集合;拉起 = 逐条开会话 + addPane;只存 target 引用。
- AI 助手:复用翻译模块引擎配置(`chat_once` 通用补全出口);三层解析防御;默认填入不执行。
- 连接复用:连接池按「用户名|host:port|auth|材料指纹」共享 SSH 连接;引用计数归零才断开。
### 关键架构语义备忘(跨模块契约)
1. **`ssh-key 0.7``decrypt()`/`encrypt()` 都是 `&self → Result<Self>` 转换语义**——返回值必须接住;
丢返回值 = 仍在加密态(坑 31,曾导致加密私钥导入从未成功过)。
2. **`encrypt()` 会清空内存对象的注释**(重建 public_key),但加密载荷里含注释(decrypt 可读回);
`set_comment` 必须在 encrypt 之后调用。
3. **`collect_commands!`(导出绑定)与 `generate_handler!`(运行时注册)是两份独立清单**——
新增命令必须双清单登记;前端用原生 `invoke` + 手写镜像类型(translate 先例,terminal 跟随)。
4. **`export_bindings()` 失败是运行时的**:specta 类型注册表全局按名索引,
跨模块同名 `Type` 派生类型会让应用启动即 panic`cargo check` 完全看不见)。
5. **`tauri-specta` derive 路径无法重命名类型**(`#[specta(rename)]` 只对函数宏生效)——
通用词(Settings/HistoryPage/Item…)一律加模块前缀。
6. **`Write` 契约**:前端 `store.write(string)` 必须 TextEncoder 编码后 base64
(后端严格解码);xterm onData / 粘贴走字符串分支。
7. **`vue-draggable-plus``target` 是跨容器专用 prop**,且 `querySelector` 不匹配元素自身——
单容器排序禁止传 target。
8. **连接池槽位是 tokio Mutex**(连接建立期跨 `.await` 持锁,天然串行化同主机并发连接);
sftp/转发的同步访问走 `spawn_blocking + block_on`,锁在 block_on 内获取。
9. **跳板 Handle 挂池条目**而非首建会话——否则首建会话关闭剪断他人隧道。
10. **`-R` 入站路由按端口全局匹配**:连接级 Handler 的 session_id 属于首建会话;
远程监听端口全局唯一(add 时强制)。
11. **`chat_once`translate 根 re-export)是终端 AI 助手的唯一 API 配置源**——
终端不持有任何引擎配置副本。
12. **面板常驻挂载**`renderPanes` 含全部会话,v-show 切可见性——
切标签/分屏绝不销毁 xterm 实例(缓冲与隐藏期输出不丢)。
### 坑记录(35 条精编)
| # | 一句话 | 修复/规避 |
|---|---|---|
| 1 | `ssh-key` 双版本分叉(0.6 vs russh 钉的 0.7 | 只用 russh re-export;例外须同版本号声明 |
| 2 | ssh-key 的 getrandom feature 门控(rand_core 0.10 | 直接依赖 getrandom 0.4 + UnwrapErr(SysRng) |
| 3 | `#[specta::specta]``#[tauri::command]` 必须成对 | 漏一个 = 绑定缺失或运行时不可调 |
| 4 | windows-sys 0.52 的 HANDLE/HPCON 是 isize | 注意类型转换 |
| 5 | ConPTY 三个时序陷阱(先建管道再建 PTY 等) | 见 pty::conpty 注释 |
| 6 | `create_pipe()` 已返回 File,不要再转一次 | — |
| 7 | xterm 无 selectWordAt(自实现选择词语) | 右键菜单自定义 |
| 8 | PowerShell 写文件产出 UTF-16LE | 让程序自己写或 Python 落盘 |
| 9 | 密码与配置分离存储(凭据管理器 vs settings.json | 永不明文落盘 |
| 10 | 新建主机先向后端要 id(密码按 id 存取) | id 规则单点 |
| 11 | russh 无 SFTP → 引入 russh-sftp | 通道复用连接 |
| 12 | SFTP 通道借用 Handle 需 spawn_blocking+block_on | Handle 不可 Clone、不能跨 await 持锁 |
| 13 | WebGL 上下文上限 4 个(黑屏风险) | maxPanes 封顶 + onContextLoss 回退 |
| 14 | 分屏容器是标签级的,切标签要重置 | resetPanesTo(见坑 36 修正) |
| 15 | 本机 Bash 缺 coreutils,管道全部失真 | 验证命令重定向到文件后用 Python 读 |
| 16 | `npx` 触发 wsl.exe 黑名单拦截 | 直接调 JS 入口 |
| 17 | PowerShell 重定向产出 UTF-16LE | 同 8 |
| 18 | `vite build` 重定向+后台 = 假死(非 OOM) | 构建一律前台跑 |
| 19 | impl 块放错位置 → trait 方法「已实现却报未实现」 | — |
| 20 | Session trait 未引入时报错指不到成因 | 显式 use |
| 21 | OSC 133 命令文本与结束标记是两个独立序列 | 必须累积 |
| 22 | `1337``133` 共享前缀,判断顺序错了静默失效 | 先判长前缀 |
| 23 | `${x#"$y"}` 类语法在 Rust 字符串里写不出 | 换等价写法 |
| 24 | 两份 `scan_control_sequences` 拷贝按后端分支出诡异 bug | 收敛到一处 |
| 25 | 命令历史遵守 `HISTCONTROL=ignorespace` 惯例 | 前导空格不记录 |
| 26 | FTS 与 LIKE 双路径查询需一致性测试 | — |
| 27 | `export_bindings()` 失败是运行时的(编译全绿 ≠ 能启动) | 新增 Type 必须实际跑二进制 |
| 28 | 两份命令清单不自动同步 | 双清单登记 + 交叉注释 |
| 29 | 重定向/后台让验证命令本身不可信 | 前台对照实验 |
| 30 | `vue-draggable-plus``target` 是跨容器专用(querySelector 不搜自身) | 单容器禁用 target |
| 31 | `decrypt()/encrypt()` 是转换语义,丢返回值 = 加密私钥导入从未成功 | 接住 Result\<Self\> |
| 32 | `encrypt()` 清空内存对象注释(载荷里有) | set_comment 在 encrypt 后 |
| 33 | trait object 不能挂两个非 auto traitE0225 | 合并 trait + blanket impl |
| 34 | russh 对 forwarded-tcpip 默认全收 | Handler 白名单覆写 |
| 35 | 连接复用后 -R 入站按 session_id 路由永不命中 | 全局端口匹配 + 唯一性 |
| 36 | **[审查轮]** 切标签销毁 xterm 实例、隐藏期输出被丢弃 | renderPanes 常驻全部会话 + v-show |
| 37 | **[审查轮]** store.write 字符串分支未编码 → 键盘输入完全失效 | TextEncoder 后 base64 |
### 全链路审查(2026-09-18P2 收官)
探查代理 + 人工复核,确认并修复 7 项(另排除 2 项误报):
| # | 级别 | 问题 | 修复 |
|---|---|---|---|
| 1 | **P0** | `store.write` 字符串分支未 base64 编码——xterm 键盘输入/粘贴全部被后端拒绝,**终端无法打字**(坑 37) | TextEncoder 编码后再 base64 |
| 2 | **P0** | 切标签卸载其他会话的 TerminalPane:xterm 缓冲丢失、隐藏期输出被丢弃(坑 36) | renderPanes 常驻全部会话 + v-show |
| 3 | 高 | 连接期间关闭标签的竞态:do_connect 复活会话(Established 覆盖 Closed)、连接写进已拆除的池条目永不断开 | do_connect 三处 closed 检查点,命中则断开新连接并放弃 |
| 4 | 高 | `closeTab` 分屏组误判:分屏激活时关后台标签会误关分屏组而非目标 | 仅当目标在分屏组内才按组关闭 |
| 5 | 中 | SFTP 面板在 SSH 会话间切换不关旧通道(泄漏) | `<SftpPanel :key="sessionId">` 强制重建 |
| 6 | 低 | HistoryPanel 防抖定时器卸载不清理 | onBeforeUnmount clearTimeout |
| 7 | 低 | Alt+1..9 要求焦点在 `.xterm` 内(侧栏/对话框下失效) | 只在输入控件聚焦时让路 |
已排除的误报:「兜底 watch 只看 sessions.length」(实际有 activeSessionId 有效性校验)等。
**性能结论**:输出管线(8ms 聚合窗口 + base64 + 事件)与渲染(WebGL + 回退)无热点;
面板常驻化后 xterm 实例数 = 会话数,WebGL 超限已有回退兜底。无需要改动的热路径。
### ZMODEM 评估(已放弃)
完整协议(帧结构 / CRC-16+32 / 转义编码 / 滑动窗口重同步 / 双向状态机)约 600–800 行,
调试依赖真实 rz/sz 对端,无法用单测覆盖主流程。SFTP 已覆盖绝大多数文件传输场景,
ZMODEM 剩余价值主要在串口/老旧嵌入式设备。成本收益不成立,正式放弃;
若未来出现需求,建议独立一轮且优先做 sz 下载方向。
### 验证汇总(收官状态)
| 检查 | 结果 |
|---|---|
| `cargo check` | exit 0(警告数与 P0 基线一致) |
| `cargo test --lib` | **91/91 通过**keys 17 + commands 9 + assistant 6 + audit 5 + pool 5 + 既有 49 |
| `vue-tsc --noEmit` | exit 0 |
| 类型重名扫描 / 池引用计数 / 解析防御 | 单测覆盖 |
### 待用户真机验证清单
1. 终端键盘输入与粘贴(审查轮修复 #1——此前从未被测出)。
2. 多标签切换不丢缓冲、隐藏期输出不丢(修复 #2)。
3. 连接复用:同主机双标签秒连、关一个另一个不受影响、全关后连接断开。
4. ProxyJump 跳板链、端口转发 -L/-R、`.ppk` 导入、会话模板拉起、AI 助手(需翻译引擎配置)。
## 附:P1 新增命令清单(供前端对接与后续维护)
| 命令 | 参数 | 返回 |
|---|---|---|
| `terminal_sftp_is_open` | `sessionId` | `bool` |
| `terminal_sftp_open` | `sessionId` | `ActionOutcome`(幂等) |
| `terminal_sftp_close` | `sessionId` | `()` |
| `terminal_sftp_list` | `sessionId`, `path` | `RemoteDir` |
| `terminal_sftp_parent` | `path` | `string` |
| `terminal_sftp_read_link` | `sessionId`, `path` | `string` |
| `terminal_sftp_mkdir` | `sessionId`, `path` | `()` |
| `terminal_sftp_delete` | `sessionId`, `path`, `isDir` | `ActionOutcome` |
| `terminal_sftp_rename` | `sessionId`, `from`, `to` | `()` |
| `terminal_sftp_upload` | `sessionId`, `localPath`, `remotePath` | `ActionOutcome` |
| `terminal_sftp_download` | `sessionId`, `remotePath`, `localPath` | `ActionOutcome` |
| `terminal_session_cwd_value` | `sessionId` | `string` |
| `terminal_open_local_path` | `path` | `()` |
| `terminal_reveal_local_path` | `path` | `()` |
| `terminal_list_snippets` | — | `SnippetView[]` |
| `terminal_save_snippet` | `snippet` | `SnippetView[]` |
| `terminal_delete_snippet` | `snippetId` | `SnippetView[]` |
| `terminal_render_snippet` | `snippetId`, `values` | `string` |
| `terminal_run_snippet` | `sessionId`, `snippetId`, `values`, `submit` | `ActionOutcome` |
| `terminal_restore_default_snippets` | — | `SnippetView[]` |
**新增事件**`terminal-transfer-progress`(负载 `TransferProgress`200ms 节流)。
### 追加:P1 第四 / 第五批(字符编码 + 命令历史)
| 命令 | 参数 | 返回 | 备注 |
|---|---|---|---|
| `terminal_set_encoding` | `sessionId`, `encoding` | `string` | 返回**后端 normalize 后的规范名**,前端须以此回写;内部已 emit `TERMINAL_STATE`,前端不要重复刷新 |
| `terminal_history_query` | `query: HistoryQuery` | `HistoryPage` | `keyword` 短于 3 字符自动走 `LIKE` 回退(trigram 索引对 `ls`/`cd` 无效) |
| `terminal_history_sources` | — | `HistorySource[]` | 只返回**有历史记录**的来源,不是全部主机列表 |
| `terminal_history_toggle_favorite` | `id` | `bool` | 返回切换后的状态 |
| `terminal_history_delete` | `id` | `ActionOutcome` | |
| `terminal_history_clear` | `keepFavorites: Option<bool>` | `ActionOutcome` | 省略时默认 `true`(保留收藏);`ActionOutcome` 带删除条数 |
| `terminal_history_run` | `sessionId`, `command`, `submit: Option<bool>` | `ActionOutcome` | `submit` 省略即 `false`(只填入不执行);命令内 `\r`/`\n` **折叠为空格** |
**前端配套约定**
- `SessionInfo.encoding` 是唯一编码事实源;状态栏下拉改值走 `terminal_set_encoding`,成功后回写 store 里的 `session.encoding`
- 输出侧解码在 `useXterm``decoderFor(encoding)` 缓存 `TextDecoder`);**Rust 侧永不转码**,只发原始字节的 base64。
- 输入侧重编码在 `SshSession::write`(本地会话不需要 —— Windows 控制台收的是 UTF-8UTF-16 转换由 ConPTY 负责)。
- 历史面板 `Ctrl+Shift+H`;单击**填入**、双击 / `Enter` **填入并执行**(默认不执行是刻意的取舍,理由见 §10.12)。
+54 -2
View File
@@ -1,12 +1,12 @@
{
"name": "thing",
"version": "0.1.0",
"version": "26.9.3",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "thing",
"version": "0.1.0",
"version": "26.9.3",
"dependencies": {
"@lucide/vue": "^1.28.0",
"@tailwindcss/vite": "^4.3.2",
@@ -16,6 +16,13 @@
"@tauri-apps/plugin-global-shortcut": "^2",
"@tauri-apps/plugin-opener": "^2",
"@vueuse/core": "^14.4.0",
"@xterm/addon-fit": "^0.11.0",
"@xterm/addon-search": "^0.16.0",
"@xterm/addon-serialize": "^0.14.0",
"@xterm/addon-unicode11": "^0.9.0",
"@xterm/addon-web-links": "^0.12.0",
"@xterm/addon-webgl": "^0.19.0",
"@xterm/xterm": "^6.0.0",
"class-variance-authority": "^0.7.1",
"clsx": "^2.1.1",
"pinia": "^3.0.4",
@@ -1719,6 +1726,51 @@
"vue": "^3.5.0"
}
},
"node_modules/@xterm/addon-fit": {
"version": "0.11.0",
"resolved": "https://registry.npmmirror.com/@xterm/addon-fit/-/addon-fit-0.11.0.tgz",
"integrity": "sha512-jYcgT6xtVYhnhgxh3QgYDnnNMYTcf8ElbxxFzX0IZo+vabQqSPAjC3c1wJrKB5E19VwQei89QCiZZP86DCPF7g==",
"license": "MIT"
},
"node_modules/@xterm/addon-search": {
"version": "0.16.0",
"resolved": "https://registry.npmmirror.com/@xterm/addon-search/-/addon-search-0.16.0.tgz",
"integrity": "sha512-9OeuBFu0/uZJPu+9AHKY6g/w0Czyb/Ut0A5t79I4ULoU4IfU5BEpPFVGQxP4zTTMdfZEYkVIRYbHBX1xWwjeSA==",
"license": "MIT"
},
"node_modules/@xterm/addon-serialize": {
"version": "0.14.0",
"resolved": "https://registry.npmmirror.com/@xterm/addon-serialize/-/addon-serialize-0.14.0.tgz",
"integrity": "sha512-uteyTU1EkrQa2Ux6P/uFl2fzmXI46jy5uoQMKEOM0fKTyiW7cSn0WrFenHm5vO5uEXX/GpwW/FgILvv3r0WbkA==",
"license": "MIT"
},
"node_modules/@xterm/addon-unicode11": {
"version": "0.9.0",
"resolved": "https://registry.npmmirror.com/@xterm/addon-unicode11/-/addon-unicode11-0.9.0.tgz",
"integrity": "sha512-FxDnYcyuXhNl+XSqGZL/t0U9eiNb/q3EWT5rYkQT/zuig8Gz/VagnQANKHdDWFM2lTMk9ly0EFQxxxtZUoRetw==",
"license": "MIT"
},
"node_modules/@xterm/addon-web-links": {
"version": "0.12.0",
"resolved": "https://registry.npmmirror.com/@xterm/addon-web-links/-/addon-web-links-0.12.0.tgz",
"integrity": "sha512-4Smom3RPyVp7ZMYOYDoC/9eGJJJqYhnPLGGqJ6wOBfB8VxPViJNSKdgRYb8NpaM6YSelEKbA2SStD7lGyqaobw==",
"license": "MIT"
},
"node_modules/@xterm/addon-webgl": {
"version": "0.19.0",
"resolved": "https://registry.npmmirror.com/@xterm/addon-webgl/-/addon-webgl-0.19.0.tgz",
"integrity": "sha512-b3fMOsyLVuCeNJWxolACEUED0vm7qC0cy4wRvf3oURSzDTYVQiGPhTnhWZwIHdvC48Y+oLhvYXnY4XDXPoJo6A==",
"license": "MIT"
},
"node_modules/@xterm/xterm": {
"version": "6.0.0",
"resolved": "https://registry.npmmirror.com/@xterm/xterm/-/xterm-6.0.0.tgz",
"integrity": "sha512-TQwDdQGtwwDt+2cgKDLn0IRaSxYu1tSUjgKarSDkUM0ZNiSRXFpjxEsvc/Zgc5kq5omJ+V0a8/kIM2WD3sMOYg==",
"license": "MIT",
"workspaces": [
"addons/*"
]
},
"node_modules/alien-signals": {
"version": "1.0.13",
"dev": true,
+10 -1
View File
@@ -5,7 +5,9 @@
"type": "module",
"scripts": {
"dev": "vite",
"build": "vue-tsc --noEmit && vite build",
"build": "vue-tsc --noEmit && node --max-old-space-size=8192 node_modules/vite/bin/vite.js build",
"build:vite": "node --max-old-space-size=8192 node_modules/vite/bin/vite.js build",
"typecheck": "vue-tsc --noEmit",
"preview": "vite preview",
"test": "node --test src/modules/quickpanel/engine.test.ts src/lib/calc.test.ts",
"tauri": "tauri"
@@ -19,6 +21,13 @@
"@tauri-apps/plugin-global-shortcut": "^2",
"@tauri-apps/plugin-opener": "^2",
"@vueuse/core": "^14.4.0",
"@xterm/addon-fit": "^0.11.0",
"@xterm/addon-search": "^0.16.0",
"@xterm/addon-serialize": "^0.14.0",
"@xterm/addon-unicode11": "^0.9.0",
"@xterm/addon-web-links": "^0.12.0",
"@xterm/addon-webgl": "^0.19.0",
"@xterm/xterm": "^6.0.0",
"class-variance-authority": "^0.7.1",
"clsx": "^2.1.1",
"pinia": "^3.0.4",
+1237 -144
View File
File diff suppressed because it is too large Load Diff
+72 -7
View File
File diff suppressed because one or more lines are too long
@@ -0,0 +1,23 @@
{
"$schema": "../gen/schemas/desktop-schema.json",
"identifier": "terminal-window",
"description": "Capability for detached terminal windows (one session per window, label = terminal-window-<sessionId>)",
"windows": ["terminal-window-*"],
"permissions": [
"core:default",
"core:window:allow-close",
"core:window:allow-minimize",
"core:window:allow-maximize",
"core:window:allow-toggle-maximize",
"core:window:allow-set-focus",
"core:window:allow-start-dragging",
"core:window:allow-set-theme",
"core:window:allow-set-background-color",
"core:event:allow-listen",
"core:event:allow-emit",
"opener:default",
"opener:allow-open-path",
"opener:allow-reveal-item-in-dir",
"snap-layout:default"
]
}
+21
View File
@@ -16,6 +16,9 @@ pub mod windows {
pub const SCREENSHOT_SCROLL: &str = "screenshot-scroll";
/// 取词翻译悬浮窗(由 translate 模块预创建,非激活显示)
pub const TRANSLATE_POPUP: &str = "translate-popup";
/// 终端独立窗口前缀,实际 label = `${TERMINAL_WINDOW}-<sessionId>`
/// 每个终端窗口承载一个会话,脱离主窗口独立存在。
pub const TERMINAL_WINDOW: &str = "terminal-window";
}
/// Tauri 事件名(与前端 constants::EVENTS 对应)
@@ -73,6 +76,24 @@ pub mod events {
pub const TRANSLATE_STREAM_ERROR: &str = "translate-stream-error";
// 音乐模块:Python 便携运行时安装进度
pub const MUSIC_RUNTIME_INSTALL_PROGRESS: &str = "music-runtime-install-progress";
// 终端模块:会话输出批次(负载见 terminal::events::OutputPayload
// 按 8~16ms 窗口聚合,前端用 seq 校验连续性
pub const TERMINAL_OUTPUT: &str = "terminal-output";
// 终端模块:会话结束(负载见 terminal::events::ExitPayload
pub const TERMINAL_EXIT: &str = "terminal-exit";
// 终端模块:会话状态变更(负载为 SessionInfo,前端据此刷新侧栏与标签)
pub const TERMINAL_STATE: &str = "terminal-state";
// 终端模块:工作目录变化(OSC 7 hook 上报;SFTP 跟随目录依赖此事件)
pub const TERMINAL_CWD: &str = "terminal-cwd";
// 终端模块:SSH 主机密钥需用户确认(阻塞式交互,握手暂停等待回传)
pub const TERMINAL_HOST_KEY_PROMPT: &str = "terminal-host-key-prompt";
// 终端模块:请求前端对「关闭仍在运行的会话」二次确认
// (P2 起用:P0 的关闭确认在前端 store 内完成,事件通道先占位)
#[allow(dead_code)]
pub const TERMINAL_CONFIRM_CLOSE: &str = "terminal-confirm-close";
// 终端模块:SFTP 传输进度(负载见 terminal::ssh::sftp::TransferProgress
// 节流后发送(约 200ms 一次),前端据此画进度条
pub const TERMINAL_TRANSFER_PROGRESS: &str = "terminal-transfer-progress";
// 音乐模块:下载任务事件(桥接事件行 → 前端,负载见 bridge.py _emit_event
pub const MUSIC_DOWNLOAD_EVENT: &str = "music-download-event";
// 后端自动切换节点完成(前端据以刷新节点列表并提示)
+169 -1
View File
@@ -16,6 +16,7 @@ mod secrets;
mod setup;
mod shortcut;
mod snap_fix;
mod terminal;
mod translate;
mod tray_menu;
mod updater;
@@ -103,6 +104,46 @@ use quickpanel::{
quickpanel_show_window, quickpanel_unregister_shortcut, quickpanel_focus_main_window,
};
use tray_menu::{tray_menu_action, tray_menu_hide, tray_menu_ready};
use terminal::commands::{
terminal_attach_session, terminal_clear_known_hosts, terminal_clear_session,
terminal_close_session, terminal_confirm_host_key, terminal_default_cwd, terminal_delete_host,
terminal_delete_key, terminal_delete_shell, terminal_detach_session,
terminal_export_known_hosts, terminal_forget_host, terminal_generate_key,
terminal_get_settings, terminal_import_key, terminal_import_known_hosts,
terminal_import_ssh_config, terminal_key_public, terminal_list_hosts,
terminal_list_known_hosts, terminal_list_keys, terminal_list_sessions,
terminal_list_shells, terminal_new_host_id, terminal_open_local,
terminal_open_ssh, terminal_open_local_path, terminal_reveal_local_path,
terminal_refresh_shells, terminal_rename_key, terminal_rename_session,
terminal_resize, terminal_save_appearance, terminal_save_host, terminal_save_layout,
terminal_save_security, terminal_save_selection, terminal_save_settings,
terminal_save_shell, terminal_save_shortcuts, terminal_send_key, terminal_session_alive,
terminal_session_cwd, terminal_session_cwd_value, terminal_set_host_password,
terminal_set_encoding,
terminal_set_key_passphrase,
terminal_set_last_shell, terminal_test_shell, terminal_write,
// SFTP 文件管理(P1
terminal_sftp_close, terminal_sftp_delete, terminal_sftp_download, terminal_sftp_is_open,
terminal_sftp_list, terminal_sftp_mkdir, terminal_sftp_open, terminal_sftp_parent,
terminal_sftp_read_link, terminal_sftp_rename, terminal_sftp_upload,
// 命令片段(P1
terminal_delete_snippet, terminal_list_snippets, terminal_render_snippet,
terminal_restore_default_snippets, terminal_run_snippet, terminal_save_snippet,
// 命令历史(P1
terminal_history_clear, terminal_history_delete, terminal_history_query,
terminal_history_run, terminal_history_sources, terminal_history_toggle_favorite,
// 端口转发(P2
terminal_add_forward, terminal_list_forwards, terminal_remove_forward,
// 会话日志(P2
terminal_log_path, terminal_toggle_logging,
// 主机配置同步(P2
terminal_export_hosts, terminal_import_hosts,
// 会话模板(P2
terminal_delete_template, terminal_save_template,
// AI 命令助手(P2
terminal_ai_engines, terminal_ai_suggest,
};
use terminal::TerminalManager;
use translate::{
translate_abort, translate_apply_shortcuts, translate_copy_text, translate_engine_delete,
translate_engine_models, translate_engine_save, translate_engine_test_config,
@@ -208,6 +249,34 @@ fn export_bindings() {
translate_history_list, translate_history_delete, translate_history_clear,
translate_history_set_favorited,
translate_stream_start, translate_abort, translate_paste_back,
// terminal4139 业务 + key_public / new_host_id 两个辅助)
terminal_get_settings, terminal_save_settings, terminal_save_appearance,
terminal_save_layout, terminal_save_selection, terminal_save_security,
terminal_save_shortcuts,
terminal_list_shells, terminal_refresh_shells, terminal_save_shell,
terminal_delete_shell, terminal_set_last_shell, terminal_test_shell,
terminal_default_cwd,
terminal_open_local, terminal_open_ssh, terminal_list_sessions,
terminal_close_session, terminal_write, terminal_resize, terminal_rename_session,
terminal_detach_session, terminal_attach_session, terminal_session_cwd,
terminal_send_key, terminal_clear_session, terminal_session_alive,
terminal_set_encoding,
terminal_list_hosts, terminal_save_host, terminal_delete_host,
terminal_set_host_password, terminal_import_ssh_config,
terminal_list_keys, terminal_generate_key, terminal_import_key,
terminal_delete_key, terminal_rename_key, terminal_set_key_passphrase,
terminal_key_public, terminal_new_host_id,
terminal_list_known_hosts, terminal_forget_host, terminal_clear_known_hosts,
terminal_export_known_hosts, terminal_import_known_hosts,
terminal_confirm_host_key,
// 命令历史(6 个)
//
// 注意:这 6 个命令**必须与 `run()` 里那份 `collect_commands!` 同时登记**。
// 只登记其中一处不会报错:漏了这里 = 运行时能调但 `bindings.ts` 里没有类型;
// 漏了那边 = 有类型但调用失败。两种都是「编译/启动全绿但功能静默不可用」。
terminal_history_query, terminal_history_sources,
terminal_history_toggle_favorite, terminal_history_delete,
terminal_history_clear, terminal_history_run,
])
.export(Typescript::default(), "../src/lib/bindings.ts")
.expect("failed to export bindings");
@@ -473,7 +542,100 @@ pub fn run() {
translate_history_set_favorited,
translate_stream_start,
translate_abort,
translate_paste_back
translate_paste_back,
terminal_get_settings,
terminal_save_settings,
terminal_save_appearance,
terminal_save_layout,
terminal_save_selection,
terminal_save_security,
terminal_save_shortcuts,
terminal_list_shells,
terminal_refresh_shells,
terminal_save_shell,
terminal_delete_shell,
terminal_set_last_shell,
terminal_test_shell,
terminal_default_cwd,
terminal_open_local,
terminal_open_ssh,
terminal_list_sessions,
terminal_close_session,
terminal_write,
terminal_resize,
terminal_rename_session,
terminal_detach_session,
terminal_attach_session,
terminal_session_cwd,
terminal_set_encoding,
terminal_send_key,
terminal_clear_session,
terminal_session_alive,
terminal_list_hosts,
terminal_save_host,
terminal_delete_host,
terminal_set_host_password,
terminal_import_ssh_config,
terminal_list_keys,
terminal_generate_key,
terminal_import_key,
terminal_delete_key,
terminal_rename_key,
terminal_set_key_passphrase,
terminal_key_public,
terminal_new_host_id,
terminal_list_known_hosts,
terminal_forget_host,
terminal_clear_known_hosts,
terminal_export_known_hosts,
terminal_import_known_hosts,
terminal_confirm_host_key,
// SFTP 文件管理(P1
terminal_sftp_is_open,
terminal_sftp_open,
terminal_sftp_close,
terminal_sftp_list,
terminal_sftp_parent,
terminal_sftp_read_link,
terminal_sftp_mkdir,
terminal_sftp_delete,
terminal_sftp_rename,
terminal_sftp_upload,
terminal_sftp_download,
terminal_session_cwd_value,
// 本地文件操作(SFTP 面板的「打开 / 在资源管理器中显示」)
terminal_open_local_path,
terminal_reveal_local_path,
// 命令片段(P1
terminal_list_snippets,
terminal_save_snippet,
terminal_delete_snippet,
terminal_render_snippet,
terminal_run_snippet,
terminal_restore_default_snippets,
// 命令历史(P1
terminal_history_query,
terminal_history_sources,
terminal_history_toggle_favorite,
terminal_history_delete,
terminal_history_clear,
terminal_history_run,
// 端口转发(P2
terminal_add_forward,
terminal_list_forwards,
terminal_remove_forward,
// 会话日志(P2
terminal_log_path,
terminal_toggle_logging,
// 主机配置同步(P2
terminal_export_hosts,
terminal_import_hosts,
// 会话模板(P2
terminal_delete_template,
terminal_save_template,
// AI 命令助手(P2
terminal_ai_engines,
terminal_ai_suggest
])
.setup(setup::init)
.on_window_event(|window, event| {
@@ -515,6 +677,12 @@ pub fn run() {
// 停止音乐桥接进程(kill 快速返回,wait 在后台线程完成)
music.cleanup_on_exit();
}
if let Some(term) = app.try_state::<TerminalManager>() {
// 关闭全部终端会话。**不等待**ConPTY 的 ClosePseudoConsole 会
// 阻塞到所有句柄关闭,退出路径上等待会卡死(会话侧已把关闭动作
// 放进后台线程,进程终止时 OS 回收剩余资源)。
term.cleanup_on_exit();
}
if let Some(clip) = app.try_state::<ClipboardManager>() {
clip.stop();
}
+15
View File
@@ -21,6 +21,7 @@ use crate::monitor_kernel::{MonitorKernel, check_and_relaunch_if_needed};
use crate::music::MusicManager;
use crate::network_monitor::NetworkMonitor;
use crate::process_manager::{ProcessManager, start_monitoring_thread};
use crate::terminal::TerminalManager;
use crate::translate::TranslateManager;
/// 应用启动初始化入口(setup 闭包调用)。
@@ -72,6 +73,20 @@ pub fn init(app: &mut App<Wry>) -> Result<(), Box<dyn std::error::Error>> {
// 失败只记日志(快捷键被占用不该阻断启动)。
crate::translate::init_on_launch(app.handle());
// ===== 终端模块:TerminalManager =====
// 仅注册状态 + 做一次 Shell 探测,**不建立任何 SSH 连接**
// (沿用 translate 的姿态:启动阶段不发网络请求,会话只在用户主动打开时创建)。
let terminal = TerminalManager::new(app_data_dir.clone());
// 初始化 known_hosts 存储(主机密钥信任库,非机密,明文 JSON)
crate::terminal::ssh::hostkey::init(terminal.root().join("known_hosts.json"));
app.manage(terminal);
// Shell 探测 + 清理上次运行遗留的 hook 脚本
if let Ok(t) = crate::terminal::manager(app.handle()) {
t.init_on_launch(app.handle());
} else {
crate::logger::log_warn("terminal", "终端模块初始化异常:State 未注册");
}
// 网速采样不依赖提权,应用启动即开始
let network_monitor = Arc::new(NetworkMonitor::new());
app.manage(network_monitor.clone());
+207
View File
@@ -0,0 +1,207 @@
//! AI 命令助手(P2)。
//!
//! 根据用户意图(+ 可选的终端上下文)生成可执行的命令建议。
//! **复用翻译模块的 AI 引擎配置**:引擎列表、Base URL、模型、密钥
//! (凭据管理器)全部来自 translate 的设置——用户只需配置一份 API。
//!
//! # 输出契约(与模型约定的 JSON)
//!
//! 模型被要求只输出 `[{"command":"...","description":"..."}]` 数组。
//! 但模型不完全可靠,解析器做了三层防御:
//! 1. 剥掉可能包裹的 Markdown 代码块标记(```json ... ```);
//! 2. 数组解析失败时尝试提取首个 `[...]` 子串再解析;
//! 3. 条目字段校验(command 非空),并截断到 5 条防止异常输出刷屏。
use serde::Serialize;
use specta::Type;
use crate::translate::chat_once;
use crate::translate::TranslateEngineConfig;
use crate::translate::TranslateSettings;
/// 可用于命令生成的引擎(kind = "ai" 且配置完整)。
#[derive(Debug, Clone, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct AiEngineOption {
pub id: String,
pub name: String,
pub model: String,
}
/// 一条命令建议。
#[derive(Debug, Clone, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct CommandSuggestion {
pub command: String,
pub description: String,
}
/// 系统提示词。
///
/// 输出契约写进 prompt 只是第一道防线;解析器(`parse_suggestions`
/// 才是真正的保证——两者都不假设模型 100% 遵守。
const SYSTEM_PROMPT: &str = r#"你是终端命令助手。根据用户的意图和(可选的)终端最近输出,给出可在 shell 中执行的命令建议。
严格规则:
1. 只输出一个 JSON 数组,格式为 [{"command":"命令","description":"说明"}],不要输出任何其他文字、不要使用 Markdown 代码块标记。
2. 给 1~3 条建议:第一条是最直接的做法,其余是备选方案或更安全的变体。
3. description 用简体中文,说明这条命令做什么;有风险的命令必须醒目标注风险。
4. 命令默认面向 POSIX shellbash)。仅当用户明确提到 Windows/PowerShell 时才用 PowerShell 语法。
5. 命令中的路径、用户名等参数保持通用;不要编造用户环境里不存在的变量值。"#;
/// 列出可用于命令生成的 AI 引擎(按翻译设置的优先级排序)。
pub fn ai_engine_options(settings: &TranslateSettings) -> Vec<AiEngineOption> {
let mut opts: Vec<AiEngineOption> = settings
.engines
.iter()
.filter(|e| e.kind == "ai" && e.enabled && !e.base_url.trim().is_empty())
.map(|e| AiEngineOption {
id: e.id.clone(),
name: e.name.clone(),
model: e.model.clone(),
})
.collect();
opts.sort_by_key(|o| {
settings
.engines
.iter()
.find(|e| e.id == o.id)
.map(|e| e.priority)
.unwrap_or(100)
});
opts
}
/// 生成命令建议。
///
/// `context` 是可选的终端最近输出/选中文本(前端从 xterm 缓冲取),
/// 帮助模型理解「接着上一步做什么」;为空则只看意图。
pub async fn suggest(
engine: &TranslateEngineConfig,
intent: &str,
context: &str,
) -> Result<Vec<CommandSuggestion>, String> {
if intent.trim().is_empty() {
return Err("请先描述你想做什么".to_string());
}
let mut user = format!("我的意图:{}", intent.trim());
if !context.trim().is_empty() {
// 上下文截断到 2 KB:太长的输出(cat 大文件)只会稀释意图,
// 且模型上下文窗口是按 token 计费的
let ctx: String = context.chars().take(2048).collect();
user.push_str(&format!("\n\n终端最近的输出(供参考):\n{ctx}"));
}
let raw = chat_once(engine, vec![("system", SYSTEM_PROMPT.to_string()), ("user", user)]).await?;
parse_suggestions(&raw)
}
/// 解析模型输出为建议列表(纯函数,单测覆盖)。
fn parse_suggestions(raw: &str) -> Result<Vec<CommandSuggestion>, String> {
let text = strip_code_fence(raw);
let parsed: Result<Vec<SuggestionRaw>, _> = serde_json::from_str(text);
let items = match parsed {
Ok(items) => items,
Err(_) => {
// 防御二:提取首个 [...] 子串(模型可能在 JSON 前后加了说明文字)
let start = text.find('[').ok_or_else(|| {
format!("模型未按约定输出 JSON。原始内容:{}", text.chars().take(300).collect::<String>())
})?;
let end = text.rfind(']').ok_or_else(|| "模型输出缺少 JSON 数组结尾".to_string())?;
if end <= start {
return Err("模型输出的 JSON 数组为空或格式错误".to_string());
}
serde_json::from_str(&text[start..=end])
.map_err(|e| format!("模型输出的 JSON 解析失败: {e}"))?
}
};
let out: Vec<CommandSuggestion> = items
.into_iter()
.map(|s| CommandSuggestion {
command: s.command.trim().to_string(),
description: s.description.trim().to_string(),
})
.filter(|s| !s.command.is_empty())
.take(5)
.collect();
if out.is_empty() {
return Err("模型没有给出有效的命令建议".to_string());
}
Ok(out)
}
/// 剥掉 Markdown 代码块围栏(```json / ```),以及首尾空白。
fn strip_code_fence(raw: &str) -> &str {
let t = raw.trim();
let t = t.strip_prefix("```json").or_else(|| t.strip_prefix("```")).unwrap_or(t);
let t = t.strip_suffix("```").unwrap_or(t);
t.trim()
}
/// 模型输出的宽松条目结构(description 缺失时容忍为空串)。
#[derive(serde::Deserialize)]
struct SuggestionRaw {
command: String,
#[serde(default)]
description: String,
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn parses_plain_json_array() {
let raw = r#"[{"command":"ls -la","description":"列出文件"},{"command":"du -sh *","description":"查看各目录大小"}]"#;
let out = parse_suggestions(raw).unwrap();
assert_eq!(out.len(), 2);
assert_eq!(out[0].command, "ls -la");
assert_eq!(out[1].description, "查看各目录大小");
}
#[test]
fn parses_markdown_fenced_json() {
let raw = "```json\n[{\"command\":\"git status\",\"description\":\"查看状态\"}]\n```";
let out = parse_suggestions(raw).unwrap();
assert_eq!(out.len(), 1);
assert_eq!(out[0].command, "git status");
}
#[test]
fn parses_json_with_surrounding_prose() {
// 防御二:模型在 JSON 前后加了说明文字
let raw = "好的,以下是建议:\n[{\"command\":\"df -h\",\"description\":\"查看磁盘\"}]\n希望有帮助";
let out = parse_suggestions(raw).unwrap();
assert_eq!(out[0].command, "df -h");
}
#[test]
fn tolerates_missing_description_and_blank_commands() {
let raw = r#"[{"command":" ","description":"空命令应被过滤"},{"command":"pwd"}]"#;
let out = parse_suggestions(raw).unwrap();
assert_eq!(out.len(), 1);
assert_eq!(out[0].command, "pwd");
assert_eq!(out[0].description, "");
}
#[test]
fn caps_at_five_and_reports_garbage() {
let items: Vec<String> = (0..8)
.map(|i| format!(r#"{{"command":"cmd{i}","description":""}}"#))
.collect();
let out = parse_suggestions(&format!("[{}]", items.join(","))).unwrap();
assert_eq!(out.len(), 5, "超出 5 条的异常输出应被截断");
assert!(parse_suggestions("这不是 JSON").is_err());
}
#[test]
fn fence_without_json_marker_also_stripped() {
let raw = "```\n[{\"command\":\"top\",\"description\":\"进程\"}]\n```";
let out = parse_suggestions(raw).unwrap();
assert_eq!(out[0].command, "top");
}
}
+229
View File
@@ -0,0 +1,229 @@
//! 会话日志与审计(P2)。
//!
//! 把会话的**原始输出字节流**(含 ANSI 序列)追加写入磁盘文件。
//! 「审计」的另一半——命令文本与退出码——已由命令历史(OSC 133 落库)承担,
//! 本模块补的是命令历史覆盖不了的部分:完整屏幕内容、非命令输出、时序原貌。
//!
//! # 设计取舍
//!
//! - **记原始字节,不做任何转义清洗**:与 PuTTY 的会话日志同策略。
//! 清洗(剥 ANSI / 转可读文本)是**阅读时**的事,日志要保真——
//! 排查「界面显示为什么这样」恰恰需要原始序列。
//! - **只记输出不记输入**:PTY 会回显输入(本地与 SSH 皆然),
//! 输出流已包含用户敲了什么。更重要的是,关闭回显的密码输入
//! **不会**出现在输出流里——这保证了日志不会意外存下密码。
//! - **每批同步追加 + 即时 flush**:日志的价值在崩溃/断线后仍然完整,
//! 攒缓冲反而丢最关键的最后几行。单批最大 4 MiB(聚合缓冲上限),
//! 同步写无性能问题。
//! - **不持久化开关状态**:会话结束日志自然终止,下次会话默认关闭。
//! 自动记录所有会话涉及磁盘占用与隐私权衡(日志含屏幕上的一切),
//! 交给用户显式开启更稳妥。
//!
//! # 挂点
//!
//! 本地 ConPTY 与 SSH 两个后端的 `flush_output` 是所有输出的必经之路
//! (聚合 → 发前端事件),在此处写日志能保证**零遗漏**且与前端所见一致。
use std::collections::HashMap;
use std::io::Write;
use std::path::PathBuf;
use std::sync::{Mutex, OnceLock};
/// 注册表:会话 id → 日志条目。
static LOGS: OnceLock<Mutex<HashMap<String, LogEntry>>> = OnceLock::new();
struct LogEntry {
path: PathBuf,
file: std::fs::File,
/// 已写入字节数(预留:后续可做单文件上限保护)
#[allow(dead_code)]
written: u64,
}
fn registry() -> &'static Mutex<HashMap<String, LogEntry>> {
LOGS.get_or_init(|| Mutex::new(HashMap::new()))
}
/// 开启或关闭某会话的日志。
///
/// 开启:在 `dir` 下创建 `{session_id}_{时间戳}.log`,写入头部说明,
/// 返回 `Some(路径)`。已在记录中则幂等(返回现有路径,不重复建文件)。
/// 关闭:flush 并移除条目,返回 `None`。未在记录中时关闭是空操作。
pub fn toggle(
session_id: &str,
enabled: bool,
dir: &PathBuf,
header: &str,
) -> Result<Option<String>, String> {
let mut reg = registry().lock().unwrap_or_else(|e| e.into_inner());
if !enabled {
// flush 在 Dropentry 被 remove)时完成;显式 flush 一次更稳
if let Some(e) = reg.remove(session_id) {
let mut e = e;
let _ = e.file.flush();
}
return Ok(None);
}
if let Some(e) = reg.get(session_id) {
return Ok(Some(e.path.to_string_lossy().to_string()));
}
std::fs::create_dir_all(dir).map_err(|e| format!("创建日志目录失败: {e}"))?;
let stamp = chrono::Local::now().format("%Y%m%d_%H%M%S");
let path = dir.join(format!("{session_id}_{stamp}.log"));
let mut file = std::fs::OpenOptions::new()
.create(true)
.append(true)
.open(&path)
.map_err(|e| format!("创建日志文件失败({}: {e}", path.display()))?;
// 头部人可读:定位「这是谁的日志」不需要任何工具
writeln!(
file,
"# 终端会话日志 | {header} | 开始于 {}",
chrono::Local::now().format("%Y-%m-%d %H:%M:%S")
)
.map_err(|e| format!("写入日志头部失败: {e}"))?;
let path_str = path.to_string_lossy().to_string();
reg.insert(
session_id.to_string(),
LogEntry {
path,
file,
written: 0,
},
);
Ok(Some(path_str))
}
/// 会话是否正在记录。
pub fn is_logging(session_id: &str) -> bool {
registry()
.lock()
.unwrap_or_else(|e| e.into_inner())
.contains_key(session_id)
}
/// 当前日志文件路径(未记录时为 `None`)。
pub fn path_of(session_id: &str) -> Option<String> {
registry()
.lock()
.unwrap_or_else(|e| e.into_inner())
.get(session_id)
.map(|e| e.path.to_string_lossy().to_string())
}
/// 追加一批输出(热路径:未开启时只付一次哈希查表的钱)。
pub fn write(session_id: &str, bytes: &[u8]) {
if bytes.is_empty() {
return;
}
let mut reg = registry().lock().unwrap_or_else(|e| e.into_inner());
let Some(entry) = reg.get_mut(session_id) else {
return;
};
if entry.file.write_all(bytes).is_ok() {
entry.written += bytes.len() as u64;
}
// 单条写入失败不中断会话:日志是尽力而为的旁路,不能反过来影响终端 I/O
let _ = entry.file.flush();
}
/// 会话关闭时的清理:flush 并移除条目。幂等。
pub fn cleanup(session_id: &str) {
if let Some(mut e) = registry()
.lock()
.unwrap_or_else(|x| x.into_inner())
.remove(session_id)
{
let _ = e.file.flush();
}
}
#[cfg(test)]
mod tests {
use super::*;
fn temp_dir(tag: &str) -> PathBuf {
let d = std::env::temp_dir().join(format!(
"thing-audit-test-{tag}-{}",
std::process::id()
));
let _ = std::fs::remove_dir_all(&d);
d
}
/// 每条测试用独立会话 id,避免注册表(全局静态)在测试间串扰
fn sid(tag: &str) -> String {
format!("{tag}-{}", std::process::id())
}
#[test]
fn toggle_write_and_stop_roundtrip() {
let id = sid("roundtrip");
let dir = temp_dir("roundtrip");
// 开启:返回路径,头部已写入
let path = toggle(&id, true, &dir, "测试会话 ops@example").unwrap().unwrap();
assert!(is_logging(&id));
assert_eq!(path_of(&id).unwrap(), path);
assert!(path.contains(&id));
// 写入:文件里能找到原始字节与头部
write(&id, b"hello \x1b[31mred\x1b[0m\n");
let content = std::fs::read(&path).unwrap();
let text = String::from_utf8_lossy(&content);
assert!(text.contains("# 终端会话日志"), "头部缺失");
assert!(text.contains("ops@example"), "头部信息缺失");
assert!(content.windows(5).any(|w| w == b"\x1b[31m"), "原始 ANSI 序列应原样保留");
assert!(text.contains("hello "));
// 关闭:条目移除,文件保留在磁盘上
assert!(toggle(&id, false, &dir, "").unwrap().is_none());
assert!(!is_logging(&id));
assert!(path_of(&id).is_none());
assert!(std::path::Path::new(&path).exists(), "关闭后日志文件应保留");
let _ = std::fs::remove_dir_all(&dir);
}
#[test]
fn write_without_log_is_noop() {
let id = sid("noop");
// 未开启时写入不应 panic、不应创建任何文件
write(&id, b"ignored");
assert!(!is_logging(&id));
}
#[test]
fn toggle_on_twice_is_idempotent() {
let id = sid("idempotent");
let dir = temp_dir("idempotent");
let p1 = toggle(&id, true, &dir, "a").unwrap().unwrap();
let p2 = toggle(&id, true, &dir, "b").unwrap().unwrap();
assert_eq!(p1, p2, "重复开启应返回同一路径而不是新建文件");
cleanup(&id);
let _ = std::fs::remove_dir_all(&dir);
}
#[test]
fn cleanup_and_off_when_not_logging_are_safe() {
let id = sid("safe");
cleanup(&id); // 未开启时清理是空操作
assert!(toggle(&id, false, &temp_dir("safe"), "").unwrap().is_none());
}
#[test]
fn disabled_log_file_keeps_bytes_after_cleanup() {
let id = sid("persist");
let dir = temp_dir("persist");
let path = toggle(&id, true, &dir, "h").unwrap().unwrap();
write(&id, b"line1\n");
write(&id, b"line2\n");
cleanup(&id); // 等价于会话关闭路径
let text = std::fs::read_to_string(&path).unwrap();
assert!(text.contains("line1") && text.contains("line2"), "cleanup 后内容应完整落盘");
let _ = std::fs::remove_dir_all(&dir);
}
}
File diff suppressed because it is too large Load Diff
+170
View File
@@ -0,0 +1,170 @@
//! 终端字符编码转换。
//!
//! # 为什么需要这个模块
//!
//! 终端输出在 SSH 场景下**不保证是 UTF-8**。国内的存量服务器(CentOS 6/7 时代装机、
//! 未改 `LANG`)默认 `zh_CN.GBK``ls` 一个中文文件名就会吐出 GBK 字节。
//! 若按 UTF-8 解码,得到的是 `测试` 这类不可逆的乱码——而且因为前端拿到的
//! 是字符串,原始字节已经丢了,用户除了改服务器配置别无办法。
//!
//! 因此设计上做了两件事:
//! 1. **Rust 侧始终以字节流发往前端**(base64),不在这里转 String
//! 2. 本模块只在**需要把字节解释成文本**的地方使用(当前是「标题」与
//! 「cwd」这两处从 OSC 序列解析出的字段,它们是给 UI 直接显示/使用的)。
//!
//! 终端画面本身的编码转换放在前端做(xterm 支持自定义 `write` 解码),
//! 因为那里才能拿到「用户当前是否切了编码」这一运行时状态。
//!
//! # 为什么不用 iconv
//!
//! `iconv` 绑定需要 C 工具链与系统库;`encoding_rs` 是纯 RustFirefox 的
//! 实现抽出),且它按 WHATWG Encoding 标准处理 GBK 的**单双字节混合**与
//! 非法序列替换,与浏览器行为一致——这在终端场景下很重要,因为服务端常会
//! 混发半截多字节字符。
/// 把指定编码的字节解码为 UTF-8 字符串。
///
/// 未知编码名一律按 UTF-8 处理(并做有损解码):宁可显示替换字符,
/// 也不要因为一个拼错的编码名让整个会话不可用。
pub fn decode(bytes: &[u8], encoding: &str) -> String {
let enc = lookup(encoding);
match enc {
// UTF-8 走 `from_utf8_lossy`:它比 encoding_rs 的 UTF-8 解码器更快,
// 且对非法序列同样产出 U+FFFD(行为一致)。
Encoding::Utf8 | Encoding::Fallback => String::from_utf8_lossy(bytes).to_string(),
Encoding::Other(e) => {
let (cow, _, _) = e.decode(bytes);
cow.into_owned()
}
}
}
/// 把 UTF-8 字符串编码为目标编码的字节。
///
/// 用于「用户键入的内容发往远端」:若服务器是 GBK,输入的中文也必须以 GBK 发出,
/// 否则远端会显示乱码(甚至把半个字符吃掉导致后续命令错位)。
pub fn encode(text: &str, encoding: &str) -> Vec<u8> {
match lookup(encoding) {
Encoding::Utf8 | Encoding::Fallback => text.as_bytes().to_vec(),
Encoding::Other(e) => {
let (cow, _, _) = e.encode(text);
cow.into_owned()
}
}
}
/// 编码名是否被识别(供命令层做输入校验与 UI 提示)。
pub fn is_supported(encoding: &str) -> bool {
!matches!(lookup(encoding), Encoding::Fallback)
}
/// 归一化编码名到标准写法(供 UI 显示与去重比较)。
///
/// 输入容忍 `gbk` / `GBK` / `gb18030` / `cp936` / `utf8` 等常见写法。
pub fn normalize(encoding: &str) -> String {
let e = encoding.trim().to_ascii_lowercase();
match e.as_str() {
"" => "utf-8".to_string(),
"utf8" | "utf-8" | "utf_8" => "utf-8".to_string(),
"gbk" | "cp936" | "ms936" | "gb2312" | "gb_2312" => "gbk".to_string(),
"gb18030" => "gb18030".to_string(),
"big5" | "big-5" | "cp950" => "big5".to_string(),
"shift_jis" | "shift-jis" | "sjis" | "cp932" => "shift_jis".to_string(),
"euc-kr" | "euckr" | "cp949" => "euc-kr".to_string(),
"latin1" | "iso-8859-1" => "latin1".to_string(),
other => other.to_string(),
}
}
/// 前端设置页可选的编码列表(值与 `normalize` 的输出一致)。
///
/// 只列终端场景真实会遇到的:中文(GBK/GB18030)、港台(Big5)、
/// 日韩(Shift_JIS/EUC-KR)。ISO-8859-1 保留给嵌入式设备(它们的 busybox
/// 经常只有 C locale)。
pub const SUPPORTED: &[&str] = &[
"utf-8",
"gbk",
"gb18030",
"big5",
"shift_jis",
"euc-kr",
"latin1",
];
enum Encoding {
Utf8,
Other(&'static encoding_rs::Encoding),
/// 未识别的编码名(回退到 UTF-8 语义,但 `is_supported` 会报 false
Fallback,
}
fn lookup(encoding: &str) -> Encoding {
let e = normalize(encoding);
if e == "utf-8" {
return Encoding::Utf8;
}
match encoding_rs::Encoding::for_label(e.as_bytes()) {
// UTF-8 通过 label 也能查到,但我们要走更快的 from_utf8_lossy 分支
Some(enc) if enc == encoding_rs::UTF_8 => Encoding::Utf8,
Some(enc) => Encoding::Other(enc),
None => Encoding::Fallback,
}
}
// ===== 测试 =====
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn utf8_roundtrip() {
let s = "测试目录 /tmp";
assert_eq!(decode(&encode(s, "utf-8"), "utf-8"), s);
}
#[test]
fn gbk_roundtrip() {
let s = "测试";
let bytes = encode(s, "gbk");
// GBK 下「测试」是 4 字节(每字 2 字节),而 UTF-8 是 6 字节。
// 断言长度而非魔法数字,是为了让这条测试同时验证「确实用了 GBK」。
assert_eq!(bytes.len(), 4, "GBK 编码「测试」应为 4 字节");
assert_eq!(decode(&bytes, "gbk"), s);
}
#[test]
fn gbk_bytes_are_mojibake_under_utf8() {
// 反向验证:GBK 字节按 UTF-8 解读会失真。这正是前端必须知道
// 会话编码的原因(也是本模块存在的理由)。
let bytes = encode("测试", "gbk");
let as_utf8 = String::from_utf8_lossy(&bytes).to_string();
assert_ne!(as_utf8, "测试");
}
#[test]
fn alias_normalization() {
assert_eq!(normalize("GBK"), "gbk");
assert_eq!(normalize("cp936"), "gbk");
assert_eq!(normalize("utf8"), "utf-8");
assert_eq!(normalize(""), "utf-8");
assert_eq!(normalize(" UTF-8 "), "utf-8");
}
#[test]
fn all_supported_labels_resolve() {
for name in SUPPORTED {
assert!(is_supported(name), "{name} 应被识别");
}
assert!(!is_supported("not-a-real-encoding"));
}
#[test]
fn invalid_bytes_do_not_panic() {
// 终端输出经常在半截多字节字符处被切断,解码必须容错而不是 panic
let broken = [0xB2u8, 0xE2]; // GBK「测」的前 2 字节(完整),再截断一个
let _ = decode(&broken, "gbk");
let _ = decode(&[0xFF, 0xFE, 0xFD], "utf-8");
let _ = decode(&[0xC0], "gb18030");
}
}
+92
View File
@@ -0,0 +1,92 @@
//! 终端模块 Tauri 事件定义与负载类型。
//!
//! 事件名常量集中在 `crate::constants::events`,这里只放负载结构与便捷发射函数。
//! 命名口径与既有模块一致:kebab-case、`terminal-` 前缀。
use serde::Serialize;
use specta::Type;
use super::session::SessionId;
/// 事件名再导出,让两个后端可以写 `events::TERMINAL_OUTPUT` 而不必回退两层路径。
///
/// `allow(unused_imports)` 的原因:这是**模块对外的常量出口**,六个事件名成组
/// 定义、成组暴露,便于调用方按同一路径取用;个别常量在当前代码路径上暂未被
/// 本模块自身引用(如 `TERMINAL_CONFIRM_CLOSE` 由窗口层发射、
/// `TERMINAL_CWD` 由 shell hook 发射),但都属于稳定契约,不应按使用情况逐个删改。
#[allow(unused_imports)]
pub use crate::constants::events::{
TERMINAL_CONFIRM_CLOSE, TERMINAL_CWD, TERMINAL_EXIT, TERMINAL_HOST_KEY_PROMPT,
TERMINAL_OUTPUT, TERMINAL_STATE, TERMINAL_TRANSFER_PROGRESS,
};
/// 发射 SFTP 传输进度事件。
///
/// 单独一个函数而不是在命令层直接 `emit`:事件名常量与负载类型分属两个模块,
/// 集中在这里能让「事件名 ↔ 负载类型」的对应关系一眼可见(也是排查
/// 「前端收到的字段对不上」这类问题的第一落点)。
pub fn emit_transfer(app: &tauri::AppHandle, payload: &super::ssh::sftp::TransferProgress) {
use tauri::Emitter;
let _ = app.emit(TERMINAL_TRANSFER_PROGRESS, payload);
}
/// 会话输出批次(**发往前端**的形态)。
///
/// 字段与内部聚合缓冲一一对应但单独定义,是为了让「前端契约」与
/// 「内部分批策略」可以独立演进(例如未来内部改成分块再组装,前端不必感知)。
#[derive(Debug, Clone, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct OutputPayload {
pub session_id: SessionId,
/// base64 编码的原始输出字节。
///
/// **为什么用 base64 而不是直接给字符串**:终端输出可能是 GBK 等非 UTF-8
/// 编码(老服务器常见),若在 Rust 侧转 String 就永久丢失了原始字节,
/// 前端再做后处理也无从下手。用 base64 保持字节完整性,由前端按会话编码解码。
pub data: String,
/// 全局单调批次序号,前端据此检测丢包。
pub seq: u64,
}
/// 会话结束。
#[derive(Debug, Clone, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct ExitPayload {
pub session_id: SessionId,
/// 退出码。本地会话通常有;SSH 通道关闭时多为 None。
pub exit_code: Option<i32>,
/// 结束原因:"eof" | "process-exit" | "killed" | "disconnected" | "error"
pub reason: Option<String>,
}
/// 会话工作目录变化(由 OSC 7 hook 上报)。
#[derive(Debug, Clone, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct CwdPayload {
pub session_id: SessionId,
pub cwd: String,
}
/// 状态变更事件直接复用 [`SessionInfo`] 作为负载——
/// 前端拿到它就能刷新侧栏与标签,不必再发一次查询。
/// SSH 主机密钥需要用户确认(首次连接或指纹变更)。
///
/// 这是一个**阻塞性的交互请求**:Rust 侧握手暂停,等前端调
/// `terminal_confirm_host_key` 回传决定。
#[derive(Debug, Clone, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct HostKeyPromptPayload {
pub session_id: SessionId,
pub host: String,
pub port: u16,
/// 密钥算法(如 "ssh-ed25519" / "ssh-rsa"
pub key_type: String,
/// 服务端出示的指纹(SHA256OpenSSH 展示格式)
pub fingerprint: String,
/// 本次是「首次见到」还是「与记录不符」。
/// 后者是**高危信号**,前端必须以红色阻断式 UI 呈现。
pub reason: String,
/// 与记录不符时,给出先前记录的指纹以便用户对比
pub previous_fingerprint: Option<String>,
}
+857
View File
@@ -0,0 +1,857 @@
//! 终端命令历史(SQLite)。
//!
//! 存储约定:`{app_data_dir}/terminal/history.db`,范式与 `translate/history.rs` 一致
//! WAL、`PRAGMA user_version` 作结构版本、FTS5 trigram 索引)。
//!
//! # 与翻译历史的关键差异:为什么不做整库重建式迁移
//!
//! 翻译历史用了「版本不等就 DROP 重建」的简化策略,理由是「历史属于可丢弃数据」。
//! 终端历史**不能照抄**:翻译历史里一条记录是「一段译文」,重建丢的是可以重翻的东西;
//! 终端历史里一条记录是**用户敲过的命令**,包含服务器地址、路径、以及偶尔泄露在
//! 命令行里的凭据。用户可能恰恰是为了翻查这些才留着它。
//!
//! 因此这里从一开始就写**增量迁移**(`migrate`),不做 DROP。
//!
//! # 为什么存两列(command + cwd
//!
//! 同一条命令在 `/var/log` 下和在 `~` 下含义完全不同(`ls`、`make`、`git status`
//! 都是典型例子)。只存命令会让「我上次在哪个目录跑的那条命令」无从追查,
//! 而 `cwd` 又是一次 OSC 7 就能免费拿到的信息。
//!
//! # 去重键的选择
//!
//! 用 `(command, cwd, host_id)` 而不是 `(command, host_id)`:在 A 目录跑过的命令,
//! 换到 B 目录再跑应当各留一条 —— 它们对用户是两个不同的事实。
//! 重复执行同一条命令(同一目录)只更新 `ts` 与 `count`,避免历史被刷屏。
use std::path::Path;
use std::sync::Mutex;
use rusqlite::{params, Connection};
use serde::{Deserialize, Serialize};
use specta::Type;
/// 库结构版本(与 `PRAGMA user_version` 对应)。
///
/// **递增时必须同步在 `migrate` 里加分支**,否则旧库会因缺少新列而在查询时报
/// 「no such column」,而报错点在读取路径上、远离真正的成因。
const SCHEMA_VERSION: i64 = 1;
/// 默认保留条数。超出后在写入路径上淘汰最旧的**非收藏**记录。
const DEFAULT_MAX_ENTRIES: i64 = 5000;
/// 走 FTS 索引所需的最小字符数。
///
/// trigram 分词器把文本切成连续 3 字符的 n-gram,长度小于 3 的查询词
/// **不会报错、只会静默返回空**。而终端里两字符的命令恰恰是最常见的
/// `ls`、`cd`、`rm`),所以短词回退到 `LIKE` 前缀匹配。
const FTS_MIN_CHARS: usize = 3;
/// 一条命令历史。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct CommandHistoryItem {
pub id: i64,
/// 毫秒时间戳(最后一次执行)
pub ts: i64,
pub command: String,
/// 执行时的工作目录(可能为空 —— OSC 7 未被远端 shell 上报时)
pub cwd: String,
/// 会话来源:本地 shell 的 id,或 SSH 主机的 id。
/// 为空串表示「来源未知」(如手工录入的历史)。
pub host_id: String,
/// 显示用的来源名(「PowerShell」/「生产服务器」),随记录一起存。
///
/// # 为什么冗余存名字而不只存 id
///
/// 主机被删除后,若只有 id,历史列表里那一列会变成一串无意义的 hash。
/// 存名字的代价是「主机改名后历史里的旧名字不会更新」—— 这里选择
/// **保留历史当时的名字**,因为「我在那台现在叫 X 的机器上跑过什么」
/// 本来就是一个有时间性的问题。
pub host_name: String,
/// 是否为 SSH 会话
pub ssh: bool,
/// 累计执行次数(同一命令在同一目录重复执行时累加)
pub count: i64,
/// 用户收藏(收藏项不参与容量淘汰)
pub favorited: bool,
/// 退出码。`None` 表示未捕获(如会话结束时命令仍在运行)
pub exit_code: Option<i32>,
}
/// 查询参数。
///
/// 用结构体而不是一长串位置参数:命令层要把前端 payload 原样转发,
/// 而 5 个 `Option<String>` 的位置参数在调用点极易顺序写错,且编译器
/// 无法发现(全是同类型)。
#[derive(Debug, Clone, Default, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct HistoryQuery {
/// 关键词(对 command 做匹配;空则不过滤)
pub keyword: String,
/// 只看某个来源(host_id;空则全部)
pub host_id: String,
/// 只看收藏
pub favorited_only: bool,
/// 分页偏移
pub offset: i64,
/// 分页大小
pub limit: i64,
}
impl HistoryQuery {
/// 归一化:`limit` 兜底并设上限,`offset` 不为负。
///
/// 上限 500:前端分页步长是 50~100,500 已远超一屏能展示的量,
/// 再大只会让 IPC 序列化成为瓶颈。
fn normalized(mut self) -> Self {
if self.limit <= 0 {
self.limit = 100;
}
if self.limit > 500 {
self.limit = 500;
}
if self.offset < 0 {
self.offset = 0;
}
self
}
}
/// 一次查询的结果(含总数,供前端显示「共 N 条」)。
///
/// # 为什么叫 `TerminalHistoryPage` 而不是 `HistoryPage`
///
/// `tauri-specta` 给 `Type` 派生的类型注册表是**全局按类型名索引**的,重名会让
/// `export_bindings()` 直接 panic`Detected multiple types with the same name`)。
/// `clipboard::commands::HistoryPage``items: Vec<ClipboardItem>`)已占用这个名字。
///
/// specta 2.0.0-rc.25 **没有**给 struct 提供重命名手段 —— `#[specta(rename = ...)]`
/// 只对**函数**宏生效(`specta-macros/src/specta.rs` 的 `parse_name_attrs`);
/// derive 路径下导出名直接取自 Rust 标识符
/// `specta-macros/src/type/mod.rs``let name = unraw_raw_ident(&format_ident!("{}", raw_ident.to_string()))`),
/// 而 `ContainerAttr` 只认 `crate` / `type` / `inline` / `remote` / `collect` /
/// `skip_attr` / `transparent`,且 `reject_unknown_specta_attrs` 会让未知属性直接编译失败。
/// 因此**改名是唯一可行解**。
#[derive(Debug, Clone, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct TerminalHistoryPage {
pub items: Vec<CommandHistoryItem>,
/// 满足筛选条件的总条数(**不受 limit/offset 影响**
pub total: i64,
}
/// 历史来源(供前端做筛选下拉)。
///
/// 单独定义而不是用元组:元组序列化成 JSON 会变成数组,前端得靠下标取值
/// `s[0]`/`s[1]`/`s[2]`),改一次顺序就静默错位。具名字段让前后端
/// 各自独立演进而不怕顺序变动。
#[derive(Debug, Clone, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct HistorySource {
pub host_id: String,
pub host_name: String,
/// 该来源的命令条数
pub count: i64,
pub ssh: bool,
}
pub struct History {
conn: Mutex<Connection>,
}
/// 建表语句。
///
/// `v1` 即当前结构。后续版本只追加 `ALTER TABLE`,不重建(见模块头说明)。
fn schema_v1() -> &'static str {
"
CREATE TABLE IF NOT EXISTS cmd_history (
id INTEGER PRIMARY KEY,
ts INTEGER NOT NULL,
command TEXT NOT NULL,
cwd TEXT NOT NULL DEFAULT '',
host_id TEXT NOT NULL DEFAULT '',
host_name TEXT NOT NULL DEFAULT '',
ssh INTEGER NOT NULL DEFAULT 0,
count INTEGER NOT NULL DEFAULT 1,
favorited INTEGER NOT NULL DEFAULT 0,
exit_code INTEGER,
UNIQUE(command, cwd, host_id)
);
CREATE INDEX IF NOT EXISTS idx_cmd_hist_ts ON cmd_history(ts DESC);
CREATE INDEX IF NOT EXISTS idx_cmd_hist_host ON cmd_history(host_id, ts DESC);
CREATE INDEX IF NOT EXISTS idx_cmd_hist_fav ON cmd_history(favorited, ts DESC);
-- 外部内容表:索引只存倒排表,正文仍只在 cmd_history 里一份。
-- 代价是不会自动感知主表变化,必须靠下面三个触发器手动同步。
CREATE VIRTUAL TABLE IF NOT EXISTS cmd_history_fts USING fts5(
command,
content='cmd_history', content_rowid='id',
tokenize='trigram'
);
CREATE TRIGGER IF NOT EXISTS cmd_hist_fts_ai AFTER INSERT ON cmd_history BEGIN
INSERT INTO cmd_history_fts(rowid, command) VALUES (new.id, new.command);
END;
CREATE TRIGGER IF NOT EXISTS cmd_hist_fts_ad AFTER DELETE ON cmd_history BEGIN
INSERT INTO cmd_history_fts(cmd_history_fts, rowid, command)
VALUES ('delete', old.id, old.command);
END;
CREATE TRIGGER IF NOT EXISTS cmd_hist_fts_au AFTER UPDATE ON cmd_history BEGIN
INSERT INTO cmd_history_fts(cmd_history_fts, rowid, command)
VALUES ('delete', old.id, old.command);
INSERT INTO cmd_history_fts(rowid, command) VALUES (new.id, new.command);
END;
"
}
/// 转义 FTS5 查询串。
///
/// FTS5 的 `MATCH` 语法把 `"` `*` `(` `)` `:` `^` `-` `+` 等当操作符。
/// 终端命令里这些字符**比比皆是**`grep -v foo`、`ls *.rs`、`git log --oneline`),
/// 不转义时会抛语法错误或产生完全意外的匹配。
///
/// 做法:整体包成双引号短语,并把内部的 `"` 转义为 `""`FTS5 的转义约定,
/// 与 SQL 的 `''` 同理)。包成短语后所有操作符都失去特殊含义,代价是不支持
/// 用户手写布尔表达式 —— 对「搜我敲过的命令」这个场景,字面量匹配正是所需。
fn fts_phrase(keyword: &str) -> String {
format!("\"{}\"", keyword.replace('"', "\"\""))
}
impl History {
pub fn new(dir: &Path) -> Result<Self, String> {
std::fs::create_dir_all(dir).map_err(|e| format!("创建终端目录失败: {e}"))?;
let conn =
Connection::open(dir.join("history.db")).map_err(|e| format!("打开历史库失败: {e}"))?;
conn.execute_batch("PRAGMA journal_mode = WAL;")
.map_err(|e| format!("初始化历史库失败: {e}"))?;
migrate(&conn)?;
Ok(Self {
conn: Mutex::new(conn),
})
}
fn conn(&self) -> std::sync::MutexGuard<'_, Connection> {
self.conn.lock().unwrap_or_else(|e| e.into_inner())
}
/// 记录一条命令(同 command+cwd+host 只累加计数并更新时间)。
///
/// # 过滤规则
///
/// - 空命令 / 纯空白:不记(回车空行不该进历史)
/// - 以空格开头:不记。这是 shell 的**惯例**`HISTCONTROL=ignorespace`),
/// 用户用它来避免把含密码的命令写进 `.bash_history`。我们若不遵守,
/// 等于把用户对系统历史的信任**从背后捅穿** —— 这条规则不是可选项。
pub fn record(
&self,
command: &str,
cwd: &str,
host_id: &str,
host_name: &str,
ssh: bool,
exit_code: Option<i32>,
) -> Result<(), String> {
let cmd = command.trim();
if cmd.is_empty() || command.starts_with(' ') {
return Ok(());
}
let now = chrono::Utc::now().timestamp_millis();
self.conn()
.execute(
"INSERT INTO cmd_history (ts, command, cwd, host_id, host_name, ssh, count,
favorited, exit_code)
VALUES (?1, ?2, ?3, ?4, ?5, ?6, 1, 0, ?7)
ON CONFLICT(command, cwd, host_id)
DO UPDATE SET ts = excluded.ts,
count = cmd_history.count + 1,
ssh = excluded.ssh,
host_name = excluded.host_name,
exit_code = excluded.exit_code",
params![now, cmd, cwd, host_id, host_name, ssh as i64, exit_code],
)
.map_err(|e| format!("写入命令历史失败: {e}"))?;
Ok(())
}
/// 分页查询。
pub fn query(&self, q: HistoryQuery) -> Result<TerminalHistoryPage, String> {
let q = q.normalized();
let conn = self.conn();
// 动态拼 WHERE。所有用户输入一律走 `params!` 占位符绑定,
// **不做字符串插值** —— 命令历史里出现 `'` 是家常便饭
// `awk '{print $1}'`),插值会直接语法错误甚至注入。
let mut wheres: Vec<String> = Vec::new();
let mut args: Vec<Box<dyn rusqlite::ToSql>> = Vec::new();
let keyword = q.keyword.trim();
if !keyword.is_empty() {
if keyword.chars().count() >= FTS_MIN_CHARS {
wheres.push(
"id IN (SELECT rowid FROM cmd_history_fts WHERE cmd_history_fts MATCH ?)"
.to_string(),
);
args.push(Box::new(fts_phrase(keyword)));
} else {
// 短词回退:trigram 索引里没有 2 字符以下的片段,走 FTS 只会
// 静默返回空。用 LIKE 做前缀匹配(`ls` 命中 `ls -la` 也命中 `lsof`)。
wheres.push("command LIKE ? ESCAPE '\\'".to_string());
args.push(Box::new(format!(
"{}%",
escape_like(keyword)
)));
}
}
if !q.host_id.trim().is_empty() {
wheres.push("host_id = ?".to_string());
args.push(Box::new(q.host_id.trim().to_string()));
}
if q.favorited_only {
wheres.push("favorited = 1".to_string());
}
let where_sql = if wheres.is_empty() {
String::new()
} else {
format!(" WHERE {}", wheres.join(" AND "))
};
// 总数单独查一次:`COUNT(*) OVER ()` 需要窗口函数支持(SQLite 3.25+
// bundled 版本满足),但把 total 与分页放在同一查询里会让「无结果时
// total 也拿不到」,而前端在无结果时同样需要显示「共 0 条」。分开查更直白。
let total: i64 = {
let sql = format!("SELECT COUNT(*) FROM cmd_history{where_sql}");
let refs: Vec<&dyn rusqlite::ToSql> = args.iter().map(|b| b.as_ref()).collect();
conn.query_row(&sql, refs.as_slice(), |r| r.get(0))
.map_err(|e| format!("统计命令历史失败: {e}"))?
};
// 排序:收藏优先 → 时间倒序。收藏优先放在 SQL 而非前端排序,
// 否则「翻到第 3 页」的语义会变成「在未排序的集合里翻页」,结果不稳定。
let sql = format!(
"SELECT id, ts, command, cwd, host_id, host_name, ssh, count, favorited, exit_code
FROM cmd_history{where_sql}
ORDER BY favorited DESC, ts DESC
LIMIT ? OFFSET ?"
);
let mut refs: Vec<&dyn rusqlite::ToSql> = args.iter().map(|b| b.as_ref()).collect();
let limit = q.limit;
let offset = q.offset;
refs.push(&limit);
refs.push(&offset);
let mut stmt = conn
.prepare(&sql)
.map_err(|e| format!("准备查询失败: {e}"))?;
let items = stmt
.query_map(refs.as_slice(), |row| {
Ok(CommandHistoryItem {
id: row.get(0)?,
ts: row.get(1)?,
command: row.get(2)?,
cwd: row.get(3)?,
host_id: row.get(4)?,
host_name: row.get(5)?,
ssh: row.get::<_, i64>(6)? != 0,
count: row.get(7)?,
favorited: row.get::<_, i64>(8)? != 0,
exit_code: row.get(9)?,
})
})
.map_err(|e| format!("查询命令历史失败: {e}"))?
.collect::<Result<Vec<_>, _>>()
.map_err(|e| format!("读取命令历史失败: {e}"))?;
Ok(TerminalHistoryPage { items, total })
}
/// 切换收藏。返回切换后的值。
pub fn toggle_favorite(&self, id: i64) -> Result<bool, String> {
let conn = self.conn();
let cur: i64 = conn
.query_row("SELECT favorited FROM cmd_history WHERE id = ?1", params![id], |r| {
r.get(0)
})
.map_err(|e| format!("找不到历史记录 {id}: {e}"))?;
let next = if cur == 0 { 1 } else { 0 };
conn.execute(
"UPDATE cmd_history SET favorited = ?1 WHERE id = ?2",
params![next, id],
)
.map_err(|e| format!("更新收藏状态失败: {e}"))?;
Ok(next != 0)
}
/// 删除单条。返回是否真的删掉了(`false` = 该 id 不存在)。
pub fn delete(&self, id: i64) -> Result<bool, String> {
let n = self
.conn()
.execute("DELETE FROM cmd_history WHERE id = ?1", params![id])
.map_err(|e| format!("删除历史记录失败: {e}"))?;
Ok(n > 0)
}
/// 清空。`keep_favorites` 为真时保留收藏项。
///
/// 返回删除条数,供前端提示「已清空 N 条」——只说「已清空」而不给数字,
/// 用户无法判断是否误删了收藏项之外的全部内容。
pub fn clear(&self, keep_favorites: bool) -> Result<i64, String> {
let conn = self.conn();
let n = if keep_favorites {
conn.execute("DELETE FROM cmd_history WHERE favorited = 0", [])
} else {
conn.execute("DELETE FROM cmd_history", [])
}
.map_err(|e| format!("清空历史失败: {e}"))?;
Ok(n as i64)
}
/// 淘汰超出容量上限的最旧非收藏记录。
///
/// 在写入路径末尾调用(而非定时任务):容量只会在写入时增长,
/// 挂一个定时器反而要处理「定时器与写入并发」的竞态。
///
/// 用 `id NOT IN (SELECT id ... LIMIT n)` 的子查询形式而不是 `OFFSET`:
/// 后者在超大偏移下要扫描全部前置行,而这里每写一条就跑一次,
/// 不能让单次写入的代价随库增大而线性上升。
pub fn prune(&self, max: i64) -> Result<i64, String> {
let max = if max <= 0 { DEFAULT_MAX_ENTRIES } else { max };
let n = self
.conn()
.execute(
"DELETE FROM cmd_history
WHERE favorited = 0 AND id NOT IN (
SELECT id FROM cmd_history WHERE favorited = 0
ORDER BY ts DESC LIMIT ?1
)",
params![max],
)
.map_err(|e| format!("淘汰历史失败: {e}"))?;
Ok(n as i64)
}
/// 全部来源(供前端做筛选下拉,避免前端自己聚合而漏掉已删除主机的历史)。
pub fn sources(&self) -> Result<Vec<HistorySource>, String> {
let conn = self.conn();
let mut stmt = conn
.prepare(
"SELECT host_id, host_name, COUNT(*) AS n,
MAX(CASE WHEN ssh THEN 1 ELSE 0 END) AS ssh
FROM cmd_history
WHERE host_id <> ''
GROUP BY host_id, host_name
ORDER BY n DESC",
)
.map_err(|e| format!("准备来源查询失败: {e}"))?;
let rows = stmt
.query_map([], |r| {
Ok(HistorySource {
host_id: r.get(0)?,
host_name: r.get(1)?,
count: r.get(2)?,
ssh: r.get::<_, i64>(3)? != 0,
})
})
.map_err(|e| format!("查询来源失败: {e}"))?
.collect::<Result<Vec<_>, _>>()
.map_err(|e| format!("读取来源失败: {e}"))?;
Ok(rows)
}
}
/// 转义 `LIKE` 模式里的通配符。
///
/// 调用方在 SQL 里写了 `ESCAPE '\'`,这里必须把 `\` `%` `_` 三个字符
/// 各自加反斜杠前缀。**`\` 必须最先替换** —— 否则后两步插入的反斜杠
/// 会被第三步再次转义,产生 `\\%` 这种把通配符当成字面量的错误结果。
fn escape_like(s: &str) -> String {
s.replace('\\', "\\\\")
.replace('%', "\\%")
.replace('_', "\\_")
}
/// 增量迁移。
///
/// 从 `user_version` 逐级升到 `SCHEMA_VERSION`。首次打开(version = 0
/// 直接建 v1 结构并把版本置为 1。
///
/// # 为什么不复用翻译历史的「版本不等就 DROP」
///
/// 见模块头说明:终端历史里是用户敲过的命令,可能包含服务器地址与路径,
/// 是可追溯的资产而非可丢弃的缓存。
fn migrate(conn: &Connection) -> Result<(), String> {
let mut version: i64 = conn
.query_row("PRAGMA user_version", [], |row| row.get(0))
.map_err(|e| format!("读取历史库版本失败: {e}"))?;
if version == 0 {
// 全新库(或来自更早的、没有版本号的实验版本)。
// 用 `CREATE TABLE IF NOT EXISTS` 保证对已有表幂等 ——
// 若库文件存在但 user_version 丢了,这里不会因表已存在而失败。
conn.execute_batch(schema_v1())
.map_err(|e| format!("初始化命令历史表失败: {e}"))?;
version = 1;
conn.execute_batch(&format!("PRAGMA user_version = {version};"))
.map_err(|e| format!("写入历史库版本失败: {e}"))?;
}
// 后续版本在此追加:
// if version == 1 {
// conn.execute_batch("ALTER TABLE cmd_history ADD COLUMN xxx TEXT NOT NULL DEFAULT '';")?;
// version = 2;
// conn.execute_batch(&format!("PRAGMA user_version = {version};"))?;
// }
if version < SCHEMA_VERSION {
// 走到这里说明有迁移分支被漏写了。**显式报错而不是静默继续** ——
// 静默继续会让「新加的列在运行时找不到」变成一个远离成因的报错。
return Err(format!(
"命令历史库版本 {version} 低于期望的 {SCHEMA_VERSION},但缺少对应的迁移步骤"
));
}
Ok(())
}
// ===== 后台 writer =====
/// 一条待落库的命令记录(读线程 → writer 线程的通道载荷)。
pub struct HistoryEntry {
pub command: String,
pub cwd: String,
pub host_id: String,
pub host_name: String,
pub ssh: bool,
pub exit_code: Option<i32>,
}
/// 攒批参数:到达任一阈值(条数 / 时间窗)就把积压写进 SQLite。
const WRITER_BATCH_MAX: usize = 64;
const WRITER_BATCH_WINDOW: std::time::Duration = std::time::Duration::from_millis(400);
/// 把积压的记录写进历史库。
///
/// 放成模块级函数(而非闭包):writer 循环的三个分支(满批 / 超时 / 断开)
/// 都要走到它,闭包会被借用检查卡住(循环里持有 `&mut batch`)。
fn flush_batch(app: &tauri::AppHandle, batch: &mut Vec<HistoryEntry>) {
use tauri::Manager as _;
if batch.is_empty() {
return;
}
let Some(mgr) = app.try_state::<crate::terminal::TerminalManager>() else {
// 应用正在退出(manager 已释放):丢掉这批,历史是辅助功能
batch.clear();
return;
};
let guard = match mgr.history() {
Ok(g) => g,
Err(e) => {
crate::logger::log_error("terminal", &format!("打开历史库失败(丢弃一批记录): {e}"));
batch.clear();
return;
}
};
let Some(h) = guard.as_ref() else {
batch.clear();
return;
};
for e in batch.drain(..) {
if let Err(err) = h.record(
&e.command,
&e.cwd,
&e.host_id,
&e.host_name,
e.ssh,
e.exit_code,
) {
crate::logger::log_error("terminal", &format!("写入命令历史失败(不影响会话): {err}"));
}
}
// 每批淘汰一次(而非每条):把 prune 的 DELETE 子查询从「每命令一次」
// 降为「每批一次」,这是此前输出热路径上最贵的一步。
if let Err(err) = h.prune(0) {
crate::logger::log_error("terminal", &format!("淘汰历史容量失败: {err}"));
}
}
/// 启动后台历史 writer,返回入队端。
///
/// # 为什么需要它(此前的形态是同步写)
///
/// `record_command` 位于**输出热路径**上(OSC 133 的 D 标记到达时,读线程/SSH
/// 读任务正在转发终端输出)。同步形态意味着:整份 settings 深拷贝 + SQLite
/// 写入 + prune 的 DELETE 子查询都发生在转发线程上,`cat` 大文件时每条命令
/// 都会让同一批输出多等一次磁盘 IO。
///
/// 改为通道 + 后台 writer 后,读线程只做一次 `mpsc::send`(非阻塞、无锁竞争)。
/// 落库延迟最多一个攒批窗口(400ms),对「翻历史」场景无感。
///
/// 退出语义:所有入队端 drop 后(`cleanup_on_exit` 会 drop manager 里的那份),
/// `recv` 返回 Err 且缓冲清空,writer 把剩余记录写完后自然退出。
pub fn spawn_writer(app: tauri::AppHandle) -> std::sync::mpsc::Sender<HistoryEntry> {
use std::sync::mpsc::{channel, RecvTimeoutError};
let (tx, rx) = channel::<HistoryEntry>();
std::thread::spawn(move || {
let mut batch: Vec<HistoryEntry> = Vec::new();
loop {
match rx.recv_timeout(WRITER_BATCH_WINDOW) {
Ok(e) => {
batch.push(e);
if batch.len() >= WRITER_BATCH_MAX {
flush_batch(&app, &mut batch);
}
}
Err(RecvTimeoutError::Timeout) => {
flush_batch(&app, &mut batch);
}
Err(RecvTimeoutError::Disconnected) => {
// 入队端全部关闭:写完剩余的,退出
flush_batch(&app, &mut batch);
break;
}
}
}
});
tx
}
#[cfg(test)]
mod tests {
use super::*;
/// 每个用例一个独立目录。
///
/// 沿用 `translate/history.rs` 的做法(`std::env::temp_dir()` + 进程号 + 序号),
/// 而不是引入 `tempdir` dev-dependency`History` 持有的连接在测试结束前不释放,
/// Windows 会拒绝删除仍被打开的文件,所以**本来就没法真正清理**。
/// 为一件做不到的事加一个依赖不划算。
fn open(tag: &str) -> History {
use std::sync::atomic::{AtomicUsize, Ordering};
static SEQ: AtomicUsize = AtomicUsize::new(0);
let n = SEQ.fetch_add(1, Ordering::Relaxed);
let dir = std::env::temp_dir().join(format!(
"thing-cmd-hist-test-{}-{tag}-{n}",
std::process::id()
));
let _ = std::fs::remove_dir_all(&dir);
History::new(&dir).expect("建库失败")
}
#[test]
fn record_and_query_roundtrip() {
let h = open("roundtrip");
h.record("ls -la", "/home/me", "h1", "服务器A", true, Some(0))
.unwrap();
h.record("git status", "/home/me", "h1", "服务器A", true, Some(0))
.unwrap();
let page = h.query(HistoryQuery::default()).unwrap();
assert_eq!(page.total, 2);
// 收藏优先 + 时间倒序:两条都不是收藏,按 ts 倒序 → 后插入的在前
assert_eq!(page.items[0].command, "git status");
}
#[test]
fn dedup_accumulates_count() {
let h = open("dedup");
h.record("make", "/proj", "h1", "A", true, Some(0)).unwrap();
h.record("make", "/proj", "h1", "A", true, Some(2)).unwrap();
let page = h.query(HistoryQuery::default()).unwrap();
assert_eq!(page.total, 1, "同 command+cwd+host 应复用同一行");
assert_eq!(page.items[0].count, 2);
assert_eq!(page.items[0].exit_code, Some(2), "退出码应为最后一次");
}
#[test]
fn same_command_different_cwd_is_separate() {
let h = open("cwd");
h.record("ls", "/a", "h1", "A", true, None).unwrap();
h.record("ls", "/b", "h1", "A", true, None).unwrap();
let page = h.query(HistoryQuery::default()).unwrap();
assert_eq!(page.total, 2, "不同目录下的同名命令是两条独立记录");
}
#[test]
fn leading_space_is_not_recorded() {
// shell 惯例:以空格开头的命令不进历史(HISTCONTROL=ignorespace)。
// 我们若不遵守,等于把用户对系统历史的信任从背后捅穿。
let h = open("leadspace");
h.record(" curl -u user:pass http://x", "/", "h1", "A", true, None)
.unwrap();
h.record("", "/", "h1", "A", true, None).unwrap();
h.record(" ", "/", "h1", "A", true, None).unwrap();
let page = h.query(HistoryQuery::default()).unwrap();
assert_eq!(page.total, 0, "带前导空格与空命令都不应入库");
}
#[test]
fn short_keyword_uses_like_fallback() {
// trigram 索引对 <3 字符的查询静默返回空,必须走 LIKE 回退,
// 否则「搜 ls」会得到空结果 —— 而这正是最常用的搜索词之一。
let h = open("shortkw");
h.record("ls -la", "/", "h1", "A", true, None).unwrap();
h.record("git log", "/", "h1", "A", true, None).unwrap();
let page = h
.query(HistoryQuery {
keyword: "ls".to_string(),
..Default::default()
})
.unwrap();
assert_eq!(page.total, 1);
assert_eq!(page.items[0].command, "ls -la");
}
#[test]
fn keyword_with_quotes_and_operators_is_safe() {
// 命令里出现 `'` `"` `*` 是家常便饭(`awk '{print $1}'`、`ls *.rs`)。
// 既不能造成 SQL 注入,也不能让 FTS 语法报错。
let h = open("meta");
h.record("awk '{print $1}' file.txt", "/", "h1", "A", true, None)
.unwrap();
h.record("ls *.rs", "/", "h1", "A", true, None).unwrap();
let p1 = h
.query(HistoryQuery {
keyword: "awk '{print $1}'".to_string(),
..Default::default()
})
.unwrap();
assert_eq!(p1.total, 1, "含单引号的查询必须能命中且不报错");
let p2 = h
.query(HistoryQuery {
keyword: "ls *.rs".to_string(),
..Default::default()
})
.unwrap();
assert_eq!(p2.total, 1, "含通配符的查询应按字面量匹配");
}
#[test]
fn favorite_survives_prune_and_clear() {
let h = open("fav");
for i in 0..5 {
h.record(&format!("cmd{i}"), "/", "h1", "A", true, None)
.unwrap();
}
let page = h.query(HistoryQuery::default()).unwrap();
let fav_id = page.items[0].id;
assert!(h.toggle_favorite(fav_id).unwrap());
// 容量淘汰到 2 条:收藏项必须留下(即使它不在最新的 2 条里)
h.prune(2).unwrap();
let after = h.query(HistoryQuery::default()).unwrap();
assert_eq!(after.total, 3, "2 条最新 + 1 条收藏");
assert!(
after.items.iter().any(|i| i.id == fav_id),
"收藏项不应被容量淘汰"
);
// 保留式清空:收藏仍在
let removed = h.clear(true).unwrap();
assert_eq!(removed, 2);
let final_page = h.query(HistoryQuery::default()).unwrap();
assert_eq!(final_page.total, 1);
assert_eq!(final_page.items[0].id, fav_id);
}
#[test]
fn like_escape_handles_backslash_first() {
// `\` 必须最先替换,否则后续插入的反斜杠会被再次转义。
assert_eq!(escape_like("a%b"), "a\\%b");
assert_eq!(escape_like("a_b"), "a\\_b");
assert_eq!(escape_like("a\\b"), "a\\\\b");
// 混合场景:反斜杠 + 通配符
assert_eq!(escape_like("\\%"), "\\\\\\%");
}
#[test]
fn fts_phrase_escapes_double_quotes() {
// FTS5 的短语转义约定:内部 `"` 写成 `""`。
assert_eq!(fts_phrase("a\"b"), "\"a\"\"b\"");
}
#[test]
fn query_limit_is_clamped() {
let q = HistoryQuery {
limit: 99999,
offset: -5,
..Default::default()
}
.normalized();
assert_eq!(q.limit, 500, "limit 上限 500");
assert_eq!(q.offset, 0, "offset 不为负");
let q2 = HistoryQuery::default().normalized();
assert_eq!(q2.limit, 100, "未指定时默认 100");
}
#[test]
fn host_filter_and_favorite_filter() {
let h = open("filters");
h.record("a", "/", "h1", "A", true, None).unwrap();
h.record("b", "/", "h2", "B", true, None).unwrap();
h.record("c", "/", "h1", "A", true, None).unwrap();
let by_host = h
.query(HistoryQuery {
host_id: "h1".to_string(),
..Default::default()
})
.unwrap();
assert_eq!(by_host.total, 2);
let page = by_host.clone();
h.toggle_favorite(page.items[0].id).unwrap();
let favs = h
.query(HistoryQuery {
favorited_only: true,
..Default::default()
})
.unwrap();
assert_eq!(favs.total, 1);
}
#[test]
fn sources_aggregates_by_host_id() {
let h = open("sources");
h.record("a", "/", "h1", "A", true, None).unwrap();
h.record("b", "/", "h1", "A", true, None).unwrap();
h.record("c", "/", "h2", "B", true, None).unwrap();
h.record("d", "/", "", "", false, None).unwrap(); // 无来源,不参与聚合
let s = h.sources().unwrap();
assert_eq!(s.len(), 2);
// 按条数倒序:h1 有 2 条
assert_eq!(s[0].host_id, "h1");
assert_eq!(s[0].count, 2);
}
#[test]
fn migration_is_idempotent_on_reopen() {
// 同一目录重复打开不应报错,也不应因重复建表而丢失数据。
// `migrate` 在 version != 0 时跳过建表,这条用例正是守着那个分支。
use std::sync::atomic::{AtomicUsize, Ordering};
static SEQ: AtomicUsize = AtomicUsize::new(0);
let n = SEQ.fetch_add(1, Ordering::Relaxed);
let dir = std::env::temp_dir().join(format!(
"thing-cmd-hist-test-reopen-{}-{n}",
std::process::id()
));
let _ = std::fs::remove_dir_all(&dir);
{
let h = History::new(&dir).expect("首次打开");
h.record("keepme", "/", "h1", "A", true, None).unwrap();
}
let h2 = History::new(&dir).expect("二次打开(v0 分支不应再执行)");
let page = h2.query(HistoryQuery::default()).unwrap();
assert_eq!(page.total, 1, "重开库不应清空数据");
assert_eq!(page.items[0].command, "keepme");
}
}
File diff suppressed because it is too large Load Diff
+431
View File
@@ -0,0 +1,431 @@
//! 终端模块:SSH 与本地 Shell 多会话终端。
//!
//! # 模块结构
//!
//! | 文件 | 职责 |
//! |---|---|
//! | [`session`] | `Session` trait 抽象 + `SessionRegistry`(本地/SSH 共用) |
//! | [`pty::conpty`] | 本地 ConPTY 后端(含三个已知坑的处理) |
//! | [`shell`] | Shell 探测、命令行组装、OSC 7 cwd 跟踪 |
//! | [`ssh`] | SSH 后端(russh)、认证、主机密钥校验、SFTP |
//! | [`keys`] | SSH 密钥生成/导入/管理 |
//! | [`settings`] | 设置模型与默认值(容器级 `#[serde(default)]` |
//! | [`events`] | 事件负载类型 |
//! | [`commands`] | Tauri 命令层(薄:整形/校验/归类) |
//!
//! # 为什么自带一套会话管理而不复用 `ProcessManager`
//!
//! 见 [`session`] 模块注释。一句话:`ProcessManager` 是「单例守护进程」模型,
//! 终端要的是「N 个独立会话 + 双向流式 I/O + 退出不重启」,语义不同。
//!
//! # 数据目录
//!
//! ```text
//! {app_data_dir}/terminal/
//! ├── settings.json 设置、主机列表、密钥元数据
//! ├── known_hosts.json 主机密钥指纹库(非机密,人可读可导出)
//! ├── keys/ SSH 私钥文件本体
//! └── hooks/ Shell cwd 跟踪临时脚本(Git Bash 用)
//! ```
//!
//! # 凭据存储
//!
//! SSH 密码、私钥 passphrase 一律走 [`crate::secrets`](系统凭据管理器,DPAPI)。
//! 键名约定:
//! - `terminal-ssh-password-{hostId}`
//! - `terminal-key-passphrase-{keyId}`
//!
//! **本模块不存在任何读取凭据明文的命令**:列表接口只回传是否已配置与掩码串。
pub mod assistant;
pub mod audit;
pub mod commands;
pub mod encoding;
pub mod events;
pub mod history;
pub mod keys;
pub mod pty;
pub mod session;
pub mod settings;
pub mod shell;
pub mod ssh;
pub mod window;
use std::path::PathBuf;
use std::sync::{Mutex, MutexGuard};
use tauri::{AppHandle, Emitter, Manager};
use session::SessionRegistry;
use settings::TerminalSettings;
/// 供 `pty::conpty` 与 `ssh` 共用的事件常量入口。
///
/// 两个后端都要 emit 事件,逐处写 `super::super::events::...` 可读性差且容易写错层级,
/// 因此在这里做一次再导出,后端内部统一用 `crate::terminal::events::TERMINAL_*`。
///
/// 注:当前两个后端已改为直接引用 `crate::terminal::events::TERMINAL_*`
/// 此别名保留为对外稳定出口(避免下游按路径引用时因重构断链)。
#[allow(unused_imports)]
pub use crate::constants::events as event_names;
/// 输出事件负载(两个后端共用)。同样作为对外出口保留。
#[allow(unused_imports)]
pub use events::OutputPayload;
/// 终端模块管理器(Tauri State)。
///
/// 与 `TranslateManager` / `MusicManager` 平级,在 `setup::init` 中构造并 `manage`。
pub struct TerminalManager {
/// 模块自身目录:`{app_data_dir}/terminal`
root: PathBuf,
/// 会话注册表(本地 + SSH 共用一张表,id 全局唯一)
pub sessions: SessionRegistry,
/// 活跃的 SFTP 通道(按会话 id 索引)。
///
/// 放在 `TerminalManager` 而不是 `SessionRegistry` 上:SFTP 是**可选能力**
/// 只有 SSH 会话且用户打开了文件面板才存在。挂在会话注册表上会让「会话」
/// 这个概念背负一个大多数情况下为空的字段。
pub sftp: ssh::sftp::SftpRegistry,
/// SSH 连接池(P2 连接复用):同身份的多个会话共享一条 SSH 连接。
///
/// 挂在 `TerminalManager` 上与 SFTP 同理——它是**跨会话**的资源,
/// 生命周期由池内引用计数管理(最后一个使用它的会话关闭时才断开)。
pub ssh_pool: ssh::pool::ConnectionPool,
/// 命令历史库(SQLite)。懒加载:`None` 表示尚未打开连接。
///
/// 与 `settings` 一样懒加载:大多数会话(尤其是刚启动就开标签的场景)
/// 在第一次写入命令之前根本用不到历史库,没必要在 `TerminalManager::new`
/// 里同步打开一个 SQLite 连接(含 WAL 初始化与建表检查)。
pub history: Mutex<Option<history::History>>,
/// 命令历史后台 writer 的入队端。
///
/// `record_command` 位于输出热路径上,此前每次都同步「settings 深拷贝 +
/// SQLite 写 + prune」;现在改为 `mpsc::send` 入队,由 [`history::spawn_writer`]
/// 的 writer 线程攒批落库。`None` 表示尚未启动(init_on_launch 时启动)。
history_tx: Mutex<Option<std::sync::mpsc::Sender<history::HistoryEntry>>>,
/// 设置缓存。`None` 表示尚未加载(懒加载,避免启动时多做一次磁盘 IO)
settings: Mutex<Option<TerminalSettings>>,
}
impl TerminalManager {
pub fn new(app_data_dir: PathBuf) -> Self {
let root = app_data_dir.join("terminal");
// 目录先行创建:后续 keys/ 与 hooks/ 都依赖它
std::fs::create_dir_all(root.join("keys")).ok();
std::fs::create_dir_all(root.join("hooks")).ok();
// logs/ 由 audit::toggle 按需创建(首次开启日志才落盘),此处不预建
Self {
root,
sessions: SessionRegistry::new(),
sftp: ssh::sftp::SftpRegistry::new(),
ssh_pool: ssh::pool::ConnectionPool::default(),
history: Mutex::new(None),
history_tx: Mutex::new(None),
settings: Mutex::new(None),
}
}
/// 取(必要时打开)命令历史库。
///
/// `&self` + 内部 `Mutex<Option<..>>` 而非 `&mut self`:命令层拿到的是
/// `State<'_, TerminalManager>`,多个并发命令(比如历史面板在搜、同时
/// 另一个会话在写新命令)都会调到它,`&mut` 会把两者串行化。
///
/// 打开失败**不缓存失败结果**`left` 保持 `None`):磁盘临时不可用、
/// 目录权限刚被修好这类情况应当允许后续调用重试。若把 `Err` 也当成
/// 「已初始化」,用户就得重启应用才能恢复历史功能。
pub fn history(&self) -> Result<std::sync::MutexGuard<'_, Option<history::History>>, String> {
let mut guard = self.history.lock().unwrap_or_else(|e| e.into_inner());
if guard.is_none() {
*guard = Some(history::History::new(&self.root)?);
}
Ok(guard)
}
pub fn root(&self) -> &PathBuf {
&self.root
}
/// 把一条命令历史入队(由后台 writer 攒批落库)。
///
/// 通道不可用(writer 尚未启动或已退出)时退回同步写:
/// 「writer 死了历史就静默丢失」比「热路径偶尔慢一次」更糟。
pub fn queue_history(&self, mut entry: history::HistoryEntry) {
{
let guard = self.history_tx.lock().unwrap_or_else(|e| e.into_inner());
if let Some(tx) = guard.as_ref() {
match tx.send(entry) {
Ok(()) => return,
// writer 已退出:SendError 里带着原值,取回走同步兜底
Err(e) => entry = e.0,
}
}
}
// 通道已断:同步兜底
if let Ok(guard) = self.history() {
if let Some(h) = guard.as_ref() {
if let Err(e) = h.record(
&entry.command,
&entry.cwd,
&entry.host_id,
&entry.host_name,
entry.ssh,
entry.exit_code,
) {
crate::logger::log_error(
"terminal",
&format!("写入命令历史失败(不影响会话): {e}"),
);
}
if let Err(e) = h.prune(0) {
crate::logger::log_error("terminal", &format!("淘汰历史容量失败: {e}"));
}
}
}
}
/// 查 shell / 主机的显示名(供历史落库)。
///
/// 此前 `record_command` 用 `settings()`(整份深拷贝,含全部主机、Shell、
/// 快捷键表)只为拿一个名字,而它在输出热路径上。这里改为持锁只读出
/// 需要的字段。
pub fn display_name(&self, target_id: &str, ssh: bool) -> String {
let guard = self.lock_settings();
let Some(s) = guard.as_ref() else {
return target_id.to_string();
};
if ssh {
s.hosts
.iter()
.find(|h| h.id == target_id)
.map(|h| h.name.clone())
.unwrap_or_else(|| target_id.to_string())
} else {
s.shells
.iter()
.find(|x| x.id == target_id)
.map(|x| x.name.clone())
.unwrap_or_else(|| target_id.to_string())
}
}
pub fn settings_path(&self) -> PathBuf {
self.root.join("settings.json")
}
/// 密钥文件存放目录。
pub fn keys_dir(&self) -> PathBuf {
self.root.join("keys")
}
/// cwd hook 脚本目录(Git Bash 的 `--init-file` 需要一个真实文件)。
pub fn hooks_dir(&self) -> PathBuf {
self.root.join("hooks")
}
/// 会话日志目录(`{app_data_dir}/terminal/logs/`)。
///
/// 目录由 `audit::toggle` 按需创建:日志是可选能力,
/// 不为它预付一次磁盘 IO。
pub fn logs_dir(&self) -> PathBuf {
self.root.join("logs")
}
/// 读取设置(带缓存)。
///
/// 首次调用会从磁盘读取并执行 `heal()`;若 `heal` 报告变更则立即落盘,
/// 避免「老配置每次启动都要自愈一遍」。
pub fn settings(&self) -> TerminalSettings {
let mut guard = self.lock_settings();
if let Some(s) = guard.as_ref() {
return s.clone();
}
let mut s = self.load_settings_from_disk();
if s.heal() {
if let Err(e) = self.write_settings_file(&s) {
crate::logger::log_error("terminal", &format!("自愈后保存设置失败: {e}"));
}
}
*guard = Some(s.clone());
s
}
/// 写入设置(覆盖缓存 + 落盘)。
pub fn save_settings(&self, mut next: TerminalSettings) -> Result<(), String> {
// 保存前自愈一次:前端可能提交了越界值(滚动缓冲、字体大小等)
next.heal();
self.write_settings_file(&next)?;
*self.lock_settings() = Some(next);
Ok(())
}
/// 局部修改设置:读 → 改 → 写。避免前端为了改一个字段而回传整份设置
/// (回传整份会带来「前端旧快照覆盖后端新值」的竞态)。
pub fn update_settings<F>(&self, f: F) -> Result<TerminalSettings, String>
where
F: FnOnce(&mut TerminalSettings),
{
let mut s = self.settings();
f(&mut s);
self.save_settings(s.clone())?;
Ok(s)
}
/// 从磁盘读取。文件不存在或解析失败时返回默认值——
/// 配置文件损坏不该让整个模块不可用(用户至少还能新建会话)。
fn load_settings_from_disk(&self) -> TerminalSettings {
let path = self.settings_path();
match std::fs::read_to_string(&path) {
Ok(raw) => match serde_json::from_str::<TerminalSettings>(&raw) {
Ok(s) => s,
Err(e) => {
// 备份损坏文件再退回默认:直接覆盖会让用户丢失可手工修复的内容
let bak = path.with_extension("json.broken");
let _ = std::fs::rename(&path, &bak);
crate::logger::log_error(
"terminal",
&format!(
"设置解析失败(已备份至 {}: {e}",
bak.display()
),
);
TerminalSettings::default()
}
},
Err(_) => TerminalSettings::default(),
}
}
fn write_settings_file(&self, s: &TerminalSettings) -> Result<(), String> {
let path = self.settings_path();
if let Some(parent) = path.parent() {
std::fs::create_dir_all(parent).map_err(|e| format!("创建配置目录失败: {e}"))?;
}
let json = serde_json::to_string_pretty(s).map_err(|e| format!("序列化设置失败: {e}"))?;
// 先写临时文件再 rename:避免写入中途崩溃留下半截 JSON
let tmp = path.with_extension("json.tmp");
std::fs::write(&tmp, json).map_err(|e| format!("写入设置失败: {e}"))?;
std::fs::rename(&tmp, &path).map_err(|e| format!("保存设置失败: {e}"))
}
/// 统一的锁获取:中毒时取回内部值。
///
/// 设置结构本身没有跨字段不变量(每个字段独立),因此「中毒」不代表数据
/// 已损坏,直接 panic 反而会把一次无关的线程崩溃放大成整个模块不可用。
fn lock_settings(&self) -> MutexGuard<'_, Option<TerminalSettings>> {
self.settings.lock().unwrap_or_else(|e| e.into_inner())
}
/// 刷新 Shell 探测结果并写回设置。
///
/// 返回完整的 Shell 列表(含用户自定义项)。用户在设置页点「重新探测」时调用。
pub fn refresh_shells(&self) -> Result<Vec<settings::ShellProfile>, String> {
let current = self.settings();
let merged = shell::detect_and_merge(&current.shells);
let result = merged.clone();
self.update_settings(|s| {
s.shells = merged;
})?;
Ok(result)
}
/// 应用退出清理:关闭所有会话。
///
/// **不等待**。ConPTY 的 `ClosePseudoConsole` 会阻塞到所有句柄关闭,
/// 退出路径上等待会卡死(参照 `MonitorKernel` 的教训——那里用了独立线程
/// + `recv_timeout(3s)` 防挂起)。会话侧已把关闭动作放进后台线程,
/// 进程终止时 OS 回收剩余资源。
pub fn cleanup_on_exit(&self) {
let n = self.sessions.len();
if n > 0 {
crate::logger::log_info("terminal", &format!("退出:关闭 {n} 个会话"));
}
// 先关 SFTP 通道:它们与 shell 共用同一条 TCP 连接,若先关连接,
// SFTP 侧的 close 报文会写到已关闭的 socket 上(在日志里留下一串噪音)。
let ids: Vec<String> = self.sessions.list().into_iter().map(|s| s.id).collect();
for id in ids {
self.sftp.close(&id);
}
// 丢弃历史 writer 的入队端:writer 会把通道里剩余的记录写完后自然退出
// (不 join —— 退出路径上不做任何等待,见本函数头部注释)
*self.history_tx.lock().unwrap_or_else(|e| e.into_inner()) = None;
self.sessions.close_all();
}
/// 在应用启动时初始化:预创建 hooks 目录、刷新 Shell 探测、按需注册全局快捷键。
///
/// **不发任何网络请求**(沿用 translate 模块的姿态):SSH 连接只在用户
/// 主动打开会话时建立。
pub fn init_on_launch(&self, app: &AppHandle) {
// 首次运行或探测结果为空时做一次 Shell 探测
let s = self.settings();
if s.shells.is_empty() {
if let Err(e) = self.refresh_shells() {
crate::logger::log_error("terminal", &format!("Shell 探测失败: {e}"));
}
} else {
// 已有配置也要重新探测:用户可能升级/卸载了 PowerShell 7。
// 失败不阻断启动。
if let Err(e) = self.refresh_shells() {
crate::logger::log_warn("terminal", &format!("Shell 重探测失败(沿用旧配置): {e}"));
}
}
// 清理上次运行遗留的 hook 脚本(内容每次都重新生成,不会丢信息)
let hooks = self.hooks_dir();
if let Ok(entries) = std::fs::read_dir(&hooks) {
for e in entries.flatten() {
if e.path().extension().map_or(false, |x| x == "sh") {
let _ = std::fs::remove_file(e.path());
}
}
}
// 启动命令历史后台 writer(见 `history_tx` 字段的说明)
*self.history_tx.lock().unwrap_or_else(|e| e.into_inner()) =
Some(history::spawn_writer(app.clone()));
let _ = app; // 全局快捷键由前端 store 在模块启用时注册(与截图模块同一范式)
}
}
/// 从 Tauri State 取 TerminalManager。
pub fn manager(app: &AppHandle) -> Result<tauri::State<'_, TerminalManager>, String> {
app.try_state::<TerminalManager>()
.ok_or_else(|| "终端模块未初始化".to_string())
}
/// 发射 SFTP 传输进度事件。
///
/// 转发到 [`events::emit_transfer`],在 `terminal` 根上再导出一层是为了让命令层
/// 写 `crate::terminal::emit_transfer(...)` 与 `emit_state` 保持同一路径风格。
pub fn emit_transfer(app: &AppHandle, payload: &ssh::sftp::TransferProgress) {
events::emit_transfer(app, payload);
}
/// 发射会话状态事件。
///
/// # 为什么需要这个统一入口
///
/// 两个后端(ConPTY / SSH)在**六处**要更新状态:连接中、已认证、已建立、
/// 降级、关闭、失败。若每处各自 `emit(TERMINAL_STATE, session.info())`
/// 就会出现「某处忘了 emit,前端状态点停在旧值」这类难查的不一致。
/// 集中到一处后,「改状态」与「广播状态」永远成对发生。
///
/// `final_state` 参数是**显式传入**而非从 `info()` 读取的:调用方常常是在
/// 刚写入状态、但 `info()` 还持有旧值的时间窗内调用(各自持有不同 Mutex),
/// 传参能避免这个竞态。
pub fn emit_state(
app: &AppHandle,
state: &session::LocalSessionState,
final_state: session::SessionState,
error: Option<String>,
) {
if let Some(err) = error.as_ref() {
*state.error.lock().unwrap_or_else(|e| e.into_inner()) = Some(err.clone());
}
let mut info = session::local_info(state, session::SessionKind::Local);
info.state = final_state;
let _ = app.emit(crate::constants::events::TERMINAL_STATE, info);
}
+746
View File
@@ -0,0 +1,746 @@
//! ConPTY 绑定与本地会话实现。
//!
//! 直接绑定 `windows-sys` 的 `CreatePseudoConsole` 系列 API(而非引入
//! `portable-pty` 之类的封装)。理由:本项目已有大量原生 Win32 调用
//! `win32_util.rs` / `screenshot/wgc_capture.rs` / `translate/capture/uia_capture.rs`),
//! 这条路径熟悉;而 ConPTY 的三个坑(见下)无论加不加封装都要踩,多一层只增加定位难度。
//!
//! # ConPTY 的三个坑(全部已在实现中处理)
//!
//! 1. **`ClosePseudoConsole` 会阻塞**,直到所有引用该 PTY 的句柄被关闭。若在读线程
//! 仍挂起于 `ReadFile` 时调用,就会永久卡住。处理:先 `CancelIoEx` 取消挂起的读,
//! 再在**独立线程**里调用 `ClosePseudoConsole`,调用方不等待(见 [`ConPtySession::kill`])。
//!
//! 2. **`ResizePseudoConsole` 有早期竞态**:进程刚创建、还没开始读 stdout 时调用,
//! 尺寸可能被吞掉(表现为 TUI 程序启动后按 80×24 而不是实际尺寸绘制,vim/htop 花屏)。
//! 处理:首帧输出到达前,resize 请求只入队不执行;首帧到达后再应用队列中的最新值
//! (见 [`PtyInner::pending_size`])。
//!
//! 3. **进程退出 ≠ PTY 关闭**:子进程退出后,管道里可能还有未读完的输出(如最后一行
//! 提示符、错误信息)。必须等 `ReadFile` 返回 0 或 `ERROR_BROKEN_PIPE` 才算真正结束,
//! 否则会丢掉尾部输出——这正是很多自制终端「退出时少一行」的原因。
//!
//! # 线程模型
//!
//! 每个会话起 **两个** 后台线程:
//! - 输出读线程:循环 `ReadFile`,把数据推入聚合缓冲,按 8~16ms 窗口发批次事件。
//! - 退出等待线程:`WaitForSingleObject` 等子进程句柄,拿退出码,等读线程自然结束
//! (即坑 3)后把状态置为 `Closed` 并发事件。
//!
//! 写操作不单独起线程:`WriteFile` 在 ConPTY 上通常不阻塞(有内部缓冲),
//! 由命令层直接同步调用。若未来证实大块粘贴会阻塞,再改成写队列。
use std::io::{ErrorKind, Read, Write};
use std::os::windows::io::{AsRawHandle, FromRawHandle, OwnedHandle};
use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
use std::sync::{Arc, Mutex};
use std::time::{Duration, Instant};
use tauri::{AppHandle, Emitter};
use windows_sys::Win32::Foundation::{CloseHandle, HANDLE, INVALID_HANDLE_VALUE};
use windows_sys::Win32::System::Console::{
ClosePseudoConsole, CreatePseudoConsole, ResizePseudoConsole, COORD, HPCON,
};
use windows_sys::Win32::System::Threading::{
CreateProcessW, GetExitCodeProcess, TerminateProcess, WaitForSingleObject,
CREATE_UNICODE_ENVIRONMENT, EXTENDED_STARTUPINFO_PRESENT, PROCESS_INFORMATION,
STARTUPINFOEXW,
};
use super::super::session::{
local_info, LocalSessionState, Session, SessionId, SessionInfo, SessionKind, SessionState,
};
/// 输出聚合窗口。
///
/// 8ms 是权衡值:`cat` 大文件时每秒可产生数万次 `ReadFile` 返回,逐条 emit 会压垮
/// WebView;但窗口太长(如 50ms)会让交互式输入出现可感知的延迟。8ms 约等于
/// 一帧(120Hz),人眼无法分辨,同时能把数千次读合并成一次事件。
const AGGREGATE_WINDOW: Duration = Duration::from_millis(8);
/// 单次读缓冲区大小。64KB 与 ConPTY 内部缓冲匹配,避免多次往返。
const READ_BUF_SIZE: usize = 64 * 1024;
/// 聚合缓冲上限:防止「疯狂输出且前端卡住」时内存无限增长。
/// 超出后丢弃**最旧**的数据(终端语义:用户更关心最新的输出)。
const MAX_PENDING_BYTES: usize = 4 * 1024 * 1024;
/// 会话终止时附加到输出的提示(由 Rust 侧统一给出,避免前端各写一套)。
const EXIT_HINT: &str = "\r\n";
// ===== 共享状态 =====
struct PtyInner {
/// PTY 句柄。`Mutex` 保护是因为 resize 需要并发访问,而 ClosePseudoConsole
/// 会把它置为 None(表示已关闭,后续调用应静默忽略)。
hpc: Mutex<Option<HPCON>>,
/// 写入端(我们 → 伪控制台输入)。`Option` 以便 kill 后释放。
writer: Mutex<Option<std::fs::File>>,
/// 子进程句柄,用于退出等待与强制终止。
process: Mutex<Option<OwnedHandle>>,
/// 是否已收到首帧输出(ConPTY resize 竞态的处理依据,见模块注释坑 2)。
first_output_seen: AtomicBool,
/// 首帧之前缓存的尺寸请求。
pending_size: Mutex<Option<(u16, u16)>>,
/// 是否已关闭(幂等保护)。
closed: AtomicBool,
}
/// 本地 ConPTY 会话。
pub struct ConPtySession {
pub state: Arc<LocalSessionState>,
inner: Arc<PtyInner>,
/// 事件发射器。持有 `AppHandle` 而非 `Window`:会话可以「提升」为独立窗口
/// (见 `terminal_detach_session`),事件应发给所有窗口而不是绑定的那一个。
app: AppHandle,
/// 输出批次序号(每会话独立计数,前端按会话校验连续性)。
seq: AtomicU64,
}
impl ConPtySession {
/// 启动一个本地 Shell 会话。
///
/// `command_line` 必须是**完整的命令行**(含可执行文件路径)。Windows 的
/// `CreateProcessW` 在传入 `lpApplicationName = NULL` 时会自行解析命令行首段
/// 作为可执行文件,因此需要调用方保证路径带引号(见 [`super::super::shell::build_command_line`])。
pub fn spawn(
app: AppHandle,
id: SessionId,
shell_id: String,
shell_name: String,
command_line: String,
cwd: Option<String>,
env: Vec<(String, String)>,
cols: u16,
rows: u16,
) -> Result<Self, String> {
let state = Arc::new(LocalSessionState::new(id.clone(), shell_id, shell_name));
*state.size.lock().unwrap_or_else(|e| e.into_inner()) = (cols, rows);
// ===== 1. 创建一对匿名管道 =====
// ConPTY 需要「输入管道」(我们写、PTY 读)与「输出管道」(PTY 写、我们读)。
let (input_read, input_write) = create_pipe()?;
let (output_read, output_write) = create_pipe()?;
// ===== 2. 创建伪控制台 =====
let size = COORD {
X: cols as i16,
Y: rows as i16,
};
let mut hpc: HPCON = 0;
// SAFETY: 传入的两个句柄是本函数刚创建的、有效的管道端;
// size 已按 COORD 的 i16 范围做了钳制(见 clamp_dim)。
let hr = unsafe {
CreatePseudoConsole(size, input_read.as_raw_handle() as HANDLE, output_write.as_raw_handle() as HANDLE, 0, &mut hpc)
};
if hr < 0 {
return Err(format!("CreatePseudoConsole 失败(HRESULT: 0x{hr:08X}"));
}
// 创建后立即关掉我们持有的这两端:
// - input_read:PTY 已持有自己的副本,我们只保留写端
// - output_write:同理,我们只保留读端
// 若不关闭,读端永远等不到 EOF(因为写端仍被本进程持有),
// 表现为「会话关闭后读线程不退出」,进而导致 ClosePseudoConsole 卡死(坑 1)。
drop(input_read);
drop(output_write);
// ===== 3. 组装 STARTUPINFOEX 并把 PTY 传给子进程 =====
let mut si: STARTUPINFOEXW = unsafe { std::mem::zeroed() };
si.StartupInfo.cb = std::mem::size_of::<STARTUPINFOEXW>() as u32;
// 必须设置这两个标志:
// - EXTENDED_STARTUPINFO_PRESENT:让系统读 attribute list 里的 HPCON
// - CREATE_UNICODE_ENVIRONMENT:环境块是 UTF-16
let mut pi: PROCESS_INFORMATION = unsafe { std::mem::zeroed() };
// 把 HPCON 放进进程属性列表。这一步用 ATTRIBUTE 常量的原始值即可,
// 不必引入 PROCTHREAD_ATTRIBUTE 类型(windows-sys 未导出便捷构造器)。
const PROC_THREAD_ATTRIBUTE_PSEUDOCONSOLE: usize = 0x0002_0016;
let mut attr_size: usize = 0;
unsafe {
// 第一次调用取所需大小
InitializeProcThreadAttributeList(std::ptr::null_mut(), 1, 0, &mut attr_size);
}
let mut attr_buf = vec![0u8; attr_size];
let attr_list = attr_buf.as_mut_ptr() as *mut _;
// SAFETY: attr_buf 按 API 报告的大小分配;attr_size 已由上一次调用写入。
let ok = unsafe { InitializeProcThreadAttributeList(attr_list, 1, 0, &mut attr_size) };
if ok == 0 {
unsafe { ClosePseudoConsole(hpc) };
return Err(format!(
"InitializeProcThreadAttributeList 失败: {}",
std::io::Error::last_os_error()
));
}
// SAFETY: attr_list 已初始化且声明可容纳 1 个属性;hpc 是有效的 HPCON。
//
// 注意 windows-sys 0.52 里 `HPCON = isize`0.59+ 才是 `*mut c_void`)。
// `isize as *const c_void` 是不允许的直接转型(E0641),
// 必须先转成 `usize` 再转指针——两步都是明确的大小的整数/指针转换。
let hpc_ptr = hpc as usize as *const std::ffi::c_void;
let ok = unsafe {
UpdateProcThreadAttribute(
attr_list,
0,
PROC_THREAD_ATTRIBUTE_PSEUDOCONSOLE,
hpc_ptr,
std::mem::size_of::<HPCON>(),
std::ptr::null_mut(),
std::ptr::null_mut(),
)
};
if ok == 0 {
let e = std::io::Error::last_os_error();
unsafe {
DeleteProcThreadAttributeList(attr_list);
ClosePseudoConsole(hpc);
}
return Err(format!("UpdateProcThreadAttribute 失败: {e}"));
}
si.lpAttributeList = attr_list;
// ===== 4. 组装环境块与命令行 =====
let env_block = build_env_block(&env)?;
let mut cmdline: Vec<u16> = command_line.encode_utf16().chain(std::iter::once(0)).collect();
let cwd_wide: Option<Vec<u16>> = cwd
.as_ref()
.filter(|s| !s.trim().is_empty())
.map(|s| s.encode_utf16().chain(std::iter::once(0)).collect());
// ===== 5. 创建进程 =====
// SAFETY: 所有指针都指向本函数栈/堆上的有效数据,且在调用期间存活;
// cmdline 是可变的(CreateProcessW 可能原地修改它,这是 API 约定)。
let created = unsafe {
CreateProcessW(
std::ptr::null(), // 让系统从命令行解析可执行文件
cmdline.as_mut_ptr(), // 可写缓冲
std::ptr::null(), // 默认进程安全属性
std::ptr::null(), // 默认线程安全属性
0, // 不继承句柄(PTY 走属性列表传递)
EXTENDED_STARTUPINFO_PRESENT | CREATE_UNICODE_ENVIRONMENT,
env_block.as_ptr() as *const std::ffi::c_void, // 环境块
cwd_wide.as_ref().map_or(std::ptr::null(), |s| s.as_ptr()),
&si.StartupInfo,
&mut pi,
)
};
// 无论成功与否,属性列表都可以释放了(系统已复制所需信息)
unsafe {
DeleteProcThreadAttributeList(attr_list);
}
if created == 0 {
let e = std::io::Error::last_os_error();
unsafe { ClosePseudoConsole(hpc) };
return Err(format!("创建进程失败: {e}"));
}
// 主线程句柄用不到,立即关闭(进程句柄保留,用于等待退出)
unsafe { CloseHandle(pi.hThread) };
// ===== 6. 组装会话对象 =====
// `create_pipe` 已直接返回 `File`(在内部完成裸句柄 → `File` 的转换),
// 此处不再做二次转换——早前那版把 `File` 当句柄再转一次,
// 会触发 `expected isize, found File` 的类型错误。
let writer = input_write;
let reader = output_read;
let process = unsafe { OwnedHandle::from_raw_handle(pi.hProcess as *mut _) };
let inner = Arc::new(PtyInner {
hpc: Mutex::new(Some(hpc)),
writer: Mutex::new(Some(writer)),
process: Mutex::new(Some(process)),
first_output_seen: AtomicBool::new(false),
pending_size: Mutex::new(None),
closed: AtomicBool::new(false),
});
let session = Self {
state: state.clone(),
inner: inner.clone(),
app: app.clone(),
seq: AtomicU64::new(0),
};
session.set_state(SessionState::Established, None);
// ===== 7. 启动读线程与退出等待线程 =====
spawn_reader(app.clone(), state.clone(), inner.clone(), reader);
spawn_waiter(app, state.clone(), inner, session.seq_counter());
Ok(session)
}
/// 输出序号计数器(每会话独立;前端按会话分别校验连续性)。
fn seq_counter(&self) -> Arc<AtomicU64> {
// 这里刻意返回一个独立计数器:`ConPtySession` 自身可能被 move 进
// 注册表,而读线程需要在 move 之前就拿到它。两者通过 Arc 共享。
Arc::new(AtomicU64::new(self.seq.load(Ordering::Relaxed)))
}
}
/// 管道创建:返回 (读端, 写端) 两个 `File`。
fn create_pipe() -> Result<(std::fs::File, std::fs::File), String> {
use std::os::windows::io::FromRawHandle;
use windows_sys::Win32::System::Pipes::CreatePipe;
let mut read: HANDLE = INVALID_HANDLE_VALUE;
let mut write: HANDLE = INVALID_HANDLE_VALUE;
// SAFETY: 两个 out 参数都指向本函数栈上的有效 HANDLE 变量;
// 安全属性传 null 表示句柄不可继承(我们不需要子进程继承管道本身)。
let ok = unsafe { CreatePipe(&mut read, &mut write, std::ptr::null(), 0) };
if ok == 0 {
return Err(format!(
"CreatePipe 失败: {}",
std::io::Error::last_os_error()
));
}
// SAFETY: CreatePipe 成功返回后,read/write 都是有效的、由我们独占的句柄。
unsafe {
Ok((
std::fs::File::from_raw_handle(read as *mut _),
std::fs::File::from_raw_handle(write as *mut _),
))
}
}
/// 构造 UTF-16 环境块(`KEY=VALUE\0...\0\0`)。
///
/// 从 `std::env::vars()` 出发做增量修改,而不是从空环境开始:Windows 上进程
/// 需要 `SystemRoot` / `PATH` / `USERPROFILE` 等继承变量才能正常工作。
/// 值为空串表示**删除**该变量(前端用「清空值」表达删除意图,比另设开关直观)。
fn build_env_block(overrides: &[(String, String)]) -> Result<Vec<u16>, String> {
let mut map: std::collections::BTreeMap<String, String> = std::env::vars().collect();
// 未设置会影响 shell 提示符与编码;显式补齐(用户 override 可覆盖)
map.entry("TERM".to_string()).or_insert_with(|| "xterm-256color".to_string());
for (k, v) in overrides {
if v.is_empty() {
map.remove(k);
} else {
map.insert(k.clone(), v.clone());
}
}
let mut block = Vec::with_capacity(4096);
for (k, v) in map {
// 环境块不允许 key 含 '='Windows 用它分隔键值)
if k.contains('=') || k.is_empty() {
continue;
}
block.extend(format!("{k}={v}").encode_utf16());
block.push(0);
}
block.push(0); // 双 null 结尾
Ok(block)
}
/// 输出读线程:读 → 聚合 → 发批次事件。
///
/// 三种结束条件(都发 `terminal-exit`,但来源不同):
/// 1. `ReadFile` 返回 0EOF)—— 正常结束
/// 2. `ERROR_BROKEN_PIPE` / `ERROR_OPERATION_ABORTED` —— PTY 被关闭(kill 路径)
/// 3. 其他 IO 错误 —— 异常,上报 error
fn spawn_reader(
app: AppHandle,
state: Arc<LocalSessionState>,
inner: Arc<PtyInner>,
mut reader: std::fs::File,
) {
std::thread::spawn(move || {
let mut buf = vec![0u8; READ_BUF_SIZE];
let mut pending: Vec<u8> = Vec::with_capacity(READ_BUF_SIZE);
let mut last_flush = Instant::now();
// OSC 序列扫描的拼接缓冲:序列可能被切在两批数据之间(见 shell::parse_control_sequences
let mut osc_tail: Vec<u8> = Vec::new();
// 命令历史累积器(见 session::CommandAccumulator)。
// 由本读线程独占持有 —— 只在读线程里被访问,不需要共享。
let sim = crate::terminal::session::CommandAccumulator::new();
// 上一批发送的序号,用于退出时把 batch 序号一并回传(前端据此判断有无丢包)
let mut last_seq: u64 = 0;
loop {
match reader.read(&mut buf) {
Ok(0) => break, // EOF:坑 3 的正解,子进程退出后管道仍可能有残余数据
Ok(n) => {
pending.extend_from_slice(&buf[..n]);
// 首帧到达:应用之前排队的尺寸(坑 2)
if !inner.first_output_seen.swap(true, Ordering::SeqCst) {
if let Some((cols, rows)) = inner
.pending_size
.lock()
.unwrap_or_else(|e| e.into_inner())
.take()
{
apply_resize(&inner, cols, rows);
}
}
// cwd / 标题 / 命令边界跟踪:在**原始字节**上解析,且解析结果不从前端输出里剔除。
//
// 为什么保留 OSC 7 原文发给前端:xterm 会自行忽略它,而保留原文让
// 「会话输出日志」可以原样重放(P2 的审计功能)。剔除反而会引入
// 一份「两份流不一致」的隐患。
crate::terminal::session::scan_control_sequences(
&app,
&state,
&mut osc_tail,
&buf[..n],
&sim,
);
// 聚合窗口到了就发一批
if last_flush.elapsed() >= AGGREGATE_WINDOW {
last_seq = flush_output(&app, &state, &mut pending).unwrap_or(last_seq);
last_flush = Instant::now();
} else if pending.len() > MAX_PENDING_BYTES {
// 前端卡住导致积压:丢弃最旧的一半,保留最新输出
let drop_len = pending.len() - MAX_PENDING_BYTES / 2;
pending.drain(..drop_len);
crate::logger::log_warn(
"terminal",
&format!(
"会话 {} 输出积压超限,已丢弃 {} 字节最旧数据",
state.id, drop_len
),
);
}
}
Err(e) => {
// BROKEN_PIPE / OPERATION_ABORTED 是 kill 路径的正常表现,不算错误
if e.kind() != ErrorKind::BrokenPipe && e.raw_os_error() != Some(995) {
crate::logger::log_error(
"terminal",
&format!("会话 {} 读取失败: {e}", state.id),
);
}
break;
}
}
// 有未发出的剩余数据时,退化为「尽快发出」:
// 交互式场景下提示符必须立刻可见,不能等满一个窗口
if !pending.is_empty() && last_flush.elapsed() >= AGGREGATE_WINDOW {
last_seq = flush_output(&app, &state, &mut pending).unwrap_or(last_seq);
last_flush = Instant::now();
}
}
// 读线程结束前把残留数据全部发出(否则最后一行提示符会丢)
if let Some(s) = flush_output(&app, &state, &mut pending) {
last_seq = s;
}
// 读线程结束即代表 PTY 侧已无更多数据,此时可以安全关闭 PTY(坑 1 的正解)
close_pty_background(&inner);
// 更新状态并发状态事件:若已被 waiter 置为 Closed 则保持 Closed 不变
let final_state = {
let mut st = state.state.lock().unwrap_or_else(|e| e.into_inner());
if *st != SessionState::Closed && *st != SessionState::Failed {
*st = SessionState::Closed;
}
*st
};
let _ = last_seq;
crate::terminal::emit_state(&app, &state, final_state, None);
let _ = app.emit(
crate::terminal::events::TERMINAL_EXIT,
crate::terminal::events::ExitPayload {
session_id: state.id.clone(),
exit_code: *state.exit_code.lock().unwrap_or_else(|e| e.into_inner()),
reason: Some("eof".to_string()),
},
);
});
}
// OSC 7cwd/ OSC 0,2(标题)/ OSC 133(命令边界)的扫描与落库
// 全部委托给 `session::scan_control_sequences`。
//
// 这里此前有一份与本文件同源的实现,SSH 后端另有一份几乎相同的拷贝。
// P1 加命令历史时把两份合一了 —— 否则「OSC 133 解析 + 落库」要在两处各写一遍,
// 任何一处漏掉都表现为「只有本地会话有历史」这类按后端分支的诡异 bug。
// 具体理由与实现见 `session.rs` 中该函数的长注释。
/// 退出等待线程:等子进程结束 → 拿退出码 → 等读线程收尾。
fn spawn_waiter(
app: AppHandle,
state: Arc<LocalSessionState>,
inner: Arc<PtyInner>,
_seq: Arc<AtomicU64>,
) {
std::thread::spawn(move || {
// 取出进程句柄(不 take,kill 也要用)
let handle = {
let g = inner.process.lock().unwrap_or_else(|e| e.into_inner());
g.as_ref().map(|h| h.as_raw_handle() as HANDLE)
};
let Some(h) = handle else { return };
// SAFETY: h 是本会话持有的有效进程句柄;无限等待直到进程退出。
let _ = unsafe { WaitForSingleObject(h, u32::MAX) };
let mut code: u32 = 0;
// SAFETY: h 有效且进程已退出,GetExitCodeProcess 会写入 code。
let ok = unsafe { GetExitCodeProcess(h, &mut code) };
if ok != 0 {
*state.exit_code.lock().unwrap_or_else(|e| e.into_inner()) = Some(code as i32);
}
// 注意:这里**不**立刻置 Closed。进程退出后管道里可能还有尾部输出,
// 要等读线程把残余数据发完(坑 3)。读线程结束时会把状态置为 Closed。
// 但若进程是被 kill 且读线程已退出,这里的 emit 就成了唯一通知。
let already_closed = {
let st = state.state.lock().unwrap_or_else(|e| e.into_inner());
*st == SessionState::Closed
};
if !already_closed {
// 给读线程一点时间收尾(正常会在 8ms 内完成)
std::thread::sleep(Duration::from_millis(50));
let st_closed = {
let st = state.state.lock().unwrap_or_else(|e| e.into_inner());
*st == SessionState::Closed
};
if !st_closed {
*state.state.lock().unwrap_or_else(|e| e.into_inner()) = SessionState::Closed;
close_pty_background(&inner);
let _ = app.emit(
crate::terminal::events::TERMINAL_EXIT,
crate::terminal::events::ExitPayload {
session_id: state.id.clone(),
exit_code: *state.exit_code.lock().unwrap_or_else(|e| e.into_inner()),
reason: Some("process-exit".to_string()),
},
);
}
}
});
}
/// 把聚合缓冲发成一批事件。返回本次批次序号(缓冲为空时返回 `None`)。
fn flush_output(app: &AppHandle, state: &LocalSessionState, pending: &mut Vec<u8>) -> Option<u64> {
if pending.is_empty() {
return None;
}
// 会话日志(audit)在 clear 之前写:保证日志与前端所见完全一致
crate::terminal::audit::write(&state.id, pending);
use base64::Engine;
let data = base64::engine::general_purpose::STANDARD.encode(&pending);
pending.clear();
let seq = SEQ.fetch_add(1, Ordering::Relaxed) + 1;
let _ = app.emit(
crate::terminal::events::TERMINAL_OUTPUT,
crate::terminal::events::OutputPayload {
session_id: state.id.clone(),
data,
seq,
},
);
Some(seq)
}
/// 全局输出批次序号。
///
/// 用全局计数器而非每会话计数器:前端校验连续性只需一个单调序列,
/// 且跨会话的绝对顺序在排查问题时更有价值(能看出「哪个会话先输出」)。
static SEQ: AtomicU64 = AtomicU64::new(0);
/// 取下一个全局输出批次序号。
///
/// 对 SSH 后端开放(见 `ssh::flush_output`):两种后端共用同一序列,
/// 前端只需一套连续性校验逻辑。
pub fn next_global_seq() -> u64 {
SEQ.fetch_add(1, Ordering::Relaxed) + 1
}
/// 应用尺寸变更(真正调用 ResizePseudoConsole)。
fn apply_resize(inner: &PtyInner, cols: u16, rows: u16) {
let g = inner.hpc.lock().unwrap_or_else(|e| e.into_inner());
let Some(hpc) = *g else { return };
let size = COORD {
X: clamp_dim(cols) as i16,
Y: clamp_dim(rows) as i16,
};
// SAFETY: hpc 是有效的伪控制台句柄(未关闭),size 已钳制到 i16 范围。
let hr = unsafe { ResizePseudoConsole(hpc, size) };
if hr < 0 {
crate::logger::log_warn("terminal", &format!("ResizePseudoConsole 失败(HRESULT 0x{hr:08X}"));
}
}
/// 把维度钳制到 COORD 的 i16 正数范围。
///
/// 为什么需要:`cols`/`rows` 来自前端 xterm 的测量结果,极端布局(超宽显示器 +
/// 极窄侧栏)下可能算出 0 或超出 32767,直接转 i16 会得到负数,ConPTY 会拒绝或
/// 产生诡异绘制。这里统一兜底到合理区间。
fn clamp_dim(v: u16) -> u16 {
v.clamp(1, 1000)
}
/// 在后台线程关闭 PTY(坑 1`ClosePseudoConsole` 可能阻塞)。
///
/// 调用方不等待。先置标志位保证幂等——读线程与退出等待线程都可能走到这里。
fn close_pty_background(inner: &Arc<PtyInner>) {
if inner.closed.swap(true, Ordering::SeqCst) {
return;
}
let inner = inner.clone();
std::thread::spawn(move || {
// 先释放写端:否则 PTY 侧仍认为有输入来源,其内部缓冲不会排空
{
let mut w = inner.writer.lock().unwrap_or_else(|e| e.into_inner());
*w = None;
}
let hpc = {
let mut g = inner.hpc.lock().unwrap_or_else(|e| e.into_inner());
g.take()
};
if let Some(hpc) = hpc {
// SAFETY: hpc 由本会话创建且尚未关闭(take 保证了唯一性)。
// 这个调用可能阻塞到所有句柄关闭,因此放在独立线程。
unsafe { ClosePseudoConsole(hpc) };
}
});
}
// ===== Session trait 实现 =====
impl Session for ConPtySession {
fn id(&self) -> &str {
&self.state.id
}
fn kind(&self) -> SessionKind {
SessionKind::Local
}
fn write(&self, data: &[u8]) -> Result<(), String> {
let mut g = self.inner.writer.lock().unwrap_or_else(|e| e.into_inner());
let Some(w) = g.as_mut() else {
return Err("会话已关闭,无法写入".to_string());
};
w.write_all(data).map_err(|e| format!("写入失败: {e}"))?;
w.flush().map_err(|e| format!("刷新失败: {e}"))
}
fn resize(&self, cols: u16, rows: u16) -> Result<(), String> {
*self.state.size.lock().unwrap_or_else(|e| e.into_inner()) = (cols, rows);
// 坑 2:首帧之前只入队。ConPTY 在进程尚未开始读 stdout 时对 resize
// 的处理不可靠(尺寸可能被吞掉),表现为 vim/htop 按 80×24 绘制而花屏。
if !self.inner.first_output_seen.load(Ordering::SeqCst) {
*self
.inner
.pending_size
.lock()
.unwrap_or_else(|e| e.into_inner()) = Some((cols, rows));
return Ok(());
}
apply_resize(&self.inner, cols, rows);
Ok(())
}
fn kill(&self) -> Result<(), String> {
// 幂等:重复 kill 不报错
if self.inner.closed.load(Ordering::SeqCst) {
return Ok(());
}
// 1. 先终止进程(若有)
if let Some(h) = self
.inner
.process
.lock()
.unwrap_or_else(|e| e.into_inner())
.as_ref()
.map(|h| h.as_raw_handle() as HANDLE)
{
// SAFETY: h 是本会话持有的有效进程句柄。
// 退出码 1 表示「被终止」,与正常退出 0 区分开,便于前端展示。
unsafe { TerminateProcess(h, 1) };
}
// 2. 关 PTY(后台线程,不阻塞调用方)
close_pty_background(&self.inner);
// 3. 状态置为 Closed 并发事件
*self.state.state.lock().unwrap_or_else(|e| e.into_inner()) = SessionState::Closed;
let _ = self.app.emit(
crate::terminal::events::TERMINAL_EXIT,
crate::terminal::events::ExitPayload {
session_id: self.state.id.clone(),
exit_code: Some(1),
reason: Some("killed".to_string()),
},
);
let _ = EXIT_HINT; // 提示文本由前端拼接,此处保留常量以备审计日志使用
Ok(())
}
fn info(&self) -> SessionInfo {
local_info(&self.state, SessionKind::Local)
}
fn set_state(&self, state: SessionState, error: Option<String>) {
*self.state.state.lock().unwrap_or_else(|e| e.into_inner()) = state;
if let Some(e) = error {
*self.state.error.lock().unwrap_or_else(|e| e.into_inner()) = Some(e);
}
let _ = self
.app
.emit(crate::terminal::events::TERMINAL_STATE, self.info());
}
fn set_title(&self, title: &str) {
*self.state.title.lock().unwrap_or_else(|e| e.into_inner()) = title.to_string();
}
fn set_detached(&self, detached: bool) {
self.state.detached.store(detached, Ordering::Relaxed);
}
/// 本地会话的编码切换语义与 SSH 不同:**只影响输出的字节→文本解释**,
/// 不影响输入(Windows 控制台走 UTF-16 转换,`WriteFile` 收到的一直是
/// UTF-8,前端不必按目标代码页重编码)。因此这里不做输入侧处理。
fn set_encoding(&self, encoding: &str) -> bool {
self.state.set_encoding(encoding)
}
fn emit_state(&self) {
let _ = self
.app
.emit(crate::terminal::events::TERMINAL_STATE, self.info());
}
}
// ===== windows-sys 中未随 feature 导出的 API 声明 =====
//
// `InitializeProcThreadAttributeList` / `UpdateProcThreadAttribute` /
// `DeleteProcThreadAttributeList` 属于 `Win32_System_Threading`,但 windows-sys
// 0.52 未把它们纳入已启用的 feature 面。用 extern "system" 直接声明,
// 避免为了三个函数额外开启一个大 feature(会显著增加编译时间)。
unsafe extern "system" {
fn InitializeProcThreadAttributeList(
lp_attribute_list: *mut std::ffi::c_void,
dw_attribute_count: u32,
dw_flags: u32,
lp_size: *mut usize,
) -> i32;
fn UpdateProcThreadAttribute(
lp_attribute_list: *mut std::ffi::c_void,
dw_flags: u32,
attribute: usize,
lp_value: *const std::ffi::c_void,
cb_size: usize,
lp_previous_value: *mut std::ffi::c_void,
lp_return_size: *mut usize,
) -> i32;
fn DeleteProcThreadAttributeList(lp_attribute_list: *mut std::ffi::c_void);
}
+6
View File
@@ -0,0 +1,6 @@
//! 终端进程后端。
//!
//! `conpty` 是本地 Shell 的实现(Windows ConPTY)。未来若需要支持非 Windows
//! 平台,在此目录下新增 `unix_pty` 即可,上层只依赖 [`super::session::Session`]。
pub mod conpty;
+629
View File
@@ -0,0 +1,629 @@
//! 会话抽象与注册表。
//!
//! ## 为什么不用 `crate::process_manager::ProcessManager`
//!
//! `ProcessManager` 是为「单例常驻守护进程」设计的(mihomo 内核):一个模块 ID
//! 对应一个进程,进程崩溃即按策略重启,配置在模块 `index.ts` 里静态声明。
//! 终端要的是完全不同的语义——
//!
//! - **N 个会话并存**,每个会话生命周期独立(开一个标签 = 多一个会话);
//! - 需要**双向流式 I/O**(写 stdin、读 stdout),而不只是「启动/停止/看状态」;
//! - 崩溃**不应重启**(重启一个 shell 只是给用户一个空提示符,毫无意义),
//! 而应把退出码报给前端做展示;
//! - 会话可能因为「网络断开」而进入 `degraded` 而不是 `stopped`。
//!
//! 把这四条塞进 `ProcessManager` 会撑坏它的抽象,因此终端模块自带一套。
//!
//! ## `Session` trait 的价值
//!
//! 本地(ConPTY)与远程(SSH)两种后端在「I/O 形态」上高度一致:都是一个字节流,
//! 都要支持 write / resize / kill / 输出订阅。抽成 trait 后,上层的命令层
//! `terminal_write` / `terminal_resize` / …)与多会话管理逻辑**只需写一遍**。
//!
//! 两处刻意的不对称(值得记下,避免后来者以为是疏漏):
//! - `resize`ConPTY 需要显式调用 `ResizePseudoConsole`SSH 是发
//! `window-change` 请求。两者都要,故都在 trait 上。
//! - `exit_code`:本地拿得到真实退出码;SSH 会话通道关闭时通常拿不到,
//! 统一返回 `None`,由前端展示为「连接已关闭」。
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::Arc;
use dashmap::DashMap;
use serde::{Deserialize, Serialize};
use specta::Type;
use super::pty::conpty::ConPtySession;
/// 会话标识。
pub type SessionId = String;
/// 会话状态机。
///
/// `degraded` 专为 SSH 保留:TCP 断了但会话对象还在(可以尝试重连),
/// 与 `closed`(已终结,需重开)是两回事。本地会话不会进入此态。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub enum SessionState {
/// 已创建,尚未开始握手/启动
Idle,
/// 正在连接(SSH 握手 / 本地启动进程)
Connecting,
/// 正在认证(仅 SSH
Authenticating,
/// 已建立,可交互
Established,
/// 连接降级(SSH 断线,可尝试重连)
Degraded,
/// 已关闭(进程退出或用户主动关闭)
Closed,
/// 异常(启动失败、握手失败、致命错误)
Failed,
}
/// 会话类型(决定前端展示哪些能力)。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub enum SessionKind {
Local,
Ssh,
}
/// 会话元信息(回传前端;**不含任何 I/O 句柄**)。
#[derive(Debug, Clone, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct SessionInfo {
pub id: SessionId,
pub kind: SessionKind,
/// 标题(本地为 Shell 名,SSH 为 用户@主机)
pub title: String,
pub state: SessionState,
/// 终端当前列数
pub cols: u16,
/// 终端当前行数
pub rows: u16,
/// 当前工作目录(由 OSC 7 hook 上报;未知为空串)
pub cwd: String,
/// 会话创建时间(Unix 毫秒)
pub created_at: u64,
/// 进程退出码(本地可拿到;SSH 通常为 None)
pub exit_code: Option<i32>,
/// 失败原因(state 为 Failed 时非空)
pub error: Option<String>,
/// 远端标识(本地为 shell idSSH 为 host id
pub target_id: String,
/// 是否由独立窗口承载(决定了关闭窗口时销毁还是保留会话)
pub detached: bool,
/// 会话的字符编码(规范名,如 `gbk` / `utf-8`)。
///
/// 回传前端的原因:**终端画面的字节→文本转换在前端做**。xterm 的
/// `write` 接受 `Uint8Array`,解码策略由前端按这个字段决定。若放在 Rust 侧
/// 转换,前端就失去了「用户临时切编码重看历史内容」的能力——
/// 而重看历史恰恰是老服务器场景下最常用的操作。
pub encoding: String,
/// 是否正在记录会话日志(`audit` 模块)。前端据此显示工具栏开关状态。
pub logging: bool,
}
/// 会话抽象:本地 ConPTY 与 SSH 两种后端都实现它。
///
/// 所有方法都要求 `&self`(配合内部可变性)而不是 `&mut self`:会话句柄需要被
/// 多个来源同时访问(输出读线程、命令层、退出监听),用 `&mut` 会把它们串行化。
pub trait Session: Send + Sync {
fn id(&self) -> &str;
fn kind(&self) -> SessionKind;
/// 写入数据(前端键入的字符、粘贴内容)。
fn write(&self, data: &[u8]) -> Result<(), String>;
/// 通知终端尺寸变化。
///
/// 实现方**必须容忍早期调用**:ConPTY 在进程刚开始输出时 resize 有竞态,
/// 需要排队到首帧之后再应用(详见 `pty::conpty`)。
fn resize(&self, cols: u16, rows: u16) -> Result<(), String>;
/// 终止会话。幂等:对已关闭的会话调用不应报错。
fn kill(&self) -> Result<(), String>;
/// 快照当前元信息。
fn info(&self) -> SessionInfo;
/// 更新状态(供内部线程在握手/退出时调用)。
fn set_state(&self, state: SessionState, error: Option<String>);
/// 更新标题。
fn set_title(&self, title: &str);
/// 标记是否由独立窗口承载。
fn set_detached(&self, detached: bool);
/// 切换字符编码。返回 `false` 表示编码名不被支持。
///
/// # 为什么放进 trait 而不是走 `as_ssh()` 下转换
///
/// 本地 ConPTY 会话也需要它 —— 用户的 Windows 控制台若是 936 代码页,
/// 本地会话同样会乱码,只是默认值不同。放进 trait 后命令层不必先判断
/// 会话类型再分派,两条后端路径只有一处实现点。
fn set_encoding(&self, encoding: &str) -> bool;
/// 广播当前会话快照到前端(`TERMINAL_STATE` 事件)。
///
/// 用于「元信息变了但状态没变」的场景(改编码、改标题),此时
/// 既有的状态机路径不会触发广播,需要显式一次。
fn emit_state(&self);
/// 向下转换成 SSH 会话(仅 SFTP 面板需要)。
///
/// # 为什么用「返回 `Option<&SshSession>`」而不是 `Any` 向下转换
///
/// `Any::downcast_ref` 要求 trait 对象是 `'static` 且需要引入 `std::any`
/// 更关键的是**编译期一无所知**:调用方写错目标类型要到运行期才炸。
/// 这里给出一个具名方法,`SshSession` 的返回 `Some(self)`、其余返回 `None`
/// 类型由签名保证,调用点的 `ok_or_else` 也就有了明确的中文错误提示。
///
/// 默认实现返回 `None`(本地会话不需要覆写)。
fn as_ssh(&self) -> Option<&super::ssh::SshSession> {
None
}
}
/// 会话注册表。
///
/// 用 `DashMap` 而不是 `Mutex<HashMap>`:会话的读操作极其频繁(每次输出批次都要
/// 查表找会话),而写操作少(创建/销毁)。分片锁能让多个会话的 I/O 线程互不等待。
///
/// 注意 `Arc<dyn Session>`:注册表持有一份,各 I/O 线程各持一份,生命周期由
/// 引用计数管理。**不使用 `Weak`**——会话的存活由用户显式关闭决定,不该因为
/// 某个线程退出而被回收。
pub struct SessionRegistry {
sessions: DashMap<SessionId, Arc<dyn Session>>,
/// 会话 id 发生器
next_id: AtomicU64,
}
impl SessionRegistry {
pub fn new() -> Self {
Self {
sessions: DashMap::new(),
next_id: AtomicU64::new(1),
}
}
/// 生成下一个会话 id。
///
/// 形如 `s1` / `s2`:短、可读、便于日志检索。不用 UUID 的理由是这个 id 会
/// 出现在窗口 label`terminal-window-s1`)与日志里,UUID 会让两者都难读。
/// 会话 id 只在本次进程生命周期内有效,重启后不保证不重复,因此无需全局唯一性。
pub fn next_session_id(&self) -> SessionId {
let n = self.next_id.fetch_add(1, Ordering::Relaxed);
format!("s{n}")
}
pub fn insert(&self, session: Arc<dyn Session>) {
self.sessions.insert(session.id().to_string(), session);
}
pub fn get(&self, id: &str) -> Option<Arc<dyn Session>> {
self.sessions.get(id).map(|e| e.value().clone())
}
/// 移除会话(**不调用 kill**,由调用方决定是否先终止)。
pub fn remove(&self, id: &str) -> Option<Arc<dyn Session>> {
self.sessions.remove(id).map(|(_, v)| v)
}
pub fn list(&self) -> Vec<SessionInfo> {
let mut list: Vec<SessionInfo> = self.sessions.iter().map(|e| e.value().info()).collect();
// 按创建时间排序,保证前端标签顺序稳定(DashMap 的迭代顺序不确定)
list.sort_by_key(|s| s.created_at);
list
}
pub fn len(&self) -> usize {
self.sessions.len()
}
/// 关闭并移除所有会话(应用退出时调用)。
///
/// 逐个 `kill` 后清表。**不做等待**:退出路径上不能阻塞(ConPTY 的
/// `ClosePseudoConsole` 会阻塞到所有句柄关闭,见 `pty::conpty`)。
/// 进程终止时 OS 会回收残留资源,这里是「尽力而为」。
pub fn close_all(&self) {
let ids: Vec<String> = self.sessions.iter().map(|e| e.key().clone()).collect();
for id in ids {
if let Some(s) = self.get(&id) {
if let Err(e) = s.kill() {
crate::logger::log_warn(
"terminal",
&format!("关闭会话 {id} 失败(退出路径,忽略): {e}"),
);
}
}
// 会话日志收尾(flush + 移除条目;与 close 命令路径保持一致)
crate::terminal::audit::cleanup(&id);
self.remove(&id);
}
}
}
impl Default for SessionRegistry {
fn default() -> Self {
Self::new()
}
}
/// 为一个新会话分配终端默认尺寸。
///
/// 80×24 是 VT 规范的经典默认值。前端挂载 xterm 后会立刻上报真实尺寸,
/// 这里的值只在「创建 → 首帧」之间短暂生效。
pub const DEFAULT_COLS: u16 = 80;
pub const DEFAULT_ROWS: u16 = 24;
/// 本地会话的共享状态(供 `ConPtySession` 与命令层共用)。
///
/// 独立成一个结构而不是塞进 `ConPtySession`,是因为状态字段的读写来自
/// 多个线程(命令层、读线程、退出监听线程),集中放置便于审计加锁范围。
pub struct LocalSessionState {
pub id: SessionId,
pub target_id: String,
/// 会话类型(本地 ConPTY / SSH)。
///
/// # 为什么存在这里而不是只由会话对象自己知道
///
/// `scan_control_sequences` 是**自由函数**ConPTY 与 SSH 两个后端共用),
/// 它只拿到 `LocalSessionState` 而拿不到会话对象。命令历史落库需要区分
/// 「target_id 是 shell id 还是主机 id」才能查对显示名 ——
/// 没有这个字段就只能靠 `target_id` 的形式去猜,那是不可靠的。
pub kind: SessionKind,
pub title: std::sync::Mutex<String>,
pub state: std::sync::Mutex<SessionState>,
pub error: std::sync::Mutex<Option<String>>,
pub cwd: std::sync::Mutex<String>,
pub size: std::sync::Mutex<(u16, u16)>,
pub created_at: u64,
pub exit_code: std::sync::Mutex<Option<i32>>,
pub detached: std::sync::atomic::AtomicBool,
/// 会话的字符编码(`encoding::normalize` 之后的规范名,如 `gbk` / `utf-8`)。
///
/// 放在这里而不是让读线程从 `SshConnectParams` 持有:编码在会话存续期间
/// **可能被用户改**(连上后发现是 GBK,在状态栏切一下),此时需要立即生效。
/// 用 `Mutex<String>` 而非 `Arc<str>` 就是为了支持这个运行时变更。
pub encoding: std::sync::Mutex<String>,
}
impl LocalSessionState {
pub fn new(id: SessionId, target_id: String, title: String) -> Self {
Self::with_encoding(id, target_id, title, SessionKind::Local, "utf-8")
}
/// 带编码与类型构造。
///
/// `kind` 由**创建方**传入而不是从 `target_id` 推断:本地会话的 target_id 是
/// shell id、SSH 会话的是主机 id,两者都是任意字符串,形式上看不出区别。
/// 让调用方(`ConPtySession::spawn` / `SshSession::spawn`)显式声明是唯一可靠的来源。
pub fn with_encoding(
id: SessionId,
target_id: String,
title: String,
kind: SessionKind,
encoding: &str,
) -> Self {
Self {
id,
target_id,
kind,
title: std::sync::Mutex::new(title),
state: std::sync::Mutex::new(SessionState::Idle),
error: std::sync::Mutex::new(None),
cwd: std::sync::Mutex::new(String::new()),
size: std::sync::Mutex::new((DEFAULT_COLS, DEFAULT_ROWS)),
created_at: now_millis(),
exit_code: std::sync::Mutex::new(None),
detached: std::sync::atomic::AtomicBool::new(false),
encoding: std::sync::Mutex::new(crate::terminal::encoding::normalize(encoding)),
}
}
/// 是否为 SSH 会话(供命令历史等需要区分来源的场景)。
pub fn is_ssh(&self) -> bool {
matches!(self.kind, SessionKind::Ssh)
}
/// 当前编码(供读线程与命令层读取)。
pub fn encoding(&self) -> String {
self.encoding
.lock()
.unwrap_or_else(|e| e.into_inner())
.clone()
}
/// 切换编码。返回 `false` 表示编码名不被支持(调用方应回滚 UI)。
pub fn set_encoding(&self, encoding: &str) -> bool {
let norm = crate::terminal::encoding::normalize(encoding);
if !crate::terminal::encoding::is_supported(&norm) {
return false;
}
*self.encoding.lock().unwrap_or_else(|e| e.into_inner()) = norm;
true
}
}
/// 当前 Unix 毫秒时间戳。
pub fn now_millis() -> u64 {
use std::time::{SystemTime, UNIX_EPOCH};
SystemTime::now()
.duration_since(UNIX_EPOCH)
.map(|d| d.as_millis() as u64)
.unwrap_or(0)
}
// ===== 控制序列扫描(ConPTY / SSH 共用) =====
/// `carry` 缓冲上限。正常 OSC 序列只有几十字节,超过即视为畸形数据。
///
/// 没有上限时,一段缺终止符的畸形输出(比如二进制文件被 `cat` 出来)
/// 会让 `carry` 无限增长,最终吃满内存。
const MAX_OSC_CARRY: usize = 8 * 1024;
/// 扫描输出批次里的控制序列,把结果落到会话状态、广播事件、并在命令边界处落库历史。
///
/// # 为什么两个后端共用这一份(此前 ConPTY 与 SSH 各有一份几乎相同的拷贝)
///
/// 两份拷贝的差异只有一处:SSH 需要按会话编码二次解码 OSC 载荷
/// (GBK 服务器上的标题与 cwd 会乱码)。其余(carry 拼接、上限防御、
/// cwd 变更判定、只上报变化量)**完全一致**。
///
/// P1 新增命令历史时这个问题变成硬约束:若继续维持两份拷贝,
/// 「OSC 133 解析 + 落库」就要在两处各写一遍 —— 任何一处漏掉都表现为
/// 「只有本地会话有历史」或「只有 SSH 有历史」这类**按后端分支的诡异 bug**,
/// 而且因为两条路径平时都各自能用,极难在测试中发现。
///
/// 编码与类型都从 `state` 上取(`state.encoding()` / `state.kind` /
/// `state.is_ssh()`),所以这个函数不需要任何按后端分派的参数。
///
/// # 关于 `emit_state` 的差异
///
/// 标题变化时要广播 `TERMINAL_STATE`,而 ConPTY 走 `terminal::emit_state`
/// (带显式 `final_state`)、SSH 走 `local_info(.., Ssh)`。统一为
/// `local_info(state, state.kind)` + 保持当前 state 不变即可 ——
/// 两条路径的原意都是「状态没变,只是标题变了」,用 `state.kind` 恰好等价。
pub fn scan_control_sequences(
app: &tauri::AppHandle,
state: &LocalSessionState,
carry: &mut Vec<u8>,
chunk: &[u8],
sim: &CommandAccumulator,
) {
use tauri::Emitter as _;
carry.extend_from_slice(chunk);
let parsed = crate::terminal::shell::parse_control_sequences(carry);
if parsed.consumed > 0 {
carry.drain(..parsed.consumed);
}
// 防御:畸形数据(没有终止符的超长序列)会让 carry 无限增长
if carry.len() > MAX_OSC_CARRY {
carry.clear();
}
// 编码转换:OSC 载荷与终端画面**共用同一套字节**,因此也必须用会话编码解码。
// 不转的话,GBK 服务器上 `echo -e "\e]0;测试\a"` 这种标题会变成乱码。
// 注意只在会话编码不是 UTF-8 时才有实际效果 —— `parse_control_sequences`
// 内部已按 UTF-8 有损解码过一轮,这一步是在其基础上的「纠正」。
let enc = state.encoding();
let recode = |v: Vec<String>| -> Vec<String> {
if enc == "utf-8" {
return v;
}
v.into_iter()
.map(|s| crate::terminal::encoding::decode(s.as_bytes(), &enc))
.collect()
};
let cwds = recode(parsed.cwds);
let titles = recode(parsed.titles);
if let Some(cwd) = cwds.last() {
let changed = {
let mut cur = state.cwd.lock().unwrap_or_else(|e| e.into_inner());
if *cur == *cwd {
false
} else {
*cur = cwd.clone();
true
}
};
if changed {
let _ = app.emit(
crate::terminal::events::TERMINAL_CWD,
crate::terminal::events::CwdPayload {
session_id: state.id.clone(),
cwd: cwd.clone(),
},
);
}
}
if let Some(title) = titles.last() {
let changed = {
let mut cur = state.title.lock().unwrap_or_else(|e| e.into_inner());
if *cur == *title {
false
} else {
*cur = title.clone();
true
}
};
if changed {
let _ = app.emit(
crate::terminal::events::TERMINAL_STATE,
local_info(state, state.kind),
);
}
}
// 命令边界:累积到 D 才落库(见 `CommandAccumulator` 的说明)
sim.absorb(app, state, &parsed.marks);
}
/// 跨批次累积「当前正在执行的命令」,在 OSC 133 的 `D` 标记处落库。
///
/// # 为什么需要累积而不是收到 D 就存
///
/// 协议里命令文本(`1337;Cmd=`)与结束标记(`133;D`)是**两个独立序列**
/// 顺序由 shell hook 决定,且可能被切在不同批次里。若收到 D 就立刻用
/// 「当前已知的命令」落库,遇到「D 先到、Cmd 后到」的顺序会存下**上一条**命令 ——
/// 错位一条,且只在特定时序下复现,是最难查的一类 bug。
///
/// 因此:Cmd 到达时先暂存,D 到达时用暂存的文本落库并清空。
/// 若 D 到达时没有暂存文本(例如 hook 未被注入的老会话),则跳过 ——
/// 记一条空命令进历史毫无意义。
///
/// # 为什么锁粒度是「整段」
///
/// 一个批次里可能有多组 Cmd/D(`ls; pwd` 在极快执行时被一次性读取)。
/// 逐条加锁会让「暂存 → 落库 → 清空」三步之间可能被另一批次的同三步插入,
/// 产生交叉覆盖。锁住整段即可,临界区里只有内存操作与一次 SQLite 写入。
///
/// # 挂载位置
///
/// 由调用方(两个后端的读线程)持有,与会话同生命周期。不放进
/// `LocalSessionState`:那个结构是**状态**(可被任意线程读),
/// 而这个是**读线程的私有工作变量**,混在一起会让「谁在改它」变得不清晰。
pub struct CommandAccumulator {
inner: std::sync::Mutex<Option<String>>,
}
impl CommandAccumulator {
pub fn new() -> Self {
Self {
inner: std::sync::Mutex::new(None),
}
}
fn absorb(
&self,
app: &tauri::AppHandle,
state: &LocalSessionState,
marks: &[crate::terminal::shell::CommandMark],
) {
use crate::terminal::shell::CommandMark;
if marks.is_empty() {
return;
}
let mut pending = self.inner.lock().unwrap_or_else(|e| e.into_inner());
for mark in marks {
match mark {
CommandMark::Command(cmd) => {
// 覆盖而非追加:`history 1` 总是给最新一条,
// 同一批里出现两次 Cmd 时后者才是当前命令
*pending = Some(cmd.clone());
}
CommandMark::End(code) => {
let Some(cmd) = pending.take() else {
continue;
};
if cmd.trim().is_empty() {
continue;
}
// 记录失败**不影响终端**:历史是辅助功能,
// 磁盘满 / 库损坏都不该让用户的命令执行流程中断。
if let Err(e) = record_command(app, state, &cmd, *code) {
crate::logger::log_error(
"terminal",
&format!("写入命令历史失败(不影响会话): {e}"),
);
}
}
CommandMark::Start => {}
}
}
}
}
impl Default for CommandAccumulator {
fn default() -> Self {
Self::new()
}
}
/// 把一条命令送进历史库。
///
/// 从 `AppHandle` 反查 `TerminalManager`:本函数由读线程调用,那里只有
/// `AppHandle` 与会话状态,没有 manager 引用。走 Tauri 的 state 查询
/// 是这里唯一可行的方式(也是项目里 `manager(&app)` 的既有范式)。
///
/// # 落库在后台 writer
///
/// 本函数位于**输出热路径**(OSC 133 的 D 标记到达时读线程正在转发输出),
/// 因此只做两次轻量读(显示名持锁读小字段、cwd 克隆)+ 一次 `mpsc::send`。
/// SQLite 写入与 prune 由 [`crate::terminal::history::spawn_writer`] 的
/// writer 线程攒批完成(通道断开时 manager 内部有同步兜底)。
fn record_command(
app: &tauri::AppHandle,
state: &LocalSessionState,
command: &str,
exit_code: Option<i32>,
) -> Result<(), String> {
use tauri::Manager as _;
let Some(mgr) = app.try_state::<crate::terminal::TerminalManager>() else {
return Ok(()); // 应用正在退出,manager 已释放 —— 静默跳过
};
// 解析显示名。本地会话的 target_id 是 shell idSSH 会话是主机 id
// 两者对用户是不同含义,所以分开查。
//
// 显示名**随记录一起存**(而不是查询时再联表):主机被删除后,
// 若只有 id,历史列表里那一列会变成一串无意义的 hash。
let name = mgr.display_name(&state.target_id, state.is_ssh());
let cwd = state.cwd.lock().unwrap_or_else(|e| e.into_inner()).clone();
mgr.queue_history(crate::terminal::history::HistoryEntry {
command: command.to_string(),
cwd,
host_id: state.target_id.clone(),
host_name: name,
ssh: state.is_ssh(),
exit_code,
});
Ok(())
}
/// 由本地会话状态组装 `SessionInfo`。
pub fn local_info(state: &LocalSessionState, kind: SessionKind) -> SessionInfo {
let (cols, rows) = *state.size.lock().unwrap_or_else(|e| e.into_inner());
SessionInfo {
id: state.id.clone(),
kind,
title: state
.title
.lock()
.unwrap_or_else(|e| e.into_inner())
.clone(),
state: *state.state.lock().unwrap_or_else(|e| e.into_inner()),
cols,
rows,
cwd: state.cwd.lock().unwrap_or_else(|e| e.into_inner()).clone(),
created_at: state.created_at,
exit_code: *state.exit_code.lock().unwrap_or_else(|e| e.into_inner()),
error: state
.error
.lock()
.unwrap_or_else(|e| e.into_inner())
.clone(),
target_id: state.target_id.clone(),
detached: state.detached.load(Ordering::Relaxed),
encoding: state.encoding(),
logging: crate::terminal::audit::is_logging(&state.id),
}
}
/// 供 `ConPtySession` 引用的类型别名,避免上层直接依赖 `pty` 模块。
pub type BoxedSession = Arc<dyn Session>;
/// 类型占位:确保 `ConPtySession` 在编译期满足 `Session` 契约。
/// 若 `ConPtySession` 漏实现某个方法,这里会直接编译失败(比等到使用处才报错更早)。
#[allow(dead_code)]
fn _assert_conpty_is_session(s: ConPtySession) -> BoxedSession {
Arc::new(s)
}
+928
View File
@@ -0,0 +1,928 @@
//! 终端模块设置的数据模型与默认值。
//!
//! 持久化位置:`{app_data_dir}/terminal/settings.json`(与 translate / music 同一范式)。
//! 容器级 `#[serde(default)]`:新增字段对旧配置文件是**向后兼容**的——缺字段取默认值
//! 而不是让整份设置反序列化失败,避免用户因为一次升级丢掉全部配置。
//!
//! 安全姿态(与 `crate::secrets` 的约定一致):**本结构里不允许出现任何明文凭据**。
//! SSH 密码、私钥 passphrase 一律进系统凭据管理器,本结构只保存它们的引用 id 与
//! 派生展示字段(如 `hasPassphrase`,由命令层回填,不落盘)。
use serde::{Deserialize, Serialize};
use specta::Type;
// ===== 本地 Shell =====
/// 本地 Shell 配置。
///
/// 探测到的 Shell 与用户自定义的 Shell 用同一结构表达:`detected` 为 true 表示
/// 由 [`super::shell::detect_shells`] 自动发现,前端只允许改启动参数而不可改路径
/// (路径已被验证存在,改错会让会话起不来)。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct ShellProfile {
/// 唯一标识(同时是新建会话时的 shellKey)
pub id: String,
/// 展示名称,如 "PowerShell 7"
pub name: String,
/// 可执行文件绝对路径
pub path: String,
/// 启动参数
pub args: Vec<String>,
/// 启动时的工作目录(空串表示用用户主目录)
pub cwd: String,
/// 环境变量覆盖(键值对;值为空串表示删除该变量)
pub env: Vec<EnvVar>,
/// Shell 类型:"powershell" | "cmd" | "bash" | "wsl"
///
/// 决定三件事:cwd 跟踪 hook 的注入方式、清屏命令、以及 OSC 7 的解析口径。
pub kind: String,
/// 是否由自动探测得到(true 时前端不可编辑 path)
pub detected: bool,
/// 是否在新建会话菜单中显示
pub enabled: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct EnvVar {
pub key: String,
pub value: String,
}
/// 手写 `Default` 而不是 derive`detected` 与 `enabled` 的默认值必须是
/// `true` / `true`derive 会给 `false`),而 `#[serde(default)]` 在容器级
/// 要求每个字段类型都实现 `Default`。两者不一致会导致「反序列化出来的
/// Shell 默认禁用」这种隐性 bug。
impl Default for ShellProfile {
fn default() -> Self {
Self {
id: String::new(),
name: String::new(),
path: String::new(),
args: Vec::new(),
cwd: String::new(),
env: Vec::new(),
kind: "bash".to_string(),
detected: true,
enabled: true,
}
}
}
/// 容器级 `#[serde(default)]` 要求字段类型实现 `Default`。
/// `EnvVar` 的「空值」语义就是空键空值,用 derive 的默认即可。
impl Default for EnvVar {
fn default() -> Self {
Self {
key: String::new(),
value: String::new(),
}
}
}
impl ShellProfile {
pub fn new(id: &str, name: &str, path: &str, kind: &str) -> Self {
Self {
id: id.to_string(),
name: name.to_string(),
path: path.to_string(),
args: Vec::new(),
cwd: String::new(),
env: Vec::new(),
kind: kind.to_string(),
detected: true,
enabled: true,
}
}
}
// ===== SSH 主机 =====
/// SSH 主机条目。
///
/// `id` 是凭据键名的一部分(`terminal-ssh-password-{id}`),**创建后不应修改**
/// 改了会让已存进凭据管理器的密码读不到。前端在编辑态需禁用该字段。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct SshHost {
pub id: String,
/// 展示别名(列表主标题)
pub name: String,
pub host: String,
pub port: u16,
pub username: String,
/// 认证方式:"key"(公钥,默认)| "password" | "agent"P1| "keyboard"P1
pub auth_method: String,
/// 公钥认证使用的密钥 id(指向 [`super::keys`] 的密钥库)
pub key_id: String,
/// 分组名(侧栏按此分组)
pub group: String,
/// 备注
pub note: String,
/// 标签色(前端用于状态点/分组标识)
pub color: String,
/// 是否收藏(置顶显示)
pub favorited: bool,
/// 连接超时(毫秒)
pub connect_timeout_ms: u64,
/// keep-alive 间隔(秒,0 表示关闭)
pub keepalive_secs: u64,
/// 启动目录(空串表示登录后进入默认目录)
pub remote_cwd: String,
/// 登录后自动执行的命令
pub startup_command: String,
/// 是否走代理模块(mihomo)。默认关闭:内网主机不该被绕进代理。
pub use_proxy: bool,
/// 跳板机链(ProxyJump):按连接顺序排列的主机 id。
///
/// 每一项引用**本主机列表里的另一台主机**(复用它的地址、账号与凭据),
/// 连接方向为 `本机 → jump_ids[0] → jump_ids[1] → … → 本主机`。
/// 空 = 直连。约束(命令层校验):不能引用自己、不能有环、
/// 链长上限 5、每一跳的认证方式必须是 key/password。
///
/// 用 id 引用而不是内联一份地址+凭据的理由:跳板机自己的密码/密钥
/// 存在凭据管理器里,按 id 复用可以避免同一台跳板机在多处配置里
/// 留下多份凭据副本(改密码时漏改一处就是连接事故)。
pub jump_ids: Vec<String>,
/// 终端的字符编码("utf-8" 默认 | "gbk" 等)。老服务器常见 GBK,中文环境刚需。
pub encoding: String,
}
impl Default for SshHost {
fn default() -> Self {
Self {
id: String::new(),
name: String::new(),
host: String::new(),
port: 22,
username: String::new(),
auth_method: "key".to_string(),
key_id: String::new(),
group: String::new(),
note: String::new(),
color: String::new(),
favorited: false,
connect_timeout_ms: 15_000,
keepalive_secs: 30,
remote_cwd: String::new(),
startup_command: String::new(),
use_proxy: false,
jump_ids: Vec::new(),
encoding: "utf-8".to_string(),
}
}
}
// ===== 外观 =====
/// 终端外观设置。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct AppearanceSettings {
/// 配色主题 id(内置若干,见前端 terminalThemes.ts
pub theme: String,
/// 是否跟随应用亮暗主题(开启时 `theme` 只作为亮/暗的取色基准)
pub follow_app_theme: bool,
/// 字体族(逗号分隔的 CSS font-family
pub font_family: String,
pub font_size: u32,
/// 行高倍数
pub line_height: f64,
/// 字母间距
pub letter_spacing: f64,
/// 光标样式:"block" | "bar" | "underline"
pub cursor_style: String,
/// 光标是否闪烁
pub cursor_blink: bool,
/// 滚动缓冲区行数。上限 200000:再高会显著吃内存且滚动查找变慢。
pub scrollback: u32,
/// 背景不透明度百分比(100 = 不透明)
pub opacity: u32,
/// 是否启用 GPU 渲染(addon-webgl)。极少数显卡驱动下有花屏问题,故给开关。
pub gpu_rendering: bool,
}
impl Default for AppearanceSettings {
fn default() -> Self {
Self {
theme: "thing-dark".to_string(),
follow_app_theme: true,
font_family: "Cascadia Mono, Consolas, Microsoft YaHei Mono, monospace".to_string(),
font_size: 14,
line_height: 1.2,
letter_spacing: 0.0,
cursor_style: "block".to_string(),
cursor_blink: true,
scrollback: 10_000,
opacity: 100,
gpu_rendering: true,
}
}
}
// ===== 快捷键 =====
/// 一条终端内快捷键绑定。
///
/// 只覆盖**终端内**(第二层)快捷键:全局快捷键(第一层)由 `crate::shortcut` 统一
/// 注册并做应用内冲突检测,不走这里;shell 原生快捷键(第三层)不做拦截。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct ShortcutBinding {
/// 动作标识,见前端 `terminalActions.ts`(如 "copy" / "newTab"
pub action: String,
/// 键位字符串,格式与 `crate::shortcut::parse_shortcut` 一致(如 "Ctrl+Shift+C"
pub keys: String,
/// 是否启用(关掉后该动作无快捷键,但仍可从菜单触发)
pub enabled: bool,
}
impl Default for ShortcutBinding {
fn default() -> Self {
Self {
action: String::new(),
keys: String::new(),
enabled: true,
}
}
}
// ===== 终端内选中行为 =====
/// 终端内选中行为。
///
/// # 为什么叫 `TerminalSelectionSettings` 而不是 `SelectionSettings`
///
/// 与 `translate::settings::SelectionSettings` 撞名。`tauri-specta` 的类型注册表
/// **全局按类型名索引**,重名会让 `export_bindings()` panic
/// `Detected multiple types with the same name`)。
/// specta 2.0.0-rc.25 的 derive 路径无法重命名导出类型
/// (详见 `history::TerminalHistoryPage` 的注释),只能改 Rust 标识符本身。
///
/// 注意:这是**第二个**独立引入的 `SelectionSettings`。新增跨模块共享名之前,
/// 先确认没有同名 `Type` 已存在 —— 否则会在**运行时启动阶段**才炸,
/// 而不是编译期(见 `TERMINAL_MODULE_PLAN.md` 坑 27)。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct TerminalSelectionSettings {
/// 选中即复制(受 Linux/macOS 习惯影响的用户会开;默认关,避免误触)
pub copy_on_select: bool,
/// 中键粘贴(X11 习惯;Windows 下默认关)
pub middle_click_paste: bool,
/// 右键行为:"menu"(默认,弹菜单)| "paste"(直接粘贴)| "select-word"
pub right_click: String,
/// 复制时是否去掉尾部空行
pub trim_trailing_newline: bool,
}
impl Default for TerminalSelectionSettings {
fn default() -> Self {
Self {
copy_on_select: false,
middle_click_paste: false,
right_click: "menu".to_string(),
trim_trailing_newline: true,
}
}
}
// ===== 布局 =====
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct LayoutSettings {
/// 关闭标签页时若会话仍有活跃进程,是否二次确认
pub confirm_close_running: bool,
/// 新建标签页时是否继承当前会话的工作目录
pub inherit_cwd: bool,
/// 侧栏默认是否展开
pub sidebar_open: bool,
/// 侧栏宽度(像素)
pub sidebar_width: u32,
/// 是否显示底部状态栏
pub show_status_bar: bool,
/// 分屏上限(1 = 不分屏,2 = 2×1,4 = 2×2)。
/// 上限刻意封在 4:分屏 × 标签 × 会话的组合复杂度会爆炸。
pub max_panes: u32,
}
impl Default for LayoutSettings {
fn default() -> Self {
Self {
confirm_close_running: true,
inherit_cwd: true,
sidebar_open: true,
sidebar_width: 220,
show_status_bar: true,
max_panes: 4,
}
}
}
// ===== 命令片段 =====
/// 一条命令片段。
///
/// # 为什么 `command` 里允许变量占位符
///
/// 常用命令的差异往往只在少数字段(路径、主机名、分支名)。若每条变体都要
/// 单独存一条,片段库会迅速退化成「一堆几乎一样的条目」,反而找不到东西。
/// 因此支持 `${name}` 形式占位符,执行前弹出表单逐个填写。
///
/// 占位符语法刻意用 `${name}` 而不是 `{name}`shell 自身大量使用 `{}`
/// `${VAR}`、`awk '{print}'`、brace expansion),单花括号会与用户的正常
/// 命令冲突,导致片段存进去就「被替换掉了」。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct CommandSnippet {
pub id: String,
/// 展示名称(列表主标题)
pub name: String,
/// 命令内容(可含 `${name}` 占位符)
pub command: String,
/// 说明(列表副标题,讲清这条命令做什么、有什么前提)
pub description: String,
/// 分组名(空串归入「未分组」)
pub group: String,
/// 占位符的默认值:name → 默认值。未列出的占位符默认空串。
pub defaults: std::collections::BTreeMap<String, String>,
/// 适用的 shell kind(空数组表示所有 shell 都适用)。
/// 例:`Get-ChildItem` 只对 powershell 有意义,不该出现在 cmd 的列表里。
pub shell_kinds: Vec<String>,
/// 仅对 SSH 会话显示(如 `sudo systemctl restart` 类远端操作)
pub ssh_only: bool,
/// 是否需要二次确认(危险命令,如 `rm -rf`)
pub confirm: bool,
/// 是否在片段面板中置顶
pub pinned: bool,
/// 创建时间(Unix 毫秒,用于列表排序)
pub created_at: u64,
}
impl Default for CommandSnippet {
fn default() -> Self {
Self {
id: String::new(),
name: String::new(),
command: String::new(),
description: String::new(),
group: String::new(),
defaults: std::collections::BTreeMap::new(),
shell_kinds: Vec::new(),
ssh_only: false,
confirm: false,
pinned: false,
created_at: 0,
}
}
}
/// 从命令文本中提取 `${name}` 占位符名(去重、保持出现顺序)。
///
/// 放在 Rust 侧而不是前端:占位符是**命令语义的一部分**,执行前的替换、
/// 校验与「哪些占位符还没填」的判断必须用同一套解析,
/// 两边各写一遍迟早会在边界情况(`$${x}`、`${a}${b}` 相邻)上分叉。
pub fn snippet_placeholders(command: &str) -> Vec<String> {
let bytes = command.as_bytes();
let mut out: Vec<String> = Vec::new();
let mut i = 0usize;
while i < bytes.len() {
// 找 `${`
if bytes[i] == b'$' && i + 1 < bytes.len() && bytes[i + 1] == b'{' {
// `$${x}` 是字面量 `${x}`(转义),跳过
let escaped = i > 0 && bytes[i - 1] == b'$';
if !escaped {
if let Some(end) = command[i + 2..].find('}') {
let name = &command[i + 2..i + 2 + end];
// 占位符名限定为标识符形态,避免把 `${VAR:-default}` 这类
// shell 参数展开语法误当成占位符
if !name.is_empty()
&& name
.chars()
.all(|c| c.is_ascii_alphanumeric() || c == '_' || c == '-')
&& !out.iter().any(|x| x == name)
{
out.push(name.to_string());
}
i = i + 2 + end + 1;
continue;
}
}
}
i += 1;
}
out
}
/// 用给定值替换命令里的占位符。
///
/// 未提供的占位符**保持原样**(不替换成空串):静默替换成空串会让
/// `rm -rf ${dir}` 变成 `rm -rf ` —— 一个参数缺失的命令可能比一个
/// 显式报错的命令危险得多。调用方应先校验所有占位符都有值。
pub fn snippet_render(command: &str, values: &std::collections::BTreeMap<String, String>) -> String {
let mut out = String::with_capacity(command.len());
let bytes = command.as_bytes();
let mut i = 0usize;
while i < bytes.len() {
if bytes[i] == b'$' && i + 1 < bytes.len() && bytes[i + 1] == b'{' {
let escaped = i > 0 && bytes[i - 1] == b'$';
if !escaped {
if let Some(end) = command[i + 2..].find('}') {
let name = &command[i + 2..i + 2 + end];
if !name.is_empty()
&& name
.chars()
.all(|c| c.is_ascii_alphanumeric() || c == '_' || c == '-')
{
match values.get(name) {
Some(v) => out.push_str(v),
None => out.push_str(&command[i..i + 2 + end + 1]),
}
i = i + 2 + end + 1;
continue;
}
}
}
}
// 逐字符拷贝,注意 UTF-8 多字节边界:这里直接按字节推进会让
// 中文字符被切断。故用 chars().next() 取整字符的长度。
let ch = command[i..].chars().next().unwrap_or(' ');
out.push(ch);
i += ch.len_utf8();
}
out
}
// ===== 密钥存储(仅元数据)=====
/// 密钥库的单个条目(元数据,**不含私钥内容**)。
///
/// 私钥本体存放在 `{app_data_dir}/terminal/keys/` 的独立文件里(可能是几 KB,
/// 塞进 Windows 凭据管理器不可靠——单条有大小上限),passphrase 才进凭据管理器。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct KeyMeta {
pub id: String,
/// 展示名称
pub name: String,
/// 算法:"ed25519" | "rsa" | "ecdsa"
pub algorithm: String,
/// 位数 / 曲线(RSA 2048/3072/4096ECDSA P-256/P-384/P-521ed25519 固定空串)
pub bits: u32,
/// 公钥指纹(SHA256OpenSSH 展示格式 `SHA256:xxxx`
pub fingerprint: String,
/// 公钥内容(`ssh-ed25519 AAAA... comment`),用于一键复制
pub public_key: String,
/// 注释
pub comment: String,
/// 私钥文件名(`keys/` 目录下,相对名)
pub file_name: String,
/// 创建时间(RFC3339
pub created_at: String,
/// 是否由 ssh-agent 托管(P1
pub in_agent: bool,
}
impl Default for KeyMeta {
fn default() -> Self {
Self {
id: String::new(),
name: String::new(),
algorithm: "ed25519".to_string(),
bits: 0,
fingerprint: String::new(),
public_key: String::new(),
comment: String::new(),
file_name: String::new(),
created_at: String::new(),
in_agent: false,
}
}
}
// ===== 安全 =====
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct SecuritySettings {
/// 主机密钥策略:"ask"(默认,首次连接必须显式确认指纹)。
///
/// **不提供 "auto-accept" 选项**TOFU 静默接受是 MITM 的入口,
/// 属于代码层不该给用户的开关。
pub host_key_policy: String,
/// 指纹变更时是否阻断(**默认 true**)。关掉会让中间人攻击无声通过,
/// 因此前端需以红色风险提示呈现该开关。
pub block_on_fingerprint_change: bool,
/// 是否记录连接审计日志(P2,默认关;开启后输入输出落盘,含脱敏)
pub audit_log: bool,
}
impl Default for SecuritySettings {
fn default() -> Self {
Self {
host_key_policy: "ask".to_string(),
block_on_fingerprint_change: true,
audit_log: false,
}
}
}
// ===== 根结构 =====
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct TerminalSettings {
/// 结构版本号(用于后续迁移判断)
pub version: u32,
/// 本地 Shell 配置(探测结果 + 用户自定义,合并存放)
pub shells: Vec<ShellProfile>,
/// SSH 主机条目
pub hosts: Vec<SshHost>,
/// 密钥元数据
pub keys: Vec<KeyMeta>,
pub appearance: AppearanceSettings,
pub layout: LayoutSettings,
pub shortcuts: Vec<ShortcutBinding>,
pub selection: TerminalSelectionSettings,
pub security: SecuritySettings,
/// 「关闭标签页时确认」等行为的白名单:某些会话可豁免确认
pub close_confirm_exempt: Vec<String>,
/// 上次使用的 Shell id(新建会话时的默认选中项)
pub last_shell_id: String,
/// 命令片段库
pub snippets: Vec<CommandSnippet>,
/// 会话模板(一键拉起一组会话 + 布局)
pub templates: Vec<SessionTemplate>,
}
impl Default for TerminalSettings {
fn default() -> Self {
Self {
version: 2,
shells: Vec::new(),
hosts: Vec::new(),
keys: Vec::new(),
appearance: AppearanceSettings::default(),
layout: LayoutSettings::default(),
shortcuts: default_shortcuts(),
selection: TerminalSelectionSettings::default(),
security: SecuritySettings::default(),
close_confirm_exempt: Vec::new(),
last_shell_id: String::new(),
snippets: Vec::new(),
templates: Vec::new(),
}
}
}
/// 会话模板:一键拉起一组会话并排成布局。
///
/// 拉起语义:`entries[0]` 作为主面板,其余依次以分屏面板加入
/// (受 `layout.maxPanes` 上限约束,超过 4 个的条目被忽略——
/// WebGL 上下文上限决定了可见面板不可能超过 4,见 useSessionStream 说明)。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct SessionTemplate {
pub id: String,
pub name: String,
/// 创建时间(Unix 毫秒;模板列表按此排序)
pub created_at: u64,
pub entries: Vec<TemplateEntry>,
}
impl Default for SessionTemplate {
fn default() -> Self {
Self {
id: String::new(),
name: String::new(),
created_at: 0,
entries: Vec::new(),
}
}
}
/// 模板中的一个会话条目。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct TemplateEntry {
/// `"local"`shell| `"ssh"`(主机)
pub kind: String,
/// 本地 = shell idSSH = host id。拉起时实时解析——
/// 模板只存引用,不快照账号密码(那些在凭据管理器里按 id 存取)。
pub target_id: String,
/// 保存时的展示名快照(仅用于模板列表显示;target 失效时前端据此标注)
pub label: String,
}
impl Default for TemplateEntry {
fn default() -> Self {
Self {
kind: "local".to_string(),
target_id: String::new(),
label: String::new(),
}
}
}
/// 默认终端内快捷键。
///
/// 键位选择依据(Windows Terminal 惯例 + 与项目既有全局快捷键避让):
/// - 复制粘贴用 `Ctrl+Shift+C/V` 而**不是** `Ctrl+C/V``Ctrl+C` 在终端里必须是
/// SIGINT,任何对它做复制映射的设计都会破坏 `^C` 中断,这是不可接受的。
/// - 新建/关闭标签用 `Ctrl+Shift+T/W`,与浏览器习惯一致。
/// - 跳转标签用 `Alt+1..9``Ctrl+数字` 已被翻译模块的 `Ctrl+2`(翻译面板)占用,
/// 而 `Alt+数字` 在终端里通常不产生控制字符,冲突面最小。
pub fn default_shortcuts() -> Vec<ShortcutBinding> {
let pairs: &[(&str, &str)] = &[
("copy", "Ctrl+Shift+C"),
("paste", "Ctrl+Shift+V"),
("newTab", "Ctrl+Shift+T"),
("closeTab", "Ctrl+Shift+W"),
("nextTab", "Ctrl+Tab"),
("prevTab", "Ctrl+Shift+Tab"),
("splitRight", "Ctrl+Shift+D"),
("splitDown", "Ctrl+Shift+E"),
("closePane", "Ctrl+Shift+Q"),
("search", "Ctrl+Shift+F"),
("clear", "Ctrl+Shift+K"),
("fontIncrease", "Ctrl+="),
("fontDecrease", "Ctrl+-"),
("fontReset", "Ctrl+0"),
("toggleSftp", "Ctrl+Shift+P"),
("snippets", "Ctrl+Shift+S"),
// 历史用 HHistory)。不与 `Ctrl+Shift+H`(替换)冲突 ——
// 终端里没有「替换」这个动作。
("history", "Ctrl+Shift+H"),
("renameTab", "F2"),
("sessionSwitcher", "Ctrl+Shift+O"),
];
pairs
.iter()
.map(|(action, keys)| ShortcutBinding {
action: action.to_string(),
keys: keys.to_string(),
enabled: true,
})
.collect()
}
impl TerminalSettings {
/// 按 id 找主机。
pub fn host(&self, id: &str) -> Option<&SshHost> {
self.hosts.iter().find(|h| h.id == id)
}
/// 按 id 找 Shell。
pub fn shell(&self, id: &str) -> Option<&ShellProfile> {
self.shells.iter().find(|s| s.id == id)
}
/// 自愈:修复失效引用、补齐缺失的默认值、推进结构版本。
///
/// 沿用 translate 模块确立的 `heal()` 约定:老配置缺字段取默认值,
/// 失效引用自动回落,返回是否发生变更(由调用方决定是否落盘)。
pub fn heal(&mut self) -> bool {
let mut changed = false;
// 快捷键表:补齐新增动作、剔除已废弃动作。用户改过的键位保留。
let defaults = default_shortcuts();
for d in &defaults {
if !self.shortcuts.iter().any(|s| s.action == d.action) {
self.shortcuts.push(d.clone());
changed = true;
}
}
let before = self.shortcuts.len();
// 只保留默认表里存在的 action,避免版本升级后残留无人消费的绑定
self.shortcuts
.retain(|s| defaults.iter().any(|d| d.action == s.action));
if self.shortcuts.len() != before {
changed = true;
}
// 主机的 key_id 指向已删除的密钥 → 清空并退回密码认证的提示由前端给,
// 这里只做数据层清理(不回退 auth_method,避免静默改变用户的认证选择)
let key_ids: Vec<String> = self.keys.iter().map(|k| k.id.clone()).collect();
for host in &mut self.hosts {
if !host.key_id.is_empty() && !key_ids.contains(&host.key_id) {
host.key_id.clear();
changed = true;
}
}
// 主机字段兜底:端口非法、用户名缺失等由前端表单保证,这里只防越界
for host in &mut self.hosts {
if host.port == 0 {
host.port = 22;
changed = true;
}
if host.connect_timeout_ms < 1000 {
host.connect_timeout_ms = 15_000;
changed = true;
}
if host.encoding.trim().is_empty() {
host.encoding = "utf-8".to_string();
changed = true;
}
}
// 外观:滚动缓冲与字体大小越界会直接导致渲染异常
if self.appearance.scrollback < 100 {
self.appearance.scrollback = 10_000;
changed = true;
}
if self.appearance.scrollback > 200_000 {
self.appearance.scrollback = 200_000;
changed = true;
}
if self.appearance.font_size < 8 || self.appearance.font_size > 40 {
self.appearance.font_size = 14;
changed = true;
}
// 布局:分屏上限封顶 4
if self.layout.max_panes == 0 || self.layout.max_panes > 4 {
self.layout.max_panes = 4;
changed = true;
}
// last_shell_id 指向已删除的 Shell → 清空,由前端选第一个可用
if !self.last_shell_id.is_empty() && self.shell(&self.last_shell_id).is_none() {
self.last_shell_id.clear();
changed = true;
}
if self.version < 1 {
self.version = 1;
changed = true;
}
// v2:引入命令片段库。给**空库**塞一批起步片段 ——
// 一个空片段面板对着用户等于没有这个功能,而「自己写第一条」的门槛
// 比「改一条现成的」高得多。只在空库时注入,用户删光后不会被重塞。
if self.version < 2 {
if self.snippets.is_empty() {
self.snippets = default_snippets();
}
self.version = 2;
changed = true;
}
changed
}
}
/// 起步命令片段。
///
/// 选取标准:**跨平台通用、参数化后确有复用价值、且不容易打错**的东西。
/// 刻意不放 `ls`/`cd` 这类过短命令 —— 它们手打比在列表里找更快,
/// 放进片段库只会稀释信噪比。
pub fn default_snippets() -> Vec<CommandSnippet> {
fn mk(
id: &str,
name: &str,
command: &str,
description: &str,
group: &str,
placeholders: &[(&str, &str)],
ssh_only: bool,
confirm: bool,
) -> CommandSnippet {
CommandSnippet {
id: id.to_string(),
name: name.to_string(),
command: command.to_string(),
description: description.to_string(),
group: group.to_string(),
defaults: placeholders
.iter()
.map(|(k, v)| (k.to_string(), v.to_string()))
.collect(),
shell_kinds: Vec::new(),
ssh_only,
confirm,
pinned: false,
created_at: 0,
}
}
vec![
mk(
"snip-find-large",
"查找大文件",
"find ${dir} -type f -size +${size} -exec ls -lh {} \\;",
"列出指定目录下大于指定体积的文件。size 用 100M / 1G 这类写法。",
"文件",
&[("dir", "/"), ("size", "100M")],
false,
false,
),
mk(
"snip-grep-recursive",
"递归搜索内容",
"grep -rn --include=${pattern} '${keyword}' ${dir}",
"在指定目录下按文件名模式递归搜索关键字。",
"文件",
&[("pattern", "*.log"), ("keyword", ""), ("dir", ".")],
false,
false,
),
mk(
"snip-tar-extract",
"解压 tar.gz",
"tar -xzvf ${file} -C ${target}",
"解压到指定目录。target 留空则解到当前目录。",
"文件",
&[("file", ""), ("target", ".")],
false,
false,
),
mk(
"snip-df",
"磁盘占用概览",
"df -h | sort -k5 -hr | head -20",
"按使用率倒序列出挂载点。排查「磁盘满了」的第一步。",
"诊断",
&[],
false,
false,
),
mk(
"snip-port-owner",
"查端口占用",
"ss -tlnp | grep ${port}",
"查看监听指定端口的进程。老系统若无 ss,改用 netstat -tlnp。",
"诊断",
&[("port", "8080")],
false,
false,
),
mk(
"snip-top-cpu",
"CPU 占用前 10",
"ps aux --sort=-%cpu | head -11",
"按 CPU 占用倒序列出进程(含表头共 11 行)。",
"诊断",
&[],
false,
false,
),
mk(
"snip-tail-follow",
"跟踪日志",
"tail -f ${file}",
"实时跟随文件新增内容。Ctrl+C 退出。",
"运维",
&[("file", "")],
false,
false,
),
mk(
"snip-systemd-status",
"服务状态",
"systemctl status ${service} --no-pager",
"查看 systemd 服务状态。--no-pager 让输出直接落到终端而不是进 less。",
"运维",
&[("service", "")],
true,
false,
),
mk(
"snip-perm-fix",
"递归修正属主",
"chown -R ${owner}:${group} ${dir}",
"递归修改目录属主与属组。",
"运维",
&[("owner", ""), ("group", ""), ("dir", "")],
true,
true,
),
mk(
"snip-ssh-tunnel",
"建立 SSH 隧道",
"ssh -N -L ${localPort}:${remoteHost}:${remotePort} ${user}@${jumpHost}",
"本地端口转发。localPort 是你要在本机访问的端口。",
"网络",
&[
("localPort", "8080"),
("remoteHost", "127.0.0.1"),
("remotePort", "80"),
("user", ""),
("jumpHost", ""),
],
false,
false,
),
mk(
"snip-ssh-keygen",
"生成 SSH 密钥",
"ssh-keygen -t ed25519 -C \"${comment}\" -f ~/.ssh/${name}",
"生成 ed25519 密钥对。ed25519 比 RSA 短且更快,现代环境首选。",
"网络",
&[("comment", ""), ("name", "id_ed25519")],
false,
false,
),
]
}
+687
View File
@@ -0,0 +1,687 @@
//! 本地 Shell 探测、命令行组装与 cwd 跟踪 hook 注入。
//!
//! # cwd 为什么需要 hook
//!
//! ConPTY 拿不到子 shell 的真实工作目录:`GetCurrentDirectory` 返回的是**我们
//! 自己进程**的目录,不是子进程的;`NtQueryInformationProcess` 读 PEB 虽然可行,
//! 但需要每帧轮询且对已提权进程无权访问。业界通行做法是让 shell 在每次提示符
//! 绘制时输出 **OSC 7** 转义序列(`ESC ] 7 ; file://host/path BEL`),
//! Windows Terminal / VS Code Terminal 都走这条路。
//!
//! 这是「SFTP 跟随终端目录」的前置能力,因此 P0 就做进去,而不是等到 P1 再补。
use std::path::{Path, PathBuf};
use super::settings::{EnvVar, ShellProfile};
/// 探测结果:合并「自动发现的 Shell」与「用户已有的自定义配置」。
///
/// 合并策略:**以自动探测为权威源修正路径**(用户机器上升级了 PowerShell 7
/// 路径可能变化),但保留用户设置的名字、参数、环境变量。已不存在且非用户自定义
/// 的条目直接丢弃(`pwsh.exe` 卸载后不该留一个点不动的菜单项)。
pub fn detect_and_merge(existing: &[ShellProfile]) -> Vec<ShellProfile> {
let detected = detect_shells();
let mut result: Vec<ShellProfile> = Vec::with_capacity(detected.len() + 2);
for mut d in detected {
if let Some(old) = existing.iter().find(|s| s.id == d.id) {
// 保留用户的个性化字段,路径以探测结果为准
d.name = if old.name.trim().is_empty() {
d.name.clone()
} else {
old.name.clone()
};
d.args = old.args.clone();
d.cwd = old.cwd.clone();
d.env = old.env.clone();
d.enabled = old.enabled;
d.detected = true;
// 用户在自定义条目上填过的路径若仍存在,尊重用户选择
if !old.path.trim().is_empty() && Path::new(&old.path).exists() && !old.detected {
d.path = old.path.clone();
d.detected = false;
}
}
result.push(d);
}
// 追加用户手工新增的、当前探测不到的条目(prune 逻辑在前端确认删除后执行)
for old in existing {
if old.detected {
continue; // 自动探测项已在上面的循环里处理(含丢弃已失效的)
}
if result.iter().any(|s| s.id == old.id) {
continue;
}
result.push(old.clone());
}
result
}
/// 自动探测本机可用的 Shell。
///
/// 顺序即菜单顺序,也是新建会话时的默认选中顺序(按现代性与功能排序)。
pub fn detect_shells() -> Vec<ShellProfile> {
let mut list = Vec::new();
// PowerShell 7+(优先:跨平台、默认 UTF-8、语法现代)
if let Some(p) = find_in_path(&["pwsh.exe"]) {
list.push(ShellProfile::new("pwsh", "PowerShell 7", &p, "powershell"));
}
// Windows PowerShell(系统必带,作保底)
if let Some(p) = find_windows_powershell() {
list.push(ShellProfile::new(
"powershell",
"Windows PowerShell",
&p,
"powershell",
));
}
// cmd
if let Some(p) = find_in_path(&["cmd.exe"]).or_else(find_cmd_fallback) {
list.push(ShellProfile::new("cmd", "命令提示符", &p, "cmd"));
}
// Git Bash(从 git 的安装目录反推,比扫 PATH 可靠)
if let Some(p) = find_git_bash() {
list.push(ShellProfile::new("gitbash", "Git Bash", &p, "bash"));
}
// WSL 发行版:每个发行版一个条目
for distro in list_wsl_distros() {
let id = format!("wsl-{}", sanitize_id(&distro));
let name = format!("WSL · {distro}");
let mut profile = ShellProfile::new(&id, &name, "wsl.exe", "wsl");
profile.args = vec!["-d".to_string(), distro];
list.push(profile);
}
list
}
/// 在 PATH 中查找可执行文件。
fn find_in_path(names: &[&str]) -> Option<String> {
let path = std::env::var_os("PATH")?;
for dir in std::env::split_paths(&path) {
for name in names {
let candidate = dir.join(name);
if candidate.is_file() {
return Some(candidate.to_string_lossy().to_string());
}
}
}
None
}
/// 定位 Windows PowerShell。
///
/// 优先用 `%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe`(权威路径),
/// 而不是查 PATH——PATH 里可能有同名伪装程序。
fn find_windows_powershell() -> Option<String> {
let root = std::env::var_os("SystemRoot")
.map(PathBuf::from)
.unwrap_or_else(|| PathBuf::from(r"C:\Windows"));
let p = root
.join("System32")
.join("WindowsPowerShell")
.join("v1.0")
.join("powershell.exe");
if p.is_file() {
return Some(p.to_string_lossy().to_string());
}
find_in_path(&["powershell.exe"])
}
fn find_cmd_fallback() -> Option<String> {
let root = std::env::var_os("SystemRoot")
.map(PathBuf::from)
.unwrap_or_else(|| PathBuf::from(r"C:\Windows"));
let p = root.join("System32").join("cmd.exe");
if p.is_file() {
return Some(p.to_string_lossy().to_string());
}
find_in_path(&["cmd.exe"])
}
/// 定位 Git Bash。
///
/// 先查 PATH 上的 `bash.exe`Git 安装时通常会把 `Git\bin` 或 `Git\usr\bin` 加进去),
/// 但更要紧的是排除掉 WSL 的 `bash.exe``System32\bash.exe`)——它不是 Git Bash
/// 混用会导致用户点「Git Bash」却进了 WSL。
fn find_git_bash() -> Option<String> {
let candidates = [
r"C:\Program Files\Git\bin\bash.exe",
r"C:\Program Files (x86)\Git\bin\bash.exe",
];
for c in candidates {
if Path::new(c).is_file() {
return Some(c.to_string());
}
}
// 从 HOME 下的常见位置反推(scoop / 便携版)
if let Some(home) = dirs::home_dir() {
for rel in [r"scoop\apps\git\current\bin\bash.exe", r"AppData\Local\Programs\Git\bin\bash.exe"] {
let p = home.join(rel);
if p.is_file() {
return Some(p.to_string_lossy().to_string());
}
}
}
// 最后才查 PATH,且必须排除 System32(那是 WSL 的 bash
find_in_path(&["bash.exe"]).filter(|p| {
let lower = p.to_lowercase();
!lower.contains("system32") && !lower.contains("windowsapps")
})
}
/// 枚举 WSL 发行版。
///
/// `wsl.exe -l -q` 输出 UTF-16LEWindows 上部分 wsl.exe 版本如此),
/// 先按 UTF-16 解,失败再按 UTF-8 解。输出每行一个发行版名。
fn list_wsl_distros() -> Vec<String> {
let out = match std::process::Command::new("wsl.exe")
.args(["-l", "-q"])
.creation_flags_no_window()
.output()
{
Ok(o) if o.status.success() => o.stdout,
_ => return Vec::new(),
};
let text = decode_wsl_output(&out);
text.lines()
.map(|l| l.trim().trim_matches('\0').to_string())
// 过滤空行与提示行("适用于 Linux 的 Windows 子系统..." 之类)
.filter(|l| !l.is_empty() && !l.contains(' ') )
.collect()
}
/// WSL 输出可能是 UTF-16LE 或 UTF-8,试两种。
fn decode_wsl_output(bytes: &[u8]) -> String {
// UTF-16LE 的特征:ASCII 字符之间夹 0x00,且长度为偶数
let looks_utf16 = bytes.len() >= 4 && bytes.len() % 2 == 0 && bytes.iter().skip(1).step_by(2).filter(|&&b| b == 0).count() > bytes.len() / 4;
if looks_utf16 {
let units: Vec<u16> = bytes
.chunks_exact(2)
.map(|c| u16::from_le_bytes([c[0], c[1]]))
.collect();
String::from_utf16_lossy(&units)
} else {
String::from_utf8_lossy(bytes).to_string()
}
}
/// 把发行版名转成可用作 id 的字符串。
fn sanitize_id(s: &str) -> String {
s.chars()
.map(|c| if c.is_ascii_alphanumeric() { c.to_ascii_lowercase() } else { '-' })
.collect()
}
/// 组装完整的命令行字符串。
///
/// Windows 的 `CreateProcessW` 在 `lpApplicationName = NULL` 时会自行解析命令行首段,
/// 因此**路径含空格必须加引号**`C:\Program Files\...` 不加引号会被切成
/// `C:\Program` + 参数)。这里统一处理。
pub fn build_command_line(profile: &ShellProfile) -> String {
let mut s = quote_if_needed(&profile.path);
for a in &profile.args {
s.push(' ');
s.push_str(&quote_if_needed(a));
}
// 启动后自动执行的命令:拼在参数之后,由 shell 自己解析
if !profile.cwd.is_empty() {
// cwd 由 CreateProcessW 的 lpCurrentDirectory 处理,不在这里拼
}
s
}
/// 需要时加引号。
fn quote_if_needed(s: &str) -> String {
if s.contains(' ') && !s.starts_with('"') {
format!("\"{s}\"")
} else {
s.to_string()
}
}
/// 把 [`ShellProfile::env`] 转成 `CreateProcessW` 需要的键值对。
pub fn env_pairs(env: &[EnvVar]) -> Vec<(String, String)> {
env.iter()
.filter(|e| !e.key.trim().is_empty())
.map(|e| (e.key.clone(), e.value.clone()))
.collect()
}
/// 为指定 Shell 生成 cwd 跟踪 hook 的注入参数。
///
/// 返回值是**额外的启动参数**,需要由调用方拼到命令行里。返回空表示该 Shell
/// 无法通过参数注入(如 cmd),此时退化为不跟踪 cwd。
///
/// # 各 Shell 的注入方式与理由
///
/// - **PowerShell / pwsh**`-NoExit -EncodedCommand <base64>`。脚本重定义 `prompt` 函数,
/// 在原有提示符前输出 OSC 7。用 `-NoExit` 是因为 `-Command` 默认会在脚本结束后
/// 退出 shell,而我们只要它执行一段初始化。**不覆盖用户已有的 profile**
/// `-Command` 在 profile 加载之后执行,属于叠加而非替换。
/// 用 `-EncodedCommand` 而不是 `-Command`:脚本里含**双引号**`Write-Host "..."`),
/// 而 `CreateProcessW` 的命令行是单一字符串,引号必须按 MSVCRT 规则转义;
/// 直接拼 `-Command "script"` 时脚本内的 `"` 会提前终结外层引号,
/// PowerShell 收到的是引号被剥掉的残缺脚本 → `Unexpected token '$('` 解析错误。
/// `-EncodedCommand` 接收 base64UTF-16LE),纯字母数字,与引号解析彻底无关。
/// - **Git Bash**`--init-file <文件>`。需要落一个临时脚本文件,因为 bash 的
/// `--init-file` 只接受文件路径。脚本里用 `PROMPT_COMMAND` 输出 OSC 7。
/// - **cmd**:无可靠注入点(`PROMPT` 环境变量不支持转义序列输出 ESC)。
/// 不跟踪,`cwd` 字段保持为空——这是能力边界,如实呈现而不糊弄。
/// - **WSL**:与 bash 同理,但需要写到 WSL 内部路径,成本高。P0 不跟踪。
pub fn cwd_hook_args(profile: &ShellProfile, hook_dir: &Path) -> (Vec<String>, Option<PathBuf>) {
match profile.kind.as_str() {
"powershell" => {
let script = powershell_prompt_hook();
(
vec![
"-NoExit".to_string(),
"-EncodedCommand".to_string(),
encode_powershell_command(&script),
],
None,
)
}
"bash" => {
let file = hook_dir.join("gitbash-cwd-hook.sh");
let content = bash_prompt_hook();
if std::fs::write(&file, content).is_err() {
return (Vec::new(), None);
}
(
vec!["--init-file".to_string(), file.to_string_lossy().to_string()],
Some(file),
)
}
// cmd / wsl:没有可靠注入点,不跟踪 cwd
_ => (Vec::new(), None),
}
}
/// 把脚本编码成 PowerShell `-EncodedCommand` 接受的 base64UTF-16LE)。
///
/// PowerShell5.1 与 7+)按 UTF-16LE 解码该参数;编码后不含空格与引号,
/// 经过 [`build_command_line`] 的引用规则时不会被改写。
fn encode_powershell_command(script: &str) -> String {
use base64::engine::general_purpose::STANDARD as B64;
use base64::Engine as _;
let utf16le: Vec<u8> = script
.encode_utf16()
.flat_map(u16::to_le_bytes)
.collect();
B64.encode(utf16le)
}
/// PowerShell 提示符 hook。
///
/// 关键点:
/// - 用 `$ExecutionContext.SessionState.Path.CurrentLocation` 取当前路径
/// - `file://` 后的主机名用 `$env:COMPUTERNAME`(本地会话无实际意义,但保持格式合法)
/// - 路径里的反斜杠要转成 `/`,且 `file://` 三段式后不能有多余斜杠
/// (否则部分解析器会把盘符吃掉)
/// - 结尾用 BEL`` `a ``)而不是 STBEL 兼容性最好,Windows Terminal 也用它
///
/// 注意 `$PWD` 在 PowerShell 里是 `PathInfo` 对象而非字符串,直接插值会得到
/// `Microsoft.PowerShell.Core\FileSystem::C:\...` 这种非预期内容,因此用
/// `ProviderPath` 显式取字符串路径。
///
/// # OSC 133 命令边界(命令历史的来源)
///
/// PowerShell 的提示符函数在「上一条命令执行完、即将显示新提示符」这个时刻被调用,
/// 因此这里输出的是 **D(上一条结束)** 而不是 C(即将开始)。
///
/// 退出码取自 `$LASTEXITCODE`(原生命令)或 `$?`cmdlet),两者语义不同:
/// cmdlet 成功时 `$LASTEXITCODE` 可能保留着**更早那条原生命令**的值。
/// 因此优先 `$LASTEXITCODE`(仅当其在本轮被设置过),否则用 `$?` 折算 0/1。
/// 无法拿到 `$?` 的历史值 —— 它会被提示符函数自身的第一条语句覆盖,
/// 所以这个取值必须在函数体**最开头**完成。
fn powershell_prompt_hook() -> String {
[
"$__thingOrigPrompt = $function:prompt;",
"function global:prompt {",
// 必须最先取:后面任何一条语句都会刷新 $?
" $__ok = $?;",
" $__code = $LASTEXITCODE;",
" if ($null -eq $__code) { $__code = if ($__ok) { 0 } else { 1 } }",
" Write-Host -NoNewline \"$([char]27)]133;D;$__code$([char]7)\";",
" $__p = $ExecutionContext.SessionState.Path.CurrentLocation;",
" $__loc = $__p.ProviderPath;",
" if ($__loc) {",
" $__u = $__loc -replace '\\\\','/';",
" if ($__u -notmatch '^/') { $__u = '/' + $__u }",
" Write-Host -NoNewline \"$([char]27)]7;file://$env:COMPUTERNAME$__u$([char]7)\";",
" }",
" if ($__thingOrigPrompt) { & $__thingOrigPrompt } else { 'PS ' + (Get-Location) + '> ' }",
"}",
]
.join(" ")
}
/// Git Bash 提示符 hook。
///
/// 用 `PROMPT_COMMAND` 而不是重定义 `PS1``PROMPT_COMMAND` 在每次绘制提示符前
/// 执行,且不干扰用户自己设置的 `PS1`(重定义 PS1 会覆盖用户的样式)。
///
/// # 命令历史的来源(OSC 133 + 1337
///
/// bash 没有「命令执行完」的钩子,但 `PROMPT_COMMAND` 恰好在同一时刻运行,
/// 且此时 `$?` 仍是上一条命令的退出码(任何语句都会覆盖它,所以先存后读)。
///
/// 命令文本取自 `history 1`:它返回 ` 123 <命令>`(前导空格 + 序号 + 空格)。
/// 用 `history 1` 而不是 `BASH_COMMAND` 或 `$1`
/// - `BASH_COMMAND` 在 `PROMPT_COMMAND` 里指向的是 `PROMPT_COMMAND` 自身
/// - `history 1` 给的是 **shell 最终执行的那条**,别名已展开、Tab 补全已生效
///
/// # 为什么 `history 1` 要去掉序号而不是按空格切
///
/// 序号与命令之间是**两个空格**分隔,但命令本身可能以空格开头
/// (用户刻意用前导空格隐藏命令)。用 `sed 's/^ *[0-9]* *//'` 会连用户的
/// 前导空格一起吃掉,导致「刻意隐藏的命令」变成普通命令被记进我们的历史 ——
/// 这正好违背用户意图。因此用「剥掉前导空白 + 数字 + 一个空格」的精确匹配,
/// 保留命令本身的任何前导空格... 但这样又与我们「前导空格不入库」的规则冲突。
///
/// 结论:**保留 shell 的原样输出交给 Rust 侧判断** —— hook 只管如实上报,
/// 「前导空格要不要记」是策略,由 `History::record` 统一决定(那里也是
/// `HISTCONTROL=ignorespace` 的落点)。hook 里做策略判断会散落成两处规则。
fn bash_prompt_hook() -> String {
[
"# Thing 终端:shell integration hook(由终端模块注入,可安全删除)",
"# 输出 OSC 7cwd)与 OSC 133/1337(命令边界与命令文本),",
"# 供文件管理器、cwd 继承与命令历史使用",
"__thing_osc7() {",
" local __code=$?",
" printf '\\033]133;D;%s\\007' \"$__code\"",
// 取最后一条历史:`history 1` 返回 ` 123 <命令>`
// (前导空格 + 序号 + 两个空格 + 命令本体)。
//
// 用 `read -r` 拆而不是参数展开剥前缀:`${x#"$y"}` 这种嵌套引号在
// Rust 字符串字面量里要转义到难以阅读,而且 `history` 的输出里
// 命令本体可能**含空格**,参数展开必须保留剩余全部内容。
// `read -r _ _ __cmd` 的语义恰好是「跳过前两段空白分隔的字段,
// 其余原样(含内部空格)收进 __cmd」—— 正是所需,且引号最少。
" local __cmd=''",
" read -r _ _ __cmd <<< \"$(HISTTIMEFORMAT= builtin history 1)\"",
" printf '\\033]1337;Cmd=%s\\007' \"$__cmd\"",
" printf '\\033]7;file://%s%s\\007' \"${HOSTNAME:-localhost}\" \"$PWD\"",
"}",
"if [[ -n \"$PROMPT_COMMAND\" ]]; then",
" PROMPT_COMMAND=\"__thing_osc7; $PROMPT_COMMAND\"",
"else",
" PROMPT_COMMAND=\"__thing_osc7\"",
"fi",
"",
]
.join("\n")
}
/// 清屏命令(按 Shell 类型区分)。
pub fn clear_command(kind: &str) -> &'static str {
match kind {
"cmd" => "cls\r",
"powershell" => "Clear-Host\r",
// bash / wsl`clear` 是 ANSI 序列,也可直接发 \x1bc 复位
_ => "clear\r",
}
}
use std::os::windows::process::CommandExt;
/// `Command::creation_flags` 的糖:隐藏控制台窗口。
trait NoWindow {
fn creation_flags_no_window(&mut self) -> &mut Self;
}
impl NoWindow for std::process::Command {
fn creation_flags_no_window(&mut self) -> &mut Self {
// CREATE_NO_WINDOW = 0x08000000,避免探测 wsl 时闪一个黑框
const CREATE_NO_WINDOW: u32 = 0x0800_0000;
self.creation_flags(CREATE_NO_WINDOW)
}
}
/// 解析终端输出流中的 OSC 7(cwd)、OSC 0/2(标题)与 OSC 133(命令边界)序列。
///
/// 输入是原始字节流的一个片段,可能**不完整**(序列被切在中间)。因此本函数
/// 采用「窗口扫描 + 保留尾部」策略:
/// - 完整解析到的序列被消费掉
/// - 未闭合的序列从起始 ESC 开始保留到缓冲区末尾,等下一批数据拼接
///
/// 返回 [`ParsedSequences`],而不是继续扩元组 —— 再加一类序列就要变成 4 元组,
/// 调用点会退化成一串 `let (_, _, x, _) = ...`,加字段时无从判断哪里该改。
pub fn parse_control_sequences(data: &[u8]) -> ParsedSequences {
let mut out = ParsedSequences {
consumed: data.len(),
cwds: Vec::new(),
titles: Vec::new(),
marks: Vec::new(),
};
let mut i = 0usize;
// 最后一个「未消费但可能是序列开头」的位置
let mut safe_end = data.len();
while i < data.len() {
if data[i] != 0x1b {
i += 1;
continue;
}
// ESC ] ... 起点
if i + 1 >= data.len() {
safe_end = i;
break;
}
if data[i + 1] != b']' {
i += 1;
continue;
}
// 找终止符:BEL(0x07) 或 ST(ESC \)
let start = i + 2;
let mut j = start;
let mut terminated = false;
while j < data.len() {
if data[j] == 0x07 {
terminated = true;
break;
}
if data[j] == 0x1b && j + 1 < data.len() && data[j + 1] == b'\\' {
terminated = true;
break;
}
j += 1;
}
if !terminated {
// 序列被切断了,从 ESC 位置保留到末尾
safe_end = i;
break;
}
let body_end = j;
let payload = String::from_utf8_lossy(&data[start..body_end]).to_string();
// 消费的长度:ESC ] body 终止符(BEL 1 字节 / ST 2 字节)
let consumed_end = if data[body_end] == 0x07 { body_end + 1 } else { body_end + 2 };
i = consumed_end;
if let Some(rest) = payload.strip_prefix("7;") {
if let Some(cwd) = parse_osc7(rest) {
out.cwds.push(cwd);
}
} else if let Some(rest) = payload.strip_prefix("0;").or_else(|| payload.strip_prefix("2;")) {
if !rest.trim().is_empty() {
out.titles.push(rest.to_string());
}
} else if payload.starts_with("133;") {
if let Some(mark) = parse_osc133(&payload) {
out.marks.push(mark);
}
}
}
// 消费掉完整解析过的部分,保留尾部残留
let consumed = if safe_end < data.len() && i <= safe_end {
safe_end.max(i)
} else {
i.min(data.len())
};
out.consumed = consumed;
out
}
/// OSC 133 命令边界标记(shell integration 协议)。
///
/// # 为什么需要它才能记录命令历史
///
/// 终端应用要记录「用户执行了什么命令」,直觉做法是「把用户在键盘上敲的字符
/// 攒起来,遇到回车就存」。这条路**必然出错**:
/// - 退格、方向键、`Ctrl+U` 都会改写已敲内容,前端拿到的是一串 `\x7f` 与 `\x1b[D`
/// - Tab 补全的结果是由 shell 生成的,前端根本不知道补全成了什么
/// - 别名(`ll` → `ls -al`)、历史展开(`!!`)同理
///
/// OSC 133 由 **shell 自己**在提示符处输出,因此上述问题全部不存在 ——
/// 它报告的是 shell 最终真正执行的那条命令。
///
/// # 协议形态
///
/// - `OSC 133 ; A` — 提示符开始(准备接收输入)
/// - `OSC 133 ; B` — 输入区开始
/// - `OSC 133 ; C` — 命令开始执行
/// - `OSC 133 ; D ; <exit_code>` — 命令结束,可选携带退出码
/// - `OSC 133 ; D` — 命令结束,无退出码
///
/// 本模块只关心 `D`:它标志着「上一条命令执行完毕」,此刻可以上报。
///
/// # 关于「命令文本从哪来」
///
/// OSC 133 的 `C` 标记**不携带命令文本**(协议本身只管边界,不管内容)。
/// 要拿到文本,标准做法是 shell hook 里额外输出一个自定义序列
/// (如 `OSC 633 ; E ; <cmd>`VS Code 用这个)。这里沿用同一思路,
/// 用 `OSC 1337 ; Cmd=<cmd>`(见 `shell_integration_script`)。
///
/// 把「命令文本」与「边界」分开传输,是因为前者需要 shell 侧配合转义
/// (命令里可能含 `\a`、`\x1b`),而边界只要一个字符,两者可靠性诉求不同 ——
/// 混在一个序列里会让「命令含 BEL 字符」直接破坏边界解析。
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CommandMark {
/// 命令开始执行(`C`
Start,
/// 命令结束(`D`),携带退出码(若有)
End(Option<i32>),
/// 即将执行的命令文本(自定义序列,见上)
Command(String),
}
/// 解析 OSC 133 / 1337 的载荷(**不含** `OSC ` 前缀)。
fn parse_osc133(payload: &str) -> Option<CommandMark> {
// 自定义序列必须**先**判断:`1337;Cmd=...` 与 `133;...` 共享 `133` 前缀,
// 若先走 `strip_prefix("133;")``1337;` 因第 4 字符是 `7` 而非 `;` 而失配,
// 结果是「命令文本永远收不到,且不报错」—— 静默失效最难查。
if let Some(cmd) = payload.strip_prefix("1337;Cmd=") {
return Some(CommandMark::Command(cmd.to_string()));
}
let rest = payload.strip_prefix("133;")?;
match rest.chars().next()? {
'C' => Some(CommandMark::Start),
'D' => {
// `D` / `D;0` / `D;1` —— 分号后的部分是退出码
let code = rest
.strip_prefix("D;")
.and_then(|s| s.trim().split(';').next())
.filter(|s| !s.is_empty())
.and_then(|s| s.parse::<i32>().ok());
Some(CommandMark::End(code))
}
// A / B 与历史记录无关(提示符与输入区起止),显式忽略而非报错:
// 它们由同一个 hook 输出,忽略掉比让调用方遍历时到处判类型更省事。
_ => None,
}
}
/// `parse_control_sequences` 的结果。
#[derive(Debug, Clone, Default)]
pub struct ParsedSequences {
/// 已完整解析、可从缓冲区丢弃的字节数
pub consumed: usize,
/// OSC 7 上报的 cwd(按出现顺序)
pub cwds: Vec<String>,
/// OSC 0/2 上报的标题
pub titles: Vec<String>,
/// OSC 133 命令边界标记(按出现顺序)
pub marks: Vec<CommandMark>,
}
/// 从 OSC 7 的载荷解析出本地路径。
///
/// 载荷形如 `file://HOST/C:/Users/foo` 或 `file:///home/user`。
/// Windows 上要处理 `file://HOST/C:/...` → `C:\...` 的还原:
/// 去掉开头的 `/`,把 `/` 换回 `\`,并把 `C:` 前面的多余斜杠去掉。
fn parse_osc7(payload: &str) -> Option<String> {
let rest = payload.strip_prefix("file://").unwrap_or(payload);
// 跳过主机名(第一个 '/' 之前的部分)
let path_part = match rest.find('/') {
Some(idx) => &rest[idx..],
None => rest,
};
if path_part.is_empty() {
return None;
}
let decoded = percent_decode(path_part);
// Windows 盘符形态:/C:/Users → C:\Users
let normalized = if decoded.len() >= 3
&& decoded.starts_with('/')
&& decoded.as_bytes()[2] == b':'
{
decoded[1..].replace('/', "\\")
} else {
decoded.replace('/', "\\")
};
Some(normalized)
}
/// 极简百分号解码(OSC 7 里的路径可能含 `%20` 等)。
fn percent_decode(s: &str) -> String {
let bytes = s.as_bytes();
let mut out = Vec::with_capacity(bytes.len());
let mut i = 0;
while i < bytes.len() {
if bytes[i] == b'%' && i + 2 < bytes.len() {
let hex = std::str::from_utf8(&bytes[i + 1..i + 3]).ok();
if let Some(v) = hex.and_then(|h| u8::from_str_radix(h, 16).ok()) {
out.push(v);
i += 3;
continue;
}
}
out.push(bytes[i]);
i += 1;
}
String::from_utf8_lossy(&out).to_string()
}
/// 默认工作目录:优先用户主目录,其次当前目录。
pub fn default_cwd() -> String {
dirs::home_dir()
.map(|p| p.to_string_lossy().to_string())
.unwrap_or_else(|| ".".to_string())
}
/// 校验用户给定的工作目录是否可用(不存在则退回默认,不报错阻断会话创建)。
pub fn resolve_cwd(requested: &str) -> Option<String> {
let r = requested.trim();
if r.is_empty() {
return Some(default_cwd());
}
if Path::new(r).is_dir() {
Some(r.to_string())
} else {
crate::logger::log_warn(
"terminal",
&format!("工作目录 {r} 不存在,退回默认目录"),
);
Some(default_cwd())
}
}
+475
View File
@@ -0,0 +1,475 @@
//! 端口转发引擎(P2):`-L` 本地转发与 `-R` 远程转发。
//!
//! # 两个方向的管线
//!
//! **-L(本地转发)**:本机开 `TcpListener`,每来一条连接就在 SSH 会话上开一条
//! `direct-tcpip` 通道指向目标,然后 `copy_bidirectional` 对拷:
//!
//! ```text
//! 本地应用 ──TCP──▶ TcpListener ──▶ direct-tcpip 通道 ──▶ 服务器 ──▶ target_host:port
//! ```
//!
//! **-R(远程转发)**:通过 `handle.tcpip_forward()` 请求**服务器**监听;
//! 服务器侧来连接时,russh 在 Handler 的
//! `server_channel_open_forwarded_tcpip` 回调里把通道交给我们,由我们连到目标:
//!
//! ```text
//! 远端访问者 ──▶ 服务器:bind_port ──forwarded-tcpip 通道──▶ 本机 ──TCP──▶ target_host:port
//! ```
//!
//! # 生命周期与所有权
//!
//! 转发规则挂在**会话**上(不持久化):会话关闭 = 全部转发消失,
//! 这与 ssh 客户端的直觉一致(连接断开转发即失效)。
//! `-L` 的监听任务句柄存进注册表,remove 时 `abort()` 释放端口;
//! `-R` 无本地任务(通道由 Handler 回调驱动),remove 时发 `cancel_tcpip_forward`。
//!
//! # 安全默认
//!
//! russh 对 `forwarded-tcpip` 通道的默认处理是**全部接受**——意味着只要服务器
//! 愿意,任何一条 forwarded 通道都会被接受并挂起等数据。本模块的 Handler
//! 覆写为**白名单匹配**:只有注册过的 `-R` 规则(按监听端口)才放行,其余拒绝。
//!
//! # 已知取舍
//!
//! - `-D`SOCKS5 动态转发)不在本模块:需要实现 SOCKS5 握手协议,独立成项再做;
//! - 转发规则不持久化:每次连接后按需添加。若后续要「主机级自动转发」,
//! 在主机配置里存模板并在会话 Established 后逐条调 `add_local`/`add_remote` 即可。
use std::collections::HashMap;
use std::sync::{Mutex, OnceLock};
use serde::Serialize;
use specta::Type;
use super::{Channel, Msg, SshInner};
use super::super::session::now_millis;
/// 转发规则视图(发往前端)。
#[derive(Debug, Clone, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct ForwardView {
pub id: String,
/// `"local"`-L| `"remote"`-R
pub kind: String,
/// -L:本机监听地址;-R:**服务器端**监听地址
pub bind_host: String,
pub bind_port: u16,
/// -L:从**服务器**视角要连接的目标;-R:从**服务器**视角连接的目标
pub target_host: String,
pub target_port: u16,
/// `"active"` | `"error"`
pub status: String,
/// 人类可读状态(实际监听地址 / 错误原因)
pub detail: String,
}
/// 注册表条目。
pub(crate) struct ForwardEntry {
pub rule: ForwardView,
/// `-L` 的监听循环任务(remove 时 abort 以释放端口);`-R` 为 None。
pub task: Option<tauri::async_runtime::JoinHandle<()>>,
}
/// 会话 → (转发 id → 条目)。
///
/// 全局静态表的理由与 `PENDING_HOST_KEYS` 相同:转发管道任务的 spawn 点
/// 分散在命令层与 Handler 回调里,拿不到统一的会话对象引用。
/// 键直接用 `String``SessionId` 是它的别名,此处不依赖别名语义)。
static REGISTRY: OnceLock<Mutex<HashMap<String, HashMap<String, ForwardEntry>>>> =
OnceLock::new();
fn registry() -> &'static Mutex<HashMap<String, HashMap<String, ForwardEntry>>> {
REGISTRY.get_or_init(|| Mutex::new(HashMap::new()))
}
fn next_id() -> String {
format!("fw{}", now_millis())
}
/// 列出某会话的全部转发规则。
pub fn list_for_session(session_id: &str) -> Vec<ForwardView> {
registry()
.lock()
.unwrap_or_else(|e| e.into_inner())
.get(session_id)
.map(|m| m.values().map(|e| e.rule.clone()).collect())
.unwrap_or_default()
}
/// Handler 回调用:按监听端口做**全局**匹配 `-R` 规则。
///
/// # 为什么是全局而不是按会话
///
/// P2 连接复用之后,入站的 forwarded-tcpip 通道总是从**连接级** Handler
/// 回调进来,而该 Handler 的 session_id 属于**第一个**建立连接的会话;
/// 第二个会话添加的 -R 规则若只查自己的 session_id 就永远匹配不上。
/// 端口的全局唯一性在 `add_remote` 时已强制(重复绑定端口被拒绝),
/// 因此这里按端口全局查找是安全的。
///
/// 返回 `(规则所属会话 id, 目标主机, 目标端口)`;无匹配 = 服务器来了一条
/// 没有对应规则的转发连接,调用方应拒绝。
pub(crate) fn match_remote_rule(connected_port: u32) -> Option<(String, String, u16)> {
let reg = registry().lock().unwrap_or_else(|e| e.into_inner());
for entries in reg.values() {
for e in entries.values() {
if e.rule.kind == "remote"
&& e.rule.status == "active"
&& e.rule.bind_port as u32 == connected_port
{
return Some((
e.rule.id.clone(),
e.rule.target_host.clone(),
e.rule.target_port,
));
}
}
}
None
}
/// 检查远程监听端口是否已被(任何会话的)规则占用。
///
/// 共享连接下两个会话各自 -R 同一端口会让路由产生歧义,必须在添加时拒绝。
pub(crate) fn remote_port_taken(bind_port: u16) -> bool {
let reg = registry().lock().unwrap_or_else(|e| e.into_inner());
reg.values().any(|entries| {
entries.values().any(|e| {
e.rule.kind == "remote" && e.rule.status == "active" && e.rule.bind_port == bind_port
})
})
}
/// 标记规则出错(如 `-L` 监听套接字意外失效)。
fn mark_error(session_id: &str, forward_id: &str, detail: String) {
if let Some(e) = registry()
.lock()
.unwrap_or_else(|x| x.into_inner())
.get_mut(session_id)
.and_then(|m| m.get_mut(forward_id))
{
e.rule.status = "error".to_string();
e.rule.detail = detail;
}
}
/// 添加 `-L` 本地转发。
///
/// 先 `bind` 再 spawn:端口被占用时**立刻**报错返回(fail-fast),
/// 而不是存了一条永远没有流量的死规则。
pub async fn add_local(
session_id: &str,
inner: std::sync::Arc<SshInner>,
bind_host: &str,
bind_port: u16,
target_host: &str,
target_port: u16,
) -> Result<ForwardView, String> {
let listener = tokio::net::TcpListener::bind((bind_host, bind_port))
.await
.map_err(|e| {
format!(
"监听 {bind_host}:{bind_port} 失败: {e}。常见原因:端口已被其他程序占用。"
)
})?;
let actual = listener
.local_addr()
.map(|a| a.to_string())
.unwrap_or_else(|_| format!("{bind_host}:{bind_port}"));
let view = ForwardView {
id: next_id(),
kind: "local".to_string(),
bind_host: bind_host.to_string(),
bind_port,
target_host: target_host.to_string(),
target_port,
status: "active".to_string(),
detail: format!("本机监听 {actual}"),
};
let sid = session_id.to_string();
let target = target_host.to_string();
let fw_id = view.id.clone();
let task = tauri::async_runtime::spawn(async move {
local_accept_loop(&sid, &fw_id, listener, inner, &target, target_port).await;
});
registry()
.lock()
.unwrap_or_else(|e| e.into_inner())
.entry(session_id.to_string())
.or_default()
.insert(
view.id.clone(),
ForwardEntry {
rule: view.clone(),
task: Some(task),
},
);
Ok(view)
}
/// `-L` 的接受循环:每条连接开一条独立 `direct-tcpip` 通道。
///
/// 通道开启用 sftp 同款的 `spawn_blocking + block_on` 模式借出
/// `Mutex` 里的 `Handle`(不可克隆、不能跨 `.await` 持锁)——
/// 每条连接只占用阻塞线程一个 RTT,数据对拷是纯异步的。
async fn local_accept_loop(
session_id: &str,
forward_id: &str,
listener: tokio::net::TcpListener,
inner: std::sync::Arc<SshInner>,
target_host: &str,
target_port: u16,
) {
loop {
let accepted = listener.accept().await;
let (tcp, peer) = match accepted {
Ok(v) => v,
Err(e) => {
// 监听套接字级错误(极少见,如句柄耗尽):标记错误并退出循环,
// 端口随即释放,前端列表里能看到 status 变为 error
mark_error(
session_id,
forward_id,
format!("监听异常,转发已停止: {e}"),
);
return;
}
};
let inner = inner.clone();
let target = target_host.to_string();
let peer_ip = peer.ip().to_string();
let peer_port = peer.port();
let target_port_u32 = target_port as u32;
tauri::async_runtime::spawn(async move {
match open_direct_tcpip(&inner, &target, target_port_u32, &peer_ip, peer_port).await {
Ok(channel) => {
// 通道转成流后与本地 TCP 对拷;任一侧关闭即结束
let mut ch = channel.into_stream();
let mut tcp = tcp;
if let Err(e) = tokio::io::copy_bidirectional(&mut ch, &mut tcp).await {
crate::logger::log_warn(
"terminal",
&format!("转发数据管道中断({peer}: {e}"),
);
}
}
Err(e) => {
// 开通道失败:直接 drop 本地 TCP,让发起方立刻看到连接被断开,
// 而不是挂死等超时
crate::logger::log_warn(
"terminal",
&format!("转发开通道失败({peer}{target}:{target_port_u32}: {e}"),
);
}
}
});
}
}
/// 在 SSH 会话上开一条 `direct-tcpip` 通道(sftp 同款的借锁模式)。
async fn open_direct_tcpip(
inner: &std::sync::Arc<SshInner>,
host: &str,
port: u32,
originator_ip: &str,
originator_port: u16,
) -> Result<Channel<Msg>, String> {
let inner = inner.clone();
let host = host.to_string();
let originator_ip = originator_ip.to_string();
tokio::task::spawn_blocking(move || {
let rt = tokio::runtime::Handle::current();
rt.block_on(async {
// 槽位为 tokio Mutex(P2 连接复用):锁的获取也放进 block_on
let guard = inner.handle.lock().await;
let handle = guard
.as_ref()
.ok_or_else(|| "SSH 会话已断开,转发不可用".to_string())?;
handle
.channel_open_direct_tcpip(host, port, originator_ip, originator_port as u32)
.await
.map_err(|e| format!("打开转发通道失败: {e}"))
})
})
.await
.map_err(|e| format!("转发任务异常: {e}"))?
}
/// 添加 `-R` 远程转发。
///
/// 请求**服务器**在 `bind_host:bind_port` 监听;后续连接经
/// `server_channel_open_forwarded_tcpip` 回调回到本机(见 Handler 覆写)。
pub async fn add_remote(
session_id: &str,
inner: &std::sync::Arc<SshInner>,
bind_host: &str,
bind_port: u16,
target_host: &str,
target_port: u16,
) -> Result<ForwardView, String> {
// 共享连接下监听端口是**全局**资源:另一个会话已用同一端口时,
// 入站路由无法区分归属,必须在添加时拒绝而不是静默错乱
if remote_port_taken(bind_port) {
return Err(format!(
"远程监听端口 {bind_port} 已被占用(可能是其他会话的远程转发)"
));
}
request_remote_listen(inner, bind_host, bind_port).await?;
let view = ForwardView {
id: next_id(),
kind: "remote".to_string(),
bind_host: bind_host.to_string(),
bind_port,
target_host: target_host.to_string(),
target_port,
status: "active".to_string(),
detail: format!("服务器监听 {bind_host}:{bind_port}"),
};
registry()
.lock()
.unwrap_or_else(|e| e.into_inner())
.entry(session_id.to_string())
.or_default()
.insert(
view.id.clone(),
ForwardEntry {
rule: view.clone(),
task: None,
},
);
Ok(view)
}
/// 请求服务器开始监听(`tcpip_forward`)。
async fn request_remote_listen(
inner: &std::sync::Arc<SshInner>,
bind_host: &str,
bind_port: u16,
) -> Result<(), String> {
let inner = inner.clone();
let host = bind_host.to_string();
tokio::task::spawn_blocking(move || {
let rt = tokio::runtime::Handle::current();
rt.block_on(async {
// 槽位为 tokio Mutex(P2 连接复用):锁的获取也放进 block_on
let guard = inner.handle.lock().await;
let handle = guard
.as_ref()
.ok_or_else(|| "SSH 会话已断开,无法建立远程转发".to_string())?;
// 返回值是服务器确认的绑定端口(u32);我们只关心成败
handle
.tcpip_forward(&host, bind_port as u32)
.await
.map(|_| ())
.map_err(|e| {
format!(
"服务器拒绝在 {host}:{bind_port} 监听: {e}\
常见原因:端口已被占用、或服务器禁用了 TCP 转发(AllowTcpForwarding no)。"
)
})
})
})
.await
.map_err(|e| format!("转发任务异常: {e}"))?
}
/// 删除一条转发。
///
/// `-L`:abort 监听任务(端口立即释放);`-R`:向服务器发 `cancel_tcpip_forward`
/// (服务器停止监听;已建立的连接自然消亡)。
pub async fn remove(
inner: &std::sync::Arc<SshInner>,
session_id: &str,
forward_id: &str,
) -> Result<(), String> {
let removed = registry()
.lock()
.unwrap_or_else(|e| e.into_inner())
.get_mut(session_id)
.and_then(|m| m.remove(forward_id));
let Some(entry) = removed else {
return Err(format!("转发规则 {forward_id} 不存在"));
};
if let Some(task) = entry.task {
task.abort(); // `-L`:监听循环停止,端口释放
} else if entry.rule.kind == "remote" {
// `-R`:取消服务器端监听。失败不阻断(会话断开时服务器也会清理),
// 但要记日志——否则「删了还在监听」的问题无从排查
let inner = inner.clone();
let host = entry.rule.bind_host.clone();
let port = entry.rule.bind_port;
let r = tokio::task::spawn_blocking(move || {
let rt = tokio::runtime::Handle::current();
rt.block_on(async {
let guard = inner.handle.lock().await;
let Some(handle) = guard.as_ref() else {
return Ok(());
};
handle.cancel_tcpip_forward(&host, port as u32).await
})
})
.await
.map_err(|e| format!("转发任务异常: {e}"));
match r {
Ok(Ok(())) => {}
Ok(Err(e)) => crate::logger::log_warn(
"terminal",
&format!("取消远程转发 {}:{} 失败(会话断开时会自动清理): {e}", entry.rule.bind_host, port),
),
Err(e) => crate::logger::log_warn("terminal", &format!("取消远程转发任务异常: {e}")),
}
}
Ok(())
}
/// 会话关闭时的清理:abort 全部 `-L` 任务并清空条目。
///
/// `-R` 不需要显式 cancel:SSH 会话断开时服务器会停掉该会话的所有监听。
pub fn cleanup_session(session_id: &str) {
if let Some(m) = registry()
.lock()
.unwrap_or_else(|e| e.into_inner())
.remove(session_id)
{
for (_, entry) in m {
if let Some(task) = entry.task {
task.abort();
}
}
}
}
/// Handler 回调里的管道任务:`forwarded-tcpip` 通道 → 本机目标。
///
/// 供 `ssh/mod.rs` 的 `server_channel_open_forwarded_tcpip` 覆写调用。
pub(crate) fn pipe_forwarded_channel(
channel: Channel<Msg>,
target_host: String,
target_port: u16,
) {
tauri::async_runtime::spawn(async move {
match tokio::net::TcpStream::connect((target_host.as_str(), target_port)).await {
Ok(mut tcp) => {
let mut ch = channel.into_stream();
if let Err(e) = tokio::io::copy_bidirectional(&mut ch, &mut tcp).await {
crate::logger::log_warn(
"terminal",
&format!("远程转发管道中断({target_host}:{target_port}: {e}"),
);
}
}
Err(e) => {
crate::logger::log_warn(
"terminal",
&format!("远程转发目标 {target_host}:{target_port} 连接失败: {e}"),
);
}
}
});
}
+405
View File
@@ -0,0 +1,405 @@
//! 主机密钥库(known_hosts)与指纹校验。
//!
//! # 为什么自己实现而不是复用 `~/.ssh/known_hosts`
//!
//! 三个理由:
//! 1. **写入冲突**OpenSSH 的 `known_hosts` 是追加式文本文件,多进程并发写入
//! 会互相破坏(这也是为什么 OpenSSH 自己做文件锁)。我们的应用与用户的
//! `ssh` 命令行会同时改它。
//! 2. **无法表达「拒绝」**:用户在我们的 UI 上选了「不接受」时,OpenSSH 格式里
//! 没有对应的记录形态(只能不写,等于下次又问)。
//! 3. **需要附加信息**:我们要记「首次见到时间」「上次确认时间」「变更历史」
//! 以便审计与提示,这些在 OpenSSH 格式里无处安放。
//!
//! 因此用自有 JSON 存储,同时**提供导入/导出到 OpenSSH 格式**的能力,
//! 让用户的既有记录可以迁移,且不与命令行工具形成两套互不相知的信任库。
//!
//! # 安全姿态
//!
//! - 指纹变更**默认阻断**(不是警告):TOFU 疲劳是 MITM 的主要入口,
//! 把它做成一个需要主动点开的红色阻断界面,是这里唯一有效的防御。
//! - 超时/未响应 = 拒绝(安全侧默认值)。
//! - known_hosts 是**非机密**数据,明文 JSON 存储、可导出、可人工审阅。
use std::collections::BTreeMap;
use std::path::PathBuf;
use std::sync::{Mutex, OnceLock};
use serde::{Deserialize, Serialize};
use specta::Type;
/// 单条已知主机记录。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct KnownHost {
/// 主机地址(不含端口,端口单独存)
pub host: String,
pub port: u16,
/// 密钥算法(如 "ssh-ed25519" / "rsa-sha2-512" / "ssh-rsa"
///
/// 同一主机可能有多种算法的密钥(服务器同时提供 ed25519 与 rsa),
/// 因此按 (host, port, key_type) 三元组建索引,而不是 (host, port)。
pub key_type: String,
/// SHA256 指纹(OpenSSH 展示格式,如 `SHA256:Abc...`
pub fingerprint: String,
/// 首次见到时间(RFC3339
pub first_seen: String,
/// 最近一次确认时间(RFC3339
pub last_confirmed: String,
/// 指纹变更历史(最新在前)。
///
/// 保留历史的价值:用户点「接受新指纹」之后,回看历史能判断这到底是
/// 服务器重装(一次性变更)还是持续的中间人(每次都变)。
pub history: Vec<FingerprintChange>,
}
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase", default)]
pub struct FingerprintChange {
/// 被替换掉的旧指纹
pub old_fingerprint: String,
/// 变更发生时间
pub changed_at: String,
/// 用户是否接受了这次变更
pub accepted: bool,
}
impl Default for FingerprintChange {
fn default() -> Self {
Self {
old_fingerprint: String::new(),
changed_at: String::new(),
accepted: false,
}
}
}
impl Default for KnownHost {
fn default() -> Self {
Self {
host: String::new(),
port: 22,
key_type: String::new(),
fingerprint: String::new(),
first_seen: String::new(),
last_confirmed: String::new(),
history: Vec::new(),
}
}
}
/// 校验结论。
#[derive(Debug, Clone)]
pub enum Verdict {
/// 指纹与记录一致 → 可信,直接放行
Trusted,
/// 该主机对此算法**没有记录** → 首次连接,需用户确认
Unknown,
/// 有记录但指纹不同 → 高危,需用户显式确认
Changed { previous: String },
}
/// 主机密钥库(内存缓存 + 文件持久化)。
struct Store {
path: PathBuf,
/// `(host, port, key_type)` → 记录
entries: BTreeMap<String, KnownHost>,
/// 是否需要落盘
dirty: bool,
}
static STORE: OnceLock<Mutex<Option<Store>>> = OnceLock::new();
fn store_slot() -> &'static Mutex<Option<Store>> {
STORE.get_or_init(|| Mutex::new(None))
}
/// 初始化存储路径(应用启动时调用一次)。
pub fn init(path: PathBuf) {
let mut slot = store_slot().lock().unwrap_or_else(|e| e.into_inner());
if slot.is_some() {
return;
}
let entries = match std::fs::read_to_string(&path) {
Ok(raw) => match serde_json::from_str::<Vec<KnownHost>>(&raw) {
Ok(list) => list
.into_iter()
.map(|h| (key_of(&h.host, h.port, &h.key_type), h))
.collect(),
Err(e) => {
crate::logger::log_error(
"terminal",
&format!("known_hosts 解析失败(将以空库启动): {e}"),
);
BTreeMap::new()
}
},
Err(_) => BTreeMap::new(),
};
*slot = Some(Store {
path,
entries,
dirty: false,
});
}
fn key_of(host: &str, port: u16, key_type: &str) -> String {
format!("{host}:{port}:{key_type}")
}
/// 校验主机密钥。
///
/// 注意「同主机多算法」的处理:服务器同时提供 ed25519 与 rsa 时,我们按
/// `key_type` 分别记录。若用户上次连的是 ed25519、这次服务器(因客户端算法
/// 偏好变化)用了 rsa,**不应判为指纹变更**——那是不同算法的两把不同密钥,
/// 属于正常情况。因此这里的比对严格限定在同一 key_type 内。
pub fn verify(host: &str, port: u16, fingerprint: &str, key_type: &str) -> Verdict {
let slot = store_slot().lock().unwrap_or_else(|e| e.into_inner());
let Some(store) = slot.as_ref() else {
// 未初始化:保守起见按「未知」处理,要求用户确认
return Verdict::Unknown;
};
// 先查同算法记录
if let Some(rec) = store.entries.get(&key_of(host, port, key_type)) {
if fingerprints_equal(&rec.fingerprint, fingerprint) {
return Verdict::Trusted;
}
return Verdict::Changed {
previous: rec.fingerprint.clone(),
};
}
// 同算法无记录,但同主机其它算法有记录:说明这个主机我们见过,
// 只是这次协商出了不同算法。仍按「未知」处理(要求确认),
// 但这是正常现象,日志里降级为 info 而非 warn。
let has_other_algo = store
.entries
.keys()
.any(|k| k.starts_with(&format!("{host}:{port}:")));
if has_other_algo {
crate::logger::log_info(
"terminal",
&format!("主机 {host}:{port} 提供了新的密钥算法 {key_type},需确认指纹"),
);
}
Verdict::Unknown
}
/// 指纹比较:忽略大小写与前缀差异。
///
/// SHA256 指纹在不同工具里可能表现为 `SHA256:AbC...` / `AbC...` / 末尾带 `=`
/// 这些差异不该被当作「指纹不同」(那会让用户看到惊悚的变更告警)。
fn fingerprints_equal(a: &str, b: &str) -> bool {
let norm = |s: &str| {
s.trim()
.trim_start_matches("SHA256:")
.trim_start_matches("MD5:")
.trim_end_matches('=')
.replace(':', "")
.to_lowercase()
};
norm(a) == norm(b)
}
/// 接受并记录指纹(首次或变更后)。
pub fn accept(host: &str, port: u16, fingerprint: &str, key_type: &str) -> Result<(), String> {
let mut slot = store_slot().lock().unwrap_or_else(|e| e.into_inner());
let Some(store) = slot.as_mut() else {
return Err("known_hosts 存储未初始化".to_string());
};
let k = key_of(host, port, key_type);
let now = chrono::Local::now().to_rfc3339();
match store.entries.get_mut(&k) {
Some(rec) => {
if !fingerprints_equal(&rec.fingerprint, fingerprint) {
// 记入变更历史(保留最近 20 条,避免无限增长)
rec.history.insert(
0,
FingerprintChange {
old_fingerprint: rec.fingerprint.clone(),
changed_at: now.clone(),
accepted: true,
},
);
rec.history.truncate(20);
rec.fingerprint = fingerprint.to_string();
}
rec.last_confirmed = now;
}
None => {
store.entries.insert(
k,
KnownHost {
host: host.to_string(),
port,
key_type: key_type.to_string(),
fingerprint: fingerprint.to_string(),
first_seen: now.clone(),
last_confirmed: now,
history: Vec::new(),
},
);
}
}
store.dirty = true;
persist(store)
}
/// 记录一次「拒绝」(仅记历史,不改指纹)。
///
/// 价值:用户拒绝后,下次连接还会弹出提示。历史里留下「曾在某时刻拒绝过」,
/// 便于事后审计——「谁在什么时候试图用新指纹冒充这台主机」。
pub fn record_rejection(host: &str, port: u16, fingerprint: &str, key_type: &str) {
let mut slot = store_slot().lock().unwrap_or_else(|e| e.into_inner());
let Some(store) = slot.as_mut() else { return };
let k = key_of(host, port, key_type);
if let Some(rec) = store.entries.get_mut(&k) {
rec.history.insert(
0,
FingerprintChange {
old_fingerprint: fingerprint.to_string(),
changed_at: chrono::Local::now().to_rfc3339(),
accepted: false,
},
);
rec.history.truncate(20);
store.dirty = true;
let _ = persist(store);
}
}
/// 列出全部记录(含历史),供设置页展示。
pub fn list() -> Vec<KnownHost> {
let slot = store_slot().lock().unwrap_or_else(|e| e.into_inner());
slot.as_ref()
.map(|s| s.entries.values().cloned().collect())
.unwrap_or_default()
}
/// 删除某条记录(用户清理失效主机时用)。
pub fn forget(host: &str, port: u16, key_type: &str) -> Result<(), String> {
let mut slot = store_slot().lock().unwrap_or_else(|e| e.into_inner());
let Some(store) = slot.as_mut() else {
return Err("known_hosts 存储未初始化".to_string());
};
store.entries.remove(&key_of(host, port, key_type));
store.dirty = true;
persist(store)
}
/// 清空全部记录(危险操作,前端需二次确认)。
pub fn clear() -> Result<(), String> {
let mut slot = store_slot().lock().unwrap_or_else(|e| e.into_inner());
let Some(store) = slot.as_mut() else {
return Err("known_hosts 存储未初始化".to_string());
};
store.entries.clear();
store.dirty = true;
persist(store)
}
/// 落盘(先写临时文件再 rename,避免半截 JSON)。
fn persist(store: &Store) -> Result<(), String> {
let list: Vec<&KnownHost> = store.entries.values().collect();
let json =
serde_json::to_string_pretty(&list).map_err(|e| format!("序列化 known_hosts 失败: {e}"))?;
if let Some(parent) = store.path.parent() {
std::fs::create_dir_all(parent).map_err(|e| format!("创建目录失败: {e}"))?;
}
let tmp = store.path.with_extension("json.tmp");
std::fs::write(&tmp, json).map_err(|e| format!("写入 known_hosts 失败: {e}"))?;
std::fs::rename(&tmp, &store.path).map_err(|e| format!("保存 known_hosts 失败: {e}"))
}
// ===== OpenSSH 格式互操作 =====
/// 导出为 OpenSSH `known_hosts` 文本格式。
///
/// 用途:(a) 用户可把记录带进命令行 ssh;(b) 便于人工审阅。
/// 输出是标准 `host:port keytype base64comment` 形态的 **hashed 形式**
/// 还是明文形式?这里选 **明文**:用户要能读懂、能 diff,才有审阅价值。
/// OpenSSH 本身也接受明文(`HashKnownHosts no`)。
///
/// 注意:我们只有指纹(SHA256 base64),没有完整公钥 blob,因此导出的
/// 第二列写 `SHA256:...` 形式的注释,**不是**可直接被 ssh 使用的完整格式。
/// 这一点必须在 UI 上说明,避免用户以为导出的文件能直接给 ssh 用。
pub fn export_openssh_text() -> String {
let mut out = String::from(
"# 由 Thing 终端模块导出\n\
# 注意:本文件仅用于人工审阅与记录迁移,第二列是指纹而非公钥 blob,\n\
# 不能直接作为 OpenSSH 的 known_hosts 使用。\n",
);
for h in list() {
out.push_str(&format!(
"{}:{} {} {}\n",
h.host, h.port, h.key_type, h.fingerprint
));
}
out
}
/// 从 OpenSSH `known_hosts` 文本导入指纹记录。
///
/// 支持的行形态(跳过注释与空行):
/// - `host:port keytype fingerprint`(本模块自己的导出格式)
/// - `host keytype fingerprint`
///
/// 返回成功导入的条数。
pub fn import_openssh_text(text: &str) -> Result<usize, String> {
let mut slot = store_slot().lock().unwrap_or_else(|e| e.into_inner());
let Some(store) = slot.as_mut() else {
return Err("known_hosts 存储未初始化".to_string());
};
let now = chrono::Local::now().to_rfc3339();
let mut count = 0usize;
for line in text.lines() {
let line = line.trim();
if line.is_empty() || line.starts_with('#') {
continue;
}
let parts: Vec<&str> = line.split_whitespace().collect();
if parts.len() < 3 {
continue;
}
// 解析 host[:port]
let (host, port) = match parts[0].rsplit_once(':') {
Some((h, p)) => match p.parse::<u16>() {
Ok(port) => (h.to_string(), port),
Err(_) => (parts[0].to_string(), 22),
},
None => (parts[0].to_string(), 22),
};
let key_type = parts[1].to_string();
let fingerprint = parts[2].to_string();
// 只接受指纹形态(SHA256:...)——完整公钥 blob 需要另外的解析路径,
// 且我们无法从它反推指纹而不引入更多依赖
if !fingerprint.starts_with("SHA256:") && !fingerprint.starts_with("MD5:") {
continue;
}
let k = key_of(&host, port, &key_type);
store.entries.insert(
k,
KnownHost {
host,
port,
key_type,
fingerprint,
first_seen: now.clone(),
last_confirmed: now.clone(),
history: Vec::new(),
},
);
count += 1;
}
store.dirty = true;
persist(store)?;
Ok(count)
}
File diff suppressed because it is too large Load Diff
+255
View File
@@ -0,0 +1,255 @@
//! SSH 连接池(P2 连接复用)。
//!
//! # 语义
//!
//! 同一「身份」(用户名 + 主机 + 端口 + 认证材料指纹)的多个会话
//! **共享同一条 SSH 连接**:第二个会话跳过 TCP / 握手 / 认证,直接在
//! 既有连接上开新的会话通道。与 OpenSSH ControlMaster 的行为一致:
//! - 打开:首个会话建立连接;
//! - 共享:后续会话引用计数 +1;
//! - 关闭:会话关闭只减引用并关闭**自己的 shell 通道**;
//! **最后一个引用释放时**才断开底层连接(含跳板机链)。
//!
//! # 为什么 Handle 必须经由池共享
//!
//! `russh::client::Handle` 不实现 `Clone`(内含 session actor 的接收端),
//! 此前每个 `SshSession` 独占一个 Handle,无从复用。池条目持有
//! `Arc<tokio::sync::Mutex<Option<Handle>>>` 槽位,会话间共享同一 Arc;
//! tokio Mutex(而非 std)是为了允许**连接建立期间跨 `.await` 持锁**——
//! 它天然串行化了「双击两个标签同时连同一主机」的竞态:后到者等待,
//! 先到者成功后直接复用。
//!
//! # 跳板机链的归属
//!
//! 经跳板链建立的连接,其跳板 Handle 挂在**池条目**上而不是首建会话上:
//! 否则首建会话关闭时会连带剪断仍在被其他会话使用的隧道。
//! 最后一个引用释放时,跳板与目标连接一起断开。
//!
//! # 已知取舍
//!
//! - 共享连接的 keepalive / 加密参数取自**首个**建立它的会话;
//! - 共享连接断开(网络故障)时,挂在上面的所有会话一起进入 Closed——
//! 这与「它们本来就在同一条 TCP 上」的物理事实一致;
//! - 远程转发(-R)的入站路由按端口做**全局**匹配(见 forward 模块),
//! 因为入站通道总是从属连接级 Handler,而 Handler 的 session_id 属于首建会话。
use std::collections::HashMap;
use std::sync::{Arc, Mutex};
use russh::client::Handle;
use russh::Disconnect;
use super::SshHandler;
/// 可克隆的池句柄(`TerminalManager` 持有一份,每个会话 clone 一份)。
#[derive(Clone, Default)]
pub struct ConnectionPool {
conns: Arc<Mutex<HashMap<String, PooledEntry>>>,
}
struct PooledEntry {
/// 共享槽位:`None` = 连接建立中(或失败);`Some` = 已就绪。
slot: Arc<tokio::sync::Mutex<Option<Handle<SshHandler>>>>,
/// 仍在使用此连接的会话数
refcount: usize,
/// 连接是否已就绪(同步可查;`has_handle` 用)
ready: bool,
/// 跳板机链的连接(经跳板建立时非空;随条目共享,最后释放时断开)
hops: Vec<Handle<SshHandler>>,
/// 日志用描述
label: String,
}
impl ConnectionPool {
/// 取(或创建)某身份的连接槽位,引用计数 +1。
///
/// 返回的 Arc 就是池条目里的槽位本身:会话把它存进 `SshInner.handle`
/// 连接建立后写 `Some(handle)`,同键的其他会话即刻可见。
pub fn slot(&self, key: &str) -> Arc<tokio::sync::Mutex<Option<Handle<SshHandler>>>> {
let mut conns = self.conns.lock().unwrap_or_else(|e| e.into_inner());
let entry = conns.entry(key.to_string()).or_insert_with(|| PooledEntry {
slot: Arc::new(tokio::sync::Mutex::new(None)),
refcount: 0,
ready: false,
hops: Vec::new(),
label: String::new(),
});
entry.refcount += 1;
entry.slot.clone()
}
/// 设置日志用描述(连接建立成功后调用)。
pub fn set_label(&self, key: &str, label: &str) {
if let Some(e) = self
.conns
.lock()
.unwrap_or_else(|x| x.into_inner())
.get_mut(key)
{
e.label = label.to_string();
}
}
/// 标记连接已就绪(do_connect 写入 Handle 之后)。
pub fn mark_ready(&self, key: &str) {
if let Some(e) = self
.conns
.lock()
.unwrap_or_else(|x| x.into_inner())
.get_mut(key)
{
e.ready = true;
}
}
/// 把跳板机连接挂到池条目上(fresh 连接路径、有跳板时调用一次)。
pub fn attach_hops(&self, key: &str, hops: Vec<Handle<SshHandler>>) {
if let Some(e) = self
.conns
.lock()
.unwrap_or_else(|x| x.into_inner())
.get_mut(key)
{
e.hops = hops;
}
}
/// 连接是否已就绪(同步可查;替代原 `SshSession::has_handle` 的语义)。
pub fn is_ready(&self, key: &str) -> bool {
self.conns
.lock()
.unwrap_or_else(|e| e.into_inner())
.get(key)
.is_some_and(|e| e.ready)
}
/// 释放一个会话的引用。
///
/// 返回 `Some((槽位, 跳板连接))` 表示这是**最后一个**引用——调用方负责
/// 断开底层连接与跳板(异步任务里做,见 `kill`)。非最后引用返回 `None`
/// 调用方只需关闭自己的 shell 通道。
pub fn release(
&self,
key: &str,
) -> Option<(
Arc<tokio::sync::Mutex<Option<Handle<SshHandler>>>>,
Vec<Handle<SshHandler>>,
)> {
let mut conns = self.conns.lock().unwrap_or_else(|e| e.into_inner());
let Some(entry) = conns.get_mut(key) else {
return None;
};
entry.refcount = entry.refcount.saturating_sub(1);
if entry.refcount > 0 {
return None;
}
// 最后一个引用:移除条目并交出断开责任
let entry = conns.remove(key)?;
Some((entry.slot, entry.hops))
}
}
/// 连接池身份键:用户名 + 主机 + 端口 + 认证方式 + 认证材料指纹。
///
/// 认证材料(密码或私钥文本)取短哈希入键——同一主机配置两份不同密钥/密码时
/// 不应共享连接(那等于用 A 的身份看了 B 的会话)。
pub fn pool_key_of(
username: &str,
host: &str,
port: u16,
auth_method: &str,
auth_material: Option<&str>,
) -> String {
let marker = match auth_material {
Some(m) => short_hash(m),
None => "none".to_string(),
};
format!("{username}|{host}:{port}|{auth_method}|{marker}")
}
/// 材料指纹:SHA-256 前 8 字节的十六进制(16 字符)。
fn short_hash(material: &str) -> String {
use sha2::{Digest, Sha256};
let digest = Sha256::digest(material.as_bytes());
digest[..8].iter().map(|b| format!("{b:02x}")).collect()
}
/// 断开一个 Handle(kill 与最后引用释放共用的收尾动作)。
pub async fn disconnect(handle: Handle<SshHandler>) {
let _ = handle
.disconnect(Disconnect::ByApplication, "closed by user", "")
.await;
}
#[cfg(test)]
mod tests {
use super::*;
/// 条目级语义测试:不涉及真实 Handle(槽位保持 None 即可)。
#[test]
fn acquire_increments_and_release_removes_on_last() {
let pool = ConnectionPool::default();
let s1 = pool.slot("k");
let s2 = pool.slot("k");
// 同键两次 acquire 返回同一个 Arc(这才是「共享」)
assert!(Arc::ptr_eq(&s1, &s2));
assert!(pool.release("k").is_none(), "还有 1 个引用,不应触发拆除");
let (slot, hops) = pool.release("k").expect("最后一个引用应触发拆除");
assert!(Arc::ptr_eq(&slot, &s1));
assert!(hops.is_empty());
// 移除后再次 acquire 得到全新条目
let s3 = pool.slot("k");
assert!(!Arc::ptr_eq(&s3, &s1));
pool.release("k");
}
#[test]
fn independent_keys_are_independent() {
let pool = ConnectionPool::default();
let a = pool.slot("a");
let b = pool.slot("b");
assert!(!Arc::ptr_eq(&a, &b));
assert!(pool.release("a").is_some());
assert!(pool.release("b").is_some());
}
#[test]
fn ready_flag_and_hops_follow_entry_lifecycle() {
let pool = ConnectionPool::default();
assert!(!pool.is_ready("k"));
pool.slot("k");
pool.slot("k"); // 两个会话共享
pool.mark_ready("k");
assert!(pool.is_ready("k"));
pool.attach_hops("k", Vec::new());
// 释放一个引用后条目仍在(另一个会话还在用),ready 保持
assert!(pool.release("k").is_none());
assert!(pool.is_ready("k"));
// 最后一个引用释放后条目消失
assert!(pool.release("k").is_some());
assert!(!pool.is_ready("k"));
}
#[test]
fn over_release_is_safe() {
let pool = ConnectionPool::default();
assert!(pool.release("ghost").is_none());
pool.slot("k");
pool.release("k");
// 多余的 release 不应 panicsaturating 语义)
let _ = pool.release("k");
}
#[test]
fn pool_key_distinguishes_identity() {
let k1 = pool_key_of("ops", "srv", 22, "key", Some("keytext"));
let k2 = pool_key_of("ops", "srv", 22, "key", Some("other-key"));
let k3 = pool_key_of("ops", "srv", 22, "key", Some("keytext"));
let k4 = pool_key_of("root", "srv", 22, "key", Some("keytext"));
assert_ne!(k1, k2, "不同认证材料不应共享连接");
assert_eq!(k1, k3, "相同身份应命中同一池条目");
assert_ne!(k1, k4, "不同用户不应共享连接");
// 无认证材料(理论上不出现)也不与他人混淆
let k5 = pool_key_of("ops", "srv", 22, "password", None);
assert_ne!(k1, k5);
}
}
+663
View File
@@ -0,0 +1,663 @@
//! SFTP 文件管理:复用 SSH 会话连接的双栏文件传输。
//!
//! # 为什么 SFTP 挂在会话上而不是独立连接
//!
//! 一台主机开两个 SSH 连接(一个 shell、一个 SFTP)有三个实际代价:
//! 1. **认证两次**——公钥还好,密码/2FA 场景下用户要输两遍;
//! 2. **服务端 `MaxStartups` / `MaxSessions` 限制**——内网跳板机经常卡这条;
//! 3. 两条连接的主机密钥都要各自校验,known_hosts 里同一台机器两份记录。
//!
//! SSH 协议本身就为此设计了 **subsystem channel**:在已认证的连接上开新通道,
//! `request_subsystem(true, "sftp")` 即可。因此 SFTP 面板只对**活跃的 SSH 会话**
//! 开放——本地 ConPTY 会话没有这条路径(本地文件用系统的资源管理器更合适)。
//!
//! # 一个 SFTP 客户端只能串行用一条通道
//!
//! `SftpSession` 内部是「请求 → 等响应」的请求/响应模型,**并发调用会因为
//! 响应乱序而错配**。russh-sftp 内部做了请求 id 匹配,因此 `&SftpSession` 上
//! 并发 `.await` 是安全的;但同一时刻大量并发(如递归上传 1000 个文件全并发)
//! 会把服务端的窗口打满并触发限流。
//!
//! 因此上传/下载走**受控并发**:由 `SftpHandle::semaphore` 限制在 4 路。
//!
//! # 断点续传
//!
//! 用 `OpenFlags::WRITE | CREATE` 打开已存在的文件,再 `seek` 到本地已有的
//! 大小继续写。服务端不支持 `append` 语义时(部分紫光的 sftp-server),
//! 退化为「整文件重传」——由 `resume_supported` 探测决定。
use std::sync::Arc;
use dashmap::DashMap;
use russh::client::Handle;
use russh_sftp::client::SftpSession;
use russh_sftp::protocol::OpenFlags;
use serde::{Deserialize, Serialize};
use specta::Type;
use tokio::io::{AsyncReadExt, AsyncSeekExt, AsyncWriteExt};
use tokio::sync::{Mutex, Semaphore};
use super::{SshHandler, SshSession};
/// 受控并发的上限。
///
/// 为什么是 4:单个 SFTP 通道的吞吐已接近链路带宽(有 32KB 报文窗口),
/// 再高的并发只是把服务端的 inflight 队列堆长,收益递减而内存占用线性增长。
/// 4 路足以让「大量小文件」这条慢路径(每文件一次 round-trip)提速约 3 倍。
const MAX_CONCURRENT_TRANSFERS: usize = 4;
/// 单次传输的分块大小。
///
/// 32KB 是 SFTP 协议默认的最大读报文(部分服务端放宽到 256KB,但 32KB
/// 是所有实现的**安全下界**)。取 32KB 而非更大:大块在丢包链路上重传代价高,
/// 而 32KB 已足够跑满千兆内网。
const CHUNK_SIZE: usize = 32 * 1024;
// ===== 数据模型 =====
/// 一个远端目录项(回传前端渲染)。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct RemoteEntry {
pub name: String,
/// 完整路径(服务端形态,`/` 分隔)
pub path: String,
/// "file" | "dir" | "symlink" | "other"
pub kind: String,
pub size: u64,
/// 修改时间(Unix 毫秒;服务端未提供时为 None)
pub modified_at: Option<u64>,
/// 权限位的八进制展示(如 "755");无权限信息时为空串
pub permissions: String,
/// 符号链接的目标(仅 kind == "symlink" 时非空)
pub link_target: String,
}
/// 目录列举结果。
///
/// 单独包一层而不是直接返回 `Vec`:前端需要 `cwd` 来确认「服务端实际解析到
/// 的目录」——符号链接目录下 `pwd` 与用户点的路径可能不同,这个字段让面包屑
/// 可以显示真实位置而不是用户以为的位置。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct RemoteDir {
/// 服务端规范化之后的目录(`canonicalize` 结果)
pub cwd: String,
pub entries: Vec<RemoteEntry>,
}
/// 传输进度事件负载。
#[derive(Debug, Clone, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct TransferProgress {
/// 传输任务 id(前端据此更新对应行的进度条)
pub id: String,
pub session_id: String,
/// "upload" | "download"
pub direction: String,
/// 源路径(展示用)
pub source: String,
/// 目标路径(展示用)
pub target: String,
/// 已传输字节
pub transferred: u64,
/// 总字节(未知时为 0
pub total: u64,
/// "running" | "done" | "failed" | "canceled"
pub state: String,
/// 失败原因
pub error: Option<String>,
}
// ===== 会话级 SFTP 句柄 =====
/// 一个会话的 SFTP 通道。
///
/// `SftpSession` 本身不是 `Sync` 的友好类型,且我们要在其上做「先查目录再写文件」
/// 这类多步操作,故用 `Mutex` 串行化**结构性操作**(建目录、删文件);
/// 大数据传输则只借用不可变引用(`&SftpSession` 的分块读写在 russh-sftp 内部
/// 有请求 id 匹配,可安全并发)。
pub struct SftpHandle {
/// 打开面板的会话 id。
///
/// 当前只有注册表的 key 用到会话 id,结构体内这份冗余字段暂无读者;
/// 保留它是为了 P2 的「跨会话传输」与日志定位(错误信息里需要会话上下文)。
#[allow(dead_code)]
pub session_id: String,
/// 串行闸门:保证「建目录 → 上传」这类有先后依赖的操作不会被乱序执行。
///
/// P0 的传输命令都是单步操作,尚无读者;P2 的组合操作(模板上传、
/// 递归同步)落地时启用。
#[allow(dead_code)]
pub gate: Mutex<()>,
pub sftp: SftpSession,
/// 并发闸门:限制同时在跑的大数据传输数量
pub semaphore: Semaphore,
/// 远端当前目录的缓存(`cwd` 跟随用;避免每次都 round-trip 取)
pub last_dir: Mutex<String>,
}
/// 所有活跃会话的 SFTP 通道表。
///
/// 与 `SessionRegistry` 同样的理由用 `DashMap`:查表极频繁(每个传输分块都要
/// 找 handle),而插入/删除只在打开/关闭面板时发生。
#[derive(Default)]
pub struct SftpRegistry {
handles: DashMap<String, Arc<SftpHandle>>,
}
impl SftpRegistry {
pub fn new() -> Self {
Self {
handles: DashMap::new(),
}
}
pub fn get(&self, session_id: &str) -> Option<Arc<SftpHandle>> {
self.handles.get(session_id).map(|e| e.value().clone())
}
pub fn insert(&self, session_id: String, handle: Arc<SftpHandle>) {
self.handles.insert(session_id, handle);
}
pub fn remove(&self, session_id: &str) -> Option<Arc<SftpHandle>> {
self.handles.remove(session_id).map(|(_, v)| v)
}
pub fn has(&self, session_id: &str) -> bool {
self.handles.contains_key(session_id)
}
/// 关闭某会话的 SFTP 通道(会话关闭时调用)。
pub fn close(&self, session_id: &str) {
self.handles.remove(session_id);
}
}
/// 在已有 SSH 会话上打开 SFTP subsystem。
///
/// # 前置条件
///
/// 会话必须已 `Established` 且持有可用的 `Handle`。若会话是本地 ConPTY
/// 或 SSH 尚未认证完成,这里会返回可读的错误而不是 panic。
///
/// # 为什么用 `spawn_blocking` 而不是直接 await
///
/// `Handle` 不实现 `Clone`,因此开通道必须**持有 `MutexGuard` 跨 await**。
/// 而 `std::sync::MutexGuard` 不是 `Send`,这让整个 future 也不是 `Send`
/// 无法交给 `tauri::async_runtime::spawn`Tauri 命令要求 `Send`)。
///
/// 解法:把「持锁 + 开通道」这一小段放进 `spawn_blocking`。它内部是
/// **阻塞的 tokio runtime block_on**,锁与 await 都限制在那个线程里,
/// 对外只返回值(`Channel` 是 `Send`)。代价是占一个线程约握手 RTT 的时间,
/// 而这只在用户点「打开文件管理器」时发生一次。
pub async fn open_subsystem(session: &SshSession) -> Result<Arc<SftpHandle>, String> {
// 先在外部确认会话可用(避免为一个必然失败的请求去占线程)
if !session.has_handle() {
return Err("SSH 会话尚未建立连接,无法打开文件管理器".to_string());
}
let channel = {
let inner = session.inner_shared();
// 把「加锁 → 开通道 → 请求 subsystem」整段移出 async 上下文。
// 槽位是 tokio MutexP2 连接复用),锁 `.await` 放进 block_on 里。
tokio::task::spawn_blocking(move || {
let rt = tokio::runtime::Handle::current();
rt.block_on(async {
let guard = inner.handle.lock().await;
let handle = guard
.as_ref()
.ok_or_else(|| "SSH 会话连接已断开,无法打开文件管理器".to_string())?;
let channel = handle
.channel_open_session()
.await
.map_err(|e| format!("打开 SFTP 通道失败: {e}"))?;
channel
.request_subsystem(true, "sftp")
.await
.map_err(|e| format!("请求 sftp 子系统失败(服务端可能未启用 SFTP): {e}"))?;
Ok::<_, String>(channel)
})
})
.await
.map_err(|e| format!("打开 SFTP 通道的任务异常退出: {e}"))?
}?;
let sftp = SftpSession::new(channel.into_stream())
.await
.map_err(|e| format!("初始化 SFTP 会话失败(可能是版本协商不兼容): {e}"))?;
// 初始目录:优先用户配置的 remote_cwd,否则用登录目录。
// `canonicalize(".")` 而不是直接用 ".":服务端的 SFTP 起点(chroot 场景下
// 是 `/`,普通场景下是 home)只有服务端知道,取回真实值前端才好画面包屑。
let initial = match sftp.canonicalize(".").await {
Ok(p) if !p.trim().is_empty() => p,
_ => ".".to_string(),
};
Ok(Arc::new(SftpHandle {
session_id: session.state.id.clone(),
gate: Mutex::new(()),
sftp,
semaphore: Semaphore::new(MAX_CONCURRENT_TRANSFERS),
last_dir: Mutex::new(initial),
}))
}
// ===== 目录操作 =====
/// 列举远端目录。
///
/// 排序在服务端做而不是让前端排:SFTP 的 `read_dir` 返回顺序是服务端的
/// 目录项物理顺序(通常是插入序),逐次调用结果不稳定;在这里排一次
/// 保证「刷新」不会让列表跳动。
pub async fn list_dir(handle: &SftpHandle, path: &str) -> Result<RemoteDir, String> {
// `read_dir` 返回 `ReadDir`(一个可迭代的句柄),**必须显式 collect**
// 它的迭代会持续向服务端发 READDIR 报文直到服务端返回 EOF,
// 不 collect 的话句柄被丢弃时可能留下未读完的报文,污染后续请求的响应队列。
let iter = handle
.sftp
.read_dir(path)
.await
.map_err(|e| format!("读取目录 {path} 失败: {e}"))?;
let mut list: Vec<RemoteEntry> = Vec::new();
for e in iter {
let name = e.file_name();
// `.` 与 `..` 由前端用面包屑表达,不混进列表(混进去会让「全选」误伤父目录)
if name == "." || name == ".." {
continue;
}
let meta = e.metadata();
// `file_type()` 来自协议 attrs`metadata()` 里**没有** `is_file()`
// ——`FileAttributes` 只提供 `is_dir()` / `is_symlink()` / `file_type()`。
// 因此「是不是普通文件」的判定必须落到 `file_type()` 上(`is_file()` 是
// `FileType` 的方法,不是 attrs 的)。
let ft = e.file_type();
let is_symlink = ft.is_symlink() || meta.is_symlink();
let kind = if is_symlink {
"symlink"
} else if ft.is_dir() || meta.is_dir() {
"dir"
} else if ft.is_file() {
"file"
} else {
"other"
};
// `mtime` 是 Unix 秒(SFTP v3 的 attrs 无亚秒精度),统一乘 1000 成毫秒。
// 服务端未提供时保持 None,前端显示为「—」而不是伪造的 1970 年。
let mtime = meta.mtime.map(|s| (s as u64) * 1000);
let perms = meta
.permissions
.map(|p| format!("{:o}", p & 0o7777))
.unwrap_or_default();
list.push(RemoteEntry {
name: name.clone(),
path: join_remote(path, &name),
kind: kind.to_string(),
size: meta.size.unwrap_or(0),
modified_at: mtime,
permissions: perms,
// `read_dir` 不带 link target,符号链接的目标要单独 `read_link`。
// 这里不逐条调用:一个含 200 个符号链接的目录会变成 200 次 round-trip。
// 前端在用户点击/悬停时再单独请求(见 `read_link` 命令)。
link_target: String::new(),
});
}
// 目录优先,其次按名称(用不区分大小写的比较,符合 Windows 用户直觉)
list.sort_by(|a, b| {
let a_dir = a.kind == "dir";
let b_dir = b.kind == "dir";
b_dir
.cmp(&a_dir)
.then_with(|| a.name.to_lowercase().cmp(&b.name.to_lowercase()))
});
let cwd = handle
.sftp
.canonicalize(path)
.await
.unwrap_or_else(|_| path.to_string());
*handle.last_dir.lock().await = cwd.clone();
Ok(RemoteDir {
cwd,
entries: list,
})
}
/// 拼接远端路径(POSIX 语义,注意不要产生 `//`)。
pub fn join_remote(base: &str, name: &str) -> String {
if base.is_empty() || base == "." {
return name.to_string();
}
if name.starts_with('/') {
return name.to_string();
}
if base.ends_with('/') {
format!("{base}{name}")
} else {
format!("{base}/{name}")
}
}
/// 取远端路径的父目录(用于「上一级」与面包屑)。
pub fn parent_remote(path: &str) -> String {
let trimmed = path.trim_end_matches('/');
// 根目录的父目录还是自己,避免前端无限上溯
if trimmed.is_empty() {
return "/".to_string();
}
match trimmed.rfind('/') {
Some(0) => "/".to_string(),
Some(i) => trimmed[..i].to_string(),
// 相对路径(服务端未 canonicalize 时):退化为当前目录
None => ".".to_string(),
}
}
/// 读符号链接的目标。
pub async fn read_link(handle: &SftpHandle, path: &str) -> Result<String, String> {
handle
.sftp
.read_link(path)
.await
.map_err(|e| format!("读取链接目标失败: {e}"))
}
/// 创建目录(递归)。
pub async fn create_dir_all(handle: &SftpHandle, path: &str) -> Result<(), String> {
// 逐级创建:SFTP 的 `create_dir` 不递归(与 `mkdir` 不同,没有 `-p`),
// 而 `create_dir_all` 在 russh-sftp 里不存在,只能自己走。
let mut cur = String::new();
for seg in path.trim_start_matches('/').split('/') {
if seg.is_empty() {
continue;
}
cur = if cur.is_empty() {
if path.starts_with('/') {
format!("/{seg}")
} else {
seg.to_string()
}
} else {
format!("{cur}/{seg}")
};
// 已存在是正常情况(多级创建的中途层级),忽略错误继续
let _ = handle.sftp.create_dir(&cur).await;
}
Ok(())
}
/// 删除远端文件。
pub async fn remove_file(handle: &SftpHandle, path: &str) -> Result<(), String> {
handle
.sftp
.remove_file(path)
.await
.map_err(|e| format!("删除文件失败: {e}"))
}
/// 递归删除远端目录。
///
/// 手写递归而不是 `remove_dir_all`:后者在部分服务端实现上对符号链接的处理
/// 不一致(有的会跟随链接删掉目标内容,这是**数据事故**)。这里显式判断
/// `symlink_metadata`,遇到符号链接只删链接本身。
pub async fn remove_dir_all(handle: &SftpHandle, path: &str) -> Result<u64, String> {
let mut removed: u64 = 0;
let iter = handle
.sftp
.read_dir(path)
.await
.map_err(|e| format!("读取目录 {path} 失败: {e}"))?;
let mut sub_dirs: Vec<String> = Vec::new();
let mut files: Vec<String> = Vec::new();
for e in iter {
let name = e.file_name();
if name == "." || name == ".." {
continue;
}
let full = join_remote(path, &name);
let ft = e.file_type();
let meta = e.metadata();
// 符号链接**先于** is_dir 判断:SFTP 的 attrs 对链接常会报告目标类型,
// 若先判 is_dir 会把链接当目录递归进去(删掉链接目标的真内容)。
if ft.is_symlink() || meta.is_symlink() {
files.push(full);
} else if ft.is_dir() || meta.is_dir() {
sub_dirs.push(full);
} else {
files.push(full);
}
}
// 先删文件再删子目录:先把当前层的文件清掉,收敛更快(失败时更容易定位)
for f in files {
handle
.sftp
.remove_file(&f)
.await
.map_err(|e| format!("删除 {f} 失败: {e}"))?;
removed += 1;
}
for d in sub_dirs {
removed += Box::pin(remove_dir_all(handle, &d)).await?;
}
handle
.sftp
.remove_dir(path)
.await
.map_err(|e| format!("删除目录 {path} 失败: {e}"))?;
Ok(removed + 1)
}
/// 重命名 / 移动。
pub async fn rename(handle: &SftpHandle, from: &str, to: &str) -> Result<(), String> {
handle
.sftp
.rename(from, to)
.await
.map_err(|e| format!("重命名失败: {e}"))
}
// ===== 上传 / 下载 =====
/// 上传本地文件到远端。
///
/// # 断点续传
///
/// 打开远端文件时**不加 `TRUNCATE`**,先 `metadata` 取已存在的大小,
/// 再 `seek` 到该位置继续写。若远端已有文件比本地大(本地被截断过),
/// 则退回整文件重传——继续写会得到一个「前长后短」的损坏文件。
pub async fn upload_file(
handle: &SftpHandle,
local: &str,
remote: &str,
on_progress: impl Fn(u64, u64),
) -> Result<u64, String> {
let _permit = handle
.semaphore
.acquire()
.await
.map_err(|e| format!("获取传输许可失败: {e}"))?;
let total = tokio::fs::metadata(local)
.await
.map_err(|e| format!("读取本地文件 {local} 失败: {e}"))?
.len();
// 远端已有大小(用于续传判断)
let existing = handle
.sftp
.metadata(remote)
.await
.ok()
.and_then(|m| m.size)
.unwrap_or(0);
let resume_from = if existing > 0 && existing < total {
existing
} else {
0
};
let flags = if resume_from > 0 {
OpenFlags::WRITE
} else {
OpenFlags::WRITE | OpenFlags::CREATE | OpenFlags::TRUNCATE
};
let mut remote_file = handle
.sftp
.open_with_flags(remote, flags)
.await
.map_err(|e| format!("打开远端文件 {remote} 失败: {e}"))?;
let mut local_file = tokio::fs::File::open(local)
.await
.map_err(|e| format!("打开本地文件 {local} 失败: {e}"))?;
if resume_from > 0 {
local_file
.seek(std::io::SeekFrom::Start(resume_from))
.await
.map_err(|e| format!("定位本地文件失败: {e}"))?;
remote_file
.seek(std::io::SeekFrom::Start(resume_from))
.await
.map_err(|e| format!("定位远端文件失败: {e}"))?;
}
let mut buf = vec![0u8; CHUNK_SIZE];
let mut sent = resume_from;
on_progress(sent, total);
loop {
let n = local_file
.read(&mut buf)
.await
.map_err(|e| format!("读取本地文件失败: {e}"))?;
if n == 0 {
break;
}
remote_file
.write_all(&buf[..n])
.await
.map_err(|e| format!("写入远端失败: {e}"))?;
sent += n as u64;
on_progress(sent, total);
}
// `shutdown` 会把 SFTP 的 close 报文发出去;不调用的话服务端可能迟迟不落盘
// (尤其写的是网络文件系统上的文件)。
remote_file
.shutdown()
.await
.map_err(|e| format!("关闭远端文件失败(数据可能未完整落盘): {e}"))?;
Ok(sent)
}
/// 从远端下载文件到本地。
///
/// 断点续传逻辑与上传对称:本地已有一部分则从该偏移继续。
pub async fn download_file(
handle: &SftpHandle,
remote: &str,
local: &str,
on_progress: impl Fn(u64, u64),
) -> Result<u64, String> {
let _permit = handle
.semaphore
.acquire()
.await
.map_err(|e| format!("获取传输许可失败: {e}"))?;
let total = handle
.sftp
.metadata(remote)
.await
.ok()
.and_then(|m| m.size)
.unwrap_or(0);
let existing = tokio::fs::metadata(local)
.await
.map(|m| m.len())
.unwrap_or(0);
let resume_from = if existing > 0 && total > 0 && existing < total {
existing
} else {
0
};
let mut remote_file = handle
.sftp
.open(remote)
.await
.map_err(|e| format!("打开远端文件 {remote} 失败: {e}"))?;
// 确保父目录存在(下载到新目录时很常见)
if let Some(parent) = std::path::Path::new(local).parent() {
let _ = tokio::fs::create_dir_all(parent).await;
}
let mut local_file = tokio::fs::OpenOptions::new()
.create(true)
.write(true)
.truncate(resume_from == 0)
.open(local)
.await
.map_err(|e| format!("创建本地文件 {local} 失败: {e}"))?;
if resume_from > 0 {
remote_file
.seek(std::io::SeekFrom::Start(resume_from))
.await
.map_err(|e| format!("定位远端文件失败: {e}"))?;
local_file
.seek(std::io::SeekFrom::Start(resume_from))
.await
.map_err(|e| format!("定位本地文件失败: {e}"))?;
}
let mut buf = vec![0u8; CHUNK_SIZE];
let mut got = resume_from;
on_progress(got, total);
loop {
let n = remote_file
.read(&mut buf)
.await
.map_err(|e| format!("读取远端失败: {e}"))?;
if n == 0 {
break;
}
local_file
.write_all(&buf[..n])
.await
.map_err(|e| format!("写入本地文件失败: {e}"))?;
got += n as u64;
on_progress(got, total);
}
local_file
.flush()
.await
.map_err(|e| format!("刷新本地文件失败: {e}"))?;
Ok(got)
}
/// 类型占位:确保 `SshHandler` 与 `Handle<SshHandler>` 的关联在编译期成立。
#[allow(dead_code)]
fn _assert_handle_type(h: &Handle<SshHandler>) -> &Handle<SshHandler> {
h
}
+147
View File
@@ -0,0 +1,147 @@
//! 终端窗口管理。
//!
//! # 设计取舍:一个会话一个窗口,而非一个窗口多个会话
//!
//! 有两条路可走:
//!
//! | 方案 | 优势 | 代价 |
//! |---|---|---|
//! | 一个独立窗口承载全部会话(把主窗口的终端 UI 整体搬出去) | 实现简单,复用全部前端组件 | 无法「只把一个会话拖出来」;两处 UI 状态要同步 |
//! | **一个会话一个窗口** | 符合「拖出标签成窗」的直觉;窗口粒度与会话粒度一致,状态无歧义 | 每窗口一个 WebView,内存开销更大 |
//!
//! 选后者。理由:终端的核心使用场景就是「同时盯几台机器的输出」,把其中一个
//! 会话丢到第二块屏幕是所有终端工具的刚需;而窗口粒度与会话粒度一致,意味着
//! 「关闭窗口」= 「关闭会话」,没有隐藏状态,心智负担最小。
//!
//! 内存开销通过限制窗口数量([`MAX_DETACHED_WINDOWS`])来控制。
//!
//! # 会话与窗口的关系
//!
//! 会话**不随窗口创建而创建**。用户点「在新窗口打开」时,会话已经在主窗口里
//! 跑着(进程在 Rust 侧),窗口只是**另一个 attach 到这个会话的视图**。
//! 这带来两个后果:
//! 1. 主窗口关闭(隐藏到托盘)不影响终端窗口 —— 会话在 Rust 侧,与窗口无关。
//! 2. 同一个会话可以同时显示在主窗口与独立窗口(输出事件是广播的)。
//! 这是刻意的:用户可以在主窗口把某个会话放进分屏、同时另开一个窗口放大看。
use tauri::{AppHandle, Manager, WebviewUrl, WebviewWindowBuilder};
use super::session::SessionId;
use crate::constants::windows as W;
/// 同时存在的独立终端窗口上限。
///
/// 8 是个经验值:每个终端窗口都是一个独立 WebView(各自约 40~80MB),
/// 再多会明显吃内存;而「同时盯 8 个终端」已覆盖绝大多数实际需求。
/// 超出时明确报错而不是静默失败——用户需要知道是上限拦住了他。
pub const MAX_DETACHED_WINDOWS: usize = 8;
/// 计算会话对应的窗口 label。
pub fn label_for(session_id: &str) -> String {
format!("{}-{}", W::TERMINAL_WINDOW, session_id)
}
/// 当前有多少个终端独立窗口。
pub fn count_windows(app: &AppHandle) -> usize {
app.webview_windows()
.keys()
.filter(|k| k.starts_with(&format!("{}-", W::TERMINAL_WINDOW)))
.count()
}
/// 打开(或聚焦)某会话的独立窗口。
///
/// 幂等:窗口已存在时只做 `show` + `set_focus`,不重建 WebView。
/// 重建会丢失 xterm 的滚动缓冲(虽然内容可从会话快照恢复,但没必要多此一举)。
pub fn open_for_session(
app: &AppHandle,
session_id: &SessionId,
title: &str,
) -> Result<(), String> {
let label = label_for(session_id);
if let Some(win) = app.get_webview_window(&label) {
win.show().map_err(|e| format!("显示窗口失败: {e}"))?;
win.set_focus().map_err(|e| format!("聚焦窗口失败: {e}"))?;
return Ok(());
}
let n = count_windows(app);
if n >= MAX_DETACHED_WINDOWS {
return Err(format!(
"已达独立终端窗口上限({MAX_DETACHED_WINDOWS} 个)。\
请先关闭一些窗口,或改为在主窗口内使用标签页。"
));
}
// 窗口尺寸:终端是「宽而扁」的,给一个偏宽的默认值,接近常见终端习惯
let win = WebviewWindowBuilder::new(
app,
&label,
// 路由到前端的 terminal 独立窗口入口(main.ts 中按 hash 分派)
WebviewUrl::App(format!("index.html#terminal-window/{session_id}").into()),
)
.title(format!("终端 · {title}"))
.inner_size(1000.0, 620.0)
.min_inner_size(420.0, 240.0)
.resizable(true)
// 无系统边框:窗口内自绘标题栏(TerminalWindow.vue),系统标题栏会与之叠加
.decorations(false)
// 无边框窗口默认没有投影,加上以保持与系统窗口一致的层次感
.shadow(true)
.center()
.build()
.map_err(|e| format!("创建终端窗口失败: {e}"))?;
// 关闭窗口时:**只关窗口,不关会话**。
//
// 这是刻意的语义选择。若「关窗即关会话」,用户移动窗口时误点关闭就会
// 丢掉一个正在跑长任务的 SSH 连接;而保留会话的代价只是列表里多一个标签。
// 需要在窗口里显式提供「关闭会话」按钮,让两个动作分离。
let app_handle = app.clone();
let sid = session_id.clone();
win.on_window_event(move |event| {
if let tauri::WindowEvent::Destroyed = event {
// 把会话标记回「未分离」状态,前端的标签列表据此恢复显示
if let Ok(state) = super::manager(&app_handle) {
if let Some(s) = state.sessions.get(&sid) {
s.set_detached(false);
}
}
}
});
Ok(())
}
/// 关闭某会话的独立窗口(会话本身保留)。
pub fn close_for_session(app: &AppHandle, session_id: &SessionId) -> Result<(), String> {
let label = label_for(session_id);
if let Some(win) = app.get_webview_window(&label) {
win.close().map_err(|e| format!("关闭窗口失败: {e}"))?;
}
Ok(())
}
/// 把会话的 `detached` 标记与窗口状态对齐。
///
/// 应用启动后(或窗口被外部关闭后)可能存在不一致:标记说已分离但窗口不在。
/// 由命令层在查询会话列表前调用一次,保证前端拿到的状态是准确的。
///
/// 返回**是否有任何标记被修正**:调用方(`terminal_list_sessions`)据此决定
/// 是否需要再取一次列表——无变更时直接复用第一次的结果,省掉一次全表遍历。
pub fn reconcile_flags(app: &AppHandle, sessions: &[(SessionId, bool)]) -> bool {
let mut changed = false;
for (id, marked) in sessions {
let exists = app.get_webview_window(&label_for(id)).is_some();
if *marked != exists {
if let Ok(state) = super::manager(app) {
if let Some(s) = state.sessions.get(id) {
s.set_detached(exists);
changed = true;
}
}
}
}
changed
}
+91 -23
View File
@@ -43,12 +43,12 @@ impl AiEngine {
/// API 根地址。容错处理:用户常把完整端点(`.../chat/completions`)直接粘进来,
/// 若不在末尾剥掉,就会拼出 `.../chat/completions/chat/completions`
/// 而这类错误在上游表现为 404,排查成本远高于此处一行判断。
fn api_root(&self) -> Result<String, TranslateError> {
let raw = self.cfg.base_url.trim();
fn api_root(cfg: &TranslateEngineConfig) -> Result<String, TranslateError> {
let raw = cfg.base_url.trim();
if raw.is_empty() {
return Err(TranslateError::config(format!(
"引擎「{}」尚未配置 Base URL",
self.cfg.name
cfg.name
)));
}
if !(raw.starts_with("http://") || raw.starts_with("https://")) {
@@ -66,36 +66,36 @@ impl AiEngine {
Ok(root)
}
fn chat_endpoint(&self) -> Result<String, TranslateError> {
Ok(format!("{}/chat/completions", self.api_root()?))
fn chat_endpoint(cfg: &TranslateEngineConfig) -> Result<String, TranslateError> {
Ok(format!("{}/chat/completions", Self::api_root(cfg)?))
}
fn models_endpoint(&self) -> Result<String, TranslateError> {
Ok(format!("{}/models", self.api_root()?))
fn models_endpoint(cfg: &TranslateEngineConfig) -> Result<String, TranslateError> {
Ok(format!("{}/models", Self::api_root(cfg)?))
}
/// 密钥只从系统凭据管理器读,不进配置文件、不经前端。
fn api_key(&self) -> String {
crate::translate::engine_api_key(&self.cfg.id)
fn api_key(cfg: &TranslateEngineConfig) -> String {
crate::translate::engine_api_key(&cfg.id)
}
fn require_key(&self) -> Result<String, TranslateError> {
let key = self.api_key();
fn require_key(cfg: &TranslateEngineConfig) -> Result<String, TranslateError> {
let key = Self::api_key(cfg);
if key.trim().is_empty() {
return Err(TranslateError::auth(format!(
"引擎「{}」尚未配置 API Key,请在翻译设置中填写",
self.cfg.name
cfg.name
)));
}
Ok(key)
}
fn require_model(&self) -> Result<String, TranslateError> {
let model = self.cfg.model.trim();
fn require_model(cfg: &TranslateEngineConfig) -> Result<String, TranslateError> {
let model = cfg.model.trim();
if model.is_empty() {
return Err(TranslateError::config(format!(
"引擎「{}」尚未选择模型,可在设置中拉取模型列表后选择",
self.cfg.name
cfg.name
)));
}
Ok(model.to_string())
@@ -162,9 +162,9 @@ impl TranslateEngine for AiEngine {
if req.text.trim().is_empty() {
return Err(TranslateError::empty());
}
let key = self.require_key()?;
let model = self.require_model()?;
let endpoint = self.chat_endpoint()?;
let key = Self::require_key(&self.cfg)?;
let model = Self::require_model(&self.cfg)?;
let endpoint = Self::chat_endpoint(&self.cfg)?;
let mut body = serde_json::Map::new();
body.insert("model".to_string(), json!(model));
@@ -267,9 +267,9 @@ impl TranslateEngine for AiEngine {
if req.text.trim().is_empty() && req.image_png.is_none() {
return Err(TranslateError::empty());
}
let key = self.require_key()?;
let model = self.require_model()?;
let endpoint = self.chat_endpoint()?;
let key = Self::require_key(&self.cfg)?;
let model = Self::require_model(&self.cfg)?;
let endpoint = Self::chat_endpoint(&self.cfg)?;
let mut body = serde_json::Map::new();
body.insert("model".to_string(), json!(model));
@@ -389,8 +389,8 @@ impl TranslateEngine for AiEngine {
}
async fn list_models(&self) -> Result<Vec<String>, TranslateError> {
let key = self.require_key()?;
let endpoint = self.models_endpoint()?;
let key = Self::require_key(&self.cfg)?;
let endpoint = Self::models_endpoint(&self.cfg)?;
let resp = self
.client
.get(&endpoint)
@@ -591,3 +591,71 @@ struct ModelEntry {
#[serde(default)]
id: String,
}
/// 通用(非翻译语义)的对话补全入口:供终端 AI 助手等模块复用引擎配置。
///
/// 与翻译路径共享端点归一(剥 `/chat/completions` 后缀)、密钥存取
/// (凭据管理器)、`apply_common_params`temperature / max_tokens / extra_body
/// 与响应解析,但 **消息由调用方全量给定**——这里不含任何翻译提示词语义。
///
/// 刻意做成关联函数而不是 `AiEngine` 的实例方法:调用方(终端助手)只持有
/// `TranslateEngineConfig`,为它构造 `AiEngine` 还要 PromptTemplates 与 client
/// 属于无谓的耦合。
pub async fn chat_once(
cfg: &TranslateEngineConfig,
messages: Vec<(&str, String)>,
) -> Result<String, String> {
let key = AiEngine::require_key(cfg).map_err(|e| e.to_string())?;
let model = AiEngine::require_model(cfg).map_err(|e| e.to_string())?;
let endpoint = AiEngine::chat_endpoint(cfg).map_err(|e| e.to_string())?;
let mut body = serde_json::Map::new();
body.insert("model".to_string(), json!(model));
body.insert("stream".to_string(), json!(false));
body.insert(
"messages".to_string(),
json!(messages
.into_iter()
.map(|(role, content)| json!({ "role": role, "content": content }))
.collect::<Vec<_>>()),
);
apply_common_params(&mut body, cfg);
let client = reqwest::Client::new();
let resp = client
.post(&endpoint)
.bearer_auth(&key)
.timeout(Duration::from_millis(cfg.timeout_ms.max(1000)))
.json(&serde_json::Value::Object(body))
.send()
.await
.map_err(|e| classify_reqwest(e, &cfg.name).to_string())?;
let status = resp.status();
let raw = resp
.text()
.await
.map_err(|e| format!("读取「{}」响应失败: {e}", cfg.name))?;
if !status.is_success() {
return Err(classify_http(status.as_u16(), &raw, &cfg.name, &model).to_string());
}
let parsed: ChatResponse = serde_json::from_str(&raw)
.map_err(|e| format!("{}」响应不是预期的 JSON: {e}", cfg.name))?;
if let Some(err) = parsed.error {
let msg = err
.message
.filter(|m| !m.trim().is_empty())
.unwrap_or_else(|| "上游返回了错误对象".to_string());
return Err(format!("{}」返回错误:{msg}", cfg.name));
}
parsed
.choices
.into_iter()
.next()
.and_then(|c| c.message.content)
.map(|s| s.trim().to_string())
.filter(|s| !s.is_empty())
.ok_or_else(|| format!("{}」返回了空内容", cfg.name))
}
+4 -1
View File
@@ -50,9 +50,12 @@ pub use engines::{TranslateEngine, TranslateError, TranslateResult};
// `engines::` / `settings::` 下,等真正用到时再提升到此处——提前摆出一堆无人消费的再导出,
// 只会让「谁在用」更难判断。
pub use settings::TranslateSettings;
// 终端 AI 助手(terminal/assistant.rs)复用引擎配置与通用对话补全——
// 「现在真正用到了」,按上面的原则提升到此处。
pub use settings::TranslateEngineConfig;
pub use engines::ai::chat_once;
use engines::EngineRequest;
use settings::TranslateEngineConfig;
use std::path::PathBuf;
use std::sync::Mutex;
use std::time::{Duration, Instant};
+15 -1
View File
@@ -35,7 +35,7 @@ watch(
<div
v-if="activeComponent"
:key="activeModule"
class="min-h-full w-full"
class="h-full w-full"
>
<component :is="activeComponent" />
</div>
@@ -76,6 +76,20 @@ watch(
</template>
<style scoped>
/*
* 穿透 reka-ui ScrollArea 的内部 content wrapper。
*
* reka 的 viewportoverflow 滚动容器)与我们的内容之间还有一层**无高度样式的
* div**,百分比高度链在这里断掉——模块根的 `h-full` 解析为 auto,全高模块
* (终端/翻译)塌缩成内容高度,表现为卡片下方留白。给它显式 100%:
* 内容矮于视口时撑满,高于视口时溢出仍由 viewport 滚动(scrollHeight 计入
* 后代溢出),两种场景都不破坏。限定 data-main-scroll 只作用于主滚动区,
* 不影响模块内部的局部 ScrollArea。
*/
:deep([data-main-scroll] [data-reka-scroll-area-viewport] > div) {
height: 100%;
}
.fade-slide-enter-active,
.fade-slide-leave-active {
transition: all 0.3s ease;
+517
View File
@@ -0,0 +1,517 @@
import { computed, ref, watch, type Ref } from 'vue'
import { useTerminalStore } from '@/stores/terminalStore'
import { createLogger } from '@/lib/logger'
import type { ShortcutBinding, TerminalSettings } from '@/types/terminal'
import { TERMINAL_ACTIONS } from '@/lib/terminalActions'
const logger = createLogger('terminal')
/**
* 终端会话的窗口级编排。
*
* # 职责划分
*
* | 层 | 职责 |
* |---|---|
* | `TerminalPane` | 一个 xterm 实例 ↔ 一个 sessionId 的绑定(渲染与输入) |
* | `useTerminalStream`(本文件) | 窗口级状态:标签顺序、活跃标签、分屏布局、快捷键解析 |
* | `TerminalModule` | 主窗口的页面骨架(侧栏 + 标签 + 面板) |
* | `TerminalWindow` | 独立窗口的骨架(单个会话,无侧栏) |
*
* 抽出来是因为主窗口与独立窗口需要**同一套**会话状态与快捷键逻辑,
* 差别只在「渲染什么」。若各自实现一遍,两边行为迟早分叉。
*/
export function useTerminalStream(options?: { fixedSessionId?: Ref<string | null> }) {
const store = useTerminalStore()
/** 主窗口下「当前聚焦」的会话(独立窗口下恒为 fixedSessionId */
const activeSessionId = ref<string | null>(null)
/** 标签展示顺序(用户可拖动重排;与 store.sessions 解耦,避免后端刷新打乱用户排序) */
const tabOrder = ref<string[]>([])
/** 分屏:当前标签内并列展示的会话(长度为 1 时即普通单面板) */
const panes = ref<Array<{ id: string; sessionId: string }>>([])
/**
* 当前打开的浮层。
*
* `snippets` 与 `search` 与其余项的区别:它们需要知道「当前作用于哪个会话」,
* 而不只是一个全局面板。因此 TerminalModule 渲染它们时会把 activeSession
* 一并传下去 —— 片段面板据此过滤出对当前 shell 可用的片段。
*/
const overlay = ref<
'none' | 'settings' | 'hosts' | 'keys' | 'knownHosts' | 'search' | 'snippets' | 'history'
>('none')
/** 搜索结果统计(供搜索栏显示「第 n 项」) */
const searchTerm = ref('')
// ===== 标签 =====
/** 按标签顺序排列的会话列表 */
const orderedSessions = computed(() => {
const byId = new Map(store.sessions.map(s => [s.id, s]))
const ordered = tabOrder.value.map(id => byId.get(id)).filter(Boolean) as typeof store.sessions
// 后端新增但还没进 tabOrder 的会话(如从独立窗口或快捷键新建)追加到末尾,
// 否则会出现「新建了会话但标签栏看不到」的迷惑现象
for (const s of store.sessions) {
if (!tabOrder.value.includes(s.id)) ordered.push(s)
}
return ordered
})
const activeSession = computed(() =>
activeSessionId.value ? store.sessionById(activeSessionId.value) : undefined
)
/** 同步 tabOrder:加入新会话、剔除已删除的 */
function syncTabOrder() {
const alive = new Set(store.sessions.map(s => s.id))
// 先剔除消失的
const next = tabOrder.value.filter(id => alive.has(id))
// 再追加新增的(保持后端返回顺序)
for (const s of store.sessions) {
if (!next.includes(s.id)) next.push(s.id)
}
tabOrder.value = next
}
/**
* 写回用户拖动后的标签顺序。
*
* 必须过滤掉不在当前会话集合里的 id:若不做这层校验,用户在拖动过程中
* 恰好有会话退出,传进来的 ids 会包含一个已消失的会话,
* 而 `orderedSessions` 会把它当成「tabOrder 里查不到的 id」反复过滤 ——
* 结果是标签顺序看起来正常,但 syncTabOrder 之后又被打乱。
*/
function applyOrder(ids: string[]) {
const alive = new Set(store.sessions.map(s => s.id))
const next = ids.filter(id => alive.has(id))
for (const s of store.sessions) {
if (!next.includes(s.id)) next.push(s.id)
}
tabOrder.value = next
}
function selectSession(id: string) {
activeSessionId.value = id
}
/**
* 关闭标签:先判断是否需要二次确认。
*
* 标签内含分屏时,关闭标签会连带关掉其中的**所有**会话 ——
* 因此确认文案必须提这一点,否则用户会以为只关掉当前聚焦的那一个。
*/
async function closeTab(sessionId: string) {
// 收集本标签(分屏容器)里的全部会话。
// **只有被关的会话本身在当前分屏组里**才按组关闭——
// 此前的实现只看 `panes.length > 1`,在分屏激活时从标签栏
// 关闭一个无关的后台标签,会误把分屏组里的会话全部关掉。
const inCurrentGroup = panes.value.some(p => p.sessionId === sessionId)
const group =
inCurrentGroup && panes.value.length > 1
? panes.value.map(p => p.sessionId)
: [sessionId]
const groupSet = new Set(group)
try {
// 只要组里有任意一个仍活跃就要确认(而不是只看被点的那一个)
let anyAlive = false
for (const id of group) {
try {
if (await store.sessionAlive(id)) {
anyAlive = true
break
}
} catch {
/* 单个查询失败按不活跃处理,下面还有整体兜底 */
}
}
if (anyAlive) {
const info = store.sessionById(sessionId)
const extra = group.length > 1 ? `(该标签含 ${group.length} 个分屏面板)` : ''
const ok = await requestConfirm(
sessionId,
info?.title || '会话',
`该会话中可能有正在运行的任务${extra}。关闭后无法恢复,确定继续?`
)
if (!ok) return
}
} catch (e) {
// 会话可能已经断开(alive 查询本身失败)——此时无需确认,直接关
logger.warn(`查询会话存活状态失败,直接关闭:${String(e)}`)
}
for (const id of group) {
try {
await store.closeSession(id)
} catch (e) {
logger.warn(`关闭会话 ${id} 失败:${String(e)}`)
}
}
// 关闭后把焦点移到相邻标签,而不是留一个空面板
const idx = tabOrder.value.indexOf(sessionId)
syncTabOrder()
const fallback = tabOrder.value[Math.min(idx, tabOrder.value.length - 1)] ?? null
activeSessionId.value = fallback
// 分屏容器随之重置到新焦点:跨标签保留分屏组合没有意义
resetPanesTo(fallback)
void groupSet
}
/** 关闭标签的确认请求(由 TerminalModule 渲染模态框) */
const confirmDialog = ref<{
title: string
message: string
resolve: (ok: boolean) => void
} | null>(null)
function requestConfirm(sessionId: string, title: string, message: string): Promise<boolean> {
return new Promise(resolve => {
confirmDialog.value = { title: `${title} · ${sessionId}`, message, resolve }
})
}
function resolveConfirm(ok: boolean) {
confirmDialog.value?.resolve(ok)
confirmDialog.value = null
}
function cycleTab(delta: number) {
const list = orderedSessions.value
if (list.length === 0) return
const cur = activeSessionId.value ? list.findIndex(s => s.id === activeSessionId.value) : -1
// 取模保证在 [0, len) 内循环(JS 的 % 对负数返回负值,需修正)
const next = (((cur + delta) % list.length) + list.length) % list.length
activeSessionId.value = list[next].id
}
function selectTabByIndex(i: number) {
const s = orderedSessions.value[i]
if (s) activeSessionId.value = s.id
}
// ===== 新建会话 =====
/** 新建本地会话(用设置里的默认 shell) */
async function newLocalTab(cwd?: string) {
const shellId = store.settings?.lastShellId || store.shells.find(s => s.enabled)?.id
if (!shellId) {
logger.error('没有可用的 Shell,无法新建会话')
return null
}
try {
// 尺寸给一个合理初值:真实值由 xterm 的 fit 在挂载后立即上报,
// 这里的作用只是让 PTY 在首帧有正确的行列数,避免 shell 先按 80x24 画一遍提示符再重排
const info = await store.openLocal(shellId, cwd, 120, 30)
syncTabOrder()
activeSessionId.value = info.id
return info
} catch (e) {
logger.error(`新建本地会话失败:${String(e)}`)
throw e
}
}
/** 新建 SSH 会话 */
async function newSshTab(hostId: string) {
try {
const info = await store.openSsh(hostId, 120, 30)
syncTabOrder()
activeSessionId.value = info.id
return info
} catch (e) {
logger.error(`连接主机 ${hostId} 失败:${String(e)}`)
throw e
}
}
// ===== 分屏 =====
//
// # 为什么分屏面板**共享同一个会话**而不是各自开新会话
//
// 用户的诉求通常是「同一个目录下,一边跑构建一边看日志」——需要的是
// **两条独立 shell**(各自有独立的进程组、独立的中断语义),但若为此
// 复制一个 xterm 实例,两块画面会争抢输出、互相覆盖。
//
// 所以这里的设计是:分屏 = **新建会话 + 在同一标签内并排渲染**。
// 每条分屏有自己的 sessionId、自己的 xterm 实例,只是共享标签页的容器。
// 这与 tmux 的「split 出一个新 pane」是同一语义。
//
// # 上限为什么是 2×2 而不是「无限分屏」
//
// 每个面板持有一个 WebGL 上下文(见 TerminalModule 的说明),
// 4 个已经是常见集显的舒适上限;再多会出现上下文丢失导致画面变黑。
// 设置里的 `layout.maxPanes` 允许下调(不能上调超过 4)。
/** 分屏上限(后端 settings 封顶 4,此处再兜一次) */
function maxPanes(): number {
const v = store.settings?.layout.maxPanes ?? 4
return Math.min(Math.max(1, v), 4)
}
/** 当前分屏布局(1 = 单面板;2 = 左右或上下;3~4 = 2×2 */
const splitLayout = computed(() => {
const n = panes.value.length
if (n <= 1) return 'single'
if (n === 2) return splitDirection.value === 'down' ? 'v-split' : 'h-split'
return 'grid'
})
/** 两分屏时的方向(由首次分屏的动作决定,后续沿用) */
const splitDirection = ref<'right' | 'down'>('right')
/**
* 在分屏中追加一个面板。
*
* 新面板要新建会话还是复用已有会话由调用方决定 —— 这里只负责容器布局。
* 返回 null 表示已达上限(调用方据此提示用户,而不是静默失败)。
*/
function addPane(sessionId: string): boolean {
if (panes.value.length >= maxPanes()) return false
panes.value = [...panes.value, { id: `pane-${sessionId}`, sessionId }]
return true
}
/**
* 关闭一个分屏面板。
*
* 只从布局里移除,**不关闭会话** —— 分屏是视图层概念,
* 「关掉这块画面」与「杀掉这个 shell」是两个不同的意图,
* 后者应该走 closeTab(带运行中确认)。
*/
function removePane(sessionId: string) {
panes.value = panes.value.filter(p => p.sessionId !== sessionId)
// 焦点落在被移除的面板上时,转移到剩下的第一个
if (activeSessionId.value === sessionId) {
activeSessionId.value = panes.value[0]?.sessionId ?? null
}
}
/**
* 把布局重置为「只有当前激活会话」。
*
* 切换标签时必须做这件事:`panes` 是**标签级**的容器状态,
* 若切标签后仍保留上一个标签的分屏组合,用户会看到一组
* 与当前标签无关的会话并排出现。
*/
function resetPanesTo(sessionId: string | null) {
panes.value = sessionId ? [{ id: `pane-${sessionId}`, sessionId }] : []
}
/** 分屏模式是否开启(>1 个面板) */
const isSplit = computed(() => panes.value.length > 1)
/**
* 向右分屏:新建一个会话作为右侧面板。
*
* # 为什么新面板默认是本地 Shell 而不是复制当前 SSH 主机
*
* 「复制当前会话」听起来更贴心,但真正需要的场景(远端作业 + 本地看日志)
* 反而更常见,而复制一个 SSH 连接要多付一次认证与一条 TCP。
* 想要第二个 SSH 面板的用户可以点侧栏里的主机 —— 一次点击,无需确认。
*/
async function splitRight() {
return splitTo('right')
}
async function splitDown() {
return splitTo('down')
}
async function splitTo(dir: 'right' | 'down') {
if (panes.value.length >= maxPanes()) {
return { ok: false, message: `分屏数已达上限(${maxPanes()} 个),请先关闭一些面板` }
}
if (panes.value.length === 0 && activeSessionId.value) {
// 首次分屏:把当前会话放进容器
resetPanesTo(activeSessionId.value)
}
splitDirection.value = dir
const anchor = activeSessionId.value
const info = await newLocalTab()
if (!info) {
return { ok: false, message: '没有可用的 Shell,无法新建分屏面板' }
}
if (!addPane(info.id)) {
// 已达上限:把刚建的会话收掉,不留一个看不见的孤儿会话
await store.closeSession(info.id)
return { ok: false, message: `分屏数已达上限(${maxPanes()} 个)` }
}
// 焦点留在原面板(分屏的语义是「增加视野」,不是「切换过去」);
// 用户按 Ctrl+Tab 或点击即可切换。若原面板不存在才落到新面板。
activeSessionId.value = anchor && store.sessionById(anchor) ? anchor : info.id
return { ok: true, message: '' }
}
/** 关闭当前分屏(保留会话) */
function closePane() {
if (!isSplit.value) {
return { ok: false, message: '当前没有分屏' }
}
const id = activeSessionId.value
if (!id) return { ok: false, message: '没有可关闭的面板' }
removePane(id)
return { ok: true, message: '' }
}
/** 切换分屏布局方向(两面板时有效) */
function toggleSplitDirection() {
if (panes.value.length !== 2) return
splitDirection.value = splitDirection.value === 'right' ? 'down' : 'right'
}
// ===== 字号 =====
/**
* 字号缩放是**视图级**的临时覆盖,不写回设置。
*
* 理由:用户按 Ctrl+= 通常是「这个文件的行太长,临时放大看看」,
* 而不是「我要永久改字号」。写回设置会让 Ctrl+0 的语义变成
* 「恢复到我上次临时调的值」,失去「重置」的意义。
*/
const fontOverride = ref<number | null>(null)
async function bumpFont(delta: number) {
const base = fontOverride.value ?? store.settings?.appearance.fontSize ?? 14
const next = Math.min(48, Math.max(6, base + delta))
fontOverride.value = next
}
function resetFont() {
fontOverride.value = null
}
/** 生效的外观(把字号覆盖合并进去,供 TerminalPane 使用) */
const effectiveAppearance = computed(() => {
const a = store.settings?.appearance
if (!a) return null
if (fontOverride.value === null) return a
return { ...a, fontSize: fontOverride.value }
})
// ===== 快捷键 =====
/** 当前生效的快捷键绑定(后端下发;未取到时用具前端默认值兜底) */
const bindings = computed<ShortcutBinding[]>(() => {
const fromSettings = store.settings?.shortcuts
if (fromSettings && fromSettings.length > 0) return fromSettings
return TERMINAL_ACTIONS.map(a => ({ action: a.id, keys: a.defaultKeys, enabled: true }))
})
function shortcutKeysOf(action: string): string {
return bindings.value.find(b => b.action === action)?.keys ?? ''
}
// ===== 初始化 =====
let inited = false
async function init() {
if (inited) return
inited = true
await store.init()
if (options?.fixedSessionId?.value) {
// 独立窗口:固定单个会话,不需要标签顺序
activeSessionId.value = options.fixedSessionId.value
} else if (!activeSessionId.value && store.sessions.length > 0) {
// 主窗口:默认聚焦第一个会话
activeSessionId.value = store.sessions[0].id
}
syncTabOrder()
}
// 后端会话列表变化时保持标签顺序同步
watch(
() => store.sessions.map(s => s.id).join(','),
() => {
syncTabOrder()
// 分屏容器里可能有关闭标签时连带关掉的会话,剔除掉
const alive = new Set(store.sessions.map(s => s.id))
const pruned = panes.value.filter(p => alive.has(p.sessionId))
if (pruned.length !== panes.value.length) {
panes.value = pruned
}
}
)
// 切换标签时把分屏容器重置为该标签的单一会话(见 resetPanesTo 的说明)
watch(activeSessionId, (id, prev) => {
if (!id || id === prev) return
if (!panes.value.some(p => p.sessionId === id)) {
resetPanesTo(id)
}
})
// 活动会话关闭后自动兜底到相邻标签
watch(
() => store.sessions.length,
len => {
if (len === 0) {
activeSessionId.value = null
panes.value = []
return
}
if (activeSessionId.value && !store.sessionById(activeSessionId.value)) {
const next = store.sessions[0].id
activeSessionId.value = next
resetPanesTo(next)
}
}
)
return {
// 状态
activeSessionId,
activeSession,
orderedSessions,
panes,
overlay,
searchTerm,
fontOverride,
effectiveAppearance,
confirmDialog,
// 标签
selectSession,
closeTab,
cycleTab,
selectTabByIndex,
syncTabOrder,
applyOrder,
// 分屏
isSplit,
splitLayout,
splitDirection,
addPane,
removePane,
resetPanesTo,
splitRight,
splitDown,
closePane,
toggleSplitDirection,
// 新建
newLocalTab,
newSshTab,
// 字号
bumpFont,
resetFont,
// 快捷键
bindings,
shortcutKeysOf,
// 确认框
resolveConfirm,
requestConfirm,
// 生命周期
init
}
}
export type TerminalStream = ReturnType<typeof useTerminalStream>
/** 供设置页展示「有效设置」用(独立窗口与主窗口共用同一份 settings) */
export function appearanceOf(settings: TerminalSettings | null) {
return settings?.appearance ?? null
}
+84
View File
@@ -0,0 +1,84 @@
import { onBeforeUnmount, onMounted } from 'vue'
import { matchesShortcut } from '@/lib/terminalActions'
import type { ShortcutBinding } from '@/types/terminal'
export type TerminalActionHandler = (actionId: string) => void
export interface UseTerminalKeysOptions {
/**
* 当前生效的快捷键绑定(来自设置页)。
* 传函数而非数组:快捷键可能随时被用户改动,用取值函数保证总能拿到最新值,
* 避免「改了键位要重启才生效」。
*/
bindings: () => ShortcutBinding[]
/** 动作被触发时的回调(由父组件实现具体行为) */
onAction: TerminalActionHandler
/** 是否启用(终端隐藏时挂起,避免抢走其他输入框的按键) */
enabled?: () => boolean
}
/**
* 终端内的快捷键拦截。
*
* # 为什么用捕获阶段的 document 监听,而不是 xterm 的 attachCustomKeyEventHandler
*
* `attachCustomKeyEventHandler` 只能挂在**单个 Terminal 实例**上,而快捷键里有
* 一半以上是**窗口级**动作(切标签、分屏、开关侧栏)——这些动作必须由父组件处理,
* 且应当在「焦点不在任何终端面板内」时也不生效(否则会和主应用其他输入框打架)。
*
* 因此这里用 document 上的捕获监听,配合两层判断:
* 1. `enabled()` —— 终端模块是否可见
* 2. 焦点是否在 `.xterm` 容器内 —— 决定「终端内」语义
*
* 注册在**捕获阶段**`capture: true`):xterm 自己在冒泡阶段处理按键,
* 若我们晚了就会被 shell 先消费(例如 Ctrl+Shift+W 会变成写入终端的字节)。
*
* # 为什么必须 preventDefault + stopPropagation
*
* 不阻止传播的话,`Ctrl+Shift+T` 会被浏览器当成「恢复关闭的标签页」、
* `Ctrl+Tab` 会被 WebView 用于窗口级切换,动作重复触发。
*/
export function useTerminalKeys(options: UseTerminalKeysOptions) {
/** 焦点是否位于某个 xterm 实例内 */
function focusInTerminal(): boolean {
const el = document.activeElement
if (!el) return false
return !!(el.closest && el.closest('.xterm'))
}
function handleKeydown(e: KeyboardEvent) {
if (options.enabled && !options.enabled()) return
// 「终端内快捷键」的语义边界:焦点必须在终端里。
// 否则用户在设置页的输入框里打字时按 Ctrl+Shift+F 会被当成搜索。
if (!focusInTerminal()) return
// 输入法组合中(拼音候选框开着)不要抢按键,否则无法选中文字
if (e.isComposing) return
const list = options.bindings()
if (!list || list.length === 0) return
for (const b of list) {
if (!b.enabled || !b.keys) continue
if (matchesShortcut(e, b.keys)) {
// 阻止默认行为与传播:既防止浏览器/WebView 的内建快捷键,
// 也防止按键继续流向 xterm(否则「复制」会同时写入一个 \x03 之类的控制字符)
e.preventDefault()
e.stopPropagation()
options.onAction(b.action)
return
}
}
}
onMounted(() => {
// capture: true —— 必须抢在 xterm 与 WebView 之前
document.addEventListener('keydown', handleKeydown, true)
})
onBeforeUnmount(() => {
document.removeEventListener('keydown', handleKeydown, true)
})
return { focusInTerminal }
}
+500
View File
@@ -0,0 +1,500 @@
import { onBeforeUnmount, ref, shallowRef, watch, type Ref } from 'vue'
import { Terminal } from '@xterm/xterm'
import { FitAddon } from '@xterm/addon-fit'
import { SearchAddon } from '@xterm/addon-search'
import { WebLinksAddon } from '@xterm/addon-web-links'
import { Unicode11Addon } from '@xterm/addon-unicode11'
import { WebglAddon } from '@xterm/addon-webgl'
import { useTerminalStore } from '@/stores/terminalStore'
import { resolveTheme } from '@/lib/terminalThemes'
import { createLogger } from '@/lib/logger'
import type { AppearanceSettings } from '@/types/terminal'
const logger = createLogger('terminal')
/** xterm 需要显式 import 样式,否则光标/滚动条都不显示 */
import '@xterm/xterm/css/xterm.css'
/**
* 取(并缓存)某个编码对应的 `TextDecoder`。
*
* # 为什么要缓存
*
* `TextDecoder` 的构造会做一次编码表查找,且**不能跨批次复用同一个实例做流式解码**
* 之外的用途。这里缓存的是「非流式」实例:每次 `decode()` 都传入完整批次。
*
* # 为什么不用 `{ stream: true }` 做跨批次增量解码
*
* 看起来更「正确」,但终端输出有个关键约束:**我们会在批次边界插入控制序列**
* `flush_output` 每批次独立、前端 `term.write` 每次调用也可能触发重绘)。
* 增量解码会把「上一批末尾的半个字符」留到下一批,而下一批可能承载的是
* `OSC` 之类需要立即解析的数据 —— 缓冲半个字符会让控制序列的前置字节错位。
* 终端场景下「极少数跨批截断的多字节字符显示为替换符」比「控制序列错位」代价小得多。
*
* 注意 xterm 自身的 UTF-8 解码**始终是流式的**,所以即便我们传入的是字符串,
* 那些被我们替换掉的坏字节也不会影响后续正常字节的渲染。
*/
const decoderCache = new Map<string, TextDecoder>()
function decoderFor(encoding: string): TextDecoder {
const key = encoding || 'utf-8'
let d = decoderCache.get(key)
if (!d) {
try {
d = new TextDecoder(key, { fatal: false })
} catch {
// 浏览器不认这个编码名(如某些精简构建去掉了 big5)。
// 退回 UTF-8 而不是抛出:显示乱码远好于整条输出流断掉。
logger.warn(`浏览器不支持编码 ${key},已退回 utf-8`)
d = new TextDecoder('utf-8', { fatal: false })
}
decoderCache.set(key, d)
}
return d
}
export interface UseXtermOptions {
/** 容器元素 ref */
container: Ref<HTMLElement | null>
/** 要绑定的会话 id */
sessionId: Ref<string | null>
/** 外观设置(响应式;变化时热更新而不重建实例) */
appearance: Ref<AppearanceSettings | null>
/** 是否只读(已结束的会话保留回放,不允许输入) */
readonly?: Ref<boolean>
/** 会话输出被消费时回调(用于「有新输出」标记) */
onData?: (bytes: string) => void
}
/**
* 把一个 xterm 实例绑定到某个终端会话。
*
* # 关键设计:为什么绕开 Vue 响应式
*
* 会话输出是高频字节流(`cat` 大文件时每秒数 MB)。若经 `ref` 传递,
* Vue 会为每批数据做依赖追踪 / 触发重渲染,代价与收益完全不成比例。
* 这里改为向 store 的**订阅表**注册回调,输出批次直接进 `term.write()`
* 从 Rust 事件到屏幕像素,中间只有一次回调转发。
*
* # 生命周期
*
* - 挂载后:创建 Terminal → 打开 fit/weblink/unicode11 插件 → 尝试加载 webgl → 上报初始尺寸
* - `sessionId` 变化:退订旧会话、清屏、订阅新会话、重新 fit
* - 卸载:注销订阅、dispose 实例、移除 ResizeObserver
*
* 注意:**不**在卸载时关闭会话。会话存活在 Rust 侧,切换标签只是换一个视图,
* 把「视图销毁」等同「会话结束」会导致切标签就断连。
*/
/**
* 把设置里的光标样式收窄到 xterm 接受的联合类型。
*
* `AppearanceSettings.cursorStyle` 是 `string`(设置文件是用户可改的 JSON,
* 不能用字面量联合类型去约束持久化格式),而 `Terminal.options.cursorStyle`
* 只接受 `'block' | 'underline' | 'bar'`。中间必须有一层收窄,
* 否则设置文件里一个拼错的 `"Block"` 就会让 xterm 的行为未定义。
*/
function normalizeCursorStyle(raw: string | undefined): 'block' | 'underline' | 'bar' {
if (raw === 'bar' || raw === 'underline' || raw === 'block') return raw
return 'block'
}
export function useXterm(options: UseXtermOptions) {
const store = useTerminalStore()
const term = shallowRef<Terminal | null>(null)
const fitAddon = shallowRef<FitAddon | null>(null)
const searchAddon = shallowRef<SearchAddon | null>(null)
const webglAddon = shallowRef<WebglAddon | null>(null)
const isReady = ref(false)
/** 首个输出是否已到达(用于「等待首个输出」的加载态) */
const hasOutput = ref(false)
/** 当前订阅的取消函数(会话切换时先调用) */
let unsubscribeOutput: (() => void) | null = null
let unsubscribeExit: (() => void) | null = null
let resizeObserver: ResizeObserver | null = null
/** 上一次上报的尺寸,避免重复发送相同的 resize IPC */
let lastCols = 0
let lastRows = 0
// ===== 实例创建 =====
function createTerminal() {
const el = options.container.value
if (!el || term.value) return
const app = options.appearance.value
const t = new Terminal({
// 主题/字体在创建时给初值,之后由 applyAppearance 热更新
theme: resolveTheme(app?.theme ?? 'vscode-dark'),
fontFamily: app?.fontFamily || 'Cascadia Mono, Consolas, monospace',
fontSize: app?.fontSize || 14,
lineHeight: app?.lineHeight || 1.2,
letterSpacing: app?.letterSpacing || 0,
cursorBlink: app?.cursorBlink ?? true,
cursorStyle: normalizeCursorStyle(app?.cursorStyle),
scrollback: app?.scrollback || 5000,
// 允许应用(如 vim、htop)用鼠标上报事件;同时在应用未捕获鼠标时支持文本选择
// ——这是 xterm 的标准做法,Ctrl+拖选仍能强制进入选择模式
macOptionIsMeta: false,
allowProposedApi: true,
// 转换宽字符(中日韩)的正确显示;配合 unicode11 插件使用 Unicode 11 宽度表
convertEol: false
})
const fit = new FitAddon()
const search = new SearchAddon()
t.loadAddon(fit)
t.loadAddon(search)
t.loadAddon(new WebLinksAddon())
// Unicode11:正确计算 emoji 与部分 CJK 字符宽度(默认宽度表是过时的 Unicode 6)
try {
const u11 = new Unicode11Addon()
t.loadAddon(u11)
t.unicode.activeVersion = '11'
} catch (e) {
logger.warn(`Unicode11 插件加载失败,回落到默认宽度表:${String(e)}`)
}
t.open(el)
fit.fit()
// Web 字体(Cascadia Mono 等)是异步加载的:上面的首次 fit 用回退字体度量
// 计算行列,字体换装后行高变化会让 rows 偏小 —— 面板底部多出一条无字符
// 网格覆盖的裸背景(表现为「终端下方多出一截黑色块」)。字体就绪后补一次
// fit 把行列数校准到真实度量。
if (typeof document !== 'undefined' && document.fonts?.ready) {
void document.fonts.ready.then(() => safeFit())
}
// WebGL 渲染:大吞吐场景(`cat` 大文件、编译日志)下 CPU 占用远低于 canvas。
// 但它在部分虚拟机 / 远程桌面 / 老显卡上会黑屏,所以**必须可回退**:
// 加载失败就留在默认的 DOM 渲染器,功能不受影响,只是性能差一些。
if (app?.gpuRendering !== false) {
try {
const webgl = new WebglAddon()
// 上下文丢失(切换显卡、系统休眠唤醒)时必须丢弃,否则画面永久卡死
webgl.onContextLoss(() => {
logger.warn('WebGL 上下文丢失,回退到默认渲染器')
webgl.dispose()
webglAddon.value = null
})
t.loadAddon(webgl)
webglAddon.value = webgl
} catch (e) {
logger.warn(`WebGL 渲染不可用,回退到默认渲染器:${String(e)}`)
}
}
// 用户输入 → Rust(base64 保字节完整性)
t.onData(data => {
const id = options.sessionId.value
if (!id || options.readonly?.value) return
void store.write(id, data).catch(e => {
logger.error(`写入会话 ${id} 失败:${String(e)}`)
})
})
// 终端尺寸变化(字体缩放、窗口 resize、分屏比例变化都会触发)
t.onResize(({ cols, rows }) => {
const id = options.sessionId.value
if (!id) return
if (cols === lastCols && rows === lastRows) return
lastCols = cols
lastRows = rows
void store.resize(id, cols, rows).catch(e => {
logger.error(`调整会话 ${id} 尺寸失败:${String(e)}`)
})
})
// 选中文本变化:把选区同步到 store,供「复制」菜单项判断是否有内容
t.onSelectionChange(() => {
const id = options.sessionId.value
if (id) selectionMap.set(id, t.getSelection())
})
term.value = t
fitAddon.value = fit
searchAddon.value = search
isReady.value = true
setupResizeObserver(el)
bindSession(options.sessionId.value)
}
/**
* 选区缓存。
*
* 放在模块级而非组件级:右键菜单由父组件(TerminalPane)渲染,
* 需要读取「当前焦点面板」的选区,逐层透传 ref 会把组件树搞得很脏。
*/
const selectionMap = new Map<string, string>()
// ===== 尺寸自适应 =====
function setupResizeObserver(el: HTMLElement) {
// ResizeObserver 而不是 window.resize:终端面板可能因分屏拖动而改变尺寸,
// 此时窗口大小根本没变,只听 window.resize 会漏掉。
resizeObserver = new ResizeObserver(() => {
// 下一帧再 fitResizeObserver 回调时布局可能还没稳定
requestAnimationFrame(() => safeFit())
})
resizeObserver.observe(el)
}
/** fit 会抛异常的场景:容器 display:none(非激活标签)、尺寸为 0、实例已 dispose */
function safeFit() {
const t = term.value
const f = fitAddon.value
if (!t || !f) return
const el = options.container.value
if (!el || el.offsetWidth === 0 || el.offsetHeight === 0) return
try {
f.fit()
} catch {
/* 忽略:容器暂时不可测量,下次 resize 会重试 */
}
}
// ===== 会话绑定 =====
function unbindSession() {
unsubscribeOutput?.()
unsubscribeExit?.()
unsubscribeOutput = null
unsubscribeExit = null
}
function bindSession(id: string | null) {
unbindSession()
if (!id || !term.value) return
// 输出批次 → xterm。
//
// # 编码在此处(前端)而非 Rust 侧完成
//
// Rust 侧 `flush_output` 发的是**原样字节**base64 编码后的 TCP 载荷),
// 不做任何转码。原因:`TextDecoder` 只有浏览器环境有,而「用户是否临时切了
// 编码」这个状态也只存在于前端。若在 Rust 侧转码,用户切编码时后端要重放
// 历史字节才能纠正画面,而前端本就在每次批次到达时现取编码 —— 零额外成本。
//
// 本地 ConPTY 会话的字节已是 UTF-8Windows 控制台内部是 UTF-16,转换由
// 系统完成),走 UTF-8 分支等价于旧的直接 `term.write(bytes)`。
unsubscribeOutput = store.subscribeOutput(id, batch => {
if (!term.value) return
hasOutput.value = true
// 用 TextDecoder 而不是手写字节循环:它能正确处理多字节序列
const bytes = store.base64ToBytes(batch.data)
const enc = store.sessionEncoding(id)
if (enc === 'utf-8') {
// 快路径:直接把字节交给 xterm,省掉「字节→字符串→再编码」的往返
term.value.write(bytes)
} else {
term.value.write(decoderFor(enc).decode(bytes))
}
options.onData?.(batch.data)
})
unsubscribeExit = store.subscribeExit(id, payload => {
if (!term.value) return
const code = payload.exitCode
const why = payload.reason ?? 'unknown'
// 用 ANSI 灰字写一行提示,不污染用户的终端内容语义
term.value.write(
`\r\n\x1b[90m── 会话已结束(${why}${code !== undefined && code !== null ? `,退出码 ${code}` : ''})──\x1b[0m\r\n`
)
hasOutput.value = true
})
// 切换会话时清屏:xterm 的 buffer 是实例级的,不清会串台
term.value.reset()
hasOutput.value = false
// reset 会丢主题,需要重新应用
applyAppearance(options.appearance.value)
requestAnimationFrame(() => {
safeFit()
term.value?.focus()
})
}
// ===== 外观热更新 =====
function applyAppearance(app: AppearanceSettings | null) {
const t = term.value
if (!t || !app) return
t.options.theme = resolveTheme(app.theme)
t.options.fontFamily = app.fontFamily || 'Cascadia Mono, Consolas, monospace'
t.options.fontSize = app.fontSize || 14
t.options.lineHeight = app.lineHeight || 1.2
t.options.letterSpacing = app.letterSpacing || 0
t.options.cursorBlink = app.cursorBlink ?? true
t.options.cursorStyle = normalizeCursorStyle(app.cursorStyle)
t.options.scrollback = app.scrollback || 5000
// 字体变化会改变字符宽高 → 行列数变了 → 必须重新 fit 并上报
requestAnimationFrame(() => safeFit())
}
// ===== 监视 =====
watch(
() => options.sessionId.value,
id => bindSession(id)
)
watch(
() => options.appearance.value,
app => applyAppearance(app),
{ deep: true }
)
// ===== 对外接口 =====
/** 聚焦终端(切换标签、点击面板时调用) */
function focus() {
term.value?.focus()
}
/** 当前选区文本 */
function getSelection(): string {
return term.value?.getSelection() ?? ''
}
/** 搜索(返回是否命中;调用方据此提示用户) */
function findNext(keyword: string, caseSensitive = false): boolean {
if (!searchAddon.value || !keyword) return false
return searchAddon.value.findNext(keyword, { caseSensitive })
}
function findPrevious(keyword: string, caseSensitive = false): boolean {
if (!searchAddon.value || !keyword) return false
return searchAddon.value.findPrevious(keyword, { caseSensitive })
}
function clearSearch() {
searchAddon.value?.clearDecorations()
}
/** 选中全部缓冲内容 */
function selectAll() {
term.value?.selectAll()
}
/**
* 选中视口中某个屏幕坐标处的「词」。
*
* xterm 没有 `selectWordAt`,只有按行列的 `select(col, row, length)`
* 因此需要自己把像素坐标换算成行列。这里刻意**不**去读 xterm 的内部
* 渲染服务(`_core._renderService`)取字符尺寸 —— 那是私有 API,
* 不在 d.ts 里,版本升级随时可能改名或改变形状。
*
* 改用公开且稳定的方式:xterm 会生成一个 `.xterm-rows` 容器,
* 每行是一个 `<div>`。用其中一行的 `getBoundingClientRect()` 就能得到
* 实际行高;列宽则由「行宽 ÷ cols」推出。这两者都是渲染后的真实值,
* 已经包含了字体、缩放、内边距的全部影响。
*
* 之所以做这个功能:终端里最常见的操作是选中一个路径 / URL / commit hash
* 而用鼠标精确拖选一个长串很难 —— 右键选词能省掉一次失败的拖选。
*/
function selectWordAt(clientX: number, clientY: number) {
const t = term.value
if (!t) return
const root = t.element
if (!root) return
const rowsEl = root.querySelector('.xterm-rows') as HTMLElement | null
if (!rowsEl) return
const rowEls = rowsEl.children
if (rowEls.length === 0) return
const firstRow = rowEls[0] as HTMLElement
const rowRect = firstRow.getBoundingClientRect()
if (rowRect.width <= 0 || rowRect.height <= 0) return
const cols = t.cols
if (cols <= 0) return
const cellW = rowRect.width / cols
const cellH = rowRect.height
if (cellW <= 0 || cellH <= 0) return
const col = Math.floor((clientX - rowRect.left) / cellW)
const row = Math.floor((clientY - rowRect.top) / cellH)
if (col < 0 || row < 0 || col >= cols || row >= rowEls.length) return
const line = t.buffer.active.getLine(t.buffer.active.viewportY + row)
if (!line) return
const text = line.translateToString(true)
if (!text.trim()) return
// 词边界:以空白和终端里高频出现的语法分隔符切分。
// 刻意不用 \b —— 它对 `/`、`-`、`.` 不构成边界,会把整条路径当成一个词,
// 而「选中路径的一段」恰恰是这个功能最常见的用途。
const isWordChar = (c: string) => c !== '' && !/[\s|&;<>()[\]{}'"]/.test(c)
let start = col
let end = col
while (start > 0 && isWordChar(text[start - 1] ?? '')) start--
while (end < text.length && isWordChar(text[end] ?? '')) end++
if (end <= start) return
t.select(start, row, end - start)
// 选完把焦点交给终端:否则用户接着按 Ctrl+Shift+C 时,
// 事件落不到 `.xterm` 上,快捷键的「焦点在终端内」判断会失败
t.focus()
}
/** 把视口滚动到底部(新输出到达、用户按 Ctrl+End 时) */
function scrollToBottom() {
term.value?.scrollToBottom()
}
function clear() {
term.value?.clear()
}
/** 重新适配尺寸(外部在容器显示后调用) */
function fit() {
safeFit()
}
// ===== 销毁 =====
onBeforeUnmount(() => {
unbindSession()
resizeObserver?.disconnect()
resizeObserver = null
// WebGL 需要先手动 dispose:它持有 WebGL context,不释放会累积泄漏
try {
webglAddon.value?.dispose()
} catch {
/* 忽略 */
}
webglAddon.value = null
term.value?.dispose()
term.value = null
fitAddon.value = null
searchAddon.value = null
isReady.value = false
})
return {
term,
isReady,
hasOutput,
createTerminal,
focus,
fit,
getSelection,
findNext,
findPrevious,
clearSearch,
selectAll,
selectWordAt,
scrollToBottom,
clear,
applyAppearance,
/** 读取某会话的选区缓存(供右键菜单判断「复制」是否可用) */
selectionOf: (id: string) => selectionMap.get(id) ?? ''
}
}
+740
View File
@@ -507,14 +507,236 @@ export const commands = {
* 在翻译期间一直保持原样。回填前校验原窗口仍然存活,避免粘贴进毫不相干的窗口。
*/
translatePasteBack: (text: string, hwnd: number) => __TAURI_INVOKE<null>("translate_paste_back", { text, hwnd }),
/** 读取终端设置。 */
terminalGetSettings: () => __TAURI_INVOKE<TerminalSettings>("terminal_get_settings"),
/**
* 保存终端设置(整份覆盖)。
*
* 前端只在「设置页」用它;主机/密钥的增删改用下面的细粒度命令,
* 避免「前端旧快照覆盖后端新值」的竞态。
*/
terminalSaveSettings: (settings: TerminalSettings) => __TAURI_INVOKE<TerminalSettings>("terminal_save_settings", { settings }),
/** 保存外观设置(细粒度:只改外观,不碰主机与密钥)。 */
terminalSaveAppearance: (appearance: AppearanceSettings) => __TAURI_INVOKE<TerminalSettings>("terminal_save_appearance", { appearance }),
/** 保存布局设置。 */
terminalSaveLayout: (layout: LayoutSettings) => __TAURI_INVOKE<TerminalSettings>("terminal_save_layout", { layout }),
/** 保存终端内选中行为。 */
terminalSaveSelection: (selection: TerminalSelectionSettings) => __TAURI_INVOKE<TerminalSettings>("terminal_save_selection", { selection }),
/** 保存安全设置。 */
terminalSaveSecurity: (security: SecuritySettings) => __TAURI_INVOKE<TerminalSettings>("terminal_save_security", { security }),
/** 保存快捷键绑定(整组覆盖)。 */
terminalSaveShortcuts: (shortcuts: ShortcutBinding[]) => __TAURI_INVOKE<TerminalSettings>("terminal_save_shortcuts", { shortcuts }),
/** 列出本机可用的 Shell。 */
terminalListShells: () => __TAURI_INVOKE<ShellProfile[]>("terminal_list_shells"),
/** 重新探测 Shell。 */
terminalRefreshShells: () => __TAURI_INVOKE<ShellProfile[]>("terminal_refresh_shells"),
/** 新增自定义 Shell。 */
terminalSaveShell: (shellProfile: ShellProfile) => __TAURI_INVOKE<ShellProfile[]>("terminal_save_shell", { shellProfile }),
/** 删除自定义 Shell(自动探测项不允许删除)。 */
terminalDeleteShell: (shellId: string) => __TAURI_INVOKE<ShellProfile[]>("terminal_delete_shell", { shellId }),
/** 设为默认 Shell(新建会话时预选)。 */
terminalSetLastShell: (shellId: string) => __TAURI_INVOKE<null>("terminal_set_last_shell", { shellId }),
/** 检查 Shell 是否能正常启动(用于设置页的「测试」按钮)。 */
terminalTestShell: (shellId: string) => __TAURI_INVOKE<ActionOutcome>("terminal_test_shell", { shellId }),
/** 探测某个 shell 的默认工作目录(用于「打开到主目录」)。 */
terminalDefaultCwd: () => __TAURI_INVOKE<string>("terminal_default_cwd"),
/** 新建本地 Shell 会话。 */
terminalOpenLocal: (shellId: string, cwd: string | null, cols: number | null, rows: number | null) => __TAURI_INVOKE<SessionInfo>("terminal_open_local", { shellId, cwd, cols, rows }),
/** 新建 SSH 会话。 */
terminalOpenSsh: (hostId: string, cols: number | null, rows: number | null) => __TAURI_INVOKE<SessionInfo>("terminal_open_ssh", { hostId, cols, rows }),
/** 列出全部会话。 */
terminalListSessions: () => __TAURI_INVOKE<SessionInfo[]>("terminal_list_sessions"),
/** 关闭会话。 */
terminalCloseSession: (sessionId: string) => __TAURI_INVOKE<null>("terminal_close_session", { sessionId }),
/**
* 向会话写入数据。
*
* `data` 用 base64:前端键入的字符、粘贴内容、以及二进制序列(如 Ctrl+C 的
* `\x03`、鼠标上报序列)都要能传,用字符串会在非 UTF-8 字节上出问题。
*/
terminalWrite: (sessionId: string, data: string) => __TAURI_INVOKE<null>("terminal_write", { sessionId, data }),
/** 通知会话尺寸变化。 */
terminalResize: (sessionId: string, cols: number, rows: number) => __TAURI_INVOKE<null>("terminal_resize", { sessionId, cols, rows }),
/** 重命名会话(同时更新标签与独立窗口标题)。 */
terminalRenameSession: (sessionId: string, title: string) => __TAURI_INVOKE<null>("terminal_rename_session", { sessionId, title }),
/** 在独立窗口中打开会话。 */
terminalDetachSession: (sessionId: string) => __TAURI_INVOKE<null>("terminal_detach_session", { sessionId }),
/** 关闭某会话的独立窗口(会话保留)。 */
terminalAttachSession: (sessionId: string) => __TAURI_INVOKE<null>("terminal_attach_session", { sessionId }),
/** 查询某会话当前工作目录(供「继承 cwd」与 SFTP 跟随使用)。 */
terminalSessionCwd: (sessionId: string) => __TAURI_INVOKE<string>("terminal_session_cwd", { sessionId }),
/**
* 发送特殊按键序列(如 Ctrl+C / Tab / 方向键)。
*
* 存在的理由:某些按键在 WebView 里会被浏览器或拼音输入法吞掉,
* 前端拦截后改由这个命令直接注入原始字节,保证行为与原生终端一致。
*/
terminalSendKey: (sessionId: string, key: string) => __TAURI_INVOKE<null>("terminal_send_key", { sessionId, key }),
/** 清屏(按 shell 类型选择命令)。 */
terminalClearSession: (sessionId: string, shellKind: string | null) => __TAURI_INVOKE<null>("terminal_clear_session", { sessionId, shellKind }),
/** 是否存在活跃会话(供「关闭标签二次确认」判断)。 */
terminalSessionAlive: (sessionId: string) => __TAURI_INVOKE<boolean>("terminal_session_alive", { sessionId }),
/**
* 切换会话的字符编码。
*
* # 为什么是会话级而不是全局设置
*
* GBK 与否取决于**对端**:同一台机器上连着 5 台服务器,可能 2 台是 GBK。
* 做成全局设置意味着「切一次全变」,用户得来回改;做成主机配置又不够用 ——
* 连上之前不知道对端是什么编码,往往要敲一条 `ls` 看到乱码才反应过来。
* 所以放在状态栏,改完立即作用于当前会话。
*
* # 为什么改编码后要重绘
*
* 已经渲染进 xterm 的字符是**按旧编码的解释结果**,它们在字节层面已经丢失
* (解码有损)。切换编码只能保证「之后新输出的字节」正确解释,历史画面无法
* 追溯复原。前端收到本命令的返回后会带 `redraw: true` 触发一次全量重绘,
* 但重绘用的是**后端保留的原始字节缓冲**(见 `OutputBatch` 的 ring buffer),
* 因此清屏重放可以纠正历史 —— 这是保留原始字节流的直接收益。
*/
terminalSetEncoding: (sessionId: string, encoding: string) => __TAURI_INVOKE<string>("terminal_set_encoding", { sessionId, encoding }),
/** 列出所有 SSH 主机(含凭据状态)。 */
terminalListHosts: () => __TAURI_INVOKE<HostView[]>("terminal_list_hosts"),
/** 保存 SSH 主机(新增或更新)。 */
terminalSaveHost: (host: SshHost) => __TAURI_INVOKE<HostView[]>("terminal_save_host", { host }),
/** 删除 SSH 主机(连带清理其密码凭据)。 */
terminalDeleteHost: (hostId: string) => __TAURI_INVOKE<HostView[]>("terminal_delete_host", { hostId }),
/**
* 设置(或清除)主机密码。
*
* 空串表示清除。密码写入系统凭据管理器,**不落盘到 settings.json**。
*/
terminalSetHostPassword: (hostId: string, password: string) => __TAURI_INVOKE<ActionOutcome>("terminal_set_host_password", { hostId, password }),
/**
* 从 `~/.ssh/config` 导入主机。
*
* 只做 P0 能覆盖的部分:Host 别名、HostName、Port、User、IdentityFile。
* 跳板机(ProxyJump)与通配符 Host 明确跳过并计数,提示用户手工补录——
* 静默忽略会让用户以为全导入了。
*/
terminalImportSshConfig: () => __TAURI_INVOKE<ActionOutcome>("terminal_import_ssh_config"),
/** 列出所有密钥(含派生状态,**不含明文**)。 */
terminalListKeys: () => __TAURI_INVOKE<KeyView[]>("terminal_list_keys"),
/** 生成新密钥。 */
terminalGenerateKey: (params: KeyGenParams) => __TAURI_INVOKE<[KeyView, ActionOutcome]>("terminal_generate_key", { params }),
/** 导入密钥。 */
terminalImportKey: (name: string, content: string, passphrase: string) => __TAURI_INVOKE<[KeyView, ActionOutcome]>("terminal_import_key", { name, content, passphrase }),
/** 删除密钥。 */
terminalDeleteKey: (keyId: string) => __TAURI_INVOKE<KeyView[]>("terminal_delete_key", { keyId }),
/** 重命名密钥。 */
terminalRenameKey: (keyId: string, name: string) => __TAURI_INVOKE<KeyView[]>("terminal_rename_key", { keyId, name }),
/**
* 设置或更新密钥 passphrase。
*
* 需要重新加密私钥文件,因此要读原 passphrase 解密 → 用新 passphrase 加密 → 落盘。
*/
terminalSetKeyPassphrase: (keyId: string, oldPassphrase: string, newPassphrase: string) => __TAURI_INVOKE<ActionOutcome>("terminal_set_key_passphrase", { keyId, oldPassphrase, newPassphrase }),
/**
* 读取密钥公钥(供「复制公钥」与「写入 authorized_keys」使用)。
*
* 只返回公钥部分——公钥本就是可公开的,不涉及明文私钥泄露。
*/
terminalKeyPublic: (keyId: string) => __TAURI_INVOKE<string>("terminal_key_public", { keyId }),
/**
* 生成一个 SSH 主机的 id。
*
* 前端在「新建主机」对话框里需要先拿到 id 才能保存密码(密码按 host_id 存取),
* 因此把 id 生成放到后端,保证与 `terminal_save_host` 的生成规则一致。
*/
terminalNewHostId: () => __TAURI_INVOKE<string>("terminal_new_host_id"),
/** 列出已知主机记录。 */
terminalListKnownHosts: () => __TAURI_INVOKE<KnownHost[]>("terminal_list_known_hosts"),
/** 遗忘某条主机记录(下次连接会重新弹指纹确认)。 */
terminalForgetHost: (host: string, port: number, keyType: string) => __TAURI_INVOKE<KnownHost[]>("terminal_forget_host", { host, port, keyType }),
/** 清空全部主机记录(危险操作,前端需二次确认)。 */
terminalClearKnownHosts: () => __TAURI_INVOKE<KnownHost[]>("terminal_clear_known_hosts"),
/** 导出 known_hosts 文本(供人工审阅或迁移)。 */
terminalExportKnownHosts: () => __TAURI_INVOKE<string>("terminal_export_known_hosts"),
/** 导入 known_hosts 文本。 */
terminalImportKnownHosts: (text: string) => __TAURI_INVOKE<ActionOutcome>("terminal_import_known_hosts", { text }),
/**
* 回传主机密钥确认决定。
*
* 由前端在用户点击「接受」/「拒绝」后调用。会话侧的握手正在阻塞等待这个回传,
* 因此超时(120 秒)后会视为拒绝。
*/
terminalConfirmHostKey: (sessionId: string, accept: boolean, host: string, port: number, keyType: string, fingerprint: string) => __TAURI_INVOKE<null>("terminal_confirm_host_key", { sessionId, accept, host, port, keyType, fingerprint }),
/** 分页 + 搜索命令历史。 */
terminalHistoryQuery: (query: HistoryQuery) => __TAURI_INVOKE<TerminalHistoryPage>("terminal_history_query", { query }),
/** 列出所有历史来源(供筛选下拉)。 */
terminalHistorySources: () => __TAURI_INVOKE<HistorySource[]>("terminal_history_sources"),
/** 收藏 / 取消收藏。返回切换后的值。 */
terminalHistoryToggleFavorite: (id: number) => __TAURI_INVOKE<boolean>("terminal_history_toggle_favorite", { id }),
/** 删除一条历史。 */
terminalHistoryDelete: (id: number) => __TAURI_INVOKE<ActionOutcome>("terminal_history_delete", { id }),
/**
* 清空历史。
*
* `keep_favorites` 默认为真 —— 破坏性操作的默认值应当是最保守的那个。
* 用户点的若是「清空」,看到「收藏还在」不会觉得被冒犯;
* 但若默认连收藏一起清掉,那份损失不可逆。
*/
terminalHistoryClear: (keepFavorites: boolean | null) => __TAURI_INVOKE<ActionOutcome>("terminal_history_clear", { keepFavorites }),
/**
* 把一条历史命令送入会话的命令行。
*
* 与 `terminal_run_snippet` 同构(`submit` 决定是否追加回车),
* 但**刻意拆成两个命令**而不是给后者加一个「来源」参数:
* 片段携带占位符需要渲染,历史命令是已定型字符串。合并会让
* `terminal_run_snippet` 多出一个只在历史场景有意义的字段。
*
* # 安全姿态
*
* 历史命令一律 `submit = false`(只填入不执行)为默认 —— 从历史里翻出
* `rm -rf` 并回车执行,是这类功能最常见的事故来源。用户要执行就再按一次回车,
* 多按一次回车的成本远低于一次误执行。
*/
terminalHistoryRun: (sessionId: string, command: string, submit: boolean | null) => __TAURI_INVOKE<ActionOutcome>("terminal_history_run", { sessionId, command, submit }),
};
/* Types */
/**
* 带提示语的操作结果。
*
* 部分操作「成功但需告知用户一些事」(如凭据管理器写入失败但密钥已生成),
* 用这个结构承载,避免为此另开一个命令。
*/
export type ActionOutcome = {
ok: boolean,
/** 给用户看的提示(成功时的附加说明,或失败原因) */
message: string,
};
export type AppRecord = {
name: string,
path: string,
};
/** 终端外观设置。 */
export type AppearanceSettings = {
/** 配色主题 id(内置若干,见前端 terminalThemes.ts */
theme?: string,
/** 是否跟随应用亮暗主题(开启时 `theme` 只作为亮/暗的取色基准) */
followAppTheme?: boolean,
/** 字体族(逗号分隔的 CSS font-family */
fontFamily?: string,
fontSize?: number,
/** 行高倍数 */
lineHeight?: number | null,
/** 字母间距 */
letterSpacing?: number | null,
/** 光标样式:"block" | "bar" | "underline" */
cursorStyle?: string,
/** 光标是否闪烁 */
cursorBlink?: boolean,
/** 滚动缓冲区行数。上限 200000:再高会显著吃内存且滚动查找变慢。 */
scrollback?: number,
/** 背景不透明度百分比(100 = 不透明) */
opacity?: number,
/** 是否启用 GPU 渲染(addon-webgl)。极少数显卡驱动下有花屏问题,故给开关。 */
gpuRendering?: boolean,
};
export type ArchiveInfo = {
name: string,
path: string,
@@ -603,6 +825,80 @@ export type ClipboardStatus = {
count: number,
};
/** 一条命令历史。 */
export type CommandHistoryItem = {
id: number,
/** 毫秒时间戳(最后一次执行) */
ts: number,
command: string,
/** 执行时的工作目录(可能为空 —— OSC 7 未被远端 shell 上报时) */
cwd: string,
/**
* 会话来源:本地 shell 的 id,或 SSH 主机的 id。
* 为空串表示「来源未知」(如手工录入的历史)。
*/
hostId: string,
/**
* 显示用的来源名(「PowerShell」/「生产服务器」),随记录一起存。
*
* # 为什么冗余存名字而不只存 id
*
* 主机被删除后,若只有 id,历史列表里那一列会变成一串无意义的 hash。
* 存名字的代价是「主机改名后历史里的旧名字不会更新」—— 这里选择
* **保留历史当时的名字**,因为「我在那台现在叫 X 的机器上跑过什么」
* 本来就是一个有时间性的问题。
*/
hostName: string,
/** 是否为 SSH 会话 */
ssh: boolean,
/** 累计执行次数(同一命令在同一目录重复执行时累加) */
count: number,
/** 用户收藏(收藏项不参与容量淘汰) */
favorited: boolean,
/** 退出码。`None` 表示未捕获(如会话结束时命令仍在运行) */
exitCode: number | null,
};
/**
* 一条命令片段。
*
* # 为什么 `command` 里允许变量占位符
*
* 常用命令的差异往往只在少数字段(路径、主机名、分支名)。若每条变体都要
* 单独存一条,片段库会迅速退化成「一堆几乎一样的条目」,反而找不到东西。
* 因此支持 `${name}` 形式占位符,执行前弹出表单逐个填写。
*
* 占位符语法刻意用 `${name}` 而不是 `{name}`shell 自身大量使用 `{}`
* `${VAR}`、`awk '{print}'`、brace expansion),单花括号会与用户的正常
* 命令冲突,导致片段存进去就「被替换掉了」。
*/
export type CommandSnippet = {
id?: string,
/** 展示名称(列表主标题) */
name?: string,
/** 命令内容(可含 `${name}` 占位符) */
command?: string,
/** 说明(列表副标题,讲清这条命令做什么、有什么前提) */
description?: string,
/** 分组名(空串归入「未分组」) */
group?: string,
/** 占位符的默认值:name → 默认值。未列出的占位符默认空串。 */
defaults?: { [key in string]: string },
/**
* 适用的 shell kind(空数组表示所有 shell 都适用)。
* 例:`Get-ChildItem` 只对 powershell 有意义,不该出现在 cmd 的列表里。
*/
shellKinds?: string[],
/** 仅对 SSH 会话显示(如 `sudo systemctl restart` 类远端操作) */
sshOnly?: boolean,
/** 是否需要二次确认(危险命令,如 `rm -rf`) */
confirm?: boolean,
/** 是否在片段面板中置顶 */
pinned?: boolean,
/** 创建时间(Unix 毫秒,用于列表排序) */
createdAt?: number,
};
/** 自定义命令 */
export type CustomCommand = {
id: string,
@@ -734,6 +1030,11 @@ export type EngineView = {
issue: string | null,
};
export type EnvVar = {
key?: string,
value?: string,
};
/**
* 错误分类。区分它们的意义在于**前端能给出可操作的提示**:
* `Auth` 要用户去改 Key`Network` 要用户查网络/代理,`RateLimit` 只需等待。
@@ -811,6 +1112,15 @@ export type FileRecord = {
isDir: boolean,
};
export type FingerprintChange = {
/** 被替换掉的旧指纹 */
oldFingerprint?: string,
/** 变更发生时间 */
changedAt?: string,
/** 用户是否接受了这次变更 */
accepted?: boolean,
};
/** 一条历史记录 */
export type HistoryItem = {
id: number,
@@ -834,6 +1144,26 @@ export type HistoryPage = {
total: number,
};
/**
* 查询参数。
*
* 用结构体而不是一长串位置参数:命令层要把前端 payload 原样转发,
* 而 5 个 `Option<String>` 的位置参数在调用点极易顺序写错,且编译器
* 无法发现(全是同类型)。
*/
export type HistoryQuery = {
/** 关键词(对 command 做匹配;空则不过滤) */
keyword?: string,
/** 只看某个来源(host_id;空则全部) */
hostId?: string,
/** 只看收藏 */
favoritedOnly?: boolean,
/** 分页偏移 */
offset?: number,
/** 分页大小 */
limit?: number,
};
/** 翻译历史设置(P2 生效)。 */
export type HistorySettings = {
enabled?: boolean,
@@ -841,6 +1171,36 @@ export type HistorySettings = {
maxItems?: number,
};
/**
* 历史来源(供前端做筛选下拉)。
*
* 单独定义而不是用元组:元组序列化成 JSON 会变成数组,前端得靠下标取值
* `s[0]`/`s[1]`/`s[2]`),改一次顺序就静默错位。具名字段让前后端
* 各自独立演进而不怕顺序变动。
*/
export type HistorySource = {
hostId: string,
hostName: string,
/** 该来源的命令条数 */
count: number,
ssh: boolean,
};
/** SSH 主机的前端视图:配置 + 派生凭据状态。 */
export type HostView = {
config: SshHost,
/** 是否已保存密码(**不返回密码本身**) */
hasPassword: boolean,
/** 密码掩码(未保存时为空串) */
passwordMasked: string,
/** 关联密钥是否存在且文件齐备 */
keyReady: boolean,
/** 是否具备发起连接的条件 */
ready: boolean,
/** 不可用原因(ready 为 true 时为空) */
issue: string | null,
};
/** 索引状态(返回给前端) */
export type IndexStats = {
total: number,
@@ -861,6 +1221,108 @@ export type KernelUpdateInfo = {
hasUpdate: boolean,
};
/** 生成密钥时的参数。 */
export type KeyGenParams = {
/** 展示名称(留空则用算法名 + 时间戳) */
name: string,
/** 算法:"ed25519"(默认)| "rsa" | "ecdsa" */
algorithm: string,
/** RSA 位数(2048 / 3072 / 4096)。其他算法忽略此字段。 */
bits: number,
/** 注释(会写进公钥末尾,通常填 用户@主机) */
comment: string,
/** passphrase。**只用于写入凭据管理器,不落盘、不回传**。 */
passphrase: string,
};
/**
* 密钥库的单个条目(元数据,**不含私钥内容**)。
*
* 私钥本体存放在 `{app_data_dir}/terminal/keys/` 的独立文件里(可能是几 KB,
* 塞进 Windows 凭据管理器不可靠——单条有大小上限),passphrase 才进凭据管理器。
*/
export type KeyMeta = {
id?: string,
/** 展示名称 */
name?: string,
/** 算法:"ed25519" | "rsa" | "ecdsa" */
algorithm?: string,
/** 位数 / 曲线(RSA 2048/3072/4096ECDSA P-256/P-384/P-521ed25519 固定空串) */
bits?: number,
/** 公钥指纹(SHA256OpenSSH 展示格式 `SHA256:xxxx` */
fingerprint?: string,
/** 公钥内容(`ssh-ed25519 AAAA... comment`),用于一键复制 */
publicKey?: string,
/** 注释 */
comment?: string,
/** 私钥文件名(`keys/` 目录下,相对名) */
fileName?: string,
/** 创建时间(RFC3339 */
createdAt?: string,
/** 是否由 ssh-agent 托管(P1 */
inAgent?: boolean,
};
/**
* 密钥视图:元数据 + 派生状态。
*
* 拆成「meta + 派生」而不是直接回传元数据,理由与 translate 模块的 `EngineView`
* 一致:让前端保存时能原样回传 `view.meta`,不必自己拼装结构,
* 也不会误把派生字段写回配置。
*/
export type KeyView = {
meta: KeyMeta,
/** 是否已设置 passphrase**不返回 passphrase 本身,本模块无此命令**) */
hasPassphrase: boolean,
/** 私钥文件是否实际存在(元数据与文件不同步时能立刻发现,如用户手工删了文件) */
fileExists: boolean,
};
/** 单条已知主机记录。 */
export type KnownHost = {
/** 主机地址(不含端口,端口单独存) */
host?: string,
port?: number,
/**
* 密钥算法(如 "ssh-ed25519" / "rsa-sha2-512" / "ssh-rsa"
*
* 同一主机可能有多种算法的密钥(服务器同时提供 ed25519 与 rsa),
* 因此按 (host, port, key_type) 三元组建索引,而不是 (host, port)。
*/
keyType?: string,
/** SHA256 指纹(OpenSSH 展示格式,如 `SHA256:Abc...` */
fingerprint?: string,
/** 首次见到时间(RFC3339 */
firstSeen?: string,
/** 最近一次确认时间(RFC3339 */
lastConfirmed?: string,
/**
* 指纹变更历史(最新在前)。
*
* 保留历史的价值:用户点「接受新指纹」之后,回看历史能判断这到底是
* 服务器重装(一次性变更)还是持续的中间人(每次都变)。
*/
history?: FingerprintChange[],
};
export type LayoutSettings = {
/** 关闭标签页时若会话仍有活跃进程,是否二次确认 */
confirmCloseRunning?: boolean,
/** 新建标签页时是否继承当前会话的工作目录 */
inheritCwd?: boolean,
/** 侧栏默认是否展开 */
sidebarOpen?: boolean,
/** 侧栏宽度(像素) */
sidebarWidth?: number,
/** 是否显示底部状态栏 */
showStatusBar?: boolean,
/**
* 分屏上限(1 = 不分屏,2 = 2×1,4 = 2×2)。
* 上限刻意封在 4:分屏 × 标签 × 会话的组合复杂度会爆炸。
*/
maxPanes?: number,
};
/** 环境状态(返回前端,设置页「环境检查」面板展示) */
export type MusicEnvStatus = {
/** 系统 Python 版本(如 "3.14.5"),无则 None */
@@ -1096,6 +1558,23 @@ export type ScrollRegion = {
height: number,
};
export type SecuritySettings = {
/**
* 主机密钥策略:"ask"(默认,首次连接必须显式确认指纹)。
*
* **不提供 "auto-accept" 选项**TOFU 静默接受是 MITM 的入口,
* 属于代码层不该给用户的开关。
*/
hostKeyPolicy?: string,
/**
* 指纹变更时是否阻断(**默认 true**)。关掉会让中间人攻击无声通过,
* 因此前端需以红色风险提示呈现该开关。
*/
blockOnFingerprintChange?: boolean,
/** 是否记录连接审计日志(P2,默认关;开启后输入输出落盘,含脱敏) */
auditLog?: boolean,
};
/** 下载分段(多线程 Range 下载 / 断点续传用) */
export type Segment = {
/** 分段索引 */
@@ -1139,6 +1618,129 @@ export type SelectionSettings = {
blacklist?: string[],
};
/** 会话元信息(回传前端;**不含任何 I/O 句柄**)。 */
export type SessionInfo = {
id: string,
kind: SessionKind,
/** 标题(本地为 Shell 名,SSH 为 用户@主机) */
title: string,
state: SessionState,
/** 终端当前列数 */
cols: number,
/** 终端当前行数 */
rows: number,
/** 当前工作目录(由 OSC 7 hook 上报;未知为空串) */
cwd: string,
/** 会话创建时间(Unix 毫秒) */
createdAt: number,
/** 进程退出码(本地可拿到;SSH 通常为 None) */
exitCode: number | null,
/** 失败原因(state 为 Failed 时非空) */
error: string | null,
/** 远端标识(本地为 shell idSSH 为 host id */
targetId: string,
/** 是否由独立窗口承载(决定了关闭窗口时销毁还是保留会话) */
detached: boolean,
/**
* 会话的字符编码(规范名,如 `gbk` / `utf-8`)。
*
* 回传前端的原因:**终端画面的字节→文本转换在前端做**。xterm 的
* `write` 接受 `Uint8Array`,解码策略由前端按这个字段决定。若放在 Rust 侧
* 转换,前端就失去了「用户临时切编码重看历史内容」的能力——
* 而重看历史恰恰是老服务器场景下最常用的操作。
*/
encoding: string,
/** 是否正在记录会话日志(`audit` 模块)。前端据此显示工具栏开关状态。 */
logging: boolean,
};
/** 会话类型(决定前端展示哪些能力)。 */
export type SessionKind = "local" | "ssh";
/**
* 会话状态机。
*
* `degraded` 专为 SSH 保留:TCP 断了但会话对象还在(可以尝试重连),
* 与 `closed`(已终结,需重开)是两回事。本地会话不会进入此态。
*/
export type SessionState =
/** 已创建,尚未开始握手/启动 */
"idle" |
/** 正在连接(SSH 握手 / 本地启动进程) */
"connecting" |
/** 正在认证(仅 SSH */
"authenticating" |
/** 已建立,可交互 */
"established" |
/** 连接降级(SSH 断线,可尝试重连) */
"degraded" |
/** 已关闭(进程退出或用户主动关闭) */
"closed" |
/** 异常(启动失败、握手失败、致命错误) */
"failed";
/**
* 会话模板:一键拉起一组会话并排成布局。
*
* 拉起语义:`entries[0]` 作为主面板,其余依次以分屏面板加入
* (受 `layout.maxPanes` 上限约束,超过 4 个的条目被忽略——
* WebGL 上下文上限决定了可见面板不可能超过 4,见 useSessionStream 说明)。
*/
export type SessionTemplate = {
id?: string,
name?: string,
/** 创建时间(Unix 毫秒;模板列表按此排序) */
createdAt?: number,
entries?: TemplateEntry[],
};
/**
* 本地 Shell 配置。
*
* 探测到的 Shell 与用户自定义的 Shell 用同一结构表达:`detected` 为 true 表示
* 由 [`super::shell::detect_shells`] 自动发现,前端只允许改启动参数而不可改路径
* (路径已被验证存在,改错会让会话起不来)。
*/
export type ShellProfile = {
/** 唯一标识(同时是新建会话时的 shellKey) */
id?: string,
/** 展示名称,如 "PowerShell 7" */
name?: string,
/** 可执行文件绝对路径 */
path?: string,
/** 启动参数 */
args?: string[],
/** 启动时的工作目录(空串表示用用户主目录) */
cwd?: string,
/** 环境变量覆盖(键值对;值为空串表示删除该变量) */
env?: EnvVar[],
/**
* Shell 类型:"powershell" | "cmd" | "bash" | "wsl"
*
* 决定三件事:cwd 跟踪 hook 的注入方式、清屏命令、以及 OSC 7 的解析口径。
*/
kind?: string,
/** 是否由自动探测得到(true 时前端不可编辑 path) */
detected?: boolean,
/** 是否在新建会话菜单中显示 */
enabled?: boolean,
};
/**
* 一条终端内快捷键绑定。
*
* 只覆盖**终端内**(第二层)快捷键:全局快捷键(第一层)由 `crate::shortcut` 统一
* 注册并做应用内冲突检测,不走这里;shell 原生快捷键(第三层)不做拦截。
*/
export type ShortcutBinding = {
/** 动作标识,见前端 `terminalActions.ts`(如 "copy" / "newTab" */
action?: string,
/** 键位字符串,格式与 `crate::shortcut::parse_shortcut` 一致(如 "Ctrl+Shift+C" */
keys?: string,
/** 是否启用(关掉后该动作无快捷键,但仍可从菜单触发) */
enabled?: boolean,
};
/** 快捷位置条目 */
export type SpecialLocation = {
id: string,
@@ -1151,6 +1753,58 @@ export type SpecialLocation = {
args: string[],
};
/**
* SSH 主机条目。
*
* `id` 是凭据键名的一部分(`terminal-ssh-password-{id}`),**创建后不应修改**
* 改了会让已存进凭据管理器的密码读不到。前端在编辑态需禁用该字段。
*/
export type SshHost = {
id?: string,
/** 展示别名(列表主标题) */
name?: string,
host?: string,
port?: number,
username?: string,
/** 认证方式:"key"(公钥,默认)| "password" | "agent"P1| "keyboard"P1 */
authMethod?: string,
/** 公钥认证使用的密钥 id(指向 [`super::keys`] 的密钥库) */
keyId?: string,
/** 分组名(侧栏按此分组) */
group?: string,
/** 备注 */
note?: string,
/** 标签色(前端用于状态点/分组标识) */
color?: string,
/** 是否收藏(置顶显示) */
favorited?: boolean,
/** 连接超时(毫秒) */
connectTimeoutMs?: number,
/** keep-alive 间隔(秒,0 表示关闭) */
keepaliveSecs?: number,
/** 启动目录(空串表示登录后进入默认目录) */
remoteCwd?: string,
/** 登录后自动执行的命令 */
startupCommand?: string,
/** 是否走代理模块(mihomo)。默认关闭:内网主机不该被绕进代理。 */
useProxy?: boolean,
/**
* 跳板机链(ProxyJump):按连接顺序排列的主机 id。
*
* 每一项引用**本主机列表里的另一台主机**(复用它的地址、账号与凭据),
* 连接方向为 `本机 → jump_ids[0] → jump_ids[1] → … → 本主机`。
* 空 = 直连。约束(命令层校验):不能引用自己、不能有环、
* 链长上限 5、每一跳的认证方式必须是 key/password。
*
* 用 id 引用而不是内联一份地址+凭据的理由:跳板机自己的密码/密钥
* 存在凭据管理器里,按 id 复用可以避免同一台跳板机在多处配置里
* 留下多份凭据副本(改密码时漏改一处就是连接事故)。
*/
jumpIds?: string[],
/** 终端的字符编码("utf-8" 默认 | "gbk" 等)。老服务器常见 GBK,中文环境刚需。 */
encoding?: string,
};
/** 任务下载协议类型 */
export type TaskProtocol =
/** HTTP/HTTPS 直链 */
@@ -1173,6 +1827,92 @@ export type TaskStatus =
/** 已取消(用户取消:进度与文件已清除,仅保留记录,只能再次下载) */
"cancelled";
/** 模板中的一个会话条目。 */
export type TemplateEntry = {
/** `"local"`shell| `"ssh"`(主机) */
kind?: string,
/**
* 本地 = shell idSSH = host id。拉起时实时解析——
* 模板只存引用,不快照账号密码(那些在凭据管理器里按 id 存取)。
*/
targetId?: string,
/** 保存时的展示名快照(仅用于模板列表显示;target 失效时前端据此标注) */
label?: string,
};
/**
* 一次查询的结果(含总数,供前端显示「共 N 条」)。
*
* # 为什么叫 `TerminalHistoryPage` 而不是 `HistoryPage`
*
* `tauri-specta` 给 `Type` 派生的类型注册表是**全局按类型名索引**的,重名会让
* `export_bindings()` 直接 panic`Detected multiple types with the same name`)。
* `clipboard::commands::HistoryPage``items: Vec<ClipboardItem>`)已占用这个名字。
*
* specta 2.0.0-rc.25 **没有**给 struct 提供重命名手段 —— `#[specta(rename = ...)]`
* 只对**函数**宏生效(`specta-macros/src/specta.rs` 的 `parse_name_attrs`);
* derive 路径下导出名直接取自 Rust 标识符
* `specta-macros/src/type/mod.rs``let name = unraw_raw_ident(&format_ident!("{}", raw_ident.to_string()))`),
* 而 `ContainerAttr` 只认 `crate` / `type` / `inline` / `remote` / `collect` /
* `skip_attr` / `transparent`,且 `reject_unknown_specta_attrs` 会让未知属性直接编译失败。
* 因此**改名是唯一可行解**。
*/
export type TerminalHistoryPage = {
items: CommandHistoryItem[],
/** 满足筛选条件的总条数(**不受 limit/offset 影响** */
total: number,
};
/**
* 终端内选中行为。
*
* # 为什么叫 `TerminalSelectionSettings` 而不是 `SelectionSettings`
*
* 与 `translate::settings::SelectionSettings` 撞名。`tauri-specta` 的类型注册表
* **全局按类型名索引**,重名会让 `export_bindings()` panic
* `Detected multiple types with the same name`)。
* specta 2.0.0-rc.25 的 derive 路径无法重命名导出类型
* (详见 `history::TerminalHistoryPage` 的注释),只能改 Rust 标识符本身。
*
* 注意:这是**第二个**独立引入的 `SelectionSettings`。新增跨模块共享名之前,
* 先确认没有同名 `Type` 已存在 —— 否则会在**运行时启动阶段**才炸,
* 而不是编译期(见 `TERMINAL_MODULE_PLAN.md` 坑 27)。
*/
export type TerminalSelectionSettings = {
/** 选中即复制(受 Linux/macOS 习惯影响的用户会开;默认关,避免误触) */
copyOnSelect?: boolean,
/** 中键粘贴(X11 习惯;Windows 下默认关) */
middleClickPaste?: boolean,
/** 右键行为:"menu"(默认,弹菜单)| "paste"(直接粘贴)| "select-word" */
rightClick?: string,
/** 复制时是否去掉尾部空行 */
trimTrailingNewline?: boolean,
};
export type TerminalSettings = {
/** 结构版本号(用于后续迁移判断) */
version?: number,
/** 本地 Shell 配置(探测结果 + 用户自定义,合并存放) */
shells?: ShellProfile[],
/** SSH 主机条目 */
hosts?: SshHost[],
/** 密钥元数据 */
keys?: KeyMeta[],
appearance?: AppearanceSettings,
layout?: LayoutSettings,
shortcuts?: ShortcutBinding[],
selection?: TerminalSelectionSettings,
security?: SecuritySettings,
/** 「关闭标签页时确认」等行为的白名单:某些会话可豁免确认 */
closeConfirmExempt?: string[],
/** 上次使用的 Shell id(新建会话时的默认选中项) */
lastShellId?: string,
/** 命令片段库 */
snippets?: CommandSnippet[],
/** 会话模板(一键拉起一组会话 + 布局) */
templates?: SessionTemplate[],
};
/** Token 用量(AI 引擎返回;其余引擎为 None) */
export type TokenUsage = {
promptTokens: number,
+16
View File
@@ -18,6 +18,8 @@ export const WINDOWS = {
downloadWindow: 'download-window',
/** 取词翻译悬浮窗(非激活显示,由 Rust 预创建) */
translatePopup: 'translate-popup',
/** 单个终端独立窗口,实际 label = `terminal-window-<sessionId>` */
terminalWindow: 'terminal-window',
} as const
/** Tauri 事件名(前端 emit / listen 与 Rust constants::events 对应) */
@@ -77,6 +79,20 @@ export const EVENTS = {
proxyAutoSwitch: 'proxy-auto-switch',
// 应用更新进度
updateProgress: 'update-progress',
// 终端:会话输出批次(按 8~16ms 窗口聚合,前端用 seq 校验连续性)
terminalOutput: 'terminal-output',
/** 终端:会话结束 */
terminalExit: 'terminal-exit',
/** 终端:会话状态变更(负载为 SessionInfo */
terminalState: 'terminal-state',
/** 终端:工作目录变化(OSC 7 hook 上报) */
terminalCwd: 'terminal-cwd',
/** 终端:SSH 主机密钥需用户确认(阻塞式,握手在等待回传) */
terminalHostKeyPrompt: 'terminal-host-key-prompt',
/** 终端:SFTP 传输进度(上传/下载,节流 200ms 推送一次) */
terminalTransferProgress: 'terminal-transfer-progress',
/** 终端:请求对「关闭仍在运行的会话」二次确认 */
terminalConfirmClose: 'terminal-confirm-close',
// 监控 OSD
osdStateUpdate: 'osd-state-update',
/** OSD 数据通道:仅推送显示项 key→value 映射 + 网速(高频,每秒) */
+287
View File
@@ -0,0 +1,287 @@
/**
* 终端内快捷键的动作定义表。
*
* # 三层快捷键的边界
*
* | 层级 | 范围 | 注册方式 | 举例 |
* |---|---|---|---|
* | 全局 | 任何应用前台时都能触发 | `crate::shortcut`Rust | 全局唤起终端窗口 |
* | **终端内** | **焦点在终端面板内时** | **本文件(前端 keydown)** | 复制粘贴、标签、分屏 |
* | shell 原生 | 被 PTY 消费 | 不做拦截,原样透传 | Ctrl+CSIGINT)、Tab 补全 |
*
* 本文件只管第二层。
*
* # 键位设计的两条硬约束
*
* 1. **`Ctrl+C` 与 `Ctrl+V` 绝不能被终端内快捷键占用**。终端里 `Ctrl+C` 必须是
* SIGINT(中断当前命令),这是不可协商的——把它映射成「复制」会让所有用户
* 失去中断能力。因此复制粘贴用 `Ctrl+Shift+C/V`Windows Terminal 惯例)。
*
* 2. **避开项目已有的全局快捷键**。`Ctrl+2` 已被翻译模块占用(取词翻译面板),
* 所以标签跳转用 `Alt+1..9` —— 在终端里 `Alt+数字` 通常不产生控制字符,
* 冲突面最小,且符合「切标签」的直觉。
*/
/** 快捷键动作定义 */
export interface TerminalAction {
/** 动作标识,与 Rust 侧 `default_shortcuts()` 的 action 字符串一致 */
id: string
/** 展示名(设置页显示) */
label: string
/** 分组(设置页按组呈现) */
group: string
/** 说明(展示在设置页的副标题,讲清「做了什么」) */
description: string
/** 默认键位(后端也会下发一份,此处用于未取到设置时的兜底与展示) */
defaultKeys: string
}
/**
* 全部终端内快捷键动作。
*
* 顺序即设置页的展示顺序。分组名刻意用「文本操作 / 标签 / 分屏 / 视图 / 会话」
* 这种动词短语,而不是「分类1」这类无信息量的标签。
*/
export const TERMINAL_ACTIONS: TerminalAction[] = [
{
id: 'copy',
label: '复制',
group: '文本操作',
description: '复制当前选中内容到剪贴板',
defaultKeys: 'Ctrl+Shift+C'
},
{
id: 'paste',
label: '粘贴',
group: '文本操作',
description: '把剪贴板内容写入终端(多行粘贴会触发确认)',
defaultKeys: 'Ctrl+Shift+V'
},
{
id: 'search',
label: '搜索',
group: '文本操作',
description: '在滚动缓冲中查找文本',
defaultKeys: 'Ctrl+Shift+F'
},
{
id: 'newTab',
label: '新建标签',
group: '标签',
description: '新建一个本地 Shell 会话',
defaultKeys: 'Ctrl+Shift+T'
},
{
id: 'closeTab',
label: '关闭标签',
group: '标签',
description: '关闭当前会话(有活跃进程时会二次确认)',
defaultKeys: 'Ctrl+Shift+W'
},
{
id: 'nextTab',
label: '下一个标签',
group: '标签',
description: '切换到右侧标签',
defaultKeys: 'Ctrl+Tab'
},
{
id: 'prevTab',
label: '上一个标签',
group: '标签',
description: '切换到左侧标签',
defaultKeys: 'Ctrl+Shift+Tab'
},
{
id: 'renameTab',
label: '重命名标签',
group: '标签',
description: '修改当前会话显示名称',
defaultKeys: 'F2'
},
{
id: 'splitRight',
label: '向右分屏',
group: '分屏',
description: '在当前面板右侧新建一个面板',
defaultKeys: 'Ctrl+Shift+D'
},
{
id: 'splitDown',
label: '向下分屏',
group: '分屏',
description: '在当前面板下方新建一个面板',
defaultKeys: 'Ctrl+Shift+E'
},
{
id: 'closePane',
label: '关闭面板',
group: '分屏',
description: '关闭当前分屏(保留会话)',
defaultKeys: 'Ctrl+Shift+Q'
},
{
id: 'clear',
label: '清屏',
group: '视图',
description: '清空显示内容(向 shell 发送清屏命令)',
defaultKeys: 'Ctrl+Shift+K'
},
{
id: 'fontIncrease',
label: '放大字号',
group: '视图',
description: '增大终端字体',
defaultKeys: 'Ctrl+='
},
{
id: 'fontDecrease',
label: '缩小字号',
group: '视图',
description: '减小终端字体',
defaultKeys: 'Ctrl+-'
},
{
id: 'fontReset',
label: '重置字号',
group: '视图',
description: '恢复设置中的默认字号',
defaultKeys: 'Ctrl+0'
},
{
id: 'toggleSftp',
label: '文件面板',
group: '视图',
description: '显示/隐藏当前 SSH 会话的文件管理面板(P1)',
defaultKeys: 'Ctrl+Shift+P'
},
{
id: 'snippets',
label: '代码片段',
group: '会话',
description: '打开常用命令片段列表',
defaultKeys: 'Ctrl+Shift+S'
},
{
id: 'sessionSwitcher',
label: '会话切换器',
group: '会话',
description: '列出全部会话并快速跳转',
defaultKeys: 'Ctrl+Shift+O'
},
{
id: 'detachWindow',
label: '独立窗口打开',
group: '会话',
description: '把当前会话放到独立窗口中(需终端独立窗口支持)',
defaultKeys: 'Ctrl+Shift+N'
}
]
/** 动作 id → 定义 的索引 */
export const ACTION_MAP: Record<string, TerminalAction> = Object.fromEntries(
TERMINAL_ACTIONS.map(a => [a.id, a])
)
/**
* 设置页的分组顺序。
*
* 显式列出而不是从 TERMINAL_ACTIONS 推导:我们希望分组顺序稳定,
* 而不是随着动作增删而漂移。
*/
export const ACTION_GROUPS = ['文本操作', '标签', '分屏', '视图', '会话'] as const
/**
* 判断一个键盘事件是否匹配某个键位字符串。
*
* 键位字符串格式与 Rust 侧 `crate::shortcut::parse_shortcut` 保持一致:
* `Ctrl+Shift+C`、`Alt+1`、`F2`、`Ctrl+=`。
*
* 匹配规则(与浏览器/系统惯例对齐):
* - 修饰键必须**精确**匹配(多按或少按都算不匹配)。
* 例:绑定了 `Ctrl+Shift+C` 时,只按 `Ctrl+C` 不应触发。
* - 主键比较不区分大小写(`Ctrl+Shift+C` 与 `Ctrl+Shift+c` 等价)。
* - `Tab` 作为主键时,`Shift` 参与区分(`Ctrl+Tab` ≠ `Ctrl+Shift+Tab`)。
*/
export function matchesShortcut(e: KeyboardEvent, keys: string): boolean {
if (!keys) return false
const parts = keys
.split('+')
.map(p => p.trim())
.filter(Boolean)
if (parts.length === 0) return false
const wantCtrl = parts.some(p => p.toLowerCase() === 'ctrl')
const wantShift = parts.some(p => p.toLowerCase() === 'shift')
const wantAlt = parts.some(p => p.toLowerCase() === 'alt')
const wantMeta = parts.some(p => p.toLowerCase() === 'meta' || p.toLowerCase() === 'win')
// 修饰键精确匹配:避免「绑了 Ctrl+Shift+T,按 Ctrl+T 也触发」这类误触
if (e.ctrlKey !== wantCtrl) return false
if (e.shiftKey !== wantShift) return false
if (e.altKey !== wantAlt) return false
if (e.metaKey !== wantMeta) return false
const main = parts.find(
p => !['ctrl', 'shift', 'alt', 'meta', 'win'].includes(p.toLowerCase())
)
if (!main) return false
// 主键比较:兼容 e.key 的多种写法('=' vs '+', ' ' vs 'Space'
const key = normalizeKey(e.key)
const target = normalizeKey(main)
return key === target
}
/** 把 KeyboardEvent.key 规整成键位字符串里的写法 */
function normalizeKey(raw: string): string {
const k = raw.length === 1 ? raw.toUpperCase() : raw
const alias: Record<string, string> = {
' ': 'Space',
Spacebar: 'Space',
Esc: 'Escape',
Del: 'Delete',
Ins: 'Insert',
Return: 'Enter',
Add: '+',
Subtract: '-',
Equal: '=',
Minus: '-',
// Shift+数字 时 e.key 会变成符号(Shift+1 → '!'),而键位表里写的是 '1'。
// 这里做一次反向映射,让 `Alt+1` 在按住 Shift 的意外情况下也能识别。
'!': '1',
'@': '2',
'#': '3',
$: '4',
'%': '5',
'^': '6',
'&': '7',
'*': '8',
'(': '9',
')': '0',
_: '-',
'+': '='
}
return alias[k] ?? k
}
/**
* 把 KeyboardEvent 转成键位字符串(设置页录制新键位时用)。
*
* 返回空串表示「只按了修饰键」,调用方应忽略这种中间状态。
*/
export function eventToShortcut(e: KeyboardEvent): string {
const parts: string[] = []
if (e.ctrlKey) parts.push('Ctrl')
if (e.shiftKey) parts.push('Shift')
if (e.altKey) parts.push('Alt')
if (e.metaKey) parts.push('Meta')
const key = e.key
// 只按修饰键时 e.key 就是修饰键本身,此时不应产出绑定
if (['Control', 'Shift', 'Alt', 'Meta'].includes(key)) return ''
parts.push(normalizeKey(key))
return parts.join('+')
}
+199
View File
@@ -0,0 +1,199 @@
import type { ITheme } from '@xterm/xterm'
/**
* 终端配色方案。
*
* # 为什么自己定义而不是引第三方包
*
* 常见的 `xterm-theme` 包把几十套主题硬编码在一个文件里,其中大部分用不上,
* 且它的配色值与 VS Code / Windows Terminal 的官方定义常有小幅偏差
* (导致同一个主题在两个终端里看起来不一样)。这里只保留项目实际提供的几套,
* 数值取自各主题官方定义,保证「选了 solarized-dark 就和别处一致」。
*
* # 命名与 Rust 侧一致
*
* key 必须与 `terminal/settings.rs` 中 `AppearanceSettings.theme` 的取值一致,
* 否则用户选了主题却回落到默认(且不会有任何报错,属于静默失效)。
*/
export const TERMINAL_THEMES: Record<string, ITheme> = {
/** VS Code 默认深色(最通用,作为默认值) */
'vscode-dark': {
background: '#1e1e1e',
foreground: '#cccccc',
cursor: '#ffffff',
cursorAccent: '#1e1e1e',
selectionBackground: '#264f78',
black: '#000000',
red: '#cd3131',
green: '#0dbc79',
yellow: '#e5e510',
blue: '#2472c8',
magenta: '#bc3fbc',
cyan: '#11a8cd',
white: '#e5e5e5',
brightBlack: '#666666',
brightRed: '#f14c4c',
brightGreen: '#23d18b',
brightYellow: '#f5f543',
brightBlue: '#3b8eea',
brightMagenta: '#d670d6',
brightCyan: '#29b8db',
brightWhite: '#e5e5e5'
},
/** VS Code 浅色 */
'vscode-light': {
background: '#ffffff',
foreground: '#333333',
cursor: '#000000',
cursorAccent: '#ffffff',
selectionBackground: '#add6ff',
black: '#000000',
red: '#cd3131',
green: '#00bc00',
yellow: '#949800',
blue: '#0451a5',
magenta: '#bc05bc',
cyan: '#0598bc',
white: '#555555',
brightBlack: '#666666',
brightRed: '#cd3131',
brightGreen: '#14ce14',
brightYellow: '#b5ba00',
brightBlue: '#0451a5',
brightMagenta: '#bc05bc',
brightCyan: '#0598bc',
brightWhite: '#a5a5a5'
},
/** Solarized Dark(长时间阅读友好,低对比度) */
'solarized-dark': {
background: '#002b36',
foreground: '#839496',
cursor: '#93a1a1',
cursorAccent: '#002b36',
selectionBackground: '#073642',
black: '#073642',
red: '#dc322f',
green: '#859900',
yellow: '#b58900',
blue: '#268bd2',
magenta: '#d33682',
cyan: '#2aa198',
white: '#eee8d5',
brightBlack: '#002b36',
brightRed: '#cb4b16',
brightGreen: '#586e75',
brightYellow: '#657b83',
brightBlue: '#839496',
brightMagenta: '#6c71c4',
brightCyan: '#93a1a1',
brightWhite: '#fdf6e3'
},
/** Solarized Light */
'solarized-light': {
background: '#fdf6e3',
foreground: '#657b83',
cursor: '#586e75',
cursorAccent: '#fdf6e3',
selectionBackground: '#eee8d5',
black: '#073642',
red: '#dc322f',
green: '#859900',
yellow: '#b58900',
blue: '#268bd2',
magenta: '#d33682',
cyan: '#2aa198',
white: '#eee8d5',
brightBlack: '#002b36',
brightRed: '#cb4b16',
brightGreen: '#586e75',
brightYellow: '#657b83',
brightBlue: '#839496',
brightMagenta: '#6c71c4',
brightCyan: '#93a1a1',
brightWhite: '#fdf6e3'
},
/** Dracula(高对比度深色,护眼配色) */
dracula: {
background: '#282a36',
foreground: '#f8f8f2',
cursor: '#f8f8f2',
cursorAccent: '#282a36',
selectionBackground: '#44475a',
black: '#21222c',
red: '#ff5555',
green: '#50fa7b',
yellow: '#f1fa8c',
blue: '#bd93f9',
magenta: '#ff79c6',
cyan: '#8be9fd',
white: '#f8f8f2',
brightBlack: '#6272a4',
brightRed: '#ff6e6e',
brightGreen: '#69ff94',
brightYellow: '#ffffa5',
brightBlue: '#d6acff',
brightMagenta: '#ff92df',
brightCyan: '#a4ffff',
brightWhite: '#ffffff'
},
/** One DarkAtom/VS Code 经典深色) */
'one-dark': {
background: '#282c34',
foreground: '#abb2bf',
cursor: '#528bff',
cursorAccent: '#282c34',
selectionBackground: '#3e4451',
black: '#282c34',
red: '#e06c75',
green: '#98c379',
yellow: '#e5c07b',
blue: '#61afef',
magenta: '#c678dd',
cyan: '#56b6c2',
white: '#abb2bf',
brightBlack: '#5c6370',
brightRed: '#e06c75',
brightGreen: '#98c379',
brightYellow: '#e5c07b',
brightBlue: '#61afef',
brightMagenta: '#c678dd',
brightCyan: '#56b6c2',
brightWhite: '#ffffff'
},
/** 跟随主应用(用 CSS 变量解析,见 resolveTheme */
system: {
// 占位:真实值在 resolveTheme 中按当前亮暗模式填入
}
}
/** 供设置页下拉展示的选项(key + 中文标签) */
export const TERMINAL_THEME_OPTIONS: Array<{ value: string; label: string }> = [
{ value: 'vscode-dark', label: 'VS Code 深色' },
{ value: 'vscode-light', label: 'VS Code 浅色' },
{ value: 'solarized-dark', label: 'Solarized 深色' },
{ value: 'solarized-light', label: 'Solarized 浅色' },
{ value: 'dracula', label: 'Dracula' },
{ value: 'one-dark', label: 'One Dark' },
{ value: 'system', label: '跟随主应用' }
]
/**
* 解析主题名到具体的 xterm 主题对象。
*
* `system` 会读取主应用的亮暗模式(`document.documentElement` 上的 `dark` class
* Tailwind 的暗色模式约定),映射到 vscode-dark / vscode-light。
* 这样终端不会在主应用切到浅色时突兀地保持全黑。
*/
export function resolveTheme(name: string): ITheme {
if (name === 'system') {
const isDark = document.documentElement.classList.contains('dark')
return TERMINAL_THEMES[isDark ? 'vscode-dark' : 'vscode-light']
}
return TERMINAL_THEMES[name] ?? TERMINAL_THEMES['vscode-dark']
}
+10 -2
View File
@@ -40,16 +40,19 @@ const standaloneWindowApps: Array<[hash: string, label: string, loader: () => Pr
['#screenshot-scroll', '滚动截图', () => import('./modules/screenshot/ScrollControl.vue')],
['#download-window', '下载窗口', () => import('./modules/downloader/DownloadWindow.vue')],
['#translate-popup', '翻译悬浮窗', () => import('./modules/translate/TranslatePopup.vue')],
['#terminal-window', '终端独立窗口', () => import('./modules/terminal/TerminalWindow.vue')],
]
const winHash = window.location.hash
// #screenshot-overlay 带窗口号参数(多屏)、#download-window 带 ?task= 参数,按前缀匹配;其余精确匹配
// #screenshot-overlay 带窗口号参数(多屏)、#download-window 带 ?task= 参数,
// #terminal-window 带 /{session_id} 路径参数,均按前缀匹配;其余精确匹配
const matched = standaloneWindowApps.find(([hash]) => {
if (
hash === '#screenshot-overlay' ||
hash === '#screenshot-scroll' ||
hash === '#download-window'
hash === '#download-window' ||
hash === '#terminal-window'
)
return winHash.startsWith(hash)
return winHash === hash
@@ -60,6 +63,11 @@ if (matched) {
logger.info(`${label}窗口启动: ${winHash}`)
void loader().then(({ default: Comp }) => {
const app = createApp(Comp)
// 独立窗口也要装一份自己的 Pinia:Pinia 是**窗口级**的,每个 WebView 有独立
// JS 运行时,store 实例互不可见;后端状态经 IPC 共享,前端缓存分叉无碍
//(见 TerminalWindow.vue 头注释)。终端独立窗口在 setup 里调 useTerminalStore
// 缺这一步会直接抛「getActivePinia() was called but there was no active Pinia」。
app.use(createPinia())
app.mount('#app')
})
} else {
+4 -2
View File
@@ -9,7 +9,8 @@ import {
Command,
Wrench,
Music,
Languages
Languages,
SquareTerminal
} from '@lucide/vue'
/**
@@ -29,7 +30,8 @@ export const moduleIconMap: Record<string, Component> = {
quickpanel: Command,
devtools: Wrench,
music: Music,
translate: Languages
translate: Languages,
terminal: SquareTerminal
}
/** 获取模块图标组件,未找到时回退到 Settings 图标 */
+3 -1
View File
@@ -12,6 +12,7 @@ import { moduleConfig as devtools } from './devtools'
import { moduleConfig as settings } from './settings'
import { moduleConfig as music } from './music'
import { moduleConfig as translate } from './translate'
import { moduleConfig as terminal } from './terminal'
const allModules: ModuleConfig[] = [
proxy,
@@ -23,7 +24,8 @@ const allModules: ModuleConfig[] = [
devtools,
settings,
music,
translate
translate,
terminal
]
// 启动时注册所有模块
File diff suppressed because it is too large Load Diff
+252
View File
@@ -0,0 +1,252 @@
<script setup lang="ts">
/**
* 终端独立窗口。
*
* # 与主窗口的关系
*
* 同一个 `sessionId` 可以同时被两个窗口订阅输出 —— 这不是设计缺陷,而是
* 「分离标签」的应有语义:独立窗口打开后,主窗口那侧的面板仍然保留(
* 内容同步更新),只是标记为 detached,用户随时可以收回来。
*
* 因此本窗口**不新建会话、也不接管生命周期**,它只是一个**附加的视图**:
* 订阅同一份输出、写入同一个 PTY、在关闭时把 detached 置回 false。
*
* # 为什么这里可以安全地装一个独立 Pinia
*
* Pinia 是**窗口级**的:每个 WebView 窗口有自己的 JS 运行时,各自的 store
* 实例互不可见,但**后端状态是共享的**(都通过 IPC 打到同一个 `TerminalManager`)。
* 所以这里 `createPinia()` 不会造成状态分裂 —— 分叉的只是「前端缓存」,
* 而事件监听的幂等保护(`store.ensureListeners` 里的 `listening` 标志)
* 恰好保证了每个窗口只注册一份自己的监听。
*
* # 为什么必须自己注册事件监听
*
* 输出事件是**窗口广播**Rust 侧 `app.emit` 发到所有窗口),主窗口的监听器
* 管不到本窗口。这正是「独立窗口能收到输出」的实现基础。
*/
import { computed, onBeforeUnmount, onMounted, ref } from 'vue'
import { getCurrentWindow } from '@tauri-apps/api/window'
import { AlertTriangle, Loader2, Menu, Minus, Square, X } from '@lucide/vue'
import { useTerminalStore } from '@/stores/terminalStore'
import { useTerminalStream } from '@/composables/useSessionStream'
import { useTerminalKeys } from '@/composables/useTerminalKeys'
import { createLogger } from '@/lib/logger'
import TerminalPane from './components/TerminalPane.vue'
import TerminalStatusBar from './components/TerminalStatusBar.vue'
import HostKeyPromptDialog from './components/HostKeyPromptDialog.vue'
const logger = createLogger('terminal')
// ===== 从 URL hash 解析会话 id#terminal-window/{session_id} =====
//
// 用路径段而不是 query 参数:会话 id 是后端生成的短串(如 `t1758...`),
// 放在路径里读起来更像「标识」,且与截图模块的 `#screenshot-overlay/0` 一致。
const hash = window.location.hash
const sessionId = hash.replace('#terminal-window/', '').replace('#terminal-window', '')
if (!sessionId) {
logger.error('终端独立窗口缺少 sessionId 参数')
}
const win = getCurrentWindow()
const store = useTerminalStore()
const stream = useTerminalStream({ fixedSessionId: ref(sessionId) })
const { effectiveAppearance, bumpFont, resetFont, bindings, init } = stream
const session = computed(() => store.sessionById(sessionId))
// ===== 面板引用 =====
const paneRef = ref<InstanceType<typeof TerminalPane> | null>(null)
// ===== 生命周期 =====
const ready = ref(false)
const fatal = ref('')
onMounted(async () => {
if (!sessionId) {
fatal.value = '缺少会话 ID,无法确定要显示哪个会话'
ready.value = true
return
}
try {
await init()
// 会话可能已经被关闭(窗口是异步创建的,这中间有窗口期)
if (!store.sessionById(sessionId)) {
fatal.value = '该会话已结束或不存在'
ready.value = true
// 会话没了,本窗口没有意义 —— 给用户一点时间看到提示再关闭
setTimeout(() => void win.close(), 1800)
return
}
// 把标题设成会话名,方便任务栏与窗口列表识别
const info = store.sessionById(sessionId)
if (info?.title) {
void win.setTitle(`${info.title} · 终端`)
}
} catch (e) {
logger.error(`独立窗口初始化失败:${String(e)}`)
fatal.value = `初始化失败:${String(e)}`
} finally {
ready.value = true
}
})
/**
* 窗口关闭时把会话的 detached 置回 false。
*
* 这是**必须**做的:detached 标记决定了主窗口是否显示「已在独立窗口打开」的提示条。
* 若窗口被用户拖到任务栏关掉而不重置,主窗口会一直以为这个会话还在独立窗口里,
* 显示一个永远点不动的提示,且用户没有任何办法消除它。
*
* 用 `onBeforeUnmount` 而不是监听 Tauri 的 close 事件:WebView 卸载时
* `invoke` 仍可发出(IPC 通道在窗口销毁前还有效),这是最后一个可靠时机。
*/
onBeforeUnmount(() => {
if (!sessionId) return
void store.attachSession(sessionId).catch(e => {
logger.warn(`重置 detached 标记失败:${String(e)}`)
})
})
// ===== 快捷键(独立窗口内只保留与本会话相关的动作) =====
useTerminalKeys({
bindings: () => bindings.value,
onAction: actionId => {
switch (actionId) {
case 'copy': {
const text = paneRef.value?.getSelection?.()
if (text) void navigator.clipboard.writeText(text.replace(/\n+$/, ''))
break
}
case 'paste':
void navigator.clipboard
.readText()
.then(text => (text ? store.write(sessionId, text) : undefined))
.catch(e => logger.error(`粘贴失败:${String(e)}`))
break
case 'clear':
paneRef.value?.clear?.()
break
case 'fontIncrease':
void bumpFont(1)
break
case 'fontDecrease':
void bumpFont(-1)
break
case 'fontReset':
resetFont()
break
// 标签类/分屏类动作在独立窗口里没有意义,静默忽略
default:
break
}
}
})
// ===== 无边框窗口的自定义标题栏 =====
/**
* 无边框窗口需要自己实现拖拽与最小化/最大化/关闭。
*
* 但本窗口**不实现拖拽区域**:终端面板占满整个窗口,若在顶部加拖拽条,
* 用户会失去一块垂直空间;而拖拽整个窗口的需求可以通过系统的方式完成
* (Alt+Space、或拖窗口边缘)。这里只保留最小化/最大化/关闭三个按钮。
*/
async function minimize() {
await win.minimize()
}
async function toggleMaximize() {
await win.toggleMaximize()
}
async function closeWindow() {
await win.close()
}
</script>
<template>
<div class="flex flex-col h-screen w-screen overflow-hidden bg-background">
<!-- 标题栏 -->
<div
class="shrink-0 h-8 flex items-center gap-2 px-2 border-b border-border select-none"
data-tauri-drag-region
>
<Menu class="size-3.5 text-muted-foreground shrink-0 pointer-events-none" />
<span class="text-xs truncate flex-1 pointer-events-none">
{{ session?.title || '终端' }}
</span>
<button
class="size-6 flex items-center justify-center rounded hover:bg-accent transition-colors"
title="最小化"
@click="minimize"
>
<Minus class="size-3" />
</button>
<button
class="size-6 flex items-center justify-center rounded hover:bg-accent transition-colors"
title="最大化"
@click="toggleMaximize"
>
<Square class="size-2.5" />
</button>
<button
class="size-6 flex items-center justify-center rounded hover:bg-destructive
hover:text-destructive-foreground transition-colors"
title="关闭窗口(会话保留)"
@click="closeWindow"
>
<X class="size-3.5" />
</button>
</div>
<!-- 主体 -->
<div class="flex-1 min-h-0 relative">
<div v-if="!ready" class="absolute inset-0 flex items-center justify-center">
<div class="flex flex-col items-center gap-3">
<Loader2 class="size-5 animate-spin text-muted-foreground" />
<p class="text-xs text-muted-foreground">正在加载会话</p>
</div>
</div>
<div v-else-if="fatal" class="absolute inset-0 flex items-center justify-center p-8">
<div class="flex flex-col items-center gap-3 text-center">
<AlertTriangle class="size-8 text-destructive/60" />
<p class="text-sm text-muted-foreground">{{ fatal }}</p>
</div>
</div>
<TerminalPane
v-else
ref="paneRef"
:session-id="sessionId"
:appearance="effectiveAppearance"
:visible="true"
/>
</div>
<!-- 状态栏 -->
<TerminalStatusBar
v-if="ready && !fatal"
:session="session"
:font-size="effectiveAppearance?.fontSize ?? 14"
:cols="session?.cols"
:rows="session?.rows"
/>
<!-- 主机密钥确认独立窗口也可能触发用户直接从这个窗口发起连接时 -->
<HostKeyPromptDialog />
</div>
</template>
<style scoped>
/* 独立窗口无边框,禁止整页滚动与选中,贴近原生窗口行为 */
:global(html),
:global(body) {
overflow: hidden;
margin: 0;
}
</style>
+211
View File
@@ -0,0 +1,211 @@
<script setup lang="ts">
/**
* AI 命令助手面板(P2)。
*
* # 引擎来源
*
* 复用**翻译模块**的 AI 引擎配置(Base URL / 模型 / 密钥)——用户配置一份 API
* 即可在两处使用。没有可用引擎时展示引导文案而不是让用户点了「生成」才报错。
*
* # 交互与片段库同一套安全语义
*
* 建议默认「填入命令行」(用户自己按回车),「直接执行」是显式第二动作。
* 理由与 SnippetPanel 一致:命令被自动执行与等待用户确认,在心理上完全不同;
* 而且模型的建议未经本地验证,用户应当有机会先看一眼再回车。
*
* # 上下文
*
* 「带上下文」开关取终端当前**选中文本**(用户选中一段报错再点生成,
* 模型能理解「接着这个修」)。没有选区时不传上下文——把整个屏幕
* 内容都塞给模型既稀释意图又增加 token 费用。
*/
import { computed, ref, watch } from 'vue'
import { Sparkles, Square, TerminalSquare } from '@lucide/vue'
import { toast } from 'vue-sonner'
import { useTerminalStore } from '@/stores/terminalStore'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'
import { Label } from '@/components/ui/label'
import {
Dialog,
DialogContent,
DialogDescription,
DialogHeader,
DialogTitle
} from '@/components/ui/dialog'
import {
Select,
SelectContent,
SelectItem,
SelectTrigger,
SelectValue
} from '@/components/ui/select'
import { createLogger } from '@/lib/logger'
import type { AiEngineOption, CommandSuggestion } from '@/types/terminal'
const logger = createLogger('terminal')
const store = useTerminalStore()
const props = defineProps<{
open: boolean
/** 当前会话(填入/执行的目标;null 时只能看不能填) */
sessionId: string | null
/** 取终端上下文(选中文本等),由 TerminalModule 提供 */
getContext: () => string
}>()
const emit = defineEmits<{ (e: 'update:open', v: boolean): void }>()
const engines = ref<AiEngineOption[]>([])
const engineId = ref('')
const intent = ref('')
const useContext = ref(false)
const loadingEngines = ref(false)
const generating = ref(false)
const suggestions = ref<CommandSuggestion[]>([])
watch(
() => props.open,
async v => {
if (!v) return
suggestions.value = []
loadingEngines.value = true
try {
engines.value = await store.aiEngines()
// 默认选第一个(后端已按优先级排序);保留用户上次的选择
if (engineId.value && engines.value.some(e => e.id === engineId.value)) {
// keep
} else {
engineId.value = engines.value[0]?.id ?? ''
}
} catch (e) {
logger.error(`加载 AI 引擎列表失败:${String(e)}`)
toast.error(`加载引擎列表失败:${String(e)}`)
} finally {
loadingEngines.value = false
}
}
)
const canGenerate = computed(
() => !!engineId.value && intent.value.trim().length > 0 && !generating.value
)
async function generate() {
if (!canGenerate.value) return
generating.value = true
try {
const ctx = useContext.value ? props.getContext() : ''
suggestions.value = await store.aiSuggest(engineId.value, intent.value, ctx)
if (suggestions.value.length === 0) {
toast.info('模型没有给出建议,试着换个描述')
}
} catch (e) {
toast.error(`生成失败:${String(e)}`)
} finally {
generating.value = false
}
}
/**
* 填入 / 执行。
*
* 两条路径都把命令字节写进 PTY stdin;区别只是要不要带回车(0x0D)。
* 「填入」让用户保留最后的确认权——模型的建议可能差一个参数。
*/
async function deliver(cmd: string, execute: boolean) {
if (!props.sessionId) {
toast.error('当前没有可写入的会话')
return
}
try {
const payload = execute ? `${cmd}\r` : cmd
await store.write(props.sessionId, new TextEncoder().encode(payload))
if (!execute) emit('update:open', false) // 填入后回到终端看命令
} catch (e) {
toast.error(`写入终端失败:${String(e)}`)
}
}
/** 引擎展示名(含模型,方便多引擎用户区分) */
function engineLabel(e: AiEngineOption): string {
return e.model ? `${e.name}${e.model}` : e.name
}
</script>
<template>
<Dialog :open="open" @update:open="v => emit('update:open', v)">
<DialogContent class="max-w-lg">
<DialogHeader>
<DialogTitle class="flex items-center gap-2 text-base">
<Sparkles class="size-4" />AI 命令助手
</DialogTitle>
<DialogDescription class="text-xs">
复用翻译设置里的 AI 引擎建议默认只填入命令行由你确认后执行
</DialogDescription>
</DialogHeader>
<!-- 引擎选择 -->
<div class="space-y-1.5">
<Label class="text-xs">引擎</Label>
<p v-if="loadingEngines" class="text-xs text-muted-foreground">加载中</p>
<template v-else-if="engines.length > 0">
<Select v-model="engineId">
<SelectTrigger class="h-8 text-xs">
<SelectValue placeholder="选择引擎" />
</SelectTrigger>
<SelectContent>
<SelectItem v-for="e in engines" :key="e.id" :value="e.id">
{{ engineLabel(e) }}
</SelectItem>
</SelectContent>
</Select>
</template>
<p v-else class="text-xs text-muted-foreground">
还没有可用的 AI 引擎请到
<span class="text-foreground font-medium">翻译模块 设置 引擎</span>
配置一个DeepSeek / OpenAI / Ollama OpenAI 兼容服务均可配置后回到这里刷新
</p>
</div>
<!-- 意图 -->
<div class="space-y-1.5">
<Label class="text-xs">你想做什么</Label>
<Input
v-model="intent"
placeholder="例如:找出占用磁盘最大的 10 个目录"
class="h-8 text-sm"
@keydown.enter="generate"
/>
<label class="flex items-center gap-1.5 text-[11px] text-muted-foreground cursor-pointer select-none">
<input v-model="useContext" type="checkbox" class="accent-primary" />
带上终端选中的文本作为上下文
</label>
</div>
<Button size="sm" class="w-full gap-1.5 text-xs" :disabled="!canGenerate" @click="generate">
<Sparkles class="size-3.5" />{{ generating ? '生成中…' : '生成建议' }}
</Button>
<!-- 建议 -->
<div v-if="suggestions.length > 0" class="space-y-1.5">
<div
v-for="(s, i) in suggestions"
:key="i"
class="rounded border border-border px-2.5 py-1.5 space-y-1"
>
<p class="text-xs font-mono break-all">{{ s.command }}</p>
<p class="text-[11px] text-muted-foreground">{{ s.description }}</p>
<div class="flex gap-1.5 justify-end">
<Button variant="outline" size="sm" class="h-6 gap-1 px-2 text-[11px]" :disabled="!sessionId" @click="deliver(s.command, false)">
<TerminalSquare class="size-3" />填入命令行
</Button>
<Button size="sm" class="h-6 gap-1 px-2 text-[11px]" :disabled="!sessionId" @click="deliver(s.command, true)">
<Square class="size-3" />直接执行
</Button>
</div>
</div>
</div>
</DialogContent>
</Dialog>
</template>
@@ -0,0 +1,253 @@
<script setup lang="ts">
/**
* 端口转发面板(P2)。
*
* # 交互形态的取舍
*
* 用**对话框**而不是 SFTP 那样的停靠面板:转发是「配置一次就忘」的低频操作,
* 不值得长期占据一块屏幕区域;对话框随开随关,与工具栏按钮的生命周期一致。
*
* # 两个方向的语义(UI 文案要写对,这是最容易配错的地方)
*
* - 本地转发(-L):「访问**我本机**的 A 端口 = 访问**服务器看到的** B 服务」。
* 典型:本机 13306 → 服务器视角的数据库 3306。
* - 远程转发(-R):「访问**服务器**的 A 端口 = 回到**我本机**的 B 服务」。
* 典型:在服务器上访问 18080 = 访问我本机跑着的开发服务器。
*
* 规则挂在会话上不持久化:会话关闭全部失效(与 ssh 客户端直觉一致)。
*/
import { ref, watch } from 'vue'
import { Network, Plus, Trash2 } from '@lucide/vue'
import { toast } from 'vue-sonner'
import { useTerminalStore } from '@/stores/terminalStore'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'
import { Label } from '@/components/ui/label'
import {
Dialog,
DialogContent,
DialogDescription,
DialogHeader,
DialogTitle
} from '@/components/ui/dialog'
import {
Select,
SelectContent,
SelectItem,
SelectTrigger,
SelectValue
} from '@/components/ui/select'
import { createLogger } from '@/lib/logger'
import type { ForwardView } from '@/types/terminal'
const logger = createLogger('terminal')
const store = useTerminalStore()
const props = defineProps<{
open: boolean
sessionId: string | null
/** 会话标题(显示当前操作对象) */
sessionLabel: string
}>()
const emit = defineEmits<{ (e: 'update:open', v: boolean): void }>()
const forwards = ref<ForwardView[]>([])
const loading = ref(false)
const busy = ref(false)
// ===== 新增表单 =====
const formKind = ref<'local' | 'remote'>('local')
const formBindHost = ref('127.0.0.1')
const formBindPort = ref('' as string | number)
const formTargetHost = ref('127.0.0.1')
const formTargetPort = ref('' as string | number)
/** 打开时拉取一次列表;之后靠本地操作同步(转发只在别处被会话关闭清除) */
watch(
() => props.open,
async v => {
if (!v) return
forwards.value = []
if (!props.sessionId) return
loading.value = true
try {
forwards.value = await store.listForwards(props.sessionId)
} catch (e) {
logger.error(`加载转发列表失败:${String(e)}`)
toast.error(`加载转发列表失败:${String(e)}`)
} finally {
loading.value = false
}
}
)
function portOf(v: string | number): number {
const n = Number(v)
return Number.isInteger(n) ? n : 0
}
/** 新增端口语义随方向变化,切换类型时给出合理默认值 */
watch(formKind, k => {
if (k === 'remote') {
// 服务器上开 18080,回连本机 8080 是常见形态
if (!formBindPort.value) formBindPort.value = 18080
formTargetHost.value = '127.0.0.1'
if (!formTargetPort.value) formTargetPort.value = 8080
} else {
if (!formBindPort.value) formBindPort.value = 13306
if (!formTargetPort.value) formTargetPort.value = 3306
}
})
async function submitAdd() {
if (!props.sessionId) return
const bp = portOf(formBindPort.value)
const tp = portOf(formTargetPort.value)
if (!bp || bp > 65535) {
toast.error('监听端口需在 165535 之间')
return
}
if (!formTargetHost.value.trim()) {
toast.error('请填写目标地址')
return
}
if (!tp || tp > 65535) {
toast.error('目标端口需在 165535 之间')
return
}
busy.value = true
try {
forwards.value = await store.addForward(props.sessionId, {
kind: formKind.value,
bindHost: formBindHost.value.trim(),
bindPort: bp,
targetHost: formTargetHost.value.trim(),
targetPort: tp
})
toast.success('转发已建立')
// 清空端口便于连续添加,保留类型与地址习惯
formBindPort.value = ''
formTargetPort.value = ''
} catch (e) {
toast.error(`${String(e)}`)
} finally {
busy.value = false
}
}
async function removeOne(f: ForwardView) {
if (!props.sessionId) return
try {
forwards.value = await store.removeForward(props.sessionId, f.id)
} catch (e) {
toast.error(`删除失败:${String(e)}`)
}
}
/** 方向描述(表格首列):一眼看懂流量从哪到哪 */
function directionText(f: ForwardView): string {
return f.kind === 'local'
? `本机:${f.bindPort}${f.targetHost}:${f.targetPort}(经服务器)`
: `服务器:${f.bindPort}${f.targetHost}:${f.targetPort}(回本机)`
}
</script>
<template>
<Dialog :open="open" @update:open="v => emit('update:open', v)">
<DialogContent class="max-w-xl">
<DialogHeader>
<DialogTitle class="flex items-center gap-2 text-base">
<Network class="size-4" />端口转发
</DialogTitle>
<DialogDescription class="text-xs">
会话{{ sessionLabel }}规则在会话存活期间有效断开后自动失效
</DialogDescription>
</DialogHeader>
<!-- ===== 已有规则 ===== -->
<div class="space-y-1.5 min-h-[60px]">
<p v-if="loading" class="text-xs text-muted-foreground">加载中</p>
<p v-else-if="forwards.length === 0" class="text-xs text-muted-foreground">
还没有转发规则常见用法本地转发本机 13306 服务器视角的 127.0.0.1:3306
即可在本机用数据库客户端直连服务器内网数据库
</p>
<div
v-for="f in forwards"
:key="f.id"
class="flex items-center gap-2 rounded border border-border px-2.5 py-1.5"
>
<span
class="shrink-0 rounded px-1.5 py-0.5 text-[10px]"
:class="f.kind === 'local' ? 'bg-primary/10 text-primary' : 'bg-blue-500/10 text-blue-500'"
>
{{ f.kind === 'local' ? '本地' : '远程' }}
</span>
<div class="min-w-0 flex-1">
<p class="text-xs font-mono truncate">{{ directionText(f) }}</p>
<p
class="text-[10px] truncate"
:class="f.status === 'error' ? 'text-destructive' : 'text-muted-foreground'"
>
{{ f.detail }}
</p>
</div>
<Button
variant="ghost"
size="sm"
class="h-7 w-7 p-0 text-destructive hover:text-destructive shrink-0"
title="删除此转发"
@click="removeOne(f)"
>
<Trash2 class="size-3.5" />
</Button>
</div>
</div>
<!-- ===== 新增 ===== -->
<div class="space-y-2 rounded-md border border-border p-3">
<div class="flex items-center gap-2">
<Label class="text-xs shrink-0">方向</Label>
<Select v-model="formKind">
<SelectTrigger class="h-8 text-xs flex-1">
<SelectValue />
</SelectTrigger>
<SelectContent>
<SelectItem value="local">本地转发-L本机端口 经服务器到达目标</SelectItem>
<SelectItem value="remote">远程转发-R服务器端口 回连本机目标</SelectItem>
</SelectContent>
</Select>
</div>
<div class="grid grid-cols-2 gap-2">
<div class="space-y-1">
<Label class="text-[11px] text-muted-foreground">
{{ formKind === 'local' ? '本机监听' : '服务器监听' }}地址 : 端口
</Label>
<div class="flex gap-1">
<Input v-model="formBindHost" class="h-8 text-xs font-mono flex-1" />
<Input v-model="formBindPort" placeholder="端口" class="h-8 text-xs font-mono w-[88px]" />
</div>
</div>
<div class="space-y-1">
<Label class="text-[11px] text-muted-foreground">
{{ formKind === 'local' ? '目标(服务器视角)' : '目标(回本机)' }}地址 : 端口
</Label>
<div class="flex gap-1">
<Input v-model="formTargetHost" class="h-8 text-xs font-mono flex-1" />
<Input v-model="formTargetPort" placeholder="端口" class="h-8 text-xs font-mono w-[88px]" />
</div>
</div>
</div>
<div class="flex justify-end">
<Button size="sm" class="h-7 gap-1 text-xs" :disabled="busy" @click="submitAdd">
<Plus class="size-3.5" />{{ busy ? '建立中…' : '建立转发' }}
</Button>
</div>
</div>
</DialogContent>
</Dialog>
</template>
@@ -0,0 +1,443 @@
<script setup lang="ts">
/**
* 命令历史面板(浮层)。
*
* # 交互模型:搜索即过滤、单击填入、双击执行
*
* 历史与片段不同:片段是「我准备好要用的」,历史是「我已经用过的」。
* 后者的使用模式是**快速找回**,因此搜索框默认聚焦、输入即过滤、
* 键盘上下键可直接选中。
*
* 单击 = 填入命令行(不执行),双击或 `Enter` = 填入并执行。
* 这个区分的必要性在于:历史里躺着用户过去敲过的所有命令,包括
* `rm -rf`、`DROP TABLE`。默认执行会让「翻历史」变成一件危险的事。
*
* # 为什么「只显示当前会话来源」不做默认
*
* 有人按主机筛选(「那台机器上我跑过什么」),也有人跨主机找同一条命令
* (「上次那条 rsync 参数是怎么写的」)。默认全量 + 可选筛选比反向合理 ——
* 前者只需点一下筛选,后者要清空筛选才能看到全部。
*/
import { computed, onBeforeUnmount, onMounted, ref, watch } from 'vue'
import {
ArrowDownToLine,
Check,
Clock,
Copy,
FolderOpen,
History,
Loader2,
Play,
Search,
Star,
Trash2,
X
} from '@lucide/vue'
import { toast } from 'vue-sonner'
import { useTerminalStore } from '@/stores/terminalStore'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'
import type { CommandHistoryItem, SessionInfo } from '@/types/terminal'
const props = defineProps<{
sessionId: string | null
session: SessionInfo | undefined
}>()
const emit = defineEmits<{
(e: 'close'): void
}>()
const store = useTerminalStore()
// ===== 筛选状态 =====
const keyword = ref('')
const hostFilter = ref('')
const favoritedOnly = ref(false)
/** 选中项(用于键盘导航与详情) */
const selectedId = ref<number | null>(null)
const items = computed(() => store.historyPage.items)
const total = computed(() => store.historyPage.total)
/** 当前会话的来源 id(用于「只看本会话」快捷筛选) */
const currentHostId = computed(() => props.session?.targetId ?? '')
/**
* 加载历史。
*
* `force` 为 false 时不重复请求(浮层首次打开才拉,其余靠筛选变化触发)——
* 浮层每次开关都重拉会让「刚删掉的记录因为重拉又出现」这种错觉出现,
* 而实际是删成功了、只是列表被刷新回旧快照(请求早于删除返回)。
*/
async function reload(force = false) {
try {
await store.loadHistory({
keyword: keyword.value,
hostId: hostFilter.value,
favoritedOnly: favoritedOnly.value
})
if (force) await store.loadHistorySources()
} catch (e) {
toast.error(`加载历史失败:${String(e)}`)
}
}
onMounted(async () => {
await reload(true)
})
// 筛选变化即重查。搜索框用 200ms 防抖:输入过程中每个字符都发请求
// 会让 IPC 通道被无效查询占满(store 里已有请求序号防乱序,但少发总比多发好)。
let searchTimer: ReturnType<typeof setTimeout> | null = null
watch([keyword, favoritedOnly], () => {
if (searchTimer) clearTimeout(searchTimer)
searchTimer = setTimeout(() => void reload(), 200)
})
// 来源筛选是离散选择,无需防抖
watch(hostFilter, () => void reload())
// 卸载时清掉未触发的防抖:面板关掉后定时器仍会发一次无主查询
onBeforeUnmount(() => {
if (searchTimer) clearTimeout(searchTimer)
})
// ===== 操作 =====
/** 把命令填入会话命令行(不执行) */
async function useCommand(item: CommandHistoryItem, submit = false) {
if (!props.sessionId) {
toast.info('当前没有活跃会话')
return
}
try {
const r = await store.runHistory(props.sessionId, item.command, submit)
if (r.ok) {
// 填入成功后关闭浮层:用户的下一步是看命令行并按回车,
// 浮层挡在那里没有价值
if (!submit) emit('close')
else toast.success(r.message)
} else {
toast.error(r.message)
}
} catch (e) {
toast.error(`操作失败:${String(e)}`)
}
}
async function copyCommand(item: CommandHistoryItem) {
try {
await navigator.clipboard.writeText(item.command)
toast.success('已复制到剪贴板')
} catch (e) {
toast.error(`复制失败:${String(e)}`)
}
}
async function toggleFavorite(item: CommandHistoryItem) {
try {
await store.toggleHistoryFavorite(item.id)
} catch (e) {
toast.error(`操作失败:${String(e)}`)
}
}
async function removeItem(item: CommandHistoryItem) {
try {
const r = await store.deleteHistory(item.id)
if (!r.ok) toast.info(r.message)
if (selectedId.value === item.id) selectedId.value = null
} catch (e) {
toast.error(`删除失败:${String(e)}`)
}
}
async function clearAll() {
// 二次确认,且默认只清非收藏 —— 破坏性操作的默认值应当是最保守的那个。
// 用 window.confirm 而不是弹 Dialog:这是浮层里的浮层,
// 嵌一个 Radix Dialog 会带来焦点陷阱与层级(z-index)的两难。
const ok = window.confirm(
'确定清空命令历史吗?\n\n收藏的记录会保留(如需连同收藏一起清空,请先取消收藏)。'
)
if (!ok) return
try {
const r = await store.clearHistory(true)
toast.success(r.message)
} catch (e) {
toast.error(`清空失败:${String(e)}`)
}
}
// ===== 键盘导航 =====
/**
* 上下键移动选中项,Enter 执行。
*
* 只在列表为空时不处理;其余一律 `preventDefault` —— 否则方向键会
* 同时滚动容器,选中项移出可视区。
*/
function onKeydown(e: KeyboardEvent) {
if (e.key === 'Escape') {
emit('close')
return
}
if (items.value.length === 0) return
const idx = items.value.findIndex(i => i.id === selectedId.value)
if (e.key === 'ArrowDown') {
e.preventDefault()
const next = idx < 0 ? 0 : Math.min(items.value.length - 1, idx + 1)
selectedId.value = items.value[next].id
} else if (e.key === 'ArrowUp') {
e.preventDefault()
const next = idx <= 0 ? 0 : idx - 1
selectedId.value = items.value[next].id
} else if (e.key === 'Enter') {
e.preventDefault()
const item = items.value.find(i => i.id === selectedId.value)
if (item) void useCommand(item, false)
}
}
// ===== 展示辅助 =====
/** 相对时间(历史列表里「3 分钟前」比精确时间戳更有信息量) */
function relTime(ts: number): string {
const diff = Date.now() - ts
if (diff < 60_000) return '刚刚'
if (diff < 3_600_000) return `${Math.floor(diff / 60_000)} 分钟前`
if (diff < 86_400_000) return `${Math.floor(diff / 3_600_000)} 小时前`
if (diff < 2_592_000_000) return `${Math.floor(diff / 86_400_000)} 天前`
return new Date(ts).toLocaleDateString('zh-CN')
}
/**
* 目录缩略:只显示最后一级。
*
* 完整路径会占满一行且把命令挤到看不见的位置,而用户分辨「在哪个项目里跑的」
* 只需要最后一级。完整路径放在 `title` 里悬停可看。
*/
function cwdTail(cwd: string): string {
if (!cwd) return ''
const parts = cwd.split(/[\\/]/).filter(Boolean)
return parts.length > 0 ? parts[parts.length - 1] : cwd
}
/** 退出码非 0 时给视觉提示(用户找的常常正是「刚才那条报错的命令」) */
function isFailed(item: CommandHistoryItem): boolean {
return item.exitCode !== null && item.exitCode !== 0
}
</script>
<template>
<!-- 作为模块 Tab 内容渲染根不再是居中对话框 -->
<div
class="h-full flex flex-col rounded-lg border border-border bg-background overflow-hidden"
@keydown="onKeydown"
>
<!-- ===== 头部搜索 + 筛选 ===== -->
<div class="shrink-0 border-b border-border">
<div class="flex items-center gap-2 px-3 h-11">
<History class="size-4 text-muted-foreground shrink-0" />
<span class="text-sm font-medium shrink-0">命令历史</span>
<span class="text-xs text-muted-foreground shrink-0">
{{ total }} {{ hostFilter || favoritedOnly || keyword ? '(已筛选)' : '' }}
</span>
<div class="flex-1" />
<div class="relative">
<Search class="size-3.5 absolute left-2 top-1/2 -translate-y-1/2 text-muted-foreground" />
<Input
v-model="keyword"
placeholder="搜索命令…"
class="h-7 w-[240px] pl-7 text-xs"
autofocus
/>
</div>
<Button
variant="ghost"
size="sm"
class="h-7 text-xs shrink-0"
title="清空历史(保留收藏)"
@click="clearAll"
>
<Trash2 class="size-3.5" />
</Button>
<Button variant="ghost" size="sm" class="h-7 text-xs shrink-0" title="关闭" @click="emit('close')">
<X class="size-3.5" />
</Button>
</div>
<!-- 筛选行 -->
<div class="flex items-center gap-2 px-3 pb-2 text-xs">
<button
class="h-6 px-2 rounded border transition-colors"
:class="hostFilter === '' && !favoritedOnly
? 'border-primary/50 bg-primary/10 text-foreground'
: 'border-border text-muted-foreground hover:bg-accent'"
@click="hostFilter = ''; favoritedOnly = false"
>
全部来源
</button>
<button
v-if="currentHostId"
class="h-6 px-2 rounded border transition-colors"
:class="hostFilter === currentHostId
? 'border-primary/50 bg-primary/10 text-foreground'
: 'border-border text-muted-foreground hover:bg-accent'"
:title="`只看本会话(${store.sessionLabel(session)}`"
@click="hostFilter = currentHostId; favoritedOnly = false"
>
仅本会话
</button>
<button
class="h-6 px-2 rounded border transition-colors inline-flex items-center gap-1"
:class="favoritedOnly
? 'border-primary/50 bg-primary/10 text-foreground'
: 'border-border text-muted-foreground hover:bg-accent'"
@click="favoritedOnly = !favoritedOnly"
>
<Star class="size-3" /> 收藏
</button>
<!-- 其他来源只列有历史的避免显示一堆空来源 -->
<div class="flex-1" />
<select
v-if="store.historySources.length > 1"
:value="hostFilter"
class="h-6 px-1 rounded border border-border bg-transparent text-xs max-w-[200px]"
@change="hostFilter = ($event.target as HTMLSelectElement).value"
>
<option value="">按来源筛选</option>
<option v-for="s in store.historySources" :key="s.hostId" :value="s.hostId">
{{ s.hostName }}{{ s.count }}
</option>
</select>
</div>
</div>
<!-- ===== 列表 ===== -->
<div class="flex-1 min-h-0 overflow-y-auto">
<div v-if="store.historyLoading && items.length === 0" class="flex items-center justify-center h-full">
<Loader2 class="size-5 animate-spin text-muted-foreground" />
</div>
<div v-else-if="items.length === 0" class="flex flex-col items-center justify-center h-full gap-2 text-muted-foreground">
<History class="size-8 opacity-40" />
<span class="text-sm">
{{ keyword || hostFilter || favoritedOnly ? '没有匹配的命令' : '还没有命令历史' }}
</span>
<span v-if="!(keyword || hostFilter || favoritedOnly)" class="text-xs opacity-70 max-w-[320px] text-center">
命令由 shell 集成 hook 上报新开的会话执行命令后即可在此查看
</span>
</div>
<div v-else class="divide-y divide-border/60">
<div
v-for="item in items"
:key="item.id"
class="group flex items-start gap-2 px-3 py-2 cursor-pointer transition-colors"
:class="selectedId === item.id ? 'bg-accent' : 'hover:bg-accent/50'"
@click="selectedId = item.id"
@dblclick="useCommand(item, false)"
>
<!-- 收藏 -->
<button
class="shrink-0 mt-0.5 size-4 flex items-center justify-center transition-colors"
:class="item.favorited ? 'text-amber-500' : 'text-muted-foreground/40 hover:text-amber-500'"
:title="item.favorited ? '取消收藏' : '收藏(不参与容量淘汰)'"
@click.stop="toggleFavorite(item)"
>
<Star class="size-3.5" :fill="item.favorited ? 'currentColor' : 'none'" />
</button>
<!-- 主体 -->
<div class="flex-1 min-w-0">
<div class="flex items-center gap-2">
<code
class="text-xs font-mono truncate"
:class="isFailed(item) ? 'text-red-600 dark:text-red-400' : 'text-foreground'"
:title="item.command"
>
{{ item.command }}
</code>
<!-- 执行次数>1 说明是反复用到的命令值得优先看 -->
<span
v-if="item.count > 1"
class="shrink-0 text-[10px] px-1 rounded bg-muted text-muted-foreground"
:title="`执行过 ${item.count} 次`"
>
×{{ item.count }}
</span>
</div>
<div class="flex items-center gap-3 mt-0.5 text-[10px] text-muted-foreground">
<span class="inline-flex items-center gap-0.5 shrink-0">
<Clock class="size-2.5" />{{ relTime(item.ts) }}
</span>
<span v-if="item.cwd" class="inline-flex items-center gap-0.5 min-w-0" :title="item.cwd">
<FolderOpen class="size-2.5 shrink-0" />
<span class="truncate max-w-[140px]">{{ cwdTail(item.cwd) }}</span>
</span>
<span class="truncate max-w-[180px]">{{ item.hostName }}</span>
<span v-if="isFailed(item)" class="text-red-600 dark:text-red-400 shrink-0">
退出码 {{ item.exitCode }}
</span>
</div>
</div>
<!-- 行操作悬停出现避免列表视觉噪音 -->
<div class="shrink-0 flex items-center gap-0.5 opacity-0 group-hover:opacity-100 transition-opacity">
<button
class="size-6 rounded flex items-center justify-center text-muted-foreground hover:bg-accent hover:text-foreground"
title="填入命令行(不执行)"
@click.stop="useCommand(item, false)"
>
<ArrowDownToLine class="size-3.5" />
</button>
<button
class="size-6 rounded flex items-center justify-center text-muted-foreground hover:bg-accent hover:text-foreground"
title="填入并执行"
@click.stop="useCommand(item, true)"
>
<Play class="size-3.5" />
</button>
<button
class="size-6 rounded flex items-center justify-center text-muted-foreground hover:bg-accent hover:text-foreground"
title="复制"
@click.stop="copyCommand(item)"
>
<Copy class="size-3.5" />
</button>
<button
class="size-6 rounded flex items-center justify-center text-muted-foreground hover:bg-accent hover:text-red-600"
title="删除这条"
@click.stop="removeItem(item)"
>
<Trash2 class="size-3.5" />
</button>
</div>
</div>
</div>
</div>
<!-- ===== 底部提示 ===== -->
<div class="shrink-0 h-7 flex items-center gap-4 px-3 border-t border-border text-[10px] text-muted-foreground">
<span class="inline-flex items-center gap-1">
<ArrowDownToLine class="size-3" /> 单击 / Enter = 填入
</span>
<span class="inline-flex items-center gap-1">
<Play class="size-3" /> 双击 = 填入并执行
</span>
<span class="inline-flex items-center gap-1">
<Check class="size-3" /> /下键导航Esc 关闭
</span>
<div class="flex-1" />
<span v-if="total > items.length">显示 {{ items.length }} / {{ total }} </span>
</div>
</div>
</template>
@@ -0,0 +1,202 @@
<script setup lang="ts">
/**
* SSH 主机密钥确认对话框。
*
* # 这是模块里安全权重最高的 UI
*
* 它在 **MITM 攻击**的防线正中间:若用户被诱导接受了攻击者的主机密钥,
* 之后所有流量(含密码、私钥操作)都会被中间人解开。因此这里做了三件事:
*
* 1. **首次连接与指纹变更走完全不同的视觉与文案**。前者是中性确认
* (只提示「这是第一次连接」),后者是红色阻断(坚持要求用户去核对指纹)。
* 若两者长得一样,用户会养成「无脑点确定」的习惯,防线形同虚设。
*
* 2. **把指纹放在最大字号、等宽字体、可选中**的位置。用户需要用
* `ssh-keyscan | ssh-keygen -lf -` 在别处核对,所以必须能复制。
*
* 3. **不提供「记住并继续」以外的快捷操作**(如「本次接受」)。
* 只有「接受并记录」与「取消」两个选项——模糊的中间选项会让用户
* 在不理解后果的情况下点下去。
*/
import { computed, ref, watch } from 'vue'
import { Copy, Check, ShieldAlert, ShieldCheck } from '@lucide/vue'
import { useTerminalStore } from '@/stores/terminalStore'
import {
Dialog,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogTitle
} from '@/components/ui/dialog'
import { Button } from '@/components/ui/button'
import { createLogger } from '@/lib/logger'
const logger = createLogger('terminal')
const store = useTerminalStore()
const open = computed({
get: () => store.hostKeyPrompt !== null,
set: v => {
if (!v) void store.confirmHostKey(false)
}
})
const prompt = computed(() => store.hostKeyPrompt)
/** 「与记录不符」= 高危,需要红色阻断式呈现 */
const isChanged = computed(() => prompt.value?.reason === 'changed')
const copied = ref(false)
/** 变更场景下强制用户勾选「我已核对」才允许继续 —— 防手滑 */
const acknowledged = ref(false)
// 每次弹出新请求时重置勾选状态,避免上一次的勾选被继承(那会导致误接受)
watch(
() => prompt.value?.sessionId,
() => {
acknowledged.value = false
copied.value = false
}
)
async function copyFingerprint() {
const fp = prompt.value?.fingerprint
if (!fp) return
try {
await navigator.clipboard.writeText(fp)
copied.value = true
setTimeout(() => (copied.value = false), 1500)
} catch (e) {
logger.warn(`复制指纹失败:${String(e)}`)
}
}
function accept() {
void store.confirmHostKey(true)
}
function reject() {
void store.confirmHostKey(false)
}
const canAccept = computed(() => !isChanged.value || acknowledged.value)
</script>
<template>
<Dialog v-model:open="open">
<!-- 不显示右上角关闭按钮这个决定必须通过底部的显式选择做出
X 走的是关闭 = 拒绝但用户会以为只是收起对话框 -->
<DialogContent class="max-w-lg" :show-close-button="false">
<DialogHeader>
<div class="flex items-center gap-2.5">
<div
class="size-9 rounded-full flex items-center justify-center shrink-0"
:class="
isChanged
? 'bg-red-500/15 text-red-600 dark:text-red-400'
: 'bg-primary/15 text-primary'
"
>
<ShieldAlert v-if="isChanged" class="size-5" />
<ShieldCheck v-else class="size-5" />
</div>
<div class="min-w-0">
<DialogTitle class="text-base">
{{ isChanged ? '主机密钥已变更' : '首次连接此主机' }}
</DialogTitle>
<DialogDescription class="text-xs">
{{ prompt?.host }}<span v-if="prompt && prompt.port !== 22">:{{ prompt.port }}</span>
</DialogDescription>
</div>
</div>
</DialogHeader>
<!-- 高危警告指纹变更几乎只有两种可能 服务器重装或有人在中间 -->
<div
v-if="isChanged"
class="rounded-md border border-red-500/40 bg-red-500/10 px-3 py-2.5 text-xs leading-relaxed text-red-700 dark:text-red-300"
>
<p class="font-medium mb-1">这可能意味着有人在窃听你的连接</p>
<p>
服务器的主机密钥与之前记录的不一致常见原因是服务器重装或更换了密钥
但也可能是中间人攻击请通过其他可信渠道如服务器管理后台
核对下方指纹后再决定
</p>
</div>
<div v-else class="rounded-md border border-border bg-muted/40 px-3 py-2.5 text-xs leading-relaxed text-muted-foreground">
这是你第一次连接这台主机接受后密钥指纹会被记录之后若发生变化会再次警告
</div>
<!-- 指纹对比区 -->
<div class="space-y-2">
<div v-if="isChanged && prompt?.previousFingerprint">
<div class="text-[10px] font-medium text-muted-foreground mb-1 uppercase tracking-wide">
已记录的指纹
</div>
<div
class="px-2.5 py-1.5 rounded bg-muted font-mono text-[11px] break-all line-through opacity-70"
>
{{ prompt.previousFingerprint }}
</div>
</div>
<div>
<div class="text-[10px] font-medium text-muted-foreground mb-1 uppercase tracking-wide">
服务器出示的指纹{{ prompt?.keyType }}
</div>
<div class="flex items-start gap-2">
<div
class="flex-1 px-2.5 py-2 rounded font-mono text-[12px] break-all select-all leading-relaxed"
:class="
isChanged
? 'bg-red-500/10 border border-red-500/30'
: 'bg-muted border border-border'
"
>
{{ prompt?.fingerprint }}
</div>
<Button
variant="outline"
size="icon"
class="size-8 shrink-0"
:title="copied ? '已复制' : '复制指纹'"
@click="copyFingerprint"
>
<Check v-if="copied" class="size-3.5 text-emerald-500" />
<Copy v-else class="size-3.5" />
</Button>
</div>
</div>
</div>
<!-- 变更场景的强制确认 -->
<label
v-if="isChanged"
class="flex items-start gap-2 cursor-pointer select-none rounded-md px-1 py-1
hover:bg-accent/40 transition-colors"
>
<input
v-model="acknowledged"
type="checkbox"
class="mt-0.5 size-3.5 rounded border-border accent-red-500 cursor-pointer"
/>
<span class="text-xs leading-relaxed">
我已在其他可信渠道核对了上述指纹确认一致
</span>
</label>
<DialogFooter class="gap-2">
<Button variant="outline" size="sm" @click="reject">取消连接</Button>
<Button
size="sm"
:variant="isChanged ? 'destructive' : 'default'"
:disabled="!canAccept"
@click="accept"
>
{{ isChanged ? '仍然接受并更新记录' : '接受并记录' }}
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
</template>
@@ -0,0 +1,671 @@
<script setup lang="ts">
/**
* SSH 主机管理。
*
* # 两个刻意的取舍
*
* 1. **密码与配置分开保存**。配置走 `terminal_save_host`(落 settings.json),
* 密码走 `terminal_set_host_password`(落系统凭据管理器)。看似麻烦,
* 但这是唯一能保证「密码永不明文落盘」的路子——合并成一个保存动作时,
* 前端必须把密码回传给后端,而那个 payload 会经过 IPC、可能进日志。
*
* 2. **新建时先向要一个 id**。密码按 hostId 存取,若等 save_host 之后再生成 id
* 用户在新建对话框里填的密码就没有归属。因此用 `terminal_new_host_id`
* 预取 id,使「新建」与「编辑」走完全相同的流程。
*/
import { computed, ref, watch } from 'vue'
import { open as openDialog, save as saveDialog } from '@tauri-apps/plugin-dialog'
import {
ArrowDown,
ArrowUp,
Download,
Eye,
EyeOff,
Globe,
KeyRound,
Loader2,
Pencil,
Plus,
Star,
Trash2,
Upload
} from '@lucide/vue'
import { toast } from 'vue-sonner'
import { useTerminalStore } from '@/stores/terminalStore'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'
import { Label } from '@/components/ui/label'
import { Switch } from '@/components/ui/switch'
import {
Dialog,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogTitle
} from '@/components/ui/dialog'
import {
Select,
SelectContent,
SelectItem,
SelectTrigger,
SelectValue
} from '@/components/ui/select'
import { createLogger } from '@/lib/logger'
import { blankHost, type SshHost } from './hostForm'
import type { HostView } from '@/types/terminal'
const logger = createLogger('terminal')
const store = useTerminalStore()
const emit = defineEmits<{ (e: 'close'): void; (e: 'connect', hostId: string): void }>()
// ===== 编辑对话框 =====
const dialogOpen = ref(false)
const editing = ref<SshHost | null>(null)
/** 编辑中的密码(空串 = 不修改;新建时为用户输入的初值) */
const password = ref('')
const showPassword = ref(false)
const saving = ref(false)
const isNew = ref(false)
/** 表单校验错误(按字段) */
const errors = ref<Record<string, string>>({})
function validate(h: SshHost): boolean {
const e: Record<string, string> = {}
if (!h.name.trim()) e.name = '请填写显示名称'
if (!h.host.trim()) e.host = '请填写主机地址'
else if (/\s/.test(h.host.trim())) e.host = '主机地址不能包含空格'
if (!h.username.trim()) e.username = '请填写登录用户名'
if (h.port < 1 || h.port > 65535) e.port = '端口需在 165535 之间'
if (h.authMethod === 'key' && !h.keyId) e.keyId = '请选择用于认证的密钥'
// 跳板链:与后端 validate_jump_refs 的规则保持一致(不自引用、不成环)
if (h.jumpIds.some(id => id === h.id)) e.jumpIds = '跳板链不能包含主机自身'
else if (new Set(h.jumpIds).size !== h.jumpIds.length) e.jumpIds = '跳板链中有重复项'
errors.value = e
return Object.keys(e).length === 0
}
async function openNew() {
try {
const id = await store.newHostId()
editing.value = blankHost(id)
isNew.value = true
password.value = ''
errors.value = {}
dialogOpen.value = true
} catch (e) {
toast.error(`生成主机 ID 失败:${String(e)}`)
}
}
function openEdit(hostId: string) {
const v = store.hosts.find(h => h.config.id === hostId)
if (!v) return
// 深拷贝:取消时不能污染 store 中的原对象
editing.value = JSON.parse(JSON.stringify(v.config)) as SshHost
isNew.value = false
// 已有密码时留空表示「不修改」,避免用户误以为要重新输入
password.value = ''
errors.value = {}
dialogOpen.value = true
}
/** 下拉选择密钥时,把 SSH 认证方式自动切到 key(用户选了密钥却还用密码认证是矛盾的) */
watch(
() => editing.value?.keyId,
v => {
if (v && editing.value && editing.value.authMethod !== 'key') {
editing.value.authMethod = 'key'
}
}
)
async function save() {
const h = editing.value
if (!h || !validate(h)) return
saving.value = true
try {
await store.saveHost(h)
// 密码单独保存:仅当用户实际输入了内容
if (password.value) {
const r = await store.setHostPassword(h.id, password.value)
if (!r.ok) {
toast.warning(`主机已保存,但密码未能写入凭据管理器:${r.message}`)
} else {
toast.success(isNew.value ? '主机已添加' : '主机已更新')
}
} else {
toast.success(isNew.value ? '主机已添加' : '主机已更新')
}
dialogOpen.value = false
} catch (e) {
logger.error(`保存主机失败:${String(e)}`)
toast.error(`保存失败:${String(e)}`)
} finally {
saving.value = false
}
}
async function remove(v: HostView) {
const ok = await confirmRemove(v)
if (!ok) return
try {
await store.deleteHost(v.config.id)
toast.success(`已删除主机「${v.config.name || v.config.host}`)
} catch (e) {
toast.error(`删除失败:${String(e)}`)
}
}
/** 删除确认(用简单的模态状态而非 window.confirm:后者在 WebView 里样式不可控) */
const pendingRemove = ref<HostView | null>(null)
function confirmRemove(v: HostView): Promise<boolean> {
return new Promise(resolve => {
pendingRemove.value = v
removeResolve = resolve
})
}
let removeResolve: ((ok: boolean) => void) | null = null
function resolveRemove(ok: boolean) {
removeResolve?.(ok)
removeResolve = null
pendingRemove.value = null
}
async function importConfig() {
try {
const r = await store.importSshConfig()
if (r.ok) toast.success(r.message)
else toast.error(r.message)
} catch (e) {
toast.error(`导入失败:${String(e)}`)
}
}
/**
* 导出主机配置(JSON,不含密码与私钥)。
*
* 路径交给系统保存对话框(前端选路径、后端写内容——与其他文件
* 写出操作的分工一致)。导出提示里明确说「密码不在备份内」,
* 避免用户以为换机后不用重填凭据。
*/
async function exportHosts() {
try {
const stamp = new Date().toISOString().slice(0, 10)
const path = await saveDialog({
title: '导出主机配置',
defaultPath: `terminal-hosts-${stamp}.json`,
filters: [{ name: 'JSON', extensions: ['json'] }]
})
if (typeof path !== 'string') return
const r = await store.exportHosts(path)
if (r.ok) toast.success(r.message)
else toast.warning(r.message)
} catch (e) {
toast.error(`导出失败:${String(e)}`)
}
}
/** 从 JSON 备份导入主机(自动重编 id、重写跳板链、去重) */
async function importHosts() {
try {
const picked = await openDialog({
multiple: false,
directory: false,
filters: [{ name: '主机备份', extensions: ['json'] }]
})
if (typeof picked !== 'string') return
const r = await store.importHosts(picked)
if (r.ok) toast.success(r.message)
else toast.warning(r.message)
} catch (e) {
toast.error(`导入失败:${String(e)}`)
}
}
async function toggleFavorite(v: HostView) {
try {
await store.saveHost({ ...v.config, favorited: !v.config.favorited })
} catch (e) {
toast.error(`更新收藏状态失败:${String(e)}`)
}
}
/** 可用密钥(供认证方式下拉使用) */
const availableKeys = computed(() => store.keys.filter(k => k.fileExists))
// ===== 跳板机链(ProxyJump=====
/**
* 跳板候选:除正在编辑的主机外的全部主机。
*
* 候选直接复用既有主机条目(地址+账号+凭据),而不是让用户在表单里
* 重新抄一遍跳板机的地址密码 —— 后者会造成同一台跳板机多份凭据副本,
* 改密码时漏改一处就是连接事故(与后端 `jump_ids` 的设计注释一致)。
*/
const hopCandidates = computed(() =>
store.hosts.filter(v => v.config.id !== editing.value?.id)
)
function hostLabel(id: string): string {
const v = store.hosts.find(x => x.config.id === id)
if (!v) return '(已删除的主机)'
return `${v.config.name || v.config.host}${v.config.username}@${v.config.host}`
}
function addHop() {
if (!editing.value) return
// 默认选第一个还没被用掉的候选,省一次点击
const used = new Set(editing.value.jumpIds)
const next = hopCandidates.value.find(v => !used.has(v.config.id))
if (!next) return
editing.value.jumpIds.push(next.config.id)
}
function removeHop(i: number) {
editing.value?.jumpIds.splice(i, 1)
}
/** 上移/下移:链的顺序就是连接顺序,靠前的先连 */
function moveHop(i: number, dir: -1 | 1) {
const arr = editing.value?.jumpIds
if (!arr) return
const j = i + dir
if (j < 0 || j >= arr.length) return
;[arr[i], arr[j]] = [arr[j], arr[i]]
}
</script>
<template>
<div class="flex flex-col h-full">
<!-- 头部 -->
<div class="shrink-0 flex items-center gap-2 px-4 h-12 border-b border-border">
<Globe class="size-4 text-muted-foreground" />
<h3 class="text-sm font-medium">SSH 主机</h3>
<span class="text-xs text-muted-foreground">({{ store.hosts.length }})</span>
<div class="flex-1" />
<Button variant="outline" size="sm" class="h-7 gap-1.5 text-xs" @click="importHosts">
<Upload class="size-3.5" />导入备份
</Button>
<Button variant="outline" size="sm" class="h-7 gap-1.5 text-xs" @click="exportHosts">
<Download class="size-3.5" />导出
</Button>
<Button variant="outline" size="sm" class="h-7 gap-1.5 text-xs" @click="importConfig">
<Download class="size-3.5" />导入 ~/.ssh/config
</Button>
<Button size="sm" class="h-7 gap-1.5 text-xs" @click="openNew">
<Plus class="size-3.5" />新建主机
</Button>
</div>
<!-- 列表 -->
<div class="flex-1 min-h-0 overflow-y-auto p-3">
<div v-if="store.hosts.length === 0" class="py-16 text-center">
<Globe class="size-8 mx-auto text-muted-foreground/30 mb-3" />
<p class="text-sm text-muted-foreground mb-1">还没有配置 SSH 主机</p>
<p class="text-xs text-muted-foreground/70 mb-4">
可以手工新建也可以直接从 <code class="px-1 rounded bg-muted">~/.ssh/config</code>
</p>
<div class="flex items-center justify-center gap-2">
<Button size="sm" class="gap-1.5" @click="openNew">
<Plus class="size-3.5" />新建主机
</Button>
<Button variant="outline" size="sm" class="gap-1.5" @click="importConfig">
<Download class="size-3.5" />导入配置
</Button>
</div>
</div>
<div v-else class="space-y-1">
<div
v-for="v in store.hosts"
:key="v.config.id"
class="group flex items-center gap-3 px-3 py-2 rounded-md border border-border
hover:border-primary/40 hover:bg-accent/30 transition-colors"
>
<button
class="shrink-0 size-6 rounded flex items-center justify-center transition-colors"
:class="
v.config.favorited
? 'text-amber-500'
: 'text-muted-foreground/30 hover:text-amber-500'
"
:title="v.config.favorited ? '取消收藏' : '收藏'"
@click="toggleFavorite(v)"
>
<Star class="size-3.5" :class="{ 'fill-current': v.config.favorited }" />
</button>
<div class="min-w-0 flex-1">
<div class="flex items-center gap-2">
<span class="text-sm font-medium truncate">
{{ v.config.name || v.config.host }}
</span>
<span v-if="v.config.group" class="text-[10px] px-1.5 py-0.5 rounded bg-muted shrink-0">
{{ v.config.group }}
</span>
<!-- 不可连接时给出明确原因而不是让用户点下去才发现失败 -->
<span
v-if="!v.ready"
class="text-[10px] px-1.5 py-0.5 rounded bg-amber-500/15 text-amber-600 dark:text-amber-400 shrink-0"
:title="v.issue ?? ''"
>
{{ v.issue || '配置不完整' }}
</span>
</div>
<div class="text-xs text-muted-foreground truncate mt-0.5">
{{ v.config.username }}@{{ v.config.host
}}<span v-if="v.config.port !== 22">:{{ v.config.port }}</span>
<span class="mx-1.5">·</span>
<span v-if="v.config.authMethod === 'key' && v.config.keyId">
<KeyRound class="inline size-2.5 -mt-0.5" />
{{ store.keys.find(k => k.meta.id === v.config.keyId)?.meta.name ?? '密钥' }}
</span>
<span v-else-if="v.config.authMethod === 'password'">
<!-- 不回显掩码密码不是 API key保留前 3 4 也是在泄露真实内容
是否已保存由 hasPassword 表达明文/掩码一律不出现在列表 -->
{{ v.hasPassword ? '密码已保存' : '密码未保存' }}
</span>
<span v-else>{{ v.config.authMethod }}</span>
</div>
</div>
<div class="shrink-0 flex items-center gap-1 opacity-0 group-hover:opacity-100 transition-opacity">
<Button
size="sm"
class="h-7 text-xs"
:disabled="!v.ready"
:title="v.ready ? '连接' : (v.issue ?? '')"
@click="emit('connect', v.config.id)"
>
连接
</Button>
<Button variant="ghost" size="icon" class="size-7" title="编辑" @click="openEdit(v.config.id)">
<Pencil class="size-3.5" />
</Button>
<Button
variant="ghost"
size="icon"
class="size-7 text-destructive hover:text-destructive"
title="删除"
@click="remove(v)"
>
<Trash2 class="size-3.5" />
</Button>
</div>
</div>
</div>
</div>
<!-- ===== 编辑对话框 ===== -->
<Dialog v-model:open="dialogOpen">
<DialogContent class="max-w-xl max-h-[85vh] overflow-y-auto">
<DialogHeader>
<DialogTitle>{{ isNew ? '新建 SSH 主机' : '编辑 SSH 主机' }}</DialogTitle>
<DialogDescription class="text-xs">
密码保存在系统凭据管理器中不会写入配置文件
</DialogDescription>
</DialogHeader>
<div v-if="editing" class="space-y-4">
<!-- 基本信息 -->
<div class="grid grid-cols-2 gap-3">
<div class="space-y-1.5">
<Label class="text-xs">显示名称</Label>
<Input v-model="editing.name" placeholder="生产服务器" class="h-8 text-sm" />
<p v-if="errors.name" class="text-[11px] text-destructive">{{ errors.name }}</p>
</div>
<div class="space-y-1.5">
<Label class="text-xs">分组</Label>
<Input v-model="editing.group" placeholder="工作 / 个人(留空为未分组)" class="h-8 text-sm" />
</div>
</div>
<div class="grid grid-cols-[1fr_100px] gap-3">
<div class="space-y-1.5">
<Label class="text-xs">主机地址</Label>
<Input
v-model="editing.host"
placeholder="192.168.1.10 或 example.com"
class="h-8 text-sm font-mono"
/>
<p v-if="errors.host" class="text-[11px] text-destructive">{{ errors.host }}</p>
</div>
<div class="space-y-1.5">
<Label class="text-xs">端口</Label>
<Input v-model.number="editing.port" type="number" class="h-8 text-sm font-mono" />
<p v-if="errors.port" class="text-[11px] text-destructive">{{ errors.port }}</p>
</div>
</div>
<div class="space-y-1.5">
<Label class="text-xs">登录用户名</Label>
<Input v-model="editing.username" placeholder="root" class="h-8 text-sm font-mono" />
<p v-if="errors.username" class="text-[11px] text-destructive">{{ errors.username }}</p>
</div>
<!-- 认证 -->
<div class="space-y-3 rounded-md border border-border p-3">
<div class="space-y-1.5">
<Label class="text-xs">认证方式</Label>
<Select v-model="editing.authMethod">
<SelectTrigger class="h-8 text-sm">
<SelectValue placeholder="选择认证方式" />
</SelectTrigger>
<SelectContent>
<SelectItem value="key">密钥认证推荐</SelectItem>
<SelectItem value="password">密码认证</SelectItem>
</SelectContent>
</Select>
</div>
<div v-if="editing.authMethod === 'key'" class="space-y-1.5">
<Label class="text-xs">使用密钥</Label>
<Select v-model="editing.keyId">
<SelectTrigger class="h-8 text-sm">
<SelectValue placeholder="选择密钥" />
</SelectTrigger>
<SelectContent>
<SelectItem v-for="k in availableKeys" :key="k.meta.id" :value="k.meta.id">
{{ k.meta.name }} · {{ k.meta.algorithm
}}{{ k.meta.bits ? ` ${k.meta.bits}` : '' }}
</SelectItem>
</SelectContent>
</Select>
<p v-if="errors.keyId" class="text-[11px] text-destructive">{{ errors.keyId }}</p>
<p v-if="availableKeys.length === 0" class="text-[11px] text-amber-600 dark:text-amber-400">
还没有可用密钥请先到密钥管理生成或导入
</p>
</div>
<div v-if="editing.authMethod === 'password'" class="space-y-1.5">
<Label class="text-xs">
密码
<span class="text-muted-foreground font-normal">留空表示不修改</span>
</Label>
<div class="relative">
<Input
v-model="password"
:type="showPassword ? 'text' : 'password'"
placeholder="写入系统凭据管理器"
class="h-8 text-sm pr-8"
/>
<button
class="absolute right-2 top-1/2 -translate-y-1/2 text-muted-foreground hover:text-foreground"
type="button"
@click="showPassword = !showPassword"
>
<Eye v-if="showPassword" class="size-3.5" />
<EyeOff v-else class="size-3.5" />
</button>
</div>
</div>
</div>
<!-- 高级 -->
<details class="rounded-md border border-border">
<summary class="px-3 py-2 text-xs cursor-pointer select-none hover:bg-accent/40">
高级选项
</summary>
<div class="px-3 pb-3 pt-1 space-y-3">
<div class="grid grid-cols-2 gap-3">
<div class="space-y-1.5">
<Label class="text-xs">连接超时毫秒</Label>
<Input v-model.number="editing.connectTimeoutMs" type="number" class="h-8 text-sm" />
</div>
<div class="space-y-1.5">
<Label class="text-xs">心跳间隔0 = 关闭</Label>
<Input v-model.number="editing.keepaliveSecs" type="number" class="h-8 text-sm" />
</div>
</div>
<div class="space-y-1.5">
<Label class="text-xs">登录后执行可选</Label>
<Input
v-model="editing.startupCommand"
placeholder="cd /var/log && ls -al"
class="h-8 text-sm font-mono"
/>
<p class="text-[11px] text-muted-foreground">
会在交互式 shell 建立后发送适合固定进入某目录
</p>
</div>
<div class="space-y-1.5">
<Label class="text-xs">远端工作目录可选</Label>
<Input v-model="editing.remoteCwd" placeholder="/home/user" class="h-8 text-sm font-mono" />
</div>
<div class="space-y-1.5">
<Label class="text-xs">远端编码</Label>
<Select v-model="editing.encoding">
<SelectTrigger class="h-8 text-sm">
<SelectValue />
</SelectTrigger>
<SelectContent>
<SelectItem value="utf-8">UTF-8默认</SelectItem>
<SelectItem value="gbk">GBK部分老系统中文环境</SelectItem>
</SelectContent>
</Select>
</div>
<!-- 跳板机链ProxyJump候选复用既有主机条目凭据跟着条目走 -->
<div class="space-y-1.5">
<div class="flex items-center justify-between">
<Label class="text-xs">跳板机链</Label>
<Button
variant="ghost"
size="sm"
class="h-6 gap-1 px-1.5 text-[11px] text-muted-foreground hover:text-foreground"
:disabled="hopCandidates.length === 0 || editing.jumpIds.length >= 5"
@click="addHop"
>
<Plus class="size-3" />添加跳板
</Button>
</div>
<p v-if="editing.jumpIds.length === 0" class="text-[11px] text-muted-foreground">
不经过跳板直连目标主机需要经堡垒机/跳板机中转时从这里添加
</p>
<div v-else class="space-y-1.5">
<div
v-for="(id, i) in editing.jumpIds"
:key="i"
class="flex items-center gap-1.5"
>
<span class="text-[11px] text-muted-foreground w-10 shrink-0">
{{ i + 1 }}
</span>
<Select v-model="editing.jumpIds[i]">
<SelectTrigger class="h-8 text-xs flex-1">
<SelectValue />
</SelectTrigger>
<SelectContent>
<SelectItem
v-for="v in hopCandidates"
:key="v.config.id"
:value="v.config.id"
>
{{ v.config.name || v.config.host }}{{ v.config.username }}@{{ v.config.host }}
</SelectItem>
<!-- 当前值对应的主机可能已被删除仍要能显示出来 -->
<SelectItem v-if="!hopCandidates.some(v => v.config.id === id)" :value="id">
{{ hostLabel(id) }}
</SelectItem>
</SelectContent>
</Select>
<Button
variant="ghost"
size="sm"
class="h-7 w-7 p-0"
:disabled="i === 0"
@click="moveHop(i, -1)"
>
<ArrowUp class="size-3.5" />
</Button>
<Button
variant="ghost"
size="sm"
class="h-7 w-7 p-0"
:disabled="i === editing.jumpIds.length - 1"
@click="moveHop(i, 1)"
>
<ArrowDown class="size-3.5" />
</Button>
<Button
variant="ghost"
size="sm"
class="h-7 w-7 p-0 text-destructive hover:text-destructive"
@click="removeHop(i)"
>
<Trash2 class="size-3.5" />
</Button>
</div>
<p class="text-[11px] text-muted-foreground">
连接方向本机 第1跳 目标主机每一跳使用对应主机条目里保存的账号与凭据
</p>
</div>
<p v-if="errors.jumpIds" class="text-[11px] text-destructive">{{ errors.jumpIds }}</p>
</div>
<div class="flex items-center justify-between">
<div>
<Label class="text-xs">收藏</Label>
<p class="text-[11px] text-muted-foreground">置顶显示在侧栏</p>
</div>
<Switch v-model="editing.favorited" />
</div>
</div>
</details>
</div>
<DialogFooter>
<Button variant="outline" size="sm" @click="dialogOpen = false">取消</Button>
<Button size="sm" :disabled="saving" @click="save">
<Loader2 v-if="saving" class="size-3.5 mr-1.5 animate-spin" />
{{ isNew ? '添加' : '保存' }}
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
<!-- ===== 删除确认 ===== -->
<Dialog :open="pendingRemove !== null" @update:open="v => !v && resolveRemove(false)">
<DialogContent class="max-w-sm" :show-close-button="false">
<DialogHeader>
<DialogTitle class="text-base">删除主机</DialogTitle>
<DialogDescription class="text-xs">
将删除{{ pendingRemove?.config.name || pendingRemove?.config.host }}的配置
与已保存的密码此操作不可撤销
</DialogDescription>
</DialogHeader>
<DialogFooter>
<Button variant="outline" size="sm" @click="resolveRemove(false)">取消</Button>
<Button variant="destructive" size="sm" @click="resolveRemove(true)">删除</Button>
</DialogFooter>
</DialogContent>
</Dialog>
</div>
</template>
@@ -0,0 +1,774 @@
<script setup lang="ts">
/**
* SSH 密钥管理
*
* # 三个刻意的取舍
*
* 1. **私钥内容永不回显**列表里只有元数据算法位数指纹公钥
* 私钥只在后端密钥目录里界面上没有任何查看私钥入口 这不是疏漏
* 而是有意为之一旦能把私钥显示到屏幕上它就会进入截图剪贴板
* 会话录制需要私钥时用户应该去密钥目录那是本机文件系统的事
*
* 2. **passphrase 修改而非查看** passphrase 需要先验证旧值
* 这保证了能改密码的人一定知道原密码 若允许无验证直接改
* 任何能碰到这个界面的人都能夺走密钥的使用权
*
* 3. **公钥一键复制**这是本面板最高频的动作用户生成密钥后要做的唯一
* 一件事就是把它贴到服务器的 `authorized_keys`为此在列表行上直接给
* 复制按钮而不是藏进详情页
*/
import { computed, ref } from 'vue'
import { open as openDialog } from '@tauri-apps/plugin-dialog'
import {
AlertTriangle,
Check,
ClipboardCopy,
Download,
FileKey,
FolderOpen,
KeyRound,
Loader2,
Lock,
Pencil,
Plus,
ShieldCheck,
Trash2,
Unlock
} from '@lucide/vue'
import { toast } from 'vue-sonner'
import { useTerminalStore } from '@/stores/terminalStore'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'
import { Label } from '@/components/ui/label'
import { Textarea } from '@/components/ui/textarea'
import {
Dialog,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogTitle
} from '@/components/ui/dialog'
import {
Select,
SelectContent,
SelectItem,
SelectTrigger,
SelectValue
} from '@/components/ui/select'
import { createLogger } from '@/lib/logger'
import type { KeyGenParams, KeyView } from '@/types/terminal'
const logger = createLogger('terminal')
const store = useTerminalStore()
// ===== =====
const genOpen = ref(false)
const genBusy = ref(false)
const genForm = ref<KeyGenParams>({
name: '',
algorithm: 'ed25519',
bits: 0,
comment: '',
passphrase: ''
})
const genErrors = ref<Record<string, string>>({})
/** 各算法的可选位数(ed25519 定长,无位数概念) */
const BIT_OPTIONS: Record<string, number[]> = {
rsa: [2048, 3072, 4096],
ecdsa: [256, 384, 521],
ed25519: []
}
const bitOptions = computed(() => BIT_OPTIONS[genForm.value.algorithm] ?? [])
/** 切换算法时把位数对齐到该算法的合法值,避免留下 RSA 4096 配 ed25519 这种无效组合 */
function onAlgorithmChange(algo: string) {
genForm.value.algorithm = algo
const opts = BIT_OPTIONS[algo] ?? []
genForm.value.bits = opts.length > 0 ? opts[0] : 0
}
function openGenerate() {
genForm.value = { name: '', algorithm: 'ed25519', bits: 0, comment: '', passphrase: '' }
genErrors.value = {}
genOpen.value = true
}
async function submitGenerate() {
const f = genForm.value
const e: Record<string, string> = {}
if (!f.name.trim()) e.name = '请填写密钥名称'
if (f.algorithm === 'rsa' && ![2048, 3072, 4096].includes(f.bits)) {
e.bits = 'RSA 位数需为 2048 / 3072 / 4096'
}
genErrors.value = e
if (Object.keys(e).length > 0) return
genBusy.value = true
try {
const [view, outcome] = await store.generateKey({ ...f, name: f.name.trim() })
if (outcome.ok) toast.success(outcome.message || `密钥「${view.meta.name}」已生成`)
else toast.warning(outcome.message)
genOpen.value = false
} catch (err) {
logger.error(`生成密钥失败:${String(err)}`)
toast.error(`生成失败:${String(err)}`)
} finally {
genBusy.value = false
}
}
// ===== =====
const importOpen = ref(false)
const importBusy = ref(false)
const importName = ref('')
const importContent = ref('')
const importPassphrase = ref('')
const importErrors = ref<Record<string, string>>({})
function openImport() {
importName.value = ''
importContent.value = ''
importPassphrase.value = ''
importErrors.value = {}
importOpen.value = true
}
/**
* 从本地文件读取私钥内容
*
* 读文件这件事交给**后端**`terminal_import_key` 已支持直接接收文件路径
* `keys.rs::import` 里的路径分支前端不碰文件系统
* 这样做既避开了 WebView 的本地文件读取限制也保证路径 内容
* 编码判断只有一处实现.ppk PEM 都是纯文本但第三方工具偶尔写出
* BOM 的文件后端统一处理更稳
*
* 选完文件后只把**路径**写进内容框由用户确认后再提交
* 不自动提交因为导入是写操作用户可能只是想看一眼选了哪个文件
*/
async function pickKeyFile() {
try {
const picked = await openDialog({
multiple: false,
directory: false,
filters: [
{ name: 'SSH 私钥', extensions: ['ppk', 'key', 'pem', 'openssh', 'priv', 'rsa', 'ed25519'] },
{ name: '全部文件', extensions: ['*'] }
]
})
if (typeof picked !== 'string') return
importContent.value = picked
//
if (!importName.value.trim()) {
importName.value = picked.replace(/\\/g, '/').split('/').pop()?.replace(/\.[^.]+$/, '') ?? ''
}
importErrors.value = {}
} catch (err) {
logger.error(`选择密钥文件失败:${String(err)}`)
toast.error(`选择文件失败:${String(err)}`)
}
}
async function submitImport() {
const e: Record<string, string> = {}
if (!importName.value.trim()) e.name = '请填写密钥名称'
const text = importContent.value
if (!text.trim()) e.content = '请粘贴私钥内容'
// `terminal/keys.rs::is_ppk` PPK
//
// SnippetPanel
else if (!text.includes('PRIVATE KEY') && !/^\s*PuTTY-User-Key-File-\d+:/m.test(text)) {
e.content = '内容看起来不是私钥(需为 OpenSSH 私钥或 PuTTY .ppk'
}
importErrors.value = e
if (Object.keys(e).length > 0) return
importBusy.value = true
try {
const [view, outcome] = await store.importKey(
importName.value.trim(),
importContent.value,
importPassphrase.value
)
if (outcome.ok) toast.success(outcome.message || `密钥「${view.meta.name}」已导入`)
else toast.warning(outcome.message)
importOpen.value = false
} catch (err) {
logger.error(`导入密钥失败:${String(err)}`)
toast.error(`导入失败:${String(err)}`)
} finally {
importBusy.value = false
}
}
// ===== =====
/** 刚复制过的密钥 id(用于按钮短暂显示对勾,给出「确实复制了」的确认) */
const copiedId = ref<string | null>(null)
let copiedTimer: ReturnType<typeof setTimeout> | null = null
async function copyPublic(k: KeyView) {
try {
// meta.publicKey
//
const text = await store.keyPublic(k.meta.id)
await navigator.clipboard.writeText(text)
copiedId.value = k.meta.id
if (copiedTimer) clearTimeout(copiedTimer)
copiedTimer = setTimeout(() => (copiedId.value = null), 1800)
toast.success('公钥已复制')
} catch (e) {
toast.error(`复制失败:${String(e)}`)
}
}
/**
* 复制为 `authorized_keys` 可用的形式
*
* 复制公钥的区别服务器上的 `authorized_keys` 每行只能有一个密钥
* 且行尾必须是注释如果用户从详情里复制到的是带换行的完整文本
* 粘到服务器上会变成多行破坏文件这里压成单行并补上注释
*/
async function copyForAuthorizedKeys(k: KeyView) {
try {
const text = await store.keyPublic(k.meta.id)
const parts = text.trim().split(/\s+/)
const body = parts.slice(0, 2).join(' ')
const comment = parts.slice(2).join(' ') || k.meta.name
const line = `${body} ${comment}`
await navigator.clipboard.writeText(line)
toast.success('已复制为单行 authorized_keys 格式')
} catch (e) {
toast.error(`复制失败:${String(e)}`)
}
}
// ===== =====
const renameTarget = ref<KeyView | null>(null)
const renameValue = ref('')
const renameBusy = ref(false)
function openRename(k: KeyView) {
renameTarget.value = k
renameValue.value = k.meta.name
}
async function submitRename() {
const k = renameTarget.value
const name = renameValue.value.trim()
if (!k) return
if (!name) {
toast.error('名称不能为空')
return
}
renameBusy.value = true
try {
await store.renameKey(k.meta.id, name)
toast.success('已重命名')
renameTarget.value = null
} catch (e) {
toast.error(`重命名失败:${String(e)}`)
} finally {
renameBusy.value = false
}
}
// ===== passphrase =====
const passTarget = ref<KeyView | null>(null)
const oldPass = ref('')
const newPass = ref('')
const confirmPass = ref('')
const passBusy = ref(false)
const passError = ref('')
function openPassphrase(k: KeyView) {
passTarget.value = k
oldPass.value = ''
newPass.value = ''
confirmPass.value = ''
passError.value = ''
}
async function submitPassphrase() {
const k = passTarget.value
if (!k) return
passError.value = ''
if (newPass.value !== confirmPass.value) {
passError.value = '两次输入的新 passphrase 不一致'
return
}
if (k.hasPassphrase && !oldPass.value) {
passError.value = '该密钥已有 passphrase,需填写当前值以验证身份'
return
}
if (!k.hasPassphrase && !newPass.value) {
passError.value = '请填写要设置的 passphrase'
return
}
// passphrase,
//
if (k.hasPassphrase && newPass.value === oldPass.value && newPass.value !== '') {
passError.value = '新 passphrase 与当前值相同,无需修改'
return
}
passBusy.value = true
try {
const r = await store.setKeyPassphrase(k.meta.id, oldPass.value, newPass.value)
if (r.ok) {
toast.success(r.message || (newPass.value ? 'passphrase 已更新' : 'passphrase 已移除'))
passTarget.value = null
} else {
passError.value = r.message
}
} catch (e) {
const msg = String(e)
logger.error(`修改 passphrase 失败:${msg}`)
//
passError.value = /passphrase|解密|decrypt/i.test(msg) ? '当前 passphrase 不正确' : msg
} finally {
passBusy.value = false
}
}
// ===== =====
const pendingDelete = ref<KeyView | null>(null)
const deleteBusy = ref(false)
/** 受该密钥影响的主机(删除前必须让用户看到代价) */
const affectedHosts = computed(() => {
const k = pendingDelete.value
if (!k) return []
return store.hosts.filter(h => h.config.keyId === k.meta.id)
})
async function submitDelete() {
const k = pendingDelete.value
if (!k) return
deleteBusy.value = true
try {
await store.deleteKey(k.meta.id)
toast.success(`密钥「${k.meta.name}」已删除`)
pendingDelete.value = null
} catch (e) {
toast.error(`删除失败:${String(e)}`)
} finally {
deleteBusy.value = false
}
}
// ===== =====
function algorithmLabel(a: string): string {
switch (a) {
case 'ed25519':
return 'Ed25519'
case 'rsa':
return 'RSA'
case 'ecdsa':
return 'ECDSA'
case 'dsa':
return 'DSA'
default:
return a || '未知'
}
}
function formatDate(rfc3339: string): string {
if (!rfc3339) return '—'
const d = new Date(rfc3339)
if (Number.isNaN(d.getTime())) return rfc3339
return d.toLocaleDateString('zh-CN', { year: 'numeric', month: '2-digit', day: '2-digit' })
}
</script>
<template>
<div class="flex flex-col h-full">
<!-- 头部 -->
<div class="shrink-0 flex items-center gap-2 px-4 h-12 border-b border-border">
<KeyRound class="size-4 text-muted-foreground" />
<h3 class="text-sm font-medium">SSH 密钥</h3>
<span class="text-xs text-muted-foreground">({{ store.keys.length }})</span>
<div class="flex-1" />
<Button variant="outline" size="sm" class="h-7 gap-1.5 text-xs" @click="openImport">
<Download class="size-3.5" />导入密钥
</Button>
<Button size="sm" class="h-7 gap-1.5 text-xs" @click="openGenerate">
<Plus class="size-3.5" />生成密钥
</Button>
</div>
<!-- 列表 -->
<div class="flex-1 min-h-0 overflow-y-auto p-3">
<div v-if="store.keys.length === 0" class="py-16 text-center">
<FileKey class="size-8 mx-auto text-muted-foreground/30 mb-3" />
<p class="text-sm text-muted-foreground mb-1">还没有 SSH 密钥</p>
<p class="text-xs text-muted-foreground/70 mb-4">
推荐生成 Ed25519 更短更快安全性优于同强度的 RSA
</p>
<div class="flex items-center justify-center gap-2">
<Button size="sm" class="gap-1.5" @click="openGenerate">
<Plus class="size-3.5" />生成密钥
</Button>
<Button variant="outline" size="sm" class="gap-1.5" @click="openImport">
<Download class="size-3.5" />导入已有密钥
</Button>
</div>
</div>
<div v-else class="space-y-1.5">
<div
v-for="k in store.keys"
:key="k.meta.id"
class="group rounded-md border border-border px-3 py-2.5
hover:border-primary/40 hover:bg-accent/30 transition-colors"
>
<div class="flex items-start gap-3">
<div class="shrink-0 mt-0.5">
<Lock v-if="k.hasPassphrase" class="size-4 text-emerald-600 dark:text-emerald-400" />
<Unlock v-else class="size-4 text-muted-foreground/50" />
</div>
<div class="min-w-0 flex-1">
<div class="flex items-center gap-2 flex-wrap">
<span class="text-sm font-medium truncate">{{ k.meta.name }}</span>
<span class="text-[10px] px-1.5 py-0.5 rounded bg-muted font-mono shrink-0">
{{ algorithmLabel(k.meta.algorithm) }}{{ k.meta.bits ? ` ${k.meta.bits}` : '' }}
</span>
<span
v-if="k.hasPassphrase"
class="text-[10px] px-1.5 py-0.5 rounded bg-emerald-500/15 text-emerald-700 dark:text-emerald-400 shrink-0"
>
已加密
</span>
<!-- 私钥文件丢失时明确告警主机配置还指向它但已经连不上了 -->
<span
v-if="!k.fileExists"
class="text-[10px] px-1.5 py-0.5 rounded bg-destructive/15 text-destructive inline-flex items-center gap-0.5 shrink-0"
>
<AlertTriangle class="size-2.5" />私钥文件缺失
</span>
</div>
<div class="mt-1 text-xs text-muted-foreground">
<span class="font-mono truncate block" :title="k.meta.fingerprint">
{{ k.meta.fingerprint }}
</span>
</div>
<div class="mt-1 flex items-center gap-3 text-[11px] text-muted-foreground/80">
<span v-if="k.meta.comment" class="truncate">{{ k.meta.comment }}</span>
<span>创建于 {{ formatDate(k.meta.createdAt) }}</span>
<span v-if="k.meta.fileName" class="font-mono truncate">{{ k.meta.fileName }}</span>
</div>
</div>
<div class="shrink-0 flex items-center gap-1">
<Button
variant="ghost"
size="icon"
class="size-7"
:title="copiedId === k.meta.id ? '已复制' : '复制公钥'"
@click="copyPublic(k)"
>
<Check v-if="copiedId === k.meta.id" class="size-3.5 text-emerald-600" />
<ClipboardCopy v-else class="size-3.5" />
</Button>
<Button
variant="ghost"
size="icon"
class="size-7 opacity-0 group-hover:opacity-100 transition-opacity"
title="复制为 authorized_keys 单行格式"
@click="copyForAuthorizedKeys(k)"
>
<ShieldCheck class="size-3.5" />
</Button>
<Button
variant="ghost"
size="icon"
class="size-7 opacity-0 group-hover:opacity-100 transition-opacity"
title="修改 passphrase"
@click="openPassphrase(k)"
>
<Lock class="size-3.5" />
</Button>
<Button
variant="ghost"
size="icon"
class="size-7 opacity-0 group-hover:opacity-100 transition-opacity"
title="重命名"
@click="openRename(k)"
>
<Pencil class="size-3.5" />
</Button>
<Button
variant="ghost"
size="icon"
class="size-7 opacity-0 group-hover:opacity-100 transition-opacity
text-destructive hover:text-destructive"
title="删除"
@click="pendingDelete = k"
>
<Trash2 class="size-3.5" />
</Button>
</div>
</div>
</div>
</div>
</div>
<!-- ===== 生成 ===== -->
<Dialog v-model:open="genOpen">
<DialogContent class="max-w-md">
<DialogHeader>
<DialogTitle>生成 SSH 密钥</DialogTitle>
<DialogDescription class="text-xs">
私钥保存在本机密钥目录公钥可直接复制到服务器的 authorized_keys
</DialogDescription>
</DialogHeader>
<div class="space-y-3">
<div class="space-y-1.5">
<Label class="text-xs">名称</Label>
<Input v-model="genForm.name" placeholder="例如:生产服务器" class="h-8 text-sm" />
<p v-if="genErrors.name" class="text-[11px] text-destructive">{{ genErrors.name }}</p>
</div>
<div class="grid grid-cols-2 gap-3">
<div class="space-y-1.5">
<Label class="text-xs">算法</Label>
<Select
:model-value="genForm.algorithm"
@update:model-value="(v: any) => onAlgorithmChange(String(v))"
>
<SelectTrigger class="h-8 text-sm">
<SelectValue />
</SelectTrigger>
<SelectContent>
<SelectItem value="ed25519">Ed25519推荐</SelectItem>
<SelectItem value="rsa">RSA</SelectItem>
<SelectItem value="ecdsa">ECDSA</SelectItem>
</SelectContent>
</Select>
</div>
<div class="space-y-1.5">
<Label class="text-xs">位数</Label>
<!-- ed25519 是定长算法禁用而非隐藏让用户看到这里确实没有可选项 -->
<Select :model-value="String(genForm.bits)" :disabled="bitOptions.length === 0">
<SelectTrigger class="h-8 text-sm">
<SelectValue :placeholder="bitOptions.length === 0 ? '定长' : '选择位数'" />
</SelectTrigger>
<SelectContent>
<SelectItem v-for="b in bitOptions" :key="b" :value="String(b)">{{ b }}</SelectItem>
</SelectContent>
</Select>
<p v-if="genErrors.bits" class="text-[11px] text-destructive">{{ genErrors.bits }}</p>
</div>
</div>
<div class="space-y-1.5">
<Label class="text-xs">注释可选</Label>
<Input
v-model="genForm.comment"
placeholder="user@host(会作为公钥行尾注释)"
class="h-8 text-sm font-mono"
/>
</div>
<div class="space-y-1.5">
<Label class="text-xs">
Passphrase
<span class="text-muted-foreground font-normal">可选推荐设置</span>
</Label>
<Input v-model="genForm.passphrase" type="password" placeholder="留空表示不加密" class="h-8 text-sm" />
<p class="text-[11px] text-muted-foreground">
设置后每次使用密钥都需输入请自行妥善保管遗失无法找回
</p>
</div>
</div>
<DialogFooter>
<Button variant="outline" size="sm" @click="genOpen = false">取消</Button>
<Button size="sm" :disabled="genBusy" @click="submitGenerate">
<Loader2 v-if="genBusy" class="size-3.5 mr-1.5 animate-spin" />
生成
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
<!-- ===== 导入 ===== -->
<Dialog v-model:open="importOpen">
<DialogContent class="max-w-lg">
<DialogHeader>
<DialogTitle>导入 SSH 私钥</DialogTitle>
<DialogDescription class="text-xs">
支持 OpenSSH 私钥与 PuTTY <span class="font-mono">.ppk</span>v2 / v3含加密
导入后统一转存为 OpenSSH 格式可直接被 ssh / git 引用
</DialogDescription>
</DialogHeader>
<div class="space-y-3">
<div class="space-y-1.5">
<Label class="text-xs">名称</Label>
<Input v-model="importName" placeholder="例如:GitHub" class="h-8 text-sm" />
<p v-if="importErrors.name" class="text-[11px] text-destructive">{{ importErrors.name }}</p>
</div>
<div class="space-y-1.5">
<div class="flex items-center justify-between">
<Label class="text-xs">私钥内容</Label>
<Button
variant="ghost"
size="sm"
class="h-6 gap-1 px-1.5 text-[11px] text-muted-foreground hover:text-foreground"
@click="pickKeyFile"
>
<FolderOpen class="size-3" />选择文件
</Button>
</div>
<Textarea
v-model="importContent"
placeholder="-----BEGIN OPENSSH PRIVATE KEY-----&#10;…&#10;&#10;或 PuTTY-User-Key-File-3: ssh-ed25519&#10;…&#10;&#10;也可直接粘贴文件路径"
class="font-mono text-xs min-h-[140px] resize-y"
/>
<p v-if="importErrors.content" class="text-[11px] text-destructive">
{{ importErrors.content }}
</p>
</div>
<div class="space-y-1.5">
<Label class="text-xs">
Passphrase
<span class="text-muted-foreground font-normal">若该密钥已加密则必填</span>
</Label>
<Input v-model="importPassphrase" type="password" class="h-8 text-sm" />
<p class="text-[11px] text-muted-foreground">
密钥将以相同的 passphrase 重新加密后保存
</p>
</div>
</div>
<DialogFooter>
<Button variant="outline" size="sm" @click="importOpen = false">取消</Button>
<Button size="sm" :disabled="importBusy" @click="submitImport">
<Loader2 v-if="importBusy" class="size-3.5 mr-1.5 animate-spin" />
导入
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
<!-- ===== 重命名 ===== -->
<Dialog :open="renameTarget !== null" @update:open="v => !v && (renameTarget = null)">
<DialogContent class="max-w-sm">
<DialogHeader>
<DialogTitle class="text-base">重命名密钥</DialogTitle>
</DialogHeader>
<Input v-model="renameValue" class="h-8 text-sm" @keydown.enter="submitRename" />
<DialogFooter>
<Button variant="outline" size="sm" @click="renameTarget = null">取消</Button>
<Button size="sm" :disabled="renameBusy" @click="submitRename">保存</Button>
</DialogFooter>
</DialogContent>
</Dialog>
<!-- ===== passphrase ===== -->
<Dialog :open="passTarget !== null" @update:open="v => !v && (passTarget = null)">
<DialogContent class="max-w-sm">
<DialogHeader>
<DialogTitle class="text-base">修改 Passphrase</DialogTitle>
<DialogDescription class="text-xs">
{{ passTarget?.meta.name }}
</DialogDescription>
</DialogHeader>
<div class="space-y-3">
<div v-if="passTarget?.hasPassphrase" class="space-y-1.5">
<Label class="text-xs">当前 Passphrase</Label>
<Input v-model="oldPass" type="password" class="h-8 text-sm" />
</div>
<div class="space-y-1.5">
<Label class="text-xs">
Passphrase
<span class="text-muted-foreground font-normal">留空表示移除加密</span>
</Label>
<Input v-model="newPass" type="password" class="h-8 text-sm" />
</div>
<div class="space-y-1.5">
<Label class="text-xs">确认新 Passphrase</Label>
<Input v-model="confirmPass" type="password" class="h-8 text-sm" />
</div>
<p v-if="passError" class="text-[11px] text-destructive">{{ passError }}</p>
<!-- 移除加密是有实际风险的操作给一次明确提示 -->
<div
v-if="passTarget?.hasPassphrase && !newPass"
class="flex items-start gap-2 p-2 rounded bg-amber-500/10 text-[11px] text-amber-700 dark:text-amber-400"
>
<AlertTriangle class="size-3.5 shrink-0 mt-0.5" />
<span> passphrase 留空将移除加密此后该私钥以明文形式存放在磁盘上</span>
</div>
</div>
<DialogFooter>
<Button variant="outline" size="sm" @click="passTarget = null">取消</Button>
<Button size="sm" :disabled="passBusy" @click="submitPassphrase">
<Loader2 v-if="passBusy" class="size-3.5 mr-1.5 animate-spin" />
确认
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
<!-- ===== 删除确认 ===== -->
<Dialog :open="pendingDelete !== null" @update:open="v => !v && (pendingDelete = null)">
<DialogContent class="max-w-sm" :show-close-button="false">
<DialogHeader>
<DialogTitle class="text-base">删除密钥</DialogTitle>
<DialogDescription class="text-xs">
将删除{{ pendingDelete?.meta.name }}的私钥与公钥文件此操作不可撤销
</DialogDescription>
</DialogHeader>
<!-- 让用户看到代价哪些主机配置正在用这个密钥 -->
<div
v-if="affectedHosts.length > 0"
class="rounded-md border border-destructive/40 bg-destructive/5 p-2.5 space-y-1"
>
<p class="text-[11px] font-medium text-destructive flex items-center gap-1">
<AlertTriangle class="size-3" />
{{ affectedHosts.length }} 台主机正在使用该密钥
</p>
<ul class="text-[11px] text-muted-foreground space-y-0.5 pl-4">
<li v-for="h in affectedHosts" :key="h.config.id" class="truncate">
{{ h.config.name || h.config.host }}
</li>
</ul>
<p class="text-[11px] text-muted-foreground">删除后这些主机将无法通过密钥方式连接</p>
</div>
<DialogFooter>
<Button variant="outline" size="sm" @click="pendingDelete = null">取消</Button>
<Button variant="destructive" size="sm" :disabled="deleteBusy" @click="submitDelete">
删除
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
</div>
</template>
@@ -0,0 +1,453 @@
<script setup lang="ts">
/**
* known_hosts 管理
*
* # 设计立场
*
* 这个面板的存在理由只有一个**忘记某台主机这件事变得容易**
*
* 主机密钥校验是 SSH 抵御中间人的核心机制但它的最大敌人不是攻击者
* 而是用户自己被卡住时的挫败感 指纹变了连不上怎么办
* 如果这时唯一的出路是去翻文档 known_hosts 文件手工删行
* 用户就会转向关闭校验这种彻底破坏安全性的做法
*
* 所以这里提供两条路
* - 单条遗忘服务器重装后重新握手正常流程
* - 全部清空最后手段带明确警告
*
* # 指纹变更历史为什么单独展示
*
* 一条**已接受**的变更服务器重装管理员换密钥和一条**刚发生**的变更
* 对用户的意义完全不同只显示最新指纹会丢掉这个上下文
* 让用户误以为这台机器一直没问题而实际上它已经换过密钥
*/
import { computed, ref } from 'vue'
import {
AlertTriangle,
Check,
ClipboardPaste,
Download,
History,
Loader2,
Server,
ShieldCheck,
Trash2
} from '@lucide/vue'
import { toast } from 'vue-sonner'
import { useTerminalStore } from '@/stores/terminalStore'
import { Button } from '@/components/ui/button'
import { Textarea } from '@/components/ui/textarea'
import {
Dialog,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogTitle
} from '@/components/ui/dialog'
import { createLogger } from '@/lib/logger'
import type { KnownHost } from '@/types/terminal'
const logger = createLogger('terminal')
const store = useTerminalStore()
const search = ref('')
const filtered = computed(() => {
const q = search.value.trim().toLowerCase()
if (!q) return store.knownHosts
return store.knownHosts.filter(
h =>
h.host.toLowerCase().includes(q) ||
h.fingerprint.toLowerCase().includes(q) ||
h.keyType.toLowerCase().includes(q)
)
})
/** 曾发生过指纹变更的主机数量(用于顶部的风险提示) */
const changedCount = computed(() => store.knownHosts.filter(h => h.history.length > 0).length)
/** 展开查看变更历史的主机 key */
const expanded = ref<string | null>(null)
function hostKey(h: KnownHost): string {
return `${h.host}:${h.port}/${h.keyType}`
}
function toggleExpand(h: KnownHost) {
const k = hostKey(h)
expanded.value = expanded.value === k ? null : k
}
// ===== =====
const pendingForget = ref<KnownHost | null>(null)
const forgetBusy = ref(false)
async function submitForget() {
const h = pendingForget.value
if (!h) return
forgetBusy.value = true
try {
await store.forgetHost(h.host, h.port, h.keyType)
toast.success(`已忘记 ${h.host}:${h.port}`)
pendingForget.value = null
} catch (e) {
toast.error(`操作失败:${String(e)}`)
} finally {
forgetBusy.value = false
}
}
// ===== =====
const clearOpen = ref(false)
const clearBusy = ref(false)
/** 清空是破坏性操作:要求用户输入确认词,避免误点 */
const clearConfirmText = ref('')
const CLEAR_KEYWORD = '清空'
async function submitClear() {
if (clearConfirmText.value.trim() !== CLEAR_KEYWORD) return
clearBusy.value = true
try {
await store.clearKnownHosts()
toast.success('已清空全部已知主机')
clearOpen.value = false
clearConfirmText.value = ''
} catch (e) {
toast.error(`清空失败:${String(e)}`)
} finally {
clearBusy.value = false
}
}
// ===== / =====
const copied = ref(false)
let copiedTimer: ReturnType<typeof setTimeout> | null = null
async function copyAll() {
try {
const text = await store.exportKnownHosts()
if (!text.trim()) {
toast.info('没有可导出的记录')
return
}
await navigator.clipboard.writeText(text)
copied.value = true
if (copiedTimer) clearTimeout(copiedTimer)
copiedTimer = setTimeout(() => (copied.value = false), 1800)
toast.success('已复制到剪贴板')
} catch (e) {
toast.error(`导出失败:${String(e)}`)
}
}
const importOpen = ref(false)
const importText = ref('')
const importBusy = ref(false)
function openImport() {
importText.value = ''
importOpen.value = true
}
async function submitImport() {
const text = importText.value.trim()
if (!text) {
toast.error('请粘贴 known_hosts 内容')
return
}
importBusy.value = true
try {
const r = await store.importKnownHosts(text)
if (r.ok) {
toast.success(r.message)
importOpen.value = false
} else {
toast.error(r.message)
}
} catch (e) {
logger.error(`导入 known_hosts 失败:${String(e)}`)
toast.error(`导入失败:${String(e)}`)
} finally {
importBusy.value = false
}
}
// ===== =====
function formatDate(rfc3339: string): string {
if (!rfc3339) return '—'
const d = new Date(rfc3339)
if (Number.isNaN(d.getTime())) return rfc3339
return d.toLocaleString('zh-CN', {
year: 'numeric',
month: '2-digit',
day: '2-digit',
hour: '2-digit',
minute: '2-digit'
})
}
function keyTypeLabel(t: string): string {
const map: Record<string, string> = {
'ssh-ed25519': 'Ed25519',
'ssh-rsa': 'RSA',
'ecdsa-sha2-nistp256': 'ECDSA 256',
'ecdsa-sha2-nistp384': 'ECDSA 384',
'ecdsa-sha2-nistp521': 'ECDSA 521',
'ssh-dss': 'DSA'
}
return map[t] ?? t
}
</script>
<template>
<div class="flex flex-col h-full">
<!-- 头部 -->
<div class="shrink-0 flex items-center gap-2 px-4 h-12 border-b border-border">
<ShieldCheck class="size-4 text-muted-foreground" />
<h3 class="text-sm font-medium">已知主机</h3>
<span class="text-xs text-muted-foreground">({{ store.knownHosts.length }})</span>
<div class="flex-1" />
<Button variant="outline" size="sm" class="h-7 gap-1.5 text-xs" @click="openImport">
<ClipboardPaste class="size-3.5" />导入
</Button>
<Button variant="outline" size="sm" class="h-7 gap-1.5 text-xs" @click="copyAll">
<Check v-if="copied" class="size-3.5 text-emerald-600" />
<Download v-else class="size-3.5" />
导出
</Button>
<Button
variant="outline"
size="sm"
class="h-7 gap-1.5 text-xs text-destructive hover:text-destructive"
:disabled="store.knownHosts.length === 0"
@click="clearOpen = true"
>
<Trash2 class="size-3.5" />清空
</Button>
</div>
<!-- 风险提示有变更历史时始终可见 -->
<div
v-if="changedCount > 0"
class="shrink-0 mx-3 mt-3 flex items-start gap-2 p-2.5 rounded-md
border border-amber-500/40 bg-amber-500/10"
>
<AlertTriangle class="size-3.5 shrink-0 mt-0.5 text-amber-600 dark:text-amber-400" />
<div class="text-[11px] text-amber-700 dark:text-amber-400">
<p class="font-medium">{{ changedCount }} 台主机曾发生指纹变更</p>
<p class="mt-0.5 opacity-90">
若不是您本人重装或更换了服务器密钥请联系管理员核实
</p>
</div>
</div>
<!-- 搜索 -->
<div v-if="store.knownHosts.length > 0" class="shrink-0 px-3 pt-3">
<input
v-model="search"
placeholder="搜索主机、指纹或类型…"
class="w-full h-7 px-2.5 rounded-md border border-border bg-transparent
text-xs outline-none focus:border-primary/50 placeholder:text-muted-foreground"
/>
</div>
<!-- 列表 -->
<div class="flex-1 min-h-0 overflow-y-auto p-3">
<div v-if="store.knownHosts.length === 0" class="py-16 text-center">
<ShieldCheck class="size-8 mx-auto text-muted-foreground/30 mb-3" />
<p class="text-sm text-muted-foreground mb-1">还没有已知主机记录</p>
<p class="text-xs text-muted-foreground/70">
首次连接某台 SSH 主机时会请您核对并保存其密钥指纹
</p>
</div>
<div v-else-if="filtered.length === 0" class="py-12 text-center">
<p class="text-sm text-muted-foreground">没有匹配{{ search }}的记录</p>
</div>
<div v-else class="space-y-1.5">
<div
v-for="h in filtered"
:key="hostKey(h)"
class="group rounded-md border border-border overflow-hidden
hover:border-primary/40 transition-colors"
:class="h.history.length > 0 ? 'border-amber-500/40' : ''"
>
<div class="flex items-start gap-3 px-3 py-2.5">
<Server class="size-4 shrink-0 mt-0.5 text-muted-foreground" />
<div class="min-w-0 flex-1">
<div class="flex items-center gap-2 flex-wrap">
<span class="text-sm font-medium font-mono truncate">
{{ h.host }}<span v-if="h.port !== 22" class="text-muted-foreground">:{{ h.port }}</span>
</span>
<span class="text-[10px] px-1.5 py-0.5 rounded bg-muted shrink-0">
{{ keyTypeLabel(h.keyType) }}
</span>
<button
v-if="h.history.length > 0"
class="text-[10px] px-1.5 py-0.5 rounded bg-amber-500/15 text-amber-700
dark:text-amber-400 shrink-0 inline-flex items-center gap-0.5
hover:bg-amber-500/25 transition-colors"
@click="toggleExpand(h)"
>
<History class="size-2.5" />
变更过 {{ h.history.length }}
</button>
</div>
<div
class="mt-1 text-xs font-mono text-muted-foreground truncate"
:title="h.fingerprint"
>
{{ h.fingerprint }}
</div>
<div class="mt-1 flex items-center gap-3 text-[11px] text-muted-foreground/80">
<span>首次 {{ formatDate(h.firstSeen) }}</span>
<span>最近确认 {{ formatDate(h.lastConfirmed) }}</span>
</div>
</div>
<Button
variant="ghost"
size="icon"
class="size-7 shrink-0 opacity-0 group-hover:opacity-100 transition-opacity
text-destructive hover:text-destructive"
title="忘记该主机"
@click="pendingForget = h"
>
<Trash2 class="size-3.5" />
</Button>
</div>
<!-- 变更历史 -->
<div
v-if="expanded === hostKey(h)"
class="border-t border-border bg-muted/30 px-3 py-2 space-y-1.5"
>
<p class="text-[10px] uppercase tracking-wide text-muted-foreground">指纹变更历史</p>
<div
v-for="(c, i) in h.history"
:key="i"
class="flex items-start gap-2 text-[11px]"
>
<span
class="shrink-0 mt-0.5 size-1.5 rounded-full"
:class="c.accepted ? 'bg-amber-500' : 'bg-muted-foreground/40'"
/>
<div class="min-w-0">
<span class="text-muted-foreground">{{ formatDate(c.changedAt) }}</span>
<span class="mx-1.5">·</span>
<span :class="c.accepted ? 'text-amber-700 dark:text-amber-400' : 'text-muted-foreground'">
{{ c.accepted ? '已接受变更' : '已拒绝变更' }}
</span>
<div class="font-mono text-muted-foreground/70 truncate" :title="c.oldFingerprint">
原指纹 {{ c.oldFingerprint }}
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- ===== 忘记单条 ===== -->
<Dialog :open="pendingForget !== null" @update:open="v => !v && (pendingForget = null)">
<DialogContent class="max-w-sm" :show-close-button="false">
<DialogHeader>
<DialogTitle class="text-base">忘记该主机</DialogTitle>
<DialogDescription class="text-xs">
将删除 <span class="font-mono">{{ pendingForget?.host }}:{{ pendingForget?.port }}</span>
的密钥指纹记录下次连接时将重新提示核对
</DialogDescription>
</DialogHeader>
<div class="flex items-start gap-2 p-2 rounded bg-muted text-[11px] text-muted-foreground">
<AlertTriangle class="size-3.5 shrink-0 mt-0.5" />
<span>仅在确认该主机密钥确实已更换时执行若出于连不上就删掉的动机请先核实原因</span>
</div>
<DialogFooter>
<Button variant="outline" size="sm" @click="pendingForget = null">取消</Button>
<Button variant="destructive" size="sm" :disabled="forgetBusy" @click="submitForget">
忘记
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
<!-- ===== 清空全部 ===== -->
<Dialog v-model:open="clearOpen">
<DialogContent class="max-w-sm" :show-close-button="false">
<DialogHeader>
<DialogTitle class="text-base text-destructive">清空全部已知主机</DialogTitle>
<DialogDescription class="text-xs">
将删除全部 {{ store.knownHosts.length }} 条记录
</DialogDescription>
</DialogHeader>
<div class="rounded-md border border-destructive/40 bg-destructive/5 p-2.5">
<p class="text-[11px] text-destructive font-medium flex items-center gap-1 mb-1">
<AlertTriangle class="size-3" />这会降低连接安全性
</p>
<p class="text-[11px] text-muted-foreground">
清空后所有主机的密钥校验都需要重新人工核对在核对前
连接可能被中间人攻击劫持而您不会收到提示
</p>
</div>
<div class="space-y-1.5">
<p class="text-xs text-muted-foreground">
请输入 <span class="font-mono font-semibold text-foreground">{{ CLEAR_KEYWORD }}</span> 以确认
</p>
<input
v-model="clearConfirmText"
class="w-full h-8 px-2.5 rounded-md border border-border bg-transparent
text-sm outline-none focus:border-destructive/60"
/>
</div>
<DialogFooter>
<Button variant="outline" size="sm" @click="clearOpen = false">取消</Button>
<Button
variant="destructive"
size="sm"
:disabled="clearBusy || clearConfirmText.trim() !== CLEAR_KEYWORD"
@click="submitClear"
>
<Loader2 v-if="clearBusy" class="size-3.5 mr-1.5 animate-spin" />
清空全部
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
<!-- ===== 导入 ===== -->
<Dialog v-model:open="importOpen">
<DialogContent class="max-w-lg">
<DialogHeader>
<DialogTitle>导入 known_hosts</DialogTitle>
<DialogDescription class="text-xs">
粘贴 <span class="font-mono">~/.ssh/known_hosts</span>
</DialogDescription>
</DialogHeader>
<Textarea
v-model="importText"
placeholder="example.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAA…"
class="font-mono text-xs min-h-[180px] resize-y"
/>
<DialogFooter>
<Button variant="outline" size="sm" @click="importOpen = false">取消</Button>
<Button size="sm" :disabled="importBusy" @click="submitImport">
<Loader2 v-if="importBusy" class="size-3.5 mr-1.5 animate-spin" />
导入
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
</div>
</template>
@@ -0,0 +1,811 @@
<script setup lang="ts">
/**
* SFTP 双栏文件管理面板
*
* # 为什么是双栏而不是单栏 + 上传/下载按钮
*
* 传输任务的本质是 A 处的这个东西放到 B 单栏形态下用户必须
* 先在远端浏览到目标目录 记住路径 打开本地文件对话框 逐级点到源文件
* 双栏把这个心智模型直接画出来左边本地右边远端拖过去就行
*
* # 左右栏的分工是有意不对称的
*
* 远端栏是**完整实现**浏览新建删除重命名符号链接解析跟随终端 cwd
* 本地栏只做定位与选取它有真实的系统文件管理器在旁边
* WebView 里重造一个更差的资源管理器缩略图右键菜单拖放剪贴板互操作
* 是纯粹的浪费因此本地栏刻意只给路径输入 + 快捷位置 + 系统对话框选择
*
* # 一次只服务一个会话
*
* 面板绑定 `sessionId`不自己持有 SFTP 通道句柄通道由 store 按会话管理
* `SftpRegistry`会话断开时面板自动收起不留一个指向死通道的空壳
*/
import { computed, onBeforeUnmount, ref, watch } from 'vue'
import { open as openDialog, save as saveDialog } from '@tauri-apps/plugin-dialog'
import {
ArrowDownToLine,
ArrowUpFromLine,
ChevronRight,
CornerUpLeft,
ExternalLink,
File as FileIcon,
Folder,
FolderOpen,
FolderPlus,
HardDrive,
Link2,
Loader2,
RefreshCw,
Server,
Trash2,
X
} from '@lucide/vue'
import { toast } from 'vue-sonner'
import { useTerminalStore } from '@/stores/terminalStore'
import { createLogger } from '@/lib/logger'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'
import type { RemoteEntry } from '@/types/terminal'
const props = defineProps<{
sessionId: string
/** 会话显示名(面板标题用,避免面板自己再查一次 store) */
sessionLabel: string
/** 终端当前工作目录,用于「跟随终端目录」 */
terminalCwd: string
}>()
const emit = defineEmits<{
(e: 'close'): void
}>()
const logger = createLogger('terminal')
const store = useTerminalStore()
// ===== =====
const remoteCwd = ref('')
const remoteEntries = ref<RemoteEntry[]>([])
const remoteLoading = ref(false)
const remoteError = ref('')
/** 选中项(单选用它;多选留给 P2 的批量操作) */
const selectedRemote = ref<RemoteEntry | null>(null)
const remoteFilter = ref('')
const filteredRemote = computed(() => {
const kw = remoteFilter.value.trim().toLowerCase()
if (!kw) return remoteEntries.value
return remoteEntries.value.filter(e => e.name.toLowerCase().includes(kw))
})
/** 面包屑:把 `/a/b/c` 拆成可点击的逐级路径 */
const crumbs = computed(() => {
const p = remoteCwd.value
if (!p) return []
const parts = p.split('/').filter(Boolean)
const out: Array<{ name: string; path: string }> = []
let acc = ''
for (const part of parts) {
acc += `/${part}`
out.push({ name: part, path: acc })
}
return out
})
async function loadRemote(path: string) {
if (!path) return
remoteLoading.value = true
remoteError.value = ''
try {
const dir = await store.sftpList(props.sessionId, path)
// cwd path
//
remoteCwd.value = dir.cwd || path
remoteEntries.value = dir.entries
selectedRemote.value = null
} catch (e) {
remoteError.value = String(e)
logger.error(`列举远端目录 ${path} 失败:${String(e)}`)
} finally {
remoteLoading.value = false
}
}
async function goUp() {
try {
const parent = await store.sftpParent(remoteCwd.value)
if (parent === remoteCwd.value) return
await loadRemote(parent)
} catch (e) {
toast.error(`无法返回上一级:${String(e)}`)
}
}
async function enterRemote(entry: RemoteEntry) {
if (entry.kind === 'dir') {
await loadRemote(entry.path)
return
}
if (entry.kind === 'symlink') {
//
try {
const dir = await store.sftpList(props.sessionId, entry.path)
remoteCwd.value = dir.cwd || entry.path
remoteEntries.value = dir.entries
selectedRemote.value = null
return
} catch {
// 退
selectedRemote.value = entry
toast.info(`符号链接指向 ${entry.linkTarget}(不是目录或不可访问)`)
}
}
}
/** 跟随终端当前目录 */
async function followTerminalCwd() {
if (!props.terminalCwd) {
toast.info('终端尚未上报工作目录(该 shell 可能不支持 OSC 7')
return
}
await loadRemote(props.terminalCwd)
}
// ===== =====
const newDirName = ref('')
const showNewDir = ref(false)
async function createFolder() {
const name = newDirName.value.trim()
if (!name || name.includes('/')) {
toast.error('目录名不能为空,且不能包含 /')
return
}
try {
// store.sftpParent `/` POSIX
// Windows `//new`
await store.sftpMkdir(props.sessionId, joinRemote(remoteCwd.value, name))
showNewDir.value = false
newDirName.value = ''
await loadRemote(remoteCwd.value)
toast.success(`已创建 ${name}`)
} catch (e) {
toast.error(`创建目录失败:${String(e)}`)
}
}
/**
* 远端路径拼接
*
* Rust `join_remote` 同一套规则前端这边**只在展示与提交时**
* 真实解析仍以服务端 `cwd` 为准若两边规则有出入服务端是权威
*/
function joinRemote(base: string, name: string): string {
if (!base) return `/${name}`
if (base === '/') return `/${name}`
return `${base.replace(/\/+$/, '')}/${name}`
}
async function removeRemote() {
const e = selectedRemote.value
if (!e) return
const isDir = e.kind === 'dir'
const hint = isDir ? '及其全部内容' : ''
if (!window.confirm(`确定删除「${e.name}${hint}?此操作不可恢复。`)) return
try {
const r = await store.sftpDelete(props.sessionId, e.path, isDir)
toast.success(r.message)
await loadRemote(remoteCwd.value)
} catch (err) {
toast.error(`删除失败:${String(err)}`)
}
}
const renaming = ref(false)
const renameValue = ref('')
function startRename() {
const e = selectedRemote.value
if (!e) return
renameValue.value = e.name
renaming.value = true
}
async function submitRename() {
const e = selectedRemote.value
if (!e) return
const name = renameValue.value.trim()
if (!name || name === e.name) {
renaming.value = false
return
}
if (name.includes('/')) {
toast.error('名称不能包含 /')
return
}
try {
await store.sftpRename(props.sessionId, e.path, joinRemote(remoteCwd.value, name))
renaming.value = false
await loadRemote(remoteCwd.value)
} catch (err) {
toast.error(`重命名失败:${String(err)}`)
}
}
// ===== =====
/**
* 本地目录**不由前端列举**
*
* 理由WebView 里没有可靠的方式读本地目录FS Access API Tauri
* http://tauri.localhost
* fs 插件权限太重本机已经有资源管理器因此本地栏的定位入口是
* **系统文件对话框** 用户本来就更习惯用它
*/
const localDir = ref('')
const localFiles = ref<string[]>([])
async function pickLocalDir() {
try {
const picked = await openDialog({ directory: true, multiple: false })
if (typeof picked !== 'string') return
localDir.value = picked
localFiles.value = []
} catch (e) {
toast.error(`选择目录失败:${String(e)}`)
}
}
async function pickLocalFiles() {
try {
const picked = await openDialog({ multiple: true, directory: false })
if (!picked) return
const list = Array.isArray(picked) ? picked : [picked]
localFiles.value = list
//
if (list.length > 0) {
const first = list[0].replace(/\\/g, '/')
localDir.value = first.slice(0, first.lastIndexOf('/')) || localDir.value
}
} catch (e) {
toast.error(`选择文件失败:${String(e)}`)
}
}
function clearLocalFiles() {
localFiles.value = []
}
/** 本地文件名的展示形态(去掉目录部分) */
function baseName(path: string): string {
const p = path.replace(/\\/g, '/')
return p.slice(p.lastIndexOf('/') + 1)
}
// ===== =====
const uploading = ref(false)
const downloading = ref(false)
/** 进行中的传输(按 id 去重后展示进度条) */
const activeTransfers = computed(() =>
store.transfers.filter(t => t.sessionId === props.sessionId)
)
async function uploadSelected() {
if (localFiles.value.length === 0) {
toast.info('请先选择要上传的本地文件')
return
}
uploading.value = true
let ok = 0
const failed: string[] = []
// 4
//
for (const file of localFiles.value) {
try {
const r = await store.sftpUpload(
props.sessionId,
file,
joinRemote(remoteCwd.value, baseName(file))
)
if (r.ok) ok += 1
else failed.push(`${baseName(file)}${r.message}`)
} catch (e) {
failed.push(`${baseName(file)}${String(e)}`)
}
}
uploading.value = false
await loadRemote(remoteCwd.value)
if (failed.length === 0) {
toast.success(`已上传 ${ok} 个文件`)
} else if (ok > 0) {
toast.warning(`上传完成 ${ok} 个,失败 ${failed.length} 个:${failed.join('')}`)
} else {
toast.error(`上传失败:${failed.join('')}`)
}
}
async function downloadSelected() {
const e = selectedRemote.value
if (!e) {
toast.info('请先选择要下载的远端文件')
return
}
if (e.kind === 'dir') {
toast.info('目录下载属 P2;请进入目录后逐个下载文件')
return
}
try {
const suggested = localDir.value
? `${localDir.value.replace(/\\/g, '/').replace(/\/+$/, '')}/${e.name}`
: e.name
const target = await saveDialog({ defaultPath: suggested })
if (!target) return
downloading.value = true
const r = await store.sftpDownload(props.sessionId, e.path, target)
toast.success(r.message)
} catch (err) {
toast.error(`下载失败:${String(err)}`)
} finally {
downloading.value = false
}
}
/** 下载到本地目录(不弹保存框,直接用当前本地目录 + 原文件名) */
async function downloadToLocalDir() {
const e = selectedRemote.value
if (!e) {
toast.info('请先选择要下载的远端文件')
return
}
if (!localDir.value) {
toast.info('请先选择本地目录')
return
}
if (e.kind === 'dir') {
toast.info('目录下载属 P2')
return
}
try {
downloading.value = true
const sep = localDir.value.includes('\\') ? '\\' : '/'
const target = `${localDir.value.replace(/[\\/]+$/, '')}${sep}${e.name}`
const r = await store.sftpDownload(props.sessionId, e.path, target)
toast.success(r.message)
} catch (err) {
toast.error(`下载失败:${String(err)}`)
} finally {
downloading.value = false
}
}
function openLocal(path: string) {
void store.openLocalPath(path).catch(e => toast.error(`打开失败:${String(e)}`))
}
function revealLocal(path: string) {
void store.revealLocalPath(path).catch(e => toast.error(`定位失败:${String(e)}`))
}
// ===== =====
/** 字节数的人类可读形态 */
function humanSize(n: number): string {
if (n < 1024) return `${n} B`
const units = ['KB', 'MB', 'GB', 'TB']
let v = n / 1024
let i = 0
while (v >= 1024 && i < units.length - 1) {
v /= 1024
i += 1
}
return `${v < 10 ? v.toFixed(1) : Math.round(v)} ${units[i]}`
}
function fmtTime(ms?: number | null): string {
if (!ms) return ''
const d = new Date(ms)
const pad = (x: number) => String(x).padStart(2, '0')
return `${d.getFullYear()}-${pad(d.getMonth() + 1)}-${pad(d.getDate())} ${pad(d.getHours())}:${pad(d.getMinutes())}`
}
function entryIcon(e: RemoteEntry) {
if (e.kind === 'dir') return Folder
if (e.kind === 'symlink') return Link2
return FileIcon
}
// ===== =====
let disposed = false
watch(
() => props.sessionId,
async id => {
if (!id || disposed) return
try {
await store.sftpOpen(id)
// remoteCwd / cwd props
await loadRemote(props.terminalCwd || '.')
} catch (e) {
remoteError.value = String(e)
toast.error(`打开文件管理器失败:${String(e)}`)
}
},
{ immediate: true }
)
// cd
const following = ref(false)
watch(
() => props.terminalCwd,
cwd => {
if (following.value && cwd) void loadRemote(cwd)
}
)
onBeforeUnmount(() => {
disposed = true
// TCP
// await
void store.sftpClose(props.sessionId).catch(() => {
/* 会话可能已断开,忽略 */
})
})
</script>
<template>
<div class="flex flex-col h-full min-h-0 bg-background">
<!-- ===== 头部 ===== -->
<div class="shrink-0 flex items-center gap-2 px-2.5 h-9 border-b border-border">
<HardDrive class="size-3.5 text-muted-foreground shrink-0" />
<span class="text-xs font-medium truncate" :title="sessionLabel">{{ sessionLabel }}</span>
<span class="text-[10px] text-muted-foreground font-mono truncate">
{{ remoteCwd || '—' }}
</span>
<div class="flex-1" />
<Button
variant="ghost"
size="sm"
class="h-6 px-1.5 text-[11px]"
:disabled="!terminalCwd"
title="定位到终端当前目录"
@click="followTerminalCwd"
>
跟随终端
</Button>
<Button variant="ghost" size="sm" class="h-6 w-6 p-0" title="关闭面板" @click="emit('close')">
<X class="size-3.5" />
</Button>
</div>
<!-- ===== 主体左右双栏 ===== -->
<div class="flex-1 min-h-0 flex">
<!-- ---------- 本地栏 ---------- -->
<section class="w-[38%] min-w-[220px] flex flex-col border-r border-border">
<div class="shrink-0 h-7 px-2 flex items-center gap-1.5 border-b border-border bg-muted/40">
<HardDrive class="size-3 text-muted-foreground" />
<span class="text-[11px] font-medium">本地</span>
</div>
<div class="shrink-0 p-2 space-y-1.5 border-b border-border">
<Button
variant="outline"
size="sm"
class="w-full h-7 text-[11px] justify-start gap-1.5"
@click="pickLocalDir"
>
<FolderOpen class="size-3" />选择目录
</Button>
<Button
variant="outline"
size="sm"
class="w-full h-7 text-[11px] justify-start gap-1.5"
@click="pickLocalFiles"
>
<FileIcon class="size-3" />选择文件
</Button>
<div v-if="localDir" class="text-[10px] text-muted-foreground truncate font-mono px-0.5" :title="localDir">
{{ localDir }}
</div>
</div>
<div class="flex-1 min-h-0 overflow-auto">
<div v-if="localFiles.length === 0" class="p-3 text-center">
<p class="text-[11px] text-muted-foreground/70 leading-relaxed">
选择本地文件后点上传<br />
本地目录浏览请用系统资源管理器 WebView 里重造一个更差的资源管理器没有意义
</p>
</div>
<ul v-else class="py-1">
<li
v-for="f in localFiles"
:key="f"
class="group px-2 py-1 flex items-center gap-1.5 text-[11px] hover:bg-accent cursor-default"
:title="f"
>
<FileIcon class="size-3 shrink-0 text-muted-foreground" />
<span class="truncate flex-1">{{ baseName(f) }}</span>
<button
class="opacity-0 group-hover:opacity-100 text-muted-foreground hover:text-foreground"
title="用默认程序打开"
@click="openLocal(f)"
>
<ExternalLink class="size-3" />
</button>
<button
class="opacity-0 group-hover:opacity-100 text-muted-foreground hover:text-foreground"
title="在资源管理器中显示"
@click="revealLocal(f)"
>
<FolderOpen class="size-3" />
</button>
</li>
</ul>
</div>
<div class="shrink-0 p-2 border-t border-border flex items-center gap-1.5">
<Button
size="sm"
class="flex-1 h-7 text-[11px] gap-1.5"
:disabled="uploading || localFiles.length === 0"
@click="uploadSelected"
>
<Loader2 v-if="uploading" class="size-3 animate-spin" />
<ArrowUpFromLine v-else class="size-3" />
上传{{ localFiles.length > 1 ? ` (${localFiles.length})` : '' }}
</Button>
<Button
v-if="localFiles.length > 0"
variant="ghost"
size="sm"
class="h-7 px-1.5 text-[11px]"
@click="clearLocalFiles"
>
清空
</Button>
</div>
</section>
<!-- ---------- 远端栏 ---------- -->
<section class="flex-1 min-w-0 flex flex-col">
<div class="shrink-0 h-7 px-2 flex items-center gap-1.5 border-b border-border bg-muted/40">
<Server class="size-3 text-muted-foreground" />
<span class="text-[11px] font-medium">远端</span>
<div class="flex-1" />
<label class="flex items-center gap-1 text-[10px] text-muted-foreground cursor-pointer select-none">
<input v-model="following" type="checkbox" class="size-3 accent-primary" />
跟随 cd
</label>
</div>
<!-- 工具条 -->
<div class="shrink-0 px-2 py-1.5 flex items-center gap-1 border-b border-border">
<Button
variant="ghost"
size="sm"
class="h-6 w-6 p-0"
title="上一级"
:disabled="remoteCwd === '/' || !remoteCwd"
@click="goUp"
>
<CornerUpLeft class="size-3.5" />
</Button>
<Button
variant="ghost"
size="sm"
class="h-6 w-6 p-0"
title="刷新"
@click="loadRemote(remoteCwd)"
>
<RefreshCw class="size-3.5" />
</Button>
<Button
variant="ghost"
size="sm"
class="h-6 w-6 p-0"
title="新建目录"
@click="showNewDir = !showNewDir"
>
<FolderPlus class="size-3.5" />
</Button>
<Button
variant="ghost"
size="sm"
class="h-6 w-6 p-0"
title="重命名"
:disabled="!selectedRemote"
@click="startRename"
>
<FileIcon class="size-3.5" />
</Button>
<Button
variant="ghost"
size="sm"
class="h-6 w-6 p-0 text-destructive"
title="删除"
:disabled="!selectedRemote"
@click="removeRemote"
>
<Trash2 class="size-3.5" />
</Button>
<div class="flex-1" />
<Input
v-model="remoteFilter"
placeholder="筛选…"
class="h-6 w-32 text-[11px]"
/>
</div>
<!-- 新建目录输入 -->
<div v-if="showNewDir" class="shrink-0 px-2 py-1.5 flex items-center gap-1.5 border-b border-border">
<Input
v-model="newDirName"
placeholder="新目录名"
class="h-6 flex-1 text-[11px]"
@keydown.enter="createFolder"
@keydown.esc="showNewDir = false"
/>
<Button size="sm" class="h-6 text-[11px]" @click="createFolder">创建</Button>
</div>
<!-- 面包屑 -->
<div class="shrink-0 px-2 py-1 flex items-center gap-0.5 text-[11px] border-b border-border overflow-x-auto whitespace-nowrap">
<button class="hover:text-primary shrink-0" @click="loadRemote('/')">/</button>
<template v-for="c in crumbs" :key="c.path">
<ChevronRight class="size-3 shrink-0 text-muted-foreground/50" />
<button class="hover:text-primary shrink-0" @click="loadRemote(c.path)">{{ c.name }}</button>
</template>
</div>
<!-- 列表 -->
<div class="flex-1 min-h-0 overflow-auto">
<div v-if="remoteLoading" class="p-4 flex items-center justify-center gap-2">
<Loader2 class="size-3.5 animate-spin text-muted-foreground" />
<span class="text-[11px] text-muted-foreground">正在读取</span>
</div>
<div v-else-if="remoteError" class="p-4">
<p class="text-[11px] text-destructive break-all">{{ remoteError }}</p>
</div>
<div v-else-if="filteredRemote.length === 0" class="p-4 text-center">
<p class="text-[11px] text-muted-foreground/70">
{{ remoteEntries.length === 0 ? '空目录' : '无匹配项' }}
</p>
</div>
<table v-else class="w-full text-[11px] border-collapse">
<thead class="sticky top-0 bg-background z-10">
<tr class="text-muted-foreground text-left">
<th class="font-normal px-2 py-1 border-b border-border">名称</th>
<th class="font-normal px-2 py-1 border-b border-border w-20 text-right">大小</th>
<th class="font-normal px-2 py-1 border-b border-border w-28 hidden md:table-cell">修改时间</th>
<th class="font-normal px-2 py-1 border-b border-border w-14 text-right">权限</th>
</tr>
</thead>
<tbody>
<tr
v-for="e in filteredRemote"
:key="e.path"
class="hover:bg-accent cursor-default select-none"
:class="selectedRemote?.path === e.path ? 'bg-accent' : ''"
@click="selectedRemote = e"
@dblclick="enterRemote(e)"
>
<td class="px-2 py-1">
<div class="flex items-center gap-1.5 min-w-0">
<component
:is="entryIcon(e)"
class="size-3 shrink-0"
:class="e.kind === 'dir' ? 'text-amber-500' : 'text-muted-foreground'"
/>
<template v-if="renaming && selectedRemote?.path === e.path">
<input
v-model="renameValue"
class="flex-1 h-5 px-1 text-[11px] rounded border border-primary/60 bg-transparent outline-none"
@click.stop
@keydown.enter="submitRename"
@keydown.esc="renaming = false"
/>
</template>
<template v-else>
<span class="truncate" :title="e.kind === 'symlink' ? `${e.path} → ${e.linkTarget}` : e.path">
{{ e.name }}
</span>
<span
v-if="e.kind === 'symlink' && e.linkTarget"
class="text-muted-foreground/60 truncate shrink-0 max-w-[40%]"
>
{{ e.linkTarget }}
</span>
</template>
</div>
</td>
<td class="px-2 py-1 text-right text-muted-foreground tabular-nums">
{{ e.kind === 'dir' ? '—' : humanSize(e.size) }}
</td>
<td class="px-2 py-1 text-muted-foreground hidden md:table-cell tabular-nums">
{{ fmtTime(e.modifiedAt) }}
</td>
<td class="px-2 py-1 text-right text-muted-foreground font-mono">
{{ e.permissions || '—' }}
</td>
</tr>
</tbody>
</table>
</div>
<!-- 远端操作条 -->
<div class="shrink-0 p-2 border-t border-border flex items-center gap-1.5">
<span class="text-[10px] text-muted-foreground truncate flex-1" :title="selectedRemote?.path">
{{ selectedRemote ? selectedRemote.path : `${filteredRemote.length}` }}
</span>
<Button
variant="outline"
size="sm"
class="h-7 text-[11px] gap-1.5"
:disabled="downloading || !selectedRemote || selectedRemote.kind === 'dir'"
@click="downloadSelected"
>
<Loader2 v-if="downloading" class="size-3 animate-spin" />
<ArrowDownToLine v-else class="size-3" />
另存为
</Button>
<Button
size="sm"
class="h-7 text-[11px] gap-1.5"
:disabled="downloading || !selectedRemote || selectedRemote.kind === 'dir' || !localDir"
@click="downloadToLocalDir"
>
<ArrowDownToLine class="size-3" />
下载到本地目录
</Button>
</div>
</section>
</div>
<!-- ===== 传输进度 ===== -->
<div v-if="activeTransfers.length > 0" class="shrink-0 border-t border-border max-h-28 overflow-auto">
<div
v-for="t in activeTransfers"
:key="t.id"
class="px-2.5 py-1.5 flex items-center gap-2 text-[11px] border-b border-border/50 last:border-b-0"
>
<component
:is="t.direction === 'upload' ? ArrowUpFromLine : ArrowDownToLine"
class="size-3 shrink-0"
:class="t.state === 'failed' ? 'text-destructive' : 'text-muted-foreground'"
/>
<span class="truncate flex-1" :title="`${t.source} → ${t.target}`">
{{ baseName(t.source) }}
<span class="text-muted-foreground/60"> {{ baseName(t.target) }}</span>
</span>
<div v-if="t.state === 'running'" class="w-24 h-1 rounded-full bg-muted overflow-hidden shrink-0">
<div
class="h-full bg-primary transition-[width] duration-200"
:style="{ width: t.total > 0 ? `${Math.min(100, (t.transferred / t.total) * 100)}%` : '0%' }"
/>
</div>
<span class="text-muted-foreground tabular-nums shrink-0 w-24 text-right">
<template v-if="t.state === 'running'">
{{ t.total > 0 ? `${humanSize(t.transferred)} / ${humanSize(t.total)}` : humanSize(t.transferred) }}
</template>
<span v-else-if="t.state === 'done'" class="text-emerald-600">完成</span>
<span v-else-if="t.state === 'failed'" class="text-destructive" :title="t.error ?? ''">失败</span>
<span v-else>{{ t.state }}</span>
</span>
<button
class="text-muted-foreground hover:text-foreground shrink-0"
title="从列表移除"
@click="store.dismissTransfer(t.id)"
>
<X class="size-3" />
</button>
</div>
</div>
</div>
</template>
@@ -0,0 +1,573 @@
<script setup lang="ts">
/**
* 命令片段面板浮层
*
* # 交互模型先填参数再决定是否执行
*
* 带占位符的片段走填写 预览 执行三步预览这一步不是装饰
* 用户能在这里看到**渲染后的真实命令**而执行按钮分两个
* 填入命令行不回车直接执行危险片段`confirm` true
* 默认只做前者让用户自己按回车与命令被自动执行在心理上完全不同
*
* # 为什么占位符列表来自后端
*
* 解析规则`$${x}` 转义`${VAR:-default}` 排除名称字符集 Rust
* `snippet_placeholders` 单独实现一份前端若自己写正则两边在边界情况上
* 迟早分叉 预览显示的命令实际执行的命令不一致是最坏的结果
*/
import { computed, ref } from 'vue'
import { open as openDialog } from '@tauri-apps/plugin-dialog'
import {
BookMarked,
Play,
Pin,
Plus,
RotateCcw,
Search,
ShieldAlert,
Terminal,
Trash2,
X
} from '@lucide/vue'
import { toast } from 'vue-sonner'
import { useTerminalStore } from '@/stores/terminalStore'
import { createLogger } from '@/lib/logger'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'
import type { CommandSnippet, SessionInfo, SnippetView } from '@/types/terminal'
const props = defineProps<{
sessionId: string | null
session: SessionInfo | undefined
}>()
const emit = defineEmits<{
(e: 'close'): void
}>()
const logger = createLogger('terminal')
const store = useTerminalStore()
const filter = ref('')
const selected = ref<SnippetView | null>(null)
/** 会话是 SSH 还是本地(决定哪些片段可见) */
const sessionKind = computed<'local' | 'ssh'>(() => props.session?.kind ?? 'local')
/** 本地会话对应的 shell kind(用于 `shellKinds` 过滤) */
const shellKind = computed(() => store.shellOf(props.session)?.kind)
/** 当前会话可用的片段 */
const available = computed(() => store.snippetsForSession(sessionKind.value, shellKind.value))
const filtered = computed(() => {
const kw = filter.value.trim().toLowerCase()
if (!kw) return available.value
return available.value.filter(
s =>
s.name.toLowerCase().includes(kw) ||
s.command.toLowerCase().includes(kw) ||
s.description.toLowerCase().includes(kw)
)
})
/** 按分组归类(保持 store 的排序:置顶优先 + 名称序) */
const grouped = computed(() => {
const map = new Map<string, SnippetView[]>()
for (const s of filtered.value) {
const g = s.group.trim() || '未分组'
if (!map.has(g)) map.set(g, [])
map.get(g)!.push(s)
}
return [...map.entries()]
})
// ===== =====
/** 占位符名 → 当前填写值 */
const values = ref<Record<string, string>>({})
/** 渲染后的命令(每次 preview 后更新) */
const preview = ref('')
const rendering = ref(false)
function select(s: SnippetView) {
selected.value = s
preview.value = ''
//
const v: Record<string, string> = {}
for (const k of s.placeholders) v[k] = s.defaults[k] ?? ''
values.value = v
}
const missing = computed(() => {
const s = selected.value
if (!s) return []
return s.placeholders.filter(k => !(values.value[k] ?? '').trim())
})
async function doRender() {
const s = selected.value
if (!s) return
if (missing.value.length > 0) {
toast.error(`还有 ${missing.value.length} 个占位符未填写`)
return
}
rendering.value = true
try {
preview.value = await store.renderSnippet(s.id, values.value)
} catch (e) {
toast.error(String(e))
preview.value = ''
} finally {
rendering.value = false
}
}
/**
* 执行片段
*
* `submit = true` 直接回车执行否则只写到命令行上
* 危险片段`confirm`在界面上不提供直接执行按钮
* 但这里仍做一层兜底见下面对 `mustConfirm` 的判断
*/
async function run(submit: boolean) {
const s = selected.value
if (!s || !props.sessionId) {
toast.info('请先打开一个会话')
return
}
if (missing.value.length > 0) {
toast.error('请先填写全部占位符')
return
}
//
try {
const rendered = await store.renderSnippet(s.id, values.value)
preview.value = rendered
} catch (e) {
toast.error(String(e))
return
}
try {
const r = await store.runSnippet(props.sessionId, s.id, values.value, submit)
if (submit) toast.success(r.message)
else toast.info(r.message)
} catch (e) {
toast.error(`执行失败:${String(e)}`)
}
}
/** 危险片段强制执行一次确认(界面已限制,这是兜底) */
function confirmThenRun() {
const s = selected.value
if (!s) return
if (s.confirm && !window.confirm(`${s.name}」被标记为需要确认的命令,确定执行?`)) return
void run(true)
}
// ===== =====
const editing = ref(false)
const draft = ref<CommandSnippet | null>(null)
function newSnippet() {
draft.value = {
id: '',
name: '',
command: '',
description: '',
group: '',
defaults: {},
shellKinds: [],
sshOnly: false,
confirm: false,
pinned: false,
createdAt: 0
}
editing.value = true
}
function editSelected() {
const s = selected.value
if (!s) return
// placeholders CommandSnippet
// save serde
const { placeholders: _p, ...rest } = s
draft.value = { ...rest }
editing.value = true
}
async function submitDraft() {
const d = draft.value
if (!d) return
if (!d.name.trim()) {
toast.error('名称不能为空')
return
}
if (!d.command.trim()) {
toast.error('命令内容不能为空')
return
}
try {
await store.saveSnippet(d)
editing.value = false
toast.success('已保存')
//
const fresh = store.snippets.find(s => s.id === (d.id || store.snippets[store.snippets.length - 1]?.id))
if (fresh) select(fresh)
} catch (e) {
toast.error(`保存失败:${String(e)}`)
}
}
async function removeSelected() {
const s = selected.value
if (!s) return
if (!window.confirm(`确定删除片段「${s.name}」?`)) return
try {
await store.deleteSnippet(s.id)
selected.value = null
toast.success('已删除')
} catch (e) {
toast.error(`删除失败:${String(e)}`)
}
}
async function togglePin() {
const s = selected.value
if (!s) return
try {
const { placeholders: _p, ...rest } = s
await store.saveSnippet({ ...rest, pinned: !s.pinned })
const fresh = store.snippets.find(x => x.id === s.id)
if (fresh) select(fresh)
} catch (e) {
toast.error(`操作失败:${String(e)}`)
}
}
async function restoreDefaults() {
if (!window.confirm('将补回缺失的内置片段(不会覆盖你已有的条目),继续?')) return
try {
await store.restoreDefaultSnippets()
toast.success('已恢复内置片段')
} catch (e) {
toast.error(`恢复失败:${String(e)}`)
}
}
/** 从本地文件导入命令文本(省去逐字敲长命令) */
async function importFromFile() {
try {
const picked = await openDialog({
multiple: false,
directory: false,
filters: [{ name: '文本/脚本', extensions: ['txt', 'sh', 'bash', 'zsh', 'ps1', 'cmd', 'bat'] }]
})
if (typeof picked !== 'string') return
// CSP WebView
// P2
draft.value = {
id: '',
name: picked.replace(/\\/g, '/').split('/').pop() ?? '导入的片段',
command: '',
description: `待粘贴内容(来源:${picked}`,
group: '导入',
defaults: {},
shellKinds: [],
sshOnly: false,
confirm: true,
pinned: false,
createdAt: 0
}
editing.value = true
toast.info('请把命令内容粘贴到「命令」框中')
void logger
} catch (e) {
toast.error(`导入失败:${String(e)}`)
}
}
</script>
<template>
<!-- 作为模块 Tab 内容渲染根不再是全屏浮层 -->
<div class="flex flex-col h-full">
<!-- ===== 头部 ===== -->
<div class="shrink-0 flex items-center gap-2 px-3 h-9 border-b border-border">
<Button variant="ghost" size="sm" class="h-7 text-xs" @click="emit('close')">返回终端</Button>
<div class="w-px h-4 bg-border" />
<BookMarked class="size-3.5 text-muted-foreground" />
<span class="text-xs font-medium">命令片段</span>
<span class="text-[10px] text-muted-foreground">
{{ session ? `作用于 ${store.sessionLabel(session)}` : '未选择会话' }}
</span>
<div class="flex-1" />
<Button variant="outline" size="sm" class="h-7 text-xs gap-1.5" @click="importFromFile">
从文件导入
</Button>
<Button variant="outline" size="sm" class="h-7 text-xs gap-1.5" @click="restoreDefaults">
<RotateCcw class="size-3" />恢复内置
</Button>
<Button size="sm" class="h-7 text-xs gap-1.5" @click="newSnippet">
<Plus class="size-3" />新建片段
</Button>
</div>
<div class="flex-1 min-h-0 flex">
<!-- ===== 列表 ===== -->
<section class="w-[300px] shrink-0 border-r border-border flex flex-col">
<div class="shrink-0 p-2 border-b border-border">
<div class="relative">
<Search class="absolute left-2 top-1/2 -translate-y-1/2 size-3 text-muted-foreground" />
<Input v-model="filter" placeholder="搜索片段…" class="h-7 pl-7 text-xs" />
</div>
</div>
<div class="flex-1 min-h-0 overflow-auto">
<div v-if="filtered.length === 0" class="p-4 text-center">
<p class="text-[11px] text-muted-foreground/70">
{{ available.length === 0 ? '当前会话没有可用的片段' : '无匹配项' }}
</p>
</div>
<template v-else>
<div v-for="[group, list] in grouped" :key="group">
<div class="px-2.5 py-1 text-[10px] font-medium text-muted-foreground bg-muted/40 sticky top-0">
{{ group }}
</div>
<button
v-for="s in list"
:key="s.id"
class="w-full text-left px-2.5 py-1.5 hover:bg-accent border-l-2 transition-colors"
:class="selected?.id === s.id ? 'bg-accent border-primary' : 'border-transparent'"
@click="select(s)"
>
<div class="flex items-center gap-1.5">
<Pin v-if="s.pinned" class="size-2.5 text-amber-500 shrink-0" />
<span class="text-[11px] font-medium truncate">{{ s.name }}</span>
<ShieldAlert v-if="s.confirm" class="size-2.5 text-destructive shrink-0" />
</div>
<div class="text-[10px] text-muted-foreground truncate font-mono mt-0.5">
{{ s.command }}
</div>
</button>
</div>
</template>
</div>
</section>
<!-- ===== 详情 / 参数填写 / 编辑 ===== -->
<section class="flex-1 min-w-0 flex flex-col overflow-auto">
<!-- ---------- 编辑态 ---------- -->
<div v-if="editing && draft" class="p-4 space-y-3 max-w-2xl">
<h3 class="text-sm font-medium">{{ draft.id ? '编辑片段' : '新建片段' }}</h3>
<label class="block space-y-1">
<span class="text-[11px] text-muted-foreground">名称</span>
<Input v-model="draft.name" class="h-7 text-xs" placeholder="如:查找大文件" />
</label>
<label class="block space-y-1">
<span class="text-[11px] text-muted-foreground">
命令 <code class="font-mono">${name}</code> 表示占位符
需要字面量时写 <code class="font-mono">$${name}</code>
</span>
<textarea
v-model="draft.command"
rows="3"
class="w-full px-2 py-1.5 rounded-md border border-border bg-transparent
text-xs font-mono outline-none focus:border-primary/60 resize-y"
placeholder="find ${dir} -type f -size +${size}"
/>
</label>
<label class="block space-y-1">
<span class="text-[11px] text-muted-foreground">说明讲清做什么有什么前提</span>
<Input v-model="draft.description" class="h-7 text-xs" />
</label>
<div class="grid grid-cols-2 gap-3">
<label class="block space-y-1">
<span class="text-[11px] text-muted-foreground">分组</span>
<Input v-model="draft.group" class="h-7 text-xs" placeholder="如:文件 / 运维" />
</label>
<label class="block space-y-1">
<span class="text-[11px] text-muted-foreground">
适用 shell逗号分隔留空表示全部
</span>
<Input
:model-value="draft.shellKinds.join(',')"
class="h-7 text-xs"
placeholder="powershell,bash"
@update:model-value="v => draft && (draft.shellKinds = String(v).split(',').map(x => x.trim()).filter(Boolean))"
/>
</label>
</div>
<div class="flex items-center gap-4 text-[11px]">
<label class="flex items-center gap-1.5 cursor-pointer select-none">
<input v-model="draft.sshOnly" type="checkbox" class="size-3 accent-primary" />
SSH 会话可用
</label>
<label class="flex items-center gap-1.5 cursor-pointer select-none">
<input v-model="draft.confirm" type="checkbox" class="size-3 accent-primary" />
执行前需确认危险命令
</label>
<label class="flex items-center gap-1.5 cursor-pointer select-none">
<input v-model="draft.pinned" type="checkbox" class="size-3 accent-primary" />
置顶
</label>
</div>
<div
v-if="draft.confirm"
class="flex items-start gap-2 p-2 rounded border border-destructive/40 bg-destructive/5"
>
<ShieldAlert class="size-3.5 text-destructive shrink-0 mt-0.5" />
<p class="text-[11px] text-muted-foreground leading-relaxed">
标记为需确认的片段默认只会**填入命令行**不会自动执行
用户需要自己按回车这避免了参数误填时立刻造成破坏
</p>
</div>
<div class="flex items-center gap-2 pt-1">
<Button size="sm" class="h-7 text-xs" @click="submitDraft">保存</Button>
<Button variant="outline" size="sm" class="h-7 text-xs" @click="editing = false">取消</Button>
</div>
</div>
<!-- ---------- 详情态 ---------- -->
<div v-else-if="selected" class="p-4 space-y-3 max-w-2xl">
<div class="flex items-center gap-2">
<h3 class="text-sm font-medium">{{ selected.name }}</h3>
<button
class="text-muted-foreground hover:text-foreground"
:title="selected.pinned ? '取消置顶' : '置顶'"
@click="togglePin"
>
<Pin class="size-3.5" :class="selected.pinned ? 'text-amber-500' : ''" />
</button>
<div class="flex-1" />
<Button variant="ghost" size="sm" class="h-6 text-[11px]" @click="editSelected">编辑</Button>
<Button
variant="ghost"
size="sm"
class="h-6 text-[11px] text-destructive"
@click="removeSelected"
>
<Trash2 class="size-3" />
</Button>
</div>
<p v-if="selected.description" class="text-[11px] text-muted-foreground leading-relaxed">
{{ selected.description }}
</p>
<div class="rounded-md border border-border bg-muted/30 p-2">
<div class="text-[10px] text-muted-foreground mb-1">命令模板</div>
<pre class="text-[11px] font-mono whitespace-pre-wrap break-all">{{ selected.command }}</pre>
</div>
<!-- 占位符填写 -->
<div v-if="selected.placeholders.length > 0" class="space-y-2">
<div class="text-[11px] font-medium">参数</div>
<div
v-for="p in selected.placeholders"
:key="p"
class="flex items-center gap-2"
>
<span class="text-[11px] font-mono text-muted-foreground w-24 shrink-0 truncate" :title="p">
${ {{ p }} }
</span>
<Input
v-model="values[p]"
class="h-7 text-xs font-mono flex-1"
:placeholder="selected.defaults[p] || '(必填)'"
@keydown.enter="doRender"
/>
</div>
</div>
<!-- 预览 -->
<div class="space-y-1.5">
<div class="flex items-center gap-2">
<span class="text-[11px] font-medium">预览</span>
<Button
variant="outline"
size="sm"
class="h-6 text-[11px]"
:disabled="rendering"
@click="doRender"
>
生成预览
</Button>
<span v-if="missing.length > 0" class="text-[10px] text-amber-600">
还有 {{ missing.length }} 个未填写
</span>
</div>
<pre
v-if="preview"
class="rounded-md border border-border bg-muted/30 p-2 text-[11px] font-mono
whitespace-pre-wrap break-all"
>{{ preview }}</pre>
<p v-else class="text-[11px] text-muted-foreground/60">生成预览查看实际会执行的命令</p>
</div>
<!-- 执行 -->
<div class="flex items-center gap-2 pt-1">
<Button
variant="outline"
size="sm"
class="h-7 text-xs gap-1.5"
:disabled="!sessionId"
@click="run(false)"
>
<Terminal class="size-3" />填入命令行
</Button>
<Button
size="sm"
class="h-7 text-xs gap-1.5"
:disabled="!sessionId || selected.confirm"
:title="selected.confirm ? '该片段被标记为需确认,请用「确认并执行」' : ''"
@click="run(true)"
>
<Play class="size-3" />直接执行
</Button>
<Button
v-if="selected.confirm"
variant="destructive"
size="sm"
class="h-7 text-xs gap-1.5"
:disabled="!sessionId"
@click="confirmThenRun"
>
<ShieldAlert class="size-3" />确认并执行
</Button>
</div>
</div>
<!-- ---------- 空态 ---------- -->
<div v-else class="flex-1 flex items-center justify-center">
<div class="text-center">
<BookMarked class="size-10 text-muted-foreground/20 mx-auto mb-3" />
<p class="text-xs text-muted-foreground mb-1">从左侧选择一个片段</p>
<p class="text-[11px] text-muted-foreground/60">
或点新建片段加入自己的常用命令
</p>
</div>
</div>
</section>
</div>
<!-- 悬浮关闭按钮右上角已有返回终端这里给键盘外的第二入口 -->
<button
class="absolute top-2 right-2 size-6 rounded flex items-center justify-center
text-muted-foreground hover:text-foreground"
title="关闭"
@click="emit('close')"
>
<X class="size-3.5" />
</button>
</div>
</template>
@@ -0,0 +1,184 @@
<script setup lang="ts">
/**
* 会话模板面板P2一键拉起一组会话 + 布局
*
* # 模板的捕获语义
*
* 保存当前布局捕获的是**当前可见的面板集合**`paneIds`
* 而不是全部会话 用户对着屏幕说我要的就是现在这个样子
* 屏幕上看得见的就是全部语义拉起时按相同顺序重建
* 1 个作主面板其余加分屏超上限的条目被忽略
*
* # 为什么拉起逻辑在 TerminalModule 而不在这里
*
* 开会话newSshTab / newLocalTab与布局addPane / resetPanesTo
* 都是编排组合函数的状态 TerminalModule 所有本组件只负责
* 模板的增删与展示`apply` 事件把模板交回去
*/
import { computed, ref } from 'vue'
import { LayoutTemplate, Play, Plus, Trash2 } from '@lucide/vue'
import { toast } from 'vue-sonner'
import { useTerminalStore } from '@/stores/terminalStore'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'
import { Label } from '@/components/ui/label'
import {
Dialog,
DialogContent,
DialogDescription,
DialogHeader,
DialogTitle
} from '@/components/ui/dialog'
import type { SessionTemplate, TemplateEntry } from '@/types/terminal'
const store = useTerminalStore()
const props = defineProps<{
open: boolean
/** 当前可见面板的会话 id(用于「保存当前布局」),按显示顺序 */
paneIds: string[]
}>()
const emit = defineEmits<{
(e: 'update:open', v: boolean): void
/** 用户点击「拉起」:交出模板,由 TerminalModule 执行开会话 + 布局 */
(e: 'apply', template: SessionTemplate): void
}>()
const templates = computed(() => store.settings?.templates ?? [])
const newName = ref('')
const saving = ref(false)
/** 从当前可见面板构造条目(会话不存在时跳过并提示) */
function captureEntries(): TemplateEntry[] | null {
const out: TemplateEntry[] = []
for (const id of props.paneIds) {
const s = store.sessionById(id)
if (!s) continue
out.push({
kind: s.kind,
targetId: s.targetId,
label: s.title
})
}
if (out.length === 0) {
toast.error('当前没有可捕获的会话面板')
return null
}
if (out.length > 4) {
toast.error('当前布局超过 4 个面板,无法保存为模板(上限 4)')
return null
}
return out
}
async function saveCurrent() {
const entries = captureEntries()
if (!entries) return
const name = newName.value.trim()
if (!name) {
toast.error('请填写模板名称')
return
}
saving.value = true
try {
await store.saveTemplate({ id: '', name, createdAt: 0, entries })
newName.value = ''
toast.success(`模板「${name}」已保存`)
} catch (e) {
toast.error(`保存失败:${String(e)}`)
} finally {
saving.value = false
}
}
async function removeOne(t: SessionTemplate) {
try {
await store.deleteTemplate(t.id)
toast.success(`模板「${t.name}」已删除`)
} catch (e) {
toast.error(`删除失败:${String(e)}`)
}
}
function apply(t: SessionTemplate) {
emit('apply', t)
emit('update:open', false)
}
/** 条目展示名:target 失效时给出可辨识的标注(拉起时该条目会失败) */
function entryLabel(t: SessionTemplate): string {
return t.entries
.map(e => {
const alive =
e.kind === 'ssh'
? store.hosts.some(h => h.config.id === e.targetId)
: store.shells.some(sh => sh.id === e.targetId)
return alive ? e.label : `${e.label || '未知目标'}(已失效)`
})
.join(' + ')
}
</script>
<template>
<Dialog :open="open" @update:open="v => emit('update:open', v)">
<DialogContent class="max-w-lg">
<DialogHeader>
<DialogTitle class="flex items-center gap-2 text-base">
<LayoutTemplate class="size-4" />会话模板
</DialogTitle>
<DialogDescription class="text-xs">
把常用的一组会话存成模板一键拉起并自动排好布局
</DialogDescription>
</DialogHeader>
<!-- ===== 模板列表 ===== -->
<div class="space-y-1.5 min-h-[60px]">
<p v-if="templates.length === 0" class="text-xs text-muted-foreground">
还没有模板先摆好想要的分屏布局然后在下方保存为模板
</p>
<div
v-for="t in templates"
:key="t.id"
class="flex items-center gap-2 rounded border border-border px-2.5 py-1.5"
>
<div class="min-w-0 flex-1">
<p class="text-xs font-medium truncate">{{ t.name }}</p>
<p class="text-[10px] text-muted-foreground truncate">{{ entryLabel(t) }}</p>
</div>
<Button variant="outline" size="sm" class="h-7 gap-1 text-xs shrink-0" @click="apply(t)">
<Play class="size-3" />拉起
</Button>
<Button
variant="ghost"
size="sm"
class="h-7 w-7 p-0 text-destructive hover:text-destructive shrink-0"
title="删除模板"
@click="removeOne(t)"
>
<Trash2 class="size-3.5" />
</Button>
</div>
</div>
<!-- ===== 保存当前布局 ===== -->
<div class="space-y-2 rounded-md border border-border p-3">
<Label class="text-[11px] text-muted-foreground">
保存当前布局{{ paneIds.length }} 个面板取前 4
</Label>
<div class="flex gap-1.5">
<Input
v-model="newName"
placeholder="模板名称,例如:开发环境"
class="h-8 text-sm flex-1"
@keydown.enter="saveCurrent"
/>
<Button size="sm" class="h-8 gap-1 text-xs shrink-0" :disabled="saving" @click="saveCurrent">
<Plus class="size-3.5" />{{ saving ? '保存中…' : '保存' }}
</Button>
</div>
</div>
</DialogContent>
</Dialog>
</template>
@@ -0,0 +1,217 @@
<script setup lang="ts">
/**
* 终端面板一个 xterm 实例 一个会话
*
* 这是整条链路的汇合点Rust 的字节流xterm 的渲染键盘输入的回传
* 都在这里对接其余组件标签栏侧栏工具栏都只是它的外围装饰
*
* # 为什么不在卸载时关闭会话
*
* 组件卸载的触发场景很多切标签切模块关闭独立窗口**没有一个是
* 用户想结束这个会话**真正的结束只有两条路径显式点关闭按钮
* shell 自己退出把组件生命周期与会话生命周期绑定会导致切标签就断连
*/
import { computed, onMounted, ref, toRef, watch, nextTick } from 'vue'
import { useTerminalStore } from '@/stores/terminalStore'
import { useXterm } from '@/composables/useXterm'
import { resolveTheme } from '@/lib/terminalThemes'
import type { AppearanceSettings } from '@/types/terminal'
const props = defineProps<{
sessionId: string
appearance: AppearanceSettings | null
/** 面板是否可见(非激活标签为 false;不可见时应挂起渲染压力) */
visible: boolean
}>()
const emit = defineEmits<{
/** 面板内的右键菜单请求(由父组件统一渲染菜单位置) */
(e: 'contextmenu', payload: { sessionId: string; x: number; y: number }): void
/** 面板获得焦点(父组件据此更新 activeSessionId */
(e: 'focus', sessionId: string): void
}>()
const store = useTerminalStore()
const containerRef = ref<HTMLElement | null>(null)
const sessionInfo = computed(() => store.sessionById(props.sessionId))
/** 会话已结束 → 面板转为只读回放 */
const isReadonly = computed(() => {
const s = sessionInfo.value?.state
return s === 'closed' || s === 'failed'
})
const {
hasOutput,
createTerminal,
focus,
fit,
getSelection,
clear,
scrollToBottom,
selectAll,
selectWordAt,
findNext,
findPrevious,
clearSearch
} = useXterm({
container: containerRef,
sessionId: toRef(props, 'sessionId'),
appearance: toRef(props, 'appearance'),
readonly: isReadonly
})
// ===== =====
onMounted(async () => {
// nextTick v-if DOM
await nextTick()
createTerminal()
})
// fit
// offsetWidth/offsetHeight 0fit 0 0
// 线
watch(
() => props.visible,
async v => {
if (!v) return
await nextTick()
fit()
focus()
}
)
// ===== =====
function onMouseDown() {
emit('focus', props.sessionId)
}
function onContextMenu(e: MouseEvent) {
e.preventDefault()
emit('contextmenu', { sessionId: props.sessionId, x: e.clientX, y: e.clientY })
}
/** 状态徽标文案与配色 */
const stateBadge = computed(() => {
const s = sessionInfo.value?.state
switch (s) {
case 'connecting':
return { text: '连接中', cls: 'bg-amber-500/15 text-amber-600 dark:text-amber-400' }
case 'authenticating':
return { text: '认证中', cls: 'bg-amber-500/15 text-amber-600 dark:text-amber-400' }
case 'established':
return { text: '已连接', cls: 'bg-emerald-500/15 text-emerald-600 dark:text-emerald-400' }
case 'degraded':
return { text: '不稳定', cls: 'bg-orange-500/15 text-orange-600 dark:text-orange-400' }
case 'closed':
return { text: '已结束', cls: 'bg-muted text-muted-foreground' }
case 'failed':
return { text: '失败', cls: 'bg-red-500/15 text-red-600 dark:text-red-400' }
default:
return { text: '空闲', cls: 'bg-muted text-muted-foreground' }
}
})
/** 失败原因(展示在面板中央,比只在日志里更有用) */
const errorText = computed(() => sessionInfo.value?.error ?? '')
/**
* 面板背景色 = 当前终端主题的 background
*
* 之前 `--terminal-bg` 只在 CSS 里给了一个近黑色的回退值而**从未被赋值**
* 浅色主题下 xterm 屏幕是浅色但容器的 padding 4px/ 6px与行列取整
* 的边缘露出的是这个深色底 表现为终端四周固定的黑线跟随主题后
* 露出的部分与屏幕同色视觉上无缝
*/
const paneBackground = computed(() => {
const theme = resolveTheme(props.appearance?.theme ?? 'vscode-dark')
return theme.background ?? '#1e1e1e'
})
defineExpose({
focus,
fit,
getSelection,
clear,
scrollToBottom,
/** 全选当前缓冲内容(右键菜单用) */
selectAll,
/** 选中指定屏幕坐标处的词(右键「选择词语」用) */
selectWordAt,
/** 在滚动缓冲里查找(返回是否命中),供工具栏搜索使用 */
findNext,
findPrevious,
clearSearch
})
</script>
<template>
<div
class="relative h-full w-full overflow-hidden"
:style="{ backgroundColor: paneBackground }"
@mousedown="onMouseDown"
@contextmenu="onContextMenu"
>
<!-- xterm 挂载点不加 paddingxterm 自己会算内边距
外面套 padding 会让 fit 算出的行列数与实际渲染尺寸不一致导致右侧被裁切 -->
<div ref="containerRef" class="h-full w-full" />
<!-- 连接中/首个输出未到的加载态盖在终端上避免用户看到一片空白 -->
<div
v-if="!hasOutput && sessionInfo && sessionInfo.state !== 'established'"
class="absolute inset-0 flex items-center justify-center pointer-events-none"
>
<div class="flex flex-col items-center gap-3 px-6 text-center">
<div
class="size-5 rounded-full border-2 border-muted-foreground/30 border-t-foreground animate-spin"
/>
<p class="text-xs text-muted-foreground">
{{ sessionInfo.state === 'failed' ? '连接失败' : '正在建立连接…' }}
</p>
<p v-if="errorText" class="max-w-md text-xs text-red-500 leading-relaxed">
{{ errorText }}
</p>
</div>
</div>
<!-- 会话已结束的角标保留回放内容提示这是因为进程退出而非断线 -->
<div
v-if="isReadonly && hasOutput"
class="absolute top-2 right-2 px-2 py-0.5 rounded text-[10px] pointer-events-none"
:class="stateBadge.cls"
>
{{ stateBadge.text }}
</div>
</div>
</template>
<style scoped>
/* xterm v6 .xterm-scrollable-element
.xterm-viewport 仍是 xterm.css 的默认 background-color:#000且不再被
主题覆盖 网格未覆盖的边缘padding行列取整露出这层纯黑浅色
主题下表现为固定的黑线粗细随行列取整变化置为透明后由面板根元素
已绑定主题 background透出任意主题下无缝 */
:deep(.xterm-viewport) {
background-color: transparent !important;
scrollbar-width: thin;
}
:deep(.xterm-viewport)::-webkit-scrollbar {
width: 8px;
height: 8px;
}
:deep(.xterm-viewport)::-webkit-scrollbar-thumb {
background: color-mix(in srgb, currentColor 25%, transparent);
border-radius: 4px;
}
:deep(.xterm-viewport)::-webkit-scrollbar-thumb:hover {
background: color-mix(in srgb, currentColor 40%, transparent);
}
/* xterm 的 screen 默认会撑出父容器,这里强制贴合 */
:deep(.xterm) {
height: 100%;
padding: 4px 0 4px 6px;
}
</style>
@@ -0,0 +1,922 @@
<script setup lang="ts">
/**
* 终端设置面板
*
* # 五个分区的划分依据
*
* | 分区 | 回答的问题 |
* |---|---|
* | 外观 | 终端长什么样 |
* | 行为 | 终端和鼠标/剪贴板怎么互动 |
* | 布局 | 窗口怎么组织 |
* | 快捷键 | 键盘能做什么 |
* | 安全 | 什么情况下应该拦住我 |
*
* # 保存策略分区独立落盘 + 即时生效
*
* 每个分区调各自的后端命令`save_appearance` / `save_layout` /
* 而不是攒成一份完整设置一次提交理由
* 1. 后端各分区是独立的 Mutex 保护单元合并提交需要前端持有完整快照
* 而快照可能与后端正在被其它窗口改的状态冲突谁后写谁赢丢失更新
* 2. 用户在外观里调字号不应该因为快捷键区有一处未填完而保存失败
*
* 无保存按钮本地草稿 + 深度 watch + 400ms 防抖写回与其他模块的
* 设置即时生效规范一致成功不提示仅失败提示
*
* # 快捷键录制
*
* 录制时必须**阻止默认行为**`preventDefault`否则按 `Ctrl+Shift+T`
* 想绑到新建标签浏览器/WebView 会先执行自己的动作
* 同时用捕获阶段监听抢在 xterm 的输入处理之前拿到事件
*/
import { computed, nextTick, onBeforeUnmount, reactive, ref, watch } from 'vue'
import {
AlertTriangle,
Keyboard,
Layout,
Monitor,
MousePointerClick,
Palette,
RefreshCw,
RotateCcw,
ShieldAlert,
Trash2
} from '@lucide/vue'
import { toast } from 'vue-sonner'
import { useTerminalStore } from '@/stores/terminalStore'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'
import { Label } from '@/components/ui/label'
import { Switch } from '@/components/ui/switch'
import { Slider } from '@/components/ui/slider'
import {
Select,
SelectContent,
SelectItem,
SelectTrigger,
SelectValue
} from '@/components/ui/select'
import {
Dialog,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogTitle
} from '@/components/ui/dialog'
import { createLogger } from '@/lib/logger'
import { ACTION_GROUPS, ACTION_MAP, eventToShortcut, TERMINAL_ACTIONS } from '@/lib/terminalActions'
import { TERMINAL_THEME_OPTIONS } from '@/lib/terminalThemes'
import type {
AppearanceSettings,
LayoutSettings,
SecuritySettings,
SelectionSettings,
ShellProfile,
ShortcutBinding
} from '@/types/terminal'
const logger = createLogger('terminal')
const store = useTerminalStore()
type Section = 'appearance' | 'behavior' | 'layout' | 'shortcuts' | 'security' | 'shells'
const section = ref<Section>('appearance')
const SECTIONS: Array<{ id: Section; label: string; icon: unknown }> = [
{ id: 'appearance', label: '外观', icon: Palette },
{ id: 'behavior', label: '行为', icon: MousePointerClick },
{ id: 'layout', label: '布局', icon: Layout },
{ id: 'shells', label: 'Shell', icon: Monitor },
{ id: 'shortcuts', label: '快捷键', icon: Keyboard },
{ id: 'security', label: '安全', icon: ShieldAlert }
]
// ===== 稿 =====
//
// v-model store.settings store
// IPC稿 +
const appearance = reactive<AppearanceSettings>({
theme: 'vscode-dark',
followAppTheme: true,
fontFamily: '',
fontSize: 14,
lineHeight: 1.2,
letterSpacing: 0,
cursorStyle: 'block',
cursorBlink: true,
scrollback: 10000,
opacity: 100,
gpuRendering: true
})
const layout = reactive<LayoutSettings>({
confirmCloseRunning: true,
inheritCwd: false,
sidebarOpen: true,
sidebarWidth: 240,
showStatusBar: true,
maxPanes: 1
})
const selection = reactive<SelectionSettings>({
copyOnSelect: false,
middleClickPaste: true,
rightClick: 'menu',
trimTrailingNewline: true
})
const security = reactive<SecuritySettings>({
hostKeyPolicy: 'ask',
blockOnFingerprintChange: true,
auditLog: true
})
/** 快捷键草稿(数组需整体替换才能触发响应) */
const shortcuts = ref<ShortcutBinding[]>([])
/** store → 草稿同步期间为 true:此时触发的 watch 是回声,不能写回 */
const syncing = ref(false)
/** 把 store 里的设置同步到本地草稿 */
function syncFromStore() {
const s = store.settings
if (!s) return
syncing.value = true
Object.assign(appearance, s.appearance)
Object.assign(layout, s.layout)
Object.assign(selection, s.selection)
Object.assign(security, s.security)
//
const byAction = new Map(s.shortcuts.map(b => [b.action, b]))
shortcuts.value = TERMINAL_ACTIONS.map(a => {
const existing = byAction.get(a.id)
return existing
? { ...existing }
: { action: a.id, keys: a.defaultKeys, enabled: true }
})
// watch flush syncing
// true nextTick flush
nextTick(() => {
syncing.value = false
})
}
watch(() => store.settings, syncFromStore, { immediate: true, deep: false })
// ===== 稿 + 400ms =====
//
// proxy/clipboard/downloader 稿
// watch
// IPC +
/** 各分区的防抖计时器(互不干扰:改外观不会顺带重写行为设置) */
const saveTimers = new Map<Section, ReturnType<typeof setTimeout>>()
function debouncedSave(sectionId: Section, fn: () => Promise<unknown>) {
const old = saveTimers.get(sectionId)
if (old) clearTimeout(old)
saveTimers.set(
sectionId,
setTimeout(() => {
saveTimers.delete(sectionId)
fn().catch(e => {
logger.error(`保存设置失败(${sectionId}):${String(e)}`)
toast.error(`保存失败:${String(e)}`)
})
}, 400)
)
}
watch(
appearance,
() => {
if (syncing.value) return
debouncedSave('appearance', () => store.saveAppearance({ ...appearance }))
},
{ deep: true }
)
watch(
layout,
() => {
if (syncing.value) return
debouncedSave('layout', () => store.saveLayout({ ...layout }))
},
{ deep: true }
)
watch(
selection,
() => {
if (syncing.value) return
debouncedSave('behavior', () => store.saveSelection({ ...selection }))
},
{ deep: true }
)
watch(
security,
() => {
if (syncing.value) return
debouncedSave('security', () => store.saveSecurity({ ...security }))
},
{ deep: true }
)
onBeforeUnmount(() => {
for (const t of saveTimers.values()) clearTimeout(t)
saveTimers.clear()
})
/** 快捷键:每次变更立即写回(低频且键位改动需要立刻反馈冲突检测的结果) */
function persistShortcuts() {
store.saveShortcuts(shortcuts.value.map(b => ({ ...b }))).catch(e => {
logger.error(`保存快捷键失败:${String(e)}`)
toast.error(`保存失败:${String(e)}`)
})
}
// ===== =====
/** 正在录制的动作 id */
const recording = ref<string | null>(null)
/** 录制中检测到的冲突 */
const conflictOf = ref<string | null>(null)
async function startRecording(actionId: string) {
recording.value = actionId
conflictOf.value = null
await nextTick()
// document xterm
document.addEventListener('keydown', onRecordKey, true)
}
function stopRecording() {
recording.value = null
conflictOf.value = null
document.removeEventListener('keydown', onRecordKey, true)
}
function onRecordKey(e: KeyboardEvent) {
// EscEsc
e.preventDefault()
e.stopPropagation()
if (e.key === 'Escape') {
stopRecording()
return
}
const keys = eventToShortcut(e)
//
if (!keys) return
const actionId = recording.value
if (!actionId) return
//
const clash = shortcuts.value.find(b => b.action !== actionId && b.enabled && b.keys === keys)
if (clash) {
const other = ACTION_MAP[clash.action]
conflictOf.value = `该键位已被「${other?.label ?? clash.action}」占用`
//
return
}
shortcuts.value = shortcuts.value.map(b => (b.action === actionId ? { ...b, keys } : b))
stopRecording()
persistShortcuts()
}
function clearBinding(actionId: string) {
shortcuts.value = shortcuts.value.map(b => (b.action === actionId ? { ...b, keys: '' } : b))
persistShortcuts()
}
function toggleBinding(actionId: string, enabled: boolean) {
shortcuts.value = shortcuts.value.map(b => (b.action === actionId ? { ...b, enabled } : b))
persistShortcuts()
}
function resetShortcuts() {
shortcuts.value = TERMINAL_ACTIONS.map(a => ({ action: a.id, keys: a.defaultKeys, enabled: true }))
persistShortcuts()
}
onBeforeUnmount(stopRecording)
/** 按分组组织快捷键(组内保持 TERMINAL_ACTIONS 的定义顺序) */
const shortcutGroups = computed(() =>
ACTION_GROUPS.map(g => ({
group: g,
items: shortcuts.value.filter(b => ACTION_MAP[b.action]?.group === g)
})).filter(g => g.items.length > 0)
)
/** 有效设置里是否有未绑定(keys 为空)的动作 */
const unboundCount = computed(() => shortcuts.value.filter(b => !b.keys).length)
// ===== Shell =====
const pendingShellDelete = ref<ShellProfile | null>(null)
const detecting = ref(false)
async function refreshShells() {
detecting.value = true
try {
await store.refreshShells()
toast.success('已重新探测系统 Shell')
} catch (e) {
toast.error(`探测失败:${String(e)}`)
} finally {
detecting.value = false
}
}
async function toggleShellEnabled(s: ShellProfile) {
try {
await store.saveShell({ ...s, enabled: !s.enabled })
} catch (e) {
toast.error(`操作失败:${String(e)}`)
}
}
async function testShell(s: ShellProfile) {
try {
const r = await store.testShell(s.id)
if (r.ok) toast.success(r.message)
else toast.error(r.message)
} catch (e) {
toast.error(`测试失败:${String(e)}`)
}
}
async function submitShellDelete() {
const s = pendingShellDelete.value
if (!s) return
try {
await store.deleteShell(s.id)
toast.success(`已删除「${s.name}`)
pendingShellDelete.value = null
} catch (e) {
toast.error(`删除失败:${String(e)}`)
}
}
// ===== =====
/** 字体族预设(Windows 上可用的等宽字体) */
/**
* 系统默认字体 Select 里的哨兵值
*
* reka-ui SelectItem **拒绝空字符串 value**空串被保留用于清空选择
* 显示 placeholder语义传入即抛错并中断组件更新设置页整个失去响应
* 因此草稿里的 `fontFamily: ''` Select 的值之间用哨兵映射
*/
const SYSTEM_FONT_VALUE = '__system_default__'
const FONT_PRESETS = [
{ label: 'Cascadia CodeWindows Terminal 默认)', value: "'Cascadia Code', 'Cascadia Mono', Consolas, monospace" },
{ label: 'Consolas', value: "Consolas, 'Courier New', monospace" },
{ label: 'JetBrains Mono', value: "'JetBrains Mono', Consolas, monospace" },
{ label: 'Fira Code', value: "'Fira Code', Consolas, monospace" },
{ label: '等宽宋体 / 中易宋体', value: "'SimSun', 'NSimSun', monospace" },
{ label: '系统默认', value: SYSTEM_FONT_VALUE }
]
/** Select 绑定:'' ↔ 哨兵值的双向映射 */
const fontFamilyValue = computed({
get: () => appearance.fontFamily || SYSTEM_FONT_VALUE,
set: (v: string) => {
appearance.fontFamily = v === SYSTEM_FONT_VALUE ? '' : v
}
})
</script>
<template>
<div class="flex h-full">
<!-- 分区导航 -->
<aside class="w-40 shrink-0 border-r border-border py-2">
<button
v-for="s in SECTIONS"
:key="s.id"
class="w-full flex items-center gap-2 px-3 py-2 text-xs text-left transition-colors"
:class="
section === s.id
? 'bg-accent text-accent-foreground font-medium'
: 'text-muted-foreground hover:bg-accent/50 hover:text-foreground'
"
@click="section = s.id"
>
<component :is="s.icon" class="size-3.5 shrink-0" />
{{ s.label }}
</button>
</aside>
<!-- 分区内容 -->
<div class="flex-1 min-w-0 overflow-y-auto p-5">
<!-- ===== 外观 ===== -->
<div v-if="section === 'appearance'" class="space-y-5 max-w-2xl">
<div>
<h3 class="text-sm font-medium mb-1">外观</h3>
<p class="text-xs text-muted-foreground">控制终端的配色字体与渲染方式</p>
</div>
<div class="space-y-1.5">
<Label class="text-xs">配色主题</Label>
<Select v-model="appearance.theme">
<SelectTrigger class="h-8 text-sm"><SelectValue /></SelectTrigger>
<SelectContent>
<SelectItem v-for="t in TERMINAL_THEME_OPTIONS" :key="t.value" :value="t.value">
{{ t.label }}
</SelectItem>
</SelectContent>
</Select>
<div class="flex items-center justify-between pt-1.5">
<div>
<Label class="text-xs">跟随应用主题</Label>
<p class="text-[11px] text-muted-foreground">
应用切换到浅色/深色时终端自动跟随选择跟随系统时生效
</p>
</div>
<Switch v-model="appearance.followAppTheme" />
</div>
</div>
<div class="space-y-1.5">
<Label class="text-xs">字体</Label>
<Select v-model="fontFamilyValue">
<SelectTrigger class="h-8 text-sm"><SelectValue placeholder="系统默认" /></SelectTrigger>
<SelectContent>
<SelectItem v-for="f in FONT_PRESETS" :key="f.label" :value="f.value">
{{ f.label }}
</SelectItem>
</SelectContent>
</Select>
<p class="text-[11px] text-muted-foreground font-mono truncate">
{{ appearance.fontFamily || '(系统默认等宽字体)' }}
</p>
</div>
<div class="space-y-1.5">
<div class="flex items-center justify-between">
<Label class="text-xs">字号</Label>
<span class="text-xs font-mono text-muted-foreground">{{ appearance.fontSize }} px</span>
</div>
<Slider
:model-value="[appearance.fontSize]"
:min="6"
:max="48"
:step="1"
@update:model-value="(v: any) => { appearance.fontSize = Array.isArray(v) ? v[0] : Number(v) }"
/>
</div>
<div class="space-y-1.5">
<div class="flex items-center justify-between">
<Label class="text-xs">行高</Label>
<span class="text-xs font-mono text-muted-foreground">{{ appearance.lineHeight.toFixed(2) }}</span>
</div>
<Slider
:model-value="[appearance.lineHeight]"
:min="1"
:max="2"
:step="0.05"
@update:model-value="(v: any) => { appearance.lineHeight = Array.isArray(v) ? v[0] : Number(v) }"
/>
</div>
<div class="space-y-1.5">
<div class="flex items-center justify-between">
<Label class="text-xs">字间距</Label>
<span class="text-xs font-mono text-muted-foreground">{{ appearance.letterSpacing }} px</span>
</div>
<Slider
:model-value="[appearance.letterSpacing]"
:min="-2"
:max="4"
:step="0.5"
@update:model-value="(v: any) => { appearance.letterSpacing = Array.isArray(v) ? v[0] : Number(v) }"
/>
</div>
<div class="grid grid-cols-2 gap-4">
<div class="space-y-1.5">
<Label class="text-xs">光标样式</Label>
<Select v-model="appearance.cursorStyle">
<SelectTrigger class="h-8 text-sm"><SelectValue /></SelectTrigger>
<SelectContent>
<SelectItem value="block">方块</SelectItem>
<SelectItem value="bar">竖线</SelectItem>
<SelectItem value="underline">下划线</SelectItem>
</SelectContent>
</Select>
</div>
<div class="flex items-end pb-1.5">
<div class="flex items-center justify-between w-full">
<Label class="text-xs">光标闪烁</Label>
<Switch v-model="appearance.cursorBlink" />
</div>
</div>
</div>
<div class="space-y-1.5">
<div class="flex items-center justify-between">
<Label class="text-xs">背景不透明度</Label>
<span class="text-xs font-mono text-muted-foreground">{{ appearance.opacity }}%</span>
</div>
<Slider
:model-value="[appearance.opacity]"
:min="30"
:max="100"
:step="1"
@update:model-value="(v: any) => { appearance.opacity = Array.isArray(v) ? v[0] : Number(v) }"
/>
<p v-if="appearance.opacity < 70" class="text-[11px] text-amber-600 dark:text-amber-400">
过低的不透明度会让文字与背景内容混在一起影响可读性
</p>
</div>
<div class="grid grid-cols-2 gap-4">
<div class="space-y-1.5">
<Label class="text-xs">回滚缓冲行数</Label>
<Input v-model.number="appearance.scrollback" type="number" class="h-8 text-sm font-mono" />
<p class="text-[11px] text-muted-foreground">内存占用与此成正比</p>
</div>
</div>
<div class="flex items-center justify-between">
<div>
<Label class="text-xs">GPU 渲染WebGL</Label>
<p class="text-[11px] text-muted-foreground">
显著提升滚动流畅度驱动异常时自动回退到 Canvas
</p>
</div>
<Switch v-model="appearance.gpuRendering" />
</div>
<!-- 保存按钮已移除改动经 400ms 防抖自动写回即时生效 -->
</div>
<!-- ===== 行为 ===== -->
<div v-else-if="section === 'behavior'" class="space-y-5 max-w-2xl">
<div>
<h3 class="text-sm font-medium mb-1">行为</h3>
<p class="text-xs text-muted-foreground">鼠标与剪贴板的交互方式</p>
</div>
<div class="flex items-center justify-between">
<div>
<Label class="text-xs">选中即复制</Label>
<p class="text-[11px] text-muted-foreground">用鼠标选中文本后立即写入剪贴板X11 习惯</p>
</div>
<Switch v-model="selection.copyOnSelect" />
</div>
<div class="flex items-center justify-between">
<div>
<Label class="text-xs">中键粘贴</Label>
<p class="text-[11px] text-muted-foreground">点击鼠标中键粘贴剪贴板内容</p>
</div>
<Switch v-model="selection.middleClickPaste" />
</div>
<div class="space-y-1.5">
<Label class="text-xs">右键行为</Label>
<Select v-model="selection.rightClick">
<SelectTrigger class="h-8 text-sm"><SelectValue /></SelectTrigger>
<SelectContent>
<SelectItem value="menu">弹出菜单</SelectItem>
<SelectItem value="paste">粘贴</SelectItem>
<SelectItem value="select-word">选中光标下的词</SelectItem>
</SelectContent>
</Select>
</div>
<div class="flex items-center justify-between">
<div>
<Label class="text-xs">复制时去掉行尾换行</Label>
<p class="text-[11px] text-muted-foreground">
复制单行命令时不带末尾换行粘贴到 shell 不会立即执行
</p>
</div>
<Switch v-model="selection.trimTrailingNewline" />
</div>
<!-- 保存按钮已移除改动经 400ms 防抖自动写回即时生效 -->
</div>
<!-- ===== 布局 ===== -->
<div v-else-if="section === 'layout'" class="space-y-5 max-w-2xl">
<div>
<h3 class="text-sm font-medium mb-1">布局</h3>
<p class="text-xs text-muted-foreground">窗口与面板的组织方式</p>
</div>
<div class="flex items-center justify-between">
<div>
<Label class="text-xs">显示状态栏</Label>
<p class="text-[11px] text-muted-foreground">底部显示会话工作目录与终端尺寸</p>
</div>
<Switch v-model="layout.showStatusBar" />
</div>
<div class="flex items-center justify-between">
<div>
<Label class="text-xs">新会话继承当前目录</Label>
<p class="text-[11px] text-muted-foreground">
新建本地标签时从当前会话的工作目录启动 shell 支持 OSC 7 上报
</p>
</div>
<Switch v-model="layout.inheritCwd" />
</div>
<div class="flex items-center justify-between">
<div>
<Label class="text-xs">关闭运行中的会话前确认</Label>
<p class="text-[11px] text-muted-foreground">
强烈建议保持开启 一个正在跑的编译或部署任务被误关会很难受
</p>
</div>
<Switch v-model="layout.confirmCloseRunning" />
</div>
<div class="space-y-1.5">
<Label class="text-xs">面板数量上限</Label>
<Select :model-value="String(layout.maxPanes)">
<SelectTrigger class="h-8 text-sm"><SelectValue /></SelectTrigger>
<SelectContent>
<SelectItem value="1">1不分屏</SelectItem>
<SelectItem value="2">2</SelectItem>
<SelectItem value="3">3</SelectItem>
<SelectItem value="4">4</SelectItem>
</SelectContent>
</Select>
<p class="text-[11px] text-muted-foreground">
分屏功能在后续版本提供此处先确定上限
</p>
</div>
<!-- 保存按钮已移除改动经 400ms 防抖自动写回即时生效 -->
</div>
<!-- ===== Shell ===== -->
<div v-else-if="section === 'shells'" class="space-y-5 max-w-3xl">
<div class="flex items-start justify-between">
<div>
<h3 class="text-sm font-medium mb-1">本地 Shell</h3>
<p class="text-xs text-muted-foreground">
自动探测系统中可用的 Shell禁用的 Shell 不会出现在新建会话的列表中
</p>
</div>
<Button variant="outline" size="sm" class="h-7 gap-1.5 text-xs shrink-0" :disabled="detecting" @click="refreshShells">
<RefreshCw class="size-3.5" :class="{ 'animate-spin': detecting }" />
重新探测
</Button>
</div>
<div v-if="store.shells.length === 0" class="py-12 text-center border border-dashed border-border rounded-md">
<Monitor class="size-7 mx-auto text-muted-foreground/30 mb-2" />
<p class="text-sm text-muted-foreground">未探测到可用 Shell</p>
</div>
<div v-else class="space-y-1.5">
<div
v-for="s in store.shells"
:key="s.id"
class="group flex items-start gap-3 px-3 py-2.5 rounded-md border border-border
hover:border-primary/40 transition-colors"
>
<Monitor class="size-4 shrink-0 mt-0.5 text-muted-foreground" />
<div class="min-w-0 flex-1">
<div class="flex items-center gap-2 flex-wrap">
<span class="text-sm font-medium truncate">{{ s.name }}</span>
<span class="text-[10px] px-1.5 py-0.5 rounded bg-muted shrink-0">{{ s.kind }}</span>
<span
v-if="s.detected"
class="text-[10px] px-1.5 py-0.5 rounded bg-sky-500/15 text-sky-700 dark:text-sky-400 shrink-0"
>
自动探测
</span>
<span
v-if="s.id === store.settings?.lastShellId"
class="text-[10px] px-1.5 py-0.5 rounded bg-emerald-500/15 text-emerald-700 dark:text-emerald-400 shrink-0"
>
默认
</span>
</div>
<div class="mt-1 text-[11px] text-muted-foreground font-mono truncate" :title="s.path">
{{ s.path }}
<span v-if="s.args.length > 0" class="opacity-70">{{ s.args.join(' ') }}</span>
</div>
</div>
<div class="shrink-0 flex items-center gap-2">
<Button
v-if="s.id !== store.settings?.lastShellId"
variant="ghost"
size="sm"
class="h-7 text-[11px] opacity-0 group-hover:opacity-100 transition-opacity"
title="设为默认 Shell"
@click="store.setLastShell(s.id)"
>
设为默认
</Button>
<Button
variant="ghost"
size="sm"
class="h-7 text-[11px] opacity-0 group-hover:opacity-100 transition-opacity"
@click="testShell(s)"
>
测试
</Button>
<Switch :model-value="s.enabled" @update:model-value="() => toggleShellEnabled(s)" />
<Button
v-if="!s.detected"
variant="ghost"
size="icon"
class="size-7 opacity-0 group-hover:opacity-100 transition-opacity
text-destructive hover:text-destructive"
title="删除"
@click="pendingShellDelete = s"
>
<Trash2 class="size-3.5" />
</Button>
</div>
</div>
</div>
<p class="text-[11px] text-muted-foreground">
自动探测到的 Shell 无法删除只能禁用 它们的路径来自系统删掉也会在下次探测时重新出现
</p>
</div>
<!-- ===== 快捷键 ===== -->
<div v-else-if="section === 'shortcuts'" class="space-y-5 max-w-3xl">
<div class="flex items-start justify-between">
<div>
<h3 class="text-sm font-medium mb-1">终端内快捷键</h3>
<p class="text-xs text-muted-foreground">
仅在焦点位于终端面板内时生效点击键位后按下新组合键即可修改
</p>
</div>
<Button variant="outline" size="sm" class="h-7 gap-1.5 text-xs shrink-0" @click="resetShortcuts">
<RotateCcw class="size-3.5" />恢复默认
</Button>
</div>
<!-- 硬约束说明这是最容易引起困惑的地方必须显式写在界面上 -->
<div class="flex items-start gap-2 p-2.5 rounded-md bg-muted text-[11px] text-muted-foreground">
<AlertTriangle class="size-3.5 shrink-0 mt-0.5" />
<div>
<p>
<span class="font-medium text-foreground">Ctrl+C Ctrl+V 不可被占用</span>
终端中它们是中断当前命令 shell 的粘贴键映射成其它功能会导致无法中止任务
</p>
<p class="mt-1">复制粘贴请使用 Ctrl+Shift+C / Ctrl+Shift+V</p>
</div>
</div>
<p v-if="unboundCount > 0" class="text-[11px] text-muted-foreground">
{{ unboundCount }} 个动作未绑定键位
</p>
<div v-for="g in shortcutGroups" :key="g.group" class="space-y-1">
<p class="text-[10px] uppercase tracking-wide text-muted-foreground px-1">{{ g.group }}</p>
<div
v-for="b in g.items"
:key="b.action"
class="flex items-center gap-3 px-3 py-2 rounded-md border border-border"
:class="recording === b.action ? 'border-primary bg-accent/40' : 'border-border'"
>
<div class="min-w-0 flex-1">
<div class="text-xs font-medium">{{ ACTION_MAP[b.action]?.label ?? b.action }}</div>
<div class="text-[11px] text-muted-foreground truncate">
{{ ACTION_MAP[b.action]?.description }}
</div>
</div>
<!-- 键位录制按钮 -->
<button
class="shrink-0 min-w-[132px] h-7 px-2.5 rounded-md border text-[11px] font-mono
transition-colors"
:class="
recording === b.action
? 'border-primary bg-primary/10 text-primary'
: b.keys
? 'border-border hover:border-primary/50 hover:bg-accent/50'
: 'border-dashed border-muted-foreground/40 text-muted-foreground hover:border-primary/50'
"
@click="recording === b.action ? stopRecording() : startRecording(b.action)"
>
<template v-if="recording === b.action">
<span class="animate-pulse">按下组合键</span>
</template>
<template v-else-if="b.keys">{{ b.keys }}</template>
<template v-else>未绑定</template>
</button>
<Button
v-if="b.keys"
variant="ghost"
size="icon"
class="size-7 shrink-0 text-muted-foreground"
title="清除绑定"
@click="clearBinding(b.action)"
>
<RotateCcw class="size-3.5" />
</Button>
<div v-else class="size-7 shrink-0" />
<Switch
:model-value="b.enabled"
class="shrink-0"
@update:model-value="(v: boolean) => toggleBinding(b.action, v)"
/>
</div>
</div>
<!-- 录制冲突提示 -->
<div
v-if="conflictOf"
class="fixed bottom-6 left-1/2 -translate-x-1/2 px-3 py-2 rounded-md
bg-destructive text-destructive-foreground text-xs shadow-lg z-50"
>
{{ conflictOf }}请换一个键位
</div>
</div>
<!-- ===== 安全 ===== -->
<div v-else-if="section === 'security'" class="space-y-5 max-w-2xl">
<div>
<h3 class="text-sm font-medium mb-1">安全</h3>
<p class="text-xs text-muted-foreground">主机密钥校验与审计</p>
</div>
<div class="rounded-md border border-border p-3 space-y-3">
<div>
<Label class="text-xs">主机密钥策略</Label>
<p class="text-[11px] text-muted-foreground mt-0.5">
本项目<span class="font-medium text-foreground">不提供自动接受</span>选项
首次连接必须人工核对指纹 这是抵御中间人攻击的唯一有效手段
</p>
</div>
<div class="flex items-center gap-2 px-2.5 py-2 rounded bg-muted">
<ShieldAlert class="size-3.5 text-emerald-600 dark:text-emerald-400 shrink-0" />
<span class="text-xs">询问并核对指纹唯一策略</span>
</div>
</div>
<div class="flex items-center justify-between">
<div>
<Label class="text-xs">指纹变更时阻断连接</Label>
<p class="text-[11px] text-muted-foreground">
已记录的主机换了密钥时默认拒绝连接需用户显式核对后放行
</p>
</div>
<Switch v-model="security.blockOnFingerprintChange" />
</div>
<div class="flex items-center justify-between">
<div>
<Label class="text-xs">记录安全事件</Label>
<p class="text-[11px] text-muted-foreground">
把主机密钥确认指纹变更等事件写入日志便于事后追溯
</p>
</div>
<Switch v-model="security.auditLog" />
</div>
<div
v-if="!security.blockOnFingerprintChange"
class="flex items-start gap-2 p-2.5 rounded-md border border-amber-500/40 bg-amber-500/10"
>
<AlertTriangle class="size-3.5 shrink-0 mt-0.5 text-amber-600 dark:text-amber-400" />
<p class="text-[11px] text-amber-700 dark:text-amber-400">
关闭阻断后主机密钥变更将不再自动拦截若服务器被中间人替换
您可能在毫无提示的情况下连接到了错误的机器
</p>
</div>
<!-- 保存按钮已移除改动经 400ms 防抖自动写回即时生效 -->
</div>
</div>
<!-- ===== Shell 删除确认 ===== -->
<Dialog :open="pendingShellDelete !== null" @update:open="(v: boolean) => !v && (pendingShellDelete = null)">
<DialogContent class="max-w-sm" :show-close-button="false">
<DialogHeader>
<DialogTitle class="text-base">删除 Shell</DialogTitle>
<DialogDescription class="text-xs">
将从列表中移除{{ pendingShellDelete?.name }}这不影响系统上实际的可执行文件
</DialogDescription>
</DialogHeader>
<DialogFooter>
<Button variant="outline" size="sm" @click="pendingShellDelete = null">取消</Button>
<Button variant="destructive" size="sm" @click="submitShellDelete">删除</Button>
</DialogFooter>
</DialogContent>
</Dialog>
</div>
</template>
@@ -0,0 +1,190 @@
<script setup lang="ts">
/**
* 终端状态栏当前会话的客观事实摆在最下面一行
*
* 为什么需要它终端是全屏沉浸式的界面用户容易忘记自己在哪台机器
* 用哪个 shell当前目录是什么状态栏用最低的视觉权重承担这个职责
*
* 设计取舍这里**只放只读事实 + 一个例外**编码选择器
* 编码之所以破例它是读出来的事实当前用什么编码需要就地改的开关
* 看到乱码要立刻切这两重身份的合体若挪进设置页用户在 GBK 服务器上看到
* 乱码时得先想设置在哪而这个动作天然是就在我看到乱码的那一行下面改
* 其余任何可写设置都不该进状态栏 那会让它退化成一个迷你设置面板
*/
import { computed, ref } from 'vue'
import { Globe, TerminalSquare, FolderOpen, Hash, Wifi, WifiOff, Cpu, Languages, Loader2 } from '@lucide/vue'
import { useTerminalStore } from '@/stores/terminalStore'
import { toast } from 'vue-sonner'
import {
ENCODING_OPTIONS,
encodingShortLabel,
isNonDefaultEncoding,
type SessionInfo
} from '@/types/terminal'
const store = useTerminalStore()
const props = defineProps<{
session: SessionInfo | undefined
/** 当前字号(含临时覆盖) */
fontSize: number
/** 终端实际行列数(由 xterm 上报,父组件透传) */
cols?: number
rows?: number
}>()
const isSsh = computed(() => props.session?.kind === 'ssh')
const stateText = computed(() => {
switch (props.session?.state) {
case 'connecting':
return '连接中'
case 'authenticating':
return '认证中'
case 'established':
return '已连接'
case 'degraded':
return '连接不稳定'
case 'closed':
return '已断开'
case 'failed':
return '连接失败'
default:
return '空闲'
}
})
const stateColor = computed(() => {
switch (props.session?.state) {
case 'established':
return 'text-emerald-600 dark:text-emerald-400'
case 'connecting':
case 'authenticating':
case 'degraded':
return 'text-amber-600 dark:text-amber-400'
case 'failed':
return 'text-red-600 dark:text-red-400'
default:
return 'text-muted-foreground'
}
})
/** 会话标题(与标签栏一致的口径,统一走 store 的解析) */
const title = computed(() => store.sessionLabel(props.session) || '无会话')
/** SSH 目标串 / 本地 shell 名 */
const target = computed(() => store.sessionTarget(props.session))
// ===== =====
/** 当前会话的编码(缺省按 utf-8 显示,避免旧会话快照没有该字段时闪空) */
const encoding = computed(() => props.session?.encoding || 'utf-8')
/** 非默认编码时给视觉提示 —— 见 `isNonDefaultEncoding` 的说明 */
const encodingAlert = computed(() => isNonDefaultEncoding(encoding.value))
/** 切换中(防止连点造成多次广播与状态错乱) */
const switching = ref(false)
/**
* 切换编码
*
* 成功后**不清屏**已渲染的历史字符是旧编码的解释结果重绘需要后端保留的
* 原始字节缓冲配合当前 `OutputBatch` ring buffer 尚未接到前端
* 所以新编码只对之后的输出生效这一点必须让用户知道
* 否则他会看到切了还是乱码并认为功能坏了
*/
async function onEncodingChange(value: unknown) {
const sid = props.session?.id
const next = String(value ?? '')
if (!sid || !next || next === encoding.value) return
switching.value = true
try {
const norm = await store.setEncoding(sid, next)
toast.success(`编码已切换为 ${norm}`, {
description: '新编码对之后的输出生效;已显示的历史内容不会自动重绘,可执行 clear 后重新查看'
})
} catch (e) {
// UI
toast.error(`切换编码失败:${String(e)}`)
} finally {
switching.value = false
}
}
</script>
<template>
<div
class="shrink-0 h-6 flex items-center gap-3 px-2.5 border-t border-border bg-card/20
text-[10px] text-muted-foreground select-none"
>
<div class="flex items-center gap-1.5 min-w-0">
<component :is="isSsh ? Globe : TerminalSquare" class="size-3 shrink-0" />
<span class="truncate max-w-[200px]">{{ title }}</span>
</div>
<span v-if="target" class="truncate max-w-[220px] opacity-80">{{ target }}</span>
<!-- shrink-0 + nowrap状态栏 flex 项多不加会被压缩到已连接逐字换行成竖排 -->
<div class="flex items-center gap-1 shrink-0 whitespace-nowrap">
<Wifi v-if="session?.state === 'established'" class="size-3" />
<WifiOff v-else class="size-3 opacity-50" />
<span :class="stateColor">{{ stateText }}</span>
</div>
<div class="flex-1" />
<!--
编码选择器非默认编码时整块变琥珀色
只换文字不够 GBKUTF-8 10px 字号下形状差异不明显
用户扫一眼不会注意到自己正在用非默认编码
-->
<div
v-if="session"
class="flex items-center gap-0.5 shrink-0 rounded px-1 -mx-0.5 transition-colors"
:class="encodingAlert
? 'bg-amber-500/15 text-amber-700 dark:text-amber-400'
: 'text-muted-foreground'"
:title="encodingAlert
? `当前使用非默认编码 ${encoding},中文乱码时可在此切换`
: '切换字符编码'"
>
<Loader2 v-if="switching" class="size-3 animate-spin" />
<Languages v-else class="size-3" />
<!--
用原生 select 而不是 shadcn Select后者是 Radix 实现会在 body 末尾
挂一个 portal 浮层而状态栏处在终端容器的裁剪区内10px 字号 + 状态栏
这种工具条语境下原生 select 的外观差异可以接受换来的是不受
浮层层级与裁剪影响 这是稳定性优先于观感的一处取舍
-->
<select
:value="encoding"
:disabled="switching"
class="bg-transparent border-0 outline-none cursor-pointer appearance-none
text-[10px] text-inherit pr-0.5 disabled:cursor-wait"
@change="onEncodingChange(($event.target as HTMLSelectElement).value)"
>
<option v-for="opt in ENCODING_OPTIONS" :key="opt.value" :value="opt.value">
{{ opt.label }}
</option>
</select>
<span class="tabular-nums opacity-70">{{ encodingShortLabel(encoding) }}</span>
</div>
<div v-if="session?.cwd" class="flex items-center gap-1 min-w-0 max-w-[45%]">
<FolderOpen class="size-3 shrink-0" />
<span class="truncate" :title="session.cwd">{{ session.cwd }}</span>
</div>
<div v-if="cols && rows" class="flex items-center gap-1 shrink-0">
<Hash class="size-3" />
<span>{{ cols }}×{{ rows }}</span>
</div>
<div class="flex items-center gap-1 shrink-0">
<Cpu class="size-3" />
<span>{{ fontSize }}px</span>
</div>
</div>
</template>
@@ -0,0 +1,219 @@
<script setup lang="ts">
/**
* 终端标签栏
*
* 职责展示会话列表切换关闭拖动重排新建
* 不含任何终端渲染逻辑标签只是会话的视图句柄
*/
import { ref, watch } from 'vue'
import { Plus, X, TerminalSquare, Lock, Loader2, AlertTriangle } from '@lucide/vue'
import { VueDraggable } from 'vue-draggable-plus'
import { Tooltip, TooltipContent, TooltipTrigger } from '@/components/ui/tooltip'
import { useTerminalStore } from '@/stores/terminalStore'
import type { SessionInfo } from '@/types/terminal'
const store = useTerminalStore()
const props = defineProps<{
sessions: SessionInfo[]
activeId: string | null
/** 有新输出但未被查看的会话 id 集合 */
unread?: Set<string>
}>()
const emit = defineEmits<{
(e: 'select', id: string): void
(e: 'close', id: string): void
(e: 'new'): void
(e: 'reorder', ids: string[]): void
}>()
/**
* 拖动重排用的本地副本
*
* # 为什么不用 `computed({ get: () => props.sessions, set })`
*
* `VueDraggable` `v-model` **就地改写数组**内部 `splice`而不是派发一个
* 新数组 getter 直接返回 `props.sessions`就会去改**父组件传下来的 prop**
* 触发 Vue 不要直接修改 prop告警且改动依赖父组件恰好用同一个数组引用
*
* 这里改用本地 `ref` 镜像
* - `props.sessions` 变化 同步到本地含新增/删除/重命名
* - 用户拖动 `VueDraggable` 改本地数组 watch 派发 `reorder` 给父组件落库
* 两边都只碰自己的数据没有跨组件写
*/
const localList = ref<SessionInfo[]>([...props.sessions])
watch(
// id store watch(props.sessions)
// /
() => props.sessions.map(s => s.id).join(','),
() => {
localList.value = [...props.sessions]
}
)
// / id watch
// SSH
//
watch(
() =>
props.sessions
.map(s => `${s.id}:${s.state}:${s.title}:${s.detached ? 1 : 0}`)
.join(','),
() => {
const byId = new Map(props.sessions.map(s => [s.id, s]))
localList.value = localList.value.map(old => byId.get(old.id) ?? old)
}
)
/** 拖动结束:把顺序写回父组件(父组件会做「过滤已消失会话并补齐」的校验) */
function onDragUpdate() {
emit(
'reorder',
localList.value.map(s => s.id)
)
}
/** 当前正在被鼠标悬停的标签(用于 alway 显示关闭按钮 vs 仅悬停显示) */
const hoveredId = ref<string | null>(null)
function stateIcon(s: SessionInfo) {
if (s.state === 'connecting' || s.state === 'authenticating') return Loader2
if (s.state === 'failed') return AlertTriangle
return null
}
function isBusy(s: SessionInfo) {
return s.state === 'connecting' || s.state === 'authenticating'
}
/** 标签主标题:优先用户重命名的 title,其次 shell/主机名,最后退化到 id */
function labelOf(s: SessionInfo) {
return store.sessionLabel(s)
}
/** 副标题:展示 cwd(本地)或 user@host(SSH),提供「我在哪」的一眼信息 */
function subtitleOf(s: SessionInfo) {
return store.sessionSubtitle(s)
}
/** 会话类型图标:SSH 加锁标记,本地用终端标记 */
function kindIcon(s: SessionInfo) {
return s.kind === 'ssh' ? Lock : TerminalSquare
}
/** Tooltip 全文:标题 + 副标题(cwd / user@host),替代标签内的两行排版 */
function tooltipText(s: SessionInfo) {
const sub = subtitleOf(s)
return sub ? `${labelOf(s)}\n${sub}` : labelOf(s)
}
</script>
<template>
<!-- shrink-0 而不是 flex-1主区是纵向 flex标签行是固定高度的头部
flex-1 会与下方面板区平分剩余高度标签芯片垂直悬在拉高出
的空白中间窗口栏高度异常的根因 -->
<div class="flex items-center gap-1 min-w-0 shrink-0">
<!--
不要加 `target=".tab-track"`
`target` 是给**跨容器拖拽**用的把元素从 A 列表拖到 B 列表它会被解析成
`$el.querySelector(target)` vue-draggable-plus 源码 `R(v)` / `Sn(t, e)`
`querySelector` **只搜后代不匹配元素自身** `.tab-track` 正是这个组件
根元素自己的类名所以必然返回 `null`继而 `new Sortable(null)`
`el` must be an HTMLElement, not [object Null]
单容器内排序**本来就不需要 target**`v-model` 绑定的数组顺序就是拖拽结果
项目内其他三处 VueDraggablemonitor ×2settings ×1也都没传它
-->
<VueDraggable
v-model="localList"
:animation="150"
class="tab-track flex items-center gap-1 min-w-0 overflow-x-auto scrollbar-none"
@update:model-value="onDragUpdate"
>
<!--
标签只显示单行标题完整信息标题 + cwd/user@host 副标题 Tooltip
与其他模块的悬停提示范式一致此前副标题直接排在标签里标签变成两行高
-->
<Tooltip v-for="s in localList" :key="s.id">
<TooltipTrigger as-child>
<div
class="group relative flex items-center gap-1.5 shrink-0 max-w-[220px] px-2.5 py-1.5
rounded-md cursor-pointer select-none transition-colors"
:class="
s.id === activeId
? 'bg-accent text-accent-foreground'
: 'text-muted-foreground hover:bg-accent/50 hover:text-foreground'
"
@click="emit('select', s.id)"
@mouseenter="hoveredId = s.id"
@mouseleave="hoveredId = null"
>
<!-- 类型图标 / 状态指示连接中用旋转的 loader失败用警告三角 -->
<component
:is="stateIcon(s) || kindIcon(s)"
class="size-3.5 shrink-0"
:class="{
'animate-spin': isBusy(s),
'text-red-500': s.state === 'failed',
'text-muted-foreground/60': s.state === 'closed'
}"
/>
<span class="text-xs truncate">{{ labelOf(s) }}</span>
<!-- 未读小圆点有输出但当前未激活 -->
<span
v-if="unread?.has(s.id) && s.id !== activeId"
class="size-1.5 rounded-full bg-primary shrink-0"
/>
<!-- 独立窗口标记该会话已被拖出到独立窗口 -->
<span
v-if="s.detached"
class="text-[9px] px-1 rounded bg-primary/15 text-primary shrink-0"
>
独立
</span>
<!-- 关闭按钮始终占位避免悬停时标签宽度跳动非悬停时透明 -->
<button
class="shrink-0 size-4 rounded flex items-center justify-center transition-opacity
hover:bg-background/60"
:class="hoveredId === s.id || s.id === activeId ? 'opacity-100' : 'opacity-0'"
@click.stop="emit('close', s.id)"
>
<X class="size-3" />
</button>
</div>
</TooltipTrigger>
<TooltipContent side="bottom" class="max-w-[360px]">
<!-- break-all会话标题/路径是不含空格的长串默认断行规则整行溢出 -->
<p class="text-xs whitespace-pre-line break-all">{{ tooltipText(s) }}</p>
</TooltipContent>
</Tooltip>
</VueDraggable>
<!-- 新建按钮固定在标签滚动区之外避免被长标签列表挤到看不见 -->
<button
class="shrink-0 size-6 rounded flex items-center justify-center text-muted-foreground
hover:bg-accent hover:text-foreground transition-colors"
title="新建本地会话"
@click="emit('new')"
>
<Plus class="size-3.5" />
</button>
</div>
</template>
<style scoped>
/* 标签栏横向滚动但不显示滚动条:滚动条会吃掉 8px 高度,让标签栏显得脏 */
.scrollbar-none {
scrollbar-width: none;
}
.scrollbar-none::-webkit-scrollbar {
display: none;
}
</style>
@@ -0,0 +1,277 @@
<script setup lang="ts">
/**
* 终端工具栏包裹当前会话的常用动作
*
* 设计原则**只放标签栏放不下的会话级动作**新建/关闭/切换在标签栏已有
* 这里不重复放的是搜索字号清屏独立窗口这类低频但需要显式入口的操作
*/
import { ref } from 'vue'
import {
ExternalLink,
FileText,
FolderOpen,
FolderTree,
LayoutTemplate,
Minus,
Network,
Plus,
RotateCcw,
Search,
Eraser,
Sparkles,
X,
ChevronDown,
ChevronUp
} from '@lucide/vue'
import { Input } from '@/components/ui/input'
// 使 `sessionId` / `title` / `searching` script
defineProps<{
sessionId: string | null
/** 会话标题(用于显示「当前操作对象」) */
title: string
/** 搜索面板是否展开 */
searching: boolean
/** 是否有匹配结果的反馈文案(由父组件在搜索后设置) */
searchHint?: string
/** 当前会话是否为 SSH(决定是否显示文件面板按钮) */
isSsh: boolean
/** 文件面板是否展开 */
sftpVisible: boolean
/** 当前会话是否正在记录日志 */
logging: boolean
}>()
const emit = defineEmits<{
(e: 'toggle-search'): void
/** 关键词随事件传出(工具栏是关键词的唯一持有者) */
(e: 'search', keyword: string): void
(e: 'search-next', keyword: string): void
(e: 'search-prev', keyword: string): void
(e: 'font', delta: number): void
(e: 'font-reset'): void
(e: 'clear'): void
(e: 'detach'): void
(e: 'toggle-sftp'): void
/** 打开端口转发对话框(仅 SSH 会话显示按钮) */
(e: 'open-forwards'): void
/** 开关当前会话的日志记录 */
(e: 'toggle-logging'): void
/** 在文件管理器中显示日志文件 */
(e: 'open-log-dir'): void
/** 打开会话模板对话框 */
(e: 'open-templates'): void
/** 打开 AI 命令助手对话框 */
(e: 'open-ai'): void
}>()
/** 搜索输入(受控于工具栏,回车触发) */
const keyword = ref('')
/**
* 每次查找都要把关键词随事件带出去
*
* 早期版本只发 `search-next`不带参数依赖父组件记住上次的关键词
* 但父组件并不持有工具栏的输入框内容导致首次按 Enter 时搜索栏是空的
* 什么都不会发生关键词是工具栏的局部状态只有这里知道它是什么
* 因此必须由这里显式传出
*/
function onSearchNext() {
const k = keyword.value.trim()
if (k) emit('search', k)
}
function onSearchPrev() {
const k = keyword.value.trim()
if (k) emit('search-prev', k)
}
function closeSearch() {
keyword.value = ''
emit('toggle-search')
}
</script>
<template>
<div class="shrink-0 flex items-center gap-1 px-2 h-9 border-b border-border bg-card/20">
<!-- 当前会话标识工具栏的动作都作用于它必须显式写出来 -->
<div class="flex items-center gap-1.5 min-w-0 px-1">
<span class="text-xs font-medium truncate max-w-[220px]">{{ title || '无会话' }}</span>
<span v-if="sessionId" class="text-[10px] text-muted-foreground/60 shrink-0">
{{ sessionId }}
</span>
</div>
<div class="flex-1" />
<!-- ===== 搜索 ===== -->
<div v-if="searching" class="flex items-center gap-1">
<div class="relative">
<Input
v-model="keyword"
placeholder="查找…"
class="h-6 w-[160px] text-xs"
autofocus
@keydown.enter="onSearchNext"
@keydown.shift.enter="onSearchPrev"
@keydown.esc="closeSearch"
/>
</div>
<button
class="size-6 rounded flex items-center justify-center text-muted-foreground hover:bg-accent"
title="上一个(Shift+Enter"
@click="onSearchPrev"
>
<ChevronUp class="size-3.5" />
</button>
<button
class="size-6 rounded flex items-center justify-center text-muted-foreground hover:bg-accent"
title="下一个(Enter"
@click="onSearchNext"
>
<ChevronDown class="size-3.5" />
</button>
<button
class="size-6 rounded flex items-center justify-center text-muted-foreground hover:bg-accent"
title="关闭搜索"
@click="closeSearch"
>
<X class="size-3.5" />
</button>
</div>
<button
v-else
class="size-7 rounded flex items-center justify-center text-muted-foreground
hover:bg-accent hover:text-foreground transition-colors"
title="搜索"
@click="emit('toggle-search')"
>
<Search class="size-3.5" />
</button>
<div class="w-px h-4 bg-border mx-0.5" />
<!-- ===== 字号 ===== -->
<button
class="size-7 rounded flex items-center justify-center text-muted-foreground
hover:bg-accent hover:text-foreground transition-colors"
title="缩小字号"
@click="emit('font', -1)"
>
<Minus class="size-3.5" />
</button>
<button
class="size-7 rounded flex items-center justify-center text-muted-foreground
hover:bg-accent hover:text-foreground transition-colors"
title="放大字号"
@click="emit('font', 1)"
>
<Plus class="size-3.5" />
</button>
<button
class="size-7 rounded flex items-center justify-center text-muted-foreground
hover:bg-accent hover:text-foreground transition-colors"
title="重置字号"
@click="emit('font-reset')"
>
<RotateCcw class="size-3.5" />
</button>
<div class="w-px h-4 bg-border mx-0.5" />
<!-- 会话模板不依赖当前会话可以没有会话时先拉起一组 -->
<button
class="size-7 rounded flex items-center justify-center text-muted-foreground
hover:bg-accent hover:text-foreground transition-colors"
title="会话模板"
@click="emit('open-templates')"
>
<LayoutTemplate class="size-3.5" />
</button>
<!-- AI 命令助手 -->
<button
class="size-7 rounded flex items-center justify-center text-muted-foreground
hover:bg-accent hover:text-foreground transition-colors disabled:opacity-40"
:disabled="!sessionId"
title="AI 命令助手"
@click="emit('open-ai')"
>
<Sparkles class="size-3.5" />
</button>
<!--
文件面板只对 SSH 会话显示
本地会话不给这个按钮而不是给了再报错 看得见但点不动
看不见更让人困惑
-->
<button
v-if="isSsh"
class="size-7 rounded flex items-center justify-center transition-colors
disabled:opacity-40"
:class="'text-muted-foreground hover:bg-accent hover:text-foreground'"
:disabled="!sessionId"
title="端口转发(-L / -R"
@click="emit('open-forwards')"
>
<Network class="size-3.5" />
</button>
<button
v-if="isSsh"
class="size-7 rounded flex items-center justify-center transition-colors
disabled:opacity-40"
:class="sftpVisible
? 'bg-accent text-foreground'
: 'text-muted-foreground hover:bg-accent hover:text-foreground'"
:disabled="!sessionId"
:title="sftpVisible ? '隐藏文件面板' : '显示文件面板'"
@click="emit('toggle-sftp')"
>
<FolderTree class="size-3.5" />
</button>
<button
class="size-7 rounded flex items-center justify-center transition-colors
disabled:opacity-40"
:class="logging
? 'bg-primary/15 text-primary'
: 'text-muted-foreground hover:bg-accent hover:text-foreground'"
:disabled="!sessionId"
:title="logging ? '停止记录会话日志' : '开始记录会话日志'"
@click="emit('toggle-logging')"
>
<FileText class="size-3.5" />
</button>
<!-- 打开日志文件只在记录中显示日志路径此时才有意义 -->
<button
v-if="logging"
class="size-7 rounded flex items-center justify-center text-muted-foreground
hover:bg-accent hover:text-foreground transition-colors"
title="在文件管理器中显示日志文件"
@click="emit('open-log-dir')"
>
<FolderOpen class="size-3.5" />
</button>
<button
class="size-7 rounded flex items-center justify-center text-muted-foreground
hover:bg-accent hover:text-foreground transition-colors disabled:opacity-40"
:disabled="!sessionId"
title="清屏"
@click="emit('clear')"
>
<Eraser class="size-3.5" />
</button>
<button
class="size-7 rounded flex items-center justify-center text-muted-foreground
hover:bg-accent hover:text-foreground transition-colors disabled:opacity-40"
:disabled="!sessionId"
title="在独立窗口中打开"
@click="emit('detach')"
>
<ExternalLink class="size-3.5" />
</button>
</div>
</template>
+101
View File
@@ -0,0 +1,101 @@
/**
* SSH
*
* `HostManager.vue`
* 使`HostManager.vue`
*
*
*
*
* - `port: 22` SSH
* - `connectTimeoutMs: 15000` + DNS 10
* 30 15
*
* - `keepaliveSecs: 30` /NAT 60
* 穿 NAT
* - `encoding: 'utf-8'` Linux localeGBK
*/
import type { SshHost } from '@/types/terminal'
export type { SshHost }
/**
*
*
* `id` `terminal_new_host_id`,
* `HostManager.vue`
* hostId id
*/
export function blankHost(id: string): SshHost {
return {
id,
name: '',
host: '',
port: 22,
username: '',
authMethod: 'key',
keyId: '',
group: '',
note: '',
color: '',
favorited: false,
connectTimeoutMs: 15000,
keepaliveSecs: 30,
remoteCwd: '',
startupCommand: '',
useProxy: false,
jumpIds: [],
encoding: 'utf-8'
}
}
/**
*
*
* `SshHost`
* `encoding``useProxy` `undefined`
* `<Input v-model.number>` `undefined`
* `NaN`
*/
export function normalizeHost(raw: Partial<SshHost>, id: string): SshHost {
const base = blankHost(raw.id || id)
return {
...base,
...raw,
// 数值字段单独兜底:`NaN` 是合法 number,不会触发 `??` 的默认值,
// 但塞进 `port` 会让后端校验失败,且表单上显示为空,用户看不出问题所在。
port: Number.isFinite(raw.port) ? (raw.port as number) : base.port,
connectTimeoutMs: Number.isFinite(raw.connectTimeoutMs)
? (raw.connectTimeoutMs as number)
: base.connectTimeoutMs,
keepaliveSecs: Number.isFinite(raw.keepaliveSecs)
? (raw.keepaliveSecs as number)
: base.keepaliveSecs,
authMethod: raw.authMethod || base.authMethod,
// 数组字段单独兜底:旧配置没有该字段时是 undefined,直接展开会盖掉 base 的 []
jumpIds: Array.isArray(raw.jumpIds) ? raw.jumpIds : base.jumpIds,
encoding: raw.encoding || base.encoding
}
}
/** 认证方式的中文展示名 */
export function authMethodLabel(method: string): string {
switch (method) {
case 'key':
return '密钥认证'
case 'password':
return '密码认证'
case 'agent':
return 'SSH Agent'
case 'keyboard':
return '键盘交互'
default:
return method || '未设置'
}
}
/** 是否是可用的认证方式(P0 只实现 key 与 password */
export function isSupportedAuthMethod(method: string): boolean {
return method === 'key' || method === 'password'
}
+84
View File
@@ -0,0 +1,84 @@
import type { ModuleConfig } from '@/types/module'
import type { SearchIndexItem } from '@/stores/searchIndex'
const searchItems: SearchIndexItem[] = [
{
title: '终端',
description: 'SSH 与本地 Shell 多会话终端',
keywords: ['终端', 'terminal', 'shell', '命令行', 'console', '控制台', 'bash', 'ssh'],
tab: 'terminal'
},
{
title: '新建本地会话',
description: '打开 PowerShell / cmd / Git Bash / WSL',
keywords: ['新建', '本地', 'powershell', 'pwsh', 'cmd', 'git bash', 'wsl', '会话', '标签'],
tab: 'terminal'
},
{
title: 'SSH 主机',
description: '管理 SSH 主机连接(含跳板机与自动登录)',
keywords: ['ssh', '主机', '服务器', '远程', '连接', 'host', '远程登录'],
tab: 'hosts'
},
{
title: 'SSH 密钥管理',
description: '生成、导入与管理 SSH 密钥,passphrase 存入系统凭据管理器',
keywords: ['密钥', 'key', '私钥', '公钥', 'ed25519', 'rsa', 'ecdsa', 'passphrase', '指纹'],
tab: 'keys'
},
{
title: '已知主机(known_hosts',
description: '查看与清理主机密钥指纹记录,导出供审阅',
keywords: ['known_hosts', '指纹', '主机密钥', '信任', 'host key', '安全'],
tab: 'knownHosts'
},
{
title: '终端外观设置',
description: '主题、字体、光标、滚动缓冲与 GPU 渲染',
keywords: ['外观', '主题', '字体', '字号', '光标', '滚动', '颜色', '透明度'],
tab: 'settings'
},
{
title: '终端快捷键',
description: '自定义终端内快捷键(复制粘贴、标签、分屏、搜索)',
keywords: ['快捷键', '热键', 'shortcut', 'keybinding', '复制', '粘贴', '分屏'],
tab: 'settings'
},
{
title: '终端独立窗口',
description: '把会话拖出主窗口,独立窗口承载单个会话',
keywords: ['独立窗口', '分离', 'detach', '新窗口', '多屏'],
tab: 'settings'
}
]
export const moduleConfig: ModuleConfig = {
id: 'terminal',
name: '终端',
icon: 'terminal',
description: 'SSH 与本地 Shell 多会话终端(密钥管理 + 主机密钥校验 + 独立窗口)',
category: 'tool',
defaultEnabled: true,
loader: () => import('./TerminalModule.vue'),
searchItems,
lifecycle: {
// 模块启用:拉取一次会话列表(会话在 Rust 侧存活,模块被禁用期间不会中断)
onEnable: async () => {
// 动态导入避免 index.ts 直接依赖 store(会形成循环依赖,参见 music 模块的处理)
try {
const { useTerminalStore } = await import('@/stores/terminalStore')
const store = useTerminalStore()
await store.init()
} catch (e) {
console.error('[terminal] onEnable 初始化失败:', e)
}
},
onDisable: () => {
// 刻意**不**关闭会话:用户禁用模块通常是暂时的(排查冲突),
// 若此时杀掉正在跑长任务的 SSH 连接,代价远大于保留几个空闲会话。
// 真正的清理在应用退出时由 Rust 侧 cleanup_on_exit 统一处理。
}
},
// 排在音乐(15)之后、剪贴板(20)之前:终端是高频入口,应靠前
order: 18
}
File diff suppressed because it is too large Load Diff
+574
View File
@@ -0,0 +1,574 @@
/**
*
*
* Rust `src-tauri/src/terminal/settings.rs`
*
* ** `@/lib/bindings` **specta debug
* `tauri dev` bindings.ts
* translate P0
* `stores/terminalStore.ts` `commands.*`
*
* camelCase Rust `#[serde(rename_all = "camelCase")]`
*/
// ===== 本地 Shell =====
export interface EnvVar {
key: string
value: string
}
export interface ShellProfile {
id: string
name: string
/** 可执行文件绝对路径 */
path: string
args: string[]
/** 启动工作目录(空串表示用户主目录) */
cwd: string
env: EnvVar[]
/** 'powershell' | 'cmd' | 'bash' | 'wsl' */
kind: string
/** 自动探测得到(true 时 path 不可编辑) */
detected: boolean
enabled: boolean
}
// ===== SSH 主机 =====
export interface SshHost {
id: string
name: string
host: string
port: number
username: string
/** 'key' | 'password' | 'agent'P1| 'keyboard'P1 */
authMethod: string
keyId: string
group: string
note: string
color: string
favorited: boolean
connectTimeoutMs: number
keepaliveSecs: number
remoteCwd: string
startupCommand: string
useProxy: boolean
/** 跳板机链(ProxyJump):按连接顺序引用其他主机 id。空 = 直连。 */
jumpIds: string[]
/** 'utf-8'(默认)| 'gbk' 等 */
encoding: string
}
/** 主机视图:配置 + 派生凭据状态(**不含密码明文**) */
export interface HostView {
config: SshHost
hasPassword: boolean
/** 掩码串,未保存时为空 */
passwordMasked: string
/** 关联密钥是否存在且文件齐备 */
keyReady: boolean
/** 是否具备发起连接的条件 */
ready: boolean
/** 不可用原因(ready 为 true 时为空) */
issue?: string | null
}
/** 端口转发规则视图(后端 `ssh::forward::ForwardView` 镜像) */
export interface ForwardView {
id: string
/** 'local'-L| 'remote'-R */
kind: string
/** -L:本机监听地址;-R:服务器端监听地址 */
bindHost: string
bindPort: number
/** -L/-R 皆为「从服务器视角连接的目标」 */
targetHost: string
targetPort: number
/** 'active' | 'error' */
status: string
/** 人类可读状态(实际监听地址 / 错误原因) */
detail: string
}
// ===== 外观 / 布局 / 快捷键 / 安全 =====
export interface AppearanceSettings {
theme: string
followAppTheme: boolean
fontFamily: string
fontSize: number
lineHeight: number
letterSpacing: number
/** 'block' | 'bar' | 'underline' */
cursorStyle: string
cursorBlink: boolean
scrollback: number
/** 背景不透明度百分比(100 = 不透明) */
opacity: number
gpuRendering: boolean
}
export interface SelectionSettings {
copyOnSelect: boolean
middleClickPaste: boolean
/** 'menu'(默认)| 'paste' | 'select-word' */
rightClick: string
trimTrailingNewline: boolean
}
export interface LayoutSettings {
confirmCloseRunning: boolean
inheritCwd: boolean
sidebarOpen: boolean
sidebarWidth: number
showStatusBar: boolean
/** 分屏上限(后端封顶 4 */
maxPanes: number
}
export interface ShortcutBinding {
/** 动作标识,见 `terminalActions.ts` */
action: string
/** 键位字符串,如 "Ctrl+Shift+C" */
keys: string
enabled: boolean
}
export interface SecuritySettings {
/** 主机密钥策略(后端仅支持 "ask" */
hostKeyPolicy: string
blockOnFingerprintChange: boolean
auditLog: boolean
}
// ===== 密钥 =====
export interface KeyMeta {
id: string
name: string
/** 'ed25519' | 'rsa' | 'ecdsa' */
algorithm: string
bits: number
/** SHA256 指纹,OpenSSH 展示格式 */
fingerprint: string
/** 公钥内容,用于一键复制 */
publicKey: string
comment: string
fileName: string
/** RFC3339 */
createdAt: string
inAgent: boolean
}
export interface KeyView {
meta: KeyMeta
hasPassphrase: boolean
fileExists: boolean
}
export interface KeyGenParams {
name: string
/** 'ed25519'(默认)| 'rsa' | 'ecdsa' */
algorithm: string
/** RSA 2048/3072/4096ECDSA 256/384/521ed25519 忽略 */
bits: number
comment: string
passphrase: string
}
// ===== 会话 =====
export type SessionState =
| 'idle'
| 'connecting'
| 'authenticating'
| 'established'
| 'degraded'
| 'closed'
| 'failed'
export type SessionKind = 'local' | 'ssh'
export interface SessionInfo {
id: string
kind: SessionKind
title: string
state: SessionState
cols: number
rows: number
/** 当前工作目录(OSC 7 上报;未知为空串) */
cwd: string
/** Unix 毫秒 */
createdAt: number
exitCode?: number | null
error?: string | null
/** 本地为 shell idSSH 为 host id */
targetId: string
/** 是否已在独立窗口中打开 */
detached: boolean
/**
* `utf-8` / `gbk`
*
* **** base64 `OutputPayload.data`
*
* GBK
*/
encoding: string
/** 是否正在记录会话日志(后端 audit 模块;工具栏开关状态随之显示) */
logging: boolean
}
/**
*
*
* `SessionInfo.targetId` idshell user@host
* `SessionInfo`广
* targetId shells / hosts
*/
export function sessionTitleOf(s: SessionInfo): string {
return s.title || s.id
}
// ===== 事件负载 =====
export interface OutputPayload {
sessionId: string
/** base64 编码的原始字节(终端输出可能是 GBK 等非 UTF-8 编码) */
data: string
/** 全局单调批次序号,用于检测丢包 */
seq: number
}
export interface ExitPayload {
sessionId: string
exitCode?: number | null
/** 'eof' | 'process-exit' | 'killed' | 'disconnected' | 'error' | 'signal' */
reason?: string | null
}
export interface CwdPayload {
sessionId: string
cwd: string
}
/** 状态变更事件负载就是 SessionInfo 本身 */
export type StatePayload = SessionInfo
export interface HostKeyPromptPayload {
sessionId: string
host: string
port: number
keyType: string
fingerprint: string
/** 'unknown'(首次见到)| 'changed'(与记录不符,高危) */
reason: string
previousFingerprint?: string | null
}
/** 一次指纹变更的历史记录 */
export interface FingerprintChange {
oldFingerprint: string
/** RFC3339 */
changedAt: string
/** 用户当时是否接受了这次变更 */
accepted: boolean
}
export interface KnownHost {
host: string
port: number
keyType: string
fingerprint: string
/** 首次记录时间(RFC3339 */
firstSeen: string
/** 最近一次确认时间(RFC3339 */
lastConfirmed: string
/**
*
*
* ****
*
*
*/
history: FingerprintChange[]
}
export interface ActionOutcome {
ok: boolean
message: string
}
// ===== SFTP 文件管理 =====
/** 远端目录项(与 Rust 侧 `ssh::sftp::RemoteEntry` 对应) */
export interface RemoteEntry {
name: string
/** 完整路径(服务端形态,`/` 分隔) */
path: string
/** 'file' | 'dir' | 'symlink' | 'other' */
kind: string
size: number
/** Unix 毫秒;服务端未提供时为 undefined */
modifiedAt?: number | null
/** 权限位的八进制展示(如 "755");无权限信息时为空串 */
permissions: string
/** 符号链接的目标(仅 kind === 'symlink' 时非空) */
linkTarget: string
}
/**
*
*
* `cwd` ****
*
* `/opt/app -> /srv/app-v2`
* `/opt/app`
*/
export interface RemoteDir {
cwd: string
entries: RemoteEntry[]
}
/** 传输进度事件负载 */
export interface TransferProgress {
/** 传输任务 id(前端据此更新对应行的进度条) */
id: string
sessionId: string
/** 'upload' | 'download' */
direction: string
source: string
target: string
transferred: number
/** 总字节(未知时为 0 */
total: number
/** 'running' | 'done' | 'failed' | 'canceled' */
state: string
error?: string | null
}
/** 本地目录项(由浏览器 FS Access API 或路径补全用的 Windows 侧列举) */
export interface LocalEntry {
name: string
path: string
kind: 'file' | 'dir'
size: number
modifiedAt?: number
}
// ===== 命令片段 =====
/**
*
*
* `command` `${name}` **** `{name}`
* shell 使 `{}``${VAR}``awk '{print}'`brace expansion
* `${x}` `$${x}`
*/
export interface CommandSnippet {
id: string
name: string
command: string
description: string
/** 分组名(空串归入「未分组」) */
group: string
/** 占位符默认值:name → 默认值 */
defaults: Record<string, string>
/** 适用的 shell kind(空数组表示全部适用) */
shellKinds: string[]
/** 仅对 SSH 会话显示 */
sshOnly: boolean
/** 执行前需二次确认(危险命令) */
confirm: boolean
pinned: boolean
/** Unix 毫秒 */
createdAt: number
}
/**
* +
*
* `placeholders`
* `$${x}` `${VAR:-default}`
*
*/
export interface SnippetView extends CommandSnippet {
placeholders: string[]
}
// ===== 命令历史 =====
/**
*
*
* shell `.bash_history`
*
*/
export interface CommandHistoryItem {
id: number
/** 毫秒时间戳(最后一次执行) */
ts: number
command: string
/** 执行时的工作目录(OSC 7 未上报时为空串) */
cwd: string
hostId: string
/** 显示用来源名(「PowerShell」/「生产服务器」) */
hostName: string
ssh: boolean
/** 累计执行次数(同命令同目录重复执行时累加) */
count: number
favorited: boolean
exitCode: number | null
}
/** 历史查询参数 */
export interface HistoryQuery {
keyword: string
/** 只看某个来源(hostId;空串表示全部) */
hostId: string
favoritedOnly: boolean
offset: number
limit: number
}
/** 分页结果 */
export interface HistoryPage {
items: CommandHistoryItem[]
/** 满足筛选条件的总条数(不受 limit/offset 影响) */
total: number
}
/** 历史来源(供筛选下拉) */
export interface HistorySource {
hostId: string
hostName: string
count: number
ssh: boolean
}
// ===== 设置根结构 =====
export interface TerminalSettings {
version: number
shells: ShellProfile[]
hosts: SshHost[]
keys: KeyMeta[]
appearance: AppearanceSettings
layout: LayoutSettings
shortcuts: ShortcutBinding[]
selection: SelectionSettings
security: SecuritySettings
closeConfirmExempt: string[]
lastShellId: string
/** 命令片段库(v2 起) */
snippets: CommandSnippet[]
/** 会话模板(P2;一键拉起一组会话 + 布局) */
templates: SessionTemplate[]
}
/** 会话模板:一键拉起一组会话并排成布局 */
export interface SessionTemplate {
id: string
name: string
/** Unix 毫秒 */
createdAt: number
entries: TemplateEntry[]
}
/** 模板中的一个会话条目(targetId 为 shell id 或 host id 的引用) */
export interface TemplateEntry {
/** 'local' | 'ssh' */
kind: string
targetId: string
/** 保存时的展示名快照(仅用于列表显示) */
label: string
}
/** AI 命令助手:可用引擎(来自翻译设置的 AI 类型引擎) */
export interface AiEngineOption {
id: string
name: string
model: string
}
/** AI 命令助手:一条命令建议 */
export interface CommandSuggestion {
command: string
description: string
}
// ===== 设置版本 =====
/**
*
*
* Rust `TerminalSettings::default().version`
*
* v1 `snippets` undefined
*
*/
export const TERMINAL_SETTINGS_VERSION = 2
// ===== 字符编码 =====
/**
* Rust `encoding::SUPPORTED` `encoding::normalize()`
* ****
*
* #
*
*
* ****
* `terminal_set_encoding`
* UI
*
*
*
*/
export const ENCODING_OPTIONS: { value: string; label: string }[] = [
{ value: 'utf-8', label: 'UTF-8' },
{ value: 'gbk', label: 'GBK (中文)' },
{ value: 'gb18030', label: 'GB18030 (中文)' },
{ value: 'big5', label: 'Big5 (繁体)' },
{ value: 'shift_jis', label: 'Shift_JIS (日文)' },
{ value: 'euc-kr', label: 'EUC-KR (韩文)' },
{ value: 'latin1', label: 'Latin-1' }
]
/**
*
*
* 便
* GB18030 ()
*/
export function encodingShortLabel(encoding: string): string {
switch (encoding) {
case 'utf-8':
return 'UTF-8'
case 'gbk':
return 'GBK'
case 'gb18030':
return 'GB18030'
case 'big5':
return 'Big5'
case 'shift_jis':
return 'SJIS'
case 'euc-kr':
return 'EUC-KR'
case 'latin1':
return 'Latin-1'
default:
return encoding.toUpperCase()
}
}
/**
* UTF-8
*
*
* locale
* UTF-8
*/
export function isNonDefaultEncoding(encoding: string): boolean {
return encoding !== 'utf-8'
}