pi-webdav-backup 1.0.1 → 1.3.0

package/extensions/webdav-backup/collect.mjs

@@ -3,7 +3,54 @@
  */
 
 import { readdirSync, statSync, lstatSync } from "node:fs";
-import { join, relative, sep, posix } from "node:path";
+import { join, relative, sep, posix, resolve } from "node:path";
+
+/**
+ * 把 agentDir 之外的绝对路径映射成归档内安全、无歧义的相对路径。
+ *   C:\Users\me\.pi\settings.json → extra/C/Users/me/.pi/settings.json
+ *   /home/me/.pi/settings.json    → extra/home/me/.pi/settings.json
+ */
+export function extraArchivePath(absPath) {
+  let p = resolve(String(absPath)).replace(/\\/g, "/");
+  p = p.replace(/^([A-Za-z]):\//, "$1/"); // 去掉盘符后的冒号，保留盘符作为首段
+  const segs = p.split("/").filter((s) => s && s !== "." && s !== "..");
+  return `extra/${segs.join("/")}`;
+}
+
+/**
+ * 该额外路径是否是“配置/数据类”文件（值得一并脱敏保护）。
+ * 目录一律视为需要保护（其下内容逐文件判断）。
+ */
+export function isDataLikeExtraPath(absPath) {
+  const b = String(absPath).replace(/\\/g, "/").split("/").pop() ?? "";
+  const lower = b.toLowerCase();
+  return (
+    lower.endsWith(".json") ||
+    lower === ".env" ||
+    lower.startsWith(".env.") ||
+    /\.(ya?ml|toml|ini|conf|cfg|txt)$/i.test(lower) ||
+    ["config", "config.json", "settings", "auth", "secret", "secrets", "credentials"].includes(lower)
+  );
+}
+
+/**
+ * 从 extraScope 推导出归档内“需要脱敏”的路径集合。
+ * 目录 → "extra/.../dir/"（前缀匹配）；数据类文件 → "extra/.../file"（精确匹配）。
+ */
+export function deriveSensitivePaths(extraScope) {
+  const out = [];
+  for (const p of extraScope ?? []) {
+    try {
+      const st = statSync(p);
+      if (st.isDirectory()) out.push(`${extraArchivePath(p)}/`);
+      else if (st.isFile() && isDataLikeExtraPath(p)) out.push(extraArchivePath(p));
+    } catch {
+      /* 不存在就跳过（反正不会被收集） */
+    }
+  }
+  return out;
+}
+
 
 /** glob -> RegExp（支持 **、*、?） */
 export function globToRegExp(glob) {
@@ -57,9 +104,10 @@ export function makeExcluder(patterns) {
  * @param {string} opts.agentDir  基准目录
  * @param {string[]} opts.scope   相对 agentDir 的路径列表
  * @param {string[]} opts.exclude glob 排除规则
+ * @param {string[]} [opts.extraScope] agentDir 之外的绝对路径（文件或目录）
  * @returns {{files: {abs: string, rel: string, size: number, mtimeMs: number}[], skipped: number, totalSize: number}}
  */
-export function collectFiles({ agentDir, scope, exclude, followSymlinks = false }) {
+export function collectFiles({ agentDir, scope, exclude, extraScope = [], followSymlinks = false }) {
   const isExcluded = makeExcluder(exclude);
   const files = [];
   let skipped = 0;
@@ -119,6 +167,60 @@ export function collectFiles({ agentDir, scope, exclude, followSymlinks = false
     }
   }
 
+  // agentDir 之外的额外路径（~/.pi/settings.json、~/.config/rpiv-* 等）
+  for (const extra of extraScope) {
+    let st;
+    try {
+      st = lstatSync(extra);
+    } catch {
+      skipped++;
+      continue;
+    }
+    const baseRel = extraArchivePath(extra);
+    if (st.isDirectory()) {
+      walkExtra(extra, baseRel);
+    } else if (st.isFile()) {
+      if (!isExcluded(baseRel)) {
+        files.push({ abs: extra, rel: baseRel, size: st.size, mtimeMs: Math.floor(st.mtimeMs) });
+      }
+    } else {
+      skipped++;
+    }
+  }
+
+  function walkExtra(abs, relPath) {
+    let entries;
+    try {
+      entries = readdirSync(abs, { withFileTypes: true });
+    } catch {
+      return;
+    }
+    for (const ent of entries) {
+      const absPath = join(abs, ent.name);
+      const rel = `${relPath}/${ent.name}`;
+      if (isExcluded(rel)) {
+        skipped++;
+        continue;
+      }
+      let st2;
+      try {
+        st2 = followSymlinks ? statSync(absPath) : lstatSync(absPath);
+      } catch {
+        continue;
+      }
+      if (st2.isSymbolicLink()) {
+        skipped++;
+        continue;
+      }
+      if (st2.isDirectory()) walkExtra(absPath, rel);
+      else if (st2.isFile()) {
+        files.push({ abs: absPath, rel, size: st2.size, mtimeMs: Math.floor(st2.mtimeMs) });
+      } else {
+        skipped++;
+      }
+    }
+  }
+
   files.sort((a, b) => (a.rel < b.rel ? -1 : a.rel > b.rel ? 1 : 0));
   const totalSize = files.reduce((n, f) => n + f.size, 0);
   return { files, skipped, totalSize };

package/extensions/webdav-backup/config.mjs

@@ -25,13 +25,16 @@ function stripBom(text) {
   return text.replace(/^\uFEFF/, "");
 }
 
-const DEFAULT_EXCLUDE = [
+/**
+ * 基础排除：这些内容要么是缓存、要么可重建、要么是密钥，任何情况下都不备份。
+ */
+const BASE_EXCLUDE = [
   "tmp/**",
   "web-search-cache/**",
-  "npm/node_modules/**",
   "sessions/**",
   "**/*.log",
-  "**/node_modules/**",
+  // pi 管理的 fd/rg 二进制，换机后会自动重新下载，不值得备份
+  "bin/**",
   // 密钥相关，绝不能进备份
   "secrets/**",
   "secrets.dpapi.json",
@@ -43,6 +46,37 @@ const DEFAULT_EXCLUDE = [
   "**/*.save",
 ];
 
+/**
+ * 插件实现代码的排除规则。
+ *  - 默认（includePlugins: false）：完全排除 node_modules（瘦备份，恢复后靠联网补装）
+ *  - 开启（includePlugins: true）：保留 node_modules，只排除其中运行时用不到、体积大的部分，
+ *    这样换机恢复后插件即可直接使用，无需联网重装。
+ */
+const PLUGIN_EXCLUDE = ["**/node_modules/**", "npm/node_modules/**"];
+const PLUGIN_KEEP_EXCLUDE = [
+  // git 仓库内部数据：运行时不需要，却可能很大、且含平台相关对象
+  "**/.git/**",
+  "**/node_modules/.cache/**",
+  "**/node_modules/.vite/**",
+  "**/node_modules/.turbo/**",
+  "**/node_modules/.bin/**",
+];
+
+/** 按 includePlugins 组装最终排除列表 */
+function buildExclude(userExclude, includePlugins) {
+  const extra = Array.isArray(userExclude) ? userExclude.map(String) : [];
+  const pluginRules = includePlugins ? PLUGIN_KEEP_EXCLUDE : PLUGIN_EXCLUDE;
+  return [...BASE_EXCLUDE, ...pluginRules, ...extra];
+}
+
+function expandTildeValue(p) {
+  const s = String(p ?? "").trim();
+  if (!s) return "";
+  if (s === "~") return homedir();
+  if (s.startsWith("~/") || s.startsWith("~\\")) return join(homedir(), s.slice(2));
+  return s;
+}
+
 /**
  * 读取配置。返回 { ok, config, errors, warnings, raw }
  */
@@ -97,9 +131,14 @@ export function loadConfig() {
     remoteDir: String(remote.remoteDir ?? raw.remoteDir ?? "pi-backup").replace(/^\/+|\/+$/g, ""),
     remoteName: String(remote.remoteName ?? raw.remoteName ?? "pi-agent").trim(),
     scope: Array.isArray(raw.scope) && raw.scope.length > 0 ? raw.scope.map(String) : ["."],
-    exclude: Array.isArray(raw.exclude)
-      ? [...DEFAULT_EXCLUDE, ...raw.exclude.map(String)]
-      : DEFAULT_EXCLUDE,
+    // 是否把插件实现代码（node_modules）一起备份。开启后换机恢复即可直接使用，无需联网重装。
+    includePlugins: raw.includePlugins === true,
+    // agentDir 之外的额外备份路径（绝对路径或 ~/...）。用于把 ~/.pi/settings.json、
+    // ~/.config/rpiv-* 等插件写在 agentDir 之外的数据一并带上。
+    extraScope: Array.isArray(raw.extraScope)
+      ? [...new Set(raw.extraScope.map(expandTildeValue).filter(Boolean))]
+      : [],
+    exclude: buildExclude(raw.exclude, raw.includePlugins === true),
     includeSessions: raw.includeSessions === true,
     snapshot: raw.snapshot === true,
     encrypt: raw.encrypt === true,
@@ -174,8 +213,15 @@ export function configTemplate() {
     },
     _说明_scope: "要备份的路径，相对 ~/.pi/agent",
     scope: ["."],
-    _说明_exclude: "额外排除规则（glob），内置已排除 tmp/、sessions/、缓存、node_modules",
+    _说明_includePlugins:
+      "是否把插件实现代码（node_modules）一起备份。true=换机恢复后插件可直接用、无需联网重装（推荐）；false=瘦备份，恢复后需 /backup repair-plugins 补装",
+    includePlugins: false,
+    _说明_exclude:
+      "额外排除规则（glob）。内置已排除 tmp/、sessions/、缓存、bin/、密钥副本；includePlugins=false 时另排除 node_modules",
     exclude: [],
+    _说明_extraScope:
+      "agentDir 之外的额外备份路径（绝对路径或 ~/...），例如 \"~/.pi/settings.json\"、\"~/.pi/web-search.json\"、\"~/.config/rpiv-todo\"；归档内落在 extra/ 前缀下，恢复时按当前机器的家目录/XDG 锚点重映射（支持换用户名/盘符）",
+    extraScope: [],
     _说明_includeSessions: "是否包含会话历史（可能很大）",
     includeSessions: false,
     _说明_snapshot: "true=逐文件快照上传（增量，可单文件恢复）；false=打包成单个 tar.gz（默认）",

package/extensions/webdav-backup/dav-mock.mjs

@@ -1,145 +1,166 @@
-/**
- * dav-mock.mjs — 内存 WebDAV 服务端（供测试使用）
- * 支持 PROPFIND / MKCOL / PUT / GET / HEAD / DELETE + Basic Auth
- */
-
-import http from "node:http";
-
-export function startDavServer({ username = "user", password = "pass" } = {}) {
-  /** @type {Map<string, Buffer>} */
-  const store = new Map();
-  const dirs = new Set(["/"]);
-  const expectedAuth = "Basic " + Buffer.from(`${username}:${password}`).toString("base64");
-  let putCount = 0;
-  let getCount = 0;
-
-  const server = http.createServer((req, res) => {
-    const path = decodeURIComponent((req.url ?? "/").split("?")[0]);
-    const key = path.replace(/\/+$/, "") || "/";
-    const method = (req.method ?? "GET").toUpperCase();
-
-    if (req.headers.authorization !== expectedAuth) {
-      res.writeHead(401, { "WWW-Authenticate": 'Basic realm="dav"' });
-      res.end("unauthorized");
-      return;
-    }
-
-    if (method === "PROPFIND") {
-      const depth = req.headers.depth ?? "0";
-      if (!dirs.has(key) && !store.has(key)) {
-        res.writeHead(404).end("not found");
-        return;
-      }
-      const prefix = key === "/" ? "/" : `${key}/`;
-      const children = [];
-      if (depth !== "0") {
-        for (const d of dirs) {
-          if (d === key) continue;
-          if (d.startsWith(prefix)) {
-            const rest = d.slice(prefix.length);
-            if (rest && !rest.includes("/")) {
-              children.push({ href: d, isDir: true, size: 0, lm: new Date().toUTCString() });
-            }
-          }
-        }
-        for (const [p, buf] of store) {
-          if (p.startsWith(prefix)) {
-            const rest = p.slice(prefix.length);
-            if (rest && !rest.includes("/")) {
-              children.push({ href: p, isDir: false, size: buf.length, lm: new Date().toUTCString() });
-            }
-          }
-        }
-      }
-      const responses = [
-        { href: key, isDir: !store.has(key), size: store.get(key)?.length ?? 0, lm: new Date().toUTCString() },
-        ...children,
-      ];
-      const xml =
-        `<?xml version="1.0" encoding="utf-8"?>\n<D:multistatus xmlns:D="DAV:">\n` +
-        responses
-          .map(
-            (e) =>
-              `  <D:response><D:href>${e.href}</D:href><D:propstat><D:prop>` +
-              `<D:getcontentlength>${e.size}</D:getcontentlength>` +
-              `<D:getlastmodified>${e.lm}</D:getlastmodified>` +
-              `<D:resourcetype>${e.isDir ? "<D:collection/>" : ""}</D:resourcetype>` +
-              `</D:prop><D:status>HTTP/1.1 200 OK</D:status></D:propstat></D:response>`,
-          )
-          .join("\n") +
-        `\n</D:multistatus>`;
-      res.writeHead(207, { "Content-Type": "application/xml" }).end(xml);
-      return;
-    }
-
-    if (method === "MKCOL") {
-      if (dirs.has(key) || store.has(key)) {
-        res.writeHead(405).end("exists");
-        return;
-      }
-      dirs.add(key);
-      res.writeHead(201).end();
-      return;
-    }
-
-    if (method === "PUT") {
-      const chunks = [];
-      req.on("data", (c) => chunks.push(c));
-      req.on("end", () => {
-        putCount++;
-        store.set(key, Buffer.concat(chunks));
-        res.writeHead(201).end();
-      });
-      return;
-    }
-
-    if (method === "GET") {
-      if (!store.has(key)) {
-        res.writeHead(404).end();
-        return;
-      }
-      getCount++;
-      const buf = store.get(key);
-      res.writeHead(200, { "Content-Length": String(buf.length) }).end(buf);
-      return;
-    }
-
-    if (method === "HEAD") {
-      if (!store.has(key)) {
-        res.writeHead(404).end();
-        return;
-      }
-      res.writeHead(200, { "Content-Length": String(store.get(key).length) }).end();
-      return;
-    }
-
-    if (method === "DELETE") {
-      if (store.delete(key) || dirs.delete(key)) {
-        res.writeHead(204).end();
-        return;
-      }
-      res.writeHead(404).end();
-      return;
-    }
-
-    res.writeHead(405).end("method not allowed");
-  });
-
-  return new Promise((resolve) => {
-    server.listen(0, "127.0.0.1", () => {
-      const addr = server.address();
-      const port = typeof addr === "object" && addr ? addr.port : 0;
-      resolve({
-        server,
-        port,
-        store,
-        dirs,
-        stats: () => ({ putCount, getCount }),
-        reset: () => {
-          putCount = 0;
-          getCount = 0;
-        },
-      });
-    });
-  });
-}
+/**
+ * dav-mock.mjs — 内存 WebDAV 服务端（供测试使用）
+ * 支持 PROPFIND / MKCOL / PUT / GET / HEAD / DELETE + Basic Auth
+ *
+ * 可选：
+ *   requireAuth: false    不校验认证（用于模拟对象存储）
+ *   redirectGetsTo        所有 GET 都 302 到该地址 + 原路径
+ *                         （模拟 Cloudreve/群晖把下载重定向到对象存储）
+ */
+
+import http from "node:http";
+
+export function startDavServer({
+  username = "user",
+  password = "pass",
+  requireAuth = true,
+  redirectGetsTo = null,
+} = {}) {
+  /** @type {Map<string, Buffer>} */
+  const store = new Map();
+  const dirs = new Set(["/"]);
+  const expectedAuth = "Basic " + Buffer.from(`${username}:${password}`).toString("base64");
+  let putCount = 0;
+  let getCount = 0;
+  let lastAuth = null;
+
+  const server = http.createServer((req, res) => {
+    const path = decodeURIComponent((req.url ?? "/").split("?")[0]);
+    const key = path.replace(/\/+$/, "") || "/";
+    const method = (req.method ?? "GET").toUpperCase();
+    lastAuth = req.headers.authorization ?? null;
+
+    if (requireAuth && req.headers.authorization !== expectedAuth) {
+      res.writeHead(401, { "WWW-Authenticate": 'Basic realm="dav"' });
+      res.end("unauthorized");
+      return;
+    }
+
+    if (method === "PROPFIND") {
+      const depth = req.headers.depth ?? "0";
+      if (!dirs.has(key) && !store.has(key)) {
+        res.writeHead(404).end("not found");
+        return;
+      }
+      const prefix = key === "/" ? "/" : `${key}/`;
+      const children = [];
+      if (depth !== "0") {
+        for (const d of dirs) {
+          if (d === key) continue;
+          if (d.startsWith(prefix)) {
+            const rest = d.slice(prefix.length);
+            if (rest && !rest.includes("/")) {
+              children.push({ href: d, isDir: true, size: 0, lm: new Date().toUTCString() });
+            }
+          }
+        }
+        for (const [p, buf] of store) {
+          if (p.startsWith(prefix)) {
+            const rest = p.slice(prefix.length);
+            if (rest && !rest.includes("/")) {
+              children.push({ href: p, isDir: false, size: buf.length, lm: new Date().toUTCString() });
+            }
+          }
+        }
+      }
+      const responses = [
+        { href: key, isDir: !store.has(key), size: store.get(key)?.length ?? 0, lm: new Date().toUTCString() },
+        ...children,
+      ];
+      const xml =
+        `<?xml version="1.0" encoding="utf-8"?>\n<D:multistatus xmlns:D="DAV:">\n` +
+        responses
+          .map(
+            (e) =>
+              `  <D:response><D:href>${e.href}</D:href><D:propstat><D:prop>` +
+              `<D:getcontentlength>${e.size}</D:getcontentlength>` +
+              `<D:getlastmodified>${e.lm}</D:getlastmodified>` +
+              `<D:resourcetype>${e.isDir ? "<D:collection/>" : ""}</D:resourcetype>` +
+              `</D:prop><D:status>HTTP/1.1 200 OK</D:status></D:propstat></D:response>`,
+          )
+          .join("\n") +
+        `\n</D:multistatus>`;
+      res.writeHead(207, { "Content-Type": "application/xml" }).end(xml);
+      return;
+    }
+
+    if (method === "MKCOL") {
+      if (dirs.has(key) || store.has(key)) {
+        res.writeHead(405).end("exists");
+        return;
+      }
+      dirs.add(key);
+      res.writeHead(201).end();
+      return;
+    }
+
+    if (method === "PUT") {
+      const chunks = [];
+      req.on("data", (c) => chunks.push(c));
+      req.on("end", () => {
+        putCount++;
+        store.set(key, Buffer.concat(chunks));
+        res.writeHead(201).end();
+      });
+      return;
+    }
+
+    if (method === "GET") {
+      // 网盘行为：下载不在 WebDAV 侧，302 到对象存储的带签名临时 URL
+      if (redirectGetsTo) {
+        res.writeHead(302, { Location: `${redirectGetsTo}${path}` });
+        res.end();
+        return;
+      }
+      if (!store.has(key)) {
+        res.writeHead(404).end();
+        return;
+      }
+      getCount++;
+      const buf = store.get(key);
+      res.writeHead(200, { "Content-Length": String(buf.length) }).end(buf);
+      return;
+    }
+
+    if (method === "HEAD") {
+      if (!store.has(key)) {
+        res.writeHead(404).end();
+        return;
+      }
+      res.writeHead(200, { "Content-Length": String(store.get(key).length) }).end();
+      return;
+    }
+
+    if (method === "DELETE") {
+      if (store.delete(key) || dirs.delete(key)) {
+        res.writeHead(204).end();
+        return;
+      }
+      res.writeHead(404).end();
+      return;
+    }
+
+    res.writeHead(405).end("method not allowed");
+  });
+
+  return new Promise((resolve) => {
+    server.listen(0, "127.0.0.1", () => {
+      const addr = server.address();
+      const port = typeof addr === "object" && addr ? addr.port : 0;
+      resolve({
+        server,
+        port,
+        store,
+        dirs,
+        stats: () => ({ putCount, getCount }),
+        get lastAuth() {
+          return lastAuth;
+        },
+        reset: () => {
+          putCount = 0;
+          getCount = 0;
+        },
+      });
+    });
+  });
+}