@hyzyn/dsh-tty 0.10.3 → 0.12.0

package/lib/index.d.ts

@@ -93,9 +93,20 @@ export interface Config {
     persistence?: 'off' | 'tmux';
     /** 页面（最后一个连接）断开且保活期结束时，是否连 tmux 持久会话一起结束（默认 false = 留存可恢复）。 */
     endOnPageClose?: boolean;
+    /** SFTP 传输限制（0 = 不限）。 */
+    sftpLimits?: Partial<SftpLimits>;
     /** 内部状态：SSH 持久会话名（远程 tmux 托管，本机 socket 清单看不到，随 settings 留存供新窗口恢复确认）。 */
     persistSessions?: Array<{
         tmuxName: string;
     }>;
 }
+/** SFTP 传输限制（均为 0 = 不限；客户端浏览器侧执行，宿主不做总量闸）。 */
+export interface SftpLimits {
+    /** 单文件下载上限（MB）。默认 1024。 */
+    maxDownloadMb: number;
+    /** 单文件上传上限（MB）。默认 2048。 */
+    maxUploadMb: number;
+    /** 一次批量/拖拽上传的文件数上限。默认 1000。 */
+    maxUploadFiles: number;
+}
 export declare const name: string, inject: string[] | undefined, apply: (ctx: Context, config?: Config | undefined) => void;

package/lib/index.js

@@ -15,12 +15,15 @@ const HeadlessTerminal = xtermHeadless.Terminal;
 import { definePlugin } from '@hyzyn/dsh-kit';
 import { defineTool } from '@deepseek-ai/dsh-tools';
 import { spawnSsh, sshTarget, expandHome } from './ssh.js';
+import { probeSsh } from './probe.js';
 import { buildShellSpawn } from './shell-integration.js';
 import { parseSshConfig } from './ssh-config.js';
 import { parseKnownHosts } from './known-hosts.js';
 import { TunnelManager } from './tunnels.js';
 import { SftpManager } from './sftp.js';
 import { buildTmuxSpawnPlan, ensureTmuxAssets, killTmuxSession, listTmuxSessions, probeTmux, refreshTmuxClient, sanitizePersistName } from './tmux.js';
