@xiaoyuyu6420/dsh-backup 0.7.2 → 0.8.0

package/lib/index.js

@@ -42,6 +42,8 @@ import { hostname } from 'node:os';
 import { dirname, join } from 'node:path';
 import { defineTool } from '@deepseek-ai/dsh-tools';
 import { TypertRemoteService } from '@deepseek-ai/dsh-typert-protocol';
+import { settingsNamespace, SettingsConflictError } from '@deepseek-ai/dsh-settings';
+import z from '@deepseek-ai/schemastery';
 
 export const name = 'dsh-backup';
 export const inject = ['subprocess', 'commands', 'timer', 'tools'];
@@ -67,6 +69,97 @@ const SENSITIVE_DEFAULTS = ['.credentials.yaml', '.env', 'qq-bridge/config.json'
 /** 备份目录下保存明文敏感文件的子目录（随备份刷新为最新一份的副本）。 */
 const VAULT_DIR = 'vault';
 
+/** Settings 命名空间：经 `ctx.settings` 提供（持久化到 $DSH_HOME/settings.yaml）。 */
+const NS = settingsNamespace('dsh-backup');
+
+/**
+ * 设置默认值。SCHEMA 的 .default() 与 resolveBase 的初始值都引用这里，
+ * 避免同一字面量散落多处导致迁移逻辑漏改。
+ */
+const DEFAULTS = Object.freeze({
+  destination: '~/Desktop/dsh-backups',
+  exclude: [],
+  redact: [...SENSITIVE_DEFAULTS],
+  githubRepo: '',
+});
+
+/**
+ * 解析 settings 命名空间的 schema，同时定义默认值。
+ * Base 层：pluginConfig（cordis.patch.yml，插件级或 profile 级）。
+ * User 层：Settings 面板运行时编辑，持久化到 settings.yaml。
+ */
+const SCHEMA = z.object({
+  destination: z.string().default(DEFAULTS.destination),
+  keep: z.number().min(0).default(0),
+  exclude: z.array(z.string()).default(DEFAULTS.exclude),
+  redact: z.union([z.array(z.string()), 'off']).default(DEFAULTS.redact),
+  githubRepo: z.string().default(DEFAULTS.githubRepo),
+});
+
+const SETTINGS_FIELDS = ['destination', 'keep', 'exclude', 'redact', 'githubRepo'];
+
+/** 校验并归一化单个字段到 `out`；非法值忽略。 */
+function normalizeField(out, field, value) {
+  if (field === 'destination') {
+    if (typeof value === 'string' && value.trim()) out.destination = value.trim();
+  } else if (field === 'keep') {
+    const n = Number(value);
+    if (Number.isFinite(n) && n >= 0) out.keep = Math.floor(n);
+  } else if (field === 'exclude') {
+    if (Array.isArray(value)) out.exclude = value.filter((v) => typeof v === 'string');
+  } else if (field === 'redact') {
+    // 'none' 为旧配置兼容：旧版允许 'none' 关闭脱敏，新版 SCHEMA 只接受数组或 'off'
+    if (value === 'off' || value === false || value === 'none') out.redact = 'off';
+    else if (Array.isArray(value)) out.redact = value.filter((v) => typeof v === 'string');
+  } else if (field === 'githubRepo') {
+    if (typeof value === 'string') out.githubRepo = value;
+  }
+}
+
+/**
+ * 将 loader 提供的 config（cordis.patch.yml）合并到 DEFAULTS 上，逐字段归一化。
+ * SCHEMA 的 .default() 与这里共用 DEFAULTS，避免迁移逻辑漏改。
+ */
+function resolveBase(config) {
+  const out = { ...DEFAULTS, redact: [...DEFAULTS.redact] };
+  if (config && typeof config === 'object') {
+    for (const field of SETTINGS_FIELDS) normalizeField(out, field, config[field]);
+  }
+  return out;
+}
+
+/** 校验 partial 中提供的字段；非法字段名返回给调用方，用于 400 响应。 */
+function validatePartial(partial) {
+  const invalid = [];
+  for (const field of SETTINGS_FIELDS) {
+    if (partial[field] === undefined) continue;
+    const probe = {};
+    normalizeField(probe, field, partial[field]);
+    if (probe[field] === undefined) invalid.push(field);
+  }
+  return invalid;
+}
+
+/** 判断是否为 settings seam 的乐观并发冲突错误。 */
+function isSettingsConflict(err) {
+  return err instanceof SettingsConflictError || (err && err.code === 'SETTINGS_CONFLICT');
+}
+
+/** 从 settings 服务中取出本命名空间的描述符（脱敏视图）。 */
+function describeOwn(settings, ns) {
+  const list = settings.describe({ redactSecrets: true });
+  return list.find((descriptor) => descriptor.ns === ns);
+}
+
+/** 将命名空间描述符整理为客户端使用的线格式。 */
+function describeResponse(descriptor) {
+  return {
+    ...descriptor.value,
+    revision: descriptor.revision,
+    hasOverrides: !!(descriptor.user && Object.keys(descriptor.user).length > 0),
+  };
+}
+
 /**
  * `backupPanel` Remote 命名空间的调用描述符（src-json codec）。手工经
  * `ctx.typert.register()` 注册——运行时 registry 接受 src-json，免去 zod
@@ -167,6 +260,68 @@ class BackupPanelService extends TypertRemoteService {
 }
 
 export function apply(ctx, pluginConfig) {
+  // ---------- Settings seam ----------
+  // settings 服务可选：无该服务的 profile（非 Web）回退到 pluginConfig base 层。
+  let settingsService;
+  ctx.inject(['settings'], (sctx) => {
+    settingsService = sctx.settings;
+    settingsService.register(NS, SCHEMA, { base: resolveBase(pluginConfig) });
+    // detach 清理：服务中途 dispose 时置空，resolvedConfig() 自动降级到 pluginConfig
+    return () => { settingsService = undefined; };
+  });
+
+  // 旧配置兼容警告：redact: 'none' 在新版映射为 'off'
+  if (pluginConfig && pluginConfig.redact === 'none') {
+    console.warn("[dsh-backup] config.redact: 'none' 已废弃，请改用 'off'（行为相同，'none' 将在未来版本移除）");
+  }
+
+  /**
+   * 解析后的生效配置：schema 默认值 ← base（cordis.patch.yml）←
+   * 用户层（settings.yaml）。settings 服务不可用时回退到 pluginConfig。
+   */
+  function resolvedConfig() {
+    if (settingsService) {
+      const descriptor = describeOwn(settingsService, NS);
+      if (descriptor && descriptor.value) return descriptor.value;
+    }
+    return resolveBase(pluginConfig);
+  }
+
+  /** 读取并解析 JSON 请求体（上限 1 MiB）。 */
+  function readJsonBody(req) {
+    return new Promise((resolve, reject) => {
+      const chunks = [];
+      let size = 0;
+      req.on('data', (chunk) => {
+        size += chunk.length;
+        if (size > 1024 * 1024) {
+          reject(new Error('request body too large'));
+          req.once('error', () => {});
+          req.destroy();
+          return;
+        }
+        chunks.push(chunk);
+      });
+      req.on('end', () => {
+        const text = Buffer.concat(chunks).toString('utf8');
+        if (text.trim() === '') return resolve({});
+        try {
+          resolve(JSON.parse(text));
+        } catch {
+          reject(new Error('invalid JSON body'));
+        }
+      });
+      req.on('error', reject);
+    });
+  }
+
+  /** 写入 JSON 响应。 */
+  function sendJson(res, status, data) {
+    const body = JSON.stringify(data);
+    res.writeHead(status, { 'Content-Type': 'application/json; charset=utf-8', 'Cache-Control': 'no-store' });
+    res.end(body);
+  }
+
   // ---------- 工具函数 ----------
   /**
    * 读取 subprocess 收集的输出流。dsh-subprocess 的收集契约：输出超过
@@ -228,28 +383,32 @@ export function apply(ctx, pluginConfig) {
     const home = homeRaw ? toFwd(homeRaw.replace(/\/+$/, '')) : undefined;
     const dshHome = env?.get('DSH_HOME')?.value || (home ? `${home}/.dsh` : undefined);
     if (!home || !dshHome) throw new Error('无法解析 HOME/USERPROFILE 或 DSH_HOME（launchEnvironment 缺失）');
-    const raw = typeof pluginConfig?.destination === 'string' && pluginConfig.destination.trim()
-      ? pluginConfig.destination.trim()
-      : '~/Desktop/dsh-backups';
+    const cfg = resolvedConfig();
+    const raw = typeof cfg.destination === 'string' && cfg.destination.trim()
+      ? cfg.destination.trim()
+      : DEFAULTS.destination;
     const root = raw.startsWith('~') ? `${home}${raw.slice(1)}` : toFwd(raw);
     return { home, dshHome: toFwd(dshHome), root };
   }
 
   function defaultKeep() {
-    const k = Number(pluginConfig?.keep);
+    const cfg = resolvedConfig();
+    const k = Number(cfg.keep);
     return Number.isFinite(k) && k > 0 ? Math.floor(k) : 7;
   }
 
   function extraExcludes() {
-    const list = Array.isArray(pluginConfig?.exclude) ? pluginConfig.exclude : [];
+    const cfg = resolvedConfig();
+    const list = Array.isArray(cfg.exclude) ? cfg.exclude : [];
     return list.filter((p) => typeof p === 'string' && p.length > 0).map((p) => `--exclude=${p}`);
   }
 
   /** 生效的脱敏清单：默认集 + config.redact 追加（false/'off' 整体关闭）。 */
   function sensitivePaths() {
-    const cfg = pluginConfig?.redact;
-    if (cfg === false || cfg === 'off' || cfg === 'none') return [];
-    const extra = Array.isArray(cfg) ? cfg.filter((p) => typeof p === 'string' && p.trim().length) : [];
+    const cfg = resolvedConfig();
+    const redactCfg = cfg.redact;
+    if (redactCfg === false || redactCfg === 'off' || redactCfg === 'none') return [];
+    const extra = Array.isArray(redactCfg) ? redactCfg.filter((p) => typeof p === 'string' && p.trim().length) : [];
     return [...new Set([...SENSITIVE_DEFAULTS, ...extra.map((p) => p.trim())])];
   }
 
@@ -510,11 +669,12 @@ export function apply(ctx, pluginConfig) {
 
   // ---------- GitHub 同步 ----------
   function githubConfig() {
-    // 运行时设置（面板/命令，存 auto.json）优先，cordis.yml 的 githubRepo 只是初始默认。
+    // 运行时设置（面板/命令，存 auto.json）优先，settings.yaml → cordis.yml 的 githubRepo 是初始默认。
+    const cfg = resolvedConfig();
     const raw = githubState && typeof githubState.repo === 'string' && githubState.repo.trim()
       ? githubState.repo.trim()
-      : (typeof pluginConfig?.githubRepo === 'string' && pluginConfig.githubRepo.trim()
-        ? pluginConfig.githubRepo.trim()
+      : (typeof cfg.githubRepo === 'string' && cfg.githubRepo.trim()
+        ? cfg.githubRepo.trim()
         : '');
     if (!raw) return null;
     const env = ctx.get('launchEnvironment');
@@ -1042,7 +1202,8 @@ export function apply(ctx, pluginConfig) {
 
   /** 自动备份的保留份数：config.keep 支配（未配置时 <24h 3 份、否则 7 份）。 */
   function autoKeep() {
-    const k = Number(pluginConfig?.keep);
+    const cfg = resolvedConfig();
+    const k = Number(cfg.keep);
     return Number.isFinite(k) && k > 0 ? Math.floor(k) : (autoHours >= 24 ? 7 : 3);
   }
 
@@ -1399,10 +1560,11 @@ export function apply(ctx, pluginConfig) {
     githubStatus: async () => {
       const cfg = githubConfig();
       const { root } = paths();
+      const resolved = resolvedConfig();
       return {
-        // repoRaw 是用户原始输入（运行时值优先，否则 cordis.yml 默认），供面板编辑框回填
+        // repoRaw 是用户原始输入（运行时值优先，否则 settings.yaml → cordis.yml 默认），供面板编辑框回填
         // 两路都经 stripUserinfo：避免 cordis.yml config.githubRepo 内嵌 token 时经面板泄露
-        repoRaw: githubState.repo ?? (typeof pluginConfig?.githubRepo === 'string' ? stripUserinfo(pluginConfig.githubRepo) : null),
+        repoRaw: githubState.repo ?? (typeof resolved.githubRepo === 'string' ? stripUserinfo(resolved.githubRepo) : null),
         repo: cfg ? cfg.repo : null,
         tokenSet: Boolean(cfg?.token),
         syncDir: `${root}/${SYNC_DIR}`,
@@ -1454,13 +1616,33 @@ export function apply(ctx, pluginConfig) {
       if (!raw) {
         githubState = { ...githubState, repo: null, lastError: null };
         await saveAutoState();
-        return { ok: true, repo: null, summary: 'GitHub 同步仓库已清除（回退到 cordis.yml 配置，若有）。' };
+        // 清除用户层的 githubRepo，让 base 层（cordis.patch.yml）透传回来
+        if (settingsService) {
+          try {
+            // 读取当前用户层，移除 githubRepo 字段后 replace 回去
+            const desc = describeOwn(settingsService, NS);
+            const userLayer = desc?.user ? { ...desc.user } : {};
+            delete userLayer.githubRepo;
+            await settingsService.replace(NS, userLayer);
+          } catch (err) {
+            return { ok: false, summary: String(err && err.message ? err.message : err) };
+          }
+        }
+        return { ok: true, repo: null, summary: 'GitHub 同步仓库已清除用户层覆盖（回退到 cordis.yml 配置，若有）。' };
       }
       const invalid = validateRepo(raw);
       if (invalid) return { ok: false, summary: invalid };
       const clean = stripUserinfo(raw);
       githubState = { ...githubState, repo: clean, lastError: null };
       await saveAutoState();
+      // 同步写入 settings.yaml
+      if (settingsService) {
+        try {
+          await settingsService.update(NS, { githubRepo: clean });
+        } catch (err) {
+          return { ok: false, summary: String(err && err.message ? err.message : err) };
+        }
+      }
       return { ok: true, repo: clean, summary: `GitHub 同步仓库已设为: ${clean}` };
     },
   };
@@ -1486,6 +1668,67 @@ export function apply(ctx, pluginConfig) {
     }), 'dsh-backup: download route');
   });
 
+  // Settings 薄代理：经 ctx.settings 官方 seam 的 GET/POST 接口。
+  // 用户编辑持久化到 $DSH_HOME/settings.yaml；base 层（cordis.patch.yml）
+  // 本插件从不写入。
+  ctx.inject(['webServer'], (scope) => {
+    scope.effect(() => scope.webServer.register({
+      kind: 'exact',
+      path: '/dsh-backup/settings',
+      handler: async (req, res) => {
+        try {
+          // 与 /backup-download 同一 loopback 校验：settings 路由更敏感，绝不对非本机暴露
+          const host = String(req.headers?.host || '');
+          if (!/^(127\.0\.0\.1|localhost|\[::1\])(:\d+)?$/.test(host)) {
+            sendJson(res, 403, { error: 'forbidden' });
+            return;
+          }
+          if (!settingsService) {
+            sendJson(res, 503, { error: 'settings-unavailable' });
+            return;
+          }
+          if (req.method === 'GET' || req.method === 'HEAD') {
+            sendJson(res, 200, describeResponse(describeOwn(settingsService, NS)));
+            return;
+          }
+          if (req.method !== 'POST') {
+            sendJson(res, 405, { error: 'method-not-allowed' });
+            return;
+          }
+          const body = await readJsonBody(req);
+          const expectedRevision = typeof body.revision === 'number' ? body.revision : undefined;
+          try {
+            if (body.reset === true) {
+              // 重置：清除用户层，值回退到 base 层
+              await settingsService.replace(NS, {}, expectedRevision);
+            } else {
+              const invalid = validatePartial(body);
+              if (invalid.length > 0) {
+                sendJson(res, 400, { error: 'invalid-field', fields: invalid });
+                return;
+              }
+              // 保存：仅合并提供的字段到用户层
+              const patch = {};
+              for (const field of SETTINGS_FIELDS) {
+                if (body[field] !== undefined) normalizeField(patch, field, body[field]);
+              }
+              await settingsService.update(NS, patch, expectedRevision);
+            }
+          } catch (err) {
+            if (isSettingsConflict(err)) {
+              sendJson(res, 409, { error: 'settings-conflict', revision: err.actual });
+              return;
+            }
+            throw err;
+          }
+          sendJson(res, 200, describeResponse(describeOwn(settingsService, NS)));
+        } catch (err) {
+          sendJson(res, 400, { error: String(err && err.message ? err.message : err) });
+        }
+      },
+    }), 'dsh-backup: settings route');
+  });
+
   // 启动时恢复持久化的定时备份计划（不阻塞插件装配）；错过则 delay=0 立即补跑。
   void (async () => {
     const h = await loadAutoState();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiaoyuyu6420/dsh-backup",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "description": "Backup, restore, download and GitHub-sync DeepSeek Harness user data (~/.dsh): /backup, scheduled auto-backup that survives restarts, sha256 checksums, integrity verify, rotation, credential redaction with a local vault (plaintext never leaves the machine), cross-machine restore preflight with github pull, and a visual Settings panel. Cross-platform (macOS/Linux/Windows). 一键备份与恢复 DSH 数据：定时自动备份、完整性校验、凭据默认脱敏（明文只存本机 vault）、跨机恢复预检与 github pull 拉取，附 Settings 可视面板。",
   "type": "module",
   "main": "lib/index.js",
@@ -46,9 +46,11 @@
     "@deepseek-ai/cordis": "^4.0.1",
     "@deepseek-ai/dsh-commands": "^0.1.1-rc.2",
     "@deepseek-ai/dsh-fs": "^0.1.1-rc.2",
+    "@deepseek-ai/dsh-settings": "^0.1.1-rc.2",
     "@deepseek-ai/dsh-subprocess": "^0.1.1-rc.2",
     "@deepseek-ai/dsh-tools": "^0.1.1-rc.2",
-    "@deepseek-ai/dsh-typert-protocol": "^0.1.1-rc.2"
+    "@deepseek-ai/dsh-typert-protocol": "^0.1.1-rc.2",
+    "@deepseek-ai/schemastery": "^3.18.1"
   },
   "devDependencies": {
     "esbuild": "^0.25.0",