0.2.14

.env.example.txt

@@ -0,0 +1,3 @@
+DROPBOX_APP_KEY=
+ONEDRIVE_CLIENT_ID=
+ONEDRIVE_AUTHORITY=https://

.github/workflows/auto-build.yml

@@ -15,6 +15,11 @@ jobs:
 
     environment: env-for-buildci
 
+    env:
+      DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
+      ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
+      ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
+
     strategy:
       matrix:
         node-version: [16.x]

.prettierignore

@@ -1,2 +1,3 @@
 node_modules/
 main.js
+data.json

README.md

@@ -2,7 +2,11 @@
 
 This is yet another unofficial sync plugin for Obsidian. If you like it or find it useful, please consider give it a [star ![GitHub Repo stars](https://img.shields.io/github/stars/fyears/remotely-save?style=social)](https://github.com/fyears/remotely-save) on Github.
 
-[![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml) [![Latest release: 0.2.6)](https://img.shields.io/github/downloads/fyears/remotely-save/0.2.6/main.js)](https://github.com/fyears/remotely-save/releases) [![Previous release: 0.2.5)](https://img.shields.io/github/downloads/fyears/remotely-save/0.2.5/main.js)](https://github.com/fyears/remotely-save/releases)
+[![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml)
+
+[![total downloads auto count](https://remotely-save.github.io/auto-download-stats/totalDownloads.svg)](https://github.com/fyears/remotely-save/releases)
+
+[![downloads of latest version](https://remotely-save.github.io/auto-download-stats/latestVersionDownloads.svg)](https://github.com/fyears/remotely-save/releases)
 
 ## Disclaimer
 
@@ -17,17 +21,17 @@ As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any
 - Supports:
   - Amazon S3 or S3-compatible
   - Dropbox
-  - OneDrive
+  - OneDrive for personal
   - Webdav
 - **Obsidiain Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
 - **[End-to-end encryption](./docs/encryption.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
+- **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
 - **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
 - **Fully open source under [Apache-2.0 License](./LICENSE).**
 - **[Sync Algorithm open](./docs/sync_algorithm.md) for discussion.**
 
 ## Limitations
 
-- **Users have to trigger the sync manually.** This design is intentional because the plugin is in beta, and it's better for users to be exactly aware of the running of this plugin.
 - **"deletion" operation can only be triggered from local device.** It's because of the "[minimal intrusive design](./docs/minimal_intrusive_design.md)". May be changed in the future.
 - **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
 - **Cloud services cost you money.** Always be aware of the costs and pricing.
@@ -45,7 +49,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 ## Download and Install
 
-- Option #1: You can search, download, and install the plugin in official "community plugin list".
+- Option #1: Search in the official "community plugin list", or click [obsidian://show-plugin?id=remotely-save](obsidian://show-plugin?id=remotely-save), then install the plugin.
 - Option #2: You can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin. Input `fyears/remotely-save` in the configuration of BRAT.
 - Option #3: [![GitHub release (latest by SemVer and asset including pre-releases)](https://img.shields.io/github/downloads-pre/fyears/remotely-save/latest/main.js?sort=semver)](https://github.com/fyears/remotely-save/releases) Manually download assets (`main.js`, `manifest.json`, `styles.css`) from the latest release.
 - Option #4: [![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml) Every artifacts are placed in the "Summary" under every successful builds. It's automatically generated by every commit, may break something.
@@ -59,7 +63,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 - Download and enable this plugin.
 - Enter your information to the settings of this plugin.
 - If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
-- Click the new "switch" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (No "auto sync" yet.)
+- Click the new "circle arrow" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (Or, you could configure auto sync in the settings panel (See next chapter).) While syncing, the icon becomes "two half-circle arrows". Besides clicking the icon on the sidebar ribbon, you can also activate the corresponding command in the command palette.
 - **Be patient while syncing.** Especially in the first-time sync.
 
 ### Dropbox
@@ -70,10 +74,11 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 - If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions.
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
 
-### OneDrive
+### OneDrive for personal
 
 - **This plugin's function for OneDrive is not as mature as functions for S3.**
 - **This plugin is NOT an official Microsoft / OneDrive product.** The plugin just uses Microsoft's [OneDrive's public API](https://docs.microsoft.com/en-us/onedrive/developer/rest-api).
+- This plugin only works for "OneDrive for personal", and not works for "OneDrive for Business" (yet). See [#11](https://github.com/fyears/remotely-save/issues/11) to further details.
 - After the authorization, the plugin can read your name and email, and read and write files in your OneDrive's `/Apps/remotely-save` folder.
 - If you decide to authorize this plugin to connect to OneDrive, please go to plugin's settings, and choose OneDrive then follow the instructions.
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
@@ -88,22 +93,12 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 - Your data would be synced to a `${vaultName}` sub folder on your webdav server.
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
 
-## Import And Export Not-Oauth2 Plugin Settings By QR Code
+## Scheduled Auto Sync
 
-It's often verbose / inconvenient to input not-oauth2 credentials on mobile. (On different desktop computers, it's trivial to copy and paste `data.json` across different devices.)
+- You can configure auto syncing every N minutes in settings.
+- In auto sync mode, if any error occurs, the plugin would **fail silently**.
+- Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
 
-So this plugin has a helper function to export those settings as a QR code, then you could use mobile device's camera to import the settings.
+## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
 
-Attention:
+See [here](./docs/import_export_some_settings.md) for more details.
-
-1. Oauth2 - related information is omitted. It means that Dropbox, OneDrive login credentials are NOT included in the QR Code.
-2. Please, NEVER share the QR Code to others. It's as equivalent to the login credentials.
-
-Steps:
-
-1. Configure the plugin settings on one device, and make sure the sync functions work. (E.g, you could sync notes using S3 credentials.)
-2. Open plugin settings page. Then scroll down the page, until the section "Import and Export Settings". Click the button "Get QR Code". A new modal should show up and you should see a QR code.
-3. On a second device, make sure the vault name is the same as the first device's.
-4. On that second device, use its camera app, or any apps that support scanning QR codes, to scan the QR code from the first device. (On latest iOS, the system's built in camera app should work. On Android, at least one open source app [Binary Eye](https://github.com/markusfisch/BinaryEye) is tested to be working.)
-5. A link / url / address should be identified in the scan-QR-code app, and you could follow the instruction in the app, and then you should be redirected to open the Obsidian app.
-6. And finally, there should be a new notice in the Obsidian app saying the settings are successfully imported. Otherwise please check the error message in the notice.

assets/branding/256x256.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a9bf1cc2403c3a32e7a6f5d5829bb065573922dc050ae2fdb8b3d34b4c87ecf5
+size 8296

assets/branding/300x300.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6990a598379c457442345e50c3f056c4598a121523bc10980835c08fc7447a54
+size 10119

assets/branding/300x300.svg

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:432198e63fa9676541a41436917e025d1ea6af3772139c1dea450fcc0155cfd0
+size 13054

assets/branding/50x50.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fe3b5b8bf9c32e57c0af366c455b11ae68eb9fb8a32f371c9c445b3e7e89cc02
+size 1120

assets/branding/64x64.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f68df7bae94eb4c4cddfa6af47d7819d01a6482d4f6afe6ef3236f72f9adf15f
+size 1523

assets/branding/LICENSE.txt

@@ -0,0 +1 @@
+This work is licensed under CC BY-SA 4.0. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/

assets/branding/README.md

@@ -0,0 +1,75 @@
+# the logo
+
+Some different sizes' logos are needed.
+
+## license
+
+<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
+
+## the process of creation
+
+No professional designers are here. Thus the following steps involve many programer styles. :-)
+
+1. use excalidraw and export png and svg.
+
+   ```bash
+   # results
+   logo.excalidraw
+   logo.png
+   logo.svg
+   ```
+
+2. manually edit the `logo.svg` and make background transparent.
+
+   ```bash
+   # results
+   logo-transparent.svg
+   ```
+
+3. use python library [`svgutils`](https://github.com/btel/svg_utils) to make a strictly square figure. The [doc](https://svgutils.readthedocs.io/en/latest/tutorials/composing_multipanel_figures.html) is very useful.
+
+   ```python
+   from svgutils.compose import *
+   def get_standard_300x300(file_name):
+       fig = Figure(300, 300,
+           Panel(
+               SVG(file_name),
+           ).move(-3, 12),
+       )
+       return fig
+
+   get_standard_300x300('logo-transparent.svg').save('300x300.svg')
+
+   # def get_other_size_from_standard(file_name, px):
+   #     fig = Figure(px, px,
+   #         Panel(
+   #             SVG(file_name).scale(px/300.0),
+   #         ).move(-3*px/300.0, 12*px/300.0),
+   #     )
+   #     return fig
+
+   # get_other_size_from_standard('logo.svg',256).save('256x256.svg')
+   ```
+
+   ```bash
+   # results
+   300x300.svg
+   ```
+
+4. use `inkscape` command line to get different sizes' `.png` files.
+
+   ```bash
+   inkscape 300x300.svg -o 300x300.png
+
+   inkscape 300x300.svg -o 50x50.png -w 50 -h 50
+
+   inkscape 300x300.svg -o 64x64.png -w 64 -h 64
+   inkscape 300x300.svg -o 256x256.png -w 256 -h 256
+   ```
+
+   ```bash
+   # results
+   50x50.png
+   64x64.png
+   256x256.png
+   ```

assets/branding/logo-transparent.svg

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:daedd262170200cb5e8cc288898b40892771b3962cf2bc17dc443f1c82a4aa94
+size 12886

docs/import_export_some_settings.md

@@ -0,0 +1,19 @@
+## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
+
+It's often verbose / inconvenient to input not-oauth2 credentials on mobile. (On different desktop computers, it's trivial to copy and paste `data.json` across different devices.)
+
+So this plugin has a helper function to export those settings as a QR code, then you could use mobile device's camera to import the settings.
+
+Attention:
+
+1. Oauth2 - related information is omitted. It means that Dropbox, OneDrive login credentials are NOT included in the QR Code.
+2. Please, NEVER share the QR Code to others. It's as equivalent to the login credentials.
+
+Steps:
+
+1. Configure the plugin settings on one device, and make sure the sync functions work. (E.g, you could sync notes using S3 credentials.)
+2. Open plugin settings page. Then scroll down the page, until the section "Import and Export Settings". Click the button "Get QR Code". A new modal should show up and you should see a QR code.
+3. On a second device, make sure the vault name is the same as the first device's.
+4. On that second device, use its camera app, or any apps that support scanning QR codes, to scan the QR code from the first device. (On latest iOS, the system's built in camera app should work. On Android, at least one open source app [Binary Eye](https://github.com/markusfisch/BinaryEye) is tested to be working.)
+5. A link / url / address should be identified in the scan-QR-code app, and you could follow the instruction in the app, and then you should be redirected to open the Obsidian app.
+6. And finally, there should be a new notice in the Obsidian app saying the settings are successfully imported. Otherwise please check the error message in the notice.

esbuild.config.mjs

@@ -9,6 +9,8 @@ if you want to view the source, please visit the github repository of this plugi
 */
 `;
 
+console.log(`esbuild version = ${esbuild.version}`);
+
 const prod = process.argv[2] === "production";
 
 const DEFAULT_DROPBOX_APP_KEY = process.env.DROPBOX_APP_KEY || "";

manifest.json

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

package.json

@@ -1,11 +1,12 @@
 {
   "name": "remotely-save",
-  "version": "0.2.6",
+  "version": "0.2.14",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
-    "dev": "node esbuild.config.mjs",
+    "dev2": "node esbuild.config.mjs",
     "build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
     "build": "webpack --mode production",
+    "dev": "webpack --mode development --watch",
     "format": "npx prettier --write .",
     "clean": "npx rimraf main.js",
     "test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'"
@@ -24,6 +25,7 @@
     "@microsoft/microsoft-graph-types": "^2.11.0",
     "@types/chai": "^4.2.22",
     "@types/chai-as-promised": "^7.1.4",
+    "@types/feather-icons": "^4.7.0",
     "@types/jsdom": "^16.2.13",
     "@types/lodash": "^4.14.178",
     "@types/mime-types": "^2.1.1",
@@ -35,7 +37,7 @@
     "chai-as-promised": "^7.1.1",
     "cross-env": "^7.0.3",
     "dotenv": "^10.0.0",
-    "esbuild": "^0.14.0",
+    "esbuild": "^0.14.3",
     "jsdom": "^19.0.0",
     "mocha": "^9.1.3",
     "prettier": "^2.4.1",
@@ -52,6 +54,7 @@
     "@aws-sdk/lib-storage": "^3.40.1",
     "@aws-sdk/signature-v4-crt": "^3.37.0",
     "@azure/msal-node": "^1.4.0",
+    "@fyears/tsqueue": "^1.0.1",
     "@microsoft/microsoft-graph-client": "^3.0.1",
     "acorn": "^8.5.0",
     "assert": "^2.0.0",
@@ -60,9 +63,12 @@
     "codemirror": "^5.63.1",
     "crypto-browserify": "^3.12.0",
     "dropbox": "^10.22.0",
+    "feather-icons": "^4.28.0",
     "localforage": "^1.10.0",
     "lodash": "^4.17.21",
+    "loglevel": "^1.8.0",
     "mime-types": "^2.1.33",
+    "nanoid": "^3.1.30",
     "obsidian": "^0.12.0",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",

src/baseTypes.ts

@@ -31,6 +31,7 @@ export interface WebdavConfig {
   username: string;
   password: string;
   authType: WebdavAuthType;
+  manualRecursive: boolean;
 }
 
 export interface OnedriveConfig {
@@ -52,6 +53,9 @@ export interface RemotelySavePluginSettings {
   onedrive: OnedriveConfig;
   password: string;
   serviceType: SUPPORTED_SERVICES_TYPE;
+  currLogLevel?: string;
+  vaultRandomID?: string;
+  autoRunEveryMilliseconds?: number;
 }
 
 export interface RemoteItem {

src/configPersist.ts

@@ -0,0 +1,70 @@
+import { base64, base64url } from "rfc4648";
+import { reverseString } from "./misc";
+
+import type { RemotelySavePluginSettings } from "./baseTypes";
+
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
+const DEFAULT_README: string =
+  "Do NOT modify this manually. It's generated automatically.";
+
+interface MessyConfigType {
+  readme: string;
+  d: string;
+}
+
+/**
+ * this should accept the result after loadData();
+ */
+export const messyConfigToNormal = (
+  x: MessyConfigType | RemotelySavePluginSettings | null | undefined
+): RemotelySavePluginSettings | null | undefined => {
+  log.debug("loading, original config on disk:");
+  log.debug(x);
+  if (x === null || x === undefined) {
+    log.debug("the messy config is null or undefined, skip");
+    return x as any;
+  }
+  if ("readme" in x && "d" in x) {
+    // we should decode
+    const y = JSON.parse(
+      (
+        base64url.parse(reverseString(x["d"]), {
+          out: Buffer.allocUnsafe as any,
+          loose: true,
+        }) as Buffer
+      ).toString("utf-8")
+    );
+    log.debug("loading, parsed config is:");
+    log.debug(y);
+    return y;
+  } else {
+    // return as is
+    log.debug("loading, parsed config is the same");
+    return x;
+  }
+};
+
+/**
+ * this should accept the result of original config
+ */
+export const normalConfigToMessy = (
+  x: RemotelySavePluginSettings | null | undefined
+) => {
+  if (x === null || x === undefined) {
+    log.debug("the normal config is null or undefined, skip");
+    return x;
+  }
+  const y = {
+    readme: DEFAULT_README,
+    d: reverseString(
+      base64url.stringify(Buffer.from(JSON.stringify(x), "utf-8"), {
+        pad: false,
+      })
+    ),
+  };
+  log.debug("encoding, encoded config is:");
+  log.debug(y);
+  return y;
+};

src/debugMode.ts

@@ -1,17 +1,24 @@
 import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
 
 import type { SyncPlanType } from "./sync";
-import { readAllSyncPlanRecordTexts } from "./localdb";
+import { readAllSyncPlanRecordTextsByVault } from "./localdb";
 import type { InternalDBs } from "./localdb";
 import { mkdirpInVault } from "./misc";
 
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
 const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
 const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX = "sync_plans_hist_exported_on_";
 
-export const exportSyncPlansToFiles = async (db: InternalDBs, vault: Vault) => {
+export const exportVaultSyncPlansToFiles = async (
-  console.log("exporting");
+  db: InternalDBs,
+  vault: Vault,
+  vaultRandomID: string
+) => {
+  log.info("exporting");
   await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
-  const records = await readAllSyncPlanRecordTexts(db);
+  const records = await readAllSyncPlanRecordTextsByVault(db, vaultRandomID);
   let md = "";
   if (records.length === 0) {
     md = "No sync plans history found";
@@ -25,5 +32,5 @@ export const exportSyncPlansToFiles = async (db: InternalDBs, vault: Vault) => {
   await vault.create(filePath, md, {
     mtime: ts,
   });
-  console.log("finish exporting");
+  log.info("finish exporting");
 };

src/encrypt.ts

@@ -1,6 +1,9 @@
 import { base32, base64url } from "rfc4648";
 import { bufferToArrayBuffer, hexStringToTypedArray } from "./misc";
 
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
 const DEFAULT_ITER = 20000;
 
 // base32.stringify(Buffer.from('Salted__'))

src/importExport.ts

@@ -7,6 +7,9 @@ import {
   RemotelySavePluginSettings,
 } from "./baseTypes";
 
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
 export const exportQrCodeUri = async (
   settings: RemotelySavePluginSettings,
   currentVaultName: string,
@@ -15,11 +18,12 @@ export const exportQrCodeUri = async (
   const settings2 = cloneDeep(settings);
   delete settings2.dropbox;
   delete settings2.onedrive;
+  delete settings2.vaultRandomID;
   const data = encodeURIComponent(JSON.stringify(settings2));
   const vault = encodeURIComponent(currentVaultName);
   const version = encodeURIComponent(pluginVersion);
   const rawUri = `obsidian://${COMMAND_URI}?func=settings&version=${version}&vault=${vault}&data=${data}`;
-  // console.log(uri)
+  // log.info(uri)
   const imgUri = await QRCode.toDataURL(rawUri);
   return {
     rawUri,

src/localdb.ts

@@ -6,7 +6,11 @@ import type { SyncPlanType } from "./sync";
 
 export type LocalForage = typeof localforage;
 
-export const DEFAULT_DB_VERSION_NUMBER: number = 20211114;
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
+const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108];
+export const DEFAULT_DB_VERSION_NUMBER: number = 20220108;
 export const DEFAULT_DB_NAME = "remotelysavedb";
 export const DEFAULT_TBL_VERSION = "schemaversion";
 export const DEFAULT_TBL_DELETE_HISTORY = "filefolderoperationhistory";
@@ -22,6 +26,7 @@ export interface FileFolderHistoryRecord {
   actionType: "delete" | "rename";
   keyType: "folder" | "file";
   renameTo: string;
+  vaultRandomID: string;
 }
 
 interface SyncMetaMappingRecord {
@@ -34,12 +39,14 @@ interface SyncMetaMappingRecord {
   remoteExtraKey: string;
   remoteType: SUPPORTED_SERVICES_TYPE;
   keyType: "folder" | "file";
+  vaultRandomID: string;
 }
 
 interface SyncPlanRecord {
   ts: number;
   remoteType: string;
   syncPlan: string;
+  vaultRandomID: string;
 }
 
 export interface InternalDBs {
@@ -49,7 +56,103 @@ export interface InternalDBs {
   syncPlansTbl: LocalForage;
 }
 
-export const prepareDBs = async () => {
+/**
+ * This migration mainly aims to assign vault name or vault id into all tables.
+ * @param db
+ * @param vaultRandomID
+ */
+const migrateDBsFrom20211114To20220108 = async (
+  db: InternalDBs,
+  vaultRandomID: string
+) => {
+  const oldVer = 20211114;
+  const newVer = 20220108;
+  log.debug(`start upgrading internal db from ${oldVer} to ${newVer}`);
+
+  const allPromisesToWait: Promise<any>[] = [];
+
+  log.debug("assign vault id to any delete history");
+  const keysInDeleteHistoryTbl = await db.deleteHistoryTbl.keys();
+  for (const key of keysInDeleteHistoryTbl) {
+    if (key.startsWith(vaultRandomID)) {
+      continue;
+    }
+    const value = (await db.deleteHistoryTbl.getItem(
+      key
+    )) as FileFolderHistoryRecord;
+    if (value === null || value === undefined) {
+      continue;
+    }
+    if (value.vaultRandomID === undefined || value.vaultRandomID === "") {
+      value.vaultRandomID = vaultRandomID;
+    }
+    const newKey = `${vaultRandomID}\t${key}`;
+    allPromisesToWait.push(db.deleteHistoryTbl.setItem(newKey, value));
+    allPromisesToWait.push(db.deleteHistoryTbl.removeItem(key));
+  }
+
+  log.debug("assign vault id to any sync mapping");
+  const keysInSyncMappingTbl = await db.syncMappingTbl.keys();
+  for (const key of keysInSyncMappingTbl) {
+    if (key.startsWith(vaultRandomID)) {
+      continue;
+    }
+    const value = (await db.syncMappingTbl.getItem(
+      key
+    )) as SyncMetaMappingRecord;
+    if (value === null || value === undefined) {
+      continue;
+    }
+    if (value.vaultRandomID === undefined || value.vaultRandomID === "") {
+      value.vaultRandomID = vaultRandomID;
+    }
+    const newKey = `${vaultRandomID}\t${key}`;
+    allPromisesToWait.push(db.syncMappingTbl.setItem(newKey, value));
+    allPromisesToWait.push(db.syncMappingTbl.removeItem(key));
+  }
+
+  log.debug("assign vault id to any sync plan records");
+  const keysInSyncPlansTbl = await db.syncPlansTbl.keys();
+  for (const key of keysInSyncPlansTbl) {
+    if (key.startsWith(vaultRandomID)) {
+      continue;
+    }
+    const value = (await db.syncPlansTbl.getItem(key)) as SyncPlanRecord;
+    if (value === null || value === undefined) {
+      continue;
+    }
+    if (value.vaultRandomID === undefined || value.vaultRandomID === "") {
+      value.vaultRandomID = vaultRandomID;
+    }
+    const newKey = `${vaultRandomID}\t${key}`;
+    allPromisesToWait.push(db.syncPlansTbl.setItem(newKey, value));
+    allPromisesToWait.push(db.syncPlansTbl.removeItem(key));
+  }
+
+  log.debug("finally update version if everything is ok");
+  await Promise.all(allPromisesToWait);
+  await db.versionTbl.setItem("version", newVer);
+
+  log.debug(`finish upgrading internal db from ${oldVer} to ${newVer}`);
+};
+
+const migrateDBs = async (
+  db: InternalDBs,
+  oldVer: number,
+  newVer: number,
+  vaultRandomID: string
+) => {
+  if (oldVer === newVer) {
+    return;
+  }
+  if (oldVer === 20211114 && newVer === 20220108) {
+    return await migrateDBsFrom20211114To20220108(db, vaultRandomID);
+  }
+  // not implemented
+  throw Error(`not supported internal db changes from ${oldVer} to ${newVer}`);
+};
+
+export const prepareDBs = async (vaultRandomID: string) => {
   const db = {
     versionTbl: localforage.createInstance({
       name: DEFAULT_DB_NAME,
@@ -71,14 +174,25 @@ export const prepareDBs = async () => {
 
   const originalVersion = (await db.versionTbl.getItem("version")) as number;
   if (originalVersion === null) {
+    log.debug(
+      `no internal db version, setting it to ${DEFAULT_DB_VERSION_NUMBER}`
+    );
     await db.versionTbl.setItem("version", DEFAULT_DB_VERSION_NUMBER);
   } else if (originalVersion === DEFAULT_DB_VERSION_NUMBER) {
     // do nothing
   } else {
-    await migrateDBs(db, originalVersion, DEFAULT_DB_VERSION_NUMBER);
+    log.debug(
+      `trying to upgrade db version from ${originalVersion} to ${DEFAULT_DB_VERSION_NUMBER}`
+    );
+    await migrateDBs(
+      db,
+      originalVersion,
+      DEFAULT_DB_VERSION_NUMBER,
+      vaultRandomID
+    );
   }
 
-  console.log("db connected");
+  log.info("db connected");
   return db;
 };
 
@@ -86,10 +200,10 @@ export const destroyDBs = async () => {
   // await localforage.dropInstance({
   //   name: DEFAULT_DB_NAME,
   // });
-  // console.log("db deleted");
+  // log.info("db deleted");
   const req = indexedDB.deleteDatabase(DEFAULT_DB_NAME);
   req.onsuccess = (event) => {
-    console.log("db deleted");
+    log.info("db deleted");
   };
   req.onblocked = (event) => {
     console.warn("trying to delete db but it was blocked");
@@ -100,35 +214,34 @@ export const destroyDBs = async () => {
   };
 };
 
-const migrateDBs = async (db: InternalDBs, oldVer: number, newVer: number) => {
+export const loadDeleteRenameHistoryTableByVault = async (
-  if (oldVer === newVer) {
+  db: InternalDBs,
-    return;
+  vaultRandomID: string
-  }
+) => {
-  // not implemented
-  throw Error(`not supported internal db changes from ${oldVer} to ${newVer}`);
-};
-
-export const loadDeleteRenameHistoryTable = async (db: InternalDBs) => {
   const records = [] as FileFolderHistoryRecord[];
   await db.deleteHistoryTbl.iterate((value, key, iterationNumber) => {
-    records.push(value as FileFolderHistoryRecord);
+    if (key.startsWith(`${vaultRandomID}\t`)) {
+      records.push(value as FileFolderHistoryRecord);
+    }
   });
   records.sort((a, b) => a.actionWhen - b.actionWhen); // ascending
   return records;
 };
 
-export const clearDeleteRenameHistoryOfKey = async (
+export const clearDeleteRenameHistoryOfKeyAndVault = async (
   db: InternalDBs,
-  key: string
+  key: string,
+  vaultRandomID: string
 ) => {
-  await db.deleteHistoryTbl.removeItem(key);
+  await db.deleteHistoryTbl.removeItem(`${vaultRandomID}\t${key}`);
 };
 
-export const insertDeleteRecord = async (
+export const insertDeleteRecordByVault = async (
   db: InternalDBs,
-  fileOrFolder: TAbstractFile
+  fileOrFolder: TAbstractFile,
+  vaultRandomID: string
 ) => {
-  // console.log(fileOrFolder);
+  // log.info(fileOrFolder);
   let k: FileFolderHistoryRecord;
   if (fileOrFolder instanceof TFile) {
     k = {
@@ -140,6 +253,7 @@ export const insertDeleteRecord = async (
       actionType: "delete",
       keyType: "file",
       renameTo: "",
+      vaultRandomID: vaultRandomID,
     };
   } else if (fileOrFolder instanceof TFolder) {
     // key should endswith "/"
@@ -155,17 +269,19 @@ export const insertDeleteRecord = async (
       actionType: "delete",
       keyType: "folder",
       renameTo: "",
+      vaultRandomID: vaultRandomID,
     };
   }
-  await db.deleteHistoryTbl.setItem(k.key, k);
+  await db.deleteHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
 };
 
-export const insertRenameRecord = async (
+export const insertRenameRecordByVault = async (
   db: InternalDBs,
   fileOrFolder: TAbstractFile,
-  oldPath: string
+  oldPath: string,
+  vaultRandomID: string
 ) => {
-  // console.log(fileOrFolder);
+  // log.info(fileOrFolder);
   let k: FileFolderHistoryRecord;
   if (fileOrFolder instanceof TFile) {
     k = {
@@ -177,6 +293,7 @@ export const insertRenameRecord = async (
       actionType: "rename",
       keyType: "file",
       renameTo: fileOrFolder.path,
+      vaultRandomID: vaultRandomID,
     };
   } else if (fileOrFolder instanceof TFolder) {
     const key = oldPath.endsWith("/") ? oldPath : `${oldPath}/`;
@@ -192,12 +309,13 @@ export const insertRenameRecord = async (
       actionType: "rename",
       keyType: "folder",
       renameTo: renameTo,
+      vaultRandomID: vaultRandomID,
     };
   }
-  await db.deleteHistoryTbl.setItem(k.key, k);
+  await db.deleteHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
 };
 
-export const upsertSyncMetaMappingData = async (
+export const upsertSyncMetaMappingDataByVault = async (
   serviceType: SUPPORTED_SERVICES_TYPE,
   db: InternalDBs,
   localKey: string,
@@ -206,7 +324,8 @@ export const upsertSyncMetaMappingData = async (
   remoteKey: string,
   remoteMTime: number,
   remoteSize: number,
-  remoteExtraKey: string /* ETag from s3 */
+  remoteExtraKey: string,
+  vaultRandomID: string
 ) => {
   const aggregratedInfo: SyncMetaMappingRecord = {
     localKey: localKey,
@@ -218,19 +337,24 @@ export const upsertSyncMetaMappingData = async (
     remoteExtraKey: remoteExtraKey,
     remoteType: serviceType,
     keyType: localKey.endsWith("/") ? "folder" : "file",
+    vaultRandomID: vaultRandomID,
   };
-  await db.syncMappingTbl.setItem(remoteKey, aggregratedInfo);
+  await db.syncMappingTbl.setItem(
+    `${vaultRandomID}\t${remoteKey}`,
+    aggregratedInfo
+  );
 };
 
-export const getSyncMetaMappingByRemoteKey = async (
+export const getSyncMetaMappingByRemoteKeyAndVault = async (
   serviceType: SUPPORTED_SERVICES_TYPE,
   db: InternalDBs,
   remoteKey: string,
   remoteMTime: number,
-  remoteExtraKey: string
+  remoteExtraKey: string,
+  vaultRandomID: string
 ) => {
   const potentialItem = (await db.syncMappingTbl.getItem(
-    remoteKey
+    `${vaultRandomID}\t${remoteKey}`
   )) as SyncMetaMappingRecord;
 
   if (potentialItem === null) {
@@ -255,26 +379,33 @@ export const clearAllSyncMetaMapping = async (db: InternalDBs) => {
   await db.syncMappingTbl.clear();
 };
 
-export const insertSyncPlanRecord = async (
+export const insertSyncPlanRecordByVault = async (
   db: InternalDBs,
-  syncPlan: SyncPlanType
+  syncPlan: SyncPlanType,
+  vaultRandomID: string
 ) => {
   const record = {
     ts: syncPlan.ts,
+    vaultRandomID: vaultRandomID,
     remoteType: syncPlan.remoteType,
     syncPlan: JSON.stringify(syncPlan /* directly stringify */, null, 2),
   } as SyncPlanRecord;
-  await db.syncPlansTbl.setItem(`${syncPlan.ts}`, record);
+  await db.syncPlansTbl.setItem(`${vaultRandomID}\t${syncPlan.ts}`, record);
 };
 
 export const clearAllSyncPlanRecords = async (db: InternalDBs) => {
   await db.syncPlansTbl.clear();
 };
 
-export const readAllSyncPlanRecordTexts = async (db: InternalDBs) => {
+export const readAllSyncPlanRecordTextsByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string
+) => {
   const records = [] as SyncPlanRecord[];
   await db.syncPlansTbl.iterate((value, key, iterationNumber) => {
-    records.push(value as SyncPlanRecord);
+    if (key.startsWith(`${vaultRandomID}\t`)) {
+      records.push(value as SyncPlanRecord);
+    }
   });
   records.sort((a, b) => -(a.ts - b.ts)); // descending
 

src/main.ts

@@ -1,5 +1,7 @@
-import { Modal, Notice, Plugin, Setting } from "obsidian";
+import { Modal, Notice, Plugin, Setting, addIcon, setIcon } from "obsidian";
 import cloneDeep from "lodash/cloneDeep";
+import { nanoid } from "nanoid";
+import feather from "feather-icons";
 import type { RemotelySavePluginSettings } from "./baseTypes";
 import {
   COMMAND_CALLBACK,
@@ -10,10 +12,10 @@ import {
 import { importQrCodeUri } from "./importExport";
 import type { InternalDBs } from "./localdb";
 import {
-  insertDeleteRecord,
+  insertDeleteRecordByVault,
-  insertRenameRecord,
+  insertRenameRecordByVault,
-  insertSyncPlanRecord,
+  insertSyncPlanRecordByVault,
-  loadDeleteRenameHistoryTable,
+  loadDeleteRenameHistoryTableByVault,
   prepareDBs,
 } from "./localdb";
 import { RemoteClient } from "./remote";
@@ -34,6 +36,10 @@ import { DEFAULT_WEBDAV_CONFIG } from "./remoteForWebdav";
 import { RemotelySaveSettingTab } from "./settings";
 import type { SyncStatusType } from "./sync";
 import { doActualSync, getSyncPlan, isPasswordOk } from "./sync";
+import { messyConfigToNormal, normalConfigToMessy } from "./configPersist";
+
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
 
 const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   s3: DEFAULT_S3_CONFIG,
@@ -42,6 +48,9 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   onedrive: DEFAULT_ONEDRIVE_CONFIG,
   password: "",
   serviceType: "s3",
+  currLogLevel: "info",
+  vaultRandomID: "",
+  autoRunEveryMilliseconds: -1,
 };
 
 interface OAuth2Info {
@@ -52,15 +61,182 @@ interface OAuth2Info {
   revokeAuthSetting?: Setting;
 }
 
+type SyncTriggerSourceType = "manual" | "auto";
+
+const iconNameSyncWait = `remotely-save-sync-wait`;
+const iconNameSyncRunning = `remotely-save-sync-running`;
+const iconSvgSyncWait = feather.icons["rotate-ccw"].toSvg({
+  width: 100,
+  height: 100,
+});
+const iconSvgSyncRunning = feather.icons["refresh-ccw"].toSvg({
+  width: 100,
+  height: 100,
+});
+
 export default class RemotelySavePlugin extends Plugin {
   settings: RemotelySavePluginSettings;
   // cm: CodeMirror.Editor;
   db: InternalDBs;
   syncStatus: SyncStatusType;
   oauth2Info: OAuth2Info;
+  currLogLevel: string;
+  currSyncMsg?: string;
+  syncRibbon?: HTMLElement;
+  autoRunIntervalID?: number;
+
+  async syncRun(triggerSource: SyncTriggerSourceType = "manual") {
+    const getNotice = (x: string) => {
+      // only show notices in manual mode
+      // no notice in auto mode
+      if (triggerSource === "manual") {
+        new Notice(x);
+      }
+    };
+    if (this.syncStatus !== "idle") {
+      // here the notice is shown regardless of triggerSource
+      new Notice(`Remotely Save already running in stage ${this.syncStatus}!`);
+      if (this.currSyncMsg !== undefined && this.currSyncMsg !== "") {
+        new Notice(this.currSyncMsg);
+      }
+      return;
+    }
+
+    let originLabel = `${this.manifest.name}`;
+    if (this.syncRibbon !== undefined) {
+      originLabel = this.syncRibbon.getAttribute("aria-label");
+    }
+
+    try {
+      log.info(
+        `${
+          this.manifest.id
+        }-${Date.now()}: start sync, triggerSource=${triggerSource}`
+      );
+
+      if (this.syncRibbon !== undefined) {
+        setIcon(this.syncRibbon, iconNameSyncRunning);
+        this.syncRibbon.setAttribute(
+          "aria-label",
+          `${this.manifest.name}: ${triggerSource} syncing`
+        );
+      }
+
+      //log.info(`huh ${this.settings.password}`)
+      getNotice(
+        `1/7 Remotely Save Sync Preparing (${this.settings.serviceType})`
+      );
+      this.syncStatus = "preparing";
+
+      getNotice("2/7 Starting to fetch remote meta data.");
+      this.syncStatus = "getting_remote_meta";
+      const self = this;
+      const client = new RemoteClient(
+        this.settings.serviceType,
+        this.settings.s3,
+        this.settings.webdav,
+        this.settings.dropbox,
+        this.settings.onedrive,
+        this.app.vault.getName(),
+        () => self.saveSettings()
+      );
+      const remoteRsp = await client.listFromRemote();
+      log.info(remoteRsp);
+
+      getNotice("3/7 Starting to fetch local meta data.");
+      this.syncStatus = "getting_local_meta";
+      const local = this.app.vault.getAllLoadedFiles();
+      const localHistory = await loadDeleteRenameHistoryTableByVault(
+        this.db,
+        this.settings.vaultRandomID
+      );
+      // log.info(local);
+      // log.info(localHistory);
+
+      getNotice("4/7 Checking password correct or not.");
+      this.syncStatus = "checking_password";
+      const passwordCheckResult = await isPasswordOk(
+        remoteRsp.Contents,
+        this.settings.password
+      );
+      if (!passwordCheckResult.ok) {
+        getNotice("something goes wrong while checking password");
+        throw Error(passwordCheckResult.reason);
+      }
+
+      getNotice("5/7 Starting to generate sync plan.");
+      this.syncStatus = "generating_plan";
+      const syncPlan = await getSyncPlan(
+        remoteRsp.Contents,
+        local,
+        localHistory,
+        this.db,
+        this.settings.vaultRandomID,
+        client.serviceType,
+        this.settings.password
+      );
+      log.info(syncPlan.mixedStates); // for debugging
+      await insertSyncPlanRecordByVault(
+        this.db,
+        syncPlan,
+        this.settings.vaultRandomID
+      );
+
+      // The operations above are read only and kind of safe.
+      // The operations below begins to write or delete (!!!) something.
+
+      getNotice("6/7 Remotely Save Sync data exchanging!");
+
+      this.syncStatus = "syncing";
+      await doActualSync(
+        client,
+        this.db,
+        this.settings.vaultRandomID,
+        this.app.vault,
+        syncPlan,
+        this.settings.password,
+        (i: number, totalCount: number, pathName: string, decision: string) =>
+          self.setCurrSyncMsg(i, totalCount, pathName, decision)
+      );
+
+      getNotice("7/7 Remotely Save finish!");
+      this.currSyncMsg = "";
+      this.syncStatus = "finish";
+      this.syncStatus = "idle";
+
+      if (this.syncRibbon !== undefined) {
+        setIcon(this.syncRibbon, iconNameSyncWait);
+        this.syncRibbon.setAttribute("aria-label", originLabel);
+      }
+
+      log.info(
+        `${
+          this.manifest.id
+        }-${Date.now()}: finish sync, triggerSource=${triggerSource}`
+      );
+    } catch (error) {
+      const msg = `${
+        this.manifest.id
+      }-${Date.now()}: abort sync, triggerSource=${triggerSource}, error while ${
+        this.syncStatus
+      }`;
+      log.info(msg);
+      log.info(error);
+      getNotice(msg);
+      getNotice(error.message);
+      this.syncStatus = "idle";
+      if (this.syncRibbon !== undefined) {
+        setIcon(this.syncRibbon, iconNameSyncWait);
+        this.syncRibbon.setAttribute("aria-label", originLabel);
+      }
+    }
+  }
 
   async onload() {
-    console.log(`loading plugin ${this.manifest.id}`);
+    log.info(`loading plugin ${this.manifest.id}`);
+
+    addIcon(iconNameSyncWait, iconSvgSyncWait);
+    addIcon(iconNameSyncRunning, iconSvgSyncRunning);
 
     this.oauth2Info = {
       verifier: "",
@@ -70,8 +246,16 @@ export default class RemotelySavePlugin extends Plugin {
       revokeAuthSetting: undefined,
     }; // init
 
+    this.currSyncMsg = "";
+
     await this.loadSettings();
+
+    if (this.settings.currLogLevel !== undefined) {
+      log.setLevel(this.settings.currLogLevel as any);
+    }
+
     await this.checkIfOauthExpires();
+    await this.checkIfVaultIDAssigned(); // MUST before prepareDB()
 
     await this.prepareDB();
 
@@ -79,13 +263,22 @@ export default class RemotelySavePlugin extends Plugin {
 
     this.registerEvent(
       this.app.vault.on("delete", async (fileOrFolder) => {
-        await insertDeleteRecord(this.db, fileOrFolder);
+        await insertDeleteRecordByVault(
+          this.db,
+          fileOrFolder,
+          this.settings.vaultRandomID
+        );
       })
     );
 
     this.registerEvent(
       this.app.vault.on("rename", async (fileOrFolder, oldPath) => {
-        await insertRenameRecord(this.db, fileOrFolder, oldPath);
+        await insertRenameRecordByVault(
+          this.db,
+          fileOrFolder,
+          oldPath,
+          this.settings.vaultRandomID
+        );
       })
     );
 
@@ -266,107 +459,42 @@ export default class RemotelySavePlugin extends Plugin {
       }
     );
 
-    this.addRibbonIcon("switch", "Remotely Save", async () => {
+    this.syncRibbon = this.addRibbonIcon(
-      if (this.syncStatus !== "idle") {
+      iconNameSyncWait,
-        new Notice(
+      `${this.manifest.name}`,
-          `Remotely Save already running in stage ${this.syncStatus}!`
+      async () => this.syncRun("manual")
-        );
+    );
-        return;
-      }
 
-      try {
+    this.addCommand({
-        //console.log(`huh ${this.settings.password}`)
+      id: "start-sync",
-        new Notice(
+      name: "start sync",
-          `1/7 Remotely Save Sync Preparing (${this.settings.serviceType})`
+      icon: iconNameSyncWait,
-        );
+      callback: async () => {
-        this.syncStatus = "preparing";
+        this.syncRun("manual");
-
+      },
-        new Notice("2/7 Starting to fetch remote meta data.");
-        this.syncStatus = "getting_remote_meta";
-        const self = this;
-        const client = new RemoteClient(
-          this.settings.serviceType,
-          this.settings.s3,
-          this.settings.webdav,
-          this.settings.dropbox,
-          this.settings.onedrive,
-          this.app.vault.getName(),
-          () => self.saveSettings()
-        );
-        const remoteRsp = await client.listFromRemote();
-        // console.log(remoteRsp);
-
-        new Notice("3/7 Starting to fetch local meta data.");
-        this.syncStatus = "getting_local_meta";
-        const local = this.app.vault.getAllLoadedFiles();
-        const localHistory = await loadDeleteRenameHistoryTable(this.db);
-        // console.log(local);
-        // console.log(localHistory);
-
-        new Notice("4/7 Checking password correct or not.");
-        this.syncStatus = "checking_password";
-        const passwordCheckResult = await isPasswordOk(
-          remoteRsp.Contents,
-          this.settings.password
-        );
-        if (!passwordCheckResult.ok) {
-          new Notice("something goes wrong while checking password");
-          throw Error(passwordCheckResult.reason);
-        }
-
-        new Notice("5/7 Starting to generate sync plan.");
-        this.syncStatus = "generating_plan";
-        const syncPlan = await getSyncPlan(
-          remoteRsp.Contents,
-          local,
-          localHistory,
-          this.db,
-          client.serviceType,
-          this.settings.password
-        );
-        console.log(syncPlan.mixedStates); // for debugging
-        await insertSyncPlanRecord(this.db, syncPlan);
-
-        // The operations above are read only and kind of safe.
-        // The operations below begins to write or delete (!!!) something.
-
-        new Notice("6/7 Remotely Save Sync data exchanging!");
-
-        this.syncStatus = "syncing";
-        await doActualSync(
-          client,
-          this.db,
-          this.app.vault,
-          syncPlan,
-          this.settings.password
-        );
-
-        new Notice("7/7 Remotely Save finish!");
-        this.syncStatus = "finish";
-        this.syncStatus = "idle";
-      } catch (error) {
-        const msg = `Remotely Save error while ${this.syncStatus}`;
-        console.log(msg);
-        console.log(error);
-        new Notice(msg);
-        new Notice(error.message);
-        this.syncStatus = "idle";
-      }
     });
 
     this.addSettingTab(new RemotelySaveSettingTab(this.app, this));
 
     // this.registerDomEvent(document, "click", (evt: MouseEvent) => {
-    //   console.log("click", evt);
+    //   log.info("click", evt);
     // });
 
-    // this.registerInterval(
+    if (
-    //   window.setInterval(() => console.log("setInterval"), 5 * 60 * 1000)
+      this.settings.autoRunEveryMilliseconds !== undefined &&
-    // );
+      this.settings.autoRunEveryMilliseconds !== null &&
+      this.settings.autoRunEveryMilliseconds > 0
+    ) {
+      const intervalID = window.setInterval(() => {
+        this.syncRun("auto");
+      }, this.settings.autoRunEveryMilliseconds);
+      this.autoRunIntervalID = intervalID;
+      this.registerInterval(intervalID);
+    }
   }
 
   onunload() {
-    console.log(`unloading plugin ${this.manifest.id}`);
+    log.info(`unloading plugin ${this.manifest.id}`);
     this.destroyDBs();
   }
 
@@ -374,7 +502,7 @@ export default class RemotelySavePlugin extends Plugin {
     this.settings = Object.assign(
       {},
       cloneDeep(DEFAULT_SETTINGS),
-      await this.loadData()
+      messyConfigToNormal(await this.loadData())
     );
     if (this.settings.dropbox.clientID === "") {
       this.settings.dropbox.clientID = DEFAULT_SETTINGS.dropbox.clientID;
@@ -385,10 +513,13 @@ export default class RemotelySavePlugin extends Plugin {
     if (this.settings.onedrive.authority === "") {
       this.settings.onedrive.authority = DEFAULT_SETTINGS.onedrive.authority;
     }
+    if (this.settings.webdav.manualRecursive === undefined) {
+      this.settings.webdav.manualRecursive = false;
+    }
   }
 
   async saveSettings() {
-    await this.saveData(this.settings);
+    await this.saveData(normalConfigToMessy(this.settings));
   }
 
   async checkIfOauthExpires() {
@@ -461,11 +592,31 @@ export default class RemotelySavePlugin extends Plugin {
     }
   }
 
+  async checkIfVaultIDAssigned() {
+    if (
+      this.settings.vaultRandomID === undefined ||
+      this.settings.vaultRandomID === ""
+    ) {
+      this.settings.vaultRandomID = nanoid();
+      await this.saveSettings();
+    }
+  }
+
   async prepareDB() {
-    this.db = await prepareDBs();
+    this.db = await prepareDBs(this.settings.vaultRandomID);
   }
 
   destroyDBs() {
     /* destroyDBs(this.db); */
   }
+
+  async setCurrSyncMsg(
+    i: number,
+    totalCount: number,
+    pathName: string,
+    decision: string
+  ) {
+    const msg = `syncing progress=${i}/${totalCount},decision=${decision},path=${pathName}`;
+    this.currSyncMsg = msg;
+  }
 }

src/misc.ts

@@ -4,6 +4,9 @@ import * as path from "path";
 import { base32, base64url } from "rfc4648";
 import XRegExp from "xregexp";
 
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
 /**
  * If any part of the file starts with '.' or '_' then it's a hidden file.
  * @param item
@@ -13,7 +16,7 @@ import XRegExp from "xregexp";
 export const isHiddenPath = (item: string, loose: boolean = true) => {
   const k = path.posix.normalize(item); // TODO: only unix path now
   const k2 = k.split("/"); // TODO: only unix path now
-  // console.log(k2)
+  // log.info(k2)
   for (const singlePart of k2) {
     if (singlePart === "." || singlePart === ".." || singlePart === "") {
       continue;
@@ -54,14 +57,14 @@ export const getFolderLevels = (x: string) => {
 };
 
 export const mkdirpInVault = async (thePath: string, vault: Vault) => {
-  // console.log(thePath);
+  // log.info(thePath);
   const foldersToBuild = getFolderLevels(thePath);
-  // console.log(foldersToBuild);
+  // log.info(foldersToBuild);
   for (const folder of foldersToBuild) {
     const r = await vault.adapter.exists(folder);
-    // console.log(r);
+    // log.info(r);
     if (!r) {
-      console.log(`mkdir ${folder}`);
+      log.info(`mkdir ${folder}`);
       await vault.adapter.mkdir(folder);
     }
   }
@@ -196,3 +199,12 @@ export const getRandomArrayBuffer = (byteLength: number) => {
   const k = window.crypto.getRandomValues(new Uint8Array(byteLength));
   return bufferToArrayBuffer(k);
 };
+
+/**
+ * https://stackoverflow.com/questions/958908
+ * @param x
+ * @returns
+ */
+export const reverseString = (x: string) => {
+  return [...x].reverse().join("");
+};

src/remote.ts

@@ -11,6 +11,9 @@ import * as onedrive from "./remoteForOnedrive";
 import * as s3 from "./remoteForS3";
 import * as webdav from "./remoteForWebdav";
 
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
 export class RemoteClient {
   readonly serviceType: SUPPORTED_SERVICES_TYPE;
   readonly s3Client?: s3.S3Client;

src/remoteForDropbox.ts

@@ -12,6 +12,9 @@ import { bufferToArrayBuffer, getFolderLevels, mkdirpInVault } from "./misc";
 
 export { Dropbox } from "dropbox";
 
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
 export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
   accessToken: "",
   clientID: process.env.DEFAULT_DROPBOX_APP_KEY,
@@ -208,7 +211,7 @@ export const sendRefreshTokenReq = async (
   appKey: string,
   refreshToken: string
 ) => {
-  console.log("start auto getting refreshed Dropbox access token.");
+  log.info("start auto getting refreshed Dropbox access token.");
   const resp1 = await fetch("https://api.dropboxapi.com/oauth2/token", {
     method: "POST",
     body: new URLSearchParams({
@@ -218,7 +221,7 @@ export const sendRefreshTokenReq = async (
     }),
   });
   const resp2 = (await resp1.json()) as DropboxSuccessAuthRes;
-  console.log("finish auto getting refreshed Dropbox access token.");
+  log.info("finish auto getting refreshed Dropbox access token.");
   return resp2;
 };
 
@@ -227,7 +230,7 @@ export const setConfigBySuccessfullAuthInplace = async (
   authRes: DropboxSuccessAuthRes,
   saveUpdatedConfigFunc: () => Promise<any> | undefined
 ) => {
-  console.log("start updating local info of Dropbox token");
+  log.info("start updating local info of Dropbox token");
 
   config.accessToken = authRes.access_token;
   config.accessTokenExpiresInSeconds = parseInt(authRes.expires_in);
@@ -249,7 +252,7 @@ export const setConfigBySuccessfullAuthInplace = async (
     await saveUpdatedConfigFunc();
   }
 
-  console.log("finish updating local info of Dropbox token");
+  log.info("finish updating local info of Dropbox token");
 };
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -308,9 +311,9 @@ export class WrappedDropboxClient {
     }
 
     // check vault folder
-    // console.log(`checking remote has folder /${this.vaultName}`);
+    // log.info(`checking remote has folder /${this.vaultName}`);
     if (this.vaultFolderExists) {
-      // console.log(`already checked, /${this.vaultName} exist before`)
+      // log.info(`already checked, /${this.vaultName} exist before`)
     } else {
       const res = await this.dropbox.filesListFolder({
         path: "",
@@ -323,14 +326,14 @@ export class WrappedDropboxClient {
         }
       }
       if (!this.vaultFolderExists) {
-        console.log(`remote does not have folder /${this.vaultName}`);
+        log.info(`remote does not have folder /${this.vaultName}`);
         await this.dropbox.filesCreateFolderV2({
           path: `/${this.vaultName}`,
         });
-        console.log(`remote folder /${this.vaultName} created`);
+        log.info(`remote folder /${this.vaultName} created`);
         this.vaultFolderExists = true;
       } else {
-        // console.log(`remote folder /${this.vaultName} exists`);
+        // log.info(`remote folder /${this.vaultName} exists`);
       }
     }
 
@@ -489,7 +492,7 @@ export const listFromRemote = async (
   if (res.status !== 200) {
     throw Error(JSON.stringify(res));
   }
-  // console.log(res);
+  // log.info(res);
 
   const contents = res.result.entries;
   const unifiedContents = contents

src/remoteForOnedrive.ts

@@ -1,26 +1,19 @@
 import { CryptoProvider, PublicClientApplication } from "@azure/msal-node";
-import {
+import { AuthenticationProvider } from "@microsoft/microsoft-graph-client";
-  AuthenticationProvider,
+import type {
-  Client,
+  DriveItem,
-  FileUpload,
+  UploadSession,
-  LargeFileUploadSession,
+  User,
-  LargeFileUploadTask,
+} from "@microsoft/microsoft-graph-types";
-  LargeFileUploadTaskOptions,
-  Range,
-  UploadEventHandlers,
-  UploadResult,
-} from "@microsoft/microsoft-graph-client";
-import type { DriveItem, User } from "@microsoft/microsoft-graph-types";
 import cloneDeep from "lodash/cloneDeep";
+import * as origLog from "loglevel";
 import { request, Vault } from "obsidian";
-import * as path from "path";
 import {
-  DropboxConfig,
+  COMMAND_CALLBACK_ONEDRIVE,
   OAUTH2_FORCE_EXPIRE_MILLISECONDS,
   OnedriveConfig,
   RemoteItem,
 } from "./baseTypes";
-import { COMMAND_CALLBACK_ONEDRIVE } from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import {
   getRandomArrayBuffer,
@@ -28,6 +21,8 @@ import {
   mkdirpInVault,
 } from "./misc";
 
+const log = origLog.getLogger("rs-default");
+
 const SCOPES = ["User.Read", "Files.ReadWrite.AppFolder", "offline_access"];
 const REDIRECT_URI = `obsidian://${COMMAND_CALLBACK_ONEDRIVE}`;
 
@@ -117,8 +112,8 @@ export const sendAuthReq = async (
   //   code: authCode,
   //   codeVerifier: verifier, // PKCE Code Verifier
   // });
-  // console.log('authResponse')
+  // log.info('authResponse')
-  // console.log(authResponse)
+  // log.info(authResponse)
   // return authResponse;
 
   // Because of the CORS problem,
@@ -142,7 +137,7 @@ export const sendAuthReq = async (
   });
 
   const rsp2 = JSON.parse(rsp1);
-  // console.log(rsp2);
+  // log.info(rsp2);
 
   if (rsp2.error !== undefined) {
     return rsp2 as AccessCodeResponseFailedType;
@@ -171,7 +166,7 @@ export const sendRefreshTokenReq = async (
   });
 
   const rsp2 = JSON.parse(rsp1);
-  // console.log(rsp2);
+  // log.info(rsp2);
 
   if (rsp2.error !== undefined) {
     return rsp2 as AccessCodeResponseFailedType;
@@ -185,7 +180,7 @@ export const setConfigBySuccessfullAuthInplace = async (
   authRes: AccessCodeResponseSuccessfulType,
   saveUpdatedConfigFunc: () => Promise<any> | undefined
 ) => {
-  console.log("start updating local info of OneDrive token");
+  log.info("start updating local info of OneDrive token");
   config.accessToken = authRes.access_token;
   config.accessTokenExpiresAtTime =
     Date.now() + authRes.expires_in - 5 * 60 * 1000;
@@ -200,7 +195,7 @@ export const setConfigBySuccessfullAuthInplace = async (
     await saveUpdatedConfigFunc();
   }
 
-  console.log("finish updating local info of Onedrive token");
+  log.info("finish updating local info of Onedrive token");
 };
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -245,19 +240,45 @@ const getNormPath = (fileOrFolderPath: string, vaultName: string) => {
   return fileOrFolderPath.slice(`${prefix}/`.length);
 };
 
+const constructFromDriveItemToRemoteItemError = (x: DriveItem) => {
+  return `parentPath="${x.parentReference.path}", selfName="${x.name}"`;
+};
+
 const fromDriveItemToRemoteItem = (
   x: DriveItem,
   vaultName: string
 ): RemoteItem => {
   let key = "";
 
-  const COMMON_PREFIX = `/drive/root:/Apps/remotely-save/${vaultName}`;
+  // possible prefix:
-  const COMMON_PREFIX_OTHERS = `/drive/items/`;
+  // pure english: /drive/root:/Apps/remotely-save/${vaultName}
-  if (`${x.parentReference.path}/${x.name}`.startsWith(COMMON_PREFIX)) {
+  // or localized, e.g.: /drive/root:/应用/remotely-save/${vaultName}
-    key = `${x.parentReference.path}/${x.name}`.substring(
+  const FIRST_COMMON_PREFIX_REGEX = /^\/drive\/root:\/[^\/]+\/remotely-save\//g;
-      COMMON_PREFIX.length + 1
+  // or the root is absolute path /Livefolders,
-    );
+  // e.g.: /Livefolders/应用/remotely-save/${vaultName}
-  } else if (x.parentReference.path.startsWith(COMMON_PREFIX_OTHERS)) {
+  const SECOND_COMMON_PREFIX_REGEX = /^\/Livefolders\/[^\/]+\/remotely-save\//g;
+
+  // another possibile prefix
+  const THIRD_COMMON_PREFIX_RAW = `/drive/items/`;
+
+  const fullPathOriginal = `${x.parentReference.path}/${x.name}`;
+  const matchFirstPrefixRes = fullPathOriginal.match(FIRST_COMMON_PREFIX_REGEX);
+  const matchSecondPrefixRes = fullPathOriginal.match(
+    SECOND_COMMON_PREFIX_REGEX
+  );
+  if (
+    matchFirstPrefixRes !== null &&
+    fullPathOriginal.startsWith(`${matchFirstPrefixRes[0]}${vaultName}`)
+  ) {
+    const foundPrefix = `${matchFirstPrefixRes[0]}${vaultName}`;
+    key = fullPathOriginal.substring(foundPrefix.length + 1);
+  } else if (
+    matchSecondPrefixRes !== null &&
+    fullPathOriginal.startsWith(`${matchSecondPrefixRes[0]}${vaultName}`)
+  ) {
+    const foundPrefix = `${matchSecondPrefixRes[0]}${vaultName}`;
+    key = fullPathOriginal.substring(foundPrefix.length + 1);
+  } else if (x.parentReference.path.startsWith(THIRD_COMMON_PREFIX_RAW)) {
     // it's something like
     // /drive/items/<some_id>!<another_id>:/${vaultName}/<subfolder>
     // with uri encoded!
@@ -270,14 +291,14 @@ const fromDriveItemToRemoteItem = (
       key = x.name;
     } else {
       throw Error(
-        `we meet file/folder and do not know how to deal with it:\n${JSON.stringify(
+        `we meet file/folder and do not know how to deal with it:\n${constructFromDriveItemToRemoteItemError(
           x
         )}`
       );
     }
   } else {
     throw Error(
-      `we meet file/folder and do not know how to deal with it:\n${JSON.stringify(
+      `we meet file/folder and do not know how to deal with it:\n${constructFromDriveItemToRemoteItemError(
         x
       )}`
     );
@@ -292,7 +313,7 @@ const fromDriveItemToRemoteItem = (
     lastModified: Date.parse(x.fileSystemInfo.lastModifiedDateTime),
     size: isFolder ? 0 : x.size,
     remoteType: "onedrive",
-    etag: x.eTag || x.cTag || "",
+    etag: x.cTag || "", // do NOT use x.eTag because it changes if meta changes
   };
 };
 
@@ -338,7 +359,7 @@ class MyAuthProvider implements AuthenticationProvider {
       this.onedriveConfig.accessTokenExpiresAtTime =
         currentTs + r2.expires_in * 1000 - 60 * 2 * 1000;
       await this.saveUpdatedConfigFunc();
-      console.log("Onedrive accessToken updated");
+      log.info("Onedrive accessToken updated");
       return this.onedriveConfig.accessToken;
     }
   };
@@ -347,8 +368,8 @@ class MyAuthProvider implements AuthenticationProvider {
 export class WrappedOnedriveClient {
   onedriveConfig: OnedriveConfig;
   vaultName: string;
-  client: Client;
   vaultFolderExists: boolean;
+  authGetter: MyAuthProvider;
   saveUpdatedConfigFunc: () => Promise<any>;
   constructor(
     onedriveConfig: OnedriveConfig,
@@ -359,9 +380,7 @@ export class WrappedOnedriveClient {
     this.vaultName = vaultName;
     this.vaultFolderExists = false;
     this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
-    this.client = Client.initWithMiddleware({
+    this.authGetter = new MyAuthProvider(onedriveConfig, saveUpdatedConfigFunc);
-      authProvider: new MyAuthProvider(onedriveConfig, saveUpdatedConfigFunc),
-    });
   }
 
   init = async () => {
@@ -374,29 +393,155 @@ export class WrappedOnedriveClient {
     }
 
     // check vault folder
-    // console.log(`checking remote has folder /${this.vaultName}`);
+    // log.info(`checking remote has folder /${this.vaultName}`);
     if (this.vaultFolderExists) {
-      // console.log(`already checked, /${this.vaultName} exist before`)
+      // log.info(`already checked, /${this.vaultName} exist before`)
     } else {
-      const k = await this.client.api("/drive/special/approot/children").get();
+      const k = await this.getJson("/drive/special/approot/children");
-      // console.log(k);
+      log.debug(k);
       this.vaultFolderExists =
         (k.value as DriveItem[]).filter((x) => x.name === this.vaultName)
           .length > 0;
       if (!this.vaultFolderExists) {
-        console.log(`remote does not have folder /${this.vaultName}`);
+        log.info(`remote does not have folder /${this.vaultName}`);
-        await this.client.api("/drive/special/approot/children").post({
+        await this.postJson("/drive/special/approot/children", {
           name: `${this.vaultName}`,
           folder: {},
           "@microsoft.graph.conflictBehavior": "replace",
         });
-        console.log(`remote folder /${this.vaultName} created`);
+        log.info(`remote folder /${this.vaultName} created`);
         this.vaultFolderExists = true;
       } else {
-        // console.log(`remote folder /${this.vaultName} exists`);
+        // log.info(`remote folder /${this.vaultName} exists`);
       }
     }
   };
+
+  buildUrl = (pathFragOrig: string) => {
+    const API_PREFIX = "https://graph.microsoft.com/v1.0";
+    let theUrl = "";
+    if (
+      pathFragOrig.startsWith("http://") ||
+      pathFragOrig.startsWith("https://")
+    ) {
+      theUrl = pathFragOrig;
+    } else {
+      const pathFrag = encodeURI(pathFragOrig);
+      theUrl = `${API_PREFIX}${pathFrag}`;
+    }
+    return theUrl;
+  };
+
+  getJson = async (pathFragOrig: string) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(`getJson, theUrl=${theUrl}`);
+    return JSON.parse(
+      await request({
+        url: theUrl,
+        method: "GET",
+        contentType: "application/json",
+        headers: {
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      })
+    );
+  };
+
+  postJson = async (pathFragOrig: string, payload: any) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(`postJson, theUrl=${theUrl}`);
+    return JSON.parse(
+      await request({
+        url: theUrl,
+        method: "POST",
+        contentType: "application/json",
+        body: JSON.stringify(payload),
+        headers: {
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      })
+    );
+  };
+
+  patchJson = async (pathFragOrig: string, payload: any) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(`patchJson, theUrl=${theUrl}`);
+    return JSON.parse(
+      await request({
+        url: theUrl,
+        method: "PATCH",
+        contentType: "application/json",
+        body: JSON.stringify(payload),
+        headers: {
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      })
+    );
+  };
+
+  deleteJson = async (pathFragOrig: string) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(`deleteJson, theUrl=${theUrl}`);
+    // TODO: delete does not have response, so Obsidian request may have error
+    // currently downgraded to fetch()!
+    await fetch(theUrl, {
+      method: "DELETE",
+      headers: {
+        Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+      },
+    });
+  };
+
+  putArrayBuffer = async (pathFragOrig: string, payload: ArrayBuffer) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(`putArrayBuffer, theUrl=${theUrl}`);
+    // TODO: Obsidian doesn't support ArrayBuffer
+    // currently downgraded to fetch()!
+    await fetch(theUrl, {
+      method: "PUT",
+      body: payload,
+      headers: {
+        Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+      },
+    });
+  };
+
+  /**
+   * A specialized function to upload large files by parts
+   * @param pathFragOrig
+   * @param payload
+   * @param rangeMin
+   * @param rangeEnd the end, exclusive
+   * @param size
+   */
+  putUint8ArrayByRange = async (
+    pathFragOrig: string,
+    payload: Uint8Array,
+    rangeStart: number,
+    rangeEnd: number,
+    size: number
+  ) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(
+      `putUint8ArrayByRange, theUrl=${theUrl}, range=${rangeStart}-${
+        rangeEnd - 1
+      }, len=${rangeEnd - rangeStart}, size=${size}`
+    );
+    // TODO: Obsidian doesn't support ArrayBuffer
+    // currently downgraded to fetch()!
+    // AND, NO AUTH HEADER here!
+    const res = await fetch(theUrl, {
+      method: "PUT",
+      body: payload.subarray(rangeStart, rangeEnd),
+      headers: {
+        "Content-Length": `${rangeEnd - rangeStart}`,
+        "Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
+        "Content-Type": "application/octet-stream",
+      },
+    });
+
+    return res.json() as DriveItem | UploadSession;
+  };
 }
 
 export const getOnedriveClient = (
@@ -428,13 +573,14 @@ export const listFromRemote = async (
 
   const NEXT_LINK_KEY = "@odata.nextLink";
   const DELTA_LINK_KEY = "@odata.deltaLink";
-  let res = await client.client
+
-    .api(`/drive/special/approot:/${client.vaultName}:/delta`)
+  let res = await client.getJson(
-    .get();
+    `/drive/special/approot:/${client.vaultName}:/delta`
-  const driveItems = res.value as DriveItem[];
+  );
+  let driveItems = res.value as DriveItem[];
 
   while (NEXT_LINK_KEY in res) {
-    res = await client.client.api(res[NEXT_LINK_KEY]).get();
+    res = await client.getJson(res[NEXT_LINK_KEY]);
     driveItems.push(...cloneDeep(res.value as DriveItem[]));
   }
 
@@ -448,6 +594,7 @@ export const listFromRemote = async (
   const unifiedContents = driveItems
     .map((x) => fromDriveItemToRemoteItem(x, client.vaultName))
     .filter((x) => x.key !== "/");
+
   return {
     Contents: unifiedContents,
   };
@@ -459,15 +606,14 @@ export const getRemoteMeta = async (
 ) => {
   await client.init();
   const remotePath = getOnedrivePath(fileOrFolderPath, client.vaultName);
-  // console.log(`remotePath=${remotePath}`);
+  // log.info(`remotePath=${remotePath}`);
-  const rsp = await client.client
+  const rsp = await client.getJson(
-    .api(remotePath)
+    `${remotePath}?$select=cTag,eTag,fileSystemInfo,folder,file,name,parentReference,size`
-    .select("cTag,eTag,fileSystemInfo,folder,file,name,parentReference,size")
+  );
-    .get();
+  // log.info(rsp);
-  // console.log(rsp);
   const driveItem = rsp as DriveItem;
   const res = fromDriveItemToRemoteItem(driveItem, client.vaultName);
-  // console.log(res);
+  // log.info(res);
   return res;
 };
 
@@ -487,7 +633,7 @@ export const uploadToRemote = async (
     uploadFile = remoteEncryptedKey;
   }
   uploadFile = getOnedrivePath(uploadFile, client.vaultName);
-  // console.log(`uploadFile=${uploadFile}`);
+  log.debug(`uploadFile=${uploadFile}`);
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
@@ -502,7 +648,7 @@ export const uploadToRemote = async (
       } else {
         // https://stackoverflow.com/questions/56479865/creating-nested-folders-in-one-go-onedrive-api
         // use PATCH to create folder recursively!!!
-        await client.client.api(uploadFile).patch({
+        await client.patchJson(uploadFile, {
           folder: {},
           "@microsoft.graph.conflictBehavior": "replace",
         });
@@ -522,40 +668,14 @@ export const uploadToRemote = async (
         password
       );
 
-      const uploadSession: LargeFileUploadSession =
+      // an encrypted folder is always small, we just use put here
-        await LargeFileUploadTask.createUploadSession(
+      await client.putArrayBuffer(
-          client.client,
+        `${uploadFile}:/content?${new URLSearchParams({
-          `https://graph.microsoft.com/v1.0/me${encodeURIComponent(
+          "@microsoft.graph.conflictBehavior": "replace",
-            uploadFile
+        })}`,
-          )}:/createUploadSession`,
+        arrBufRandom
-          {
-            item: {
-              "@microsoft.graph.conflictBehavior": "replace",
-            },
-          }
-        );
-      const task = new LargeFileUploadTask(
-        client.client,
-        new FileUpload(
-          arrBufRandom,
-          path.posix.basename(uploadFile),
-          arrBufRandom.byteLength
-        ),
-        uploadSession,
-        {
-          rangeSize: 1024 * 1024,
-          uploadEventHandlers: {
-            progress: (range?: Range) => {
-              // Handle progress event
-              // console.log(
-              //   `uploading ${range.minValue}-${range.maxValue} of ${fileOrFolderPath}`
-              // );
-            },
-          } as UploadEventHandlers,
-        } as LargeFileUploadTaskOptions
       );
-      const uploadResult: UploadResult = await task.upload();
+      // log.info(uploadResult)
-      // console.log(uploadResult)
       const res = await getRemoteMeta(client, uploadFile);
       return res;
     }
@@ -570,48 +690,42 @@ export const uploadToRemote = async (
 
     // no need to create parent folders firstly, cool!
 
-    // we need to customize the special root folder,
+    // upload large files!
-    // so use LargeFileUploadTask instead of OneDriveLargeFileUploadTask
+    // ref: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createuploadsession?view=odsp-graph-online
-    const progress = (range?: Range) => {
+
-      // Handle progress event
+    // 1. create uploadSession
-      // console.log(
-      //   `uploading ${range.minValue}-${range.maxValue} of ${fileOrFolderPath}`
-      // );
-    };
-    const uploadEventHandlers: UploadEventHandlers = {
-      progress: progress,
-    };
-    const options: LargeFileUploadTaskOptions = {
-      rangeSize: 1024 * 1024,
-      uploadEventHandlers: uploadEventHandlers,
-    };
-    const payload = {
-      item: {
-        "@microsoft.graph.conflictBehavior": "replace",
-      },
-    };
     // uploadFile already starts with /drive/special/approot:/${vaultName}
-    const uploadSession: LargeFileUploadSession =
+    const s: UploadSession = await client.postJson(
-      await LargeFileUploadTask.createUploadSession(
+      `${uploadFile}:/createUploadSession`,
-        client.client,
+      {
-        `https://graph.microsoft.com/v1.0/me${encodeURIComponent(
+        item: {
-          uploadFile
+          "@microsoft.graph.conflictBehavior": "replace",
-        )}:/createUploadSession`,
+        },
-        payload
+      }
+    );
+    const uploadUrl = s.uploadUrl;
+    log.debug("uploadSession = ");
+    log.debug(s);
+
+    // 2. upload by ranges
+    // convert to uint8
+    const uint8 = new Uint8Array(remoteContent);
+    // hard code range size
+    const MIN_UNIT = 327680; // bytes in msft doc, about 0.32768 MB
+    const RANGE_SIZE = MIN_UNIT * 20; // about 6.5536 MB
+    // upload the ranges one by one
+    let rangeStart = 0;
+    while (rangeStart < uint8.byteLength) {
+      await client.putUint8ArrayByRange(
+        uploadUrl,
+        uint8,
+        rangeStart,
+        Math.min(rangeStart + RANGE_SIZE, uint8.byteLength),
+        uint8.byteLength
       );
-    const fileObject = new FileUpload(
+      rangeStart += RANGE_SIZE;
-      remoteContent,
+    }
-      path.posix.basename(uploadFile),
+
-      remoteContent.byteLength
-    );
-    const task = new LargeFileUploadTask(
-      client.client,
-      fileObject,
-      uploadSession,
-      options
-    );
-    const uploadResult: UploadResult = await task.upload();
-    // console.log(uploadResult)
     const res = await getRemoteMeta(client, uploadFile);
     return res;
   }
@@ -623,10 +737,9 @@ const downloadFromRemoteRaw = async (
 ): Promise<ArrayBuffer> => {
   await client.init();
   const key = getOnedrivePath(fileOrFolderPath, client.vaultName);
-  const rsp = await client.client
+  const rsp = await client.getJson(
-    .api(key)
+    `${key}?$select=@microsoft.graph.downloadUrl`
-    .select("@microsoft.graph.downloadUrl")
+  );
-    .get();
   const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
   const content = await (await fetch(downloadUrl)).arrayBuffer();
   return content;
@@ -682,7 +795,7 @@ export const deleteFromRemote = async (
   remoteFileName = getOnedrivePath(remoteFileName, client.vaultName);
 
   await client.init();
-  await client.client.api(remoteFileName).delete();
+  await client.deleteJson(remoteFileName);
 };
 
 export const checkConnectivity = async (client: WrappedOnedriveClient) => {
@@ -696,7 +809,7 @@ export const checkConnectivity = async (client: WrappedOnedriveClient) => {
 
 export const getUserDisplayName = async (client: WrappedOnedriveClient) => {
   await client.init();
-  const res: User = await client.client.api("/me").select("displayName").get();
+  const res: User = await client.getJson("/me?$select=displayName");
   return res.displayName || "<unknown display name>";
 };
 
@@ -709,7 +822,7 @@ export const getUserDisplayName = async (client: WrappedOnedriveClient) => {
  */
 // export const revokeAuth = async (client: WrappedOnedriveClient) => {
 //   await client.init();
-//   await client.client.api('/me/revokeSignInSessions').post(undefined);
+//   await client.postJson('/me/revokeSignInSessions', {});
 // };
 
 export const getRevokeAddr = async () => {

src/remoteForS3.ts

@@ -25,6 +25,9 @@ import {
 
 export { S3Client } from "@aws-sdk/client-s3";
 
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
 export const DEFAULT_S3_CONFIG = {
   s3Endpoint: "",
   s3Region: "",
@@ -150,7 +153,7 @@ export const uploadToRemote = async (
       },
     });
     upload.on("httpUploadProgress", (progress) => {
-      // console.log(progress);
+      // log.info(progress);
     });
     await upload.done();
 

src/remoteForWebdav.ts

@@ -2,16 +2,23 @@ import { Buffer } from "buffer";
 import { Vault } from "obsidian";
 import type { FileStat, WebDAVClient } from "webdav/web";
 import { AuthType, BufferLike, createClient } from "webdav/web";
+import { Queue } from "@fyears/tsqueue";
+import chunk from "lodash/chunk";
+import flatten from "lodash/flatten";
 import type { RemoteItem, WebdavConfig } from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import { bufferToArrayBuffer, getPathFolder, mkdirpInVault } from "./misc";
 export type { WebDAVClient } from "webdav/web";
 
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
 export const DEFAULT_WEBDAV_CONFIG = {
   address: "",
   username: "",
   password: "",
   authType: "basic",
+  manualRecursive: false,
 } as WebdavConfig;
 
 const getWebdavPath = (fileOrFolderPath: string, vaultName: string) => {
@@ -82,7 +89,7 @@ export class WrappedWebdavClient {
               : AuthType.Password,
         });
       } else {
-        console.log("no password");
+        log.info("no password");
         this.client = createClient(this.webdavConfig.address);
       }
     }
@@ -93,12 +100,12 @@ export class WrappedWebdavClient {
     } else {
       const res = await this.client.exists(`/${this.vaultName}`);
       if (res) {
-        // console.log("remote vault folder exits!");
+        // log.info("remote vault folder exits!");
         this.vaultFolderExists = true;
       } else {
-        console.log("remote vault folder not exists, creating");
+        log.info("remote vault folder not exists, creating");
         await this.client.createDirectory(`/${this.vaultName}`);
-        console.log("remote vault folder created!");
+        log.info("remote vault folder created!");
         this.vaultFolderExists = true;
       }
     }
@@ -118,7 +125,7 @@ export const getRemoteMeta = async (
 ) => {
   await client.init();
   const remotePath = getWebdavPath(fileOrFolderPath, client.vaultName);
-  // console.log(`remotePath = ${remotePath}`);
+  // log.info(`remotePath = ${remotePath}`);
   const res = (await client.client.stat(remotePath, {
     details: false,
   })) as FileStat;
@@ -158,7 +165,7 @@ export const uploadToRemote = async (
       await client.client.putFileContents(uploadFile, "", {
         overwrite: true,
         onUploadProgress: (progress) => {
-          // console.log(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
+          // log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
         },
       });
 
@@ -180,7 +187,7 @@ export const uploadToRemote = async (
     await client.client.putFileContents(uploadFile, remoteContent, {
       overwrite: true,
       onUploadProgress: (progress) => {
-        console.log(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
+        log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
       },
     });
 
@@ -196,14 +203,51 @@ export const listFromRemote = async (
     throw Error("prefix not supported");
   }
   await client.init();
-  const contents = (await client.client.getDirectoryContents(
+
-    `/${client.vaultName}`,
+  let contents = [] as FileStat[];
-    {
+  if (client.webdavConfig.manualRecursive) {
-      deep: true,
+    // the remote doesn't support infinity propfind,
-      details: false /* no need for verbose details here */,
+    // we need to do a bfs here
-      glob: "/**" /* avoid dot files by using glob */,
+    const q = new Queue([`/${client.vaultName}`]);
+    const CHUNK_SIZE = 10;
+    while (q.length > 0) {
+      const itemsToFetch = [];
+      while (q.length > 0) {
+        itemsToFetch.push(q.pop());
+      }
+      const itemsToFetchChunks = chunk(itemsToFetch, CHUNK_SIZE);
+      // log.debug(itemsToFetchChunks);
+      const subContents = [] as FileStat[];
+      for (const singleChunk of itemsToFetchChunks) {
+        const r = singleChunk.map((x) => {
+          return client.client.getDirectoryContents(x, {
+            deep: false,
+            details: false /* no need for verbose details here */,
+            glob: "/**" /* avoid dot files by using glob */,
+          }) as Promise<FileStat[]>;
+        });
+        const r2 = flatten(await Promise.all(r));
+        subContents.push(...r2);
+      }
+      for (let i = 0; i < subContents.length; ++i) {
+        const f = subContents[i];
+        contents.push(f);
+        if (f.type === "directory") {
+          q.push(f.filename);
+        }
+      }
     }
-  )) as FileStat[];
+  } else {
+    // the remote supports infinity propfind
+    contents = (await client.client.getDirectoryContents(
+      `/${client.vaultName}`,
+      {
+        deep: true,
+        details: false /* no need for verbose details here */,
+        glob: "/**" /* avoid dot files by using glob */,
+      }
+    )) as FileStat[];
+  }
   return {
     Contents: contents.map((x) =>
       fromWebdavItemToRemoteItem(x, client.vaultName)
@@ -282,10 +326,10 @@ export const deleteFromRemote = async (
   await client.init();
   try {
     await client.client.deleteFile(remoteFileName);
-    // console.log(`delete ${remoteFileName} succeeded`);
+    // log.info(`delete ${remoteFileName} succeeded`);
   } catch (err) {
     console.error("some error while deleting");
-    console.log(err);
+    log.info(err);
   }
 };
 

src/settings.ts

@@ -1,6 +1,6 @@
 import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
 import type { SUPPORTED_SERVICES_TYPE, WebdavAuthType } from "./baseTypes";
-import { exportSyncPlansToFiles } from "./debugMode";
+import { exportVaultSyncPlansToFiles } from "./debugMode";
 import { exportQrCodeUri } from "./importExport";
 import {
   clearAllSyncMetaMapping,
@@ -19,6 +19,10 @@ import {
   DEFAULT_ONEDRIVE_CONFIG,
   getAuthUrlAndVerifier as getAuthUrlAndVerifierOnedrive,
 } from "./remoteForOnedrive";
+import { messyConfigToNormal } from "./configPersist";
+
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
 
 class PasswordModal extends Modal {
   plugin: RemotelySavePlugin;
@@ -117,6 +121,21 @@ class DropboxAuthModal extends Modal {
     contentEl.createEl("p", {
       text: "Finally you should be redirected to Obsidian.",
     });
+
+    const div2 = contentEl.createDiv();
+    div2.createEl(
+      "button",
+      {
+        text: "Click to copy the auth url",
+      },
+      (el) => {
+        el.onclick = async () => {
+          await navigator.clipboard.writeText(authUrl);
+          new Notice("the auth url copied to clipboard!");
+        };
+      }
+    );
+
     contentEl.createEl("p").createEl("a", {
       href: authUrl,
       text: authUrl,
@@ -157,12 +176,31 @@ export class OnedriveAuthModal extends Modal {
     );
     this.plugin.oauth2Info.verifier = verifier;
 
+    contentEl.createEl("p", {
+      text: "Currently only OneDrive for personal is supported. OneDrive for Business is NOT supported (yet).",
+    });
+
     contentEl.createEl("p", {
       text: "Visit the address in a browser, and follow the steps.",
     });
     contentEl.createEl("p", {
       text: "Finally you should be redirected to Obsidian.",
     });
+
+    const div2 = contentEl.createDiv();
+    div2.createEl(
+      "button",
+      {
+        text: "Click to copy the auth url",
+      },
+      (el) => {
+        el.onclick = async () => {
+          await navigator.clipboard.writeText(authUrl);
+          new Notice("the auth url copied to clipboard!");
+        };
+      }
+    );
+
     contentEl.createEl("p").createEl("a", {
       href: authUrl,
       text: authUrl,
@@ -344,6 +382,46 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         });
       });
 
+    const scheduleDiv = generalDiv.createEl("div");
+    new Setting(scheduleDiv)
+      .setName("schedule for auto run")
+      .setDesc(
+        "The plugin trys to schedule the running after every interval. Battery may be impacted."
+      )
+      .addDropdown((dropdown) => {
+        dropdown.addOption("-1", "(no auto run)");
+        dropdown.addOption(`${1000 * 60 * 1}`, "every 1 minute");
+        dropdown.addOption(`${1000 * 60 * 5}`, "every 5 minutes");
+        dropdown.addOption(`${1000 * 60 * 10}`, "every 10 minutes");
+        dropdown.addOption(`${1000 * 60 * 30}`, "every 30 minutes");
+
+        dropdown
+          .setValue(`${this.plugin.settings.autoRunEveryMilliseconds}`)
+          .onChange(async (val: string) => {
+            const realVal = parseInt(val);
+            this.plugin.settings.autoRunEveryMilliseconds = realVal;
+            await this.plugin.saveSettings();
+            if (
+              (realVal === undefined || realVal === null || realVal <= 0) &&
+              this.plugin.autoRunIntervalID !== undefined
+            ) {
+              // clear
+              window.clearInterval(this.plugin.autoRunIntervalID);
+              this.plugin.autoRunIntervalID = undefined;
+            } else if (
+              realVal !== undefined &&
+              realVal !== null &&
+              realVal > 0
+            ) {
+              const intervalID = window.setInterval(() => {
+                this.plugin.syncRun("auto");
+              }, realVal);
+              this.plugin.autoRunIntervalID = intervalID;
+              this.plugin.registerInterval(intervalID);
+            }
+          });
+      });
+
     //////////////////////////////////////////////////
     // below for general chooser (part 1/2)
     //////////////////////////////////////////////////
@@ -365,7 +443,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
     });
 
     s3Div.createEl("p", {
-      text: "Disclaimer: The information is stored in PLAIN TEXT locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your bucket, please immediately delete the access key on your AWS (or other S3-service provider) settings.",
+      text: "Disclaimer: The information is stored in locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your bucket, please immediately delete the access key on your AWS (or other S3-service provider) settings.",
       cls: "s3-disclaimer",
     });
 
@@ -491,7 +569,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       cls: "dropbox-disclaimer",
     });
     dropboxDiv.createEl("p", {
-      text: "Disclaimer: The information is stored in PLAIN TEXT locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Dropbox, please immediately disconnect this app on https://www.dropbox.com/account/connected_apps .",
+      text: "Disclaimer: The information is stored in locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Dropbox, please immediately disconnect this app on https://www.dropbox.com/account/connected_apps .",
       cls: "dropbox-disclaimer",
     });
     dropboxDiv.createEl("p", {
@@ -614,13 +692,13 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       "onedrive-hide",
       this.plugin.settings.serviceType !== "onedrive"
     );
-    onedriveDiv.createEl("h2", { text: "Remote For Onedrive" });
+    onedriveDiv.createEl("h2", { text: "Remote For Onedrive (for personal)" });
     onedriveDiv.createEl("p", {
       text: "Disclaimer: This app is NOT an official Microsoft / Onedrive product.",
       cls: "onedrive-disclaimer",
     });
     onedriveDiv.createEl("p", {
-      text: "Disclaimer: The information is stored in PLAIN TEXT locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Onedrive, please immediately disconnect this app on https://microsoft.com/consent .",
+      text: "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Onedrive, please immediately disconnect this app on https://microsoft.com/consent .",
       cls: "onedrive-disclaimer",
     });
     onedriveDiv.createEl("p", {
@@ -629,6 +707,10 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       }/${this.app.vault.getName()} on your Onedrive.`,
     });
 
+    onedriveDiv.createEl("p", {
+      text: "Currently only OneDrive for personal is supported. OneDrive for Business is NOT supported (yet).",
+    });
+
     const onedriveSelectAuthDiv = onedriveDiv.createDiv();
     const onedriveAuthDiv = onedriveSelectAuthDiv.createDiv({
       cls: "onedrive-auth-button-hide",
@@ -724,7 +806,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
     webdavDiv.createEl("h2", { text: "Remote For Webdav" });
 
     webdavDiv.createEl("p", {
-      text: "Disclaimer: The information is stored in PLAIN TEXT 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.",
+      text: "Disclaimer: The information is stored in 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.",
       cls: "webdav-disclaimer",
     });
 
@@ -790,6 +872,32 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
           });
       });
 
+    new Setting(webdavDiv)
+      .setName("server supports infinity propfind or not")
+      .setDesc(
+        "The plugin needs to get all files and folders recursively using probfind. If your webdav server only supports depth='1' (such as NGINX), you need to adjust the setting here, then the plugin consumes more network requests, but better than not working."
+      )
+      .addDropdown((dropdown) => {
+        dropdown.addOption("infinity", "supports depth='infinity'");
+        dropdown.addOption("1", "only supports depth='1'");
+
+        type Depth = "1" | "infinity";
+        dropdown
+          .setValue(
+            this.plugin.settings.webdav.manualRecursive === false
+              ? "infinity"
+              : "1"
+          )
+          .onChange(async (val: Depth) => {
+            if (val === "1") {
+              this.plugin.settings.webdav.manualRecursive = true;
+            } else if (val === "infinity") {
+              this.plugin.settings.webdav.manualRecursive = false;
+            }
+            await this.plugin.saveSettings();
+          });
+      });
+
     new Setting(webdavDiv)
       .setName("check connectivity")
       .setDesc("check connectivity")
@@ -829,7 +937,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         dropdown.addOption("s3", "S3 or compatible");
         dropdown.addOption("dropbox", "Dropbox");
         dropdown.addOption("webdav", "Webdav (beta)");
-        dropdown.addOption("onedrive", "OneDrive (alpha)");
+        dropdown.addOption("onedrive", "OneDrive for personal (alpha)");
         dropdown
           .setValue(this.plugin.settings.serviceType)
           .onChange(async (val: SUPPORTED_SERVICES_TYPE) => {
@@ -886,6 +994,43 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
 
     const debugDiv = containerEl.createEl("div");
     debugDiv.createEl("h2", { text: "Debug" });
+
+    const setConsoleLogLevelDiv = debugDiv.createDiv("div");
+    new Setting(setConsoleLogLevelDiv)
+      .setName("alter console log level")
+      .setDesc(
+        'By default the log level is "info". You can change to "debug" to get verbose infomation in console.'
+      )
+      .addDropdown(async (dropdown) => {
+        dropdown.addOption("info", "info");
+        dropdown.addOption("debug", "debug");
+        dropdown
+          .setValue(this.plugin.settings.currLogLevel)
+          .onChange(async (val: string) => {
+            this.plugin.settings.currLogLevel = val;
+            log.setLevel(val as any);
+            await this.plugin.saveSettings();
+            log.info(`the log level is changed to ${val}`);
+          });
+      });
+    const outputCurrSettingsDiv = debugDiv.createDiv("div");
+    new Setting(outputCurrSettingsDiv)
+      .setName("output current settings from disk to console")
+      .setDesc(
+        "The settings save on disk in encoded. Click this to see the decoded settings in console."
+      )
+      .addButton(async (button) => {
+        button.setButtonText("Output");
+        button.onClick(async () => {
+          const c = messyConfigToNormal(await this.plugin.loadData());
+          if (c.currLogLevel === "debug") {
+            // no need to ouput it again because debug mode already output it
+          } else {
+            log.info(c);
+          }
+          new Notice("Finished outputing in console.");
+        });
+      });
     const syncPlanDiv = debugDiv.createEl("div");
     new Setting(syncPlanDiv)
       .setName("export sync plans")
@@ -895,7 +1040,11 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       .addButton(async (button) => {
         button.setButtonText("Export");
         button.onClick(async () => {
-          await exportSyncPlansToFiles(this.plugin.db, this.app.vault);
+          await exportVaultSyncPlansToFiles(
+            this.plugin.db,
+            this.app.vault,
+            this.plugin.settings.vaultRandomID
+          );
           new Notice("sync plans history exported");
         });
       });

src/sync.ts

@@ -9,13 +9,16 @@ import {
 } from "./encrypt";
 import type { FileFolderHistoryRecord, InternalDBs } from "./localdb";
 import {
-  clearDeleteRenameHistoryOfKey,
+  clearDeleteRenameHistoryOfKeyAndVault,
-  getSyncMetaMappingByRemoteKey,
+  getSyncMetaMappingByRemoteKeyAndVault,
-  upsertSyncMetaMappingData,
+  upsertSyncMetaMappingDataByVault,
 } from "./localdb";
 import { isHiddenPath, isVaildText, mkdirpInVault } from "./misc";
 import { RemoteClient } from "./remote";
 
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
 export type SyncStatusType =
   | "idle"
   | "preparing"
@@ -167,6 +170,7 @@ const ensembleMixedStates = async (
   local: TAbstractFile[],
   deleteHistory: FileFolderHistoryRecord[],
   db: InternalDBs,
+  vaultRandomID: string,
   remoteType: SUPPORTED_SERVICES_TYPE,
   password: string = ""
 ) => {
@@ -187,12 +191,13 @@ const ensembleMixedStates = async (
           throw Error(`unexpected key=${remoteEncryptedKey}`);
         }
       }
-      const backwardMapping = await getSyncMetaMappingByRemoteKey(
+      const backwardMapping = await getSyncMetaMappingByRemoteKeyAndVault(
         remoteType,
         db,
         key,
         entry.lastModified,
-        entry.etag
+        entry.etag,
+        vaultRandomID
       );
 
       let r = {} as FileOrFolderMixedState;
@@ -440,6 +445,7 @@ export const getSyncPlan = async (
   local: TAbstractFile[],
   deleteHistory: FileFolderHistoryRecord[],
   db: InternalDBs,
+  vaultRandomID: string,
   remoteType: SUPPORTED_SERVICES_TYPE,
   password: string = ""
 ) => {
@@ -448,6 +454,7 @@ export const getSyncPlan = async (
     local,
     deleteHistory,
     db,
+    vaultRandomID,
     remoteType,
     password
   );
@@ -464,6 +471,7 @@ export const getSyncPlan = async (
 
 const dispatchOperationToActual = async (
   key: string,
+  vaultRandomID: string,
   state: FileOrFolderMixedState,
   client: RemoteClient,
   db: InternalDBs,
@@ -490,6 +498,18 @@ const dispatchOperationToActual = async (
     throw Error(`unknown decision in ${JSON.stringify(state)}`);
   } else if (state.decision === "skip") {
     // do nothing
+  } else if (
+    client.serviceType === "onedrive" &&
+    state.size_local === 0 &&
+    !state.key.endsWith("/") &&
+    password === "" &&
+    (state.decision === "upload" || state.decision === "upload_clearhist")
+  ) {
+    // TODO: it's ugly, any other way to deal with empty file for onedrive?
+    // do nothing, skip empty file without encryption
+    // if it's empty folder, or it's encrypted file/folder, it continues to be uploaded.
+    // this branch should be earlier than normal upload / upload_clearhist branches.
+    log.debug(`skip empty file ${state.key} uploading for OneDrive`);
   } else if (state.decision === "download_clearhist") {
     await client.downloadFromRemote(
       state.key,
@@ -498,7 +518,7 @@ const dispatchOperationToActual = async (
       password,
       remoteEncryptedKey
     );
-    await clearDeleteRenameHistoryOfKey(db, state.key);
+    await clearDeleteRenameHistoryOfKeyAndVault(db, state.key, vaultRandomID);
   } else if (state.decision === "upload_clearhist") {
     const remoteObjMeta = await client.uploadToRemote(
       state.key,
@@ -508,7 +528,7 @@ const dispatchOperationToActual = async (
       remoteEncryptedKey,
       foldersCreatedBefore
     );
-    await upsertSyncMetaMappingData(
+    await upsertSyncMetaMappingDataByVault(
       client.serviceType,
       db,
       state.key,
@@ -517,9 +537,10 @@ const dispatchOperationToActual = async (
       state.key,
       remoteObjMeta.lastModified,
       remoteObjMeta.size,
-      remoteObjMeta.etag
+      remoteObjMeta.etag,
+      vaultRandomID
     );
-    await clearDeleteRenameHistoryOfKey(db, state.key);
+    await clearDeleteRenameHistoryOfKeyAndVault(db, state.key, vaultRandomID);
   } else if (state.decision === "download") {
     await mkdirpInVault(state.key, vault);
     await client.downloadFromRemote(
@@ -531,7 +552,7 @@ const dispatchOperationToActual = async (
     );
   } else if (state.decision === "delremote_clearhist") {
     await client.deleteFromRemote(state.key, password, remoteEncryptedKey);
-    await clearDeleteRenameHistoryOfKey(db, state.key);
+    await clearDeleteRenameHistoryOfKeyAndVault(db, state.key, vaultRandomID);
   } else if (state.decision === "upload") {
     const remoteObjMeta = await client.uploadToRemote(
       state.key,
@@ -541,7 +562,7 @@ const dispatchOperationToActual = async (
       remoteEncryptedKey,
       foldersCreatedBefore
     );
-    await upsertSyncMetaMappingData(
+    await upsertSyncMetaMappingDataByVault(
       client.serviceType,
       db,
       state.key,
@@ -550,10 +571,11 @@ const dispatchOperationToActual = async (
       state.key,
       remoteObjMeta.lastModified,
       remoteObjMeta.size,
-      remoteObjMeta.etag
+      remoteObjMeta.etag,
+      vaultRandomID
     );
   } else if (state.decision === "clearhist") {
-    await clearDeleteRenameHistoryOfKey(db, state.key);
+    await clearDeleteRenameHistoryOfKeyAndVault(db, state.key, vaultRandomID);
   } else {
     throw Error("this should never happen!");
   }
@@ -562,27 +584,37 @@ const dispatchOperationToActual = async (
 export const doActualSync = async (
   client: RemoteClient,
   db: InternalDBs,
+  vaultRandomID: string,
   vault: Vault,
   syncPlan: SyncPlanType,
-  password: string = ""
+  password: string = "",
+  callbackSyncProcess?: any
 ) => {
   const keyStates = syncPlan.mixedStates;
   const foldersCreatedBefore = new Set<string>();
+  let i = 0;
+  const totalCount = Object.keys(keyStates).length || 0;
   for (const [k, v] of Object.entries(keyStates).sort(
     ([k1, v1], [k2, v2]) => k2.length - k1.length
   )) {
+    i += 1;
     const k2 = k as string;
     const v2 = v as FileOrFolderMixedState;
+    log.debug(`start syncing "${k2}" with plan ${JSON.stringify(v2)}`);
+    if (callbackSyncProcess !== undefined) {
+      await callbackSyncProcess(i, totalCount, k2, v2.decision);
+    }
     await dispatchOperationToActual(
-      k as string,
+      k2,
-      v as FileOrFolderMixedState,
+      vaultRandomID,
+      v2,
       client,
       db,
       vault,
       password,
       foldersCreatedBefore
     );
-    // console.log(`finished ${k}, with ${setToString(foldersCreatedBefore)}`);
+    log.info(`finished ${k2}`);
   }
   // await Promise.all(
   //   Object.entries(keyStates)

tests/configPersist.test.ts

@@ -0,0 +1,35 @@
+import * as chai from "chai";
+import chaiAsPromised from "chai-as-promised";
+
+import { RemotelySavePluginSettings } from "../src/baseTypes";
+import { messyConfigToNormal, normalConfigToMessy } from "../src/configPersist";
+
+chai.use(chaiAsPromised);
+const expect = chai.expect;
+
+const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
+  s3: {
+    s3AccessKeyID: "acc",
+  } as any,
+  webdav: {
+    address: "addr",
+  } as any,
+  dropbox: {
+    username: "测试中文",
+  } as any,
+  onedrive: {
+    username: "test 🍎 emoji",
+  } as any,
+  password: "password",
+  serviceType: "s3",
+  currLogLevel: "info",
+};
+
+describe("Config Persist tests", () => {
+  it("should encrypt go back and forth conrrectly", async () => {
+    const k = DEFAULT_SETTINGS;
+    const k2 = normalConfigToMessy(k);
+    const k3 = messyConfigToNormal(k2);
+    expect(k3).to.deep.equal(k);
+  });
+});

versions.json

@@ -1,3 +1,3 @@
 {
-  "0.2.6": "0.12.15"
+  "0.2.14": "0.12.15"
 }