add funding url

* begin adding a sync on save option

* get the main sync on save working

* get settings sync on save working

---------

Co-authored-by: Sam Purkis <sam.purkis@zimmerbiomet.com>
Co-authored-by: fyears <1142836+fyears@users.noreply.github.com>

.editorconfig

@@ -23,6 +23,6 @@ indent_size = 4
 indent_style = tab
 
 # Indentation override for all JS under lib directory
-[*.{js,jsx,mjs,cjs,ts,tsx,json,py}]
+[*.{js,jsx,mjs,cjs,ts,tsx,json}]
 indent_style = space
 indent_size = 2

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,73 @@
+name: Bug Report
+description: Fire a bug report
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: What did you expect to happen?
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: What OS are you using?
+      multiple: true
+      options:
+        - Windows
+        - Linux
+        - macOS
+        - iOS (iPhone, iPad)
+        - Android
+    validations:
+      required: true
+  - type: dropdown
+    id: service
+    attributes:
+      label: What remote cloud services are you using?
+      multiple: true
+      options:
+        - S3
+        - OneDrive for personal
+        - Dropbox
+        - webdav
+        - others
+    validations:
+      required: true
+  - type: input
+    id: version-plugin
+    attributes:
+      label: Version of the plugin
+      description: What version of the plugin are you running?
+    validations:
+      required: false
+  - type: input
+    id: version-obsidian
+    attributes:
+      label: Version of Obsidian
+      description: What version of Obsidian are you running?
+    validations:
+      required: false
+  - type: checkboxes
+    id: using-password
+    attributes:
+      label: Using password or not
+      description: Are you using password (end-to-end encryption) or not?
+      options:
+        - label: Yes.
+          required: false
+  - type: checkboxes
+    id: ensure-no-sensitive-information
+    attributes:
+      label: Ensure no sensitive information
+      description: By submitting this issue, you ensure that no sensitive information is submitted in the issue.
+      options:
+        - label: I ensure that no sensitive information is submitted in the issue.
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,37 @@
+name: Feature Request
+description: Some idea about new features
+title: "[Feature Request]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-are-you-expecting
+    attributes:
+      label: What feature are you suggesting?
+      description: What feature are you suggesting?
+    validations:
+      required: true
+  - type: dropdown
+    id: service
+    attributes:
+      label: What remote cloud services are you using, or suggesting adding the feature to?
+      multiple: true
+      options:
+        - S3
+        - OneDrive for personal
+        - Dropbox
+        - webdav
+        - others
+    validations:
+      required: false
+  - type: checkboxes
+    id: ensure-no-sensitive-information
+    attributes:
+      label: Ensure no sensitive information
+      description: By submitting this issue, you ensure that no sensitive information is submitted in the issue.
+      options:
+        - label: I ensure that no sensitive information is submitted in the issue.
+          required: true

.github/workflows/auto-build.yml

@@ -5,7 +5,7 @@ name: BuildCI
 
 on:
   push:
-    branches: [master]
+    branches: ["**"]
   pull_request:
     branches: [master]
 
@@ -30,6 +30,7 @@ jobs:
         uses: actions/checkout@v2
         with:
           lfs: true
+          submodules: recursive
       - name: Checkout LFS
         run: git lfs checkout
       - name: Use Node.js ${{ matrix.node-version }}

.github/workflows/release.yml

