@zhangfengshun/dsh-remote-ssh 1.9.3 → 2.0.1

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 本文件的版本号与 `package.json` 的 `version` 保持一致。每个版本对应一个 Cordis Package 快照（`pkg-N`）。
 
+## [2.0.1] — 修复远程检测：从 payload.path 也查找 .remote-ssh.json
+### 修复
+- **sessionCwd 为空时无法检测远程工作区**：客户端请求有时只带 `payload.path` 不带 `cwd`，而 `ctx.sessions.get(sessionId)` 可能返回 undefined（session 未创建或 ID 不匹配）。现改为：先尝试 `sessionCwd`，再尝试 `payload.path`，两者都会检查 `.remote-ssh.json`。
+- 添加调试日志（`ctx.logger.info`）记录每次拦截的方法、sessionId、cwd 和远程检测结果。
+
+## [2.0.0] — 内置文件页签直接 SSH 读写远程文件（不再需要同步）
+### 重大变更
+- **内置「文件」页签直接操作远程文件**：通过注册更长前缀 `/sidebar/api/fs.` 拦截 better-sidebar 的文件 API（`fs.tree`/`fs.read`/`fs.write`/`fs.search`），在远程工作区中直接通过 SSH 读写远程文件，不再需要 sync/push 同步。
+- **透明路径映射**：客户端看到的是本地镜像路径，host 拦截器自动转换为远程路径，通过 SSH 执行操作后返回结果。
+- **本地工作区照常**：非远程工作区的请求走本地 fs，行为与 better-sidebar 原始实现一致。
+- 不再依赖 tar 同步——打开文件 = 直接读远程，保存文件 = 直接写远程。
+
 ## [1.9.3] — 修复 syncDown 删除 .remote-ssh.json 导致终端不工作
 ### 修复
 - **`remoteSyncDown` 会清空镜像目录**：syncDown 先 `rm -rf` 镜像目录再 `tar xf` 展开，导致之前写入的 `.remote-ssh.json`（供 shell wrapper 读取连接信息）被删掉，终端 wrapper 检测不到远程工作区，降级到本地 shell。

package/README.md

@@ -29,7 +29,7 @@ dsh plugin --profile <name> add /absolute/path/to/dsh-remote-ssh
 ### 发布后安装
 
 ```bash
-dsh plugin --profile <name> add @zhangfengshun/dsh-remote-ssh@1.9.3
+dsh plugin --profile <name> add @zhangfengshun/dsh-remote-ssh@2.0.0
 ```
 
 > ⚠️ 安装后需**重启 DSH** 才生效；后续仅修改 Client 半边时刷新浏览器即可。

package/lib/index.js

@@ -11,14 +11,14 @@
 import z from "schemastery";
 import { defineTool } from "@deepseek-ai/dsh-tools";
 import { settingsNamespace } from "@deepseek-ai/dsh-settings";
-import { mkdir, rm, writeFile, readFile } from "node:fs/promises";
+import { mkdir, rm, writeFile, readFile, opendir, stat, open, rename, readdir } from "node:fs/promises";
 import { homedir } from "node:os";
 import { join } from "node:path";
 
 /** Plugin identity for cordis.yml rows. */
 const name = "@zhangfengshun/dsh-remote-ssh";
 /** Services required before mounting. */
-const inject = ["webServer", "subprocess", "tools"];
+const inject = ["webServer", "subprocess", "tools", "sessions", "webRuntime"];
 /** Composition config schema（本插件暂无配置项）。 */
 const Config = z.object({});
 
@@ -1393,6 +1393,243 @@ function apply(ctx, config) {
     }
   })();
 