+/** SFTP 传输限制默认值。 */
+const DEFAULT_SFTP_LIMITS = { maxDownloadMb: 1024, maxUploadMb: 2048, maxUploadFiles: 1000 };
 const SSH_HOST_SCHEMA = z.object({
     name: z.string(),
     host: z.string(),
@@ -67,6 +70,11 @@ const TTY_SETTINGS_SCHEMA = z.object({
     sftpStyle: z.union([z.const('dialog'), z.const('dual')]).default('dialog'),
     persistence: z.union([z.const('off'), z.const('tmux')]).default('off'),
     endOnPageClose: z.boolean().default(false),
+    sftpLimits: z.object({
+        maxDownloadMb: z.natural().max(1024 * 1024).default(1024),
+        maxUploadMb: z.natural().max(1024 * 1024).default(2048),
+        maxUploadFiles: z.natural().max(100000).default(1000),
+    }).default({ maxDownloadMb: 1024, maxUploadMb: 2048, maxUploadFiles: 1000 }),
     persistSessions: z.array(z.object({ tmuxName: z.string() })).default([]),
 });
 /* ------------------------------------------------------------------ *
@@ -85,7 +93,7 @@ const BUFFER_CAP = 256 * 1024;
 const TERM_RE = /^[A-Za-z0-9_.+-]+$/;
 /** 孤儿会话回收器的扫描间隔。 */
 const REAPER_INTERVAL_MS = 10_000;
-const TTY_GUIDANCE = '本机已安装 dsh-tty 插件（终端面板）：Web GUI 侧边栏的「终端」入口可打开交互终端（xterm.js + PTY），可运行任意命令与 TUI 程序（vim/htop 等），支持多标签页与断线自动重连（刷新页面/网络抖动后会话保活并恢复现场）；新标签默认在当前会话工作目录打开。标签栏「+」菜单还能开 SSH 标签页（ssh2 原生连接，连接簿在设置卡片维护，支持 agent forwarding 与主机指纹 TOFU 钉扎），像本地终端一样操作远程主机。设置卡片开启「会话持久化（tmux）」后，新开的本地/SSH 标签默认由 tmux server 托管（宿主重启/断线超时后重开即恢复现场），长任务建议在持久化开启时运行。长驻进程（dev server、watch、交互式程序）应引导用户到终端面板里运行，不要在 bash 工具里挂起等待；用户提到「开个终端 / 在终端里跑 / SSH 到某台机器」时引导其打开该面板。agent 侧配套工具：tty_list 列出活跃终端会话（含 SSH 的 target 与实时 cwd），tty_capture 读取近期输出（默认清洗 ANSI；last:true 拿「上一条命令」的输出+退出码），tty_screen 读取当前可见屏幕（可读懂 vim/htop 等 TUI），tty_expect 用正则等待输出中的就绪信号（如 dev server URL、构建完成），tty_send 发送按键，tunnel_list 列出端口转发隧道状态——操作会实时显示在用户终端里。SFTP 文件传输：面板内可对 SSH 连接簿条目（或 SSH 连接对话框当前填写的信息）打开文件浏览（上传/下载/建目录/重命名/删除），agent 配套 sftp_list 列远程目录、sftp_tree 递归看目录结构、sftp_read 读远程文本文件（≤1MB）、sftp_write 写远程文本文件（≤1MB，可追加）、sftp_mkdir 建目录（parents 可逐级补齐）、sftp_rename 重命名/移动、sftp_remove 删除（目录需 recursive），book 参数为连接簿条目名。端口转发：连接簿条目可配本地/远程隧道（如把远程数据库映射到本地端口），宿主自动保活重连，用户提到「转发端口 / 访问远程库」时引导其到终端面板设置卡片配置。推荐流程：tty_send 启动长任务 → tty_expect 等就绪标记 → tty_capture{last:true} 拿结果。';
+const TTY_GUIDANCE = '本机已安装 dsh-tty 插件（终端面板）：Web GUI 侧边栏的「终端」入口可打开交互终端（xterm.js + PTY），可运行任意命令与 TUI 程序（vim/htop 等），支持多标签页与断线自动重连（刷新页面/网络抖动后会话保活并恢复现场）；新标签默认在当前会话工作目录打开。标签栏「+」菜单还能开 SSH 标签页（ssh2 原生连接，连接簿在设置卡片维护，支持 agent forwarding 与主机指纹 TOFU 钉扎），像本地终端一样操作远程主机。设置卡片开启「会话持久化（tmux）」后，新开的本地/SSH 标签默认由 tmux server 托管（宿主重启/断线超时后重开即恢复现场），长任务建议在持久化开启时运行。长驻进程（dev server、watch、交互式程序）应引导用户到终端面板里运行，不要在 bash 工具里挂起等待；用户提到「开个终端 / 在终端里跑 / SSH 到某台机器」时引导其打开该面板。agent 侧配套工具：tty_list 列出活跃终端会话（含 SSH 的 target 与实时 cwd），tty_capture 读取近期输出（默认清洗 ANSI；last:true 拿「上一条命令」的输出+退出码），tty_screen 读取当前可见屏幕（可读懂 vim/htop 等 TUI），tty_expect 用正则等待输出中的就绪信号（如 dev server URL、构建完成），tty_send 发送按键，tunnel_list 列出端口转发隧道状态——操作会实时显示在用户终端里。SFTP 文件传输：面板内可对 SSH 连接簿条目（或 SSH 连接对话框当前填写的信息）打开文件浏览（上传/下载/建目录/重命名/删除），传输期间进度条右侧 ✕ 可取消（半截文件自动清理）；agent 配套 sftp_list 列远程目录、sftp_tree 递归看目录结构、sftp_read 读远程文本文件（≤1MB）、sftp_write 写远程文本文件（≤1MB，可追加）、sftp_mkdir 建目录（parents 可逐级补齐）、sftp_rename 重命名/移动、sftp_remove 删除（目录需 recursive），book 参数为连接簿条目名。端口转发：连接簿条目可配本地/远程隧道（如把远程数据库映射到本地端口），宿主自动保活重连，用户提到「转发端口 / 访问远程库」时引导其到终端面板设置卡片配置。推荐流程：tty_send 启动长任务 → tty_expect 等就绪标记 → tty_capture{last:true} 拿结果。';
 /** 本地 PTY 包装成 TermHandle（resize/kill 仍是透传 node-pty 的内部耦合；防御性降级）。 */
 function wrapLocalPty(handle) {
     let resizeWarned = false;
@@ -143,6 +151,8 @@ class LiveConfig {
     endOnPageClose;
     /** SSH 持久会话名（远程 tmux 托管；本机 socket 清单看不到，随 settings 留存）。 */
     persistSessions;
+    /** SFTP 传输限制（客户端浏览器侧执行）。 */
+    sftpLimits;
     constructor(init) {
         this.shell = init.shell;
         this.term = sanitizeTermValue(init.term, 'xterm-256color');
@@ -155,6 +165,7 @@ class LiveConfig {
         this.tunnels = init.tunnels ?? [];
         this.persistence = init.persistence === 'tmux' ? 'tmux' : 'off';
         this.endOnPageClose = init.endOnPageClose === true;
+        this.sftpLimits = sanitizeSftpLimits(init.sftpLimits);
         this.persistSessions = init.persistSessions ?? [];
     }
     /** 合并部分更新；空字符串/undefined 保持原值；sshHosts/hostKeys/tunnels 传数组即整体替换。 */
@@ -182,6 +193,8 @@ class LiveConfig {
             this.persistence = partial.persistence;
         if (typeof partial.endOnPageClose === 'boolean')
             this.endOnPageClose = partial.endOnPageClose;
+        if (partial.sftpLimits !== undefined)
+            this.sftpLimits = sanitizeSftpLimits({ ...this.sftpLimits, ...partial.sftpLimits });
         if (Array.isArray(partial.persistSessions))
             this.persistSessions = partial.persistSessions;
     }
@@ -503,6 +516,18 @@ function sanitizeHostKeys(input) {
     }
     return out;
 }
+/** 清洗一份 sftpLimits 输入：每项取 0~上限 的整数（0 = 不限），缺省回落默认值。 */
+function sanitizeSftpLimits(input) {
+    const num = (value, fallback, max) => {
+        const n = Number(value);
+        return Number.isInteger(n) && n >= 0 && n <= max ? n : fallback;
+    };
+    return {
+        maxDownloadMb: num(input?.maxDownloadMb, DEFAULT_SFTP_LIMITS.maxDownloadMb, 1024 * 1024),
+        maxUploadMb: num(input?.maxUploadMb, DEFAULT_SFTP_LIMITS.maxUploadMb, 1024 * 1024),
+        maxUploadFiles: num(input?.maxUploadFiles, DEFAULT_SFTP_LIMITS.maxUploadFiles, 100000),
+    };
+}
 /** 严格校验一份 hostKeys 输入（HTTP POST 路径）；返回错误信息或清洗后的数组。 */
 function validateHostKeys(input) {
     if (!Array.isArray(input))
@@ -1556,6 +1581,7 @@ const plugin = definePlugin({
             tunnels: Array.isArray(config?.tunnels) ? config.tunnels : [],
             persistence: config?.persistence === 'tmux' ? 'tmux' : 'off',
             endOnPageClose: config?.endOnPageClose === true,
+            sftpLimits: sanitizeSftpLimits(config?.sftpLimits),
             persistSessions: sanitizePersistSessions(config?.persistSessions) ?? [],
         });
         const sessions = new SessionManager(config?.maxSessions ?? DEFAULT_MAX_SESSIONS, () => live.endOnPageClose);
@@ -1611,6 +1637,7 @@ const plugin = definePlugin({
             sftpStyle: stateRef.sftpStyle,
             persistence: live.persistence,
             endOnPageClose: live.endOnPageClose,
+            sftpLimits: live.sftpLimits,
             toolsRegistered: stateRef.toolsRegistered,
         });
         /** 规范化并应用一份配置补丁（settings/updated 事件与 HTTP POST 共用；幂等）。 */
@@ -1627,6 +1654,7 @@ const plugin = definePlugin({
                 tunnels: sanitizeTunnels(section.tunnels),
                 persistence: section.persistence === 'tmux' || section.persistence === 'off' ? section.persistence : undefined,
                 endOnPageClose: typeof section.endOnPageClose === 'boolean' ? section.endOnPageClose : undefined,
+                sftpLimits: typeof section.sftpLimits === 'object' && section.sftpLimits !== null ? section.sftpLimits : undefined,
                 persistSessions: sanitizePersistSessions(section.persistSessions),
             });
             // 隧道按最新规格对齐（幂等；sshHosts 变更也会触发，让重连取到新凭证）
@@ -1645,7 +1673,7 @@ const plugin = definePlugin({
         /** 校验 HTTP POST 的配置体；返回规范化补丁或错误信息。 */
         const normalizePatch = (input) => {
             const patch = {};
-            const known = new Set(['enabled', 'announceToAgent', 'maxSessions', 'shell', 'term', 'colorTerm', 'cwd', 'reconnectGraceSec', 'sshHosts', 'hostKeys', 'tunnels', 'shellIntegration', 'sftpStyle', 'persistence', 'endOnPageClose']);
+            const known = new Set(['enabled', 'announceToAgent', 'maxSessions', 'shell', 'term', 'colorTerm', 'cwd', 'reconnectGraceSec', 'sshHosts', 'hostKeys', 'tunnels', 'shellIntegration', 'sftpStyle', 'persistence', 'endOnPageClose', 'sftpLimits']);
             for (const key of Object.keys(input)) {
                 if (!known.has(key))
                     return { error: '未知配置项: ' + key };
@@ -1731,6 +1759,22 @@ const plugin = definePlugin({
                     return { error: validated.error };
                 patch.tunnels = validated.tunnels;
             }
+            if (input.sftpLimits !== undefined) {
+                if (typeof input.sftpLimits !== 'object' || input.sftpLimits === null || Array.isArray(input.sftpLimits))
+                    return { error: 'sftpLimits 必须是对象' };
+                const raw = input.sftpLimits;
+                const next = {};
+                for (const key of ['maxDownloadMb', 'maxUploadMb', 'maxUploadFiles']) {
+                    if (raw[key] === undefined)
+                        continue;
+                    const value = Number(raw[key]);
+                    if (!Number.isInteger(value) || value < 0 || value > (key === 'maxUploadFiles' ? 100000 : 1024 * 1024)) {
+                        return { error: key + ' 必须是 0~' + (key === 'maxUploadFiles' ? '100000' : '1048576') + ' 的整数（0 = 不限）' };
+                    }
+                    next[key] = value;
+                }
+                patch.sftpLimits = next;
+            }
             return { patch };
         };
         // webServer：WS upgrade 路由 + 配置读写路由（/api/dsh-tty/config）
@@ -1847,6 +1891,72 @@ const plugin = definePlugin({
                         }
                     },
                 }));
+                // SSH 连接测试（0.11.0，src/probe.ts）：连接簿行「测试」与 SSH 对话框
+                // 「试连」共用。body 携带完整内联 SSH 规格（不引用连接簿——卡片测试
+                // 由客户端先行展开条目），免去服务端按 name 解析；只诊断不建会话。
+                // 连接簿条目测试传 store（新指纹当场 TOFU record）；对话框试连不带
+                // store（只比对不落盘，避免给未保存草稿建立钉扎）。
+                disposers.push(webServer.register({
+                    kind: 'exact',
+                    path: '/api/dsh-tty/probe',
+                    handler: async (req, res) => {
+                        if (!isLoopbackHttp(req)) {
+                            writeJson(res, 403, { error: 'forbidden: loopback-only' });
+                            return;
+                        }
+                        if (req.method !== 'POST') {
+                            writeJson(res, 405, { error: 'method not allowed: ' + String(req.method) });
+                            return;
+                        }
+                        const body = await readJsonBody(req);
+                        if (body === undefined) {
+                            writeJson(res, 400, { error: 'invalid JSON body' });
+                            return;
+                        }
+                        const host = typeof body.host === 'string' ? body.host.trim() : '';
+                        const username = typeof body.username === 'string' ? body.username.trim() : '';
+                        if (host === '' || username === '') {
+                            writeJson(res, 200, { ok: false, error: '主机与用户名必填' });
+                            return;
+                        }
+                        let port = 22;
+                        if (body.port !== undefined && body.port !== '') {
+                            const value = Number(body.port);
+                            if (!Number.isInteger(value) || value < 1 || value > 65535) {
+                                writeJson(res, 200, { ok: false, error: '端口必须是 1~65535 的整数' });
+                                return;
+                            }
+                            port = value;
+                        }
+                        const auth = body.auth === 'key' || body.auth === 'password' ? body.auth : 'agent';
+                        const spec = { host, port, username, auth };
+                        if (auth === 'key') {
+                            const keyPath = typeof body.keyPath === 'string' ? body.keyPath.trim() : '';
+                            if (keyPath === '') {
+                                writeJson(res, 200, { ok: false, error: 'auth=key 需要私钥路径' });
+                                return;
+                            }
+                            spec.keyPath = keyPath;
+                            const passphrase = typeof body.passphrase === 'string' ? body.passphrase : '';
+                            if (passphrase !== '')
+                                spec.passphrase = passphrase;
+                        }
+                        if (auth === 'password') {
+                            const password = typeof body.password === 'string' ? body.password : '';
+                            if (password === '') {
+                                writeJson(res, 200, { ok: false, error: 'auth=password 需要密码' });
+                                return;
+                            }
+                            spec.password = password;
+                        }
+                        if (body.agentForward === true)
+                            spec.agentForward = true;
+                        // bookRecord=true：来自连接簿条目的完整 TOFU（store 记录新指纹）；
+                        // 缺省（对话框试连）只比对不落盘
+                        const result = await probeSsh(spec, body.bookRecord === true ? hostKeyStore : undefined);
+                        writeJson(res, 200, { ok: result.auth.ok, result });
+                    },
+                }));
                 // 已安装 shell 候选（设置卡片「Shell 路径」可选可输入）：loopback 围栏，只回路径不执行
                 disposers.push(webServer.register({
                     kind: 'exact',
@@ -1997,17 +2107,30 @@ const plugin = definePlugin({
                                 writeJson(res, 400, { error: parsed.error ?? '无效的 SSH 连接规格' });
                                 return;
                             }
+                            // 取消上传（0.12.0）：客户端 abort → req 'aborted' → 打断 pipeline
+                            // 并删掉远端半截文件。不清理的话远端会留一个同名残留文件，用户
+                            // 只看得到「已取消」，却有个打不开的文件占着位。
+                            const controller = new AbortController();
+                            let abortedByClient = false;
+                            req.on('aborted', () => {
+                                abortedByClient = true;
+                                controller.abort();
+                            });
                             try {
                                 const { stream, done } = await sftpManager.openUpload(parsed.spec, target, meta.append === true);
                                 let bytes = 0;
                                 req.on('data', (chunk) => {
                                     bytes += chunk.length;
                                 });
-                                await pipeline(req, stream);
+                                await pipeline(req, stream, { signal: controller.signal });
                                 await done;
                                 writeJson(res, 200, { ok: true, bytes });
                             }
                             catch (error) {
+                                if (abortedByClient) {
+                                    void sftpManager.deleteRemoteQuiet(parsed.spec, target);
+                                    return;
+                                }
                                 const message = error instanceof Error ? error.message : String(error);
                                 if (res.headersSent)
                                     res.destroy();
@@ -2075,6 +2198,34 @@ const plugin = definePlugin({
                             }
                             if (sub === '/transfer') {
                                 // up = 本机→远程（上传），down = 远程→本机（下载）；目录递归
+                                // 0.12.0：任务化（start 返回 jobId，浏览器可轮询进度 / 取消），
+                                // 代替原先「一个 HTTP 请求同步跑完、无法打断」的直传。
+                                const action = strField('action');
+                                const jobId = strField('job');
+                                if (action === 'status') {
+                                    if (jobId === '')
+                                        throw new Error('job 必填');
+                                    const job = sftpManager.getTransfer(jobId);
+                                    if (job === undefined) {
+                                        writeJson(res, 404, { error: '传输任务不存在或已回收' });
+                                        return;
+                                    }
+                                    writeJson(res, 200, { ok: true, job });
+                                    return;
+                                }
+                                if (action === 'cancel') {
+                                    if (jobId === '')
+                                        throw new Error('job 必填');
+                                    const job = sftpManager.cancelTransfer(jobId);
+                                    if (job === undefined) {
+                                        writeJson(res, 404, { error: '传输任务不存在或已回收' });
+                                        return;
+                                    }
+                                    writeJson(res, 200, { ok: true, job });
+                                    return;
+                                }
+                                if (action !== '' && action !== 'start')
+                                    throw new Error('action 必须是 start/status/cancel');
                                 const direction = strField('direction');
                                 const localPath = strField('localPath');
                                 const remotePath = strField('remotePath');
@@ -2087,11 +2238,8 @@ const plugin = definePlugin({
                                     writeJson(res, 400, { error: parsed.error ?? '无效的 SSH 连接规格' });
                                     return;
                                 }
-                                if (direction === 'up')
-                                    await sftpManager.uploadFromLocal(parsed.spec, localPath, remotePath);
-                                else
-                                    await sftpManager.downloadToLocal(parsed.spec, remotePath, localPath);
-                                writeJson(res, 200, { ok: true });
+                                const job = sftpManager.startTransfer(parsed.spec, direction, localPath, remotePath);
+                                writeJson(res, 200, { ok: true, job });
                                 return;
                             }
                             writeJson(res, 404, { error: 'not found: ' + sub });