@@ -0,0 +1,86 @@
+# modified from https://github.com/argenos/nldates-obsidian/blob/master/.github/workflows/release.yml
+# which is released under MIT License
+
+# trigger:
+# modify manifest.json, package.json, versions.json
+# git tag <version number>
+# git push origin --tags
+
+name: Release A New Version
+
+on:
+  push:
+    tags:
+      - "*" # Push events to matching any tag format, i.e. 1.0, 20.15.10
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    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]
+
+    steps:
+      - name: Checkout codes
+        uses: actions/checkout@v2
+        with:
+          lfs: true
+          submodules: recursive
+      - name: Checkout LFS
+        run: git lfs checkout
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test
+      - run: npm run build
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION: ${{ github.ref }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          draft: false
+          prerelease: true
+      - name: Upload main.js
+        id: upload-main
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./main.js
+          asset_name: main.js
+          asset_content_type: text/javascript
+      - name: Upload manifest.json
+        id: upload-manifest
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./manifest.json
+          asset_name: manifest.json
+          asset_content_type: application/json
+      - name: Upload styles.css
+        id: upload-styles
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./styles.css
+          asset_name: styles.css
+          asset_content_type: text/css

.gitignore

@@ -5,6 +5,7 @@
 # npm
 node_modules
 package-lock.json
+pnpm-lock.yaml
 
 # build
 main.js

README.md

@@ -4,7 +4,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 
 [![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://img.shields.io/github/downloads-pre/remotely-save/remotely-save/latest/main.js?sort=semver)](https://github.com/fyears/remotely-save/releases)
 
 ## Disclaimer
 
@@ -12,7 +12,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 
 ## !!!Caution!!!
 
-As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any serious vaults.** **ALWAYS, ALWAYS, backup your vault before using this plugin.**
+**ALWAYS, ALWAYS, backup your vault before using this plugin.**
 
 ## Features
 
@@ -21,19 +21,24 @@ As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any
   - Dropbox
   - OneDrive for personal
   - Webdav
-- **Obsidiain Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
+  - [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details.
+- **Obsidian 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.** Manual sync is also supported, of course.
+- **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).**
+- \*\*Skip Large files and skip paths by custom regex conditions!
 - **Fully open source under [Apache-2.0 License](./LICENSE).**
-- **[Sync Algorithm open](./docs/sync_algorithm.md) for discussion.**
+- **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.**
 
 ## Limitations
 
-- **"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.
+- **To support deletions sync, extra metadata will also be uploaded.** See [Minimal Intrusive](./docs/minimal_intrusive_design.md).
 - **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.
-- **All files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
+- **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
+- **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
+- **You should protect your `data.json` file.** The file contains sensitive information.
+  - It's strongly advised **NOT** to share your `data.json` file to anyone.
+  - It's usually **NOT** a good idea to check the file into version control. By default, the plugin tries to create a `.gitignore` file inside the plugin directory if it doesn't exist, for ignoring `data.json` in the `git` version control. If you know exactly what it means and want to remove the setting, please modify the `.gitignore` file or set it to be empty.
 
 ## Questions, Suggestions, Or Bugs
 
@@ -47,7 +52,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 ## Download and Install
 
-- 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 #1: Search in the official "community plugin list", or visit this: [https://obsidian.md/plugins?id=remotely-save](https://obsidian.md/plugins?id=remotely-save) (which should redirect you into Obsidian app), 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.
@@ -56,25 +61,27 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 ### S3
 
+- Tutorials / Examples:
+  - [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/README.md)
+  - [MinIO](./docs/remote_services/s3_minio/README.md)
 - Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
-- Configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
+- If you are using AWS S3, create [policy and user](./docs/remote_services/s3_general/s3_user_policy.md).
+- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md).
 - 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 "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".
+- 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
 
-- **This plugin's function for Dropbox is not as mature as functions for S3.**
 - **This plugin is NOT an official Dropbox product.** The plugin just uses Dropbox's public API.
 - After the authorization, the plugin can read your name and email (which cannot be unselected on Dropbox api), and read and write files in your Dropbox's `/Apps/remotely-save` folder.
-- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions.
+- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions. [More with screenshot is here](./docs/dropbox_review_material/README.md).
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
 
 ### 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.
@@ -83,11 +90,11 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 ### webdav
 
-- **webdav support is considered experimental.**
-- Currently only supports BASIC authorization method.
-- Currently webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies.
-  - Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin.
-  - The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
+- Tutorials / Examples:
+  - [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
+  - [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
+  - [坚果云 JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
+- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md).
 - 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**.
 
@@ -97,6 +104,16 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 - 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.
 
+## How To Deal With Hidden Files Or Folders
+
+**By default, all files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
+
+In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder (but not any other `.` files or folders).
+
+## How To Debug
+
+See [here](./docs/how_to_debug/README.md) for more details.
+
 ## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
 
 See [here](./docs/import_export_some_settings.md) for more details.

debugServer.js

@@ -0,0 +1,25 @@
+// Importing the http module
+const http = require("http");
+
+const requestHandler = (req, res) => {
+  let body = [];
+  req
+    .on("data", (chunk) => {
+      body.push(chunk);
+    })
+    .on("end", () => {
+      const parsed = JSON.parse(Buffer.concat(body).toString());
+      const prettyParsed = JSON.stringify(parsed, null, 2);
+      console.log(prettyParsed);
+      res.setHeader("Content-Type", "application/json");
+      res.end(prettyParsed);
+    });
+};
+
+const server = http.createServer(requestHandler);
+
+const addr = "0.0.0.0";
+const port = 3000;
+server.listen(port, addr, undefined, () => {
+  console.log(`Server is Running on ${addr}:${port}`);
+});

docs/browser_env.md

@@ -0,0 +1,12 @@
+# Limitations From The Browser Environment
+
+Obsidian desktop is developed by using [Electron](https://www.electronjs.org/). And Obsidian mobile is developed by using [Capacitor](https://capacitorjs.com/)
+
+Technically, the plugin (or any plugin?) runs in the js environment provided by Obsidian. And to support the mobile Obsidian, the plugin is limited to be developed for the browser environment, instead of the Node.js environment.
+
+Then some limitations are applied:
+
+1. [The CORS issue (solved in the new Obsidian version on some platforms).](./browser_env_cors.md)
+2. [No Node.js environment.](./browser_env_no_nodejs.md)
+3. If the cloud service uses OAuth flow, it needs to support PKCE. More details are [here](./browser_env_oauth2_pkce.md).
+4. [No background running after Obsidian is closes.](./browser_env_no_background_after_closing.md)

docs/browser_env_cors.md

@@ -0,0 +1,14 @@
+# Limitations From The Browser Environment: CORS Issue
+
+The plugin is developed for the browser environment. The "fake" browser behind the scenes also follows the CORS policy.
+
+[MDN has a doc about CORS.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
+
+1. From Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
+
+2. For using this plugin in Obsidian desktop < 0.13.25 or mobile < 1.1.1, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`.
+
+   Example configurations:
+
+   - [Amazon S3](./s3_cors_configure.md)
+   - [Apache](./apache_cors_configure.md) ([contributed by community](https://github.com/remotely-save/remotely-save/pull/31))

docs/browser_env_no_background_after_closing.md

@@ -0,0 +1,3 @@
+# Limitations From The Browser Environment: No Background Running After Obsidian Is Closed
+
+The plugin treats Obsidian as a special browser, and is in fact some js codes. So if Obsidian is closed, then the browser environment stops, then the plugin will be stopped.

docs/browser_env_no_nodejs.md

@@ -0,0 +1,9 @@
+# Limitations From The Browser Environment: No Node.js
+
+To support the mobile Obsidian, the plugin is limited to be developed for the browser environment, instead of the Node.js environment.
+
+Many js libraries are designed to work in both the browser and the Node.js environments. But some are not, because the browser doesn't provide the corresponding abilities.
+
+For example, there is a popular npm package [`ssh2-sftp-client`](https://www.npmjs.com/package/ssh2-sftp-client) for SFTP. But it relies on the modules (e.g. `http`) from Node.js which cannot be "translated" to the browser environment. So it's impossible to make this plugin support SFTP. The same status applies to FTP / FTPS.
+
+Likewise, [MEGA](https://mega.nz/) provides a SDK, but the SDK is [for C++ only](https://mega.nz/doc), so it's also impossible to make this plugin support MEGA.

docs/browser_env_oauth2_pkce.md

@@ -0,0 +1,7 @@
+# Limitations From The Browser Environment: OAuth2 PKCE
+
+If the cloud service uses OAuth flow, it needs to support PKCE, because the plugin is released to the public, and no real secrets can be statically kept in the client.
+
+Luckily, Dropbox and OneDrive supports PKCE, making it possible for this plugin to connect to them easily.
+
+Dropbox has an excellent [article](https://dropbox.tech/developers/pkce--what-and-why-) explaining what is and how to use PKCE.

docs/dropbox_review_material/README.md

@@ -0,0 +1,47 @@
+## Material Source
+
+To apply for the production use of Dropbox API, some descriptions are needed to be submitted to Dropbox. Coincidently, this can also be served as a "readme" to use this plugin with Dropbox.
+
+## Some Backgrounds
+
+1. Obsidian allows users to take notes using markdown files.
+2. The "app", remotely-save. is an unofficial Obsidian plugin, helping users download and upload ("sync") their notes from and to Dropbox.
+3. Technically, remotely-save is developed using web technologies.
+
+## Api Usages
+
+1. remotely-save uses "App folder", to avoid unnecessary accessing users' other files.
+2. remotely-save uses "account_info.read", to get the displayed username, so that users know which of their accounts has been logged in after OAuth steps.
+3. remotely-save uses "files.content.read", so that it can read the "last modified time", and the content of files on Dropbox. Under some conditions, the plugin would download the files. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp on Dropbox is larger, the plugin would download the "newer" file from Dropbox to local.
+4. remotely-save uses "files.content.write", so that it can upload or overwrite the content of files on Dropbox. Under some conditions, the plugin would do that. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp in the local device is larger, the plugin would upload the "newer" file from local to Dropbox, and overwrite that file on Dropbox.
+
+## Steps
+
+Here are the steps to see the functionality of remotely-save.
+
+Most steps have screenshots.
+
+1. Download the note-taking app Obsidian (Windows or Mac versions are both ok) from its official website: https://obsidian.md/ . It's free to download and use. Then install it.
+2. Open Obsidian, click the "Create" button under "Create new vault".
+3. Pick a vault name, "example-vault", and choose a location, then click "Create".
+   ![step03](./attachments/step03.png)
+4. Close any update new if prompted.
+5. Create a new note by clicking a button on the left. And write something on the note.
+   ![step05](./attachments/step05.png)
+6. Click "setting" (a gear icon) on the button left of the sidebar.
+   ![step06](./attachments/step06.png)
+7. In the settings panel, go to the "Community plugins" page, turn off the safe mode, and confirm to turn off the safe mode. Then click the "Browse" button for community plugins.
+   ![step07](./attachments/step07.png)
+8. Search "Remotely Save" and install on the result.
+   ![step08](./attachments/step08.png)
+9. After successful installing the plugin, go back to the "Community plugins" page, and enable the plugin.
+   ![step09](./attachments/step09.png)
+10. Go to newly added "Remotely Save" settings, select "Dropbox" in "Choose service", and click the "Auth" button.
+    ![step10](./attachments/step10.png)
+11. The standard auth flow address is shown, users should click the address, and finish the auth steps on the website. Finally, the Dropbox website should automatically redirect users back to the Obsidian app.
+    ![step11](./attachments/step11.png)
+12. The "Auth" button disappears. A new "Revoke Auth" appears.
+    ![step12](./attachments/step12.png)
+13. Go back to the main interface of Obsidian, a new "switch icon" should appear on the left sidebar. Click this, then the plugin would trigger the sync progress. It would compare meta info of local files and remote files (on Dropbox), and decide to download some files and/or upload some files.
+    ![step13](./attachments/step13.png)
+14. Create, edit, remove some notes, and repeat step 13, the files on Dropbox should also change to reflect the changes locally.

docs/dropbox_review_material/attachments/step03.png

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

docs/dropbox_review_material/attachments/step05.png

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

docs/dropbox_review_material/attachments/step06.png

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

docs/dropbox_review_material/attachments/step07.png

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

docs/dropbox_review_material/attachments/step08.png

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

docs/dropbox_review_material/attachments/step09.png

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

docs/dropbox_review_material/attachments/step10.png

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

docs/dropbox_review_material/attachments/step11.png

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

docs/dropbox_review_material/attachments/step12.png

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

docs/dropbox_review_material/attachments/step13.png

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

docs/how_to_debug/README.md

@@ -0,0 +1,19 @@
+# How To Debug
+
+Ideally, users do not need to debug anything. But if something bad happened, we have to dig into details.
+
+## Easy: Export Sync Plans
+
+See [here](./export_sync_plans.md).
+
+## Advanced: Check Console Output Directly
+
+...of desktop and Android.
+
+See [here](./check_console_output.md).
+
+## Advanced: Save Console Output Then Read Them Later
+
+This method works for desktop and mobile devices (iOS, Android).
+
+See [here](./save_console_output_and_export.md).

docs/how_to_debug/check_console_output.md

@@ -0,0 +1,23 @@
+# Check Console Output
+
+If you are using Obsidian on desktop or Android, you can check the Obsidian console.
+
+## Disable Auto Sync Firstly
+
+You should disable auto sync to avoid any unexpected running.
+
+## Set The Output Level To Debug
+
+Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
+
+## Check The Output
+
+- If you are on desktop
+
+  Press the keyboard shortcut "ctrl+shift+i" if you are on Windows or Linux, or press "cmd+shift+i" if you are on macOS. You should be able to see the console of Obsidian.
+
+- If you are using Android
+
+  You need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on your Android, then connect your Android to a computer using USB, then open the **desktop** Chrome browser and go to the special web page <chrome://inspect>. You shall be able to see the "inspect" link inside the special page, then click the link to open the console. After debugging, remember to turn off USB debugging.
+
+Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. You could understand what happened and what goes wrong more explictly by checking the output.

docs/how_to_debug/export_sync_plans.md

@@ -0,0 +1,95 @@
+# Export Sync Plans
+
+## What's this?
+
+Everytime the plugin starts a sync, it gathers all required information together, generates a "sync plan" of every operations to every files and folders, and assign the corresponding actual operations.
+
+Thus, if something goes wrong, we should check the sync plan firstly.
+
+## How To Export The Plans?
+
+Please read through the following instructions.
+
+### Disable Auto Sync Firstly
+
+You should disable auto sync to avoid any unexpected running.
+
+### Manual Sync If Not Yet
+
+You should at least sync once, so that at least one sync plan is generated and saved. If you have synced the vualt before, there should be some sync plans already saved.
+
+### Export To The File
+
+Go to the plugin settings, scroll down to the section "Debug" -> "export sync plans", and click the button "Export". \*\*It would generate a new folder `_debug_remotely_save/` in your vault, and generate a file `sync_plans_hist_exported_on_{a_timestamp},md.` inside that folder.
+
+## How To Read The Plans
+
+Open the genrated `sync_plans_hist_exported_on_{a_timestamp},md.`. You should see a json, or multiple jsons. Every json represents a sync plan.
+
+A sync plan looks like this:
+
+```json
+{
+  "ts": 1646960867560,
+  "remoteType": "onedrive",
+  "mixedStates": {
+    "abc.md": {
+      "key": "abc.md",
+      "existRemote": true,
+      "mtimeRemote": 1646566632000,
+      "sizeRemote": 56797,
+      "remoteEncryptedKey": "abc.md",
+      "changeMtimeUsingMapping": true,
+      "existLocal": true,
+      "mtimeLocal": 1646566632000,
+      "sizeLocal": 56797,
+      "decision": "skipUploading",
+      "decisionBranch": 1
+    },
+    "New folder/": {
+      "key": "New folder/",
+      "deltimeRemote": 1646925354372,
+      "existLocal": false,
+      "existRemote": false,
+      "decision": "keepRemoteDelHistFolder",
+      "decisionBranch": 9
+    }
+  }
+}
+```
+
+We usually care about the `mixedStates` property. As you may guess, every item in `mixedStates` represent a file or a folder.
+
+We should find out the file/folder we are interested in (or we believe something goes wrong), then checkout the following properties:
+
+```
+decision
+  What decision is made.
+
+decisionBranch
+  It's a mark of the actual logic in the sync code. Useful to debug.
+
+existRemote
+  Does the file/folder exist on the remote service?
+
+mtimeRemote
+  The "last modeified time" on the remote service.
+
+deltimeRemote
+  The "deletion time" on the remote record.
+
+existLocal
+  Does the file/folder exist locally?
+
+mtimeLocal
+  The max of "last modeified time" and "creation time" locally.
+
+deltimeLocal
+  The "deletion time" locally.
+```
+
+The `decision` SHOULD be determined by the modified times and deletion times, by the logic described in [the doc of sync alogorithm](../sync_algorithm_v2.md). In short, we collect four timestamps (`mtimeRemote`, `deltimeRemote`, `mtimeLocal`, `deltimeLocal`), and respect the max timestamp and its corresponding operation.
+
+## Common Issues
+
+Some users report that their "last modeified time"s or "creation time"s are not set correctly by the operating system. In this case, the plugin cannot do anything because it determines the sync plan by comparing the timestamps. It's suggested to check the settings of the operating system or check whether other programs are doing something to the files.

docs/how_to_debug/save_console_output_and_export.md

@@ -0,0 +1,25 @@
+# Save Console Output And Read Them Later
+
+## Disable Auto Sync Firstly
+
+You should disable auto sync to avoid any unexpected running.
+
+## Set The Output Level To Debug
+
+Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
+
+## Enable Saving The Output To DB
+
+Go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "disable" to "enable". **This setting has some performance cost, so do NOT always turn this on when not necessary!**
+
+## Run The Sync
+
+Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. The the console logs are also saved into DB now.
+
+## Export The Output And Read The Logs
+
+Go to the plugin settings, scroll down to the section "Debug" -> "Export Console Logs From DB", and click the button. A new file `log_hist_exported_on_....md` should be created inside the special folder `_debug_remotely_save/`. You could read it and hopefully find something useful.
+
+## Disable Saving The Output To DB
+
+After debugging, go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "enable" to "disable".

docs/minimal_intrusive_design.md

@@ -1,36 +1,21 @@
 # Minimal Intrusive Design
 
-The plugin tries to avoid saving additional meta data remotely.
+Before version 0.3.0, the plugin did not upload additional meta data to the remote.
+
+From and after version 0.3.0, the plugin just upload minimal extra necessary meta data to the remote.
 
 ## Benefits
 
-Then the plugin doesn't make any assumptions about information on the remote endpoint.
+Then the plugin doesn't make more-than-necessary assumptions about information on the remote endpoint.
 
 For example, it's possbile for a uses to manually upload a file to s3, and next time the plugin can download that file to the local device.
 
 And it's also possible to combine another "sync-to-s3" solution (like, another software) on desktops, and this plugin on mobile devices, together.
 
-## Flaws
+## Necessarity Of Uploading Extra Metadata
 
 The main issue comes from deletions (and renamings which is actually interpreted as "deletion-then-creation").
 
-Consider this:
+If we don't upload any extra info to the remote, there's usually no way for the second device to know what files / folders have been deleted on the first device.
 
-1. The user create and sync a file to the cloud on the 1st device.
-2. Then download this file to the 2nd device.
-3. And then delete this file on the 1st device.
-4. And sync on the 1st device. The file on the cloud is also deleted.
-5. And sync on the 2nd device. **The 2nd device would upload the file again to the cloud.**
-
-In step 4, the file is marked "deleted" on the 1st device, and the 1st device send the command "delete this file on the cloud" to the cloud sevice (e.g. s3). Then the file on the cloud is also deleted. So far so good.
-
-But, in step 5, because no meta data are saved on the cloud, the 2nd device doesn't know that the file are deleted. Instead, it thinks "the file was not synced to the cloud last time, so it's uploaded this time". So an unintentional upload occurs.
-
-Currently no way to fix this if no meta data are saved remotely. The only workarounds are:
-
-1. Delete the file on the 1st device, **before** syncing it to the cloud. Then the file never show up on the cloud or on the 2nd device.
-2. Or, manually delete the file on 2nd device **before** step 5 in above situation.
-
-## Future
-
-This design may be changed in the feature, considering the flaws described above.
+To overcome this issue, from and after version 0.3.0, the plugin uploads extra metadata files `_remotely-save-metadata-on-remote.{json,bin}` to users' configured cloud services. Those files contain some info about what has been deleted on the first device, so that the second device can read the list to apply the deletions to itself. Some other necessary meta info would also be written into the extra files.

docs/remote_services/s3_cloudflare_r2/README.md

@@ -0,0 +1,27 @@
+# Cloudflare R2
+
+## Links
+
+<https://www.cloudflare.com/developer-platform/r2/>
+
+## Steps
+
+1. **Be aware that it may cost you money.**
+2. Create a Cloudflare account and enable R2 feature. **Credit card info might be required by Cloudflare**, though Cloudflare provides generous free tier and zero egress fee.
+3. Create a bucket.
+   ![](./s3_cloudflare_r2_create_bucket.png)
+4. Create an Access Key with "Object Read & Write" permission, and add specify to your created bucket. During the creation, you will also get the auto-generated secret key, and the endpoint address.
+   ![](./s3_cloudflare_r2_create_api_token.png)
+5. In remotely-save setting page, input the address / bucket / access key / secret key. **Region being set to `us-east-1` is sufficient.** Enable "Bypass CORS", because usually that's what you want.
+
+   Click "check connectivity". (If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.)
+
+   ![](./s3_cloudflare_r2_rs_settings.png)
+
+6. Sync!
+
+## And Issue Related To "Check Connectivity"
+
+If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.
+
+Cloudflare doesn't allow `HeadBucket` for access keys with "Object Read & Write". So it may be possible that checking connectivity is not ok but actual syncing is ok. New version >= 0.3.29 of the plugin fix this problem by using `ListObjects` instead of `HeadBucket`.

docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_api_token.png

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

docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_bucket.png

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

docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_rs_settings.png

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

docs/remote_services/s3_general/s3_cors_configure.md

@@ -0,0 +1,33 @@
+# How To Configure S3 CORS Rules
+
+If you are using the latest version of this plugin AND Obsidian desktop >= 0.13.25, mobile >= 1.1.1, you do not need to configure it any more. If you are using Obsidian desktop < 0.13.25, moble < 1.1.1, you are required to configure the rules as following.
+
+Thanks to [@NAL100 in the Discussion](https://github.com/fyears/remotely-save/discussions/28).
+
+Please try this config:
+
+```json
+[
+  {
+    "AllowedHeaders": ["*"],
+    "AllowedMethods": ["GET", "PUT", "POST", "DELETE", "HEAD"],
+    "AllowedOrigins": [
+      "app://obsidian.md",
+      "capacitor://localhost",
+      "http://localhost"
+    ],
+    "ExposeHeaders": [
+      "Content-Length",
+      "Content-Type",
+      "Connection",
+      "Date",
+      "ETag",
+      "Server",
+      "x-amz-delete-marker",
+      "x-amz-id-2",
+      "x-amz-request-id",
+      "x-amz-version-id"
+    ]
+  }
+]
+```

docs/remote_services/s3_general/s3_user_policy.md

@@ -0,0 +1,83 @@
+# AWS S3 Bucket: How to configure user's policy
+
+## Attention
+
+Please read the doc carefully and adjust the optional fields accordingly. The doc is not fully tested and contributions are welcome.
+
+## AWS Official Docs
+
+- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html>
+- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html>
+- <https://docs.aws.amazon.com/AmazonS3/latest/API/API_Operations.html>
+
+## Prerequisites
+
+Using the principle of least privilege is crucial for security when allowing a third party system to access your AWS resources.
+
+**Prerequisites**: Ensure you have an AWS account and administrative access to manage IAM policies.
+
+## Step 1: Create a new IAM Policy
+
+1. Log in to your AWS Management Console.
+1. Navigate to the IAM Policies section.
+1. Create a new policy with the following configuration.
+
+**Note**: `my-bucket` is a placeholder. For example, if your bucket's name is `obsidian-data`, the resource line should read `arn:aws:s3:::obsidian-data`.
+
+```JSON
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "ObsidianBucket",
+            "Effect": "Allow",
+            "Action": [
+                "s3:HeadBucket"
+            ],
+            "Resource": "arn:aws:s3:::my-bucket"
+        },
+        {
+            "Sid": "ObsidianObjects",
+            "Effect": "Allow",
+            "Action": [
+                "s3:HeadObject",
+                "s3:PutObject",
+                "s3:CopyObject",
+                "s3:UploadPart",
+                "s3:UploadPartCopy",
+                "s3:ListMultipartUploads",
+                "s3:AbortMultipartUpload",
+                "s3:CompleteMultipartUpload",
+                "s3:ListObjects",
+                "s3:ListObjectsV2",
+                "s3:ListParts",
+                "s3:GetObject",
+                "s3:GetObjectAttributes",
+                "s3:DeleteObject",
+                "s3:DeleteObjects"
+            ],
+            "Resource": "arn:aws:s3:::my-bucket/*"
+        }
+    ]
+}
+```
+
+> The policy allows the Obsidian plugin to list, add, retrieve, and delete objects in the specified S3 bucket.
+
+## Step 2: Attach the Policy to Obsidian user
+
+1. Create a new user in the IAM console. (Never use your own root user, as it would have full access to your AWS account).
+1. When creating the user, select "Attach policy directly" and select the policy created.
+1. Edit the recent created user and go to "Security Credentials" tab to create your access key.
+1. Create an Access Key. If asked for a "use case", select "other"
+1. Use the credentials in the plugin settings. (NEVER share these credentials)
+
+> PS. The bucket doesn't need to have a policy, only the user.
+
+## Verifying the Policy
+
+After attaching the policy, test it by trying to access the S3 bucket through the Obsidian plugin. Ensure that all intended actions can be performed without errors.
+
+## Troubleshooting
+
+If you encounter permission errors, check the policy for typos in the bucket name or actions. Ensure the policy is attached to the correct user.

docs/remote_services/s3_minio/README.md

@@ -0,0 +1,27 @@
+# MinIO
+
+## Links
+
+<https://min.io/>
+
+## Steps
+
+1. Configure your minio instance and get an account.
+2. Create an Access Key (during the creation, you will also get the auto-generated secret key).
+   ![](./minio_access_key.png)
+3. Check or set the region.
+   ![](./minio_region.png)
+4. Create a bucket.
+   ![](./minio_create_bucket.png)
+5. In remotely-save setting page, input the address / bucket / access key / secret key. **Usually minio instances may need "S3 URL style"="Path Style".** Enable "Bypass CORS", because usually that's what you want.
+   ![](./minio_rs_settings.png)
+6. Sync!
+   ![](./minio_sync_success.png)
+
+## Ports In Address
+
+Just type in the full address with `http(s)://` and `:port` in remotely-save settings, for example `http://192.168.31.198:9000`.
+
+It's verified that everything is ok.
+
+![](./minio_custom_port.png)

docs/remote_services/s3_minio/minio_access_key.png

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

docs/remote_services/s3_minio/minio_create_bucket.png

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

docs/remote_services/s3_minio/minio_custom_port.png

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

docs/remote_services/s3_minio/minio_region.png

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

docs/remote_services/s3_minio/minio_rs_settings.png

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

docs/remote_services/s3_minio/minio_sync_success.png

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

docs/remote_services/webdav_alist/README.md

@@ -0,0 +1,22 @@
+# AList
+
+## 链接 Links
+
+- English official website: <https://alist.nn.ci/> and <https://alist.nn.ci/guide/webdav.html>
+- 中文官网：<https://alist.nn.ci/zh/> 和 <https://alist.nn.ci/zh/guide/webdav.html>
+
+## 步骤 Steps
+
+1. 安装和使用 AList。获取账号名和密码。在网页上登录。Install and run AList. Get the account and password. Login using the web page.
+2. 新建挂载，检查挂载路径。如图所示是 `/alisttest davpath`。Add new storage. Pay attention to the mount path. The screenshot shows the mount path as `/alisttest davpath`.
+   ![](./alist_mount_path.zh.png)
+   ![](./alist_mount_path.en.png)
+3. 从而构建 webdav 网址如下，**http(s)://域名** + **端口** + **`/dav`** + **挂载路径**，其中挂载路径中假如有空格，换成 `%20`：Construct the webdav address as: **http(s)://domain** + **port** + **`/dav`** + **mount path**, and the space inside the mount path should be replaced with `%20`:
+   ```
+   http[s]://domain:port/dav/[mountpath url encoded]
+   http://127.0.0.1:5244/dav/alisttest%20davpath
+   ```
+4. 在 remotely-save 设置，输入**带域名端口`/dav`和挂载路径的网址**、账号、密码。In remotely-save setting page, select webdav type, then input the **full address with mount path**/account/password.
+   ![](./alist_rs_settings.en.png)
+5. 在 remotely-save 设置，检查连接。In remotely-save setting page, click "Check Connectivity".
+6. 同步文件！Sync!

docs/remote_services/webdav_alist/alist_mount_path.en.png

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

docs/remote_services/webdav_alist/alist_mount_path.zh.png

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

docs/remote_services/webdav_alist/alist_rs_settings.en.png

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

docs/remote_services/webdav_general/webav_cors.md

@@ -0,0 +1,10 @@
+If you are using Obsidian desktop >= 0.13.25 or iOS >= 1.1.1, you can skip this CORS part.
+
+If you are using Obsidian desktop < 0.13.25 or iOS < 1.1.1 or any Android version:
+
+- The webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies unless under a upgraded Obsidian version.
+- Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin, or use a upgraded Obsidian version.
+  - **Unofficial** workaround: NextCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can install [WebAppPassword](https://apps.nextcloud.com/apps/webapppassword) app, and add `app://obsidian.md`, `capacitor://localhost`, `http://localhost` to `Allowed origins`
+  - **Unofficial** workaround: OwnCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can download `.tar.gz` of `WebAppPassword` above and manually install and configure it on their instances.
+- [Apache is also possible](./webdav_apache_cors.md).
+- The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.

docs/remote_services/webdav_general/webdav_apache_cors.md

@@ -0,0 +1,25 @@
+# How To Configure Apache CORS Rules for Webdav
+
+This method is [contributed by community](https://github.com/remotely-save/remotely-save/pull/31).
+
+You should evaluate the risk by yourself before trying this method.
+
+**You are strongly advised to backup your original Apache configuration files before making any changes.**
+
+```apacheconf
+<IfModule mod_headers.c>
+  # Obsidian webdav
+  SetEnvIf Origin "^app://obsidian.md$" IS_OBSIDIAN
+  SetEnvIf Origin "^capacitor://localhost$" IS_OBSIDIAN
+  SetEnvIf Origin "^http://localhost$" IS_OBSIDIAN
+  Header always set Access-Control-Allow-Origin "*" env=IS_OBSIDIAN
+  Header always set Access-Control-Allow-Methods "GET, HEAD, POST, PUT, OPTIONS, MOVE, DELETE, COPY, LOCK, UNLOCK, PROPFIND" env=IS_OBSIDIAN
+  Header always set Access-Control-Allow-Headers "Authorization, Depth, DNT, User-Agent, Keep-Alive, Content-Type, accept, origin, X-Requested-With" env=IS_OBSIDIAN
+  Header always set Access-Control-Expose-Headers "etag, dav" env=IS_OBSIDIAN
+
+  # Allow OPTION request without authentication and respond with status 200
+  RewriteCond %{ENV:IS_OBSIDIAN} 1
+  RewriteCond %{REQUEST_METHOD} OPTIONS
+  RewriteRule ^(.*)$ $1 [R=200,L]
+</IfModule>
+```

docs/remote_services/webdav_infinicloud_teracloud/README.md

@@ -0,0 +1,15 @@
+# InfiniCLOUD (formally TeraCLOUD) Webdav
+
+## Link
+
+<https://infini-cloud.net/en/>
+
+## Steps
+
+1. Register an acount.
+2. Go to <https://infini-cloud.net/en/modules/mypage/usage/>, in section "Apps Connection", enable "Turn on Apps Connection". Here you get the address and account and webdav password (different from your account password):
+   ![](./infinicloud_account.png)
+3. In remotely-save setting page, select webdav type, then input the address/account/**webdav password**(not your account password).
+   ![](./infinicloud_rs_setting.png)
+4. In remotely-save setting page, click "Check Connectivity".
+5. Sync!

docs/remote_services/webdav_infinicloud_teracloud/infinicloud_account.png

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

docs/remote_services/webdav_infinicloud_teracloud/infinicloud_rs_setting.png

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

docs/remote_services/webdav_jianguoyun/README.md

@@ -0,0 +1,22 @@
+# 坚果云 JianGuoYun/NutStore
+
+## 链接 Link
+
+<https://www.jianguoyun.com/>
+
+## 注意！！！Attentions!!!
+
+坚果云有限制 api 数量等设定。本插件会产生若干查询，如果文件较多很容易触发 api 上限，从而工作不正常。这不是插件 bug，也没有办法解决。
+
+JianGuoYun/NutStore has api limits. The plugin may generate many queries, and it's possible to reach the api limits if there are many files, then do not work properly. It's not a bug and there's no way to fix this situation.
+
+## 步骤 Steps
+
+1. **知悉坚果云有 api 限制，本插件可能因此工作不正常。Be aware that JianGuoYun/NutStore has api limits, and the plugin may not work properly because of this.**
+2. 注册账号，登录。Register an account.
+3. 去“个人信息”->“安全”，“添加应用”，从而获取了 webDAV 账号（应该是 email）和 WebDAV 密码（一串特殊的字符，不等于网站密码）。Go to "settings"->"Security", click "Add Application", then obtain the WebDAV account (email), and WebDAV password (a string different from web site password).
+   ![](./webdav_jianguoyun.cn.png)
+4. 在 remotely-save 设置，输入网址、账号、密码、**“发送到服务器的 Depth Header”设置为“只支持 depth='1'”**。Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
+   ![](./webdav_jianguoyun_rs_settting.cn.png)
+5. 在 remotely-save 设置，检查连接。In remotely-save setting page, click "Check Connectivity".
+6. 同步文件！Sync!

docs/remote_services/webdav_jianguoyun/webdav_jianguoyun.cn.png

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

docs/remote_services/webdav_jianguoyun/webdav_jianguoyun_rs_settting.cn.png

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

docs/remote_services/webdav_owncloud/README.md

@@ -0,0 +1,17 @@
+# ownCloud Webdav
+
+## Link
+
+<https://owncloud.com/>
+
+# Steps
+
+1. Create an account.
+2. Login.
+3. In the Settings position, enable the "Show hidden files" and find out the WebDAV address.
+   ![](./owncloud_address.png)
+4. Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
+   ![](./owncloud_rs_settings.png)
+5. In remotely-save setting page, click "Check Connectivity".
+6. Sync!
+   ![](./owncloud_files.png)

docs/remote_services/webdav_owncloud/owncloud_address.png

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

docs/remote_services/webdav_owncloud/owncloud_files.png

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

docs/remote_services/webdav_owncloud/owncloud_rs_settings.png

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

docs/services_connectable_or_not.md

@@ -0,0 +1,42 @@
+# services connectability
+
+Here is an overview of the connectability ("connectable" or "not connectable" or "in the plan" or "never") to some services by this plugin.
+
+The plugin works under the browser environment in Obsidian, so CORS is an issue. Obsidian starts to provide a rich API `requestUrl` for desktop version >= 0.13.25, mobile >= 1.1.1 to bypass the CORS issue. But if the users are still using an older version of Obsidian, they need to configure CORS on server.
+
+The list is for information purposes only.
+
+| Service                                                                               | Connectable | by S3 | by WebDAV | by other protocol                                                | can bypass CORS issue in latest Obsidian | need CORS config in old Obsidian                 |
+| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------ |
+| Amazon S3                                                                             | Yes         | Yes   |           |                                                                  | Yes                                      | [CORS config needed.](./s3_cors_configure.md)    |
+| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储                             | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |
+| Alibaba Cloud - Object Storage Service 阿里云对象存储                                 | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |
+| Backblaze B2 Cloud Storage                                                            | Yes         | Yes   |           |                                                                  | Yes                                      | Its CORS rules doesn't allow no-http(s) origins. |
+| [Wasabi](https://wasabi.com)                                                          | ?           | ?     |           |                                                                  |                                          |                                                  |
+| [filebase](https://filebase.com/)                                                     | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |
+| QingStor 青云                                                                         | ?           | ?     |           |                                                                  |                                          |                                                  |
+| [MinIO](https://min.io/)                                                              | ?           | ?     |           |                                                                  |                                          |                                                  |
+| [WsgiDAV](https://github.com/mar10/wsgidav)                                           | Yes         |       | Yes       |                                                                  | Yes                                      | CORS rules can be set.                           |
+| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes?        |       | Yes?      |                                                                  | Yes?                                     | ?                                                |
+| NextCloud                                                                             | Yes         |       | Yes       |                                                                  | Yes?                                     | No CORS config by default.                       |
+| OwnCloud                                                                              | Yes?        |       | Yes?      |                                                                  | Yes?                                     | No CORS config by default.                       |
+| Seafile                                                                               | Yes         |       | Yes       |                                                                  | Yes?                                     | No CORS config by default.                       |
+| `rclone serve webdav`                                                                 | Yes         |       | Yes       |                                                                  | Yes                                      | No CORS support.                                 |
+| [Nutstore 坚果云](https://www.jianguoyun.com/)                                        | Yes         |       | Yes       |                                                                  | Yes                                      | No CORS support.                                 |
+| [TeraCLOUD](https://teracloud.jp/en/)                                                 | Yes         |       | Yes       |                                                                  | Yes                                      | No CORS support.                                 |
+| Dropbox                                                                               | Yes         |       |           | Yes                                                              |                                          |                                                  |
+| OneDrive for personal                                                                 | Yes         |       |           | Yes                                                              |                                          |                                                  |
+| OneDrive for Business                                                                 | Yes         |       |           | ?                                                                |                                          |                                                  |
+| Google Drive                                                                          | In the plan |       |           | ?                                                                |                                          |                                                  |
+| [Box](https://www.box.com/)                                                           | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |
+| Google Cloud Storage                                                                  | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |
+| Microsoft Azure Blob Storage                                                          | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |
+| [OpenStack Storage (Swift)](https://github.com/openstack/swift)                       | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |
+| https://put.io/                                                                       | ?           |       |           | ?                                                                |                                          |                                                  |
+| Yandex Disk                                                                           | ?           |       |           | ?                                                                |                                          |                                                  |
+| FTP / FTPS                                                                            | Never       |       |           | Technically never possible to be implemented.                    |                                          |                                                  |
+| SFTP                                                                                  | Never       |       |           | Technically never possible to be implemented.                    |                                          |                                                  |
+| Jottacloud                                                                            | No          |       |           | No. It seems that no open api is available.                      |                                          |                                                  |
+| Mega                                                                                  | Never       |       |           | No. No js api is available.                                      |                                          |                                                  |
+| Git                                                                                   | Never       |       |           | No. Technically very hard, if not impossible, to be implemented. |                                          |                                                  |
+|                                                                                       |             |       |           |                                                                  |                                          |                                                  |

docs/sync_algorithm_v1.md

@@ -4,9 +4,9 @@
 
 We have three record sources:
 
-1. Local files
-2. Remote files
-3. Local "delete-or-rename" history.
+1. Local files. By scanning all files in the vault locally. Actually Obsidian provides an api directly returning this.
+2. Remote files. By scanning all files on the remote service. Some services provide an api directly returning this, and some other services require the plugin scanning the folders recursively.
+3. Local "delete-or-rename" history. It's recorded by using Obsidian's tracking api. So if users delete or rename files/folders outside Obsidian, we could do nothing.
 
 Assuming all sources are reliable.
 

docs/sync_algorithm_v2.md

@@ -0,0 +1,63 @@
+# Sync Algorithm V2
+
+## Sources
+
+We have 4 record sources:
+
+1. Local files. By scanning all files in the vault locally. Actually Obsidian provides an api directly returning this.
+2. Remote files. By scanning all files on the remote service. Some services provide an api directly returning this, and some other services require the plugin scanning the folders recursively.
+3. Local "delete-or-rename" history. It's recorded by using Obsidian's tracking api. So if users delete or rename files/folders outside Obsidian, we could do nothing.
+4. Remote "delete" history. It's uploaded by the plugin in each sync.
+
+Assuming all sources are reliable.
+
+## Deal with them
+
+We list all combinations mutually exclusive and collectively exhaustive.
+
+### Files
+
+In short, we collect four timestamps, and respect the max timestamp and its corresponding operation.
+
+| t1             | t2             | t3             | t4             | local file to do | remote file to do | local del history to do | remote del history to do | equal to sync v2 branch |
+| -------------- | -------------- | -------------- | -------------- | ---------------- | ----------------- | ----------------------- | ------------------------ | ----------------------- |
+| mtime_remote   | mtime_local    | deltime_remote | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history |                         |
+| mtime_local    | mtime_remote   | deltime_remote | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history |                         |
+| mtime_remote   | deltime_remote | mtime_local    | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history |                         |
+| deltime_remote | mtime_remote   | mtime_local    | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history |                         |
+| mtime_local    | deltime_remote | mtime_remote   | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history |                         |
+| deltime_remote | mtime_local    | mtime_remote   | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history | 8                       |
+| mtime_remote   | mtime_local    | deltime_local  | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
+| mtime_local    | mtime_remote   | deltime_local  | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
+| mtime_remote   | deltime_local  | mtime_local    | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
+| deltime_local  | mtime_remote   | mtime_local    | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
+| mtime_local    | deltime_local  | mtime_remote   | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
+| deltime_local  | mtime_local    | mtime_remote   | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
+| mtime_remote   | deltime_remote | deltime_local  | mtime_local    | skip             | upload_local      | clean                   | clean                    |                         |
+| deltime_remote | mtime_remote   | deltime_local  | mtime_local    | skip             | upload_local      | clean                   | clean                    | 10                      |
+| mtime_remote   | deltime_local  | deltime_remote | mtime_local    | skip             | upload_local      | clean                   | clean                    |                         |
+| deltime_local  | mtime_remote   | deltime_remote | mtime_local    | skip             | upload_local      | clean                   | clean                    |                         |
+| deltime_remote | deltime_local  | mtime_remote   | mtime_local    | skip             | upload_local      | clean                   | clean                    | 2;3;4;5;6               |
+| deltime_local  | deltime_remote | mtime_remote   | mtime_local    | skip             | upload_local      | clean                   | clean                    |                         |
+| mtime_local    | deltime_remote | deltime_local  | mtime_remote   | download_remote  | skip              | clean                   | clean                    |                         |
+| deltime_remote | mtime_local    | deltime_local  | mtime_remote   | download_remote  | skip              | clean                   | clean                    | 7;9                     |
+| mtime_local    | deltime_local  | deltime_remote | mtime_remote   | download_remote  | skip              | clean                   | clean                    |                         |
+| deltime_local  | mtime_local    | deltime_remote | mtime_remote   | download_remote  | skip              | clean                   | clean                    |                         |
+| deltime_remote | deltime_local  | mtime_local    | mtime_remote   | download_remote  | skip              | clean                   | clean                    | 1;9                     |
+| deltime_local  | deltime_remote | mtime_local    | mtime_remote   | download_remote  | skip              | clean                   | clean                    |                         |
+
+### Folders
+
+We actually do not use any folders' metadata. Thus the only relevent info is their names, while the mtime is actually ignorable.
+
+1. Firstly generate all the files' plan. If any files exist, then it's parent folders all should exist. If the should-exist folder doesn't exist locally, the local should create it recursively. If the should-exist folder doesn't exist remotely, the remote should create it recursively.
+2. Then, a folder is deletable, if and only if all the following conditions meet:
+
+   - it shows up in the remote deletion history
+   - it's empty, or all its sub-folders are deletable
+
+   Some examples:
+
+   - A user deletes the folder in device 1, then syncs from the device 1, then creates the same-name folder in device 2, then syncs from the device 2. The folder is deleted (again), on device 2.
+   - A user deletes the folder in device 1, then syncs from the device 1, then creates the same-name folder in device 2, **then create a new file inside it,** then syncs from the device 2. The folder is **kept** instead of deleted because of the new file, on device 2.
+   - A user deletes the folder in device 1, then syncs from the device 1, then do not touch the same-name folder in device 2, then syncs from the device 2. The folder and its untouched sub-files should be deleted on device 2.

docs/sync_ignoring_large_files.md

@@ -0,0 +1,17 @@
+# Sync Ignoring Large Files
+
+Initially, the plugin does not ignore large files.
+
+From the new version in May 2022, it can ignore all files with some sizes. But we need some rules to make the function compatible with existing conditions.
+
+1. If users are using E2E password mode, then the file sizes are compared on the **encrypted sizes**, rather than the original unencripted file sizes. The reasons are: the encrypted ones are in transferations, and the encrypted sizes can be computed from unencrypted sizes but not the reverse.
+
+2. Assuming the file A, is already synced between local device and remote service before.
+
+   - If the local size and remote size are both below the threshold, then the file can be synced normally.
+   - If the local size and remote size are both above the threshold, then the file will be ignored normally.
+   - If the local size is below the threshold, and the remote size is above the threshold, then the plugin **rejects** the sync, and throws the error to the user.
+   - If the local size is above the threshold, and the remote size is below the threshold, then the plugin **rejects** the sync, and throws the error to the user.
+   - When it somes to deletions, the same rules apply.
+
+   The main point is that, if the file sizes "cross the line", the plugin does not introduce any further trouble and just reject to work for this file.

esbuild.config.mjs

@@ -18,7 +18,7 @@ const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
 const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
 
 esbuild
-  .build({
+  .context({
     banner: {
       js: banner,
     },
@@ -31,11 +31,15 @@ esbuild
       "obsidian",
       "electron",
       "fs",
-      "crypto",
+      "tls",
+      "net",
+      "http",
+      "https",
       // ...builtins
     ],
+    inject: ["./esbuild.injecthelper.mjs"],
     format: "cjs",
-    watch: !prod,
+    // watch: !prod, // no longer valid in esbuild 0.17
     target: "es2016",
     logLevel: "info",
     sourcemap: prod ? false : "inline",
@@ -46,6 +50,20 @@ esbuild
       "process.env.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`,
       "process.env.DEFAULT_ONEDRIVE_CLIENT_ID": `"${DEFAULT_ONEDRIVE_CLIENT_ID}"`,
       "process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`,
+      global: "window",
+      "process.env.NODE_DEBUG": `undefined`, // ugly fix
+      "process.env.DEBUG": `undefined`, // ugly fix
     },
   })
+  .then((context) => {
+    if (process.argv.includes("--watch")) {
+      // Enable watch mode
+      context.watch();
+    } else {
+      // Build once and exit if not in watch mode
+      context.rebuild().then((result) => {
+        context.dispose();
+      });
+    }
+  })
   .catch(() => process.exit(1));

esbuild.injecthelper.mjs

@@ -0,0 +1,2 @@
+export let Buffer = require("buffer").Buffer;
+export let process = require("process/browser");

manifest-beta.json

@@ -0,0 +1,11 @@
+{
+  "id": "remotely-save",
+  "name": "Remotely Save",
+  "version": "0.3.34",
+  "minAppVersion": "0.13.21",
+  "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
+  "author": "fyears",
+  "authorUrl": "https://github.com/fyears",
+  "isDesktopOnly": false,
+  "fundingUrl": "https://github.com/remotely-save/donation"
+}

manifest.json

@@ -1,10 +1,11 @@
 {
   "id": "remotely-save",
   "name": "Remotely Save",
-  "version": "0.2.12",
-  "minAppVersion": "0.12.15",
+  "version": "0.3.34",
+  "minAppVersion": "0.13.21",
   "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
   "author": "fyears",
   "authorUrl": "https://github.com/fyears",
-  "isDesktopOnly": false
+  "isDesktopOnly": false,
+  "fundingUrl": "https://github.com/remotely-save/donation"
 }

package.json

@@ -1,13 +1,13 @@
 {
   "name": "remotely-save",
-  "version": "0.2.12",
+  "version": "0.3.25",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
-    "dev2": "node esbuild.config.mjs",
+    "dev2": "node esbuild.config.mjs --watch",
     "build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
     "build": "webpack --mode production",
     "dev": "webpack --mode development --watch",
-    "format": "npx prettier --write .",
+    "format": "npx prettier --trailing-comma es5 --write .",
     "clean": "npx rimraf main.js",
     "test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'"
   },
@@ -15,70 +15,82 @@
     "path": "path-browserify",
     "process": "process/browser",
     "stream": "stream-browserify",
-    "crypto": "crypto-browserify"
+    "crypto": "crypto-browserify",
+    "url": "url/"
   },
   "source": "main.ts",
   "keywords": [],
   "author": "",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@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",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^14.14.37",
-    "@types/qrcode": "^1.4.1",
-    "builtin-modules": "^3.2.0",
-    "chai": "^4.3.4",
+    "@microsoft/microsoft-graph-types": "^2.40.0",
+    "@types/chai": "^4.3.11",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/jsdom": "^21.1.6",
+    "@types/lodash": "^4.14.202",
+    "@types/mime-types": "^2.1.4",
+    "@types/mocha": "^10.0.6",
+    "@types/mustache": "^4.2.5",
+    "@types/node": "^20.10.4",
+    "@types/qrcode": "^1.5.5",
+    "builtin-modules": "^3.3.0",
+    "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "cross-env": "^7.0.3",
-    "dotenv": "^10.0.0",
-    "esbuild": "^0.14.3",
-    "jsdom": "^19.0.0",
-    "mocha": "^9.1.3",
-    "prettier": "^2.4.1",
-    "ts-loader": "^9.2.6",
-    "ts-node": "^10.4.0",
-    "tslib": "^2.2.0",
-    "typescript": "^4.4.4",
+    "dotenv": "^16.3.1",
+    "esbuild": "^0.19.9",
+    "jsdom": "^23.0.1",
+    "mocha": "^10.2.0",
+    "npm-check-updates": "^16.14.12",
+    "obsidian": "^1.4.11",
+    "prettier": "^3.1.1",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3",
     "webdav-server": "^2.6.2",
-    "webpack": "^5.64.4",
-    "webpack-cli": "^4.9.1"
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.37.0",
-    "@aws-sdk/lib-storage": "^3.40.1",
-    "@aws-sdk/signature-v4-crt": "^3.37.0",
-    "@azure/msal-node": "^1.4.0",
+    "@aws-sdk/client-s3": "^3.474.0",
+    "@aws-sdk/lib-storage": "^3.474.0",
+    "@aws-sdk/signature-v4-crt": "^3.474.0",
+    "@aws-sdk/types": "^3.468.0",
+    "@azure/msal-node": "^2.6.0",
     "@fyears/tsqueue": "^1.0.1",
-    "@microsoft/microsoft-graph-client": "^3.0.1",
-    "acorn": "^8.5.0",
-    "assert": "^2.0.0",
-    "aws-crt": "^1.10.1",
+    "@microsoft/microsoft-graph-client": "^3.0.7",
+    "@smithy/fetch-http-handler": "^2.3.1",
+    "@smithy/protocol-http": "^3.0.11",
+    "@smithy/querystring-builder": "^2.0.15",
+    "acorn": "^8.11.2",
+    "aggregate-error": "^5.0.0",
+    "assert": "^2.1.0",
+    "aws-crt": "^1.20.0",
     "buffer": "^6.0.3",
-    "codemirror": "^5.63.1",
     "crypto-browserify": "^3.12.0",
-    "dropbox": "^10.22.0",
-    "feather-icons": "^4.28.0",
+    "delay": "^6.0.0",
+    "dropbox": "^10.34.0",
+    "emoji-regex": "^10.3.0",
+    "http-status-codes": "^2.3.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",
+    "loglevel": "^1.8.1",
+    "lucide": "^0.298.0",
+    "mime-types": "^2.1.35",
+    "mustache": "^4.2.0",
+    "nanoid": "^5.0.4",
+    "p-queue": "^8.0.1",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
-    "qrcode": "^1.5.0",
-    "rfc4648": "^1.5.0",
-    "rimraf": "^3.0.2",
+    "qrcode": "^1.5.3",
+    "rfc4648": "^1.5.3",
+    "rimraf": "^5.0.5",
     "stream-browserify": "^3.0.0",
-    "util": "^0.12.4",
-    "webdav": "^4.7.0",
-    "webdav-fs": "^4.0.0",
-    "xregexp": "^5.1.0"
+    "url": "^0.11.3",
+    "util": "^0.12.5",
+    "webdav": "^5.3.1",
+    "webdav-fs": "^4.0.1",
+    "xregexp": "^5.1.1"
   }
 }

src/baseTypes.ts

@@ -3,14 +3,28 @@
  * To avoid circular dependency.
  */
 
+import { Platform, requireApiVersion } from "obsidian";
+import type { LangType, LangTypeAndAuto } from "./i18n";
+
+export const DEFAULT_CONTENT_TYPE = "application/octet-stream";
+
 export type SUPPORTED_SERVICES_TYPE = "s3" | "webdav" | "dropbox" | "onedrive";
 
+export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR =
+  | "webdav"
+  | "dropbox"
+  | "onedrive";
+
 export interface S3Config {
   s3Endpoint: string;
   s3Region: string;
   s3AccessKeyID: string;
   s3SecretAccessKey: string;
   s3BucketName: string;
+  bypassCorsLocally?: boolean;
+  partsConcurrency?: number;
+  forcePathStyle?: boolean;
+  remotePrefix?: string;
 }
 
 export interface DropboxConfig {
@@ -22,16 +36,25 @@ export interface DropboxConfig {
   accountID: string;
   username: string;
   credentialsShouldBeDeletedAtTime?: number;
+  remoteBaseDir?: string;
 }
 
 export type WebdavAuthType = "digest" | "basic";
+export type WebdavDepthType =
+  | "auto_unknown"
+  | "auto_1"
+  | "auto_infinity"
+  | "manual_1"
+  | "manual_infinity";
 
 export interface WebdavConfig {
   address: string;
   username: string;
   password: string;
   authType: WebdavAuthType;
-  manualRecursive: boolean;
+  manualRecursive: boolean; // deprecated in 0.3.6, use depth
+  depth?: WebdavDepthType;
+  remoteBaseDir?: string;
 }
 
 export interface OnedriveConfig {
@@ -44,6 +67,7 @@ export interface OnedriveConfig {
   deltaLink: string;
   username: string;
   credentialsShouldBeDeletedAtTime?: number;
+  remoteBaseDir?: string;
 }
 
 export interface RemotelySavePluginSettings {
@@ -54,8 +78,24 @@ export interface RemotelySavePluginSettings {
   password: string;
   serviceType: SUPPORTED_SERVICES_TYPE;
   currLogLevel?: string;
-  vaultRandomID?: string;
   autoRunEveryMilliseconds?: number;
+  initRunAfterMilliseconds?: number;
+  syncOnSaveAfterMilliseconds?: number;
+  agreeToUploadExtraMetadata?: boolean;
+  concurrency?: number;
+  syncConfigDir?: boolean;
+  syncUnderscoreItems?: boolean;
+  lang?: LangTypeAndAuto;
+  logToDB?: boolean;
+  skipSizeLargerThan?: number;
+  ignorePaths?: string[];
+  enableStatusBarInfo?: boolean;
+  deleteToWhere?: "system" | "obsidian";
+
+  /**
+   * @deprecated
+   */
+  vaultRandomID?: string;
 }
 
 export interface RemoteItem {
@@ -80,3 +120,77 @@ export interface UriParams {
 
 // 80 days
 export const OAUTH2_FORCE_EXPIRE_MILLISECONDS = 1000 * 60 * 60 * 24 * 80;
+
+type DecisionTypeForFile =
+  | "skipUploading" // special, mtimeLocal === mtimeRemote
+  | "uploadLocalDelHistToRemote" // "delLocalIfExists && delRemoteIfExists && cleanLocalDelHist && uploadLocalDelHistToRemote"
+  | "keepRemoteDelHist" // "delLocalIfExists && delRemoteIfExists && cleanLocalDelHist && keepRemoteDelHist"
+  | "uploadLocalToRemote" // "skipLocal && uploadLocalToRemote && cleanLocalDelHist && cleanRemoteDelHist"
+  | "downloadRemoteToLocal"; // "downloadRemoteToLocal && skipRemote && cleanLocalDelHist && cleanRemoteDelHist"
+
+type DecisionTypeForFileSize =
+  | "skipUploadingTooLarge"
+  | "skipDownloadingTooLarge"
+  | "skipUsingLocalDelTooLarge"
+  | "skipUsingRemoteDelTooLarge"
+  | "errorLocalTooLargeConflictRemote"
+  | "errorRemoteTooLargeConflictLocal";
+
+type DecisionTypeForFolder =
+  | "createFolder"
+  | "uploadLocalDelHistToRemoteFolder"
+  | "keepRemoteDelHistFolder"
+  | "skipFolder";
+
+export type DecisionType =
+  | DecisionTypeForFile
+  | DecisionTypeForFileSize
+  | DecisionTypeForFolder;
+
+export interface FileOrFolderMixedState {
+  key: string;
+  existLocal?: boolean;
+  existRemote?: boolean;
+  mtimeLocal?: number;
+  mtimeRemote?: number;
+  deltimeLocal?: number;
+  deltimeRemote?: number;
+  sizeLocal?: number;
+  sizeLocalEnc?: number;
+  sizeRemote?: number;
+  sizeRemoteEnc?: number;
+  changeRemoteMtimeUsingMapping?: boolean;
+  changeLocalMtimeUsingMapping?: boolean;
+  decision?: DecisionType;
+  decisionBranch?: number;
+  syncDone?: "done";
+  remoteEncryptedKey?: string;
+
+  mtimeLocalFmt?: string;
+  mtimeRemoteFmt?: string;
+  deltimeLocalFmt?: string;
+  deltimeRemoteFmt?: string;
+}
+
+export const API_VER_STAT_FOLDER = "0.13.27";
+export const API_VER_REQURL = "0.13.26"; // desktop ver 0.13.26, iOS ver 1.1.1
+export const API_VER_REQURL_ANDROID = "0.14.6"; // Android ver 1.2.1
+
+export const VALID_REQURL =
+  (!Platform.isAndroidApp && requireApiVersion(API_VER_REQURL)) ||
+  (Platform.isAndroidApp && requireApiVersion(API_VER_REQURL_ANDROID));
+
+export const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
+export const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX =
+  "sync_plans_hist_exported_on_";
+export const DEFAULT_LOG_HISTORY_FILE_PREFIX = "log_hist_exported_on_";
+
+export type SyncTriggerSourceType =
+  | "manual"
+  | "auto"
+  | "dry"
+  | "autoOnceInit"
+  | "auto_sync_on_save";
+
+export const REMOTELY_SAVE_VERSION_2022 = "0.3.25";
+export const REMOTELY_SAVE_VERSION_2024PREPARE = "0.3.32";

src/configPersist.ts

@@ -3,11 +3,10 @@ import { reverseString } from "./misc";
 
 import type { RemotelySavePluginSettings } from "./baseTypes";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 const DEFAULT_README: string =
-  "Do NOT modify this manually. It's generated automatically.";
+  "The file contains sensitive info, so DO NOT take screenshot of, copy, or share it to anyone! It's also generated automatically, so do not edit it manually.";
 
 interface MessyConfigType {
   readme: string;
@@ -20,8 +19,8 @@ interface MessyConfigType {
 export const messyConfigToNormal = (
   x: MessyConfigType | RemotelySavePluginSettings | null | undefined
 ): RemotelySavePluginSettings | null | undefined => {
-  log.debug("loading, original config on disk:");
-  log.debug(x);
+  // 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;
@@ -36,12 +35,12 @@ export const messyConfigToNormal = (
         }) as Buffer
       ).toString("utf-8")
     );
-    log.debug("loading, parsed config is:");
-    log.debug(y);
+    // log.debug("loading, parsed config is:");
+    // log.debug(y);
     return y;
   } else {
     // return as is
-    log.debug("loading, parsed config is the same");
+    // log.debug("loading, parsed config is the same");
     return x;
   }
 };
@@ -64,7 +63,7 @@ export const normalConfigToMessy = (
       })
     ),
   };
-  log.debug("encoding, encoded config is:");
-  log.debug(y);
+  // log.debug("encoding, encoded config is:");
+  // log.debug(y);
   return y;
 };

src/debugMode.ts

@@ -1,20 +1,85 @@
 import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
 
 import type { SyncPlanType } from "./sync";
-import { readAllSyncPlanRecordTextsByVault } from "./localdb";
+import {
+  readAllSyncPlanRecordTextsByVault,
+  readAllLogRecordTextsByVault,
+} from "./localdb";
 import type { InternalDBs } from "./localdb";
 import { mkdirpInVault } from "./misc";
+import {
+  DEFAULT_DEBUG_FOLDER,
+  DEFAULT_LOG_HISTORY_FILE_PREFIX,
+  DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX,
+  FileOrFolderMixedState,
+} from "./baseTypes";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
-const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
-const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX = "sync_plans_hist_exported_on_";
+const turnSyncPlanToTable = (record: string) => {
+  const syncPlan: SyncPlanType = JSON.parse(record);
+  const { ts, tsFmt, remoteType, mixedStates } = syncPlan;
+
+  type allowedHeadersType = keyof FileOrFolderMixedState;
+  const headers: allowedHeadersType[] = [
+    "key",
+    "remoteEncryptedKey",
+    "existLocal",
+    "sizeLocal",
+    "sizeLocalEnc",
+    "mtimeLocal",
+    "deltimeLocal",
+    "changeLocalMtimeUsingMapping",
+    "existRemote",
+    "sizeRemote",
+    "sizeRemoteEnc",
+    "mtimeRemote",
+    "deltimeRemote",
+    "changeRemoteMtimeUsingMapping",
+    "decision",
+    "decisionBranch",
+  ];
+
+  const lines = [
+    `ts: ${ts}${tsFmt !== undefined ? " / " + tsFmt : ""}`,
+    `remoteType: ${remoteType}`,
+    `| ${headers.join(" | ")} |`,
+    `| ${headers.map((x) => "---").join(" | ")} |`,
+  ];
+  for (const [k1, v1] of Object.entries(syncPlan.mixedStates)) {
+    const k = k1 as string;
+    const v = v1 as FileOrFolderMixedState;
+    const singleLine = [];
+    for (const h of headers) {
+      const field = v[h];
+      if (field === undefined) {
+        singleLine.push("");
+        continue;
+      }
+      if (
+        h === "mtimeLocal" ||
+        h === "deltimeLocal" ||
+        h === "mtimeRemote" ||
+        h === "deltimeRemote"
+      ) {
+        const fmt = v[(h + "Fmt") as allowedHeadersType] as string;
+        const s = `${field}${fmt !== undefined ? " / " + fmt : ""}`;
+        singleLine.push(s);
+      } else {
+        singleLine.push(field);
+      }
+    }
+    lines.push(`| ${singleLine.join(" | ")} |`);
+  }
+
+  return lines.join("\n");
+};
 
 export const exportVaultSyncPlansToFiles = async (
   db: InternalDBs,
   vault: Vault,
-  vaultRandomID: string
+  vaultRandomID: string,
+  toFormat: "table" | "json" = "json"
 ) => {
   log.info("exporting");
   await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
@@ -23,9 +88,16 @@ export const exportVaultSyncPlansToFiles = async (
   if (records.length === 0) {
     md = "No sync plans history found";
   } else {
+    if (toFormat === "json") {
       md =
         "Sync plans found:\n\n" +
         records.map((x) => "```json\n" + x + "\n```\n").join("\n");
+    } else if (toFormat === "table") {
+      md =
+        "Sync plans found:\n\n" + records.map(turnSyncPlanToTable).join("\n\n");
+    } else {
+      const _: never = toFormat;
+    }
   }
   const ts = Date.now();
   const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX}${ts}.md`;
@@ -34,3 +106,27 @@ export const exportVaultSyncPlansToFiles = async (
   });
   log.info("finish exporting");
 };
+
+export const exportVaultLoggerOutputToFiles = async (
+  db: InternalDBs,
+  vault: Vault,
+  vaultRandomID: string
+) => {
+  await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
+  const records = await readAllLogRecordTextsByVault(db, vaultRandomID);
+  let md = "";
+  if (records.length === 0) {
+    md = "No logger history found.";
+  } else {
+    md =
+      "Logger history found:\n\n" +
+      "```text\n" +
+      records.join("\n") +
+      "\n```\n";
+  }
+  const ts = Date.now();
+  const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_LOG_HISTORY_FILE_PREFIX}${ts}.md`;
+  await vault.create(filePath, md, {
+    mtime: ts,
+  });
+};

src/encrypt.ts

@@ -1,8 +1,7 @@
 import { base32, base64url } from "rfc4648";
 import { bufferToArrayBuffer, hexStringToTypedArray } from "./misc";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 const DEFAULT_ITER = 20000;
 
@@ -165,3 +164,25 @@ export const decryptBase64urlToString = async (
     )
   );
 };
+
+export const getSizeFromOrigToEnc = (x: number) => {
+  if (x < 0 || Number.isNaN(x) || !Number.isInteger(x)) {
+    throw Error(`getSizeFromOrigToEnc: x=${x} is not a valid size`);
+  }
+  return (Math.floor(x / 16) + 1) * 16 + 16;
+};
+
+export const getSizeFromEncToOrig = (x: number) => {
+  if (x < 32 || Number.isNaN(x) || !Number.isInteger(x)) {
+    throw Error(`getSizeFromEncToOrig: ${x} is not a valid size`);
+  }
+  if (x % 16 !== 0) {
+    throw Error(
+      `getSizeFromEncToOrig: ${x} is not a valid encrypted file size`
+    );
+  }
+  return {
+    minSize: ((x - 16) / 16 - 1) * 16,
+    maxSize: ((x - 16) / 16 - 1) * 16 + 15,
+  };
+};

src/i18n.ts

@@ -0,0 +1,44 @@
+import Mustache from "mustache";
+import { moment } from "obsidian";
+
+import { LANGS } from "./langs";
+
+export type LangType = keyof typeof LANGS;
+export type LangTypeAndAuto = LangType | "auto";
+export type TransItemType = keyof (typeof LANGS)["en"];
+
+export class I18n {
+  lang: LangTypeAndAuto;
+  readonly saveSettingFunc: (tolang: LangTypeAndAuto) => Promise<void>;
+  constructor(
+    lang: LangTypeAndAuto,
+    saveSettingFunc: (tolang: LangTypeAndAuto) => Promise<void>
+  ) {
+    this.lang = lang;
+    this.saveSettingFunc = saveSettingFunc;
+  }
+  async changeTo(anotherLang: LangTypeAndAuto) {
+    this.lang = anotherLang;
+    await this.saveSettingFunc(anotherLang);
+  }
+
+  _get(key: TransItemType) {
+    let realLang = this.lang;
+    if (this.lang === "auto" && moment.locale().replace("-", "_") in LANGS) {
+      realLang = moment.locale().replace("-", "_") as LangType;
+    } else {
+      realLang = "en";
+    }
+
+    const res: string =
+      (LANGS[realLang] as (typeof LANGS)["en"])[key] || LANGS["en"][key] || key;
+    return res;
+  }
+
+  t(key: TransItemType, vars?: Record<string, string>) {
+    if (vars === undefined) {
+      return this._get(key);
+    }
+    return Mustache.render(this._get(key), vars);
+  }
+}

src/importExport.ts

@@ -7,8 +7,7 @@ import {
   RemotelySavePluginSettings,
 } from "./baseTypes";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 export const exportQrCodeUri = async (
   settings: RemotelySavePluginSettings,

src/langs/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   

src/langs/README.md

@@ -0,0 +1,14 @@
+# Translations for Remotely Save
+
+## How To Add A Language?
+
+1. Copy `en.json` to a new json file named `<lang>.json`, and translate all the items inside. The language should match what is available in Obsidian app.
+2. Modify the `index.ts` file to include the new language file.
+
+~~## Why Seperated Repo?~~
+
+~~For better pull requests management.~~
+
+## No more `lang` submodule from 20240106
+
+It's actually harder to manage pull requests of submodule for me. The submodule is merged back to the main repo on 20240106. Any further improved translations (and/or pull requestes) should be dealt with in the main repo.

src/langs/en.json

@@ -0,0 +1,301 @@
+{
+  "confirm": "Confirm",
+  "disable": "Disable",
+  "enable": "Enable",
+  "goback": "Go Back",
+  "submit": "Submit",
+  "sometext": "Here are some texts.",
+  "syncrun_alreadyrunning": "{{pluginName}} already running in stage {{syncStatus}}!",
+  "syncrun_syncingribbon": "{{pluginName}}: syncing from {{triggerSource}}",
+  "syncrun_step0": "0/8 Remotely Save running in dry mode, not actual file changes would happen.",
+  "syncrun_step1": "1/8 Remotely Save Sync Preparing ({{serviceType}})",
+  "syncrun_step2": "2/8 Starting to fetch remote meta data.",
+  "syncrun_step3": "3/8 Checking password correct or not.",
+  "syncrun_passworderr": "Something goes wrong while checking password.",
+  "syncrun_step4": "4/8 Trying to fetch extra meta data from remote.",
+  "syncrun_step5": "5/8 Starting to fetch local meta data.",
+  "syncrun_step6": "6/8 Starting to generate sync plan.",
+  "syncrun_step7": "7/8 Remotely Save Sync data exchanging!",
+  "syncrun_step7skip": "7/8 Remotely Save real sync is skipped in dry run mode.",
+  "syncrun_step8": "8/8 Remotely Save finish!",
+  "syncrun_shortstep0": "0/2 Remotely Save running in dry mode, not actual file changes would happen.",
+  "syncrun_shortstep1": "1/2 Remotely Save Sync Start Running ({{serviceType}})",
+  "syncrun_shortstep2skip": "2/2 Remotely Save real sync is skipped in dry run mode.",
+  "syncrun_shortstep2": "2/2 Remotely Save finish!",
+  "syncrun_abort": "{{manifestID}}-{{theDate}}: abort sync, triggerSource={{triggerSource}}, error while {{syncStatus}}",
+  "protocol_saveqr": "New not-oauth2 settings for {{manifestName}} saved. Reopen the plugin Settings to the effect.",
+  "protocol_callbacknotsupported": "Your uri call a callback that's not supported yet: {{params}}",
+  "protocol_dropbox_connecting": "Connecting to Dropbox...\nPlease DO NOT close this modal.",
+  "protocol_dropbox_connect_succ": "Good! We've connected to Dropbox as user {{username}}!",
+  "protocol_dropbox_connect_succ_revoke": "You've connected as user {{username}}. If you want to disconnect, click this button.",
+  "protocol_dropbox_connect_fail": "Something went wrong from response from Dropbox. Maybe you rejected the auth?",
+  "protocol_dropbox_connect_unknown": "Do not know how to deal with the callback: {{params}}",
+  "protocol_onedrive_connecting": "Connecting to OneDrive...\nPlease DO NOT close this modal.",
+  "protocol_onedrive_connect_succ_revoke": "You've connected as user {{username}}. If you want to disconnect, click this button.",
+  "protocol_onedrive_connect_fail": "Something went wrong from response from OneDrive. Maybe you rejected the auth?",
+  "protocol_onedrive_connect_unknown": "Do not know how to deal with the callback: {{params}}",
+  "command_startsync": "start sync",
+  "command_drynrun": "start sync (dry run only)",
+  "command_exportsyncplans_json": "export sync plans in json format",
+  "command_exportsyncplans_table": "export sync plans in table format",
+  "command_exportlogsindb": "export logs saved in db",
+
+  "statusbar_time_years": "{{time}} years",
+  "statusbar_time_months": "{{time}} months",
+  "statusbar_time_weeks": "{{time}} weeks",
+  "statusbar_time_days": "{{time}} days",
+  "statusbar_time_hours": "{{time}} hours",
+  "statusbar_time_minutes": "{{time}} minutes",
+  "statusbar_time_lessminute": "less than a minute",
+  "statusbar_lastsync": "Synced {{time}} ago",
+  "statusbar_lastsync_label": "Last successful Sync on {{date}}",
+  "statusbar_lastsync_never": "Never Synced",
+  "statusbar_lastsync_never_label": "Never Synced before",
+
+  "modal_password_title": "Hold on and PLEASE READ ON...",
+  "modal_password_shortdesc": "If the field is not empty, files would be encrypted locally before being uploaded.\nIf the field is empty, then files would be uploaded without encryption.",
+  "modal_password_attn1": "Attention 1/5: The vault name is NOT encrypted. The plugin creates a folder with the vault name on some remote services.",
+  "modal_password_attn2": "Attention 2/5: The password itself is stored in PLAIN TEXT LOCALLY.",
+  "modal_password_attn3": "Attention 3/5: Some metadata are not encrypted or can be easily guessed. (File sizes are closed to their unencrypted ones, and directory path may be stored as 0-byte-size object.)",
+  "modal_password_attn4": "Attention 4/5: You should make sure the remote store IS EMPTY, or REMOTE FILES WERE ENCRYPTED BY THAT NEW PASSWORD, to avoid conflicts.",
+  "modal_password_attn5": "Attention 5/5: The longer the password, the better.",
+  "modal_password_secondconfirm": "The Second Confirm to change password.",
+  "modal_password_notice": "New password saved!",
+  "modal_remotebasedir_title": "You are changing the remote base directory config",
+  "modal_remotebasedir_shortdesc": "1. The plugin would NOT automatically move the content from the old directory to the new one directly on the remote. Everything syncs from the beginning again.\n2. If you set the string to the empty, the config would be reset to use the vault folder name (the default config).\n3. The remote directory name itself would not be encrypted even you've set an E2E password.\n4. Some special char like '?', '/', '\\' are not allowed. Spaces in the beginning or in the end are also trimmed.",
+  "modal_remotebasedir_invaliddirhint": "Your input contains special characters like '?', '/', '\\' which are not allowed.",
+  "modal_remotebasedir_secondconfirm_vaultname": "Reset To The Default Vault Folder Name",
+  "modal_remotebasedir_secondconfirm_change": "Confirm To Change",
+  "modal_remotebasedir_notice": "New remote base directory config saved!",
+  "modal_remoteprefix_title": "You are changing the remote prefix config",
+  "modal_remoteprefix_shortdesc": "1. The plugin would NOT automatically move the content from the old directory to the new one directly on the remote. Everything syncs from the beginning again.\n2. If you set the string to the empty, the prefix will be empty and the files will be saved at the root of the bucket.\n3. The remote directory name itself would not be encrypted even you've set an E2E password.\n4. Some special char like '?', '/', '\\' are not allowed. Spaces in the beginning or in the end are also trimmed.",
+  "modal_remoteprefix_invaliddirhint": "Your input contains special characters like '?', '/', '\\' which are not allowed.",
+  "modal_remoteprefix_tosave": "The prefix to save is \"{{{prefix}}}\"",
+  "modal_remoteprefix_secondconfirm_empty": "The prefix is empty and the files will be saved at the root of the bucket.",
+  "modal_remoteprefix_secondconfirm_change": "Confirm To Change",
+  "modal_remoteprefix_notice": "New remote prefix config saved!",
+  "modal_dropboxauth_manualsteps": "Step 1: Visit the address in a browser, and follow the steps.\nStep 2: In the end of the web flow, you obtain a long code. Paste it here then click \"Submit\".",
+  "modal_dropboxauth_autosteps": "Visit the address in a browser, and follow the steps.\nFinally you should be redirected to Obsidian.",
+  "modal_dropboxauth_copybutton": "Click to copy the auth url",
+  "modal_dropboxauth_copynotice": "The auth url is copied to the clipboard!",
+  "modal_dropboxauth_maualinput": "Auth Code from web page",
+  "modal_dropboxauth_maualinput_desc": "You need to click \"Confirm\".",
+  "modal_dropboxauth_maualinput_notice": "Trying to connect to Dropbox",
+  "modal_dropboxauth_maualinput_conn_succ": "Good! We've connected to Dropbox as user {{username}}!",
+  "modal_dropboxauth_maualinput_conn_succ_revoke": "You've connected as user {{username}}. If you want to disconnect, click this button.",
+  "modal_dropboxauth_maualinput_conn_fail": "Something goes wrong while connecting to Dropbox.",
+  "modal_onedriveauth_shortdesc": "Currently only OneDrive for personal is supported. OneDrive for Business is NOT supported (yet).\nVisit the address in a browser, and follow the steps.\nFinally you should be redirected to Obsidian.",
+  "modal_onedriveauth_copybutton": "Click to copy the auth url",
+  "modal_onedriveauth_copynotice": "The auth url is copied to the clipboard!",
+  "modal_onedriverevokeauth_step1": "Step 1: Go to the following address, click the \"Edit\" button for the plugin, then click \"Remove these permissions\" button on the page.",
+  "modal_onedriverevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
+  "modal_onedriverevokeauth_clean": "Clean Locally-Saved Login Credentials",
+  "modal_onedriverevokeauth_clean_desc": "You need to click the button.",
+  "modal_onedriverevokeauth_clean_button": "Clean",
+  "modal_onedriverevokeauth_clean_notice": "Cleaned!",
+  "modal_onedriverevokeauth_clean_fail": "Something goes wrong while revoking.",
+  "modal_syncconfig_attn": "Attention 1/2: This only syncs (copies) the whole Obsidian config dir, not other startting-with-dot folders or files. Except for ignoring folders .git and node_modules, it also doesn't understand the meaning of sub-files and sub-folders inside the config dir.\nAttention 2/2: After the config dir is synced, plugins settings might be corrupted, and Obsidian might need to be restarted to load the new settings.\nIf you are agreed to take your own risk, please click the following second confirm button.",
+  "modal_syncconfig_secondconfirm": "The Second Confirm To Enable.",
+  "modal_syncconfig_notice": "You've enabled syncing config folder!",
+  "modal_qr_shortdesc": "This exports not-oauth2 settings. (It means that Dropbox, OneDrive info are NOT exported.)\nYou can use another device to scan this qrcode.\nOr, you can click the button to copy the special url.",
+  "modal_qr_button": "Click to copy the special URI",
+  "modal_qr_button_notice": "The special uri is copied to the clipboard!",
+  "modal_sizesconflict_title": "Remotely Save: Some conflict were found while skipping large files",
+  "modal_sizesconflict_desc": "You've set skipping files larger than {{thresholdMB}} MB ({{thresholdBytes}} bytes).\nBut the following files have sizes larger than the threshold on one side, and sizes smaller than the threshold on the other side.\nTo avoid unexpected overwriting or deleting, the plugin stops, and you have to manually deal with at least one side of the files.",
+  "modal_sizesconflict_copybutton": "Click to copy all the below sizes conflicts info",
+  "modal_sizesconflict_copynotice": "All the sizes conflicts info have been copied to the clipboard!",
+  "modal_logtohttpserver_title": "Log To HTTP(S) Server Is DANGEROUS!",
+  "modal_logtohttpserver_desc": "All your sensitive logging information will be posted to the HTTP(S) server without any authentications!!!!!\nPlease make sure you trust the HTTP(S) server, and it's better to setup a HTTPS one instead of HTTP one.\nIt's for debugging purposes only, especially on mobile.",
+  "modal_logtohttpserver_secondconfirm": "I know it's dangerous, and insist, and am willing to bear all possible losses.",
+  "modal_logtohttpserver_notice": "OK.",
+  "settings_basic": "Basic Settings",
+  "settings_password": "Encryption Password",
+  "settings_password_desc": "Password for E2E encryption. Empty for no password. You need to click \"Confirm\". Attention: the password and other info are saved locally.",
+  "settings_autorun": "Schedule For Auto Run",
+  "settings_autorun_desc": "The plugin tries to schedule the running after every interval. Battery may be impacted.",
+  "settings_autorun_notset": "(not set)",
+  "settings_autorun_1min": "every 1 minute",
+  "settings_autorun_5min": "every 5 minutes",
+  "settings_autorun_10min": "every 10 minutes",
+  "settings_autorun_30min": "every 30 minutes",
+  "settings_runoncestartup": "Run Once On Start Up Automatically",
+  "settings_runoncestartup_desc": "This settings allows setting running ONCE on start up automatically. This will take effect on NEXT start up after changing. This setting, is different from \"schedule for auto run\" which starts syncing after EVERY interval.",
+  "settings_runoncestartup_notset": "(not set)",
+  "settings_runoncestartup_1sec": "sync once after 1 second of start up",
+  "settings_runoncestartup_10sec": "sync once after 10 seconds of start up",
+  "settings_runoncestartup_30sec": "sync once after 30 seconds of start up",
+  "settings_saverun": "Sync On Save (experimental)",
+  "settings_saverun_desc": "A sync will be triggered if a file save action happened within a few seconds. Please pay attention that syncing is potentially a heavy action and battery may be impacted. (May need to reload the plugin or restart Obsidian after changing)",
+  "settings_saverun_notset": "(not set)",
+  "settings_saverun_1sec": "check every 1 second",
+  "settings_saverun_5sec": "check every 5 seconds",
+  "settings_saverun_10sec": "check every 10 seconds (recommended)",
+  "settings_saverun_1min": "check every 1 minute",
+  "settings_skiplargefiles": "Skip Large Files",
+  "settings_skiplargefiles_desc": "Skip files with sizes larger than the threshold. Here 1 MB = 10^6 bytes.",
+  "settings_skiplargefiles_notset": "(not set)",
+
+  "settings_ignorepaths": "Regex Of Paths To Ignore",
+  "settings_ignorepaths_desc": "Regex of paths of folders or files to ignore. One regex per line. The path is relative to the vault root without leading slash.",
+  "settings_enablestatusbar_info": "Show Last Successful Sync In Status Bar",
+  "settings_enablestatusbar_info_desc": "Show the time of the last successful sync in the status bar.",
+  "settings_enablestatusbar_reloadrequired_notice": "Reload the plugin for the changes to take effect.",
+  "settings_resetstatusbar_time": "Reset Last Successful Sync Time",
+  "settings_resetstatusbar_time_desc": "Reset last successful sync time.",
+  "settings_resetstatusbar_button": "Reset",
+  "settings_resetstatusbar_notice": "Reset done!",
+
+  "settings_checkonnectivity": "Check Connectivity",
+  "settings_checkonnectivity_desc": "Check connectivity.",
+  "settings_checkonnectivity_button": "Check",
+  "settings_checkonnectivity_checking": "Checking...",
+  "settings_remotebasedir": "Change The Remote Base Directory (experimental)",
+  "settings_remotebasedir_desc": "By default the content is synced to a remote directory with the same name as the vault name. You can change the remote folder name here, or keep the input field empty to reset to the default. You need to click \"Confirm\".",
+  "settings_remoteprefix": "Change The Remote Prefix (experimental)",
+  "settings_remoteprefix_desc": "By default in s3 the files are saved at the root of the bucket. You can change the remote prefix here, or keep the input field empty to reset to the default. You need to click \"Confirm\".",
+  "settings_s3": "Remote For S3 or compatible",
+  "settings_s3_disclaimer1": "Disclaimer: This plugin is NOT an official Amazon product.",
+  "settings_s3_disclaimer2": "Disclaimer: The information is stored 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.",
+  "settings_s3_cors": "You need to configure CORS to allow requests from origin app://obsidian.md and capacitor://localhost and http://localhost, and add ETag into exposed headers.",
+  "settings_s3_prod": "Some Amazon S3 official docs for references:",
+  "settings_s3_prod1": "Endpoint and region info",
+  "settings_s3_prod2": "Access Key ID and Secret Access Key info",
+  "settings_s3_prod3": "Configuring CORS",
+  "settings_s3_endpoint": "Endpoint",
+  "settings_s3_region": "Region",
+  "settings_s3_region_desc": "If you are not sure what to enter, you could try the value: us-east-1",
+  "settings_s3_accesskeyid": "Access Key ID",
+  "settings_s3_accesskeyid_desc": "Access key ID. Attention: Access key ID and other info are saved locally.",
+  "settings_s3_secretaccesskey": "Secret Access Key",
+  "settings_s3_secretaccesskey_desc": "Secret access key. Attention: Secret access key and other info are saved locally.",
+  "settings_s3_bucketname": "Bucket Name",
+  "settings_s3_bypasscorslocally": "Bypass CORS Issue Locally",
+  "settings_s3_bypasscorslocally_desc": "The plugin allows skipping server CORS config in new version of Obsidian ( desktop>=0.13.25 or iOS>=1.1.1 or Android>=1.2.1). If you encounter any issues, please disable this setting and config CORS on servers (allowing requests from app://obsidian.md and capacitor://localhost and http://localhost and add ETag into exposed headers).",
+  "settings_s3_parts": "Parts Concurrency",
+  "settings_s3_parts_desc": "Large files are split into small parts to upload in S3. How many parts do you want to upload in parallel at most?",
+  "settings_s3_urlstyle": "S3 URL style",
+  "settings_s3_urlstyle_desc": "Whether to force path-style URLs for S3 objects (e.g., https://s3.amazonaws.com/*/ instead of https://*.s3.amazonaws.com/).",
+  "settings_s3_connect_succ": "Great! The bucket can be accessed.",
+  "settings_s3_connect_fail": "The S3 bucket cannot be reached.",
+  "settings_dropbox": "Remote For Dropbox",
+  "settings_dropbox_disclaimer1": "Disclaimer: This app is NOT an official Dropbox product.",
+  "settings_dropbox_disclaimer2": "Disclaimer: The information is stored 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 .",
+  "settings_dropbox_folder": "We will create and sync inside the folder /Apps/{{pluginID}}/{{remoteBaseDir}} on your Dropbox.",
+  "settings_dropbox_revoke": "Revoke Auth",
+  "settings_dropbox_revoke_desc": "You've connected as user {{username}}. If you want to disconnect, click this button.",
+  "settings_dropbox_revoke_button": "Revoke Auth",
+  "settings_dropbox_revoke_notice": "Revoked!",
+  "settings_dropbox_revoke_noticeerr": "Something goes wrong while revoking.",
+  "settings_dropbox_clearlocal": "Clear Locally Saved Credentials",
+  "settings_dropbox_clearlocal_desc": "You can forcefully clear the locally saved Dropbox login credentials, but not send revoke auth request to the server.",
+  "settings_dropbox_clearlocal_button": "Clear",
+  "settings_dropbox_clearlocal_notice": "Cleared!",
+  "settings_dropbox_auth": "Auth",
+  "settings_dropbox_auth_desc": "Auth.",
+  "settings_dropbox_auth_button": "Auth",
+  "settings_dropbox_connect_succ": "Great! We can connect to Dropbox!",
+  "settings_dropbox_connect_fail": "We cannot connect to Dropbox.",
+  "settings_onedrive": "Remote For Onedrive (for personal)",
+  "settings_onedrive_disclaimer1": "Disclaimer: This app is NOT an official Microsoft / OneDrive product.",
+  "settings_onedrive_disclaimer2": "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 .",
+  "settings_onedrive_folder": "We will create and sync inside the folder /Apps/{{pluginID}}/{{remoteBaseDir}} on your OneDrive.",
+  "settings_onedrive_nobiz": "Currently only OneDrive for personal is supported. OneDrive for Business is NOT supported (yet).",
+  "settings_onedrive_revoke": "Revoke Auth",
+  "settings_onedrive_revoke_desc": "You've connected as user {{username}}. If you want to disconnect, click this button.",
+  "settings_onedrive_revoke_button": "Revoke Auth",
+  "settings_onedrive_auth": "Auth",
+  "settings_onedrive_auth_desc": "Auth.",
+  "settings_onedrive_auth_button": "Auth",
+  "settings_onedrive_connect_succ": "Great! We can connect to Onedrive!",
+  "settings_onedrive_connect_fail": "We cannot connect to Onedrive.",
+  "settings_webdav": "Remote For Webdav",
+  "settings_webdav_disclaimer1": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins may read the info. If you see any unintentional access to your webdav server, please immediately change the username and password.",
+  "settings_webdav_cors_os": "Obsidian desktop>=0.13.25 or iOS>=1.1.1 or Android>=1.2.1 supports bypassing CORS locally. But you are using an old version, and you're suggested to upgrade Obsidian.",
+  "settings_webdav_cors": "You need to configure CORS to allow requests from origin app://obsidian.md and capacitor://localhost and http://localhost",
+  "settings_webdav_folder": "We will create and sync inside the folder /{{remoteBaseDir}} on your server.",
+  "settings_webdav_addr": "Server Address",
+  "settings_webdav_addr_desc": "Server address.",
+  "settings_webdav_user": "Username",
+  "settings_webdav_user_desc": "Username. Attention: the username and other info are saved locally.",
+  "settings_webdav_password": "Password",
+  "settings_webdav_password_desc": "Password. Attention: the password and other info are saved locally.",
+  "settings_webdav_auth": "Auth Type",
+  "settings_webdav_auth_desc": "If no password, this option would be ignored.",
+  "settings_webdav_depth": "Depth Header Sent To Servers",
+  "settings_webdav_depth_desc": "Webdav servers should be configured to allow requests with header Depth being '1' or 'Infinity'. The plugin needs to know this info. If you are not sure what's this, choose \"auto\".",
+  "settings_webdav_depth_auto": "auto detect",
+  "settings_webdav_depth_1": "only supports depth='1'",
+  "settings_webdav_depth_inf": "supports depth='infinity'",
+  "settings_webdav_connect_succ": "Great! The webdav server can be accessed.",
+  "settings_webdav_connect_fail": "The webdav server cannot be reached (possible to be any of address/username/password/authtype errors).",
+  "settings_webdav_connect_fail_withcors": "The webdav server cannot be reached (possible to be any of address/username/password/authtype/CORS errors).",
+  "settings_chooseservice": "Choose A Remote Service",
+  "settings_chooseservice_desc": "Start here. What service are you connecting to? S3, Dropbox, Webdav, or OneDrive for personal?",
+  "settings_chooseservice_s3": "S3 or compatible",
+  "settings_chooseservice_dropbox": "Dropbox",
+  "settings_chooseservice_webdav": "Webdav",
+  "settings_chooseservice_onedrive": "OneDrive for personal",
+  "settings_adv": "Advanced Settings",
+  "settings_concurrency": "Concurrency",
+  "settings_concurrency_desc": "How many files do you want to download or upload in parallel at most? By default it's set to 5. If you meet any problems such as rate limit, you can reduce the concurrency to a lower value.",
+  "settings_syncunderscore": "Sync _ Files Or Folders",
+  "settings_syncunderscore_desc": "Sync files or folders starting with _ (\"underscore\") or not",
+  "settings_configdir": "Sync Config Dir (experimental)",
+  "settings_configdir_desc": "Sync config dir {{configDir}} or not (inner folder .git and node_modules would be ignored). Please be aware that this may impact all your plugins' or Obsidian's settings, and may require you restart Obsidian after sync. Enable this at your own risk.",
+  "settings_deletetowhere": "Deletion Destination",
+  "settings_deletetowhere_desc": "Which trash should the plugin put the files into while deleting?",
+  "settings_deletetowhere_system_trash": "system trash (default)",
+  "settings_deletetowhere_obsidian_trash": "Obsidian .trash folder",
+  "settings_importexport": "Import and Export Partial Settings",
+  "settings_export": "Export",
+  "settings_export_desc": "Export not-oauth2 settings by generating a qrcode.",
+  "settings_export_desc_button": "Get QR Code",
+  "settings_import": "Import",
+  "settings_import_desc": "You should open a camera or scan-qrcode app, to manually scan the QR code.",
+  "settings_debug": "Debug",
+  "settings_debuglevel": "Alter Console Log Level",
+  "settings_debuglevel_desc": "By default the log level is \"info\". You can change to \"debug\" to get verbose information in console.",
+  "settings_outputsettingsconsole": "Output Current Settings From Disk To Console",
+  "settings_outputsettingsconsole_desc": "The settings save on disk in encoded. Click this to see the decoded settings in console.",
+  "settings_outputsettingsconsole_button": "Output",
+  "settings_outputsettingsconsole_notice": "Finished outputing in console.",
+  "settings_syncplans": "Export Sync Plans",
+  "settings_syncplans_desc": "Sync plans are created every time after you trigger sync and before the actual sync. Useful to know what would actually happen in those sync. Click the button to export sync plans. You can choose to export to json or table format inside Markdown, which are equivalent.",
+  "settings_syncplans_button_json": "Export (json)",
+  "settings_syncplans_button_table": "Export (table)",
+  "settings_syncplans_notice": "Sync plans history exported.",
+  "settings_delsyncplans": "Delete Sync Plans History In DB",
+  "settings_delsyncplans_desc": "Delete sync plans history in DB.",
+  "settings_delsyncplans_button": "Delete Sync Plans History",
+  "settings_delsyncplans_notice": "Sync plans history (in DB) deleted.",
+  "settings_logtodb": "Save Console Logs Into DB",
+  "settings_logtodb_desc": "Enable this to save all console logs into DB, so that we can export and read them later. Especially useful for mobile debugging. Has performance cost and may impact battery. The history is saved for at most 10000 records and 7 days old.",
+  "settings_logtodbexport": "Export Console Logs From DB",
+  "settings_logtodbexport_desc": "Export the saved console logs of this vault from DB into a new file in the folder {{&debugFolder}} .",
+  "settings_logtodbexport_button": "Export",
+  "settings_logtodbexport_notice": "Console logs of this vault from DB are exported!",
+  "settings_logtodbclear": "Delete All Console Logs In DB",
+  "settings_logtodbclear_desc": "Delete all the console logs saved inside DB. This setting applies to all saved logs for all vaults in this device.",
+  "settings_logtodbclear_button": "Delete",
+  "settings_logtodbclear_notice": "All console logs saved in DB are deleted!",
+  "settings_logtohttpserver": "Log To HTTP Server Temporarily",
+  "settings_logtohttpserver_desc": "It's very dangerous and please use the function with greate cautions!!!!! It will temporarily allow sending console loggins to HTTP server.",
+  "settings_logtohttpserver_reset_notice": "Already removed the setting of logging to HTTP server.",
+  "settings_delsyncmap": "Delete Sync Mappings History In DB",
+  "settings_delsyncmap_desc": "Sync mappings history stores the actual LOCAL last modified time of the REMOTE objects. Clearing it may cause unnecessary data exchanges in next-time sync. Click the button to delete sync mappings history in DB.",
+  "settings_delsyncmap_button": "Delete Sync Mappings",
+  "settings_delsyncmap_notice": "Sync mappings history (in local DB) deleted",
+  "settings_outputbasepathvaultid": "Output Vault Base Path And Randomly Assigned ID",
+  "settings_outputbasepathvaultid_desc": "For debugging purposes.",
+  "settings_outputbasepathvaultid_button": "Output",
+  "settings_resetcache": "Reset Local Internal Cache/Databases",
+  "settings_resetcache_desc": "Reset local internal caches/databases (for debugging purposes). You would want to reload the plugin after resetting this. This option will not empty the {s3, password...} settings.",
+  "settings_resetcache_button": "Reset",
+  "settings_resetcache_notice": "Local internal cache/databases deleted. Please manually reload the plugin.",
+  "syncalgov2_title": "Remotely Save has a better sync algorithm",
+  "syncalgov2_texts": "Welcome to use Remotely Save!\nFrom version 0.3.0, a new algorithm has been developed, but it needs uploading extra meta data files _remotely-save-metadata-on-remote.{json,bin} to YOUR configured cloud destinations, besides your notes.\nSo that, for example, the second device can know that what files/folders have been deleted on the first device by reading those files.\nIf you agree, plase click the button \"Agree\", and enjoy the plugin! AND PLEASE REMEMBER TO BACKUP YOUR VAULT FIRSTLY!\nIf you do not agree, you should stop using the current and later versions of Remotely Save. You could consider manually install the old version 0.2.14 which uses old algorithm and does not upload any extra meta data files. By clicking the \"Do Not Agree\" button, the plugin will unload itself, and you need to manually disable it in Obsidian settings.",
+  "syncalgov2_button_agree": "Agree",
+  "syncalgov2_button_disagree": "Do Not Agree",
+
+  "official_notice_2024_first_party": "Plugin Remotely-Save is back to the party and get a HUGE update!🎉🎉🎉 Try it yourself or see the release note on https://github.com/remotely-save/remotely-save/releases."
+}

src/langs/index.ts

@@ -0,0 +1,9 @@
+import en from "./en.json";
+import zh_cn from "./zh_cn.json";
+import zh_tw from "./zh_tw.json";
+
+export const LANGS = {
+  en: en,
+  zh_cn: zh_cn,
+  zh_tw: zh_tw,
+};

src/langs/zh_cn.json

@@ -0,0 +1,301 @@
+{
+  "confirm": "确认",
+  "disable": "关闭",
+  "enable": "开启",
+  "goback": "返回",
+  "submit": "提交",
+  "sometext": "这里有一段文字。",
+  "syncrun_alreadyrunning": "{{pluginName}} 正处于此阶段：{{syncStatus}}!",
+  "syncrun_syncingribbon": "{{pluginName}}：正在由 {{triggerSource}} 触发运行",
+  "syncrun_step0": "0/8 Remotely Save 在空跑（dry run）模式，不会发生实际的文件交换。",
+  "syncrun_step1": "1/8 Remotely Save 准备同步（{{serviceType}}）",
+  "syncrun_step2": "2/8 正在获取远端的元数据。",
+  "syncrun_step3": "3/8 正在检查密码正确与否。",
+  "syncrun_passworderr": "检查密码时候出错。",
+  "syncrun_step4": "4/8 正在获取远端的额外的元数据。",
+  "syncrun_step5": "5/8 正在获取本地的元数据。",
+  "syncrun_step6": "6/8 正在生成同步计划。",
+  "syncrun_step7": "7/8 Remotely Save 开始发生数据交换！",
+  "syncrun_step7skip": "7/8 Remotely Save 在空跑模式，跳过实际数据交换步骤。",
+  "syncrun_step8": "8/8 Remotely Save 已完成同步！",
+  "syncrun_shortstep0": "0/2 Remotely Save 在空跑（dry run）模式，不会发生实际的文件交换。",
+  "syncrun_shortstep1": "1/2 Remotely Save 开始同步（{{serviceType}}）",
+  "syncrun_shortstep2skip": "2/2 Remotely Save 在空跑模式，跳过实际数据交换步骤。",
+  "syncrun_shortstep2": "2/2 Remotely Save 已完成同步！",
+  "syncrun_abort": "{{manifestID}}-{{theDate}}：中断同步，同步来源={{triggerSource}}，出错阶段={{syncStatus}}",
+  "protocol_saveqr": " {{manifestName}} 新的非 oauth2 设置保存完成。请重启插件设置页使之生效。",
+  "protocol_callbacknotsupported": "您的 uri callback 暂不支持： {{params}}",
+  "protocol_dropbox_connecting": "正在连接 Dropbox……\n请不要关闭此弹窗。",
+  "protocol_dropbox_connect_succ": "好！我们作为用户 {{username}} 连接上了 Dropbox！",
+  "protocol_dropbox_connect_succ_revoke": "您已作为用户 {{username}} 连接上了。如果您想取消连接，请点击此按钮。",
+  "protocol_dropbox_connect_fail": "Dropbox 的回调请求有点异常。您是否拒绝了鉴权？",
+  "protocol_dropbox_connect_unknown": "不知道如何处理此 callback：{{params}}",
+  "protocol_onedrive_connecting": "正在连接 OneDrive……\n请不要关闭此弹窗。",
+  "protocol_onedrive_connect_succ_revoke": "您已作为用户 {{username}} 连接上了。如果您想取消连接，请点击此按钮。",
+  "protocol_onedrive_connect_fail": "OneDrive 的回调请求有点异常。您是否拒绝了鉴权？",
+  "protocol_onedrive_connect_unknown": "不知道如何处理此 callback：{{params}}",
+  "command_startsync": "开始同步（start sync）",
+  "command_drynrun": "开始同步（空跑模式）（start sync (dry run only)）",
+  "command_exportsyncplans_json": "导出同步计划为 json 格式（export sync plans in json format）",
+  "command_exportsyncplans_table": "导出同步计划为表格格式（export sync plans in table format）",
+  "command_exportlogsindb": "从数据库导出终端日志（export logs saved in db）",
+
+  "statusbar_time_years": "{{time}} 年前",
+  "statusbar_time_months": "{{time}} 月前",
+  "statusbar_time_weeks": "{{time}} 周前",
+  "statusbar_time_days": "{{time}} 天前",
+  "statusbar_time_hours": "{{time}} 小时前",
+  "statusbar_time_minutes": "{{time}} 分钟前",
+  "statusbar_time_lessminute": "一分钟之内",
+  "statusbar_lastsync": "上一次同步于：{{time}}",
+  "statusbar_lastsync_label": "上一次同步于：{{date}}",
+  "statusbar_lastsync_never": "没触发过同步",
+  "statusbar_lastsync_never_label": "没触发过同步",
+
+  "modal_password_title": "稍等一下，请阅读下文：",
+  "modal_password_shortdesc": "如果密码不是空的，那么文件会在上传之前，在本地先用此密码加密。\n如果密码是空的，那么文件会被非加密地上传。",
+  "modal_password_attn1": "注意 1/5：库（Vault）名字是不会加密的！本插件会在一些远程存储里创建一个和库名字有着同名的文件夹。",
+  "modal_password_attn2": "注意 2/5：密码在本地不加密地保存！",
+  "modal_password_attn3": "注意 3/5：一些元信息是没有被加密的，或者可以被较容易地猜测出来。（文件大小很接近于没加密的时候，且文件夹可能会被存储为大小为 0 byte 的对象。）",
+  "modal_password_attn4": "注意 4/5：您需要确保远程存储是“空”的，或者已有文件也是被同一个新密码加密的；从而避免冲突。",
+  "modal_password_attn5": "注意 5/5：密码越长越好。",
+  "modal_password_secondconfirm": "再次确认保存新密码",
+  "modal_password_notice": "新密码已保存！",
+  "modal_remotebasedir_title": "您正在修改远端基文件夹设置",
+  "modal_remotebasedir_shortdesc": "1. 本插件并不会自动在远端把内容从旧文件夹移动到新文件夹。所有内容都会重新同步。\n2. 如果你使得文本输入框为空，那么本设置会被重设回库的文件夹名（默认设置）。\n3. 即使您设置了端对端加密的密码，远端文件夹名称本身也不会被加密。\n4. 某些特殊字符，如“?”、“/”、“\\”是不允许的。文本前后的空格也会被自动删去。",
+  "modal_remotebasedir_invaliddirhint": "您所输入的内容含有某些特殊字符，如“?”、“/”、“\\”，它们是不允许的。",
+  "modal_remotebasedir_secondconfirm_vaultname": "重设回默认的库文件夹名",
+  "modal_remotebasedir_secondconfirm_change": "确认修改",
+  "modal_remotebasedir_notice": "新的远端基文件夹设置已保存！",
+  "modal_remoteprefix_title": "您正在修改远端路径前缀设置",
+  "modal_remoteprefix_shortdesc": "1. 本插件并不会自动在远端把内容从旧文件夹移动到新文件夹。所有内容都会重新同步。\n2. 如果你使得文本输入框为空，那么本设置为保存为空，文件将会被存储在桶（Bucket）的根目录。\n3. 即使您设置了端对端加密的密码，远端文件夹名称本身也不会被加密。\n4. 某些特殊字符，如“?”、“/”、“\\”是不允许的。文本前后的空格也会被自动删去。",
+  "modal_remoteprefix_invaliddirhint": "您所输入的内容含有某些特殊字符，如“?”、“/”、“\\”，它们是不允许的。",
+  "modal_remoteprefix_tosave": "您设定的新前缀为：“{{{prefix}}}”",
+  "modal_remoteprefix_secondconfirm_empty": "前缀为空，文件会保存在根目录",
+  "modal_remoteprefix_secondconfirm_change": "确认修改",
+  "modal_remoteprefix_notice": "新的远端路径前缀设置已保存！",
+  "modal_dropboxauth_manualsteps": "第 1 步：在浏览器中访问以下地址，然后按照网页提示操作。\n到了最后，您应该会获得一串很长的代码文本，请复制粘贴到下方，并点击“提交”",
+  "modal_dropboxauth_autosteps": "在浏览器中访问以下地址，然后按照网页提示操作。\n到了最后，您应该会被自动重定向回来 Obsidian。",
+  "modal_dropboxauth_copybutton": "点击此按钮从而复制鉴权 url",
+  "modal_dropboxauth_copynotice": "鉴权 url 已复制到剪贴板！",
+  "modal_dropboxauth_maualinput": "来自网页的授权码",
+  "modal_dropboxauth_maualinput_desc": "您需要点击“确认”",
+  "modal_dropboxauth_maualinput_notice": "正在尝试连接 Dropbox",
+  "modal_dropboxauth_maualinput_conn_succ": "很好！我们作为用户 {{username}} 连接到 Dropbox 了！",
+  "modal_dropboxauth_maualinput_conn_succ_revoke": "您已作为用户 {{username}} 连接到 Dropbox。如果您想断开连接，点击此按钮。",
+  "modal_dropboxauth_maualinput_conn_fail": "连接 Dropbox 途中出错了。",
+  "modal_onedriveauth_shortdesc": "现在只支持个人版 OneDrive，（暂）不支持企业版。\n在浏览器中访问以下地址，然后按照网页提示操作。\n到了最后，您应该会被自动重定向回来 Obsidian。",
+  "modal_onedriveauth_copybutton": "点击此按钮从而复制鉴权 url",
+  "modal_onedriveauth_copynotice": "鉴权 url 已复制到剪贴板！",
+  "modal_onedriverevokeauth_step1": "第 1 步：用浏览器打开以下地址，点击本插件对应的“Edit”按钮，点击“Remove these permissions”按钮。",
+  "modal_onedriverevokeauth_step2": "第 2 步：点击以下按钮，清理本地保存的登录信息。",
+  "modal_onedriverevokeauth_clean": "清理本地保存的登录信息",
+  "modal_onedriverevokeauth_clean_desc": "您需要点击“清理”按钮。",
+  "modal_onedriverevokeauth_clean_button": "清理",
+  "modal_onedriverevokeauth_clean_notice": "已清理！",
+  "modal_onedriverevokeauth_clean_fail": "鉴权途中出错了。",
+  "modal_syncconfig_attn": "注意 1/2：此设置只同步（复制）整个 Obsidian 的配置文件夹，但是不会同步其它 . 开头的文件夹或文件。除了会忽略 .git 和 node_modules 文件夹之外，它也并不理解配置文件夹的里各个子文件或子文件夹的含义。\n注意 2/2：配置文件夹被同步之后，各插件的设置或许会出错，且 Obsidian 或许需要重启来重载各插件的新配置。\n如果您同意自行承受以上风险，您可以点击以下再次确认按钮。",
+  "modal_syncconfig_secondconfirm": "再次确认开启",
+  "modal_syncconfig_notice": "您已开启配置文件夹的同步！",
+  "modal_qr_shortdesc": "这里可导出非 oauth2 设置。（意味着：Dropbox 和 OneDrive 信息不会被导出。）\n您可以使用另一个设备来扫描此 QR 码。\n又或者，您可以点击以下按钮复制此特殊 URI。",
+  "modal_qr_button": "点击此按钮复制特殊 URI",
+  "modal_qr_button_notice": "特殊 URI 已被复制到剪贴板！",
+  "modal_sizesconflict_title": "Remotely Save：跳过大文件的时候出现了一些冲突",
+  "modal_sizesconflict_desc": "您设置了跳过同步大于 {{thresholdMB}} MB（{{thresholdBytes}} bytes）的文件。\n但是以下文件的大小，在一端大于阈值，在另一端则小于阈值。\n为了避免意外的覆盖或删除，插件停止了运作，您需要手动处理至少一端的文件。",
+  "modal_sizesconflict_copybutton": "点击以复制以下所有文件大小冲突信息",
+  "modal_sizesconflict_copynotice": "所有的文件大小冲突信息，已被复制到剪贴板！",
+  "modal_logtohttpserver_title": "转发终端日志到 HTTP 服务器，此操作很危险！",
+  "modal_logtohttpserver_desc": "所有您的带敏感信息的终端日志，都会被转发到 HTTP(S) 服务器，没有任何鉴权！！！！！\n请确保您信任对应的服务器，最好设置为 HTTPS 而不是 HTTP。\n仅仅用于 debug 用途，例如手机上的 debug。",
+  "modal_logtohttpserver_secondconfirm": "我知道很危险，坚持要设置，愿意承担所有可能损失。",
+  "modal_logtohttpserver_notice": "已设置。",
+  "settings_basic": "基本设置",
+  "settings_password": "密码",
+  "settings_password_desc": "端到端加密的密码。不填写则代表没密码。您需要点击“确认”来修改。注意：密码和其它信息都会在本地保存。",
+  "settings_autorun": "自动运行",
+  "settings_autorun_desc": "每隔一段时间，此插件尝试自动同步。会影响到电池用量。",
+  "settings_autorun_notset": "（不设置）",
+  "settings_autorun_1min": "每 1 分钟",
+  "settings_autorun_5min": "每 5 分钟",
+  "settings_autorun_10min": "每 10 分钟",
+  "settings_autorun_30min": "每 30 分钟",
+  "settings_runoncestartup": "启动后自动运行一次",
+  "settings_runoncestartup_desc": "本设置使得插件在程序启动后自动触发一次同步。修改后，会在下一次启动生效。本设置和“自动运行”是不同的，那个设置是指“每隔一段时间”都自动同步一次。",
+  "settings_runoncestartup_notset": "（不设置）",
+  "settings_runoncestartup_1sec": "启动后第 1 秒运行一次",
+  "settings_runoncestartup_10sec": "启动后第 10 秒运行一次",
+  "settings_runoncestartup_30sec": "启动后第 30 秒运行一次",
+  "settings_saverun": "保存时同步（实验性质）",
+  "settings_saverun_desc": "插件如果检查到当前文件在最近一段时间有修改保存过，则尝试同步。请注意，同步是一个很重的操作，因此会影响到耗电量。（修改设置后可能需要重载插件或重启。）",
+  "settings_saverun_notset": "（不设置）",
+  "settings_saverun_1sec": "隔 1 秒检查一次",
+  "settings_saverun_5sec": "隔 5 秒检查一次",
+  "settings_saverun_10sec": "隔 10 秒检查一次（推荐）",
+  "settings_saverun_1min": "隔 1 分钟检查一次",
+  "settings_skiplargefiles": "跳过大文件",
+  "settings_skiplargefiles_desc": "跳过大于某一个阈值的文件。这里 1 MB = 10^6 bytes。",
+  "settings_skiplargefiles_notset": "（不设置）",
+
+  "settings_ignorepaths": "忽略的文件或文件夹的正则表达式",
+  "settings_ignorepaths_desc": "忽略的文件或文件夹的正则表达式。每行一条。路径是相对于库（Vault）根目录的，没有前置 / 符号。",
+  "settings_enablestatusbar_info": "在状态栏显示上一次成功的同步",
+  "settings_enablestatusbar_info_desc": "在状态栏显示上一次成功的同步的时间。",
+  "settings_enablestatusbar_reloadrequired_notice": "需要重新载入此插件才生效。",
+  "settings_resetstatusbar_time": "重设上一次成功同步的时间记录",
+  "settings_resetstatusbar_time_desc": "重设上一次成功同步的时间记录。",
+  "settings_resetstatusbar_button": "重设",
+  "settings_resetstatusbar_notice": "重设完毕！",
+
+  "settings_checkonnectivity": "检查可否连接",
+  "settings_checkonnectivity_desc": "检查可否连接。",
+  "settings_checkonnectivity_button": "检查",
+  "settings_checkonnectivity_checking": "正在检查……",
+  "settings_remotebasedir": "修改远端基文件夹（实验性质）",
+  "settings_remotebasedir_desc": "默认设定，内容会被同步到远端的和资料库同名的文件夹下。您可以在此修改远端文件夹名，或删除输入框文本从而重设到默认值。您需要点击“确认”。",
+  "settings_remoteprefix": "修改远端前缀路径（实验性质）",
+  "settings_remoteprefix_desc": "默认设定 s3 保存在存储桶（Bucket）的根目录。您可以在这里修改路径前缀，或者保持为空保持默认设置。您需要点击“确认”。",
+  "settings_s3": "S3 或兼容 S3 的服务的设置",
+  "settings_s3_disclaimer1": "声明：本插件不是 Amazon 的官方产品。",
+  "settings_s3_disclaimer2": "声明：您所输入的信息存储于本地。其它有害的或者出错的插件，是有可能读取到这些信息的。如果您发现了存储桶有不符合预期的访问，请立刻从 AWS（或其它 S3 服务商）删除记录于此的 access key。",
+  "settings_s3_cors": "您需要设置 CORS，从而允许这些源的请求访问：app://obsidian.md 和 capacitor://localhost 和 http://localhost 且增加 ETag 到暴露 headers 里。",
+  "settings_s3_prod": "一些可参考的 Amazon S3 官方文档：",
+  "settings_s3_prod1": "服务地址（Endpoint）和区域（Region）信息",
+  "settings_s3_prod2": "Access Key ID 和 Secret Access Key 信息",
+  "settings_s3_prod3": "设置 CORS",
+  "settings_s3_endpoint": "服务地址（Endpoint）",
+  "settings_s3_region": "区域（Region）",
+  "settings_s3_region_desc": "如果您不知道这个值填什么，可以尝试填写此默认值：us-east-1",
+  "settings_s3_accesskeyid": "Access Key ID",
+  "settings_s3_accesskeyid_desc": "Access key ID。注意：access key ID 和其它信息都会在本地保存。",
+  "settings_s3_secretaccesskey": "Secret Access Key",
+  "settings_s3_secretaccesskey_desc": "Secret access key。注意：secret access key 和其它信息都会在本地保存。",
+  "settings_s3_bucketname": "存储桶（Bucket）的名字",
+  "settings_s3_bypasscorslocally": "本地绕过 CORS 问题",
+  "settings_s3_bypasscorslocally_desc": "对于 Obsidian 新版本（桌面版>=0.13.25 或 iOS>=1.1.1 或 Android>=1.2.1），本插件可以跳过服务器设置 CORS 的步骤。如果您遇到任意问题，可以关闭此设定，并在服务端设置 CORS（允许来自 app://obsidian.md 和 capacitor://localhost 和 http://localhost 的请求且增加 ETag 到暴露 headers 里）。",
+  "settings_s3_parts": "分块并行度",
+  "settings_s3_parts_desc": "在 S3 里，大文件会被分块上传。您希望同一时间最多有多少个分块被上传？",
+  "settings_s3_urlstyle": "S3 URL style",
+  "settings_s3_urlstyle_desc": "是否对 S3 对象强制使用 path style URL（例如使用 https://s3.amazonaws.com/*/ 而不是 https://*.s3.amazonaws.com/）。",
+  "settings_s3_connect_succ": "很好！可以访问到对应存储桶。",
+  "settings_s3_connect_fail": "无法访问到对应存储桶。",
+  "settings_dropbox": "Dropbox 设置",
+  "settings_dropbox_disclaimer1": "声明：此插件不是 Dropbox 官方产品。",
+  "settings_dropbox_disclaimer2": "声明：您所输入的信息存储于本地。其它有害的或者出错的插件，是有可能读取到这些信息的。如果您发现了 Dropbox 有不符合预期的访问，请立刻从 https://www.dropbox.com/account/connected_apps 删除记录于此插件的连接鉴权。",
+  "settings_dropbox_folder": "我们会在您的 Dropbox 上创建此文件夹并在里面同步：/Apps/{{pluginID}}/{{remoteBaseDir}}。",
+  "settings_dropbox_revoke": "撤回鉴权",
+  "settings_dropbox_revoke_desc": "您现在使用了用户名 {{username}} 来连接。如果想取消连接，请点击此按钮。",
+  "settings_dropbox_revoke_button": "撤回鉴权",
+  "settings_dropbox_revoke_notice": "鉴权已被撤回！",
+  "settings_dropbox_revoke_noticeerr": "撤回鉴权出错。",
+  "settings_dropbox_clearlocal": "清除本地保存的鉴权信息",
+  "settings_dropbox_clearlocal_desc": "您可以强制清除本地已保存的 Dropbox 的登录鉴权信息，但不向服务器发送撤回鉴权的请求。",
+  "settings_dropbox_clearlocal_button": "清除",
+  "settings_dropbox_clearlocal_notice": "已清除！",
+  "settings_dropbox_auth": "鉴权",
+  "settings_dropbox_auth_desc": "鉴权。",
+  "settings_dropbox_auth_button": "鉴权",
+  "settings_dropbox_connect_succ": "很好！我们可连接上 Dropbox！",
+  "settings_dropbox_connect_fail": "我们未能连接上 Dropbox。",
+  "settings_onedrive": "Onedrive（个人版）设置",
+  "settings_onedrive_disclaimer1": "声明：此插件不是微软或 OneDrive 的官方产品。",
+  "settings_onedrive_disclaimer2": "声明：您所输入的信息存储于本地。其它有害的或者出错的插件，是有可能读取到这些信息的。如果您发现了 OneDrive 有不符合预期的访问，请立刻从 https://microsoft.com/consent 删除记录于此插件的连接鉴权。",
+  "settings_onedrive_folder": "我们会在您的 OneDrive 上创建此文件夹并在里面同步：/Apps/{{pluginID}}/{{remoteBaseDir}}。",
+  "settings_onedrive_nobiz": "现在只支持个人版 OneDrive。（暂时）并不支持企业版 OneDrive。",
+  "settings_onedrive_revoke": "撤回鉴权",
+  "settings_onedrive_revoke_desc": "您现在使用了用户名 {{username}} 来连接。如果想取消连接，请点击此按钮。",
+  "settings_onedrive_revoke_button": "撤回鉴权",
+  "settings_onedrive_auth": "鉴权",
+  "settings_onedrive_auth_desc": "鉴权。",
+  "settings_onedrive_auth_button": "鉴权",
+  "settings_onedrive_connect_succ": "很好！我们可连接上 OneDrive！",
+  "settings_onedrive_connect_fail": "我们未能连接上 OneDrive。",
+  "settings_webdav": "Webdav 设置",
+  "settings_webdav_disclaimer1": "声明：您所输入的信息存储于本地。其它有害的或者出错的插件，是有可能读取到这些信息的。如果您发现了 Webdav 服务器有不符合预期的访问，请立刻修改用户名和密码。",
+  "settings_webdav_cors_os": "Obsidian 桌面版>=0.13.25 或 iOS>=1.1.1 或 Android>=1.2.1 支持跳过 CORS 设置。但您正在使用旧版，建议升级。",
+  "settings_webdav_cors": "您需要设置 CORS，允许来自这些源的请求：app://obsidian.md 和 capacitor://localhost 和 http://localhost。",
+  "settings_webdav_folder": "我们会在您的服务器上创建此文件夹并在里面同步：/{{remoteBaseDir}}",
+  "settings_webdav_addr": "服务器地址",
+  "settings_webdav_addr_desc": "服务器地址。",
+  "settings_webdav_user": "用户名",
+  "settings_webdav_user_desc": "用户名。注意：用户名和其它信息都会保存在本地。",
+  "settings_webdav_password": "密码",
+  "settings_webdav_password_desc": "密码。注意：密码和其它信息都会保存在本地。",
+  "settings_webdav_auth": "鉴权类型",
+  "settings_webdav_auth_desc": "如果不填写密码，本设置会被忽略。",
+  "settings_webdav_depth": "发送到服务器的 Depth header",
+  "settings_webdav_depth_desc": "Webdav 服务器会被设为接收 Depth header 为“1”或“Infinity”请求。本插件需要得知此信息。如果您不清楚如何设置，可以选择“自动检测”",
+  "settings_webdav_depth_auto": "自动检测",
+  "settings_webdav_depth_1": "只支持 depth='1'",
+  "settings_webdav_depth_inf": "支持 depth='infinity'",
+  "settings_webdav_connect_succ": "很好！可以连接上 Webdav 服务器。",
+  "settings_webdav_connect_fail": "无法连接上 Webdav 服务器。（可能是地址/账号/密码/鉴权类型等错误。）",
+  "settings_webdav_connect_fail_withcors": "无法连接上 Webdav 服务器。（可能是地址/账号/密码/鉴权类型/CORS 等错误。）",
+  "settings_chooseservice": "选择远程服务",
+  "settings_chooseservice_desc": "从这里开始设置。您想连接到哪一个服务？S3、Dropbox、Webdav、OneDrive（个人版）？",
+  "settings_chooseservice_s3": "S3 或兼容 S3 的服务",
+  "settings_chooseservice_dropbox": "Dropbox",
+  "settings_chooseservice_webdav": "Webdav",
+  "settings_chooseservice_onedrive": "OneDrive（个人版）",
+  "settings_adv": "进阶设置",
+  "settings_concurrency": "并行度",
+  "settings_concurrency_desc": "您希望同时最多有多少个文件被上传和下载？默认值是 5。如果您遇到了一些问题（如访问频率限制），您可以减少并行度。",
+  "settings_syncunderscore": "同步 _ 文件或文件夹",
+  "settings_syncunderscore_desc": "是否同步“_”（下划线）开始的文件或文件夹。",
+  "settings_configdir": "同步配置文件夹（实验性质）",
+  "settings_configdir_desc": "是否同步 Obsidian 的配置文件夹 {{configDir}}（其中的 .git 和 node_modules 依然会被忽略）。请注意，此设置可能会影响到您 Obsidian 或者所有的插件设置，也可能需要您同步完毕后重启 Obsidian。如果您同意自行承受其风险，则可以开启本设置。",
+  "settings_deletetowhere": "删除文件到哪里",
+  "settings_deletetowhere_desc": "插件触发删除操作时候，删除到哪里？",
+  "settings_deletetowhere_system_trash": "系统回收站（默认）",
+  "settings_deletetowhere_obsidian_trash": "Obsidian .trash 文件夹",
+  "settings_importexport": "导入导出部分设置",
+  "settings_export": "导出",
+  "settings_export_desc": "用 QR 码导出非 oauth2 的设置信息。",
+  "settings_export_desc_button": "生成 QR 码",
+  "settings_import": "导入",
+  "settings_import_desc": "您需要使用系统拍摄 app 或者扫描 QR 码的app，来扫描对应的 QR 码。",
+  "settings_debug": "调试",
+  "settings_debuglevel": "修改终端输出的 level",
+  "settings_debuglevel_desc": "默认值为 \"info\"。您可以改为 \"debug\" 从而在终端里获取更多信息。",
+  "settings_outputsettingsconsole": "读取硬盘上的设置文件输出到终端",
+  "settings_outputsettingsconsole_desc": "硬盘上的设置文件是编码过的，点击这里从而解码并输出到终端。",
+  "settings_outputsettingsconsole_button": "输出",
+  "settings_outputsettingsconsole_notice": "已输出到终端",
+  "settings_syncplans": "导出同步计划",
+  "settings_syncplans_desc": "每次您启动同步，并在实际上传下载前，插件会生成同步计划。它可以使您知道每次同步发生了什么。点击按钮可以导出同步计划。并且，您可以选择导出为内嵌在 Markdown 里的 json 格式或表格格式，它们是等价的。",
+  "settings_syncplans_button_json": "导出（json）",
+  "settings_syncplans_button_table": "导出（表格）",
+  "settings_syncplans_notice": "同步计划已导出",
+  "settings_delsyncplans": "删除数据库里的同步计划历史",
+  "settings_delsyncplans_desc": "删除数据库里的同步计划历史。",
+  "settings_delsyncplans_button": "删除同步计划历史",
+  "settings_delsyncplans_notice": "（数据库里的）同步计划已被删除。",
+  "settings_logtodb": "保存终端日志到数据库",
+  "settings_logtodb_desc": "如果开启此设置，所有终端日志都会保存到数据，从而我们可以在之后导出和阅读它们。对于移动设备的调试较为有用。有性能成本，可能会影响电池用量。历史会保存最多 10000 条和 7 天时间。",
+  "settings_logtodbexport": "从数据库导出终端日志",
+  "settings_logtodbexport_desc": "从数据库导出本资料库的已保存的终端日志，输出到文件夹 {{&debugFolder}} 下的一个新文件内。",
+  "settings_logtodbexport_button": "导出",
+  "settings_logtodbexport_notice": "数据库内的本资料库的终端日志已导出！",
+  "settings_logtodbclear": "删除数据库的所有终端日志",
+  "settings_logtodbclear_desc": "删除数据库内的所有已保存的终端日志。本设置会影响本设备下所有资料库的所有已保存日志。",
+  "settings_logtodbclear_button": "删除",
+  "settings_logtodbclear_notice": "数据库内的所有终端日志已删除！",
+  "settings_logtohttpserver": "临时设定终端日志实时转发到 HTTP 服务器。",
+  "settings_logtohttpserver_desc": "非常危险，谨慎行动！！！！！临时设定终端日志实时转发到 HTTP 服务器。",
+  "settings_logtohttpserver_reset_notice": "移除了终端日志转发到 HTTP 服务器的设定。",
+  "settings_delsyncmap": "删除数据库里的同步映射历史",
+  "settings_delsyncmap_desc": "同步映射历史存储了本地真正的最后修改时间和远程文件时间的映射。删除之可能会导致下一次同步时发生不必要的数据交换。点击按钮删除数据库里的同步映射历史。",
+  "settings_delsyncmap_button": "删除同步映射历史",
+  "settings_delsyncmap_notice": "（本地数据库里的）同步映射历史已被删除。",
+  "settings_outputbasepathvaultid": "输出资料库对应的位置和随机分配的 ID",
+  "settings_outputbasepathvaultid_desc": "用于调试。",
+  "settings_outputbasepathvaultid_button": "输出",
+  "settings_resetcache": "重设本地缓存和数据库",
+  "settings_resetcache_desc": "（出于调试原因）重设本地缓存和数据库。您需要在重设之后重新载入此插件。本重设不会删除 s3，密码……等设定。",
+  "settings_resetcache_button": "重设",
+  "settings_resetcache_notice": "本地同步缓存和数据库已被删除。请手动重新载入此插件。",
+  "syncalgov2_title": "Remotely Save 的同步算法得到优化",
+  "syncalgov2_texts": "欢迎使用 Remotely Save!\n从版本 0.3.0 开始，它带来了新的同步算法，但是，除了您的笔记之外，它还需要上传额外的带有元信息的文件 _remotely-save-metadata-on-remote.{json,bin} 到您的云服务目的地上。\n从而，比如说，通过读取这些信息，另一台设备可以知道什么文件或文件夹在第一台设备上被删除了。\n如果您同意此策略，请点击按钮 \"同意\"，然后开始享用此插件！且特别要注意：使用插件之前，请首先备份好您的库（Vault）！\n如果您不同意此策略，您应该停止使用此版本和之后版本的 Remotely Save。您可以考虑手动安装旧版 0.2.14，它使用旧的同步算法，并不上传额外元信息文件。点击 \"不同意\" 之后，插件会自动停止运行（unload），然后您需要 Obsidian 设置里手动停用（disable）此插件。",
+  "syncalgov2_button_agree": "同意",
+  "syncalgov2_button_disagree": "不同意",
+
+  "official_notice_2024_first_party": "插件 Remotely-Save 回来了，更新了一大堆功能！🎉🎉🎉请自行使用，或参阅更新文档： https://github.com/remotely-save/remotely-save/releases 。"
+}

src/langs/zh_tw.json

@@ -0,0 +1,300 @@
+{
+  "confirm": "確認",
+  "disable": "關閉",
+  "enable": "開啟",
+  "goback": "返回",
+  "submit": "提交",
+  "sometext": "這裡有一段文字。",
+  "syncrun_alreadyrunning": "{{pluginName}} 正處於此階段：{{syncStatus}}!",
+  "syncrun_syncingribbon": "{{pluginName}}：正在由 {{triggerSource}} 觸發執行",
+  "syncrun_step0": "0/8 Remotely Save 在空跑（dry run）模式，不會發生實際的檔案交換。",
+  "syncrun_step1": "1/8 Remotely Save 準備同步（{{serviceType}}）",
+  "syncrun_step2": "2/8 正在獲取遠端的元資料。",
+  "syncrun_step3": "3/8 正在檢查密碼正確與否。",
+  "syncrun_passworderr": "檢查密碼時候出錯。",
+  "syncrun_step4": "4/8 正在獲取遠端的額外的元資料。",
+  "syncrun_step5": "5/8 正在獲取本地的元資料。",
+  "syncrun_step6": "6/8 正在生成同步計劃。",
+  "syncrun_step7": "7/8 Remotely Save 開始發生資料交換！",
+  "syncrun_step7skip": "7/8 Remotely Save 在空跑模式，跳過實際資料交換步驟。",
+  "syncrun_step8": "8/8 Remotely Save 已完成同步！",
+  "syncrun_shortstep0": "0/2 Remotely Save 在空跑（dry run）模式，不會發生實際的檔案交換。",
+  "syncrun_shortstep1": "1/2 Remotely Save 開始同步（{{serviceType}}）",
+  "syncrun_shortstep2skip": "2/2 Remotely Save 在空跑模式，跳過實際資料交換步驟。",
+  "syncrun_shortstep2": "2/2 Remotely Save 已完成同步！",
+  "syncrun_abort": "{{manifestID}}-{{theDate}}：中斷同步，同步來源={{triggerSource}}，出錯階段={{syncStatus}}",
+  "protocol_saveqr": " {{manifestName}} 新的非 oauth2 設定儲存完成。請重啟外掛設定頁使之生效。",
+  "protocol_callbacknotsupported": "您的 uri callback 暫不支援： {{params}}",
+  "protocol_dropbox_connecting": "正在連線 Dropbox……\n請不要關閉此彈窗。",
+  "protocol_dropbox_connect_succ": "好！我們作為使用者 {{username}} 連線上了 Dropbox！",
+  "protocol_dropbox_connect_succ_revoke": "您已作為使用者 {{username}} 連線上了。如果您想取消連線，請點選此按鈕。",
+  "protocol_dropbox_connect_fail": "Dropbox 的回撥請求有點異常。您是否拒絕了鑑權？",
+  "protocol_dropbox_connect_unknown": "不知道如何處理此 callback：{{params}}",
+  "protocol_onedrive_connecting": "正在連線 OneDrive……\n請不要關閉此彈窗。",
+  "protocol_onedrive_connect_succ_revoke": "您已作為使用者 {{username}} 連線上了。如果您想取消連線，請點選此按鈕。",
+  "protocol_onedrive_connect_fail": "OneDrive 的回撥請求有點異常。您是否拒絕了鑑權？",
+  "protocol_onedrive_connect_unknown": "不知道如何處理此 callback：{{params}}",
+  "command_startsync": "開始同步（start sync）",
+  "command_drynrun": "開始同步（空跑模式）（start sync (dry run only)）",
+  "command_exportsyncplans_json": "匯出同步計劃為 json 格式（export sync plans in json format）",
+  "command_exportsyncplans_table": "匯出同步計劃為表格格式（export sync plans in table format）",
+  "command_exportlogsindb": "從資料庫匯出終端日誌（export logs saved in db）",
+
+  "statusbar_time_years": "{{time}} 年前",
+  "statusbar_time_months": "{{time}} 月前",
+  "statusbar_time_weeks": "{{time}} 周前",
+  "statusbar_time_days": "{{time}} 天前",
+  "statusbar_time_hours": "{{time}} 小時前",
+  "statusbar_time_minutes": "{{time}} 分鐘前",
+  "statusbar_time_lessminute": "一分鐘之內",
+  "statusbar_lastsync": "上一次同步於：{{time}}",
+  "statusbar_lastsync_label": "上一次同步於：{{date}}",
+  "statusbar_lastsync_never": "沒觸發過同步",
+  "statusbar_lastsync_never_label": "沒觸發過同步",
+
+  "modal_password_title": "稍等一下，請閱讀下文：",
+  "modal_password_shortdesc": "如果密碼不是空的，那麼檔案會在上傳之前，在本地先用此密碼加密。\n如果密碼是空的，那麼檔案會被非加密地上傳。",
+  "modal_password_attn1": "注意 1/5：儲存庫（Vault）名字是不會加密的！本外掛會在一些遠端儲存裡建立一個和庫名字有著同名的資料夾。",
+  "modal_password_attn2": "注意 2/5：密碼在本地不加密地儲存！",
+  "modal_password_attn3": "注意 3/5：一些元資訊是沒有被加密的，或者可以被較容易地猜測出來。（檔案大小很接近於沒加密的時候，且資料夾可能會被儲存為大小為 0 byte 的物件。）",
+  "modal_password_attn4": "注意 4/5：您需要確保遠端儲存是“空”的，或者已有檔案也是被同一個新密碼加密的；從而避免衝突。",
+  "modal_password_attn5": "注意 5/5：密碼越長越好。",
+  "modal_password_secondconfirm": "再次確認儲存新密碼",
+  "modal_password_notice": "新密碼已儲存！",
+  "modal_remotebasedir_title": "您正在修改遠端基資料夾設定",
+  "modal_remotebasedir_shortdesc": "1. 本外掛並不會自動在遠端把內容從舊資料夾移動到新資料夾。所有內容都會重新同步。\n2. 如果你使得文字輸入框為空，那麼本設定會被重設回庫的資料夾名（預設設定）。\n3. 即使您設定了端對端加密的密碼，遠端資料夾名稱本身也不會被加密。\n4. 某些特殊字元，如“?”、“/”、“\\”是不允許的。文字前後的空格也會被自動刪去。",
+  "modal_remotebasedir_invaliddirhint": "您所輸入的內容含有某些特殊字元，如“?”、“/”、“\\”，它們是不允許的。",
+  "modal_remotebasedir_secondconfirm_vaultname": "重設回預設的庫資料夾名",
+  "modal_remotebasedir_secondconfirm_change": "確認修改",
+  "modal_remotebasedir_notice": "新的遠端基資料夾設定已儲存！",
+  "modal_remoteprefix_title": "您正在修改遠端路徑字首設定",
+  "modal_remoteprefix_shortdesc": "1. 本外掛並不會自動在遠端把內容從舊資料夾移動到新資料夾。所有內容都會重新同步。\n2. 如果你使得文字輸入框為空，那麼本設定為儲存為空，檔案將會被儲存在桶（Bucket）的根目錄。\n3. 即使您設定了端對端加密的密碼，遠端資料夾名稱本身也不會被加密。\n4. 某些特殊字元，如“?”、“/”、“\\”是不允許的。文字前後的空格也會被自動刪去。",
+  "modal_remoteprefix_invaliddirhint": "您所輸入的內容含有某些特殊字元，如“?”、“/”、“\\”，它們是不允許的。",
+  "modal_remoteprefix_tosave": "您設定的新字首為：“{{{prefix}}}”",
+  "modal_remoteprefix_secondconfirm_empty": "字首為空，檔案會儲存在根目錄",
+  "modal_remoteprefix_secondconfirm_change": "確認修改",
+  "modal_remoteprefix_notice": "新的遠端路徑字首設定已儲存！",
+  "modal_dropboxauth_manualsteps": "第 1 步：在瀏覽器中訪問以下地址，然後按照網頁提示操作。\n到了最後，您應該會獲得一串很長的程式碼文字，請複製貼上到下方，並點選“提交”",
+  "modal_dropboxauth_autosteps": "在瀏覽器中訪問以下地址，然後按照網頁提示操作。\n到了最後，您應該會被自動重定向回來 Obsidian。",
+  "modal_dropboxauth_copybutton": "點選此按鈕從而複製鑑權 url",
+  "modal_dropboxauth_copynotice": "鑑權 url 已複製到剪貼簿！",
+  "modal_dropboxauth_maualinput": "來自網頁的授權碼",
+  "modal_dropboxauth_maualinput_desc": "您需要點選“確認”",
+  "modal_dropboxauth_maualinput_notice": "正在嘗試連線 Dropbox",
+  "modal_dropboxauth_maualinput_conn_succ": "很好！我們作為使用者 {{username}} 連線到 Dropbox 了！",
+  "modal_dropboxauth_maualinput_conn_succ_revoke": "您已作為使用者 {{username}} 連線到 Dropbox。如果您想斷開連線，點選此按鈕。",
+  "modal_dropboxauth_maualinput_conn_fail": "連線 Dropbox 途中出錯了。",
+  "modal_onedriveauth_shortdesc": "現在只支援個人版 OneDrive，（暫）不支援企業版。\n在瀏覽器中訪問以下地址，然後按照網頁提示操作。\n到了最後，您應該會被自動重定向回來 Obsidian。",
+  "modal_onedriveauth_copybutton": "點選此按鈕從而複製鑑權 url",
+  "modal_onedriveauth_copynotice": "鑑權 url 已複製到剪貼簿！",
+  "modal_onedriverevokeauth_step1": "第 1 步：用瀏覽器開啟以下地址，點選本外掛對應的“Edit”按鈕，點選“Remove these permissions”按鈕。",
+  "modal_onedriverevokeauth_step2": "第 2 步：點選以下按鈕，清理本地儲存的登入資訊。",
+  "modal_onedriverevokeauth_clean": "清理本地儲存的登入資訊",
+  "modal_onedriverevokeauth_clean_desc": "您需要點選“清理”按鈕。",
+  "modal_onedriverevokeauth_clean_button": "清理",
+  "modal_onedriverevokeauth_clean_notice": "已清理！",
+  "modal_onedriverevokeauth_clean_fail": "鑑權途中出錯了。",
+  "modal_syncconfig_attn": "注意 1/2：此設定只同步（複製）整個 Obsidian 的配置資料夾，但是不會同步其它 . 開頭的資料夾或檔案。除了會忽略 .git 和 node_modules 資料夾之外，它也並不理解配置資料夾的裡各個子檔案或子資料夾的含義。\n注意 2/2：配置資料夾被同步之後，各外掛的設定或許會出錯，且 Obsidian 或許需要重啟來過載各外掛的新配置。\n如果您同意自行承受以上風險，您可以點選以下再次確認按鈕。",
+  "modal_syncconfig_secondconfirm": "再次確認開啟",
+  "modal_syncconfig_notice": "您已開啟配置資料夾的同步！",
+  "modal_qr_shortdesc": "這裡可匯出非 oauth2 設定。（意味著：Dropbox 和 OneDrive 資訊不會被匯出。）\n您可以使用另一個裝置來掃描此 QR 碼。\n又或者，您可以點選以下按鈕複製此特殊 URI。",
+  "modal_qr_button": "點選此按鈕複製特殊 URI",
+  "modal_qr_button_notice": "特殊 URI 已被複制到剪貼簿！",
+  "modal_sizesconflict_title": "Remotely Save：跳過大檔案的時候出現了一些衝突",
+  "modal_sizesconflict_desc": "您設定了跳過同步大於 {{thresholdMB}} MB（{{thresholdBytes}} bytes）的檔案。\n但是以下檔案的大小，在一端大於閾值，在另一端則小於閾值。\n為了避免意外的覆蓋或刪除，外掛停止了運作，您需要手動處理至少一端的檔案。",
+  "modal_sizesconflict_copybutton": "點選以複製以下所有檔案大小衝突資訊",
+  "modal_sizesconflict_copynotice": "所有的檔案大小衝突資訊，已被複制到剪貼簿！",
+  "modal_logtohttpserver_title": "轉發終端日誌到 HTTP 伺服器，此操作很危險！",
+  "modal_logtohttpserver_desc": "所有您的帶敏感資訊的終端日誌，都會被轉發到 HTTP(S) 伺服器，沒有任何鑑權！！！！！\n請確保您信任對應的伺服器，最好設定為 HTTPS 而不是 HTTP。\n僅僅用於 debug 用途，例如手機上的 debug。",
+  "modal_logtohttpserver_secondconfirm": "我知道很危險，堅持要設定，願意承擔所有可能損失。",
+  "modal_logtohttpserver_notice": "已設定。",
+  "settings_basic": "基本設定",
+  "settings_password": "密碼",
+  "settings_password_desc": "端到端加密的密碼。不填寫則代表沒密碼。您需要點選“確認”來修改。注意：密碼和其它資訊都會在本地儲存。",
+  "settings_autorun": "自動執行",
+  "settings_autorun_desc": "每隔一段時間，此外掛嘗試自動同步。會影響到電池用量。",
+  "settings_autorun_notset": "（不設定）",
+  "settings_autorun_1min": "每 1 分鐘",
+  "settings_autorun_5min": "每 5 分鐘",
+  "settings_autorun_10min": "每 10 分鐘",
+  "settings_autorun_30min": "每 30 分鐘",
+  "settings_runoncestartup": "啟動後自動執行一次",
+  "settings_runoncestartup_desc": "本設定使得外掛在程式啟動後自動觸發一次同步。修改後，會在下一次啟動生效。本設定和“自動執行”是不同的，那個設定是指“每隔一段時間”都自動同步一次。",
+  "settings_runoncestartup_notset": "（不設定）",
+  "settings_runoncestartup_1sec": "啟動後第 1 秒執行一次",
+  "settings_runoncestartup_10sec": "啟動後第 10 秒執行一次",
+  "settings_runoncestartup_30sec": "啟動後第 30 秒執行一次",
+  "settings_saverun": "儲存時同步（實驗性質）",
+  "settings_saverun_desc": "外掛如果檢查到當前檔案在最近一段時間有修改儲存過，則嘗試同步。請注意，同步是一個很重的操作，因此會影響到耗電量。（修改設定後可能需要過載外掛或重啟。）",
+  "settings_saverun_notset": "（不設定）",
+  "settings_saverun_1sec": "隔 1 秒檢查一次",
+  "settings_saverun_5sec": "隔 5 秒檢查一次",
+  "settings_saverun_10sec": "隔 10 秒檢查一次（推薦）",
+  "settings_saverun_1min": "隔 1 分鐘檢查一次",
+  "settings_skiplargefiles": "跳過大檔案",
+  "settings_skiplargefiles_desc": "跳過大於某一個閾值的檔案。這裡 1 MB = 10^6 bytes。",
+  "settings_skiplargefiles_notset": "（不設定）",
+
+  "settings_ignorepaths": "忽略的檔案或資料夾的正則表示式",
+  "settings_ignorepaths_desc": "忽略的檔案或資料夾的正則表示式。每行一條。路徑是相對於庫（Vault）根目錄的，沒有前置 / 符號。",
+  "settings_enablestatusbar_info": "在狀態列顯示上一次成功的同步",
+  "settings_enablestatusbar_info_desc": "在狀態列顯示上一次成功的同步的時間。",
+  "settings_enablestatusbar_reloadrequired_notice": "需要重新載入此外掛才生效。",
+  "settings_resetstatusbar_time": "重設上一次成功同步的時間記錄",
+  "settings_resetstatusbar_time_desc": "重設上一次成功同步的時間記錄。",
+  "settings_resetstatusbar_button": "重設",
+  "settings_resetstatusbar_notice": "重設完畢！",
+
+  "settings_checkonnectivity": "檢查可否連線",
+  "settings_checkonnectivity_desc": "檢查可否連線。",
+  "settings_checkonnectivity_button": "檢查",
+  "settings_checkonnectivity_checking": "正在檢查……",
+  "settings_remotebasedir": "修改遠端基資料夾（實驗性質）",
+  "settings_remotebasedir_desc": "預設設定，內容會被同步到遠端的和資料庫同名的資料夾下。您可以在此修改遠端資料夾名，或刪除輸入框文字從而重設到預設值。您需要點選“確認”。",
+  "settings_remoteprefix": "修改遠端字首路徑（實驗性質）",
+  "settings_remoteprefix_desc": "預設設定 s3 儲存在儲存桶（Bucket）的根目錄。您可以在這裡修改路徑字首，或者保持為空保持預設設定。您需要點選“確認”。",
+  "settings_s3": "S3 或相容 S3 的服務的設定",
+  "settings_s3_disclaimer1": "宣告：本外掛不是 Amazon 的官方產品。",
+  "settings_s3_disclaimer2": "宣告：您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛，是有可能讀取到這些資訊的。如果您發現了儲存桶有不符合預期的訪問，請立刻從 AWS（或其它 S3 服務商）刪除記錄於此的 access key。",
+  "settings_s3_cors": "您需要設定 CORS，從而允許這些源的請求訪問：app://obsidian.md 和 capacitor://localhost 和 http://localhost 且增加 ETag 到暴露 headers 裡。",
+  "settings_s3_prod": "一些可參考的 Amazon S3 官方文件：",
+  "settings_s3_prod1": "服務地址（Endpoint）和區域（Region）資訊",
+  "settings_s3_prod2": "Access Key ID 和 Secret Access Key 資訊",
+  "settings_s3_prod3": "設定 CORS",
+  "settings_s3_endpoint": "服務地址（Endpoint）",
+  "settings_s3_region": "區域（Region）",
+  "settings_s3_region_desc": "如果您不知道這個值填什麼，可以嘗試填寫此預設值：us-east-1",
+  "settings_s3_accesskeyid": "Access Key ID",
+  "settings_s3_accesskeyid_desc": "Access key ID。注意：access key ID 和其它資訊都會在本地儲存。",
+  "settings_s3_secretaccesskey": "Secret Access Key",
+  "settings_s3_secretaccesskey_desc": "Secret access key。注意：secret access key 和其它資訊都會在本地儲存。",
+  "settings_s3_bucketname": "儲存桶（Bucket）的名字",
+  "settings_s3_bypasscorslocally": "本地繞過 CORS 問題",
+  "settings_s3_bypasscorslocally_desc": "對於 Obsidian 新版本（桌面版>=0.13.25 或 iOS>=1.1.1 或 Android>=1.2.1），本外掛可以跳過伺服器設定 CORS 的步驟。如果您遇到任意問題，可以關閉此設定，並在服務端設定 CORS（允許來自 app://obsidian.md 和 capacitor://localhost 和 http://localhost 的請求且增加 ETag 到暴露 headers 裡）。",
+  "settings_s3_parts": "分塊並行度",
+  "settings_s3_parts_desc": "在 S3 裡，大檔案會被分塊上傳。您希望同一時間最多有多少個分塊被上傳？",
+  "settings_s3_urlstyle": "S3 URL style",
+  "settings_s3_urlstyle_desc": "是否對 S3 物件強制使用 path style URL（例如使用 https://s3.amazonaws.com/*/ 而不是 https://*.s3.amazonaws.com/）。",
+  "settings_s3_connect_succ": "很好！可以訪問到對應儲存桶。",
+  "settings_s3_connect_fail": "無法訪問到對應儲存桶。",
+  "settings_dropbox": "Dropbox 設定",
+  "settings_dropbox_disclaimer1": "宣告：此外掛不是 Dropbox 官方產品。",
+  "settings_dropbox_disclaimer2": "宣告：您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛，是有可能讀取到這些資訊的。如果您發現了 Dropbox 有不符合預期的訪問，請立刻從 https://www.dropbox.com/account/connected_apps 刪除記錄於此外掛的連線鑑權。",
+  "settings_dropbox_folder": "我們會在您的 Dropbox 上建立此資料夾並在裡面同步：/Apps/{{pluginID}}/{{remoteBaseDir}}。",
+  "settings_dropbox_revoke": "撤回鑑權",
+  "settings_dropbox_revoke_desc": "您現在使用了使用者名稱 {{username}} 來連線。如果想取消連線，請點選此按鈕。",
+  "settings_dropbox_revoke_button": "撤回鑑權",
+  "settings_dropbox_revoke_notice": "鑑權已被撤回！",
+  "settings_dropbox_revoke_noticeerr": "撤回鑑權出錯。",
+  "settings_dropbox_clearlocal": "清除本地儲存的鑑權資訊",
+  "settings_dropbox_clearlocal_desc": "您可以強制清除本地已儲存的 Dropbox 的登入鑑權資訊，但不向伺服器傳送撤回鑑權的請求。",
+  "settings_dropbox_clearlocal_button": "清除",
+  "settings_dropbox_clearlocal_notice": "已清除！",
+  "settings_dropbox_auth": "鑑權",
+  "settings_dropbox_auth_desc": "鑑權。",
+  "settings_dropbox_auth_button": "鑑權",
+  "settings_dropbox_connect_succ": "很好！我們可連線上 Dropbox！",
+  "settings_dropbox_connect_fail": "我們未能連線上 Dropbox。",
+  "settings_onedrive": "Onedrive（個人版）設定",
+  "settings_onedrive_disclaimer1": "宣告：此外掛不是微軟或 OneDrive 的官方產品。",
+  "settings_onedrive_disclaimer2": "宣告：您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛，是有可能讀取到這些資訊的。如果您發現了 OneDrive 有不符合預期的訪問，請立刻從 https://microsoft.com/consent 刪除記錄於此外掛的連線鑑權。",
+  "settings_onedrive_folder": "我們會在您的 OneDrive 上建立此資料夾並在裡面同步：/Apps/{{pluginID}}/{{remoteBaseDir}}。",
+  "settings_onedrive_nobiz": "現在只支援個人版 OneDrive。（暫時）並不支援企業版 OneDrive。",
+  "settings_onedrive_revoke": "撤回鑑權",
+  "settings_onedrive_revoke_desc": "您現在使用了使用者名稱 {{username}} 來連線。如果想取消連線，請點選此按鈕。",
+  "settings_onedrive_revoke_button": "撤回鑑權",
+  "settings_onedrive_auth": "鑑權",
+  "settings_onedrive_auth_desc": "鑑權。",
+  "settings_onedrive_auth_button": "鑑權",
+  "settings_onedrive_connect_succ": "很好！我們可連線上 OneDrive！",
+  "settings_onedrive_connect_fail": "我們未能連線上 OneDrive。",
+  "settings_webdav": "Webdav 設定",
+  "settings_webdav_disclaimer1": "宣告：您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛，是有可能讀取到這些資訊的。如果您發現了 Webdav 伺服器有不符合預期的訪問，請立刻修改使用者名稱和密碼。",
+  "settings_webdav_cors_os": "Obsidian 桌面版>=0.13.25 或 iOS>=1.1.1 或 Android>=1.1.1 支援跳過 CORS 設定。但您正在使用舊版，建議升級。",
+  "settings_webdav_cors": "您需要設定 CORS，允許來自這些源的請求：app://obsidian.md 和 capacitor://localhost 和 http://localhost。",
+  "settings_webdav_folder": "我們會在您的伺服器上建立此資料夾並在裡面同步：/{{remoteBaseDir}}",
+  "settings_webdav_addr": "伺服器地址",
+  "settings_webdav_addr_desc": "伺服器地址。",
+  "settings_webdav_user": "使用者名稱",
+  "settings_webdav_user_desc": "使用者名稱。注意：使用者名稱和其它資訊都會儲存在本地。",
+  "settings_webdav_password": "密碼",
+  "settings_webdav_password_desc": "密碼。注意：密碼和其它資訊都會儲存在本地。",
+  "settings_webdav_auth": "鑑權型別",
+  "settings_webdav_auth_desc": "如果不填寫密碼，本設定會被忽略。",
+  "settings_webdav_depth": "傳送到伺服器的 Depth header",
+  "settings_webdav_depth_desc": "Webdav 伺服器會被設為接收 Depth header 為“1”或“Infinity”請求。本外掛需要得知此資訊。如果您不清楚如何設定，可以選擇“自動檢測”",
+  "settings_webdav_depth_auto": "自動檢測",
+  "settings_webdav_depth_1": "只支援 depth='1'",
+  "settings_webdav_depth_inf": "支援 depth='infinity'",
+  "settings_webdav_connect_succ": "很好！可以連線上 Webdav 伺服器。",
+  "settings_webdav_connect_fail": "無法連線上 Webdav 伺服器。（可能是地址/賬號/密碼/鑑權型別等錯誤。）",
+  "settings_webdav_connect_fail_withcors": "無法連線上 Webdav 伺服器。（可能是地址/賬號/密碼/鑑權型別/CORS 等錯誤。）",
+  "settings_chooseservice": "選擇遠端服務",
+  "settings_chooseservice_desc": "從這裡開始設定。您想連線到哪一個服務？S3、Dropbox、Webdav、OneDrive（個人版）？",
+  "settings_chooseservice_s3": "S3 或相容 S3 的服務",
+  "settings_chooseservice_dropbox": "Dropbox",
+  "settings_chooseservice_webdav": "Webdav",
+  "settings_chooseservice_onedrive": "OneDrive（個人版）",
+  "settings_adv": "進階設定",
+  "settings_concurrency": "並行度",
+  "settings_concurrency_desc": "您希望同時最多有多少個檔案被上傳和下載？預設值是 5。如果您遇到了一些問題（如訪問頻率限制），您可以減少並行度。",
+  "settings_syncunderscore": "同步 _ 檔案或資料夾",
+  "settings_syncunderscore_desc": "是否同步“_”（下劃線）開始的檔案或資料夾。",
+  "settings_configdir": "同步配置資料夾（實驗性質）",
+  "settings_configdir_desc": "是否同步 Obsidian 的配置資料夾 {{configDir}}（其中的 .git 和 node_modules 依然會被忽略）。請注意，此設定可能會影響到您 Obsidian 或者所有的外掛設定，也可能需要您同步完畢後重啟 Obsidian。如果您同意自行承受其風險，則可以開啟本設定。",
+  "settings_deletetowhere": "刪除檔案到哪裡",
+  "settings_deletetowhere_desc": "外掛觸發刪除操作時候，刪除到哪裡？",
+  "settings_deletetowhere_system_trash": "系統回收站（預設）",
+  "settings_deletetowhere_obsidian_trash": "Obsidian .trash 資料夾",
+  "settings_importexport": "匯入匯出部分設定",
+  "settings_export": "匯出",
+  "settings_export_desc": "用 QR 碼匯出非 oauth2 的設定資訊。",
+  "settings_export_desc_button": "生成 QR 碼",
+  "settings_import": "匯入",
+  "settings_import_desc": "您需要使用系統拍攝 app 或者掃描 QR 碼的app，來掃描對應的 QR 碼。",
+  "settings_debug": "除錯",
+  "settings_debuglevel": "修改終端輸出的 level",
+  "settings_debuglevel_desc": "預設值為 \"info\"。您可以改為 \"debug\" 從而在終端裡獲取更多資訊。",
+  "settings_outputsettingsconsole": "讀取硬碟上的設定檔案輸出到終端",
+  "settings_outputsettingsconsole_desc": "硬碟上的設定檔案是編碼過的，點選這裡從而解碼並輸出到終端。",
+  "settings_outputsettingsconsole_button": "輸出",
+  "settings_outputsettingsconsole_notice": "已輸出到終端",
+  "settings_syncplans": "匯出同步計劃",
+  "settings_syncplans_desc": "每次您啟動同步，並在實際上傳下載前，外掛會生成同步計劃。它可以使您知道每次同步發生了什麼。點選按鈕可以匯出同步計劃。並且，您可以選擇匯出為內嵌在 Markdown 裡的 json 格式或表格格式，它們是等價的。",
+  "settings_syncplans_button_json": "匯出（json）",
+  "settings_syncplans_button_table": "匯出（表格）",
+  "settings_syncplans_notice": "同步計劃已匯出",
+  "settings_delsyncplans": "刪除資料庫裡的同步計劃歷史",
+  "settings_delsyncplans_desc": "刪除資料庫裡的同步計劃歷史。",
+  "settings_delsyncplans_button": "刪除同步計劃歷史",
+  "settings_delsyncplans_notice": "（資料庫裡的）同步計劃已被刪除。",
+  "settings_logtodb": "儲存終端日誌到資料庫",
+  "settings_logtodb_desc": "如果開啟此設定，所有終端日誌都會儲存到資料，從而我們可以在之後匯出和閱讀它們。對於移動裝置的除錯較為有用。有效能成本，可能會影響電池用量。歷史會儲存最多 10000 條和 7 天時間。",
+  "settings_logtodbexport": "從資料庫匯出終端日誌",
+  "settings_logtodbexport_desc": "從資料庫匯出本資料庫的已儲存的終端日誌，輸出到資料夾 {{&debugFolder}} 下的一個新檔案內。",
+  "settings_logtodbexport_button": "匯出",
+  "settings_logtodbexport_notice": "資料庫內的本資料庫的終端日誌已匯出！",
+  "settings_logtodbclear": "刪除資料庫的所有終端日誌",
+  "settings_logtodbclear_desc": "刪除資料庫內的所有已儲存的終端日誌。本設定會影響本裝置下所有資料庫的所有已儲存日誌。",
+  "settings_logtodbclear_button": "刪除",
+  "settings_logtodbclear_notice": "資料庫內的所有終端日誌已刪除！",
+  "settings_logtohttpserver": "臨時設定終端日誌實時轉發到 HTTP 伺服器。",
+  "settings_logtohttpserver_desc": "非常危險，謹慎行動！！！！！臨時設定終端日誌實時轉發到 HTTP 伺服器。",
+  "settings_logtohttpserver_reset_notice": "移除了終端日誌轉發到 HTTP 伺服器的設定。",
+  "settings_delsyncmap": "刪除資料庫裡的同步對映歷史",
+  "settings_delsyncmap_desc": "同步對映歷史儲存了本地真正的最後修改時間和遠端檔案時間的對映。刪除之可能會導致下一次同步時發生不必要的資料交換。點選按鈕刪除資料庫裡的同步對映歷史。",
+  "settings_delsyncmap_button": "刪除同步對映歷史",
+  "settings_delsyncmap_notice": "（本地資料庫裡的）同步對映歷史已被刪除。",
+  "settings_outputbasepathvaultid": "輸出資料庫對應的位置和隨機分配的 ID",
+  "settings_outputbasepathvaultid_desc": "用於除錯。",
+  "settings_outputbasepathvaultid_button": "輸出",
+  "settings_resetcache": "重設本地快取和資料庫",
+  "settings_resetcache_desc": "（出於除錯原因）重設本地快取和資料庫。您需要在重設之後重新載入此外掛。本重設不會刪除 s3，密碼……等設定。",
+  "settings_resetcache_button": "重設",
+  "settings_resetcache_notice": "本地同步快取和資料庫已被刪除。請手動重新載入此外掛。",
+  "syncalgov2_title": "Remotely Save 的同步演算法得到最佳化",
+  "syncalgov2_texts": "歡迎使用 Remotely Save!\n從版本 0.3.0 開始，它帶來了新的同步演算法，但是，除了您的筆記之外，它還需要上傳額外的帶有元資訊的檔案 _remotely-save-metadata-on-remote.{json,bin} 到您的雲服務目的地上。\n從而，比如說，透過讀取這些資訊，另一臺裝置可以知道什麼檔案或資料夾在第一臺裝置上被刪除了。\n如果您同意此策略，請點選按鈕 \"同意\"，然後開始享用此外掛！且特別要注意：使用外掛之前，請首先備份好您的儲存庫（Vault）！\n如果您不同意此策略，您應該停止使用此版本和之後版本的 Remotely Save。您可以考慮手動安裝舊版 0.2.14，它使用舊的同步演算法，並不上傳額外元資訊檔案。點選 \"不同意\" 之後，外掛會自動停止執行（unload），然後您需要 Obsidian 設定裡手動停用（disable）此外掛。",
+  "syncalgov2_button_agree": "同意",
+  "syncalgov2_button_disagree": "不同意",
+  "official_notice_2024_first_party": "外掛 Remotely-Save 回來了，更新了一大堆功能！🎉🎉🎉請自行使用，或參閱更新文件： https://github.com/remotely-save/remotely-save/releases 。"
+}

src/localdb.ts

@@ -1,21 +1,24 @@
 import localforage from "localforage";
-import { TAbstractFile, TFile, TFolder } from "obsidian";
-
-import type { SUPPORTED_SERVICES_TYPE } from "./baseTypes";
-import type { SyncPlanType } from "./sync";
-
 export type LocalForage = typeof localforage;
+import { nanoid } from "nanoid";
+import { requireApiVersion, TAbstractFile, TFile, TFolder } from "obsidian";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { API_VER_STAT_FOLDER, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
+import type { SyncPlanType } from "./sync";
+import { statFix, toText, unixTimeToStr } from "./misc";
 
-const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108];
-export const DEFAULT_DB_VERSION_NUMBER: number = 20220108;
+import { log } from "./moreOnLog";
+
+const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108, 20220326];
+export const DEFAULT_DB_VERSION_NUMBER: number = 20220326;
 export const DEFAULT_DB_NAME = "remotelysavedb";
 export const DEFAULT_TBL_VERSION = "schemaversion";
-export const DEFAULT_TBL_DELETE_HISTORY = "filefolderoperationhistory";
+export const DEFAULT_TBL_FILE_HISTORY = "filefolderoperationhistory";
 export const DEFAULT_TBL_SYNC_MAPPING = "syncmetadatahistory";
 export const DEFAULT_SYNC_PLANS_HISTORY = "syncplanshistory";
+export const DEFAULT_TBL_VAULT_RANDOM_ID_MAPPING = "vaultrandomidmapping";
+export const DEFAULT_TBL_LOGGER_OUTPUT = "loggeroutput";
+export const DEFAULT_TBL_SIMPLE_KV_FOR_MISC = "simplekvformisc";
 
 export interface FileFolderHistoryRecord {
   key: string;
@@ -23,7 +26,7 @@ export interface FileFolderHistoryRecord {
   mtime: number;
   size: number;
   actionWhen: number;
-  actionType: "delete" | "rename";
+  actionType: "delete" | "rename" | "renameDestination";
   keyType: "folder" | "file";
   renameTo: string;
   vaultRandomID: string;
@@ -51,9 +54,12 @@ interface SyncPlanRecord {
 
 export interface InternalDBs {
   versionTbl: LocalForage;
-  deleteHistoryTbl: LocalForage;
+  fileHistoryTbl: LocalForage;
   syncMappingTbl: LocalForage;
   syncPlansTbl: LocalForage;
+  vaultRandomIDMappingTbl: LocalForage;
+  loggerOutputTbl: LocalForage;
+  simpleKVForMiscTbl: LocalForage;
 }
 
 /**
@@ -72,12 +78,12 @@ const migrateDBsFrom20211114To20220108 = async (
   const allPromisesToWait: Promise<any>[] = [];
 
   log.debug("assign vault id to any delete history");
-  const keysInDeleteHistoryTbl = await db.deleteHistoryTbl.keys();
+  const keysInDeleteHistoryTbl = await db.fileHistoryTbl.keys();
   for (const key of keysInDeleteHistoryTbl) {
     if (key.startsWith(vaultRandomID)) {
       continue;
     }
-    const value = (await db.deleteHistoryTbl.getItem(
+    const value = (await db.fileHistoryTbl.getItem(
       key
     )) as FileFolderHistoryRecord;
     if (value === null || value === undefined) {
@@ -87,8 +93,8 @@ const migrateDBsFrom20211114To20220108 = async (
       value.vaultRandomID = vaultRandomID;
     }
     const newKey = `${vaultRandomID}\t${key}`;
-    allPromisesToWait.push(db.deleteHistoryTbl.setItem(newKey, value));
-    allPromisesToWait.push(db.deleteHistoryTbl.removeItem(key));
+    allPromisesToWait.push(db.fileHistoryTbl.setItem(newKey, value));
+    allPromisesToWait.push(db.fileHistoryTbl.removeItem(key));
   }
 
   log.debug("assign vault id to any sync mapping");
@@ -136,6 +142,23 @@ const migrateDBsFrom20211114To20220108 = async (
   log.debug(`finish upgrading internal db from ${oldVer} to ${newVer}`);
 };
 
+/**
+ * no need to do anything except changing version
+ * we just add more file operations in db, and no schema is changed.
+ * @param db
+ * @param vaultRandomID
+ */
+const migrateDBsFrom20220108To20220326 = async (
+  db: InternalDBs,
+  vaultRandomID: string
+) => {
+  const oldVer = 20220108;
+  const newVer = 20220326;
+  log.debug(`start upgrading internal db from ${oldVer} to ${newVer}`);
+  await db.versionTbl.setItem("version", newVer);
+  log.debug(`finish upgrading internal db from ${oldVer} to ${newVer}`);
+};
+
 const migrateDBs = async (
   db: InternalDBs,
   oldVer: number,
@@ -148,19 +171,36 @@ const migrateDBs = async (
   if (oldVer === 20211114 && newVer === 20220108) {
     return await migrateDBsFrom20211114To20220108(db, vaultRandomID);
   }
+  if (oldVer === 20220108 && newVer === 20220326) {
+    return await migrateDBsFrom20220108To20220326(db, vaultRandomID);
+  }
+  if (oldVer === 20211114 && newVer === 20220326) {
+    // TODO: more steps with more versions in the future
+    await migrateDBsFrom20211114To20220108(db, vaultRandomID);
+    await migrateDBsFrom20220108To20220326(db, vaultRandomID);
+    return;
+  }
+  if (newVer < oldVer) {
+    throw Error(
+      "You've installed a new version, but then downgrade to an old version. Stop working!"
+    );
+  }
   // not implemented
   throw Error(`not supported internal db changes from ${oldVer} to ${newVer}`);
 };
 
-export const prepareDBs = async (vaultRandomID: string) => {
+export const prepareDBs = async (
+  vaultBasePath: string,
+  vaultRandomIDFromOldConfigFile: string
+) => {
   const db = {
     versionTbl: localforage.createInstance({
       name: DEFAULT_DB_NAME,
       storeName: DEFAULT_TBL_VERSION,
     }),
-    deleteHistoryTbl: localforage.createInstance({
+    fileHistoryTbl: localforage.createInstance({
       name: DEFAULT_DB_NAME,
-      storeName: DEFAULT_TBL_DELETE_HISTORY,
+      storeName: DEFAULT_TBL_FILE_HISTORY,
     }),
     syncMappingTbl: localforage.createInstance({
       name: DEFAULT_DB_NAME,
@@ -170,9 +210,50 @@ export const prepareDBs = async (vaultRandomID: string) => {
       name: DEFAULT_DB_NAME,
       storeName: DEFAULT_SYNC_PLANS_HISTORY,
     }),
+    vaultRandomIDMappingTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_VAULT_RANDOM_ID_MAPPING,
+    }),
+    loggerOutputTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_LOGGER_OUTPUT,
+    }),
+    simpleKVForMiscTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_SIMPLE_KV_FOR_MISC,
+    }),
   } as InternalDBs;
 
-  const originalVersion = (await db.versionTbl.getItem("version")) as number;
+  // try to get vaultRandomID firstly
+  let vaultRandomID = "";
+  const vaultRandomIDInDB: string | null =
+    await db.vaultRandomIDMappingTbl.getItem(`path2id\t${vaultBasePath}`);
+  if (vaultRandomIDInDB === null) {
+    if (vaultRandomIDFromOldConfigFile !== "") {
+      // reuse the old config id
+      vaultRandomID = vaultRandomIDFromOldConfigFile;
+    } else {
+      // no old config id, we create a random one
+      vaultRandomID = nanoid();
+    }
+    // save the id back
+    await db.vaultRandomIDMappingTbl.setItem(
+      `path2id\t${vaultBasePath}`,
+      vaultRandomID
+    );
+    await db.vaultRandomIDMappingTbl.setItem(
+      `id2path\t${vaultRandomID}`,
+      vaultBasePath
+    );
+  } else {
+    vaultRandomID = vaultRandomIDInDB;
+  }
+
+  if (vaultRandomID === "") {
+    throw Error("no vaultRandomID found or generated");
+  }
+
+  const originalVersion: number | null = await db.versionTbl.getItem("version");
   if (originalVersion === null) {
     log.debug(
       `no internal db version, setting it to ${DEFAULT_DB_VERSION_NUMBER}`
@@ -193,7 +274,10 @@ export const prepareDBs = async (vaultRandomID: string) => {
   }
 
   log.info("db connected");
-  return db;
+  return {
+    db: db,
+    vaultRandomID: vaultRandomID,
+  };
 };
 
 export const destroyDBs = async () => {
@@ -206,20 +290,20 @@ export const destroyDBs = async () => {
     log.info("db deleted");
   };
   req.onblocked = (event) => {
-    console.warn("trying to delete db but it was blocked");
+    log.warn("trying to delete db but it was blocked");
   };
   req.onerror = (event) => {
-    console.error("tried to delete db but something bad!");
-    console.error(event);
+    log.error("tried to delete db but something goes wrong!");
+    log.error(event);
   };
 };
 
-export const loadDeleteRenameHistoryTableByVault = async (
+export const loadFileHistoryTableByVault = async (
   db: InternalDBs,
   vaultRandomID: string
 ) => {
   const records = [] as FileFolderHistoryRecord[];
-  await db.deleteHistoryTbl.iterate((value, key, iterationNumber) => {
+  await db.fileHistoryTbl.iterate((value, key, iterationNumber) => {
     if (key.startsWith(`${vaultRandomID}\t`)) {
       records.push(value as FileFolderHistoryRecord);
     }
@@ -233,12 +317,20 @@ export const clearDeleteRenameHistoryOfKeyAndVault = async (
   key: string,
   vaultRandomID: string
 ) => {
-  await db.deleteHistoryTbl.removeItem(`${vaultRandomID}\t${key}`);
+  const fullKey = `${vaultRandomID}\t${key}`;
+  const item: FileFolderHistoryRecord | null =
+    await db.fileHistoryTbl.getItem(fullKey);
+  if (
+    item !== null &&
+    (item.actionType === "delete" || item.actionType === "rename")
+  ) {
+    await db.fileHistoryTbl.removeItem(fullKey);
+  }
 };
 
 export const insertDeleteRecordByVault = async (
   db: InternalDBs,
-  fileOrFolder: TAbstractFile,
+  fileOrFolder: TAbstractFile | string,
   vaultRandomID: string
 ) => {
   // log.info(fileOrFolder);
@@ -255,13 +347,65 @@ export const insertDeleteRecordByVault = async (
       renameTo: "",
       vaultRandomID: vaultRandomID,
     };
+    await db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
   } else if (fileOrFolder instanceof TFolder) {
     // key should endswith "/"
     const key = fileOrFolder.path.endsWith("/")
       ? fileOrFolder.path
       : `${fileOrFolder.path}/`;
+    const ctime = 0; // they are deleted, so no way to get ctime, mtime
+    const mtime = 0; // they are deleted, so no way to get ctime, mtime
     k = {
       key: key,
+      ctime: ctime,
+      mtime: mtime,
+      size: 0,
+      actionWhen: Date.now(),
+      actionType: "delete",
+      keyType: "folder",
+      renameTo: "",
+      vaultRandomID: vaultRandomID,
+    };
+    await db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
+  } else if (typeof fileOrFolder === "string") {
+    // always the deletions in .obsidian folder
+    // so annoying that the path doesn't exists
+    // and we have to guess whether the path is folder or file
+    k = {
+      key: fileOrFolder,
+      ctime: 0,
+      mtime: 0,
+      size: 0,
+      actionWhen: Date.now(),
+      actionType: "delete",
+      keyType: "file",
+      renameTo: "",
+      vaultRandomID: vaultRandomID,
+    };
+    await db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
+    for (const ext of [
+      "json",
+      "js",
+      "mjs",
+      "ts",
+      "md",
+      "txt",
+      "css",
+      "png",
+      "gif",
+      "jpg",
+      "jpeg",
+      "gitignore",
+      "gitkeep",
+    ]) {
+      if (fileOrFolder.endsWith(`.${ext}`)) {
+        // stop here, no more need to insert the folder record later
+        return;
+      }
+    }
+    // also add a deletion record as folder if not ending with special exts
+    k = {
+      key: `${fileOrFolder}/`,
       ctime: 0,
       mtime: 0,
       size: 0,
@@ -271,10 +415,20 @@ export const insertDeleteRecordByVault = async (
       renameTo: "",
       vaultRandomID: vaultRandomID,
     };
+    await db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
   }
-  await db.deleteHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
 };
 
+/**
+ * A file/folder is renamed from A to B
+ * We insert two records:
+ * A with actionType="rename"
+ * B with actionType="renameDestination"
+ * @param db
+ * @param fileOrFolder
+ * @param oldPath
+ * @param vaultRandomID
+ */
 export const insertRenameRecordByVault = async (
   db: InternalDBs,
   fileOrFolder: TAbstractFile,
@@ -282,37 +436,73 @@ export const insertRenameRecordByVault = async (
   vaultRandomID: string
 ) => {
   // log.info(fileOrFolder);
-  let k: FileFolderHistoryRecord;
+  let k1: FileFolderHistoryRecord;
+  let k2: FileFolderHistoryRecord;
+  const actionWhen = Date.now();
   if (fileOrFolder instanceof TFile) {
-    k = {
+    k1 = {
       key: oldPath,
       ctime: fileOrFolder.stat.ctime,
       mtime: fileOrFolder.stat.mtime,
       size: fileOrFolder.stat.size,
-      actionWhen: Date.now(),
+      actionWhen: actionWhen,
       actionType: "rename",
       keyType: "file",
       renameTo: fileOrFolder.path,
       vaultRandomID: vaultRandomID,
     };
+    k2 = {
+      key: fileOrFolder.path,
+      ctime: fileOrFolder.stat.ctime,
+      mtime: fileOrFolder.stat.mtime,
+      size: fileOrFolder.stat.size,
+      actionWhen: actionWhen,
+      actionType: "renameDestination",
+      keyType: "file",
+      renameTo: "", // itself is the destination, so no need to set this field
+      vaultRandomID: vaultRandomID,
+    };
   } else if (fileOrFolder instanceof TFolder) {
     const key = oldPath.endsWith("/") ? oldPath : `${oldPath}/`;
     const renameTo = fileOrFolder.path.endsWith("/")
       ? fileOrFolder.path
       : `${fileOrFolder.path}/`;
-    k = {
+    let ctime = 0;
+    let mtime = 0;
+    if (requireApiVersion(API_VER_STAT_FOLDER)) {
+      // TAbstractFile does not contain these info
+      // but from API_VER_STAT_FOLDER we can manually stat them by path.
+      const s = await statFix(fileOrFolder.vault, fileOrFolder.path);
+      ctime = s.ctime;
+      mtime = s.mtime;
+    }
+    k1 = {
       key: key,
-      ctime: 0,
-      mtime: 0,
+      ctime: ctime,
+      mtime: mtime,
       size: 0,
-      actionWhen: Date.now(),
+      actionWhen: actionWhen,
       actionType: "rename",
       keyType: "folder",
       renameTo: renameTo,
       vaultRandomID: vaultRandomID,
     };
+    k2 = {
+      key: renameTo,
+      ctime: ctime,
+      mtime: mtime,
+      size: 0,
+      actionWhen: actionWhen,
+      actionType: "renameDestination",
+      keyType: "folder",
+      renameTo: "", // itself is the destination, so no need to set this field
+      vaultRandomID: vaultRandomID,
+    };
   }
-  await db.deleteHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
+  await Promise.all([
+    db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k1.key}`, k1),
+    db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k2.key}`, k2),
+  ]);
 };
 
 export const upsertSyncMetaMappingDataByVault = async (
@@ -386,6 +576,7 @@ export const insertSyncPlanRecordByVault = async (
 ) => {
   const record = {
     ts: syncPlan.ts,
+    tsFmt: syncPlan.tsFmt,
     vaultRandomID: vaultRandomID,
     remoteType: syncPlan.remoteType,
     syncPlan: JSON.stringify(syncPlan /* directly stringify */, null, 2),
@@ -415,3 +606,175 @@ export const readAllSyncPlanRecordTextsByVault = async (
     return records.map((x) => x.syncPlan);
   }
 };
+
+/**
+ * We remove records that are older than 7 days or 10000 records.
+ * It's a heavy operation, so we shall not place it in the start up.
+ * @param db
+ */
+export const clearExpiredSyncPlanRecords = async (db: InternalDBs) => {
+  const MILLISECONDS_OLD = 1000 * 60 * 60 * 24 * 7; // 7 days
+  const COUNT_TO_MANY = 10000;
+
+  const currTs = Date.now();
+  const expiredTs = currTs - MILLISECONDS_OLD;
+
+  let records = (await db.syncPlansTbl.keys()).map((key) => {
+    const ts = parseInt(key.split("\t")[1]);
+    const expired = ts <= expiredTs;
+    return {
+      ts: ts,
+      key: key,
+      expired: expired,
+    };
+  });
+
+  const keysToRemove = new Set(
+    records.filter((x) => x.expired).map((x) => x.key)
+  );
+
+  if (records.length - keysToRemove.size > COUNT_TO_MANY) {
+    // we need to find out records beyond 10000 records
+    records = records.filter((x) => !x.expired); // shrink the array
+    records.sort((a, b) => -(a.ts - b.ts)); // descending
+    records.slice(COUNT_TO_MANY).forEach((element) => {
+      keysToRemove.add(element.key);
+    });
+  }
+
+  const ps = [] as Promise<void>[];
+  keysToRemove.forEach((element) => {
+    ps.push(db.syncPlansTbl.removeItem(element));
+  });
+  await Promise.all(ps);
+};
+
+export const readAllLogRecordTextsByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string
+) => {
+  const records = [] as { ts: number; r: string }[];
+  await db.loggerOutputTbl.iterate((value, key, iterationNumber) => {
+    if (key.startsWith(`${vaultRandomID}\t`)) {
+      const item = {
+        ts: parseInt(key.split("\t")[1]),
+        r: value as string,
+      };
+      records.push(item);
+    }
+  });
+
+  // while reading the logs, we want it to be ascending
+  records.sort((a, b) => a.ts - b.ts);
+
+  if (records === undefined) {
+    return [] as string[];
+  } else {
+    return records.map((x) => x.r);
+  }
+};
+
+export const insertLoggerOutputByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string,
+  ...msg: any[]
+) => {
+  const ts = Date.now();
+  const tsFmt = unixTimeToStr(ts);
+  const key = `${vaultRandomID}\t${ts}`;
+
+  try {
+    const val = [`[${tsFmt}]`, ...msg.map((x) => toText(x))].join(" ");
+    db.loggerOutputTbl.setItem(key, val);
+  } catch (err) {
+    // give up, and let it pass
+  }
+};
+
+export const clearAllLoggerOutputRecords = async (db: InternalDBs) => {
+  await db.loggerOutputTbl.clear();
+};
+
+/**
+ * We remove records that are older than 7 days or 10000 records.
+ * It's a heavy operation, so we shall not place it in the start up.
+ * @param db
+ */
+export const clearExpiredLoggerOutputRecords = async (db: InternalDBs) => {
+  const MILLISECONDS_OLD = 1000 * 60 * 60 * 24 * 7; // 7 days
+  const COUNT_TO_MANY = 10000;
+
+  const currTs = Date.now();
+  const expiredTs = currTs - MILLISECONDS_OLD;
+
+  let records = (await db.loggerOutputTbl.keys()).map((key) => {
+    const ts = parseInt(key.split("\t")[1]);
+    const expired = ts <= expiredTs;
+    return {
+      ts: ts,
+      key: key,
+      expired: expired,
+    };
+  });
+
+  const keysToRemove = new Set(
+    records.filter((x) => x.expired).map((x) => x.key)
+  );
+
+  if (records.length - keysToRemove.size > COUNT_TO_MANY) {
+    // we need to find out records beyond 10000 records
+    records = records.filter((x) => !x.expired); // shrink the array
+    records.sort((a, b) => -(a.ts - b.ts)); // descending
+    records.slice(COUNT_TO_MANY).forEach((element) => {
+      keysToRemove.add(element.key);
+    });
+  }
+
+  const ps = [] as Promise<void>[];
+  keysToRemove.forEach((element) => {
+    ps.push(db.loggerOutputTbl.removeItem(element));
+  });
+  await Promise.all(ps);
+};
+
+export const upsertLastSuccessSyncByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string,
+  millis: number
+) => {
+  await db.simpleKVForMiscTbl.setItem(
+    `${vaultRandomID}-lastSuccessSyncMillis`,
+    millis
+  );
+};
+
+export const getLastSuccessSyncByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string
+) => {
+  return (await db.simpleKVForMiscTbl.getItem(
+    `${vaultRandomID}-lastSuccessSyncMillis`
+  )) as number;
+};
+
+export const upsertPluginVersionByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string,
+  newVersion: string
+) => {
+  let oldVersion: string | null = await db.simpleKVForMiscTbl.getItem(
+    `${vaultRandomID}-pluginversion`
+  );
+  if (oldVersion === null) {
+    oldVersion = "0.0.0";
+  }
+  await db.simpleKVForMiscTbl.setItem(
+    `${vaultRandomID}-pluginversion`,
+    newVersion
+  );
+
+  return {
+    oldVersion: oldVersion,
+    newVersion: newVersion,
+  };
+};

src/metadataOnRemote.ts

@@ -0,0 +1,113 @@
+import isEqual from "lodash/isEqual";
+import { base64url } from "rfc4648";
+import { reverseString } from "./misc";
+import { log } from "./moreOnLog";
+
+const DEFAULT_README_FOR_METADATAONREMOTE =
+  "Do NOT edit or delete the file manually. This file is for the plugin remotely-save to store some necessary meta data on the remote services. Its content is slightly obfuscated.";
+
+const DEFAULT_VERSION_FOR_METADATAONREMOTE = "20220220";
+
+export const DEFAULT_FILE_NAME_FOR_METADATAONREMOTE =
+  "_remotely-save-metadata-on-remote.json";
+
+export const DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2 =
+  "_remotely-save-metadata-on-remote.bin";
+
+export interface DeletionOnRemote {
+  key: string;
+  actionWhen: number;
+}
+
+export interface MetadataOnRemote {
+  version?: string;
+  generatedWhen?: number;
+  deletions?: DeletionOnRemote[];
+}
+
+export const isEqualMetadataOnRemote = (
+  a: MetadataOnRemote,
+  b: MetadataOnRemote
+) => {
+  const m1 = a === undefined ? { deletions: [] } : a;
+  const m2 = b === undefined ? { deletions: [] } : b;
+
+  // we only need to compare deletions
+  const d1 = m1.deletions === undefined ? [] : m1.deletions;
+  const d2 = m2.deletions === undefined ? [] : m2.deletions;
+  return isEqual(d1, d2);
+};
+
+export const serializeMetadataOnRemote = (x: MetadataOnRemote) => {
+  const y = x;
+
+  if (y["version"] === undefined) {
+    y["version"] === DEFAULT_VERSION_FOR_METADATAONREMOTE;
+  }
+  if (y["generatedWhen"] === undefined) {
+    y["generatedWhen"] = Date.now();
+  }
+  if (y["deletions"] === undefined) {
+    y["deletions"] = [];
+  }
+
+  const z = {
+    readme: DEFAULT_README_FOR_METADATAONREMOTE,
+    d: reverseString(
+      base64url.stringify(Buffer.from(JSON.stringify(x), "utf-8"), {
+        pad: false,
+      })
+    ),
+  };
+
+  return JSON.stringify(z, null, 2);
+};
+
+export const deserializeMetadataOnRemote = (x: string | ArrayBuffer) => {
+  let y1 = "";
+  if (typeof x === "string") {
+    y1 = x;
+  } else {
+    y1 = new TextDecoder().decode(x);
+  }
+
+  let y2: any;
+  try {
+    y2 = JSON.parse(y1);
+  } catch (e) {
+    throw new Error(
+      `invalid remote meta data file with first few chars: ${y1.slice(0, 5)}`
+    );
+  }
+
+  if (!("readme" in y2 && "d" in y2)) {
+    throw new Error(
+      'invalid remote meta data file (no "readme" or "d" fields)!'
+    );
+  }
+
+  let y3: string;
+  try {
+    y3 = (
+      base64url.parse(reverseString(y2["d"]), {
+        out: Buffer.allocUnsafe as any,
+        loose: true,
+      }) as Buffer
+    ).toString("utf-8");
+  } catch (e) {
+    throw new Error('invalid remote meta data file (invalid "d" field)!');
+  }
+
+  let y4: MetadataOnRemote;
+  try {
+    y4 = JSON.parse(y3) as MetadataOnRemote;
+  } catch (e) {
+    throw new Error(
+      `invalid remote meta data file with \"d\" field with first few chars: ${y3.slice(
+        0,
+        5
+      )}`
+    );
+  }
+  return y4;
+};

src/misc.ts

@@ -3,17 +3,31 @@ import * as path from "path";
 
 import { base32, base64url } from "rfc4648";
 import XRegExp from "xregexp";
+import emojiRegex from "emoji-regex";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
+
+declare global {
+  interface Window {
+    moment: (...data: any) => any;
+  }
+}
 
 /**
  * If any part of the file starts with '.' or '_' then it's a hidden file.
  * @param item
- * @param loose
+ * @param dot
+ * @param underscore
  * @returns
  */
-export const isHiddenPath = (item: string, loose: boolean = true) => {
+export const isHiddenPath = (
+  item: string,
+  dot: boolean = true,
+  underscore: boolean = true
+) => {
+  if (!(dot || underscore)) {
+    throw Error("parameter error for isHiddenPath");
+  }
   const k = path.posix.normalize(item); // TODO: only unix path now
   const k2 = k.split("/"); // TODO: only unix path now
   // log.info(k2)
@@ -21,10 +35,10 @@ export const isHiddenPath = (item: string, loose: boolean = true) => {
     if (singlePart === "." || singlePart === ".." || singlePart === "") {
       continue;
     }
-    if (singlePart[0] === ".") {
+    if (dot && singlePart[0] === ".") {
       return true;
     }
-    if (loose && singlePart[0] === "_") {
+    if (underscore && singlePart[0] === "_") {
       return true;
     }
   }
@@ -38,7 +52,7 @@ export const isHiddenPath = (item: string, loose: boolean = true) => {
  * @param x string
  * @returns string[] might be empty
  */
-export const getFolderLevels = (x: string) => {
+export const getFolderLevels = (x: string, addEndingSlash: boolean = false) => {
   const res: string[] = [];
 
   if (x === "" || x === "/") {
@@ -48,10 +62,14 @@ export const getFolderLevels = (x: string) => {
   const y1 = x.split("/");
   let i = 0;
   for (let index = 0; index + 1 < y1.length; index++) {
-    const k = y1.slice(0, index + 1).join("/");
-    if (k !== "" && k !== "/") {
-      res.push(k);
+    let k = y1.slice(0, index + 1).join("/");
+    if (k === "" || k === "/") {
+      continue;
     }
+    if (addEndingSlash) {
+      k = `${k}/`;
+    }
+    res.push(k);
   }
   return res;
 };
@@ -75,7 +93,9 @@ export const mkdirpInVault = async (thePath: string, vault: Vault) => {
  * @param b Buffer
  * @returns ArrayBuffer
  */
-export const bufferToArrayBuffer = (b: Buffer | Uint8Array) => {
+export const bufferToArrayBuffer = (
+  b: Buffer | Uint8Array | ArrayBufferView
+) => {
   return b.buffer.slice(b.byteOffset, b.byteOffset + b.byteLength);
 };
 
@@ -143,6 +163,34 @@ export const isVaildText = (a: string) => {
   );
 };
 
+/**
+ * Use regex to detect a text contains emoji or not.
+ * @param a
+ * @returns
+ */
+export const hasEmojiInText = (a: string) => {
+  const regex = emojiRegex();
+  return regex.test(a);
+};
+
+/**
+ * Convert the headers to a normal object.
+ * @param h
+ * @param toLower
+ * @returns
+ */
+export const headersToRecord = (h: Headers, toLower: boolean = true) => {
+  const res: Record<string, string> = {};
+  h.forEach((v, k) => {
+    if (toLower) {
+      res[k.toLowerCase()] = v;
+    } else {
+      res[k] = v;
+    }
+  });
+  return res;
+};
+
 /**
  * If input is already a folder, returns it as is;
  * And if input is a file, returns its direname.
@@ -157,6 +205,24 @@ export const getPathFolder = (a: string) => {
   return b.endsWith("/") ? b : `${b}/`;
 };
 
+/**
+ * If input is already a folder, returns its folder;
+ * And if input is a file, returns its direname.
+ * @param a
+ * @returns
+ */
+export const getParentFolder = (a: string) => {
+  const b = path.posix.dirname(a);
+  if (b === "." || b === "/") {
+    // the root
+    return "/";
+  }
+  if (b.endsWith("/")) {
+    return b;
+  }
+  return `${b}/`;
+};
+
 /**
  * https://stackoverflow.com/questions/54511144
  * @param a
@@ -208,3 +274,212 @@ export const getRandomArrayBuffer = (byteLength: number) => {
 export const reverseString = (x: string) => {
   return [...x].reverse().join("");
 };
+
+export interface SplitRange {
+  partNum: number; // startting from 1
+  start: number;
+  end: number; // exclusive
+}
+export const getSplitRanges = (bytesTotal: number, bytesEachPart: number) => {
+  const res: SplitRange[] = [];
+  if (bytesEachPart >= bytesTotal) {
+    res.push({
+      partNum: 1,
+      start: 0,
+      end: bytesTotal,
+    });
+    return res;
+  }
+  const remainder = bytesTotal % bytesEachPart;
+  const howMany =
+    Math.floor(bytesTotal / bytesEachPart) + (remainder === 0 ? 0 : 1);
+  for (let i = 0; i < howMany; ++i) {
+    res.push({
+      partNum: i + 1,
+      start: bytesEachPart * i,
+      end: Math.min(bytesEachPart * (i + 1), bytesTotal),
+    });
+  }
+  return res;
+};
+
+/**
+ * https://stackoverflow.com/questions/332422
+ * @param obj anything
+ * @returns string of the name of the object
+ */
+export const getTypeName = (obj: any) => {
+  return Object.prototype.toString.call(obj).slice(8, -1);
+};
+
+/**
+ * Startting from 1
+ * @param x
+ * @returns
+ */
+export const atWhichLevel = (x: string) => {
+  if (
+    x === undefined ||
+    x === "" ||
+    x === "." ||
+    x === ".." ||
+    x.startsWith("/")
+  ) {
+    throw Error(`do not know which level for ${x}`);
+  }
+  let y = x;
+  if (x.endsWith("/")) {
+    y = x.slice(0, -1);
+  }
+  return y.split("/").length;
+};
+
+export const checkHasSpecialCharForDir = (x: string) => {
+  return /[?/\\]/.test(x);
+};
+
+export const unixTimeToStr = (x: number | undefined | null) => {
+  if (x === undefined || x === null || Number.isNaN(x)) {
+    return undefined;
+  }
+  return window.moment(x).format() as string;
+};
+
+/**
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value#examples
+ * @returns
+ */
+const getCircularReplacer = () => {
+  const seen = new WeakSet();
+  return (key: any, value: any) => {
+    if (typeof value === "object" && value !== null) {
+      if (seen.has(value)) {
+        return;
+      }
+      seen.add(value);
+    }
+    return value;
+  };
+};
+
+/**
+ * Convert "any" value to string.
+ * @param x
+ * @returns
+ */
+export const toText = (x: any) => {
+  if (x === undefined || x === null) {
+    return `${x}`;
+  }
+  if (typeof x === "string") {
+    return x;
+  }
+  if (
+    x instanceof String ||
+    x instanceof Date ||
+    typeof x === "number" ||
+    typeof x === "bigint" ||
+    typeof x === "boolean"
+  ) {
+    return `${x}`;
+  }
+
+  if (
+    x instanceof Error ||
+    (x &&
+      x.stack &&
+      x.message &&
+      typeof x.stack === "string" &&
+      typeof x.message === "string")
+  ) {
+    return `ERROR! MESSAGE: ${x.message}, STACK: ${x.stack}`;
+  }
+
+  try {
+    const y = JSON.stringify(x, getCircularReplacer(), 2);
+    if (y !== undefined) {
+      return y;
+    }
+    throw new Error("not jsonable");
+  } catch {
+    return `${x}`;
+  }
+};
+
+/**
+ * On Android the stat has bugs for folders. So we need a fixed version.
+ * @param vault
+ * @param path
+ */
+export const statFix = async (vault: Vault, path: string) => {
+  const s = await vault.adapter.stat(path);
+  if (s.ctime === undefined || s.ctime === null || Number.isNaN(s.ctime)) {
+    s.ctime = undefined;
+  }
+  if (s.mtime === undefined || s.mtime === null || Number.isNaN(s.mtime)) {
+    s.mtime = undefined;
+  }
+  if (
+    (s.size === undefined || s.size === null || Number.isNaN(s.size)) &&
+    s.type === "folder"
+  ) {
+    s.size = 0;
+  }
+  return s;
+};
+
+export const isFolderToSkip = (x: string, more: string[] | undefined) => {
+  let specialFolders = [
+    ".git",
+    ".github",
+    ".gitlab",
+    ".svn",
+    "node_modules",
+    ".DS_Store",
+    "__MACOSX ",
+    "Icon\r", // https://superuser.com/questions/298785/icon-file-on-os-x-desktop
+    "desktop.ini",
+    "Desktop.ini",
+    "thumbs.db",
+    "Thumbs.db",
+  ].concat(more !== undefined ? more : []);
+  for (const iterator of specialFolders) {
+    if (
+      x === iterator ||
+      x === `${iterator}/` ||
+      x.endsWith(`/${iterator}`) ||
+      x.endsWith(`/${iterator}/`)
+    ) {
+      return true;
+    }
+  }
+  return false;
+};
+
+/**
+ *
+ * @param x versionX
+ * @param y versionY
+ * @returns 1(x>y), 0(x==y), -1(x<y)
+ */
+export const compareVersion = (x: string | null, y: string | null) => {
+  if (x === undefined || x === null) {
+    return -1;
+  }
+  if (y === undefined || y === null) {
+    return 1;
+  }
+  if (x === y) {
+    return 0;
+  }
+  const [x1, x2, x3] = x.split(".").map((k) => Number(k));
+  const [y1, y2, y3] = y.split(".").map((k) => Number(k));
+  if (
+    x1 > y1 ||
+    (x1 === y1 && x2 > y2) ||
+    (x1 === y1 && x2 === y2 && x3 > y3)
+  ) {
+    return 1;
+  }
+  return -1;
+};

src/moreOnLog.ts

@@ -0,0 +1,40 @@
+// It's very dangerous for this file to depend on other files in the same project.
+// We should avoid this situation as much as possible.
+
+import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
+
+import * as origLog from "loglevel";
+import type {
+  LogLevelNumbers,
+  Logger,
+  LogLevel,
+  LogLevelDesc,
+  LogLevelNames,
+} from "loglevel";
+const log2 = origLog.getLogger("rs-default");
+
+const originalFactory = log2.methodFactory;
+
+export const applyLogWriterInplace = function (writer: (...msg: any[]) => any) {
+  log2.methodFactory = function (
+    methodName: LogLevelNames,
+    logLevel: LogLevelNumbers,
+    loggerName: string | symbol
+  ) {
+    const rawMethod = originalFactory(methodName, logLevel, loggerName);
+
+    return function (...msg: any[]) {
+      rawMethod.apply(undefined, msg);
+      writer(...msg);
+    };
+  };
+
+  log2.setLevel(log2.getLevel());
+};
+
+export const restoreLogWritterInplace = () => {
+  log2.methodFactory = originalFactory;
+  log2.setLevel(log2.getLevel());
+};
+
+export const log = log2;

src/obsFolderLister.ts

@@ -0,0 +1,111 @@
+import { Vault, Stat, ListedFiles } from "obsidian";
+import { Queue } from "@fyears/tsqueue";
+import chunk from "lodash/chunk";
+import flatten from "lodash/flatten";
+import { statFix, isFolderToSkip } from "./misc";
+
+export interface ObsConfigDirFileType {
+  key: string;
+  ctime: number;
+  mtime: number;
+  size: number;
+  type: "folder" | "file";
+}
+
+const isPluginDirItself = (x: string, pluginId: string) => {
+  return (
+    x === pluginId ||
+    x === `${pluginId}/` ||
+    x.endsWith(`/${pluginId}`) ||
+    x.endsWith(`/${pluginId}/`)
+  );
+};
+
+const isLikelyPluginSubFiles = (x: string) => {
+  const reqFiles = [
+    "data.json",
+    "main.js",
+    "manifest.json",
+    ".gitignore",
+    "styles.css",
+  ];
+  for (const iterator of reqFiles) {
+    if (x === iterator || x.endsWith(`/${iterator}`)) {
+      return true;
+    }
+  }
+  return false;
+};
+
+export const isInsideObsFolder = (x: string, configDir: string) => {
+  if (!configDir.startsWith(".")) {
+    throw Error(`configDir should starts with . but we get ${configDir}`);
+  }
+  return x === configDir || x.startsWith(`${configDir}/`);
+};
+
+export const listFilesInObsFolder = async (
+  configDir: string,
+  vault: Vault,
+  pluginId: string
+) => {
+  const q = new Queue([configDir]);
+  const CHUNK_SIZE = 10;
+  const contents: ObsConfigDirFileType[] = [];
+  while (q.length > 0) {
+    const itemsToFetch = [];
+    while (q.length > 0) {
+      itemsToFetch.push(q.pop());
+    }
+
+    const itemsToFetchChunks = chunk(itemsToFetch, CHUNK_SIZE);
+    for (const singleChunk of itemsToFetchChunks) {
+      const r = singleChunk.map(async (x) => {
+        const statRes = await statFix(vault, x);
+
+        const isFolder = statRes.type === "folder";
+        let children: ListedFiles = undefined;
+        if (isFolder) {
+          children = await vault.adapter.list(x);
+        }
+
+        return {
+          itself: {
+            key: isFolder ? `${x}/` : x,
+            ...statRes,
+          } as ObsConfigDirFileType,
+          children: children,
+        };
+      });
+      const r2 = flatten(await Promise.all(r));
+
+      for (const iter of r2) {
+        contents.push(iter.itself);
+        const isInsideSelfPlugin = isPluginDirItself(iter.itself.key, pluginId);
+        if (iter.children !== undefined) {
+          for (const iter2 of iter.children.folders) {
+            if (isFolderToSkip(iter2, ["workspace", "workspace.json"])) {
+              continue;
+            }
+            if (isInsideSelfPlugin && !isLikelyPluginSubFiles(iter2)) {
+              // special treatment for remotely-save folder
+              continue;
+            }
+            q.push(iter2);
+          }
+          for (const iter2 of iter.children.files) {
+            if (isFolderToSkip(iter2, ["workspace", "workspace.json"])) {
+              continue;
+            }
+            if (isInsideSelfPlugin && !isLikelyPluginSubFiles(iter2)) {
+              // special treatment for remotely-save folder
+              continue;
+            }
+            q.push(iter2);
+          }
+        }
+      }
+    }
+  }
+  return contents;
+};

src/presetRules.ts

@@ -0,0 +1,69 @@
+import type {
+  RemotelySavePluginSettings,
+  WebdavConfig,
+  WebdavDepthType,
+} from "./baseTypes";
+
+const RULES = {
+  webdav: {
+    depth: [
+      {
+        url: "^https://(.+).teracloud.jp/.+",
+        depth: "auto_1",
+        manualRecursive: true,
+      },
+      {
+        url: "^https://dav.jianguoyun.com/dav/",
+        depth: "auto_1",
+        manualRecursive: true,
+      },
+    ],
+  },
+};
+
+export const applyWebdavPresetRulesInplace = (
+  webdav: Partial<WebdavConfig> | undefined
+) => {
+  if (webdav === undefined) {
+    return {
+      changed: false,
+      webdav: webdav,
+    };
+  }
+  for (const { url, depth, manualRecursive } of RULES.webdav.depth) {
+    if (
+      webdav.address !== undefined &&
+      new RegExp(url).test(webdav.address) &&
+      webdav.depth !== undefined &&
+      webdav.depth.startsWith("auto_") &&
+      webdav.depth !== depth
+    ) {
+      webdav.depth = depth as WebdavDepthType;
+      webdav.manualRecursive = manualRecursive;
+      return {
+        changed: true,
+        webdav: webdav,
+      };
+    }
+  }
+  return {
+    changed: false,
+    webdav: webdav,
+  };
+};
+
+export const applyPresetRulesInplace = (
+  settings: RemotelySavePluginSettings | undefined
+) => {
+  if (settings === undefined) {
+    return {
+      changed: false,
+      settings: settings,
+    };
+  }
+  const webdavRes = applyWebdavPresetRulesInplace(settings.webdav);
+  return {
+    changed: webdavRes.changed,
+    settings: settings,
+  };
+};

src/remote.ts

@@ -11,12 +11,10 @@ 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");
+import { log } from "./moreOnLog";
 
 export class RemoteClient {
   readonly serviceType: SUPPORTED_SERVICES_TYPE;
-  readonly s3Client?: s3.S3Client;
   readonly s3Config?: S3Config;
   readonly webdavClient?: webdav.WrappedWebdavClient;
   readonly webdavConfig?: WebdavConfig;
@@ -39,23 +37,30 @@ export class RemoteClient {
     // so we use a ref not copy of config here
     if (serviceType === "s3") {
       this.s3Config = s3Config;
-      this.s3Client = s3.getS3Client(this.s3Config);
     } else if (serviceType === "webdav") {
-      if (vaultName === undefined) {
-        throw Error("remember to provide vault name while init webdav client");
+      if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
+        throw Error(
+          "remember to provide vault name and callback while init webdav client"
+        );
       }
+      const remoteBaseDir = webdavConfig.remoteBaseDir || vaultName;
       this.webdavConfig = webdavConfig;
-      this.webdavClient = webdav.getWebdavClient(this.webdavConfig, vaultName);
+      this.webdavClient = webdav.getWebdavClient(
+        this.webdavConfig,
+        remoteBaseDir,
+        saveUpdatedConfigFunc
+      );
     } else if (serviceType === "dropbox") {
       if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
         throw Error(
           "remember to provide vault name and callback while init dropbox client"
         );
       }
+      const remoteBaseDir = dropboxConfig.remoteBaseDir || vaultName;
       this.dropboxConfig = dropboxConfig;
       this.dropboxClient = dropbox.getDropboxClient(
         this.dropboxConfig,
-        vaultName,
+        remoteBaseDir,
         saveUpdatedConfigFunc
       );
     } else if (serviceType === "onedrive") {
@@ -64,10 +69,11 @@ export class RemoteClient {
           "remember to provide vault name and callback while init onedrive client"
         );
       }
+      const remoteBaseDir = onedriveConfig.remoteBaseDir || vaultName;
       this.onedriveConfig = onedriveConfig;
       this.onedriveClient = onedrive.getOnedriveClient(
         this.onedriveConfig,
-        vaultName,
+        remoteBaseDir,
         saveUpdatedConfigFunc
       );
     } else {
@@ -78,7 +84,7 @@ export class RemoteClient {
   getRemoteMeta = async (fileOrFolderPath: string) => {
     if (this.serviceType === "s3") {
       return await s3.getRemoteMeta(
-        this.s3Client,
+        s3.getS3Client(this.s3Config),
         this.s3Config,
         fileOrFolderPath
       );
@@ -102,17 +108,21 @@ export class RemoteClient {
     isRecursively: boolean = false,
     password: string = "",
     remoteEncryptedKey: string = "",
-    foldersCreatedBefore: Set<string> | undefined = undefined
+    foldersCreatedBefore: Set<string> | undefined = undefined,
+    uploadRaw: boolean = false,
+    rawContent: string | ArrayBuffer = ""
   ) => {
     if (this.serviceType === "s3") {
       return await s3.uploadToRemote(
-        this.s3Client,
+        s3.getS3Client(this.s3Config),
         this.s3Config,
         fileOrFolderPath,
         vault,
         isRecursively,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        uploadRaw,
+        rawContent
       );
     } else if (this.serviceType === "webdav") {
       return await webdav.uploadToRemote(
@@ -121,7 +131,9 @@ export class RemoteClient {
         vault,
         isRecursively,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        uploadRaw,
+        rawContent
       );
     } else if (this.serviceType === "dropbox") {
       return await dropbox.uploadToRemote(
@@ -131,7 +143,9 @@ export class RemoteClient {
         isRecursively,
         password,
         remoteEncryptedKey,
-        foldersCreatedBefore
+        foldersCreatedBefore,
+        uploadRaw,
+        rawContent
       );
     } else if (this.serviceType === "onedrive") {
       return await onedrive.uploadToRemote(
@@ -141,22 +155,27 @@ export class RemoteClient {
         isRecursively,
         password,
         remoteEncryptedKey,
-        foldersCreatedBefore
+        foldersCreatedBefore,
+        uploadRaw,
+        rawContent
       );
     } else {
       throw Error(`not supported service type ${this.serviceType}`);
     }
   };
 
-  listFromRemote = async (prefix?: string) => {
+  listAllFromRemote = async () => {
     if (this.serviceType === "s3") {
-      return await s3.listFromRemote(this.s3Client, this.s3Config, prefix);
+      return await s3.listAllFromRemote(
+        s3.getS3Client(this.s3Config),
+        this.s3Config
+      );
     } else if (this.serviceType === "webdav") {
-      return await webdav.listFromRemote(this.webdavClient, prefix);
+      return await webdav.listAllFromRemote(this.webdavClient);
     } else if (this.serviceType === "dropbox") {
-      return await dropbox.listFromRemote(this.dropboxClient, prefix);
+      return await dropbox.listAllFromRemote(this.dropboxClient);
     } else if (this.serviceType === "onedrive") {
-      return await onedrive.listFromRemote(this.onedriveClient, prefix);
+      return await onedrive.listAllFromRemote(this.onedriveClient);
     } else {
       throw Error(`not supported service type ${this.serviceType}`);
     }
@@ -167,17 +186,19 @@ export class RemoteClient {
     vault: Vault,
     mtime: number,
     password: string = "",
-    remoteEncryptedKey: string = ""
+    remoteEncryptedKey: string = "",
+    skipSaving: boolean = false
   ) => {
     if (this.serviceType === "s3") {
       return await s3.downloadFromRemote(
-        this.s3Client,
+        s3.getS3Client(this.s3Config),
         this.s3Config,
         fileOrFolderPath,
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else if (this.serviceType === "webdav") {
       return await webdav.downloadFromRemote(
@@ -186,7 +207,8 @@ export class RemoteClient {
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else if (this.serviceType === "dropbox") {
       return await dropbox.downloadFromRemote(
@@ -195,7 +217,8 @@ export class RemoteClient {
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else if (this.serviceType === "onedrive") {
       return await onedrive.downloadFromRemote(
@@ -204,7 +227,8 @@ export class RemoteClient {
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else {
       throw Error(`not supported service type ${this.serviceType}`);
@@ -218,7 +242,7 @@ export class RemoteClient {
   ) => {
     if (this.serviceType === "s3") {
       return await s3.deleteFromRemote(
-        this.s3Client,
+        s3.getS3Client(this.s3Config),
         this.s3Config,
         fileOrFolderPath,
         password,
@@ -250,15 +274,22 @@ export class RemoteClient {
     }
   };
 
-  checkConnectivity = async () => {
+  checkConnectivity = async (callbackFunc?: any) => {
     if (this.serviceType === "s3") {
-      return await s3.checkConnectivity(this.s3Client, this.s3Config);
+      return await s3.checkConnectivity(
+        s3.getS3Client(this.s3Config),
+        this.s3Config,
+        callbackFunc
+      );
     } else if (this.serviceType === "webdav") {
-      return await webdav.checkConnectivity(this.webdavClient);
+      return await webdav.checkConnectivity(this.webdavClient, callbackFunc);
     } else if (this.serviceType === "dropbox") {
-      return await dropbox.checkConnectivity(this.dropboxClient);
+      return await dropbox.checkConnectivity(this.dropboxClient, callbackFunc);
     } else if (this.serviceType === "onedrive") {
-      return await onedrive.checkConnectivity(this.onedriveClient);
+      return await onedrive.checkConnectivity(
+        this.onedriveClient,
+        callbackFunc
+      );
     } else {
       throw Error(`not supported service type ${this.serviceType}`);
     }

src/remoteForDropbox.ts

@@ -1,4 +1,6 @@
-import { Dropbox, DropboxAuth, files } from "dropbox";
+import { rangeDelay } from "delay";
+import { Dropbox, DropboxAuth } from "dropbox";
+import type { files, DropboxResponseError, DropboxResponse } from "dropbox";
 import { Vault } from "obsidian";
 import * as path from "path";
 import {
@@ -8,12 +10,17 @@ import {
   OAUTH2_FORCE_EXPIRE_MILLISECONDS,
 } from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
-import { bufferToArrayBuffer, getFolderLevels, mkdirpInVault } from "./misc";
+import {
+  bufferToArrayBuffer,
+  getFolderLevels,
+  hasEmojiInText,
+  headersToRecord,
+  mkdirpInVault,
+} from "./misc";
 
 export { Dropbox } from "dropbox";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
   accessToken: "",
@@ -26,15 +33,18 @@ export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
   credentialsShouldBeDeletedAtTime: 0,
 };
 
-export const getDropboxPath = (fileOrFolderPath: string, vaultName: string) => {
+export const getDropboxPath = (
+  fileOrFolderPath: string,
+  remoteBaseDir: string
+) => {
   let key = fileOrFolderPath;
   if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
     // special
-    key = `/${vaultName}`;
+    key = `/${remoteBaseDir}`;
   }
   if (!fileOrFolderPath.startsWith("/")) {
     // then this is original path in Obsidian
-    key = `/${vaultName}/${fileOrFolderPath}`;
+    key = `/${remoteBaseDir}/${fileOrFolderPath}`;
   }
   if (key.endsWith("/")) {
     key = key.slice(0, key.length - 1);
@@ -42,16 +52,18 @@ export const getDropboxPath = (fileOrFolderPath: string, vaultName: string) => {
   return key;
 };
 
-const getNormPath = (fileOrFolderPath: string, vaultName: string) => {
+const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
   if (
     !(
-      fileOrFolderPath === `/${vaultName}` ||
-      fileOrFolderPath.startsWith(`/${vaultName}/`)
+      fileOrFolderPath === `/${remoteBaseDir}` ||
+      fileOrFolderPath.startsWith(`/${remoteBaseDir}/`)
     )
   ) {
-    throw Error(`"${fileOrFolderPath}" doesn't starts with "/${vaultName}/"`);
+    throw Error(
+      `"${fileOrFolderPath}" doesn't starts with "/${remoteBaseDir}/"`
+    );
   }
