bump to 0.5.14

docs/encryption/rclone.md

@@ -42,5 +42,5 @@ filename_encoding = base64 # don't forget this!!!
 You can use the `mount` command to view and see the files in file explorer! On Windows, the command should like this (the remote vault is mounted to drive `X:`):
 
 ```bash
-rclone mount webdav1crypt: X: --network-mode
+rclone mount webdav1crypt: X: --network-mode --vfs-cache-mode writes
 ```

manifest-beta.json

@@ -1,7 +1,7 @@
 {
   "id": "remotely-save",
   "name": "Remotely Save",
-  "version": "0.5.12",
+  "version": "0.5.14",
   "minAppVersion": "0.13.21",
   "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
   "author": "fyears",

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "remotely-save",
   "name": "Remotely Save",
-  "version": "0.5.12",
+  "version": "0.5.14",
   "minAppVersion": "0.13.21",
   "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
   "author": "fyears",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "remotely-save",
-  "version": "0.5.12",
+  "version": "0.5.14",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
     "dev2": "node esbuild.config.mjs --watch",

pro/src/clearDupFiles.ts

@@ -0,0 +1,34 @@
+import type { FakeFsLocal } from "../../src/fsLocal";
+import { getFileRenameForDup } from "./conflictLogic";
+
+export const getDupFiles = async (fsLocal: FakeFsLocal) => {
+  const allFilesAndFolders = await fsLocal.walk();
+
+  allFilesAndFolders.sort((a, b) => -(a.keyRaw.length - b.keyRaw.length)); // descending
+
+  const filenameSet: Set<string> = new Set();
+  const filesToBeRemoved: Set<string> = new Set();
+
+  for (const { keyRaw } of allFilesAndFolders) {
+    if (keyRaw.endsWith("/")) {
+      continue;
+    }
+    if (keyRaw.includes("dup")) {
+      filenameSet.add(keyRaw);
+    }
+
+    const dup = getFileRenameForDup(keyRaw);
+    if (filenameSet.has(dup)) {
+      filesToBeRemoved.add(dup);
+    }
+  }
+
+  return [...filesToBeRemoved];
+};
+
+export const clearDupFiles = async (
+  filesToBeRemoved: string[],
+  fsLocal: FakeFsLocal
+) => {
+  await Promise.all(filesToBeRemoved.map(async (f) => await fsLocal.rm(f)));
+};

pro/src/conflictLogic.ts

@@ -20,14 +20,14 @@ import type { FakeFs } from "../../src/fsAll";
 import { MERGABLE_SIZE } from "./baseTypesPro";
 
 export function isMergable(a: Entity, b?: Entity) {
-  if (b !== undefined && a.keyRaw !== b.keyRaw) {
+  if (b !== undefined && a.key !== b.key) {
     return false;
   }
 
   return (
-    !a.keyRaw.endsWith("/") &&
+    !a.key!.endsWith("/") &&
     a.sizeRaw <= MERGABLE_SIZE &&
-    (a.keyRaw.endsWith(".md") || a.keyRaw.endsWith(".markdown"))
+    (a.key!.endsWith(".md") || a.key!.endsWith(".markdown"))
   );
 }
 
@@ -73,6 +73,18 @@ function getLCSText(a: string, b: string) {
  * @returns
  */
 function twoWayMerge(a: string, b: string): string {
+  const aa = a.trim();
+  const bb = b.trim();
+  if (aa === "" && bb === "") {
+    return aa.length >= bb.length ? a : b;
+  }
+  if (bb === "") {
+    return a;
+  }
+  if (aa === "") {
+    return b;
+  }
+
   // const c = getLCSText(a, b);
   // const patches = makePatches(c, a);
   // const [d] = applyPatches(patches, b);
@@ -159,7 +171,7 @@ export async function mergeFile(
   };
 }
 
-export function getFileRename(key: string) {
+export function getFileRenameForDup(key: string) {
   if (
     key === "" ||
     key === "." ||
@@ -330,7 +342,7 @@ export async function tryDuplicateFile(
   uploadCallback: (entity: Entity | undefined) => Promise<any>,
   downloadCallback: (entity: Entity | undefined) => Promise<any>
 ) {
-  let key2 = getFileRename(key);
+  let key2 = getFileRenameForDup(key);
   let usable = false;
   do {
     try {
@@ -339,7 +351,7 @@ export async function tryDuplicateFile(
         throw Error(`not exist $${key2}`);
       }
       console.debug(`key2=${key2} exists, cannot use for new file`);
-      key2 = getFileRename(key2);
+      key2 = getFileRenameForDup(key2);
       console.debug(`key2=${key2} is prepared for next try`);
     } catch (e) {
       // not exists, exactly what we want

pro/src/langs/en.json

@@ -129,6 +129,10 @@
   "modal_proauth_maualinput_notice": "Trying to connect, wait...",
   "modal_proauth_maualinput_conn_fail": "Failed to connect",
 
+  "modal_cleardupfiles_warning": "Warning: The plugin just stupidly finds all the file names that looks like duplicated files (.dup in file names). Also, this only deletes local files, so you need to trigger a sync to delete remote files.",
+  "modal_cleardupfiles_warning_confirm": "Confirm to delete",
+  "modal_cleardupfiles_warning_finished": "All the detected duplicated files are removed!",
+
   "settings_onedrivefull": "Remote For Onedrive (for personal) (Full)",
   "settings_chooseservice_onedrivefull": "OneDrive for personal (Full) (PRO)",
   "settings_onedrivefull_disclaimer1": "Disclaimer: This app is NOT an official Microsoft / OneDrive product.",
@@ -278,6 +282,10 @@
   "settings_export_koofr_button": "Export Koofr Part",
   "settings_export_azureblobstorage_button": "Export Azure Blob Storage Part",
 
+  "settings_cleardupfiles": "Clear Duplicated Files By Smart Conflict",
+  "settings_cleardupfiles_desc": "If you have ever used Smart Conflict (PRO) feature, the plugin may generate duplicated files. <strong>IF YOU ARE SURE THE DUPLICATED FILES ARE NO LONGER NEEDED</strong>, you can clear <strong>ALL</strong> of them locally here.",
+  "settings_cleardupfiles_button": "Start Scanning",
+
   "settings_pro": "Account (for PRO features)",
   "settings_pro_tutorial": "<p>Using <stong>basic</strong> features of Remotely Save is <strong>FREE</strong> and do <strong>NOT</strong> need an account.</p><p>However, you will <strong>need</strong> an online account and <strong>PAY</strong> for the <strong>PRO</strong> features such as smart conflict.</p><p>Firstly please click the button to sign up and sign in to the website: <a href=\"https://remotelysave.com\">https://remotelysave.com</a>. Notice: It's different from, and NOT affiliated with Obsidian account.</p><p>Secondly please \"connect\" your local device to your online account.",
   "settings_pro_features": "Features",

pro/src/langs/zh_cn.json

@@ -140,6 +140,10 @@
   "modal_proauth_maualinput_notice": "正在连接，请稍候......",
   "modal_proauth_maualinput_conn_fail": "连接失败",
 
+  "modal_cleardupfiles_warning": "警告：插件只是简单地扫描所有文件名含有 .dup 的作为重复文件。另外，本操作只删除本地文件，因此您需要触发同步来删除远端文件。",
+  "modal_cleardupfiles_warning_confirm": "确认删除",
+  "modal_cleardupfiles_warning_finished": "所有检测到的重复文件已被删除！",
+
   "settings_onedrivefull": "Onedrive（个人版）（Full）设置",
   "settings_chooseservice_onedrivefull": "OneDrive（个人版）（Full）（PRO）",
   "settings_onedrivefull_disclaimer1": "声明：此插件不是微软或 OneDrive 的官方产品。",
@@ -285,6 +289,10 @@
   "settings_export_koofr_button": "导出 Koofr 部分",
   "settings_export_azureblobstorage_button": "导出 Azure Blob Storage 部分",
 
+  "settings_cleardupfiles": "删除智能处理冲突生成的重复文件",
+  "settings_cleardupfiles_desc": "如果用过智能处理冲突 (PRO) 功能，插件可能会生成重复文件。<strong>如果您真的确认了所有重复文件都不需要了，</strong>那么可以删除本地的<strong>所有</strong>这些文件。",
+  "settings_cleardupfiles_button": "开始扫描",
+
   "settings_pro": "账号（PRO 付费功能）",
   "settings_pro_tutorial": "<p>使用 Remotely Save 的<stong>基本</strong>功能是<strong>免费的</strong>，而且<strong>不</strong>需要注册对应账号。</p><p>但是，您<strong>需要</strong>注册账号和对<strong>PRO</strong>功能<strong>付费</strong>使用，如智能处理冲突功能。</p><p>第一步：点击按钮从而注册和登录网站：<a href=\"https://remotelysave.com\">https://remotelysave.com</a>。注意：这和 Obsidian 官方账号无关，是不同的账号。</p><p>第二部：点击“连接”按钮，从而连接本设备和在线账号。",
   "settings_pro_features": "功能",

pro/src/langs/zh_tw.json

@@ -140,6 +140,10 @@
   "modal_proauth_maualinput_notice": "正在連線，請稍候......",
   "modal_proauth_maualinput_conn_fail": "連線失敗",
 
+  "modal_cleardupfiles_warning": "警告：外掛只是簡單地掃描所有檔名含有 .dup 的作為重複檔案。另外，本操作只刪除本地檔案，因此您需要觸發同步來刪除遠端檔案。",
+  "modal_cleardupfiles_warning_confirm": "確認刪除",
+  "modal_cleardupfiles_warning_finished": "所有檢測到的重複檔案已被刪除！",
+
   "settings_onedrivefull": "Onedrive（個人版）（Full）設定",
   "settings_chooseservice_onedrivefull": "OneDrive（個人版）（Full）（PRO）",
   "settings_onedrivefull_disclaimer1": "宣告：此外掛不是微軟或 OneDrive 的官方產品。",
@@ -285,6 +289,10 @@
   "settings_export_koofr_button": "匯出 Koofr 部分",
   "settings_export_azureblobstorage_button": "匯出 Azure Blob Storage 部分",
 
+  "settings_cleardupfiles": "刪除智慧處理衝突生成的重複檔案",
+  "settings_cleardupfiles_desc": "如果用過智慧處理衝突 (PRO) 功能，外掛可能會生成重複檔案。<strong>如果您真的確認了所有重複檔案都不需要了，</strong>那麼可以刪除本地的<strong>所有</strong>這些檔案。",
+  "settings_cleardupfiles_button": "開始掃描",
+
   "settings_pro": "賬號（PRO 付費功能）",
   "settings_pro_tutorial": "<p>使用 Remotely Save 的<stong>基本</strong>功能是<strong>免費的</strong>，而且<strong>不</strong>需要註冊對應賬號。</p><p>但是，您<strong>需要</strong>註冊賬號和對<strong>PRO</strong>功能<strong>付費</strong>使用，如智慧處理衝突功能。</p><p>第一步：點選按鈕從而註冊和登入網站：<a href=\"https://remotelysave.com\">https://remotelysave.com</a>。注意：這和 Obsidian 官方賬號無關，是不同的賬號。</p><p>第二部：點選“連線”按鈕，從而連線本裝置和線上賬號。",
   "settings_pro_features": "功能",

pro/src/settingsClearDupFiles.ts

@@ -0,0 +1,90 @@
+import { type App, Modal, Notice, Setting } from "obsidian";
+import { FakeFsLocal } from "../../src/fsLocal";
+import type { TransItemType } from "../../src/i18n";
+import type RemotelySavePlugin from "../../src/main";
+import { stringToFragment } from "../../src/misc";
+import { clearDupFiles, getDupFiles } from "./clearDupFiles";
+
+class ClearDupFilesModal extends Modal {
+  readonly plugin: RemotelySavePlugin;
+  readonly t: (x: TransItemType, vars?: any) => string;
+  readonly files: string[];
+  readonly fsLocal: FakeFsLocal;
+  constructor(
+    app: App,
+    plugin: RemotelySavePlugin,
+    t: (x: TransItemType, vars?: any) => string,
+    files: string[],
+    fsLocal: FakeFsLocal
+  ) {
+    super(app);
+    this.plugin = plugin;
+    this.t = t;
+    this.files = files;
+    this.fsLocal = fsLocal;
+  }
+
+  async onOpen() {
+    const t = this.t;
+    const { contentEl } = this;
+
+    contentEl.createEl("p", {
+      text: t("modal_cleardupfiles_warning"),
+    });
+
+    contentEl.createEl("pre").createEl("code", {
+      text: this.files.join("\n"),
+    });
+
+    new Setting(contentEl)
+      .addButton((button) => {
+        button.setButtonText(t("modal_cleardupfiles_warning_confirm"));
+        button.onClick(async () => {
+          await clearDupFiles(this.files, this.fsLocal);
+          new Notice(t("modal_cleardupfiles_warning_finished"));
+          this.close();
+        });
+      })
+      .addButton((button) => {
+        button.setButtonText(t("goback"));
+        button.onClick(() => {
+          this.close();
+        });
+      });
+  }
+
+  onClose() {
+    const { contentEl } = this;
+    contentEl.empty();
+  }
+}
+
+export const generateClearDupFilesSettingsPart = (
+  containerEl: HTMLElement,
+  t: (x: TransItemType, vars?: any) => string,
+  app: App,
+  plugin: RemotelySavePlugin
+) => {
+  new Setting(containerEl)
+    .setName(t("settings_cleardupfiles"))
+    .setDesc(stringToFragment(t("settings_cleardupfiles_desc")))
+    .addButton(async (button) => {
+      button.setButtonText(t("settings_cleardupfiles_button"));
+      button.onClick(async () => {
+        const fsLocal = new FakeFsLocal(
+          app.vault,
+          plugin.settings.syncConfigDir ?? false,
+          plugin.settings.syncBookmarks ?? false,
+          app.vault.configDir,
+          plugin.manifest.id,
+          undefined,
+          plugin.settings.deleteToWhere ?? "system"
+        );
+
+        const files = await getDupFiles(fsLocal);
+
+        const modal = new ClearDupFilesModal(app, plugin, t, files, fsLocal);
+        modal.open();
+      });
+    });
+};

pro/src/settingsPro.ts

@@ -310,7 +310,7 @@ export const generateProSettingsPart = (
 
       const allowOnedriveFull =
         plugin.settings.pro?.enabledProFeatures.filter(
-          (x) => x.featureName === "feature-box"
+          (x) => x.featureName === "feature-onedrive_full"
         ).length === 1;
       console.debug(
         `allow to show up OnedriveFull settings? ${allowOnedriveFull}`

pro/src/sync.ts

@@ -116,9 +116,21 @@ const isInsideObsFolder = (x: string, configDir: string) => {
   return x === configDir || x.startsWith(`${configDir}/`);
 };
 
+const isBookmarksFile = (x: string, configDir: string) => {
+  if (!configDir.startsWith(".")) {
+    throw Error(`configDir should starts with . but we get ${configDir}`);
+  }
+  return (
+    x === configDir ||
+    x === `${configDir}/` ||
+    x === `${configDir}/bookmarks.json`
+  );
+};
+
 const isSkipItemByName = (
   key: string,
   syncConfigDir: boolean,
+  syncBookmarks: boolean,
   syncUnderscoreItems: boolean,
   configDir: string,
   ignorePaths: string[]
@@ -136,6 +148,11 @@ const isSkipItemByName = (
   if (syncConfigDir && isInsideObsFolder(key, configDir)) {
     return false;
   }
+
+  if (syncBookmarks && isBookmarksFile(key, configDir)) {
+    return false;
+  }
+
   if (isSpecialFolderNameToSkip(key, [])) {
     // some special dirs and files are always skipped
     return true;
@@ -157,6 +174,7 @@ const ensembleMixedEnties = async (
   remoteEntityList: Entity[],
 
   syncConfigDir: boolean,
+  syncBookmarks: boolean,
   configDir: string,
   syncUnderscoreItems: boolean,
   ignorePaths: string[],
@@ -184,6 +202,7 @@ const ensembleMixedEnties = async (
       isSkipItemByName(
         key,
         syncConfigDir,
+        syncBookmarks,
         syncUnderscoreItems,
         configDir,
         ignorePaths
@@ -216,6 +235,7 @@ const ensembleMixedEnties = async (
         isSkipItemByName(
           key,
           syncConfigDir,
+          syncBookmarks,
           syncUnderscoreItems,
           configDir,
           ignorePaths
@@ -251,6 +271,7 @@ const ensembleMixedEnties = async (
       isSkipItemByName(
         key,
         syncConfigDir,
+        syncBookmarks,
         syncUnderscoreItems,
         configDir,
         ignorePaths
@@ -911,13 +932,14 @@ const getSyncPlanInplace = async (
   mixedEntityMappings["/$@meta"] = {
     key: "/$@meta", // don't mess up with the types
     sideNotes: {
-      version: "20240616 fs version",
+      version: "20240714 fs version",
       generateTime: currTime,
       generateTimeFmt: currTimeFmt,
       service: settings.serviceType,
       concurrency: settings.concurrency,
       hasPassword: settings.password !== "",
       syncConfigDir: settings.syncConfigDir,
+      syncBookmarks: settings.syncBookmarks,
       syncUnderscoreItems: settings.syncUnderscoreItems,
       skipSizeLargerThan: settings.skipSizeLargerThan,
       protectModifyPercentage: settings.protectModifyPercentage,
@@ -1709,6 +1731,7 @@ export async function syncer(
       prevSyncEntityList,
       remoteEntityList,
       settings.syncConfigDir ?? false,
+      settings.syncBookmarks ?? false,
       configDir,
       settings.syncUnderscoreItems ?? false,
       settings.ignorePaths ?? [],

pro/tests/conflictLogic.test.ts

@@ -1,67 +1,70 @@
 import { deepStrictEqual, rejects, throws } from "assert";
-import { getFileRename } from "../src/conflictLogic";
+import { getFileRenameForDup } from "../src/conflictLogic";
 
 describe("New name is generated", () => {
   it("should throw for empty file", async () => {
     for (const key of ["", "/", ".", ".."]) {
-      throws(() => getFileRename(key));
+      throws(() => getFileRenameForDup(key));
     }
   });
 
   it("should throw for folder", async () => {
     for (const key of ["sss/", "ssss/yyy/"]) {
-      throws(() => getFileRename(key));
+      throws(() => getFileRenameForDup(key));
     }
   });
 
   it("should correctly get no ext files renamed", async () => {
-    deepStrictEqual(getFileRename("abc"), "abc.dup");
+    deepStrictEqual(getFileRenameForDup("abc"), "abc.dup");
 
-    deepStrictEqual(getFileRename("xxxx/yyyy/abc"), "xxxx/yyyy/abc.dup");
+    deepStrictEqual(getFileRenameForDup("xxxx/yyyy/abc"), "xxxx/yyyy/abc.dup");
   });
 
   it("should correctly get dot files renamed", async () => {
-    deepStrictEqual(getFileRename(".abc"), ".abc.dup");
+    deepStrictEqual(getFileRenameForDup(".abc"), ".abc.dup");
 
-    deepStrictEqual(getFileRename("xxxx/yyyy/.efg"), "xxxx/yyyy/.efg.dup");
+    deepStrictEqual(
+      getFileRenameForDup("xxxx/yyyy/.efg"),
+      "xxxx/yyyy/.efg.dup"
+    );
 
-    deepStrictEqual(getFileRename("xxxx/yyyy/hij."), "xxxx/yyyy/hij.dup");
+    deepStrictEqual(getFileRenameForDup("xxxx/yyyy/hij."), "xxxx/yyyy/hij.dup");
   });
 
   it("should correctly get normal files renamed", async () => {
-    deepStrictEqual(getFileRename("abc.efg"), "abc.dup.efg");
+    deepStrictEqual(getFileRenameForDup("abc.efg"), "abc.dup.efg");
 
     deepStrictEqual(
-      getFileRename("xxxx/yyyy/abc.efg"),
+      getFileRenameForDup("xxxx/yyyy/abc.efg"),
       "xxxx/yyyy/abc.dup.efg"
     );
 
     deepStrictEqual(
-      getFileRename("xxxx/yyyy/abc.tar.gz"),
+      getFileRenameForDup("xxxx/yyyy/abc.tar.gz"),
       "xxxx/yyyy/abc.tar.dup.gz"
     );
 
     deepStrictEqual(
-      getFileRename("xxxx/yyyy/.abc.efg"),
+      getFileRenameForDup("xxxx/yyyy/.abc.efg"),
       "xxxx/yyyy/.abc.dup.efg"
     );
   });
 
   it("should correctly get duplicated files renamed again", async () => {
-    deepStrictEqual(getFileRename("abc.dup"), "abc.dup.dup");
+    deepStrictEqual(getFileRenameForDup("abc.dup"), "abc.dup.dup");
 
     deepStrictEqual(
-      getFileRename("xxxx/yyyy/.abc.dup"),
+      getFileRenameForDup("xxxx/yyyy/.abc.dup"),
       "xxxx/yyyy/.abc.dup.dup"
     );
 
     deepStrictEqual(
-      getFileRename("xxxx/yyyy/abc.dup.md"),
+      getFileRenameForDup("xxxx/yyyy/abc.dup.md"),
       "xxxx/yyyy/abc.dup.dup.md"
     );
 
     deepStrictEqual(
-      getFileRename("xxxx/yyyy/.abc.dup.md"),
+      getFileRenameForDup("xxxx/yyyy/.abc.dup.md"),
       "xxxx/yyyy/.abc.dup.dup.md"
     );
   });

src/baseTypes.ts

@@ -98,6 +98,8 @@ export interface WebdavConfig {
   depth?: WebdavDepthType;
   remoteBaseDir?: string;
 
+  customHeaders?: string;
+
   /**
    * @deprecated
    */
@@ -165,6 +167,7 @@ export interface RemotelySavePluginSettings {
 
   concurrency?: number;
   syncConfigDir?: boolean;
+  syncBookmarks?: boolean;
   syncUnderscoreItems?: boolean;
   lang?: LangTypeAndAuto;
   agreeToUseSyncV3?: boolean;

src/encryptRClone.ts

@@ -200,7 +200,10 @@ export class CipherRclone {
           action: "encryptContent",
           inputContent: input,
         },
-        [channel.port1, input]
+        [
+          channel.port1,
+          // input // the array buffer might be re-used later, so we CANNOT transform here
+        ]
       );
     });
   }
@@ -244,6 +247,7 @@ export class CipherRclone {
           action: "decryptContent",
           inputContent: input,
         },
+        // the decrypted result is not used later in worker, so it's save to transfer
         [channel.port1, input]
       );
     });

src/fsLocal.ts

@@ -9,6 +9,7 @@ import type { Profiler } from "./profiler";
 export class FakeFsLocal extends FakeFs {
   vault: Vault;
   syncConfigDir: boolean;
+  syncBookmarks: boolean;
   configDir: string;
   pluginID: string;
   profiler: Profiler | undefined;
@@ -17,6 +18,7 @@ export class FakeFsLocal extends FakeFs {
   constructor(
     vault: Vault,
     syncConfigDir: boolean,
+    syncBookmarks: boolean,
     configDir: string,
     pluginID: string,
     profiler: Profiler | undefined,
@@ -26,6 +28,7 @@ export class FakeFsLocal extends FakeFs {
 
     this.vault = vault;
     this.syncConfigDir = syncConfigDir;
+    this.syncBookmarks = syncBookmarks;
     this.configDir = configDir;
     this.pluginID = pluginID;
     this.profiler = profiler;
@@ -96,13 +99,16 @@ export class FakeFsLocal extends FakeFs {
 
     this.profiler?.insert("finish transforming walk for local");
 
-    if (this.syncConfigDir) {
-      this.profiler?.insert("into syncConfigDir");
+    if (this.syncConfigDir || this.syncBookmarks) {
+      this.profiler?.insert("into syncConfigDir or syncBookmarks");
+      const bookmarksOnly = !this.syncConfigDir;
       const syncFiles = await listFilesInObsFolder(
         this.configDir,
         this.vault,
-        this.pluginID
+        this.pluginID,
+        bookmarksOnly
       );
+      // console.debug(`syncFiles in obs: ${JSON.stringify(syncFiles, null, 2)}`);
       for (const f of syncFiles) {
         local.push(f);
       }

src/fsWebdav.ts

@@ -209,6 +209,29 @@ const tryEncodeURI = (x: string) => {
   return encodeURI(x);
 };
 
+const parseCustomHeaders = (x: string): Record<string, string> => {
+  const y = x.trim();
+  if (y === "") {
+    return {};
+  }
+  const z = y.split("\n");
+
+  const res: Record<string, string> = {};
+
+  for (const kv of z) {
+    if (!kv.includes(":")) {
+      continue;
+    }
+
+    const [keyRaw, ...valueArr] = kv.split(":");
+    const key = keyRaw.trim();
+    const value = valueArr.join(":").trim();
+    res[key] = value;
+  }
+
+  return res;
+};
+
 export class FakeFsWebdav extends FakeFs {
   kind: "webdav";
 
@@ -246,9 +269,14 @@ export class FakeFsWebdav extends FakeFs {
       return;
     }
 
-    const headers = {
+    const cacheHeader = {
       "Cache-Control": "no-cache",
     };
+    const customHeaders = parseCustomHeaders(
+      this.webdavConfig.customHeaders ?? ""
+    );
+    const headers = { ...cacheHeader, ...customHeaders };
+
     if (
       this.webdavConfig.username !== "" &&
       this.webdavConfig.password !== ""
@@ -371,7 +399,9 @@ export class FakeFsWebdav extends FakeFs {
       compliance.compliance.includes("sabredav-partialupdate")
     ) {
       this.supportNativePartial = true;
-      console.debug(`supportNativePartial=true`);
+      console.debug(
+        `supportNativePartial=true, compliance=${JSON.stringify(compliance)}`
+      );
       return true;
     }
 

src/langs/en.json

@@ -232,6 +232,7 @@
   "settings_onedrive_emptyfile_desc": "OneDrive doesn't allow uploading empty file (even in its official website). Do you want to show up errors or silently skip the empty files?",
   "settings_onedrive_emptyfile_skip": "Skip",
   "settings_onedrive_emptyfile_error": "Error and abort",
+
   "settings_webdav": "Remote For Webdav",
   "settings_webdav_disclaimer1": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins may read the info. If you see any unintentional access to your webdav server, please immediately change the username and password.",
   "settings_webdav_cors_os": "Obsidian desktop>=0.13.25 or iOS>=1.1.1 or Android>=1.2.1 supports bypassing CORS locally. But you are using an old version, and you're suggested to upgrade Obsidian.",
@@ -249,9 +250,12 @@
   "settings_webdav_depth_desc": "Webdav servers should be configured to allow requests with header Depth being '1' or 'Infinity'. If you are not sure what's this, choose \"depth='1'\". If you are sure your server supports depth='infinity', please choose that to get way better performance.",
   "settings_webdav_depth_1": "only supports depth='1'",
   "settings_webdav_depth_inf": "supports depth='infinity'",
+  "settings_webdav_customheaders": "Custom Headers Sent To Servers",
+  "settings_webdav_customheaders_desc": "Some users may want to set custom headers. If you don't know what it is, just leave it empty. Input them like: <code>X-Header1:value1</code> in each line. All spaces around header keys and values will be removed.",
   "settings_webdav_connect_succ": "Great! The webdav server can be accessed.",
   "settings_webdav_connect_fail": "The webdav server cannot be reached (possible to be any of address/username/password/authtype errors).",
   "settings_webdav_connect_fail_withcors": "The webdav server cannot be reached (possible to be any of address/username/password/authtype/CORS errors).",
+
   "settings_webdis": "Remote For Webdis",
   "settings_webdis_disclaimer1": "Disclaimer: This app is NOT an official Redis® Ltd / Redis® OSS / Webdis product. Redis is a registered trademark of Redis Ltd.",
   "settings_webdis_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins may read the info. If you see any unintentional access to your Webdis server, please immediately change the username and password.",
@@ -278,6 +282,8 @@
   "settings_syncunderscore_desc": "Sync files or folders starting with _ (\"underscore\") or not",
   "settings_configdir": "Sync Config Dir (experimental)",
   "settings_configdir_desc": "Sync config dir {{configDir}} or not (inner folder .git and node_modules would be ignored). Please be aware that this may impact all your plugins' or Obsidian's settings, and may require you restart Obsidian after sync. Enable this at your own risk.",
+  "settings_bookmarks": "Sync Bookmarks (experimental)",
+  "settings_bookmarks_desc": "Sync {{configDir}}/bookmarks.json or not. If you sync config dir, this option will be ignore and treated as \"enabled\".",
   "settings_deletetowhere": "Deletion Destination",
   "settings_deletetowhere_desc": "Which trash should the plugin put the files into while deleting?",
   "settings_deletetowhere_system_trash": "system trash (default)",
@@ -336,6 +342,7 @@
   "settings_syncplans": "Export Sync Plans",
   "settings_syncplans_desc": "Sync plans are created every time after you trigger sync and before the actual sync. Useful to know what would actually happen in those sync. Click the button to export sync plans.",
   "settings_syncplans_button_1_only_change": "Export latest 1 (change part)",
+  "settings_syncplans_button_5_only_change": "Export latest 5 (change part)",
   "settings_syncplans_button_1": "Export latest 1",
   "settings_syncplans_button_5": "Export latest 5",
   "settings_syncplans_button_all": "Export All",

src/langs/zh_cn.json

@@ -231,6 +231,7 @@
   "settings_onedrive_emptyfile_desc": "OneDrive 不允许上传空文件（即使官网也是不允许的）。那么你想跳过空文件还是返回错误？",
   "settings_onedrive_emptyfile_skip": "跳过",
   "settings_onedrive_emptyfile_error": "返回错误和中断",
+
   "settings_webdav": "Webdav 设置",
   "settings_webdav_disclaimer1": "声明：您所输入的信息存储于本地。其它有害的或者出错的插件，是有可能读取到这些信息的。如果您发现了 Webdav 服务器有不符合预期的访问，请立刻修改用户名和密码。",
   "settings_webdav_cors_os": "Obsidian 桌面版>=0.13.25 或 iOS>=1.1.1 或 Android>=1.2.1 支持跳过 CORS 设置。但您正在使用旧版，建议升级。",
@@ -248,9 +249,12 @@
   "settings_webdav_depth_desc": "Webdav 服务器会被设为接收 Depth header 为“1”或“Infinity”请求。如果您不清楚如何设置，可以选择 depth='1'。如果那你确认服务器支持 depth='infinity'，请选择它，会获得更加好的性能。",
   "settings_webdav_depth_1": "只支持 depth='1'",
   "settings_webdav_depth_inf": "支持 depth='infinity'",
+  "settings_webdav_customheaders": "发送到服务器的自定义 Header",
+  "settings_webdav_customheaders_desc": "有些用户需要设置自定义 header。如果您不知道是什么，可以直接留空不填。输入格式：每行形如 <code>X-Header1:value1</code>。header 的 key 和 value 之间的空格会被删除。",
   "settings_webdav_connect_succ": "很好！可以连接上 Webdav 服务器。",
   "settings_webdav_connect_fail": "无法连接上 Webdav 服务器。（可能是地址/账号/密码/鉴权类型等错误。）",
   "settings_webdav_connect_fail_withcors": "无法连接上 Webdav 服务器。（可能是地址/账号/密码/鉴权类型/CORS 等错误。）",
+
   "settings_webdis": "Webdis 设置",
   "settings_webdis_disclaimer1": "声明：此插件不是 Redis® Ltd 或 Redis® 软件或 Wedis 的官方产品。Redis 是 Redis Ltd 的注册商标。",
   "settings_webdis_disclaimer2": "声明：您所输入的信息存储于本地。其它有害的或者出错的插件，是有可能读取到这些信息的。如果您发现了 Webdis 服务器有不符合预期的访问，请立刻修改用户名和密码。",
@@ -277,6 +281,8 @@
   "settings_syncunderscore_desc": "是否同步“_”（下划线）开始的文件或文件夹。",
   "settings_configdir": "同步配置文件夹（实验性质）",
   "settings_configdir_desc": "是否同步 Obsidian 的配置文件夹 {{configDir}}（其中的 .git 和 node_modules 依然会被忽略）。请注意，此设置可能会影响到您 Obsidian 或者所有的插件设置，也可能需要您同步完毕后重启 Obsidian。如果您同意自行承受其风险，则可以开启本设置。",
+  "settings_bookmarks": "同步书签（实验性质）",
+  "settings_bookmarks_desc": "是否同步书签 {{configDir}}/bookmarks.json 。如果您设置了同步配置文件夹，此选项会被忽略并设为“开启”。",
   "settings_deletetowhere": "删除文件到哪里",
   "settings_deletetowhere_desc": "插件触发删除操作时候，删除到哪里？",
   "settings_deletetowhere_system_trash": "系统回收站（默认）",
@@ -335,6 +341,7 @@
   "settings_syncplans": "导出同步计划",
   "settings_syncplans_desc": "每次您启动同步，并在实际上传下载前，插件会生成同步计划。它可以使您知道每次同步发生了什么。点击按钮可以导出同步计划。",
   "settings_syncplans_button_1_only_change": "导出最近 1 次（仅修改部分）",
+  "settings_syncplans_button_5_only_change": "导出最近 5 次（仅修改部分）",
   "settings_syncplans_button_1": "导出最近 1 次",
   "settings_syncplans_button_5": "导出最近 5 次",
   "settings_syncplans_button_all": "导出所有",

src/langs/zh_tw.json

@@ -230,6 +230,7 @@
   "settings_onedrive_emptyfile_desc": "OneDrive 不允許上傳空檔案（即使官網也是不允許的）。那麼你想跳過空檔案還是返回錯誤？",
   "settings_onedrive_emptyfile_skip": "跳過",
   "settings_onedrive_emptyfile_error": "返回錯誤和中斷",
+
   "settings_webdav": "Webdav 設定",
   "settings_webdav_disclaimer1": "宣告：您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛，是有可能讀取到這些資訊的。如果您發現了 Webdav 伺服器有不符合預期的訪問，請立刻修改使用者名稱和密碼。",
   "settings_webdav_cors_os": "Obsidian 桌面版>=0.13.25 或 iOS>=1.1.1 或 Android>=1.1.1 支援跳過 CORS 設定。但您正在使用舊版，建議升級。",
@@ -247,9 +248,12 @@
   "settings_webdav_depth_desc": "Webdav 伺服器會被設為接收 Depth header 為“1”或“Infinity”請求。如果您不清楚如何設定，可以選擇 depth='1'。如果那你確認伺服器支援 depth='infinity'，請選擇它，會獲得更加好的效能。",
   "settings_webdav_depth_1": "只支援 depth='1'",
   "settings_webdav_depth_inf": "支援 depth='infinity'",
+  "settings_webdav_customheaders": "傳送到伺服器的自定義 Header",
+  "settings_webdav_customheaders_desc": "有些使用者需要設定自定義 header。如果您不知道是什麼，可以直接留空不填。輸入格式：每行形如 <code>X-Header1:value1</code>。header 的 key 和 value 之間的空格會被刪除。",
   "settings_webdav_connect_succ": "很好！可以連線上 Webdav 伺服器。",
   "settings_webdav_connect_fail": "無法連線上 Webdav 伺服器。（可能是地址/賬號/密碼/鑑權型別等錯誤。）",
   "settings_webdav_connect_fail_withcors": "無法連線上 Webdav 伺服器。（可能是地址/賬號/密碼/鑑權型別/CORS 等錯誤。）",
+
   "settings_webdis": "Webdis 設置",
   "settings_webdis_disclaimer1": "聲明：此插件不是 Redis® Ltd 或 Redis® 軟件或 Wedis 的官方產品。Redis 是 Redis Ltd 的註冊商標。",
   "settings_webdis_disclaimer2": "聲明：您所輸入的信息存儲於本地。其它有害的或者出錯的插件，是有可能讀取到這些信息的。如果您發現了 Webdis 服務器有不符合預期的訪問，請立刻修改用戶名和密碼。",
@@ -276,6 +280,8 @@
   "settings_syncunderscore_desc": "是否同步“_”（下劃線）開始的檔案或資料夾。",
   "settings_configdir": "同步配置資料夾（實驗性質）",
   "settings_configdir_desc": "是否同步 Obsidian 的配置資料夾 {{configDir}}（其中的 .git 和 node_modules 依然會被忽略）。請注意，此設定可能會影響到您 Obsidian 或者所有的外掛設定，也可能需要您同步完畢後重啟 Obsidian。如果您同意自行承受其風險，則可以開啟本設定。",
+  "settings_bookmarks": "同步書籤（實驗性質）",
+  "settings_bookmarks_desc": "是否同步書籤 {{configDir}}/bookmarks.json 。如果您設定了同步配置資料夾，此選項會被忽略並設為“開啟”。",
   "settings_deletetowhere": "刪除檔案到哪裡",
   "settings_deletetowhere_desc": "外掛觸發刪除操作時候，刪除到哪裡？",
   "settings_deletetowhere_system_trash": "系統回收站（預設）",
@@ -334,6 +340,7 @@
   "settings_syncplans": "匯出同步計劃",
   "settings_syncplans_desc": "每次您啟動同步，並在實際上傳下載前，外掛會生成同步計劃。它可以使您知道每次同步發生了什麼。點選按鈕可以匯出同步計劃。",
   "settings_syncplans_button_1_only_change": "匯出最近 1 次（僅修改部分）",
+  "settings_syncplans_button_5_only_change": "匯出最近 5 次（僅修改部分）",
   "settings_syncplans_button_1": "匯出最近 1 次",
   "settings_syncplans_button_5": "匯出最近 5 次",
   "settings_syncplans_button_all": "匯出所有",

src/main.ts

@@ -135,6 +135,7 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   agreeToUploadExtraMetadata: true, // as of 20240106, it's safe to assume every new user agrees with this
   concurrency: 5,
   syncConfigDir: false,
+  syncBookmarks: false,
   syncUnderscoreItems: false,
   lang: "auto",
   logToDB: false,
@@ -239,6 +240,7 @@ export default class RemotelySavePlugin extends Plugin {
     const fsLocal = new FakeFsLocal(
       this.app.vault,
       this.settings.syncConfigDir ?? false,
+      this.settings.syncBookmarks ?? false,
       this.app.vault.configDir,
       this.manifest.id,
       profiler,
@@ -1337,6 +1339,10 @@ export default class RemotelySavePlugin extends Plugin {
       messyConfigToNormal(await this.loadData())
     );
 
+    if (this.settings.syncBookmarks === undefined) {
+      this.settings.syncBookmarks = false;
+    }
+
     if (this.settings.dropbox.clientID === "") {
       this.settings.dropbox.clientID = DEFAULT_SETTINGS.dropbox.clientID;
     }
@@ -1381,6 +1387,9 @@ export default class RemotelySavePlugin extends Plugin {
     if (this.settings.webdav.remoteBaseDir === undefined) {
       this.settings.webdav.remoteBaseDir = "";
     }
+    if (this.settings.webdav.customHeaders === undefined) {
+      this.settings.webdav.customHeaders = "";
+    }
     if (this.settings.s3.partsConcurrency === undefined) {
       this.settings.s3.partsConcurrency = 20;
     }
@@ -1876,6 +1885,7 @@ export default class RemotelySavePlugin extends Plugin {
                 const fsLocal = new FakeFsLocal(
                   this.app.vault,
                   this.settings.syncConfigDir ?? false,
+                  this.settings.syncBookmarks ?? false,
                   this.app.vault.configDir,
                   this.manifest.id,
                   undefined,

src/misc.ts

@@ -467,6 +467,21 @@ export const isSpecialFolderNameToSkip = (
       return true;
     }
   }
+
+  // microsoft tmp files...
+  const p = x.split("/");
+  if (p.length > 0) {
+    const f = p[p.length - 1]; // file name
+    if (f.startsWith("~$")) {
+      const suffixList = ["doc", "docx", "ppt", "pptx", "xls", "xlsx"];
+      for (const suffix of suffixList) {
+        if (f.endsWith(`.${suffix}`)) {
+          return true;
+        }
+      }
+    }
+  }
+
   return false;
 };
 

src/obsFolderLister.ts

@@ -34,11 +34,15 @@ const isLikelyPluginSubFiles = (x: string) => {
 export const listFilesInObsFolder = async (
   configDir: string,
   vault: Vault,
-  pluginId: string
+  pluginId: string,
+  bookmarksOnly: boolean
 ): Promise<Entity[]> => {
   const q = new Queue([configDir]);
   const CHUNK_SIZE = 10;
-  const contents: Entity[] = [];
+  let contents: Entity[] = [];
+
+  let iterRound = 0;
+
   while (q.length > 0) {
     const itemsToFetch: string[] = [];
     while (q.length > 0) {
@@ -115,6 +119,23 @@ export const listFilesInObsFolder = async (
         }
       }
     }
+
+    if (bookmarksOnly && iterRound > 1) {
+      // list until bookmarks.json is found or next level is arrived.
+      break;
+    }
+
+    iterRound += 1;
   }
+
+  // console.debug(`contents in obs config: ${JSON.stringify(contents)}`);
+
+  if (bookmarksOnly) {
+    contents = contents.filter(
+      (e) =>
+        e.key === `${configDir}/` || e.key === `${configDir}/bookmarks.json`
+    );
+  }
+
   return contents;
 };

src/settings.ts

@@ -23,6 +23,7 @@ import type {
 import cloneDeep from "lodash/cloneDeep";
 import { generateAzureBlobStorageSettingsPart } from "../pro/src/settingsAzureBlobStorage";
 import { generateBoxSettingsPart } from "../pro/src/settingsBox";
+import { generateClearDupFilesSettingsPart } from "../pro/src/settingsClearDupFiles";
 import { generateGoogleDriveSettingsPart } from "../pro/src/settingsGoogleDrive";
 import { generateKoofrSettingsPart } from "../pro/src/settingsKoofr";
 import { generateOnedriveFullSettingsPart } from "../pro/src/settingsOnedriveFull";
@@ -1637,6 +1638,27 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
           });
       });
 
+    new Setting(webdavDiv)
+      .setName(t("settings_webdav_customheaders"))
+      .setDesc(stringToFragment(t("settings_webdav_customheaders_desc")))
+      .addTextArea((textArea) => {
+        textArea
+          .setPlaceholder(`X-Header1: Value1\nX-Header2: Value2`)
+          .setValue(`${this.plugin.settings.webdav.customHeaders ?? ""}`)
+          .onChange(async (value) => {
+            this.plugin.settings.webdav.customHeaders = value
+              .trim()
+              .split("\n")
+              .filter((x) => x.trim() !== "")
+              .join("\n");
+            await this.plugin.saveSettings();
+          });
+        textArea.inputEl.rows = 10;
+        textArea.inputEl.cols = 30;
+
+        textArea.inputEl.addClass("webdav-customheaders-textarea");
+      });
+
     let newWebdavRemoteBaseDir =
       this.plugin.settings.webdav.remoteBaseDir || "";
     new Setting(webdavDiv)
@@ -2303,6 +2325,27 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
           });
       });
 
+    new Setting(advDiv)
+      .setName(t("settings_bookmarks"))
+      .setDesc(
+        t("settings_bookmarks_desc", {
+          configDir: this.app.vault.configDir,
+        })
+      )
+      .addDropdown((dropdown) => {
+        dropdown.addOption("disable", t("disable"));
+        dropdown.addOption("enable", t("enable"));
+
+        dropdown
+          .setValue(
+            `${this.plugin.settings.syncBookmarks ? "enable" : "disable"}`
+          )
+          .onChange(async (val) => {
+            this.plugin.settings.syncBookmarks = val === "enable";
+            await this.plugin.saveSettings();
+          });
+      });
+
     new Setting(advDiv)
       .setName(t("settings_deletetowhere"))
       .setDesc(t("settings_deletetowhere_desc"))
@@ -2359,6 +2402,8 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         });
     });
 
+    generateClearDupFilesSettingsPart(advDiv, t, this.app, this.plugin);
+
     const percentage1 = new Setting(advDiv)
       .setName(t("settings_protectmodifypercentage"))
       .setDesc(t("settings_protectmodifypercentage_desc"));
@@ -2781,6 +2826,19 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
           new Notice(t("settings_syncplans_notice"));
         });
       })
+      .addButton(async (button) => {
+        button.setButtonText(t("settings_syncplans_button_5_only_change"));
+        button.onClick(async () => {
+          await exportVaultSyncPlansToFiles(
+            this.plugin.db,
+            this.app.vault,
+            this.plugin.vaultRandomID,
+            5,
+            true
+          );
+          new Notice(t("settings_syncplans_notice"));
+        });
+      })
       .addButton(async (button) => {
         button.setButtonText(t("settings_syncplans_button_1"));
         button.onClick(async () => {

styles.css

@@ -88,6 +88,10 @@
   display: none;
 }
 
+.webdav-customheaders-textarea {
+  font-family: monospace;
+}
+
 .webdis-disclaimer {
   font-weight: bold;
 }