picgo-plugin-gitee 2.1.0 → 2.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "picgo-plugin-gitee",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "picgo uploader for gitee",
   "main": "src/index.js",
   "files": [

package/readme.md

@@ -46,6 +46,7 @@ git push -u origin master
 ### Feature
 - support sync gitee file delete
 - 上传/删除结束均会弹出系统通知（PicGo 消息中心）
+- GUI 菜单提供「从 Gitee 同步远程文件到相册」按钮（递归仓库所有图片，自动跳过非图片文件）
 
 ### Todo
 

package/src/index.js

@@ -18,6 +18,223 @@ module.exports = (ctx) => {
     ctx.on("remove", onRemove);
   };
 
+  // GUI 菜单项：手动触发"从 Gitee 拉取远程文件到相册"
+  const guiMenu = (ctx) => {
+    return [
+      {
+        label: "同步 Gitee 远程文件到相册",
+        async handle(ctx, guiApi) {
+          // picgo GUI 有时会把 async handle 里的异常静默吞掉。
+          // 手动加 try/catch 确保任何错误都能反馈到 UI 和日志。
+          const started = Date.now();
+          log("info", "[同步]按钮被点击");
+          log("info", `[同步]ctx 类型: ${typeof ctx}, guiApi 类型: ${typeof guiApi}`);
+          log(
+            "info",
+            `[同步]guiApi.galleryDB: ${guiApi && !!guiApi.galleryDB}, guiApi.showNotification: ${guiApi && !!guiApi.showNotification}`
+          );
+          try {
+            await syncRemoteToGallery(ctx, guiApi);
+            log("success", `[同步]完成，耗时 ${Date.now() - started}ms`);
+          } catch (err) {
+            const msg = err && err.message ? err.message : String(err);
+            const stack = err && err.stack ? err.stack : "";
+            log("error", "[同步]失败：" + msg);
+            if (stack) log("error", stack);
+            // 弹窗 + 系统通知，三重保险
+            if (guiApi && guiApi.showMessageBox) {
+              try {
+                guiApi.showMessageBox({
+                  type: "error",
+                  title: "Gitee 同步失败",
+                  message: msg,
+                  detail: stack ? stack.split("\n").slice(0, 3).join("\n") : "",
+                });
+              } catch (e) {
+                log("error", "[同步]showMessageBox 失败：" + e.message);
+              }
+            }
+            if (guiApi && guiApi.showNotification) {
+              try {
+                guiApi.showNotification({
+                  title: "Gitee 同步失败",
+                  body: msg,
+                });
+              } catch (e) {
+                log("error", "[同步]showNotification 失败：" + e.message);
+              }
+            }
+          }
+        },
+      },
+    ];
+  };
+
+  // 统一的日志输出，兼容 picgo-core (ctx.log.info) 和 picgo GUI (ctx.log 可能行为不同)
+  // 同时打 console 兜底，确保 Electron 主进程也能看到
+  const log = function (level, msg) {
+    try {
+      // picgo 的 ctx.log 支持 info / warn / success / error
+      const fn = ctx.log && (ctx.log[level] || ctx.log.info);
+      if (fn) fn.call(ctx.log, msg);
+    } catch (e) {
+      // 静吞
+    }
+    // 兜底：直接打到 stdout，这样无论 picgo GUI 把日志写到哪，这里都至少有一条记录
+    // （用户终端如果通过 npm 链接加载插件，能看到；GUI 主进程 console 也能看到）
+    if (typeof console !== "undefined") {
+      try {
+        console.log("[picgo-plugin-gitee]", level.toUpperCase(), msg);
+      } catch (e) {
+        // 静吞
+      }
+    }
+  };
+
+  // 相册里只保留图片文件，避免把 README/配置文件等也拉进来
+  const IMAGE_EXTS = new Set([
+    "jpg", "jpeg", "png", "gif", "webp", "bmp", "svg",
+    "tif", "tiff", "ico", "avif", "heic",
+  ]);
+
+  // 递归列出 Gitee 仓库所有图片文件（含子目录）。
+  // 返回 [{ fileName, imgUrl, sha, size }]
+  const listAllRemoteFiles = async function (userConfig) {
+    const headers = getHeaders();
+    const listUrl =
+      userConfig.baseUrl + "/contents" + formatConfigPath(userConfig);
+    const out = [];
+    await walkContents(listUrl, userConfig, headers, out);
+    return out
+      .filter((it) => {
+        const ext = (it.name || "").split(".").pop().toLowerCase();
+        return IMAGE_EXTS.has(ext);
+      })
+      .map((it) => ({
+        fileName: it.path,
+        imgUrl: userConfig.previewUrl + "/" + it.path,
+        sha: it.sha,
+        size: it.size,
+      }));
+  };
+
+  const walkContents = async function (url, userConfig, headers, out) {
+    const fullUrl = url + "?access_token=" + userConfig.token;
+    let res;
+    try {
+      res = await ctx.Request.request({
+        method: "GET",
+        url: fullUrl,
+        headers: headers,
+      });
+    } catch (err) {
+      throw new Error("获取 Gitee 目录失败：" + err.message);
+    }
+    // 兼容 picgo-core（字符串）和 picgo GUI（对象）
+    const items = typeof res === "string" ? JSON.parse(res) : res;
+    if (!Array.isArray(items)) {
+      // 单文件（理论上 listAllRemoteFiles 不会传单文件路径，兜底）
+      if (items && items.type === "file") {
+        out.push(items);
+      }
+      return;
+    }
+    for (const item of items) {
+      if (item.type === "file") {
+        out.push(item);
+      } else if (item.type === "dir") {
+        // 递归子目录
+        await walkContents(url + "/" + item.path, userConfig, headers, out);
+      }
+    }
+  };
+
+  // 把 Gitee 远程文件写入 PicGo GUI 相册。
+  // 关键点：每条记录带 type="gitee"，这样从相册删除时会触发 onRemove 真正删除 gitee 上的文件。
+  // 异常统一向上抛出，由 guiMenu.handle 里的 catch 统一弹窗。
+  const syncRemoteToGallery = async function (ctx, guiApi) {
+    if (!guiApi || !guiApi.galleryDB) {
+      throw new Error("当前不在 PicGo GUI 环境（galleryDB 不可用）");
+    }
+    log("info", "[同步]开始检查配置");
+    let userConfig;
+    try {
+      userConfig = getUserConfig();
+    } catch (err) {
+      throw new Error("请先在插件设置中填写 owner / repo / token");
+    }
+    if (!userConfig.owner || !userConfig.repo || !userConfig.token) {
+      throw new Error("请先在插件设置中填写 owner / repo / token");
+    }
+    log(
+      "info",
+      `[同步]配置 OK: owner=${userConfig.owner} repo=${userConfig.repo} path=${userConfig.path || "(root)"}`
+    );
+
+    if (guiApi.showNotification) {
+      guiApi.showNotification({
+        title: "正在同步",
+        body: "正在从 Gitee 拉取远程文件...",
+      });
+    }
+
+    log("info", "[同步]开始递归拉取 Gitee 文件列表");
+    const remoteFiles = await listAllRemoteFiles(userConfig);
+    log("info", `[同步]仓库共 ${remoteFiles.length} 个图片文件`);
+
+    if (remoteFiles.length === 0) {
+      log("warn", "[同步]仓库里没有任何图片文件");
+      if (guiApi.showNotification) {
+        guiApi.showNotification({
+          title: "Gitee 同步完成",
+          body: "仓库里没有任何图片文件",
+        });
+      }
+      return;
+    }
+
+    log("info", "[同步]读取本地相册");
+    const existing = (await guiApi.galleryDB.get()) || [];
+    log("info", `[同步]本地相册已有 ${existing.length} 条`);
+    const existingUrls = new Set(existing.map((x) => x.imgUrl));
+    const newItems = remoteFiles
+      .filter((f) => !existingUrls.has(f.imgUrl))
+      .map((f) => ({
+        fileName: f.fileName,
+        imgUrl: f.imgUrl,
+        type: uploadedName,
+        sha: f.sha,
+        extname: f.fileName.split(".").pop(),
+      }));
+    log(
+      "info",
+      `[同步]需要新增 ${newItems.length} 条（已存在 ${remoteFiles.length - newItems.length} 条）`
+    );
+
+    if (newItems.length === 0) {
+      if (guiApi.showNotification) {
+        guiApi.showNotification({
+          title: "Gitee 同步完成",
+          body: "没有新增文件，相册已是最新",
+        });
+      }
+      return;
+    }
+
+    log("info", "[同步]写入相册 insertMany");
+    await guiApi.galleryDB.insertMany(newItems);
+    log(
+      "success",
+      `[同步]完成：共 ${remoteFiles.length} 个，新增 ${newItems.length} 个`
+    );
+    if (guiApi.showNotification) {
+      guiApi.showNotification({
+        title: "Gitee 同步完成",
+        body: `新增 ${newItems.length} 个文件到相册（共发现 ${remoteFiles.length} 个）`,
+      });
+    }
+  };
+
   const getHeaders = function () {
     return {
       "Content-Type": "application/json;charset=UTF-8",
@@ -327,5 +544,6 @@ module.exports = (ctx) => {
   return {
     uploader: "gitee",
     register,
+    guiMenu,
   };
 };