-  return fileOrFolderPath.slice(`/${vaultName}/`.length);
+  return fileOrFolderPath.slice(`/${remoteBaseDir}/`.length);
 };
 
 const fromDropboxItemToRemoteItem = (
@@ -59,9 +71,9 @@ const fromDropboxItemToRemoteItem = (
     | files.FileMetadataReference
     | files.FolderMetadataReference
     | files.DeletedMetadataReference,
-  vaultName: string
+  remoteBaseDir: string
 ): RemoteItem => {
-  let key = getNormPath(x.path_display, vaultName);
+  let key = getNormPath(x.path_display, remoteBaseDir);
   if (x[".tag"] === "folder" && !key.endsWith("/")) {
     key = `${key}/`;
   }
@@ -156,13 +168,20 @@ const fixLastModifiedTimeInplace = (allFilesFolders: RemoteItem[]) => {
 // see https://dropbox.tech/developers/pkce--what-and-why-
 ////////////////////////////////////////////////////////////////////////////////
 
-export const getAuthUrlAndVerifier = async (appKey: string) => {
+export const getAuthUrlAndVerifier = async (
+  appKey: string,
+  needManualPatse: boolean = false
+) => {
   const auth = new DropboxAuth({
     clientId: appKey,
   });
+
+  const callback = needManualPatse
+    ? undefined
+    : `obsidian://${COMMAND_CALLBACK_DROPBOX}`;
   const authUrl = (
     await auth.getAuthenticationUrl(
-      `obsidian://${COMMAND_CALLBACK_DROPBOX}`,
+      callback,
       undefined,
       "code",
       "offline",
@@ -259,19 +278,86 @@ export const setConfigBySuccessfullAuthInplace = async (
 // Other usual common methods
 ////////////////////////////////////////////////////////////////////////////////
 
+interface ErrSubType {
+  error: {
+    retry_after: number;
+  };
+}
+
+async function retryReq<T>(
+  reqFunc: () => Promise<DropboxResponse<T>>,
+  extraHint: string = ""
+): Promise<DropboxResponse<T>> {
+  const waitSeconds = [1, 2, 4, 8]; // hard code exponential backoff
+  for (let idx = 0; idx < waitSeconds.length; ++idx) {
+    try {
+      if (idx !== 0) {
+        log.warn(
+          `${extraHint === "" ? "" : extraHint + ": "}The ${
+            idx + 1
+          }-th try starts at time ${Date.now()}`
+        );
+      }
+      return await reqFunc();
+    } catch (e: unknown) {
+      const err = e as DropboxResponseError<ErrSubType>;
+      if (err.status === undefined) {
+        // then the err is not DropboxResponseError
+        throw err;
+      }
+      if (err.status !== 429) {
+        // then the err is not "too many requests", give up
+        throw err;
+      }
+
+      if (idx === waitSeconds.length - 1) {
+        // the last retry also failed, give up
+        throw new Error(
+          `${
+            extraHint === "" ? "" : extraHint + ": "
+          }"429 too many requests", after retrying for ${
+            idx + 1
+          } times still failed.`
+        );
+      }
+
+      const headers = headersToRecord(err.headers);
+      const svrSec =
+        err.error.error.retry_after ||
+        parseInt(headers["retry-after"] || "1") ||
+        1;
+      const fallbackSec = waitSeconds[idx];
+      const secMin = Math.max(svrSec, fallbackSec);
+      const secMax = Math.max(secMin * 1.8, 2);
+      log.warn(
+        `${
+          extraHint === "" ? "" : extraHint + ": "
+        }We have "429 too many requests" error of ${
+          idx + 1
+        }-th try, at time ${Date.now()}, and wait for ${secMin} ~ ${secMax} seconds to retry. Original info: ${JSON.stringify(
+          err.error,
+          null,
+          2
+        )}`
+      );
+      await rangeDelay(secMin * 1000, secMax * 1000);
+    }
+  }
+}
+
 export class WrappedDropboxClient {
   dropboxConfig: DropboxConfig;
-  vaultName: string;
+  remoteBaseDir: string;
   saveUpdatedConfigFunc: () => Promise<any>;
   dropbox: Dropbox;
   vaultFolderExists: boolean;
   constructor(
     dropboxConfig: DropboxConfig,
-    vaultName: string,
+    remoteBaseDir: string,
     saveUpdatedConfigFunc: () => Promise<any>
   ) {
     this.dropboxConfig = dropboxConfig;
-    this.vaultName = vaultName;
+    this.remoteBaseDir = remoteBaseDir;
     this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
     this.vaultFolderExists = false;
   }
@@ -285,9 +371,13 @@ export class WrappedDropboxClient {
       throw Error("The user has not manually auth yet.");
     }
     const currentTs = Date.now();
+    const customHeaders = {
+      "Cache-Control": "no-cache",
+    };
     if (this.dropboxConfig.accessTokenExpiresAtTime > currentTs) {
       this.dropbox = new Dropbox({
         accessToken: this.dropboxConfig.accessToken,
+        customHeaders: customHeaders,
       });
     } else {
       if (this.dropboxConfig.refreshToken === "") {
@@ -307,33 +397,41 @@ export class WrappedDropboxClient {
       );
       this.dropbox = new Dropbox({
         accessToken: this.dropboxConfig.accessToken,
+        customHeaders: customHeaders,
       });
     }
 
     // check vault folder
-    // log.info(`checking remote has folder /${this.vaultName}`);
+    // log.info(`checking remote has folder /${this.remoteBaseDir}`);
     if (this.vaultFolderExists) {
-      // log.info(`already checked, /${this.vaultName} exist before`)
+      // log.info(`already checked, /${this.remoteBaseDir} exist before`)
     } else {
       const res = await this.dropbox.filesListFolder({
         path: "",
         recursive: false,
       });
       for (const item of res.result.entries) {
-        if (item.path_display === `/${this.vaultName}`) {
+        if (item.path_display === `/${this.remoteBaseDir}`) {
           this.vaultFolderExists = true;
           break;
         }
       }
       if (!this.vaultFolderExists) {
-        log.info(`remote does not have folder /${this.vaultName}`);
+        log.info(`remote does not have folder /${this.remoteBaseDir}`);
+
+        if (hasEmojiInText(`/${this.remoteBaseDir}`)) {
+          throw new Error(
+            `/${this.remoteBaseDir}: Error: Dropbox does not support emoji in folder names.`
+          );
+        }
+
         await this.dropbox.filesCreateFolderV2({
-          path: `/${this.vaultName}`,
+          path: `/${this.remoteBaseDir}`,
         });
-        log.info(`remote folder /${this.vaultName} created`);
+        log.info(`remote folder /${this.remoteBaseDir} created`);
         this.vaultFolderExists = true;
       } else {
-        // log.info(`remote folder /${this.vaultName} exists`);
+        // log.info(`remote folder /${this.remoteBaseDir} exists`);
       }
     }
 
@@ -347,12 +445,12 @@ export class WrappedDropboxClient {
  */
 export const getDropboxClient = (
   dropboxConfig: DropboxConfig,
-  vaultName: string,
+  remoteBaseDir: string,
   saveUpdatedConfigFunc: () => Promise<any>
 ) => {
   return new WrappedDropboxClient(
     dropboxConfig,
-    vaultName,
+    remoteBaseDir,
     saveUpdatedConfigFunc
   );
 };
@@ -366,10 +464,12 @@ export const getRemoteMeta = async (
     // filesGetMetadata doesn't support root folder
     // we instead try to list files
     // if no error occurs, we ensemble a fake result.
-    const rsp = await client.dropbox.filesListFolder({
-      path: `/${client.vaultName}`,
+    const rsp = await retryReq(() =>
+      client.dropbox.filesListFolder({
+        path: `/${client.remoteBaseDir}`,
         recursive: false, // don't need to recursive here
-    });
+      })
+    );
     if (rsp.status !== 200) {
       throw Error(JSON.stringify(rsp));
     }
@@ -382,15 +482,17 @@ export const getRemoteMeta = async (
     } as RemoteItem;
   }
 
-  const key = getDropboxPath(fileOrFolderPath, client.vaultName);
+  const key = getDropboxPath(fileOrFolderPath, client.remoteBaseDir);
 
-  const rsp = await client.dropbox.filesGetMetadata({
+  const rsp = await retryReq(() =>
+    client.dropbox.filesGetMetadata({
       path: key,
-  });
+    })
+  );
   if (rsp.status !== 200) {
     throw Error(JSON.stringify(rsp));
   }
-  return fromDropboxItemToRemoteItem(rsp.result, client.vaultName);
+  return fromDropboxItemToRemoteItem(rsp.result, client.remoteBaseDir);
 };
 
 export const uploadToRemote = async (
@@ -400,7 +502,9 @@ export const uploadToRemote = async (
   isRecursively: boolean = false,
   password: string = "",
   remoteEncryptedKey: string = "",
-  foldersCreatedBefore: Set<string> | undefined = undefined
+  foldersCreatedBefore: Set<string> | undefined = undefined,
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
 ) => {
   await client.init();
 
@@ -408,13 +512,22 @@ export const uploadToRemote = async (
   if (password !== "") {
     uploadFile = remoteEncryptedKey;
   }
-  uploadFile = getDropboxPath(uploadFile, client.vaultName);
+  uploadFile = getDropboxPath(uploadFile, client.remoteBaseDir);
+
+  if (hasEmojiInText(uploadFile)) {
+    throw new Error(
+      `${uploadFile}: Error: Dropbox does not support emoji in file / folder names.`
+    );
+  }
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
   if (isFolder && isRecursively) {
     throw Error("upload function doesn't implement recursive function yet!");
   } else if (isFolder && !isRecursively) {
+    if (uploadRaw) {
+      throw Error(`you specify uploadRaw, but you also provide a folder key!`);
+    }
     // folder
     if (password === "") {
       // if not encrypted, mkdir a remote folder
@@ -422,11 +535,19 @@ export const uploadToRemote = async (
         // created, pass
       } else {
         try {
-          await client.dropbox.filesCreateFolderV2({
+          await retryReq(
+            () =>
+              client.dropbox.filesCreateFolderV2({
                 path: uploadFile,
-          });
+              }),
+            fileOrFolderPath
+          );
           foldersCreatedBefore?.add(uploadFile);
-        } catch (err) {
+        } catch (e: unknown) {
+          const err = e as DropboxResponseError<files.CreateFolderError>;
+          if (err.status === undefined) {
+            throw err;
+          }
           if (err.status === 409) {
             // pass
             foldersCreatedBefore?.add(uploadFile);
@@ -439,33 +560,52 @@ export const uploadToRemote = async (
       return res;
     } else {
       // if encrypted, upload a fake file with the encrypted file name
-      await client.dropbox.filesUpload({
+      await retryReq(
+        () =>
+          client.dropbox.filesUpload({
             path: uploadFile,
             contents: "",
-      });
+          }),
+        fileOrFolderPath
+      );
       return await getRemoteMeta(client, uploadFile);
     }
   } else {
     // file
     // we ignore isRecursively parameter here
-    const localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    let localContent = undefined;
+    if (uploadRaw) {
+      if (typeof rawContent === "string") {
+        localContent = new TextEncoder().encode(rawContent).buffer;
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
     }
     // in dropbox, we don't need to create folders before uploading! cool!
     // TODO: filesUploadSession for larger files (>=150 MB)
-    await client.dropbox.filesUpload({
+
+    await retryReq(
+      () =>
+        client.dropbox.filesUpload({
           path: uploadFile,
           contents: remoteContent,
           mode: {
             ".tag": "overwrite",
           },
-    });
+        }),
+      fileOrFolderPath
+    );
+
     // we want to mark that parent folders are created
     if (foldersCreatedBefore !== undefined) {
       const dirs = getFolderLevels(uploadFile).map((x) =>
-        getDropboxPath(x, client.vaultName)
+        getDropboxPath(x, client.remoteBaseDir)
       );
       for (const dir of dirs) {
         foldersCreatedBefore?.add(dir);
@@ -475,16 +615,10 @@ export const uploadToRemote = async (
   }
 };
 
-export const listFromRemote = async (
-  client: WrappedDropboxClient,
-  prefix?: string
-) => {
-  if (prefix !== undefined) {
-    throw Error("prefix not supported (yet)");
-  }
+export const listAllFromRemote = async (client: WrappedDropboxClient) => {
   await client.init();
   let res = await client.dropbox.filesListFolder({
-    path: `/${client.vaultName}`,
+    path: `/${client.remoteBaseDir}`,
     recursive: true,
     include_deleted: false,
     limit: 1000,
@@ -497,8 +631,8 @@ export const listFromRemote = async (
   const contents = res.result.entries;
   const unifiedContents = contents
     .filter((x) => x[".tag"] !== "deleted")
-    .filter((x) => x.path_display !== `/${client.vaultName}`)
-    .map((x) => fromDropboxItemToRemoteItem(x, client.vaultName));
+    .filter((x) => x.path_display !== `/${client.remoteBaseDir}`)
+    .map((x) => fromDropboxItemToRemoteItem(x, client.remoteBaseDir));
 
   while (res.result.has_more) {
     res = await client.dropbox.filesListFolderContinue({
@@ -511,8 +645,8 @@ export const listFromRemote = async (
     const contents2 = res.result.entries;
     const unifiedContents2 = contents2
       .filter((x) => x[".tag"] !== "deleted")
-      .filter((x) => x.path_display !== `/${client.vaultName}`)
-      .map((x) => fromDropboxItemToRemoteItem(x, client.vaultName));
+      .filter((x) => x.path_display !== `/${client.remoteBaseDir}`)
+      .map((x) => fromDropboxItemToRemoteItem(x, client.remoteBaseDir));
     unifiedContents.push(...unifiedContents2);
   }
 
@@ -528,10 +662,14 @@ const downloadFromRemoteRaw = async (
   fileOrFolderPath: string
 ) => {
   await client.init();
-  const key = getDropboxPath(fileOrFolderPath, client.vaultName);
-  const rsp = await client.dropbox.filesDownload({
+  const key = getDropboxPath(fileOrFolderPath, client.remoteBaseDir);
+  const rsp = await retryReq(
+    () =>
+      client.dropbox.filesDownload({
         path: key,
-  });
+      }),
+    fileOrFolderPath
+  );
   if ((rsp.result as any).fileBlob !== undefined) {
     // we get a Blob
     const content = (rsp.result as any).fileBlob as Blob;
@@ -551,13 +689,16 @@ export const downloadFromRemote = async (
   vault: Vault,
   mtime: number,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  skipSaving: boolean = false
 ) => {
   await client.init();
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
+  if (!skipSaving) {
     await mkdirpInVault(fileOrFolderPath, vault);
+  }
 
   // the file is always local file
   // we need to encrypt it
@@ -565,21 +706,25 @@ export const downloadFromRemote = async (
   if (isFolder) {
     // mkdirp locally is enough
     // do nothing here
+    return new ArrayBuffer(0);
   } else {
     let downloadFile = fileOrFolderPath;
     if (password !== "") {
       downloadFile = remoteEncryptedKey;
     }
-    downloadFile = getDropboxPath(downloadFile, client.vaultName);
+    downloadFile = getDropboxPath(downloadFile, client.remoteBaseDir);
     const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
     let localContent = remoteContent;
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
+    if (!skipSaving) {
       await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
         mtime: mtime,
       });
     }
+    return localContent;
+  }
 };
 
 export const deleteFromRemote = async (
@@ -595,20 +740,27 @@ export const deleteFromRemote = async (
   if (password !== "") {
     remoteFileName = remoteEncryptedKey;
   }
-  remoteFileName = getDropboxPath(remoteFileName, client.vaultName);
+  remoteFileName = getDropboxPath(remoteFileName, client.remoteBaseDir);
 
   await client.init();
   try {
-    await client.dropbox.filesDeleteV2({
+    await retryReq(
+      () =>
+        client.dropbox.filesDeleteV2({
           path: remoteFileName,
-    });
+        }),
+      fileOrFolderPath
+    );
   } catch (err) {
     console.error("some error while deleting");
     console.error(err);
   }
 };
 
-export const checkConnectivity = async (client: WrappedDropboxClient) => {
+export const checkConnectivity = async (
+  client: WrappedDropboxClient,
+  callbackFunc?: any
+) => {
   try {
     const results = await getRemoteMeta(client, "/");
     if (results === undefined) {
@@ -616,8 +768,10 @@ export const checkConnectivity = async (client: WrappedDropboxClient) => {
     }
     return true;
   } catch (err) {
-    console.error("dropbox connectivity error:");
-    console.error(err);
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };

src/remoteForOnedrive.ts

@@ -1,35 +1,29 @@
 import { CryptoProvider, PublicClientApplication } from "@azure/msal-node";
-import {
-  AuthenticationProvider,
-  Client,
-  FileUpload,
-  LargeFileUploadSession,
-  LargeFileUploadTask,
-  LargeFileUploadTaskOptions,
-  Range,
-  UploadEventHandlers,
-  UploadResult,
-} from "@microsoft/microsoft-graph-client";
-import type { DriveItem, User } from "@microsoft/microsoft-graph-types";
+import { AuthenticationProvider } from "@microsoft/microsoft-graph-client";
+import type {
+  DriveItem,
+  UploadSession,
+  User,
+} from "@microsoft/microsoft-graph-types";
 import cloneDeep from "lodash/cloneDeep";
-import { request, Vault } from "obsidian";
-import * as path from "path";
+import { request, requestUrl, requireApiVersion, Vault } from "obsidian";
 import {
-  DropboxConfig,
+  VALID_REQURL,
+  COMMAND_CALLBACK_ONEDRIVE,
+  DEFAULT_CONTENT_TYPE,
   OAUTH2_FORCE_EXPIRE_MILLISECONDS,
   OnedriveConfig,
   RemoteItem,
 } from "./baseTypes";
-import { COMMAND_CALLBACK_ONEDRIVE } from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import {
+  bufferToArrayBuffer,
   getRandomArrayBuffer,
   getRandomIntInclusive,
   mkdirpInVault,
 } from "./misc";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 const SCOPES = ["User.Read", "Files.ReadWrite.AppFolder", "offline_access"];
 const REDIRECT_URI = `obsidian://${COMMAND_CALLBACK_ONEDRIVE}`;
@@ -210,9 +204,9 @@ export const setConfigBySuccessfullAuthInplace = async (
 // Other usual common methods
 ////////////////////////////////////////////////////////////////////////////////
 
-const getOnedrivePath = (fileOrFolderPath: string, vaultName: string) => {
+const getOnedrivePath = (fileOrFolderPath: string, remoteBaseDir: string) => {
   // https://docs.microsoft.com/en-us/onedrive/developer/rest-api/concepts/special-folders-appfolder?view=odsp-graph-online
-  const prefix = `/drive/special/approot:/${vaultName}`;
+  const prefix = `/drive/special/approot:/${remoteBaseDir}`;
   if (fileOrFolderPath.startsWith(prefix)) {
     // already transformed, return as is
     return fileOrFolderPath;
@@ -231,8 +225,8 @@ const getOnedrivePath = (fileOrFolderPath: string, vaultName: string) => {
   return key;
 };
 
-const getNormPath = (fileOrFolderPath: string, vaultName: string) => {
-  const prefix = `/drive/special/approot:/${vaultName}`;
+const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
+  const prefix = `/drive/special/approot:/${remoteBaseDir}`;
 
   if (
     !(fileOrFolderPath === prefix || fileOrFolderPath.startsWith(`${prefix}/`))
@@ -254,16 +248,16 @@ const constructFromDriveItemToRemoteItemError = (x: DriveItem) => {
 
 const fromDriveItemToRemoteItem = (
   x: DriveItem,
-  vaultName: string
+  remoteBaseDir: string
 ): RemoteItem => {
   let key = "";
 
   // possible prefix:
-  // pure english: /drive/root:/Apps/remotely-save/${vaultName}
-  // or localized, e.g.: /drive/root:/应用/remotely-save/${vaultName}
+  // pure english: /drive/root:/Apps/remotely-save/${remoteBaseDir}
+  // or localized, e.g.: /drive/root:/应用/remotely-save/${remoteBaseDir}
   const FIRST_COMMON_PREFIX_REGEX = /^\/drive\/root:\/[^\/]+\/remotely-save\//g;
   // or the root is absolute path /Livefolders,
-  // e.g.: /Livefolders/应用/remotely-save/${vaultName}
+  // e.g.: /Livefolders/应用/remotely-save/${remoteBaseDir}
   const SECOND_COMMON_PREFIX_REGEX = /^\/Livefolders\/[^\/]+\/remotely-save\//g;
 
   // another possibile prefix
@@ -276,26 +270,26 @@ const fromDriveItemToRemoteItem = (
   );
   if (
     matchFirstPrefixRes !== null &&
-    fullPathOriginal.startsWith(`${matchFirstPrefixRes[0]}${vaultName}`)
+    fullPathOriginal.startsWith(`${matchFirstPrefixRes[0]}${remoteBaseDir}`)
   ) {
-    const foundPrefix = `${matchFirstPrefixRes[0]}${vaultName}`;
+    const foundPrefix = `${matchFirstPrefixRes[0]}${remoteBaseDir}`;
     key = fullPathOriginal.substring(foundPrefix.length + 1);
   } else if (
     matchSecondPrefixRes !== null &&
-    fullPathOriginal.startsWith(`${matchSecondPrefixRes[0]}${vaultName}`)
+    fullPathOriginal.startsWith(`${matchSecondPrefixRes[0]}${remoteBaseDir}`)
   ) {
-    const foundPrefix = `${matchSecondPrefixRes[0]}${vaultName}`;
+    const foundPrefix = `${matchSecondPrefixRes[0]}${remoteBaseDir}`;
     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>
+    // /drive/items/<some_id>!<another_id>:/${remoteBaseDir}/<subfolder>
     // with uri encoded!
     const parPath = decodeURIComponent(x.parentReference.path);
     key = parPath.substring(parPath.indexOf(":") + 1);
-    if (key.startsWith(`/${vaultName}/`)) {
-      key = key.substring(`/${vaultName}/`.length);
+    if (key.startsWith(`/${remoteBaseDir}/`)) {
+      key = key.substring(`/${remoteBaseDir}/`.length);
       key = `${key}/${x.name}`;
-    } else if (key === `/${vaultName}`) {
+    } else if (key === `/${remoteBaseDir}`) {
       key = x.name;
     } else {
       throw Error(
@@ -321,7 +315,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
   };
 };
 
@@ -375,22 +369,20 @@ class MyAuthProvider implements AuthenticationProvider {
 
 export class WrappedOnedriveClient {
   onedriveConfig: OnedriveConfig;
-  vaultName: string;
-  client: Client;
+  remoteBaseDir: string;
   vaultFolderExists: boolean;
+  authGetter: MyAuthProvider;
   saveUpdatedConfigFunc: () => Promise<any>;
   constructor(
     onedriveConfig: OnedriveConfig,
-    vaultName: string,
+    remoteBaseDir: string,
     saveUpdatedConfigFunc: () => Promise<any>
   ) {
     this.onedriveConfig = onedriveConfig;
-    this.vaultName = vaultName;
+    this.remoteBaseDir = remoteBaseDir;
     this.vaultFolderExists = false;
     this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
-    this.client = Client.initWithMiddleware({
-      authProvider: new MyAuthProvider(onedriveConfig, saveUpdatedConfigFunc),
-    });
+    this.authGetter = new MyAuthProvider(onedriveConfig, saveUpdatedConfigFunc);
   }
 
   init = async () => {
@@ -403,39 +395,205 @@ export class WrappedOnedriveClient {
     }
 
     // check vault folder
-    // log.info(`checking remote has folder /${this.vaultName}`);
+    // log.info(`checking remote has folder /${this.remoteBaseDir}`);
     if (this.vaultFolderExists) {
-      // log.info(`already checked, /${this.vaultName} exist before`)
+      // log.info(`already checked, /${this.remoteBaseDir} exist before`)
     } else {
-      const k = await this.client.api("/drive/special/approot/children").get();
-      // log.info(k);
+      const k = await this.getJson("/drive/special/approot/children");
+      // log.debug(k);
       this.vaultFolderExists =
-        (k.value as DriveItem[]).filter((x) => x.name === this.vaultName)
+        (k.value as DriveItem[]).filter((x) => x.name === this.remoteBaseDir)
           .length > 0;
       if (!this.vaultFolderExists) {
-        log.info(`remote does not have folder /${this.vaultName}`);
-        await this.client.api("/drive/special/approot/children").post({
-          name: `${this.vaultName}`,
+        log.info(`remote does not have folder /${this.remoteBaseDir}`);
+        await this.postJson("/drive/special/approot/children", {
+          name: `${this.remoteBaseDir}`,
           folder: {},
           "@microsoft.graph.conflictBehavior": "replace",
         });
-        log.info(`remote folder /${this.vaultName} created`);
+        log.info(`remote folder /${this.remoteBaseDir} created`);
         this.vaultFolderExists = true;
       } else {
-        // log.info(`remote folder /${this.vaultName} exists`);
+        // log.info(`remote folder /${this.remoteBaseDir} 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()}`,
+          "Cache-Control": "no-cache",
+        },
+      })
+    );
+  };
+
+  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}`);
+    if (VALID_REQURL) {
+      await requestUrl({
+        url: theUrl,
+        method: "DELETE",
+        headers: {
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      });
+    } else {
+      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:
+    // 20220401: On Android, requestUrl has issue that text becomes base64.
+    // Use fetch everywhere instead!
+    if (false /*VALID_REQURL*/) {
+      await requestUrl({
+        url: theUrl,
+        method: "PUT",
+        body: payload,
+        contentType: DEFAULT_CONTENT_TYPE,
+        headers: {
+          "Content-Type": DEFAULT_CONTENT_TYPE,
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      });
+    } else {
+      await fetch(theUrl, {
+        method: "PUT",
+        body: payload,
+        headers: {
+          "Content-Type": DEFAULT_CONTENT_TYPE,
+          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}`
+    );
+    // NO AUTH HEADER here!
+    // TODO:
+    // 20220401: On Android, requestUrl has issue that text becomes base64.
+    // Use fetch everywhere instead!
+    if (false /*VALID_REQURL*/) {
+      const res = await requestUrl({
+        url: theUrl,
+        method: "PUT",
+        body: bufferToArrayBuffer(payload.subarray(rangeStart, rangeEnd)),
+        contentType: DEFAULT_CONTENT_TYPE,
+        headers: {
+          // no "Content-Length" allowed here
+          "Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
+          /* "Cache-Control": "no-cache", not allowed here!!! */
+        },
+      });
+      return res.json as DriveItem | UploadSession;
+    } else {
+      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": DEFAULT_CONTENT_TYPE,
+          /* "Cache-Control": "no-cache", not allowed here!!! */
+        },
+      });
+      return (await res.json()) as DriveItem | UploadSession;
+    }
+  };
 }
 
 export const getOnedriveClient = (
   onedriveConfig: OnedriveConfig,
-  vaultName: string,
+  remoteBaseDir: string,
   saveUpdatedConfigFunc: () => Promise<any>
 ) => {
   return new WrappedOnedriveClient(
     onedriveConfig,
-    vaultName,
+    remoteBaseDir,
     saveUpdatedConfigFunc
   );
 };
@@ -444,26 +602,21 @@ export const getOnedriveClient = (
  * Use delta api to list all files and folders
  * https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_delta?view=odsp-graph-online
  * @param client
- * @param prefix
  */
-export const listFromRemote = async (
-  client: WrappedOnedriveClient,
-  prefix?: string
-) => {
-  if (prefix !== undefined) {
-    throw Error("prefix not supported (yet)");
-  }
+export const listAllFromRemote = async (client: WrappedOnedriveClient) => {
   await client.init();
 
   const NEXT_LINK_KEY = "@odata.nextLink";
   const DELTA_LINK_KEY = "@odata.deltaLink";
-  let res = await client.client
-    .api(`/drive/special/approot:/${client.vaultName}:/delta`)
-    .get();
+
+  let res = await client.getJson(
+    `/drive/special/approot:/${client.remoteBaseDir}:/delta`
+  );
   let driveItems = res.value as DriveItem[];
+  // log.debug(driveItems);
 
   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[]));
   }
 
@@ -473,16 +626,11 @@ export const listFromRemote = async (
     await client.saveUpdatedConfigFunc();
   }
 
-  driveItems = driveItems.map((x) => {
-    const y = cloneDeep(x);
-    y.parentReference.path = y.parentReference.path.replace("/Apps", "/应用");
-    return y;
-  });
-
   // unify everything to RemoteItem
   const unifiedContents = driveItems
-    .map((x) => fromDriveItemToRemoteItem(x, client.vaultName))
+    .map((x) => fromDriveItemToRemoteItem(x, client.remoteBaseDir))
     .filter((x) => x.key !== "/");
+
   return {
     Contents: unifiedContents,
   };
@@ -493,15 +641,14 @@ export const getRemoteMeta = async (
   fileOrFolderPath: string
 ) => {
   await client.init();
-  const remotePath = getOnedrivePath(fileOrFolderPath, client.vaultName);
+  const remotePath = getOnedrivePath(fileOrFolderPath, client.remoteBaseDir);
   // log.info(`remotePath=${remotePath}`);
-  const rsp = await client.client
-    .api(remotePath)
-    .select("cTag,eTag,fileSystemInfo,folder,file,name,parentReference,size")
-    .get();
+  const rsp = await client.getJson(
+    `${remotePath}?$select=cTag,eTag,fileSystemInfo,folder,file,name,parentReference,size`
+  );
   // log.info(rsp);
   const driveItem = rsp as DriveItem;
-  const res = fromDriveItemToRemoteItem(driveItem, client.vaultName);
+  const res = fromDriveItemToRemoteItem(driveItem, client.remoteBaseDir);
   // log.info(res);
   return res;
 };
@@ -513,7 +660,9 @@ export const uploadToRemote = async (
   isRecursively: boolean = false,
   password: string = "",
   remoteEncryptedKey: string = "",
-  foldersCreatedBefore: Set<string> | undefined = undefined
+  foldersCreatedBefore: Set<string> | undefined = undefined,
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
 ) => {
   await client.init();
 
@@ -521,14 +670,17 @@ export const uploadToRemote = async (
   if (password !== "") {
     uploadFile = remoteEncryptedKey;
   }
-  uploadFile = getOnedrivePath(uploadFile, client.vaultName);
-  // log.info(`uploadFile=${uploadFile}`);
+  uploadFile = getOnedrivePath(uploadFile, client.remoteBaseDir);
+  log.debug(`uploadFile=${uploadFile}`);
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
   if (isFolder && isRecursively) {
     throw Error("upload function doesn't implement recursive function yet!");
   } else if (isFolder && !isRecursively) {
+    if (uploadRaw) {
+      throw Error(`you specify uploadRaw, but you also provide a folder key!`);
+    }
     // folder
     if (password === "") {
       // if not encrypted, mkdir a remote folder
@@ -537,7 +689,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",
         });
@@ -557,39 +709,13 @@ export const uploadToRemote = async (
         password
       );
 
-      const uploadSession: LargeFileUploadSession =
-        await LargeFileUploadTask.createUploadSession(
-          client.client,
-          `https://graph.microsoft.com/v1.0/me${encodeURIComponent(
-            uploadFile
-          )}:/createUploadSession`,
-          {
-            item: {
+      // an encrypted folder is always small, we just use put here
+      await client.putArrayBuffer(
+        `${uploadFile}:/content?${new URLSearchParams({
           "@microsoft.graph.conflictBehavior": "replace",
-            },
-          }
+        })}`,
+        arrBufRandom
       );
-      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
-              // log.info(
-              //   `uploading ${range.minValue}-${range.maxValue} of ${fileOrFolderPath}`
-              // );
-            },
-          } as UploadEventHandlers,
-        } as LargeFileUploadTaskOptions
-      );
-      const uploadResult: UploadResult = await task.upload();
       // log.info(uploadResult)
       const res = await getRemoteMeta(client, uploadFile);
       return res;
@@ -597,7 +723,16 @@ export const uploadToRemote = async (
   } else {
     // file
     // we ignore isRecursively parameter here
-    const localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    let localContent = undefined;
+    if (uploadRaw) {
+      if (typeof rawContent === "string") {
+        localContent = new TextEncoder().encode(rawContent).buffer;
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
@@ -605,48 +740,55 @@ export const uploadToRemote = async (
 
     // no need to create parent folders firstly, cool!
 
-    // we need to customize the special root folder,
-    // so use LargeFileUploadTask instead of OneDriveLargeFileUploadTask
-    const progress = (range?: Range) => {
-      // Handle progress event
-      // log.info(
-      //   `uploading ${range.minValue}-${range.maxValue} of ${fileOrFolderPath}`
-      // );
-    };
-    const uploadEventHandlers: UploadEventHandlers = {
-      progress: progress,
-    };
-    const options: LargeFileUploadTaskOptions = {
-      rangeSize: 1024 * 1024,
-      uploadEventHandlers: uploadEventHandlers,
-    };
-    const payload = {
+    // 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
+    const DIRECT_UPLOAD_MAX_SIZE = 1000 * 1000 * 4; // 4 Megabyte
+
+    if (remoteContent.byteLength < DIRECT_UPLOAD_MAX_SIZE) {
+      // directly using put!
+      await client.putArrayBuffer(
+        `${uploadFile}:/content?${new URLSearchParams({
+          "@microsoft.graph.conflictBehavior": "replace",
+        })}`,
+        remoteContent
+      );
+    } else {
+      // upload large files!
+      // ref: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createuploadsession?view=odsp-graph-online
+
+      // 1. create uploadSession
+      // uploadFile already starts with /drive/special/approot:/${remoteBaseDir}
+      const s: UploadSession = await client.postJson(
+        `${uploadFile}:/createUploadSession`,
+        {
           item: {
             "@microsoft.graph.conflictBehavior": "replace",
           },
-    };
-    // uploadFile already starts with /drive/special/approot:/${vaultName}
-    const uploadSession: LargeFileUploadSession =
-      await LargeFileUploadTask.createUploadSession(
-        client.client,
-        `https://graph.microsoft.com/v1.0/me${encodeURIComponent(
-          uploadFile
-        )}:/createUploadSession`,
-        payload
+        }
       );
-    const fileObject = new FileUpload(
-      remoteContent,
-      path.posix.basename(uploadFile),
-      remoteContent.byteLength
+      const uploadUrl = s.uploadUrl;
+      log.debug("uploadSession = ");
+      log.debug(s);
+
+      // 2. upload by ranges
+      // convert to uint8
+      const uint8 = new Uint8Array(remoteContent);
+
+      // 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 task = new LargeFileUploadTask(
-      client.client,
-      fileObject,
-      uploadSession,
-      options
-    );
-    const uploadResult: UploadResult = await task.upload();
-    // log.info(uploadResult)
+        rangeStart += RANGE_SIZE;
+      }
+    }
+
     const res = await getRemoteMeta(client, uploadFile);
     return res;
   }
@@ -657,14 +799,24 @@ const downloadFromRemoteRaw = async (
   fileOrFolderPath: string
 ): Promise<ArrayBuffer> => {
   await client.init();
-  const key = getOnedrivePath(fileOrFolderPath, client.vaultName);
-  const rsp = await client.client
-    .api(key)
-    .select("@microsoft.graph.downloadUrl")
-    .get();
+  const key = getOnedrivePath(fileOrFolderPath, client.remoteBaseDir);
+  const rsp = await client.getJson(
+    `${key}?$select=@microsoft.graph.downloadUrl`
+  );
   const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
-  const content = await (await fetch(downloadUrl)).arrayBuffer();
+  if (VALID_REQURL) {
+    const content = (
+      await requestUrl({
+        url: downloadUrl,
+        headers: { "Cache-Control": "no-cache" },
+      })
+    ).arrayBuffer;
     return content;
+  } else {
+    const content = await // cannot set no-cache here, will have cors error
+    (await fetch(downloadUrl)).arrayBuffer();
+    return content;
+  }
 };
 
 export const downloadFromRemote = async (
@@ -673,32 +825,39 @@ export const downloadFromRemote = async (
   vault: Vault,
   mtime: number,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  skipSaving: boolean = false
 ) => {
   await client.init();
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
+  if (!skipSaving) {
     await mkdirpInVault(fileOrFolderPath, vault);
+  }
 
   if (isFolder) {
     // mkdirp locally is enough
     // do nothing here
+    return new ArrayBuffer(0);
   } else {
     let downloadFile = fileOrFolderPath;
     if (password !== "") {
       downloadFile = remoteEncryptedKey;
     }
-    downloadFile = getOnedrivePath(downloadFile, client.vaultName);
+    downloadFile = getOnedrivePath(downloadFile, client.remoteBaseDir);
     const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
     let localContent = remoteContent;
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
+    if (!skipSaving) {
       await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
         mtime: mtime,
       });
     }
+    return localContent;
+  }
 };
 
 export const deleteFromRemote = async (
@@ -714,24 +873,31 @@ export const deleteFromRemote = async (
   if (password !== "") {
     remoteFileName = remoteEncryptedKey;
   }
-  remoteFileName = getOnedrivePath(remoteFileName, client.vaultName);
+  remoteFileName = getOnedrivePath(remoteFileName, client.remoteBaseDir);
 
   await client.init();
-  await client.client.api(remoteFileName).delete();
+  await client.deleteJson(remoteFileName);
 };
 
-export const checkConnectivity = async (client: WrappedOnedriveClient) => {
+export const checkConnectivity = async (
+  client: WrappedOnedriveClient,
+  callbackFunc?: any
+) => {
   try {
     const k = await getUserDisplayName(client);
     return k !== "<unknown display name>";
   } catch (err) {
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };
 
 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>";
 };
 
@@ -744,7 +910,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

@@ -11,11 +11,27 @@ import {
   S3Client,
 } from "@aws-sdk/client-s3";
 import { Upload } from "@aws-sdk/lib-storage";
+import { HttpHandler, HttpRequest, HttpResponse } from "@smithy/protocol-http";
+import {
+  FetchHttpHandler,
+  FetchHttpHandlerOptions,
+} from "@smithy/fetch-http-handler";
+// @ts-ignore
+import { requestTimeout } from "@smithy/fetch-http-handler/dist-es/request-timeout";
+import { buildQueryString } from "@smithy/querystring-builder";
+import { HeaderBag, HttpHandlerOptions, Provider } from "@aws-sdk/types";
 import { Buffer } from "buffer";
 import * as mime from "mime-types";
-import { Vault } from "obsidian";
+import { Vault, requestUrl, RequestUrlParam } from "obsidian";
 import { Readable } from "stream";
-import { RemoteItem, S3Config } from "./baseTypes";
+import * as path from "path";
+import AggregateError from "aggregate-error";
+import {
+  DEFAULT_CONTENT_TYPE,
+  RemoteItem,
+  S3Config,
+  VALID_REQURL,
+} from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import {
   arrayBufferToBuffer,
@@ -25,8 +41,119 @@ import {
 
 export { S3Client } from "@aws-sdk/client-s3";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
+
+////////////////////////////////////////////////////////////////////////////////
+// special handler using Obsidian requestUrl
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * This is close to origin implementation of FetchHttpHandler
+ * https://github.com/aws/aws-sdk-js-v3/blob/main/packages/fetch-http-handler/src/fetch-http-handler.ts
+ * that is released under Apache 2 License.
+ * But this uses Obsidian requestUrl instead.
+ */
+class ObsHttpHandler extends FetchHttpHandler {
+  requestTimeoutInMs: number;
+  constructor(options?: FetchHttpHandlerOptions) {
+    super(options);
+    this.requestTimeoutInMs =
+      options === undefined ? undefined : options.requestTimeout;
+  }
+  async handle(
+    request: HttpRequest,
+    { abortSignal }: HttpHandlerOptions = {}
+  ): Promise<{ response: HttpResponse }> {
+    if (abortSignal?.aborted) {
+      const abortError = new Error("Request aborted");
+      abortError.name = "AbortError";
+      return Promise.reject(abortError);
+    }
+
+    let path = request.path;
+    if (request.query) {
+      const queryString = buildQueryString(request.query);
+      if (queryString) {
+        path += `?${queryString}`;
+      }
+    }
+
+    const { port, method } = request;
+    const url = `${request.protocol}//${request.hostname}${
+      port ? `:${port}` : ""
+    }${path}`;
+    const body =
+      method === "GET" || method === "HEAD" ? undefined : request.body;
+
+    const transformedHeaders: Record<string, string> = {};
+    for (const key of Object.keys(request.headers)) {
+      const keyLower = key.toLowerCase();
+      if (keyLower === "host" || keyLower === "content-length") {
+        continue;
+      }
+      transformedHeaders[keyLower] = request.headers[key];
+    }
+
+    let contentType: string = undefined;
+    if (transformedHeaders["content-type"] !== undefined) {
+      contentType = transformedHeaders["content-type"];
+    }
+
+    let transformedBody: any = body;
+    if (ArrayBuffer.isView(body)) {
+      transformedBody = bufferToArrayBuffer(body);
+    }
+
+    const param: RequestUrlParam = {
+      body: transformedBody,
+      headers: transformedHeaders,
+      method: method,
+      url: url,
+      contentType: contentType,
+    };
+
+    const raceOfPromises = [
+      requestUrl(param).then((rsp) => {
+        const headers = rsp.headers;
+        const headersLower: Record<string, string> = {};
+        for (const key of Object.keys(headers)) {
+          headersLower[key.toLowerCase()] = headers[key];
+        }
+        const stream = new ReadableStream<Uint8Array>({
+          start(controller) {
+            controller.enqueue(new Uint8Array(rsp.arrayBuffer));
+            controller.close();
+          },
+        });
+        return {
+          response: new HttpResponse({
+            headers: headersLower,
+            statusCode: rsp.status,
+            body: stream,
+          }),
+        };
+      }),
+      requestTimeout(this.requestTimeoutInMs),
+    ];
+
+    if (abortSignal) {
+      raceOfPromises.push(
+        new Promise<never>((resolve, reject) => {
+          abortSignal.onabort = () => {
+            const abortError = new Error("Request aborted");
+            abortError.name = "AbortError";
+            reject(abortError);
+          };
+        })
+      );
+    }
+    return Promise.race(raceOfPromises);
+  }
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// other stuffs
+////////////////////////////////////////////////////////////////////////////////
 
 export const DEFAULT_S3_CONFIG = {
   s3Endpoint: "",
@@ -34,13 +161,66 @@ export const DEFAULT_S3_CONFIG = {
   s3AccessKeyID: "",
   s3SecretAccessKey: "",
   s3BucketName: "",
+  bypassCorsLocally: true,
+  partsConcurrency: 20,
+  forcePathStyle: false,
+  remotePrefix: "",
 };
 
 export type S3ObjectType = _Object;
 
-const fromS3ObjectToRemoteItem = (x: S3ObjectType) => {
+export const simpleTransRemotePrefix = (x: string) => {
+  if (x === undefined) {
+    return "";
+  }
+  let y = path.posix.normalize(x.trim());
+  if (y === undefined || y === "" || y === "/" || y === ".") {
+    return "";
+  }
+  if (y.startsWith("/")) {
+    y = y.slice(1);
+  }
+  if (!y.endsWith("/")) {
+    y = `${y}/`;
+  }
+  return y;
+};
+
+const getRemoteWithPrefixPath = (
+  fileOrFolderPath: string,
+  remotePrefix: string
+) => {
+  let key = fileOrFolderPath;
+  if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
+    // special
+    key = remotePrefix;
+  }
+  if (!fileOrFolderPath.startsWith("/")) {
+    key = `${remotePrefix}${fileOrFolderPath}`;
+  }
+  return key;
+};
+
+const getLocalNoPrefixPath = (
+  fileOrFolderPathWithRemotePrefix: string,
+  remotePrefix: string
+) => {
+  if (
+    !(
+      fileOrFolderPathWithRemotePrefix === `${remotePrefix}` ||
+      fileOrFolderPathWithRemotePrefix.startsWith(`${remotePrefix}`)
+    )
+  ) {
+    throw Error(
+      `"${fileOrFolderPathWithRemotePrefix}" doesn't starts with "${remotePrefix}"`
+    );
+  }
+  return fileOrFolderPathWithRemotePrefix.slice(`${remotePrefix}`.length);
+};
+
+const fromS3ObjectToRemoteItem = (x: S3ObjectType, remotePrefix: string) => {
   return {
-    key: x.Key,
+    key: getLocalNoPrefixPath(x.Key, remotePrefix),
     lastModified: x.LastModified.valueOf(),
     size: x.Size,
     remoteType: "s3",
@@ -49,11 +229,12 @@ const fromS3ObjectToRemoteItem = (x: S3ObjectType) => {
 };
 
 const fromS3HeadObjectToRemoteItem = (
-  key: string,
-  x: HeadObjectCommandOutput
+  fileOrFolderPathWithRemotePrefix: string,
+  x: HeadObjectCommandOutput,
+  remotePrefix: string
 ) => {
   return {
-    key: key,
+    key: getLocalNoPrefixPath(fileOrFolderPathWithRemotePrefix, remotePrefix),
     lastModified: x.LastModified.valueOf(),
     size: x.ContentLength,
     remoteType: "s3",
@@ -66,30 +247,68 @@ export const getS3Client = (s3Config: S3Config) => {
   if (!(endpoint.startsWith("http://") || endpoint.startsWith("https://"))) {
     endpoint = `https://${endpoint}`;
   }
-  const s3Client = new S3Client({
+
+  let s3Client: S3Client;
+
+  if (VALID_REQURL && s3Config.bypassCorsLocally) {
+    s3Client = new S3Client({
       region: s3Config.s3Region,
       endpoint: endpoint,
+      forcePathStyle: s3Config.forcePathStyle,
+      credentials: {
+        accessKeyId: s3Config.s3AccessKeyID,
+        secretAccessKey: s3Config.s3SecretAccessKey,
+      },
+      requestHandler: new ObsHttpHandler(),
+    });
+  } else {
+    s3Client = new S3Client({
+      region: s3Config.s3Region,
+      endpoint: endpoint,
+      forcePathStyle: s3Config.forcePathStyle,
       credentials: {
         accessKeyId: s3Config.s3AccessKeyID,
         secretAccessKey: s3Config.s3SecretAccessKey,
       },
     });
+  }
+
+  s3Client.middlewareStack.add(
+    (next, context) => (args) => {
+      (args.request as any).headers["cache-control"] = "no-cache";
+      return next(args);
+    },
+    {
+      step: "build",
+    }
+  );
+
   return s3Client;
 };
 
 export const getRemoteMeta = async (
   s3Client: S3Client,
   s3Config: S3Config,
-  fileOrFolderPath: string
+  fileOrFolderPathWithRemotePrefix: string
 ) => {
+  if (
+    s3Config.remotePrefix !== "" &&
+    !fileOrFolderPathWithRemotePrefix.startsWith(s3Config.remotePrefix)
+  ) {
+    throw Error(`s3 getRemoteMeta should only accept prefix-ed path`);
+  }
   const res = await s3Client.send(
     new HeadObjectCommand({
       Bucket: s3Config.s3BucketName,
-      Key: fileOrFolderPath,
+      Key: fileOrFolderPathWithRemotePrefix,
     })
   );
 
-  return fromS3HeadObjectToRemoteItem(fileOrFolderPath, res);
+  return fromS3HeadObjectToRemoteItem(
+    fileOrFolderPathWithRemotePrefix,
+    res,
+    s3Config.remotePrefix
+  );
 };
 
 export const uploadToRemote = async (
@@ -99,19 +318,23 @@ export const uploadToRemote = async (
   vault: Vault,
   isRecursively: boolean = false,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
 ) => {
   let uploadFile = fileOrFolderPath;
   if (password !== "") {
     uploadFile = remoteEncryptedKey;
   }
+  uploadFile = getRemoteWithPrefixPath(uploadFile, s3Config.remotePrefix);
   const isFolder = fileOrFolderPath.endsWith("/");
 
-  const DEFAULT_CONTENT_TYPE = "application/octet-stream";
-
   if (isFolder && isRecursively) {
     throw Error("upload function doesn't implement recursive function yet!");
   } else if (isFolder && !isRecursively) {
+    if (uploadRaw) {
+      throw Error(`you specify uploadRaw, but you also provide a folder key!`);
+    }
     // folder
     const contentType = DEFAULT_CONTENT_TYPE;
     await s3Client.send(
@@ -133,17 +356,27 @@ export const uploadToRemote = async (
           mime.lookup(fileOrFolderPath) || DEFAULT_CONTENT_TYPE
         ) || DEFAULT_CONTENT_TYPE;
     }
-    const localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    let localContent = undefined;
+    if (uploadRaw) {
+      if (typeof rawContent === "string") {
+        localContent = new TextEncoder().encode(rawContent).buffer;
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
     }
-    const body = arrayBufferToBuffer(remoteContent);
 
+    const bytesIn5MB = 5242880;
+    const body = new Uint8Array(remoteContent);
     const upload = new Upload({
       client: s3Client,
-      queueSize: 20, // concurrency
-      partSize: 5242880, // minimal 5MB by default
+      queueSize: s3Config.partsConcurrency, // concurrency
+      partSize: bytesIn5MB, // minimal 5MB by default
       leavePartsOnError: false,
       params: {
         Bucket: s3Config.s3BucketName,
@@ -161,22 +394,21 @@ export const uploadToRemote = async (
   }
 };
 
-export const listFromRemote = async (
+const listFromRemoteRaw = async (
   s3Client: S3Client,
   s3Config: S3Config,
-  prefix?: string
+  prefixOfRawKeys?: string
 ) => {
   const confCmd = {
     Bucket: s3Config.s3BucketName,
   } as ListObjectsV2CommandInput;
-  if (prefix !== undefined) {
-    confCmd.Prefix = prefix;
+  if (prefixOfRawKeys !== undefined && prefixOfRawKeys !== "") {
+    confCmd.Prefix = prefixOfRawKeys;
   }
 
   const contents = [] as _Object[];
 
   let isTruncated = true;
-  let continuationToken = "";
   do {
     const rsp = await s3Client.send(new ListObjectsV2Command(confCmd));
 
@@ -192,18 +424,30 @@ export const listFromRemote = async (
     confCmd.ContinuationToken = rsp.NextContinuationToken;
     if (
       isTruncated &&
-      (continuationToken === undefined || continuationToken === "")
+      (confCmd.ContinuationToken === undefined ||
+        confCmd.ContinuationToken === "")
     ) {
       throw Error("isTruncated is true but no continuationToken provided");
     }
   } while (isTruncated);
 
   // ensemble fake rsp
+  // in the end, we need to transform the response list
+  // back to the local contents-alike list
   return {
-    Contents: contents.map((x) => fromS3ObjectToRemoteItem(x)),
+    Contents: contents.map((x) =>
+      fromS3ObjectToRemoteItem(x, s3Config.remotePrefix)
+    ),
   };
 };
 
+export const listAllFromRemote = async (
+  s3Client: S3Client,
+  s3Config: S3Config
+) => {
+  return await listFromRemoteRaw(s3Client, s3Config, s3Config.remotePrefix);
+};
+
 /**
  * The Body of resp of aws GetObject has mix types
  * and we want to get ArrayBuffer here.
@@ -233,12 +477,18 @@ const getObjectBodyToArrayBuffer = async (
 const downloadFromRemoteRaw = async (
   s3Client: S3Client,
   s3Config: S3Config,
-  fileOrFolderPath: string
+  fileOrFolderPathWithRemotePrefix: string
 ) => {
+  if (
+    s3Config.remotePrefix !== "" &&
+    !fileOrFolderPathWithRemotePrefix.startsWith(s3Config.remotePrefix)
+  ) {
+    throw Error(`downloadFromRemoteRaw should only accept prefix-ed path`);
+  }
   const data = await s3Client.send(
     new GetObjectCommand({
       Bucket: s3Config.s3BucketName,
-      Key: fileOrFolderPath,
+      Key: fileOrFolderPathWithRemotePrefix,
     })
   );
   const bodyContents = await getObjectBodyToArrayBuffer(data.Body);
@@ -252,11 +502,14 @@ export const downloadFromRemote = async (
   vault: Vault,
   mtime: number,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  skipSaving: boolean = false
 ) => {
   const isFolder = fileOrFolderPath.endsWith("/");
 
+  if (!skipSaving) {
     await mkdirpInVault(fileOrFolderPath, vault);
+  }
 
   // the file is always local file
   // we need to encrypt it
@@ -264,11 +517,13 @@ export const downloadFromRemote = async (
   if (isFolder) {
     // mkdirp locally is enough
     // do nothing here
+    return new ArrayBuffer(0);
   } else {
     let downloadFile = fileOrFolderPath;
     if (password !== "") {
       downloadFile = remoteEncryptedKey;
     }
+    downloadFile = getRemoteWithPrefixPath(downloadFile, s3Config.remotePrefix);
     const remoteContent = await downloadFromRemoteRaw(
       s3Client,
       s3Config,
@@ -278,10 +533,13 @@ export const downloadFromRemote = async (
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
+    if (!skipSaving) {
       await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
         mtime: mtime,
       });
     }
+    return localContent;
+  }
 };
 
 /**
@@ -305,6 +563,10 @@ export const deleteFromRemote = async (
   if (password !== "") {
     remoteFileName = remoteEncryptedKey;
   }
+  remoteFileName = getRemoteWithPrefixPath(
+    remoteFileName,
+    s3Config.remotePrefix
+  );
   await s3Client.send(
     new DeleteObjectCommand({
       Bucket: s3Config.s3BucketName,
@@ -313,7 +575,7 @@ export const deleteFromRemote = async (
   );
 
   if (fileOrFolderPath.endsWith("/") && password === "") {
-    const x = await listFromRemote(s3Client, s3Config, fileOrFolderPath);
+    const x = await listFromRemoteRaw(s3Client, s3Config, remoteFileName);
     x.Contents.forEach(async (element) => {
       await s3Client.send(
         new DeleteObjectCommand({
@@ -332,27 +594,59 @@ export const deleteFromRemote = async (
 /**
  * Check the config of S3 by heading bucket
  * https://stackoverflow.com/questions/50842835
+ *
+ * Updated on 20240102:
+ * Users are not always have permission of heading bucket,
+ * so we need to use listing objects instead...
+ *
  * @param s3Client
  * @param s3Config
  * @returns
  */
 export const checkConnectivity = async (
   s3Client: S3Client,
-  s3Config: S3Config
+  s3Config: S3Config,
+  callbackFunc?: any
 ) => {
   try {
-    const results = await s3Client.send(
-      new HeadBucketCommand({ Bucket: s3Config.s3BucketName })
-    );
+    // const results = await s3Client.send(
+    //   new HeadBucketCommand({ Bucket: s3Config.s3BucketName })
+    // );
+    // very simplified version of listing objects
+    const confCmd = {
+      Bucket: s3Config.s3BucketName,
+    } as ListObjectsV2CommandInput;
+    const results = await s3Client.send(new ListObjectsV2Command(confCmd));
+
     if (
       results === undefined ||
       results.$metadata === undefined ||
       results.$metadata.httpStatusCode === undefined
     ) {
+      const err = "results or $metadata or httStatusCode is undefined";
+      log.debug(err);
+      if (callbackFunc !== undefined) {
+        callbackFunc(err);
+      }
       return false;
     }
     return results.$metadata.httpStatusCode === 200;
   } catch (err) {
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      if (s3Config.s3Endpoint.contains(s3Config.s3BucketName)) {
+        const err2 = new AggregateError([
+          err,
+          new Error(
+            "Maybe you've included the bucket name inside the endpoint setting. Please remove the bucket name and try again."
+          ),
+        ]);
+        callbackFunc(err2);
+      } else {
+        callbackFunc(err);
+      }
+    }
+
     return false;
   }
 };

src/remoteForWebdav.ts

@@ -1,17 +1,137 @@
 import { Buffer } from "buffer";
-import { Vault } from "obsidian";
-import type { FileStat, WebDAVClient } from "webdav/web";
-import { AuthType, BufferLike, createClient } from "webdav/web";
+import { Vault, requestUrl } from "obsidian";
+
 import { Queue } from "@fyears/tsqueue";
 import chunk from "lodash/chunk";
 import flatten from "lodash/flatten";
-import type { RemoteItem, WebdavConfig } from "./baseTypes";
+import { getReasonPhrase } from "http-status-codes";
+import { RemoteItem, VALID_REQURL, 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");
+import { log } from "./moreOnLog";
+
+import type {
+  FileStat,
+  WebDAVClient,
+  RequestOptionsWithState,
+  // Response,
+  // ResponseDataDetailed,
+} from "webdav";
+
+// @ts-ignore
+import { getPatcher } from "webdav/dist/web/index.js";
+if (VALID_REQURL) {
+  getPatcher().patch(
+    "request",
+    async (options: RequestOptionsWithState): Promise<Response> => {
+      const transformedHeaders = { ...options.headers };
+      delete transformedHeaders["host"];
+      delete transformedHeaders["Host"];
+      delete transformedHeaders["content-length"];
+      delete transformedHeaders["Content-Length"];
+
+      const r = await requestUrl({
+        url: options.url,
+        method: options.method,
+        body: options.data as string | ArrayBuffer,
+        headers: transformedHeaders,
+      });
+
+      let contentType: string | undefined =
+        r.headers["Content-Type"] ||
+        r.headers["content-type"] ||
+        options.headers["Content-Type"] ||
+        options.headers["content-type"] ||
+        options.headers["Accept"] ||
+        options.headers["accept"];
+      if (contentType !== undefined) {
+        contentType = contentType.toLowerCase();
+      }
+      const rspHeaders = { ...r.headers };
+      for (let key in rspHeaders) {
+        if (rspHeaders.hasOwnProperty(key)) {
+          if (key === "content-disposition" || key === "Content-Disposition") {
+            rspHeaders[key] = encodeURIComponent(rspHeaders[key]);
+          }
+        }
+      }
+      // console.log(`requesting url=${options.url}`);
+      // console.log(`contentType=${contentType}`);
+      // console.log(`rspHeaders=${JSON.stringify(rspHeaders)}`)
+
+      // let r2: Response = undefined;
+      // if (contentType.includes("xml")) {
+      //   r2 = new Response(r.text, {
+      //     status: r.status,
+      //     statusText: getReasonPhrase(r.status),
+      //     headers: rspHeaders,
+      //   });
+      // } else if (
+      //   contentType.includes("json") ||
+      //   contentType.includes("javascript")
+      // ) {
+      //   console.log('inside json branch');
+      //   // const j = r.json;
+      //   // console.log(j);
+      //   r2 = new Response(
+      //     r.text,  // yea, here is the text because Response constructor expects a text
+      //     {
+      //     status: r.status,
+      //     statusText: getReasonPhrase(r.status),
+      //     headers: rspHeaders,
+      //   });
+      // } else if (contentType.includes("text")) {
+      //   // avoid text/json,
+      //   // so we split this out from the above xml or json branch
+      //   r2 = new Response(r.text, {
+      //     status: r.status,
+      //     statusText: getReasonPhrase(r.status),
+      //     headers: rspHeaders,
+      //   });
+      // } else if (
+      //   contentType.includes("octet-stream") ||
+      //   contentType.includes("binary") ||
+      //   contentType.includes("buffer")
+      // ) {
+      //   // application/octet-stream
+      //   r2 = new Response(r.arrayBuffer, {
+      //     status: r.status,
+      //     statusText: getReasonPhrase(r.status),
+      //     headers: rspHeaders,
+      //   });
+      // } else {
+      //   throw Error(
+      //     `do not know how to deal with requested content type = ${contentType}`
+      //   );
+      // }
+
+      let r2: Response = undefined;
+      if ([101, 103, 204, 205, 304].includes(r.status)) {
+        // A null body status is a status that is 101, 103, 204, 205, or 304.
+        // https://fetch.spec.whatwg.org/#statuses
+        // fix this: Failed to construct 'Response': Response with null body status cannot have body
+        r2 = new Response(null, {
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: rspHeaders,
+        });
+      } else {
+        r2 = new Response(r.arrayBuffer, {
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: rspHeaders,
+        });
+      }
+
+      return r2;
+    }
+  );
+}
+
+// @ts-ignore
+import { AuthType, BufferLike, createClient } from "webdav/dist/web/index.js";
+export type { WebDAVClient } from "webdav";
 
 export const DEFAULT_WEBDAV_CONFIG = {
   address: "",
@@ -19,37 +139,41 @@ export const DEFAULT_WEBDAV_CONFIG = {
   password: "",
   authType: "basic",
   manualRecursive: false,
+  depth: "auto_unknown",
+  remoteBaseDir: "",
 } as WebdavConfig;
 
-const getWebdavPath = (fileOrFolderPath: string, vaultName: string) => {
+const getWebdavPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
   let key = fileOrFolderPath;
   if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
     // special
-    key = `/${vaultName}/`;
+    key = `/${remoteBaseDir}/`;
   }
   if (!fileOrFolderPath.startsWith("/")) {
-    key = `/${vaultName}/${fileOrFolderPath}`;
+    key = `/${remoteBaseDir}/${fileOrFolderPath}`;
   }
   return key;
 };
 
-const getNormPath = (fileOrFolderPath: string, vaultName: string) => {
+const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
   if (
     !(
-      fileOrFolderPath === `/${vaultName}` ||
-      fileOrFolderPath.startsWith(`/${vaultName}/`)
+      fileOrFolderPath === `/${remoteBaseDir}` ||
+      fileOrFolderPath.startsWith(`/${remoteBaseDir}/`)
     )
   ) {
-    throw Error(`"${fileOrFolderPath}" doesn't starts with "/${vaultName}/"`);
+    throw Error(
+      `"${fileOrFolderPath}" doesn't starts with "/${remoteBaseDir}/"`
+    );
   }
   // if (fileOrFolderPath.startsWith("/")) {
   //   return fileOrFolderPath.slice(1);
   // }
-  return fileOrFolderPath.slice(`/${vaultName}/`.length);
+  return fileOrFolderPath.slice(`/${remoteBaseDir}/`.length);
 };
 
-const fromWebdavItemToRemoteItem = (x: FileStat, vaultName: string) => {
-  let key = getNormPath(x.filename, vaultName);
+const fromWebdavItemToRemoteItem = (x: FileStat, remoteBaseDir: string) => {
+  let key = getNormPath(x.filename, remoteBaseDir);
   if (x.type === "directory" && !key.endsWith("/")) {
     key = `${key}/`;
   }
@@ -64,17 +188,26 @@ const fromWebdavItemToRemoteItem = (x: FileStat, vaultName: string) => {
 
 export class WrappedWebdavClient {
   webdavConfig: WebdavConfig;
-  vaultName: string;
+  remoteBaseDir: string;
   client: WebDAVClient;
   vaultFolderExists: boolean;
-  constructor(webdavConfig: WebdavConfig, vaultName: string) {
+  saveUpdatedConfigFunc: () => Promise<any>;
+  constructor(
+    webdavConfig: WebdavConfig,
+    remoteBaseDir: string,
+    saveUpdatedConfigFunc: () => Promise<any>
+  ) {
     this.webdavConfig = webdavConfig;
-    this.vaultName = vaultName;
+    this.remoteBaseDir = remoteBaseDir;
     this.vaultFolderExists = false;
+    this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
   }
 
   init = async () => {
     // init client if not inited
+    const headers = {
+      "Cache-Control": "no-cache",
+    };
     if (this.client === undefined) {
       if (
         this.webdavConfig.username !== "" &&
@@ -83,6 +216,7 @@ export class WrappedWebdavClient {
         this.client = createClient(this.webdavConfig.address, {
           username: this.webdavConfig.username,
           password: this.webdavConfig.password,
+          headers: headers,
           authType:
             this.webdavConfig.authType === "digest"
               ? AuthType.Digest
@@ -90,7 +224,9 @@ export class WrappedWebdavClient {
         });
       } else {
         log.info("no password");
-        this.client = createClient(this.webdavConfig.address);
+        this.client = createClient(this.webdavConfig.address, {
+          headers: headers,
+        });
       }
     }
 
@@ -98,25 +234,84 @@ export class WrappedWebdavClient {
     if (this.vaultFolderExists) {
       // pass
     } else {
-      const res = await this.client.exists(`/${this.vaultName}`);
+      const res = await this.client.exists(`/${this.remoteBaseDir}/`);
       if (res) {
         // log.info("remote vault folder exits!");
         this.vaultFolderExists = true;
       } else {
         log.info("remote vault folder not exists, creating");
-        await this.client.createDirectory(`/${this.vaultName}`);
+        await this.client.createDirectory(`/${this.remoteBaseDir}/`);
         log.info("remote vault folder created!");
         this.vaultFolderExists = true;
       }
     }
+
+    // adjust depth parameter
+    if (this.webdavConfig.depth === "auto_unknown") {
+      let testPassed = false;
+      try {
+        const res = await this.client.customRequest(`/${this.remoteBaseDir}/`, {
+          method: "PROPFIND",
+          headers: {
+            Depth: "infinity",
+            Accept: "text/plain,application/xml",
+          },
+          // responseType: "text",
+        } as any);
+        if (res.status === 403) {
+          throw Error("not support Infinity, get 403");
+        } else {
+          testPassed = true;
+          this.webdavConfig.depth = "auto_infinity";
+          this.webdavConfig.manualRecursive = false;
+        }
+      } catch (error) {
+        testPassed = false;
+      }
+      if (!testPassed) {
+        try {
+          const res = await this.client.customRequest(
+            `/${this.remoteBaseDir}/`,
+            {
+              method: "PROPFIND",
+              headers: {
+                Depth: "1",
+                Accept: "text/plain,application/xml",
+              },
+              // responseType: "text",
+            } as any
+          );
+          testPassed = true;
+          this.webdavConfig.depth = "auto_1";
+          this.webdavConfig.manualRecursive = true;
+        } catch (error) {
+          testPassed = false;
+        }
+      }
+      if (testPassed) {
+        // the depth option has been changed
+        // save the setting
+        if (this.saveUpdatedConfigFunc !== undefined) {
+          await this.saveUpdatedConfigFunc();
+          log.info(
+            `webdav depth="auto_unknown" is changed to ${this.webdavConfig.depth}`
+          );
+        }
+      }
+    }
   };
 }
 
 export const getWebdavClient = (
   webdavConfig: WebdavConfig,
-  vaultName: string
+  remoteBaseDir: string,
+  saveUpdatedConfigFunc: () => Promise<any>
 ) => {
-  return new WrappedWebdavClient(webdavConfig, vaultName);
+  return new WrappedWebdavClient(
+    webdavConfig,
+    remoteBaseDir,
+    saveUpdatedConfigFunc
+  );
 };
 
 export const getRemoteMeta = async (
@@ -124,12 +319,12 @@ export const getRemoteMeta = async (
   fileOrFolderPath: string
 ) => {
   await client.init();
-  const remotePath = getWebdavPath(fileOrFolderPath, client.vaultName);
+  const remotePath = getWebdavPath(fileOrFolderPath, client.remoteBaseDir);
   // log.info(`remotePath = ${remotePath}`);
   const res = (await client.client.stat(remotePath, {
     details: false,
   })) as FileStat;
-  return fromWebdavItemToRemoteItem(res, client.vaultName);
+  return fromWebdavItemToRemoteItem(res, client.remoteBaseDir);
 };
 
 export const uploadToRemote = async (
@@ -138,25 +333,30 @@ export const uploadToRemote = async (
   vault: Vault,
   isRecursively: boolean = false,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
 ) => {
   await client.init();
   let uploadFile = fileOrFolderPath;
   if (password !== "") {
     uploadFile = remoteEncryptedKey;
   }
-  uploadFile = getWebdavPath(uploadFile, client.vaultName);
+  uploadFile = getWebdavPath(uploadFile, client.remoteBaseDir);
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
   if (isFolder && isRecursively) {
     throw Error("upload function doesn't implement recursive function yet!");
   } else if (isFolder && !isRecursively) {
+    if (uploadRaw) {
+      throw Error(`you specify uploadRaw, but you also provide a folder key!`);
+    }
     // folder
     if (password === "") {
       // if not encrypted, mkdir a remote folder
       await client.client.createDirectory(uploadFile, {
-        recursive: true,
+        recursive: false, // the sync algo should guarantee no need to recursive
       });
       const res = await getRemoteMeta(client, uploadFile);
       return res;
@@ -164,7 +364,7 @@ export const uploadToRemote = async (
       // if encrypted, upload a fake file with the encrypted file name
       await client.client.putFileContents(uploadFile, "", {
         overwrite: true,
-        onUploadProgress: (progress) => {
+        onUploadProgress: (progress: any) => {
           // log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
         },
       });
@@ -174,19 +374,29 @@ export const uploadToRemote = async (
   } else {
     // file
     // we ignore isRecursively parameter here
-    const localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    let localContent = undefined;
+    if (uploadRaw) {
+      if (typeof rawContent === "string") {
+        localContent = new TextEncoder().encode(rawContent).buffer;
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
     }
-    // we need to create folders before uploading
-    const dir = getPathFolder(uploadFile);
-    if (dir !== "/" && dir !== "") {
-      await client.client.createDirectory(dir, { recursive: true });
-    }
+    // updated 20220326: the algorithm guarantee this
+    // // we need to create folders before uploading
+    // const dir = getPathFolder(uploadFile);
+    // if (dir !== "/" && dir !== "") {
+    //   await client.client.createDirectory(dir, { recursive: false });
+    // }
     await client.client.putFileContents(uploadFile, remoteContent, {
       overwrite: true,
-      onUploadProgress: (progress) => {
+      onUploadProgress: (progress: any) => {
         log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
       },
     });
@@ -195,20 +405,17 @@ export const uploadToRemote = async (
   }
 };
 
-export const listFromRemote = async (
-  client: WrappedWebdavClient,
-  prefix?: string
-) => {
-  if (prefix !== undefined) {
-    throw Error("prefix not supported");
-  }
+export const listAllFromRemote = async (client: WrappedWebdavClient) => {
   await client.init();
 
   let contents = [] as FileStat[];
-  if (client.webdavConfig.manualRecursive) {
+  if (
+    client.webdavConfig.depth === "auto_1" ||
+    client.webdavConfig.depth === "manual_1"
+  ) {
     // the remote doesn't support infinity propfind,
     // we need to do a bfs here
-    const q = new Queue([`/${client.vaultName}`]);
+    const q = new Queue([`/${client.remoteBaseDir}`]);
     const CHUNK_SIZE = 10;
     while (q.length > 0) {
       const itemsToFetch = [];
@@ -223,7 +430,10 @@ export const listFromRemote = async (
           return client.client.getDirectoryContents(x, {
             deep: false,
             details: false /* no need for verbose details here */,
-            glob: "/**" /* avoid dot files by using glob */,
+            // TODO: to support .obsidian,
+            // we need to load all files including dot,
+            // anyway to reduce the resources?
+            // glob: "/**" /* avoid dot files by using glob */,
           }) as Promise<FileStat[]>;
         });
         const r2 = flatten(await Promise.all(r));
@@ -240,17 +450,20 @@ export const listFromRemote = async (
   } else {
     // the remote supports infinity propfind
     contents = (await client.client.getDirectoryContents(
-      `/${client.vaultName}`,
+      `/${client.remoteBaseDir}`,
       {
         deep: true,
         details: false /* no need for verbose details here */,
-        glob: "/**" /* avoid dot files by using glob */,
+        // TODO: to support .obsidian,
+        // we need to load all files including dot,
+        // anyway to reduce the resources?
+        // glob: "/**" /* avoid dot files by using glob */,
       }
     )) as FileStat[];
   }
   return {
     Contents: contents.map((x) =>
-      fromWebdavItemToRemoteItem(x, client.vaultName)
+      fromWebdavItemToRemoteItem(x, client.remoteBaseDir)
     ),
   };
 };
@@ -260,9 +473,9 @@ const downloadFromRemoteRaw = async (
   fileOrFolderPath: string
 ) => {
   await client.init();
-  const buff = (await client.client.getFileContents(
-    getWebdavPath(fileOrFolderPath, client.vaultName)
-  )) as BufferLike;
+  const p = getWebdavPath(fileOrFolderPath, client.remoteBaseDir);
+  // console.log(`getWebdavPath=${p}`);
+  const buff = (await client.client.getFileContents(p)) as BufferLike;
   if (buff instanceof ArrayBuffer) {
     return buff;
   } else if (buff instanceof Buffer) {
@@ -277,13 +490,16 @@ export const downloadFromRemote = async (
   vault: Vault,
   mtime: number,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  skipSaving: boolean = false
 ) => {
   await client.init();
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
+  if (!skipSaving) {
     await mkdirpInVault(fileOrFolderPath, vault);
+  }
 
   // the file is always local file
   // we need to encrypt it
@@ -291,21 +507,26 @@ export const downloadFromRemote = async (
   if (isFolder) {
     // mkdirp locally is enough
     // do nothing here
+    return new ArrayBuffer(0);
   } else {
     let downloadFile = fileOrFolderPath;
     if (password !== "") {
       downloadFile = remoteEncryptedKey;
     }
-    downloadFile = getWebdavPath(downloadFile, client.vaultName);
+    downloadFile = getWebdavPath(downloadFile, client.remoteBaseDir);
+    // console.log(`downloadFile=${downloadFile}`);
     const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
     let localContent = remoteContent;
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
+    if (!skipSaving) {
       await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
         mtime: mtime,
       });
     }
+    return localContent;
+  }
 };
 
 export const deleteFromRemote = async (
@@ -321,7 +542,7 @@ export const deleteFromRemote = async (
   if (password !== "") {
     remoteFileName = remoteEncryptedKey;
   }
-  remoteFileName = getWebdavPath(remoteFileName, client.vaultName);
+  remoteFileName = getWebdavPath(remoteFileName, client.remoteBaseDir);
 
   await client.init();
   try {
@@ -333,15 +554,40 @@ export const deleteFromRemote = async (
   }
 };
 
-export const checkConnectivity = async (client: WrappedWebdavClient) => {
+export const checkConnectivity = async (
+  client: WrappedWebdavClient,
+  callbackFunc?: any
+) => {
+  if (
+    !(
+      client.webdavConfig.address.startsWith("http://") ||
+      client.webdavConfig.address.startsWith("https://")
+    )
+  ) {
+    const err = "Error: the url should start with http(s):// but it does not!";
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
+    return false;
+  }
   try {
     await client.init();
     const results = await getRemoteMeta(client, "/");
     if (results === undefined) {
+      const err = "results is undefined";
+      log.debug(err);
+      if (callbackFunc !== undefined) {
+        callbackFunc(err);
+      }
       return false;
     }
     return true;
   } catch (err) {
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };

src/syncAlgoV2Notice.ts

@@ -0,0 +1,64 @@
+import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
+import type RemotelySavePlugin from "./main"; // unavoidable
+import type { TransItemType } from "./i18n";
+
+import { log } from "./moreOnLog";
+
+export class SyncAlgoV2Modal extends Modal {
+  agree: boolean;
+  readonly plugin: RemotelySavePlugin;
+  constructor(app: App, plugin: RemotelySavePlugin) {
+    super(app);
+    this.plugin = plugin;
+    this.agree = false;
+  }
+  onOpen() {
+    let { contentEl } = this;
+    const t = (x: TransItemType, vars?: any) => {
+      return this.plugin.i18n.t(x, vars);
+    };
+
+    contentEl.createEl("h2", {
+      text: t("syncalgov2_title"),
+    });
+
+    const ul = contentEl.createEl("ul");
+    t("syncalgov2_texts")
+      .split("\n")
+      .forEach((val) => {
+        ul.createEl("li", {
+          text: val,
+        });
+      });
+
+    new Setting(contentEl)
+      .addButton((button) => {
+        button.setButtonText(t("syncalgov2_button_agree"));
+        button.onClick(async () => {
+          this.agree = true;
+          this.close();
+        });
+      })
+      .addButton((button) => {
+        button.setButtonText(t("syncalgov2_button_disagree"));
+        button.onClick(() => {
+          this.close();
+        });
+      });
+  }
+
+  onClose() {
+    let { contentEl } = this;
+    contentEl.empty();
+    if (this.agree) {
+      log.info("agree to use the new algorithm");
+      this.plugin.saveAgreeToUseNewSyncAlgorithm();
+      this.plugin.enableAutoSyncIfSet();
+      this.plugin.enableInitSyncIfSet();
+      this.plugin.enableSyncOnSaveIfSet();
+    } else {
+      log.info("do not agree to use the new algorithm");
+      this.plugin.unload();
+    }
+  }
+}

src/syncSizesConflictNotice.ts

@@ -0,0 +1,90 @@
+import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
+import type RemotelySavePlugin from "./main"; // unavoidable
+import type { TransItemType } from "./i18n";
+import type { FileOrFolderMixedState } from "./baseTypes";
+
+import { log } from "./moreOnLog";
+
+export class SizesConflictModal extends Modal {
+  readonly plugin: RemotelySavePlugin;
+  readonly skipSizeLargerThan: number;
+  readonly sizesGoWrong: FileOrFolderMixedState[];
+  readonly hasPassword: boolean;
+  constructor(
+    app: App,
+    plugin: RemotelySavePlugin,
+    skipSizeLargerThan: number,
+    sizesGoWrong: FileOrFolderMixedState[],
+    hasPassword: boolean
+  ) {
+    super(app);
+    this.plugin = plugin;
+    this.skipSizeLargerThan = skipSizeLargerThan;
+    this.sizesGoWrong = sizesGoWrong;
+    this.hasPassword = hasPassword;
+  }
+  onOpen() {
+    let { contentEl } = this;
+    const t = (x: TransItemType, vars?: any) => {
+      return this.plugin.i18n.t(x, vars);
+    };
+
+    contentEl.createEl("h2", {
+      text: t("modal_sizesconflict_title"),
+    });
+
+    t("modal_sizesconflict_desc", {
+      thresholdMB: `${this.skipSizeLargerThan / 1000 / 1000}`,
+      thresholdBytes: `${this.skipSizeLargerThan}`,
+    })
+      .split("\n")
+      .forEach((val) => {
+        contentEl.createEl("p", { text: val });
+      });
+
+    const info = this.serialize();
+
+    contentEl.createDiv().createEl(
+      "button",
+      {
+        text: t("modal_sizesconflict_copybutton"),
+      },
+      (el) => {
+        el.onclick = async () => {
+          await navigator.clipboard.writeText(info);
+          new Notice(t("modal_sizesconflict_copynotice"));
+        };
+      }
+    );
+
+    contentEl.createEl("pre", {
+      text: info,
+    });
+  }
+
+  serialize() {
+    return this.sizesGoWrong
+      .map((x) => {
+        return [
+          x.key,
+          this.hasPassword
+            ? `encrypted name: ${x.remoteEncryptedKey}`
+            : undefined,
+          `local ${this.hasPassword ? "encrypted " : ""}bytes: ${
+            this.hasPassword ? x.sizeLocalEnc : x.sizeLocal
+          }`,
+          `remote ${this.hasPassword ? "encrypted " : ""}bytes: ${
+            this.hasPassword ? x.sizeRemoteEnc : x.sizeRemote
+          }`,
+        ]
+          .filter((tmp) => tmp !== undefined)
+          .join("\n");
+      })
+      .join("\n\n");
+  }
+
+  onClose() {
+    let { contentEl } = this;
+    contentEl.empty();
+  }
+}

styles.css

@@ -8,6 +8,11 @@
   font-weight: bold;
 }
 
+.settings-auth-related {
+  border-top: 1px solid var(--background-modifier-border);
+  padding-top: 18px;
+}
+
 .s3-disclaimer {
   font-weight: bold;
 }
@@ -56,3 +61,12 @@
   width: 350px;
   height: 350px;
 }
+
+.ignorepaths-textarea {
+  font-family: monospace;
+}
+
+.logtohttpserver-warning {
+  color: red;
+  font-weight: bolder;
+}

tests/configPersist.test.ts

@@ -23,6 +23,8 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   password: "password",
   serviceType: "s3",
   currLogLevel: "info",
+  ignorePaths: ["somefoldertoignore"],
+  enableStatusBarInfo: true,
 };
 
 describe("Config Persist tests", () => {

tests/encrypt.test.ts

@@ -8,6 +8,8 @@ import {
   encryptArrayBuffer,
   encryptStringToBase32,
   encryptStringToBase64url,
+  getSizeFromEncToOrig,
+  getSizeFromOrigToEnc,
 } from "../src/encrypt";
 import { base64ToBase64url, bufferToArrayBuffer } from "../src/misc";
 
@@ -27,6 +29,14 @@ describe("Encryption tests", () => {
     expect(await encryptStringToBase32(k, password)).to.not.equal(k);
   });
 
+  it("should encrypt string and return different results each time", async () => {
+    const k = "dkjdhkfhdkjgsdklxxd";
+    const password = "hey";
+    const res1 = await encryptStringToBase32(k, password);
+    const res2 = await encryptStringToBase32(k, password);
+    expect(res1).to.not.equal(res2);
+  });
+
   it("should raise error using different password", async () => {
     const k = "secret text";
     const password = "hey";
@@ -95,7 +105,21 @@ describe("Encryption tests", () => {
     expect(Buffer.from(enc).equals(Buffer.from(opensslArrBuf))).to.be.true;
   });
 
-  it("should descypt binary file and get the same result as openssl", async () => {
+  it("should encrypt binary file not deterministically", async () => {
+    const testFolder = path.join(__dirname, "static_assets", "mona_lisa");
+    const testFileName =
+      "1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg";
+    const fileArrBuf = bufferToArrayBuffer(
+      await fs.readFileSync(path.join(testFolder, testFileName))
+    );
+    const password = "somepassword";
+    const res1 = await encryptArrayBuffer(fileArrBuf, password);
+    const res2 = await encryptArrayBuffer(fileArrBuf, password);
+
+    expect(Buffer.from(res1).equals(Buffer.from(res2))).to.be.false;
+  });
+
+  it("should decrypt binary file and get the same result as openssl", async () => {
     const testFolder = path.join(__dirname, "static_assets", "mona_lisa");
     const testFileName =
       "1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg";
@@ -110,4 +134,34 @@ describe("Encryption tests", () => {
 
     expect(Buffer.from(dec).equals(Buffer.from(opensslArrBuf))).to.be.true;
   });
+
+  it("should get size from origin to encrypted correctly", () => {
+    expect(() => getSizeFromOrigToEnc(-1)).to.throw();
+    expect(() => getSizeFromOrigToEnc(0.5)).to.throw();
+    expect(getSizeFromOrigToEnc(0)).equals(32);
+    expect(getSizeFromOrigToEnc(15)).equals(32);
+    expect(getSizeFromOrigToEnc(16)).equals(48);
+    expect(getSizeFromOrigToEnc(31)).equals(48);
+    expect(getSizeFromOrigToEnc(32)).equals(64);
+    expect(getSizeFromOrigToEnc(14787203)).equals(14787232);
+  });
+
+  it("should get size from encrypted to origin correctly", () => {
+    expect(() => getSizeFromEncToOrig(-1)).to.throw();
+    expect(() => getSizeFromEncToOrig(30)).to.throw();
+
+    expect(getSizeFromEncToOrig(32)).to.deep.equal({
+      minSize: 0,
+      maxSize: 15,
+    });
+    expect(getSizeFromEncToOrig(48)).to.deep.equal({
+      minSize: 16,
+      maxSize: 31,
+    });
+
+    expect(() => getSizeFromEncToOrig(14787231)).to.throw();
+
+    let { minSize, maxSize } = getSizeFromEncToOrig(14787232);
+    expect(minSize <= 14787203 && 14787203 <= maxSize).to.be.true;
+  });
 });

tests/metadataOnRemote.test.ts

@@ -0,0 +1,86 @@
+import * as chai from "chai";
+import chaiAsPromised from "chai-as-promised";
+
+import {
+  isEqualMetadataOnRemote,
+  MetadataOnRemote,
+} from "../src/metadataOnRemote";
+
+chai.use(chaiAsPromised);
+const expect = chai.expect;
+
+describe("Metadata operations tests", () => {
+  it("should compare objects deeply", async () => {
+    const a: MetadataOnRemote = {
+      deletions: [
+        { key: "xxx", actionWhen: 1 },
+        { key: "yyy", actionWhen: 2 },
+      ],
+    };
+    const b: MetadataOnRemote = {
+      deletions: [
+        { key: "xxx", actionWhen: 1 },
+        { key: "yyy", actionWhen: 2 },
+      ],
+    };
+
+    expect(isEqualMetadataOnRemote(a, b));
+  });
+
+  it("should find diff", async () => {
+    const a: MetadataOnRemote = {
+      deletions: [
+        { key: "xxxx", actionWhen: 1 },
+        { key: "yyy", actionWhen: 2 },
+      ],
+    };
+    const b: MetadataOnRemote = {
+      deletions: [
+        { key: "xxx", actionWhen: 1 },
+        { key: "yyy", actionWhen: 2 },
+      ],
+    };
+
+    expect(!isEqualMetadataOnRemote(a, b));
+  });
+
+  it("should treat undefined correctly", async () => {
+    const a: MetadataOnRemote = undefined;
+    let b: MetadataOnRemote = {
+      deletions: [
+        { key: "xxx", actionWhen: 1 },
+        { key: "yyy", actionWhen: 2 },
+      ],
+    };
+
+    expect(!isEqualMetadataOnRemote(a, b));
+
+    b = { deletions: [] };
+    expect(isEqualMetadataOnRemote(a, b));
+
+    b = { deletions: undefined };
+    expect(isEqualMetadataOnRemote(a, b));
+
+    b = undefined;
+    expect(isEqualMetadataOnRemote(a, b));
+  });
+
+  it("should ignore generated at fields", async () => {
+    const a: MetadataOnRemote = {
+      deletions: [
+        { key: "xxxx", actionWhen: 1 },
+        { key: "yyy", actionWhen: 2 },
+      ],
+      generatedWhen: 1,
+    };
+    const b: MetadataOnRemote = {
+      deletions: [
+        { key: "xxx", actionWhen: 1 },
+        { key: "yyy", actionWhen: 2 },
+      ],
+      generatedWhen: 2,
+    };
+
+    expect(isEqualMetadataOnRemote(a, b));
+  });
+});