+  // ---- 拦截 better-sidebar 的 fs.* API：远程工作区走 SSH，本地走本地 fs ----
+  // 注册更长前缀 /sidebar/api/fs. 优先于 better-sidebar 的 /sidebar/api 匹配。
+  const READ_LIMIT = 524288;
+  const LIST_LIMIT = 1000;
+
+  // 读取镜像目录下的 .remote-ssh.json，返回连接信息或 null
+  function readRemoteInfoSync(mirrorCwd) {
+    if (!mirrorCwd) return null;
+    try {
+      const fs2 = require("fs");
+      const jsonPath = require("path").join(mirrorCwd, ".remote-ssh.json");
+      if (fs2.existsSync(jsonPath)) {
+        return JSON.parse(fs2.readFileSync(jsonPath, "utf8"));
+      }
+    } catch (e) {}
+    return null;
+  }
+
+  // 把本地镜像路径转换为远程路径
+  function localToRemote(localPath, mirrorCwd, remoteBase) {
+    if (!localPath) return remoteBase;
+    // 规范化：去掉前缀 mirrorCwd，剩余部分拼到 remoteBase
+    let rel = String(localPath);
+    const mc = String(mirrorCwd).replace(/\\/g, "/");
+    rel = rel.replace(/\\/g, "/");
+    if (rel.toLowerCase().startsWith(mc.toLowerCase())) {
+      rel = rel.slice(mc.length);
+    } else {
+      // 可能是相对于 cwd 的路径
+    }
+    if (rel.startsWith("/")) rel = rel.slice(1);
+    if (!rel) return remoteBase;
+    // 拼接远程路径
+    const rb = String(remoteBase).replace(/\/+$/, "");
+    return rb + "/" + rel;
+  }
+
+  // 本地 listDirectory（复制 better-sidebar 的逻辑）
+  async function localListDir(path, maxEntries) {
+    let level;
+    try { level = await opendir(path); }
+    catch (e) { return { ok: false, error: "cannot list: " + String(e && e.message ? e.message : e) }; }
+    const rows = [];
+    let overflow = 0;
+    try {
+      for await (const dirent of level) {
+        if (rows.length >= (maxEntries || 1000)) { overflow++; continue; }
+        rows.push({
+          name: dirent.name,
+          path: join(path, dirent.name),
+          isDir: dirent.isDirectory(),
+          isSymlink: dirent.isSymbolicLink(),
+          broken: false,
+          hidden: dirent.name.startsWith(".")
+        });
+      }
+    } catch (e) { return { ok: false, error: "cannot list: " + String(e && e.message ? e.message : e) }; }
+    rows.sort(function (a, b) {
+      if (a.isDir !== b.isDir) return a.isDir ? -1 : 1;
+      return a.name.localeCompare(b.name, undefined, { sensitivity: "base" });
+    });
+    return { path: path, entries: rows, truncated: overflow > 0 };
+  }
+
+  // 本地 readText（复制 better-sidebar 的逻辑）
+  async function localReadText(path, readLimit) {
+    const info = await stat(path).catch(function (e) { throw new Error("cannot read: " + String(e && e.message ? e.message : e)); });
+    if (info.isDirectory()) throw new Error("is a directory");
+    const size = info.size;
+    const truncated = size > readLimit;
+    const handle = await open(path, "r");
+    try {
+      const buffer = Buffer.alloc(Math.min(size, readLimit));
+      const r = await handle.read(buffer, 0, buffer.length, 0);
+      const slice = buffer.subarray(0, r.bytesRead);
+      const binary = slice.includes(0);
+      if (binary) {
+        return { kind: "binary", size: size, truncated: truncated, head: slice.subarray(0, Math.min(slice.length, 4096)).toString("base64") };
+      }
+      return { kind: "text", content: slice.toString("utf8"), truncated: truncated };
+    } finally { await handle.close(); }
+  }
+
+  // 本地 writeFile（原子写入）
+  async function localWriteFile(path, content) {
+    const tmp = path + ".dsh-rssh-tmp-" + process.pid;
+    try {
+      await mkdir(require("path").dirname(path), { recursive: true });
+      await writeFile(tmp, content, "utf8");
+      await rename(tmp, path);
+    } catch (e) {
+      try { await rm(tmp, { force: true }); } catch (e2) {}
+      throw e;
+    }
+    return { ok: true };
+  }
+
+  // 本地 searchFiles（简单递归文件名搜索）
+  async function localSearchFiles(root, query) {
+    if (!query) return { entries: [] };
+    const q = query.toLowerCase();
+    const results = [];
+    async function walk(dir, depth) {
+      if (depth > 10 || results.length > 500) return;
+      let entries;
+      try { entries = await readdir(dir, { withFileTypes: true }); }
+      catch (e) { return; }
+      for (const e of entries) {
+        if (e.name.toLowerCase().includes(q)) {
+          results.push({ path: join(dir, e.name), isDir: e.isDirectory() });
+          if (results.length > 500) return;
+        }
+        if (e.isDirectory() && !e.name.startsWith(".") && e.name !== "node_modules") {
+          await walk(join(dir, e.name), depth + 1);
+        }
+      }
+    }
+    await walk(root, 0);
+    return { entries: results, truncated: false };
+  }
+
+  // 远程 listDir → better-sidebar 格式
+  async function remoteListForSidebar(profile, remotePath, localCwd) {
+    const r = await remoteListDir(runPooled, profile, remotePath);
+    if (!r.ok) return { ok: false, error: r.error || "list failed" };
+    const entries = (r.entries || []).map(function (e) {
+      return {
+        name: e.name,
+        path: join(localCwd, e.name), // 返回本地镜像路径格式，保持客户端兼容
+        isDir: e.type === "directory",
+        isSymlink: false,
+        broken: false,
+        hidden: e.name.startsWith(".")
+      };
+    });
+    entries.sort(function (a, b) {
+      if (a.isDir !== b.isDir) return a.isDir ? -1 : 1;
+      return a.name.localeCompare(b.name, undefined, { sensitivity: "base" });
+    });
+    return { path: localCwd, entries: entries, truncated: false };
+  }
+
+  // 远程 readText → better-sidebar 格式
+  async function remoteReadForSidebar(profile, remotePath) {
+    const r = await remoteReadFile(runPooled, profile, remotePath);
+    if (!r.ok) return { ok: false, error: r.error || "read failed" };
+    if (r.binary) {
+      return { kind: "binary", size: 0, truncated: !!r.truncated, head: (r.content || "").slice(0, 4096) };
+    }
+    return { kind: "text", content: r.content || "", truncated: !!r.truncated };
+  }
+
+  ctx.effect(() => ctx.webServer.register({
+    kind: "prefix",
+    path: "/sidebar/api/fs.",
+    handler: async (req, res) => {
+      if (!isTrusted(req)) { writeJson(res, 403, { ok: false, error: { code: "forbidden", message: "forbidden" } }); return; }
+      if (req.method !== "POST") { writeJson(res, 405, { ok: false, error: { code: "method-error", message: "method not allowed" } }); return; }
+      const pathname = new URL(req.url || "/", "http://dsh.internal").pathname;
+      const method = "fs." + pathname.slice("/sidebar/api/fs.".length);
+      let payload;
+      try { payload = await readJsonBody(req); }
+      catch (e) { writeJson(res, 400, { ok: false, error: { code: "bad-request", message: String(e && e.message ? e.message : e) } }); return; }
+      try {
+        // 获取会话 cwd
+        const sessionId = payload && payload.sessionId;
+        let sessionCwd = payload && payload.cwd;
+        if ((!sessionCwd || sessionCwd === "") && sessionId && ctx.sessions) {
+          const session = ctx.sessions.get(sessionId);
+          sessionCwd = session && session.header && session.header.cwd;
+        }
+        // 如果 sessionCwd 还是空，尝试用 payload.path 的父目录（文件操作时 path 是文件路径）
+        if ((!sessionCwd || sessionCwd === "") && payload && payload.path) {
+          sessionCwd = payload.path;
+        }
+        // 检查是否远程工作区
+        const remoteInfo = readRemoteInfoSync(sessionCwd);
+        // 如果 cwd 本身没有 .remote-ssh.json，尝试从 payload.path 向上查找
+        let remoteInfoFromPath = remoteInfo;
+        if (!remoteInfo && payload && payload.path) {
+          remoteInfoFromPath = readRemoteInfoSync(payload.path);
+        }
+        ctx.logger?.info("[dsh-remote-ssh] fs.* intercept: method=" + method + " sessionId=" + sessionId + " cwd=" + sessionCwd + " payload.path=" + (payload && payload.path) + " remoteInfo=" + (remoteInfo ? "YES" : "NO") + " remoteInfoFromPath=" + (remoteInfoFromPath ? "YES" : "NO"));
+        let result;
+        if (remoteInfoFromPath && remoteInfoFromPath.keyPath && remoteInfoFromPath.host && remoteInfoFromPath.user) {
+          const actualRemoteInfo = remoteInfo || remoteInfoFromPath;
+          const actualCwd = sessionCwd || (payload && payload.path) || "";
+          // ---- 远程工作区：走 SSH ----
+          const profile = getProfile(actualRemoteInfo.profileId);
+          if (!profile) { writeJson(res, 500, { ok: false, error: { code: "internal", message: "remote profile not found" } }); return; }
+          if (method === "fs.tree") {
+            const localPath = payload.path || actualCwd;
+            const rp = localToRemote(localPath, actualCwd, actualRemoteInfo.remotePath);
+            result = await remoteListForSidebar(profile, rp, localPath);
+          } else if (method === "fs.read") {
+            const localPath = payload.path || actualCwd;
+            const rp = localToRemote(localPath, actualCwd, actualRemoteInfo.remotePath);
+            result = await remoteReadForSidebar(profile, rp);
+          } else if (method === "fs.write") {
+            const localPath = payload.path || actualCwd;
+            const rp = localToRemote(localPath, actualCwd, actualRemoteInfo.remotePath);
+            result = await remoteWriteFile(runPooled, profile, rp, payload.content || "");
+          } else if (method === "fs.search") {
+            const rp = actualRemoteInfo.remotePath;
+            const r = await remoteGlob(runPooled, profile, "*" + (payload.query || "") + "*", rp);
+            result = { entries: (r.files || []).map(function (f) {
+              return { path: join(actualCwd, f), isDir: false };
+            }), truncated: !!r.truncated };
+          } else {
+            writeJson(res, 404, { ok: false, error: { code: "not-found", message: "unknown method " + method } }); return;
+          }
+        } else {
+          // ---- 本地工作区：走本地 fs ----
+          if (method === "fs.tree") {
+            const p = payload.path || sessionCwd;
+            result = await localListDir(p, LIST_LIMIT);
+          } else if (method === "fs.read") {
+            result = await localReadText(payload.path, READ_LIMIT);
+          } else if (method === "fs.write") {
+            result = await localWriteFile(payload.path, payload.content || "");
+          } else if (method === "fs.search") {
+            result = await localSearchFiles(sessionCwd, payload.query || "");
+          } else {
+            writeJson(res, 404, { ok: false, error: { code: "not-found", message: "unknown method " + method } }); return;
+          }
+        }
+        if (result && result.ok === false) {
+          writeJson(res, 400, { ok: false, error: { code: "fs-error", message: result.error || "operation failed" } });
+        } else {
+          writeOk(res, result);
+        }
+      } catch (e) {
+        writeJson(res, 400, { ok: false, error: { code: "fs-error", message: String(e && e.message ? e.message : e) } });
+      }
+    }
+  }), "dsh-remote-ssh: intercept /sidebar/api/fs.* for remote workspaces");
+
   // ---- 清理 ----
   ctx.effect(() => () => {
     clearInterval(idleTimer);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhangfengshun/dsh-remote-ssh",
-  "version": "1.9.3",
+  "version": "2.0.1",
   "description": "DSH web plugin: VSCode Remote-SSH-like remote development (SSH to supercomputers/servers, remote workspace, file explorer, integrated terminal), integrated with dsh-better-sidebar and DSH settings.",
   "keywords": [
     "dsh",