bump to 0.3.21

Seafile is indeed connectable

.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

.env.example.txt

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

.gitattributes

@@ -3,3 +3,5 @@
 *.jpeg filter=lfs diff=lfs merge=lfs -text
 *.pdf filter=lfs diff=lfs merge=lfs -text
 *.enc filter=lfs diff=lfs merge=lfs -text
+*.svg filter=lfs diff=lfs merge=lfs -text
+*.excalidraw filter=lfs diff=lfs merge=lfs -text

.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]
 
@@ -13,6 +13,13 @@ 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]
@@ -23,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 }}
@@ -38,3 +46,4 @@ jobs:
           path: |
             main.js
             manifest.json
+            styles.css

.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

@@ -1,17 +1,20 @@
-# Intellij
-*.iml
-.idea
-
-# npm
-node_modules
-package-lock.json
-
-# build
-main.js
-*.js.map
-
-# obsidian
-data.json
-
-# hidden files
-.*
+# Intellij
+*.iml
+.idea
+
+# npm
+node_modules
+package-lock.json
+
+# build
+main.js
+*.js.map
+
+# obsidian
+data.json
+
+# debug
+logs.txt
+
+# hidden files
+.*

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "src/langs"]
+	path = src/langs
+	url = https://github.com/remotely-save/langs.git

.prettierignore

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

README.md

@@ -1,26 +1,119 @@
-# Save Remote
+# Remotely Save
 
-This is yet another sync plugin for Obsidian.
+This is yet another unofficial sync plugin for Obsidian. If you like it or find it useful, please consider give it a [star ![GitHub Repo stars](https://img.shields.io/github/stars/fyears/remotely-save?style=social)](https://github.com/fyears/remotely-save) on Github.
 
-## Download and Install
+[![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)
 
-[![BuildCI](https://github.com/fyears/obsidian-save-remote/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/obsidian-save-remote/actions/workflows/auto-build.yml)
-
-Every artifacts are placed in the "Summary" under every successful builds.
-
-Besides manually download the files, you can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin.
+[![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
 
-**This is NOT the official sync service provided by Obsidian.**
+- **This is NOT the [official sync service](https://obsidian.md/sync) provided by Obsidian.**
 
 ## !!!Caution!!!
 
-As of October 2021, the plugin is under development. **DO NOT USE IT for any serious vaults.** Prepare for data loss!
+**ALWAYS, ALWAYS, backup your vault before using this plugin.**
+
+## Features
+
+- Supports:
+  - Amazon S3 or S3-compatible
+  - Dropbox
+  - OneDrive for personal
+  - Webdav
+  - [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.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
+- **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
+- **Fully open source under [Apache-2.0 License](./LICENSE).**
+- **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.**
+
+## Limitations
+
+- **To support deltions 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. 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
+
+You are greatly welcome to ask questions, post any suggestions, or report any bugs! The project is mainly maintained on GitHub:
+
+- Questions: [GitHub repo Discussions](https://github.com/fyears/remotely-save/discussions)
+- Suggestions: also in [GitHub repo Discussions](https://github.com/fyears/remotely-save/discussions)
+- Bugs: [GitHub repo Issues](https://github.com/fyears/remotely-save/issues) (NOT Discussion)
+
+Additionally, the plugin author may occasionally visit Obsidian official forum and official Discord server, and pay attention to this-plugin-related information there.
+
+## Download and Install
+
+- 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.
 
 ## Usage
 
-Remote service in support list:
+### S3
 
-- [x] AWS S3
-- [ ] webdav
+- 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.
+- About CORS:
+  - If you are using Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, you can skip this CORS part.
+  - If you are using Obsidian desktop < 0.13.25 or mobile < 1.1.1, you need to 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`, and add at least `ETag` into exposed headers. Full example is [here](./docs/s3_cors_configure.md). 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.
+- 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". 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 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. [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 is NOT an official Microsoft / OneDrive product.** The plugin just uses Microsoft's [OneDrive's public API](https://docs.microsoft.com/en-us/onedrive/developer/rest-api).
+- This plugin only works for "OneDrive for personal", and not works for "OneDrive for Business" (yet). See [#11](https://github.com/fyears/remotely-save/issues/11) to further details.
+- After the authorization, the plugin can read your name and email, and read and write files in your OneDrive's `/Apps/remotely-save` folder.
+- If you decide to authorize this plugin to connect to OneDrive, please go to plugin's settings, and choose OneDrive then follow the instructions.
+- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
+
+### webdav
+
+- About CORS:
+  - 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.
+    - 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.
+- 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**.
+
+## Scheduled Auto Sync
+
+- You can configure auto syncing every N minutes in settings.
+- In auto sync mode, if any error occurs, the plugin would **fail silently**.
+- Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
+
+## 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.

assets/branding/256x256.png

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

assets/branding/300x300.png

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

assets/branding/300x300.svg

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

assets/branding/50x50.png

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

assets/branding/64x64.png

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

assets/branding/LICENSE.txt

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

assets/branding/README.md

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

assets/branding/logo-transparent.svg

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

assets/branding/logo.excalidraw

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

assets/branding/logo.png

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

assets/branding/logo.svg

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

docs/apache_cors_configure.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/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/encryption.md

@@ -0,0 +1,34 @@
+# Encryption
+
+If a password is set, the files are encrypted before being sent to the cloud.
+
+The encryption algorithm is delibrately designed to be aligned with openssl format.
+
+1. The encryption algorithm is implemented using web-crypto.
+2. The file content is encrypted using openssl format. Assuming a file named `sometext.txt`, a password `somepassword`, then the encryption is equivalent to the following command:
+
+   ```bash
+   # file content encryption (ignoring file path encryption)
+   openssl enc -p -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:somepassword -in ./sometext.txt -out ./sometext.txt.enc
+
+   # file content decryption (ignoring file path decryption)
+   openssl enc -d -p -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:somepassword -in ./sometext.txt.enc -out ./sometext.txt
+   ```
+
+3. The file/directory path strings, are encrypted using openssl in binary mode and then `base64url without padding` is applied.
+   Assuming the file path is `a-folder-文件夹/a-file-文件.md`, then the following commands are equivilent:
+
+   ```bash
+   # prepare the functions
+   # https://unix.stackexchange.com/questions/628842
+   base64url::encode () { base64 -w0 | tr '+/' '-_' | tr -d '='; }
+   base64url::decode () { awk '{ if (length($0) % 4 == 3) print $0"="; else if (length($0) % 4 == 2) print $0"=="; else print $0; }' | tr -- '-_' '+/' | base64 -d; }
+
+   # pure string encryption then base32
+   echo -n 'a-folder-文件夹/a-file-文件.md' | openssl enc -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:mylongpassword | base64url::encode
+
+   # pure string base64url then decryption
+   echo -n 'U2FsdGVkX19tNkdFL5rZeHxbe7FL-Pp5mkZJkDNFJWFT6lldZlfa57j0C_cKn0I3PZ9YDvOkyoKqfF6lbn0_yg' | base64url::decode | openssl enc -d -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:mylongpassword
+   ```
+
+4. The directory is considered as special "0-byte" object on remote s3. So this meta infomation may be easily guessed if some third party can access the remote bucket.

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/import_export_some_settings.md

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

docs/minimal_intrusive_design.md

@@ -0,0 +1,21 @@
+# Minimal Intrusive Design
+
+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 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.
+
+## Necessarity Of Uploading Extra Metadata
+
+The main issue comes from deletions (and renamings which is actually interpreted as "deletion-then-creation").
+
+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.
+
+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/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/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                                                                 | In the plan |       |           | ?                                                                |                                          |                                                  |
+| 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

@@ -1,12 +1,12 @@
-# Algorithm
+# Sync Algorithm
 
 ## Sources
 
 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.

esbuild.config.mjs

@@ -0,0 +1,56 @@
+import dotenv from "dotenv/config";
+import esbuild from "esbuild";
+import process from "process";
+// import builtins from 'builtin-modules'
+
+const banner = `/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+`;
+
+console.log(`esbuild version = ${esbuild.version}`);
+
+const prod = process.argv[2] === "production";
+
+const DEFAULT_DROPBOX_APP_KEY = process.env.DROPBOX_APP_KEY || "";
+const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
+const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
+
+esbuild
+  .build({
+    banner: {
+      js: banner,
+    },
+    loader: {
+      ".svg": "text",
+    },
+    entryPoints: ["./src/main.ts"],
+    bundle: true,
+    external: [
+      "obsidian",
+      "electron",
+      "fs",
+      "tls",
+      "net",
+      // ...builtins
+    ],
+    inject: ["./esbuild.injecthelper.mjs"],
+    format: "cjs",
+    watch: !prod,
+    target: "es2016",
+    logLevel: "info",
+    sourcemap: prod ? false : "inline",
+    treeShaking: true,
+    minify: prod,
+    outfile: "main.js",
+    define: {
+      "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
+    },
+  })
+  .catch(() => process.exit(1));

esbuild.injecthelper.mjs

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

manifest.json

@@ -1,9 +1,9 @@
 {
-  "id": "obsdian-save-remote",
-  "name": "Save remote",
-  "version": "0.0.11",
-  "minAppVersion": "0.12.15",
-  "description": "This is yet another plugin allowing users to sync notes between local device and the cloud.",
+  "id": "remotely-save",
+  "name": "Remotely Save",
+  "version": "0.3.21",
+  "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

package.json

@@ -1,52 +1,95 @@
 {
-  "name": "obsidian-save-remote",
-  "version": "0.0.11",
+  "name": "remotely-save",
+  "version": "0.3.21",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
-    "dev": "webpack --mode development --watch",
+    "dev2": "node esbuild.config.mjs",
+    "build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
     "build": "webpack --mode production",
+    "dev": "webpack --mode development --watch",
     "format": "npx prettier --write .",
     "clean": "npx rimraf main.js",
     "test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'"
   },
+  "browser": {
+    "path": "path-browserify",
+    "process": "process/browser",
+    "stream": "stream-browserify",
+    "crypto": "crypto-browserify",
+    "url": "url/"
+  },
   "source": "main.ts",
   "keywords": [],
   "author": "",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@types/chai": "^4.2.22",
+    "@microsoft/microsoft-graph-types": "^2.19.0",
+    "@types/chai": "^4.3.1",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/jsdom": "^16.2.14",
+    "@types/lodash": "^4.14.182",
     "@types/mime-types": "^2.1.1",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^14.14.37",
-    "chai": "^4.3.4",
+    "@types/mocha": "^9.1.1",
+    "@types/mustache": "^4.1.2",
+    "@types/node": "^17.0.30",
+    "@types/qrcode": "^1.4.2",
+    "builtin-modules": "^3.2.0",
+    "chai": "^4.3.6",
+    "chai-as-promised": "^7.1.1",
     "cross-env": "^7.0.3",
-    "mocha": "^9.1.3",
-    "prettier": "^2.4.1",
-    "terser-webpack-plugin": "^5.2.4",
-    "ts-loader": "^9.2.6",
-    "ts-node": "^10.4.0",
-    "tslib": "^2.2.0",
-    "typescript": "^4.4.4",
+    "dotenv": "^16.0.0",
+    "esbuild": "^0.14.38",
+    "jsdom": "^19.0.0",
+    "mocha": "^9.2.2",
+    "prettier": "^2.6.2",
+    "ts-loader": "^9.2.9",
+    "ts-node": "^10.7.0",
+    "tslib": "^2.4.0",
+    "typescript": "^4.6.4",
     "webdav-server": "^2.6.2",
-    "webpack": "^5.58.2",
-    "webpack-cli": "^4.9.1"
+    "webpack": "^5.72.0",
+    "webpack-cli": "^4.9.2"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.37.0",
-    "@aws-sdk/signature-v4-crt": "^3.37.0",
-    "acorn": "^8.5.0",
-    "aws-crt": "^1.10.1",
+    "@aws-sdk/client-s3": "^3.81.0",
+    "@aws-sdk/fetch-http-handler": "^3.78.0",
+    "@aws-sdk/lib-storage": "^3.81.0",
+    "@aws-sdk/protocol-http": "^3.78.0",
+    "@aws-sdk/querystring-builder": "^3.78.0",
+    "@aws-sdk/signature-v4-crt": "^3.78.0",
+    "@aws-sdk/types": "^3.78.0",
+    "@azure/msal-node": "^1.8.0",
+    "@fyears/tsqueue": "^1.0.1",
+    "@microsoft/microsoft-graph-client": "^3.0.2",
+    "acorn": "^8.7.1",
+    "aggregate-error": "^4.0.0",
+    "assert": "^2.0.0",
+    "aws-crt": "^1.12.1",
     "buffer": "^6.0.3",
-    "codemirror": "^5.63.1",
-    "lovefield-ts": "^0.7.0",
-    "mime-types": "^2.1.33",
-    "obsidian": "^0.12.0",
+    "crypto-browserify": "^3.12.0",
+    "delay": "^5.0.0",
+    "dropbox": "^10.28.0",
+    "emoji-regex": "^10.1.0",
+    "http-status-codes": "^2.2.0",
+    "localforage": "^1.10.0",
+    "lodash": "^4.17.21",
+    "loglevel": "^1.8.0",
+    "lucide": "^0.35.0",
+    "mime-types": "^2.1.35",
+    "mustache": "^4.2.0",
+    "nanoid": "^3.3.3",
+    "obsidian": "^0.14.6",
+    "p-queue": "^7.2.0",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
-    "rfc4648": "^1.5.0",
+    "qrcode": "^1.5.0",
+    "rfc4648": "^1.5.1",
     "rimraf": "^3.0.2",
     "stream-browserify": "^3.0.0",
-    "webdav": "^4.7.0",
-    "webdav-fs": "^4.0.0"
+    "url": "^0.11.0",
+    "util": "^0.12.4",
+    "webdav": "^4.9.0",
+    "webdav-fs": "^4.0.1",
+    "xregexp": "^5.1.0"
   }
 }

src/baseTypes.ts

@@ -0,0 +1,169 @@
+/**
+ * Only type defs here.
+ * 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;
+}
+
+export interface DropboxConfig {
+  accessToken: string;
+  clientID: string;
+  refreshToken: string;
+  accessTokenExpiresInSeconds: number;
+  accessTokenExpiresAtTime: number;
+  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; // deprecated in 0.3.6, use depth
+  depth?: WebdavDepthType;
+  remoteBaseDir?: string;
+}
+
+export interface OnedriveConfig {
+  accessToken: string;
+  clientID: string;
+  authority: string;
+  refreshToken: string;
+  accessTokenExpiresInSeconds: number;
+  accessTokenExpiresAtTime: number;
+  deltaLink: string;
+  username: string;
+  credentialsShouldBeDeletedAtTime?: number;
+  remoteBaseDir?: string;
+}
+
+export interface RemotelySavePluginSettings {
+  s3: S3Config;
+  webdav: WebdavConfig;
+  dropbox: DropboxConfig;
+  onedrive: OnedriveConfig;
+  password: string;
+  serviceType: SUPPORTED_SERVICES_TYPE;
+  currLogLevel?: string;
+  autoRunEveryMilliseconds?: number;
+  initRunAfterMilliseconds?: number;
+  agreeToUploadExtraMetadata?: boolean;
+  concurrency?: number;
+  syncConfigDir?: boolean;
+  syncUnderscoreItems?: boolean;
+  lang?: LangTypeAndAuto;
+  logToDB?: boolean;
+
+  /**
+   * @deprecated
+   */
+  vaultRandomID?: string;
+}
+
+export interface RemoteItem {
+  key: string;
+  lastModified: number;
+  size: number;
+  remoteType: SUPPORTED_SERVICES_TYPE;
+  etag?: string;
+}
+
+export const COMMAND_URI = "remotely-save";
+export const COMMAND_CALLBACK = "remotely-save-cb";
+export const COMMAND_CALLBACK_ONEDRIVE = "remotely-save-cb-onedrive";
+export const COMMAND_CALLBACK_DROPBOX = "remotely-save-cb-dropbox";
+
+export interface UriParams {
+  func?: string;
+  vault?: string;
+  ver?: string;
+  data?: string;
+}
+
+// 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 DecisionTypeForFolder =
+  | "createFolder"
+  | "uploadLocalDelHistToRemoteFolder"
+  | "keepRemoteDelHistFolder"
+  | "skipFolder";
+
+export type DecisionType = DecisionTypeForFile | DecisionTypeForFolder;
+
+export interface FileOrFolderMixedState {
+  key: string;
+  existLocal?: boolean;
+  existRemote?: boolean;
+  mtimeLocal?: number;
+  mtimeRemote?: number;
+  deltimeLocal?: number;
+  deltimeRemote?: number;
+  sizeLocal?: number;
+  sizeRemote?: 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";

src/configPersist.ts

@@ -0,0 +1,69 @@
+import { base64, base64url } from "rfc4648";
+import { reverseString } from "./misc";
+
+import type { RemotelySavePluginSettings } from "./baseTypes";
+
+import { log } from "./moreOnLog";
+
+const DEFAULT_README: string =
+  "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;
+  d: string;
+}
+
+/**
+ * this should accept the result after loadData();
+ */
+export const messyConfigToNormal = (
+  x: MessyConfigType | RemotelySavePluginSettings | null | undefined
+): RemotelySavePluginSettings | null | undefined => {
+  // log.debug("loading, original config on disk:");
+  // log.debug(x);
+  if (x === null || x === undefined) {
+    log.debug("the messy config is null or undefined, skip");
+    return x as any;
+  }
+  if ("readme" in x && "d" in x) {
+    // we should decode
+    const y = JSON.parse(
+      (
+        base64url.parse(reverseString(x["d"]), {
+          out: Buffer.allocUnsafe as any,
+          loose: true,
+        }) as Buffer
+      ).toString("utf-8")
+    );
+    // log.debug("loading, parsed config is:");
+    // log.debug(y);
+    return y;
+  } else {
+    // return as is
+    // log.debug("loading, parsed config is the same");
+    return x;
+  }
+};
+
+/**
+ * this should accept the result of original config
+ */
+export const normalConfigToMessy = (
+  x: RemotelySavePluginSettings | null | undefined
+) => {
+  if (x === null || x === undefined) {
+    log.debug("the normal config is null or undefined, skip");
+    return x;
+  }
+  const y = {
+    readme: DEFAULT_README,
+    d: reverseString(
+      base64url.stringify(Buffer.from(JSON.stringify(x), "utf-8"), {
+        pad: false,
+      })
+    ),
+  };
+  // log.debug("encoding, encoded config is:");
+  // log.debug(y);
+  return y;
+};

src/debugMode.ts

@@ -1,37 +1,130 @@
 import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
 
-import * as lf from "lovefield-ts/dist/es6/lf.js";
-
 import type { SyncPlanType } from "./sync";
 import {
-  insertSyncPlanRecord,
-  clearAllSyncPlanRecords,
-  readAllSyncPlanRecordTexts,
+  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";
 
-const DEFAULT_DEBUG_FOLDER = "_debug_save_remote/";
-const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX = "sync_plans_hist_exported_on_";
+import { log } from "./moreOnLog";
 
-export const exportSyncPlansToFiles = async (
-  db: lf.DatabaseConnection,
-  vault: Vault
+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",
+    "mtimeLocal",
+    "deltimeLocal",
+    "changeLocalMtimeUsingMapping",
+    "existRemote",
+    "sizeRemote",
+    "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,
+  toFormat: "table" | "json" = "json"
 ) => {
-  console.log("exporting");
+  log.info("exporting");
   await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
-  const records = await readAllSyncPlanRecordTexts(db);
+  const records = await readAllSyncPlanRecordTextsByVault(db, vaultRandomID);
   let md = "";
   if (records.length === 0) {
     md = "No sync plans history found";
   } else {
-    md =
-      "Sync plans found:\n\n" +
-      records.map((x) => "```json\n" + x + "\n```\n").join("\n");
+    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`;
   await vault.create(filePath, md, {
     mtime: ts,
   });
-  console.log("finish exporting");
+  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,15 +1,14 @@
-import { base32, base64 } from "rfc4648";
-import {
-  bufferToArrayBuffer,
-  arrayBufferToBuffer,
-  hexStringToTypedArray,
-  arrayBufferToHex,
-} from "./misc";
+import { base32, base64url } from "rfc4648";
+import { bufferToArrayBuffer, hexStringToTypedArray } from "./misc";
 
-const DEFAULT_ITER = 10000;
+import { log } from "./moreOnLog";
+
+const DEFAULT_ITER = 20000;
 
 // base32.stringify(Buffer.from('Salted__'))
 export const MAGIC_ENCRYPTED_PREFIX_BASE32 = "KNQWY5DFMRPV";
+// base64.stringify(Buffer.from('Salted__'))
+export const MAGIC_ENCRYPTED_PREFIX_BASE64URL = "U2FsdGVkX";
 
 const getKeyIVFromPassword = async (
   salt: Uint8Array,
@@ -120,7 +119,7 @@ export const encryptStringToBase32 = async (
     rounds,
     saltHex
   );
-  return base32.stringify(new Uint8Array(enc));
+  return base32.stringify(new Uint8Array(enc), { pad: false });
 };
 
 export const decryptBase32ToString = async (
@@ -130,9 +129,58 @@ export const decryptBase32ToString = async (
 ) => {
   return new TextDecoder().decode(
     await decryptArrayBuffer(
-      bufferToArrayBuffer(base32.parse(text)),
+      bufferToArrayBuffer(base32.parse(text, { loose: true })),
       password,
       rounds
     )
   );
 };
+
+export const encryptStringToBase64url = async (
+  text: string,
+  password: string,
+  rounds: number = DEFAULT_ITER,
+  saltHex: string = ""
+) => {
+  const enc = await encryptArrayBuffer(
+    bufferToArrayBuffer(new TextEncoder().encode(text)),
+    password,
+    rounds,
+    saltHex
+  );
+  return base64url.stringify(new Uint8Array(enc), { pad: false });
+};
+
+export const decryptBase64urlToString = async (
+  text: string,
+  password: string,
+  rounds: number = DEFAULT_ITER
+) => {
+  return new TextDecoder().decode(
+    await decryptArrayBuffer(
+      bufferToArrayBuffer(base64url.parse(text, { loose: true })),
+      password,
+      rounds
+    )
+  );
+};
+
+export const getSizeFromOrigToEnc = (x: number) => {
+  if (x < 0 || !Number.isInteger(x)) {
+    throw Error(`x=${x} is not a valid size`);
+  }
+  return (Math.floor(x / 16) + 1) * 16 + 16;
+};
+
+export const getSizeFromEncToOrig = (x: number) => {
+  if (x < 32 || !Number.isInteger(x)) {
+    throw Error(`${x} is not a valid size`);
+  }
+  if (x % 16 !== 0) {
+    throw Error(`${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

@@ -0,0 +1,83 @@
+import QRCode from "qrcode";
+import cloneDeep from "lodash/cloneDeep";
+
+import {
+  COMMAND_URI,
+  UriParams,
+  RemotelySavePluginSettings,
+} from "./baseTypes";
+
+import { log } from "./moreOnLog";
+
+export const exportQrCodeUri = async (
+  settings: RemotelySavePluginSettings,
+  currentVaultName: string,
+  pluginVersion: string
+) => {
+  const settings2 = cloneDeep(settings);
+  delete settings2.dropbox;
+  delete settings2.onedrive;
+  delete settings2.vaultRandomID;
+  const data = encodeURIComponent(JSON.stringify(settings2));
+  const vault = encodeURIComponent(currentVaultName);
+  const version = encodeURIComponent(pluginVersion);
+  const rawUri = `obsidian://${COMMAND_URI}?func=settings&version=${version}&vault=${vault}&data=${data}`;
+  // log.info(uri)
+  const imgUri = await QRCode.toDataURL(rawUri);
+  return {
+    rawUri,
+    imgUri,
+  };
+};
+
+export interface ProcessQrCodeResultType {
+  status: "error" | "ok";
+  message: string;
+  result?: RemotelySavePluginSettings;
+}
+
+export const importQrCodeUri = (
+  inputParams: any,
+  currentVaultName: string
+): ProcessQrCodeResultType => {
+  let params = inputParams as UriParams;
+  if (
+    params.func === undefined ||
+    params.func !== "settings" ||
+    params.vault === undefined ||
+    params.data === undefined
+  ) {
+    return {
+      status: "error",
+      message: `the uri is not for exporting/importing settings: ${JSON.stringify(
+        inputParams
+      )}`,
+    };
+  }
+
+  if (params.vault !== currentVaultName) {
+    return {
+      status: "error",
+      message: `the target vault is ${
+        params.vault
+      } but you are currently in ${currentVaultName}: ${JSON.stringify(
+        inputParams
+      )}`,
+    };
+  }
+
+  let settings = {} as RemotelySavePluginSettings;
+  try {
+    settings = JSON.parse(params.data);
+  } catch (e) {
+    return {
+      status: "error",
+      message: `errors while parsing settings: ${JSON.stringify(inputParams)}`,
+    };
+  }
+  return {
+    status: "ok",
+    message: "ok",
+    result: settings,
+  };
+};

src/localdb.ts

@@ -1,144 +1,334 @@
-import * as lf from "lovefield-ts/dist/es6/lf.js";
-import { TAbstractFile, TFile, TFolder } from "obsidian";
+import localforage from "localforage";
+export type LocalForage = typeof localforage;
+import { nanoid } from "nanoid";
+import { requireApiVersion, TAbstractFile, TFile, TFolder } from "obsidian";
 
-import type { SUPPORTED_SERVICES_TYPE } from "./misc";
+import { API_VER_STAT_FOLDER, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
 import type { SyncPlanType } from "./sync";
+import { toText, unixTimeToStr } from "./misc";
 
-export type DatabaseConnection = lf.DatabaseConnection;
+import { log } from "./moreOnLog";
 
-export const DEFAULT_DB_NAME = "saveremotedb";
-export const DEFAULT_TBL_DELETE_HISTORY = "filefolderoperationhistory";
+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_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 interface FileFolderHistoryRecord {
   key: string;
   ctime: number;
   mtime: number;
   size: number;
-  action_when: number;
-  action_type: "delete" | "rename";
-  key_type: "folder" | "file";
-  rename_to: string;
+  actionWhen: number;
+  actionType: "delete" | "rename" | "renameDestination";
+  keyType: "folder" | "file";
+  renameTo: string;
+  vaultRandomID: string;
 }
 
-export interface SyncMetaMappingRecord {
-  local_key: string;
-  remote_key: string;
-  local_size: number;
-  remote_size: number;
-  local_mtime: number;
-  remote_mtime: number;
-  remote_extra_key: string;
-  remote_type: SUPPORTED_SERVICES_TYPE;
-  key_type: "folder" | "file";
+interface SyncMetaMappingRecord {
+  localKey: string;
+  remoteKey: string;
+  localSize: number;
+  remoteSize: number;
+  localMtime: number;
+  remoteMtime: number;
+  remoteExtraKey: string;
+  remoteType: SUPPORTED_SERVICES_TYPE;
+  keyType: "folder" | "file";
+  vaultRandomID: string;
 }
 
 interface SyncPlanRecord {
   ts: number;
-  remote_type: string;
-  sync_plan: string;
+  remoteType: string;
+  syncPlan: string;
+  vaultRandomID: string;
 }
 
-export const prepareDBs = async () => {
-  const schemaBuilder = lf.schema.create(DEFAULT_DB_NAME, 1);
-  schemaBuilder
-    .createTable(DEFAULT_TBL_DELETE_HISTORY)
-    .addColumn("id", lf.Type.INTEGER)
-    .addColumn("key", lf.Type.STRING)
-    .addColumn("ctime", lf.Type.INTEGER)
-    .addColumn("mtime", lf.Type.INTEGER)
-    .addColumn("size", lf.Type.INTEGER)
-    .addColumn("action_when", lf.Type.INTEGER)
-    .addColumn("action_type", lf.Type.STRING)
-    .addColumn("key_type", lf.Type.STRING)
-    .addPrimaryKey(["id"], true)
-    .addIndex("idxKey", ["key"]);
+export interface InternalDBs {
+  versionTbl: LocalForage;
+  fileHistoryTbl: LocalForage;
+  syncMappingTbl: LocalForage;
+  syncPlansTbl: LocalForage;
+  vaultRandomIDMappingTbl: LocalForage;
+  loggerOutputTbl: LocalForage;
+}
 
-  schemaBuilder
-    .createTable(DEFAULT_TBL_SYNC_MAPPING)
-    .addColumn("id", lf.Type.INTEGER)
-    .addColumn("local_key", lf.Type.STRING)
-    .addColumn("remote_key", lf.Type.STRING)
-    .addColumn("local_size", lf.Type.INTEGER)
-    .addColumn("remote_size", lf.Type.INTEGER)
-    .addColumn("local_mtime", lf.Type.INTEGER)
-    .addColumn("remote_mtime", lf.Type.INTEGER)
-    .addColumn("key_type", lf.Type.STRING)
-    .addColumn("remote_extra_key", lf.Type.STRING)
-    .addColumn("remote_type", lf.Type.STRING)
-    .addNullable([
-      "remote_extra_key",
-      "remote_mtime",
-      "remote_size",
-      "local_mtime",
-    ])
-    .addPrimaryKey(["id"], true)
-    .addIndex("idxkey", ["local_key", "remote_key"]);
+/**
+ * This migration mainly aims to assign vault name or vault id into all tables.
+ * @param db
+ * @param vaultRandomID
+ */
+const migrateDBsFrom20211114To20220108 = async (
+  db: InternalDBs,
+  vaultRandomID: string
+) => {
+  const oldVer = 20211114;
+  const newVer = 20220108;
+  log.debug(`start upgrading internal db from ${oldVer} to ${newVer}`);
 
-  schemaBuilder
-    .createTable(DEFAULT_SYNC_PLANS_HISTORY)
-    .addColumn("id", lf.Type.INTEGER)
-    .addColumn("ts", lf.Type.INTEGER)
-    .addColumn("remote_type", lf.Type.STRING)
-    .addColumn("sync_plan", lf.Type.STRING)
-    .addPrimaryKey(["id"], true)
-    .addIndex("tskey", ["ts"]);
+  const allPromisesToWait: Promise<any>[] = [];
 
-  const db = await schemaBuilder.connect({
-    storeType: lf.DataStoreType.INDEXED_DB,
-  });
-  console.log("db connected");
-  return db;
+  log.debug("assign vault id to any delete history");
+  const keysInDeleteHistoryTbl = await db.fileHistoryTbl.keys();
+  for (const key of keysInDeleteHistoryTbl) {
+    if (key.startsWith(vaultRandomID)) {
+      continue;
+    }
+    const value = (await db.fileHistoryTbl.getItem(
+      key
+    )) as FileFolderHistoryRecord;
+    if (value === null || value === undefined) {
+      continue;
+    }
+    if (value.vaultRandomID === undefined || value.vaultRandomID === "") {
+      value.vaultRandomID = vaultRandomID;
+    }
+    const newKey = `${vaultRandomID}\t${key}`;
+    allPromisesToWait.push(db.fileHistoryTbl.setItem(newKey, value));
+    allPromisesToWait.push(db.fileHistoryTbl.removeItem(key));
+  }
+
+  log.debug("assign vault id to any sync mapping");
+  const keysInSyncMappingTbl = await db.syncMappingTbl.keys();
+  for (const key of keysInSyncMappingTbl) {
+    if (key.startsWith(vaultRandomID)) {
+      continue;
+    }
+    const value = (await db.syncMappingTbl.getItem(
+      key
+    )) as SyncMetaMappingRecord;
+    if (value === null || value === undefined) {
+      continue;
+    }
+    if (value.vaultRandomID === undefined || value.vaultRandomID === "") {
+      value.vaultRandomID = vaultRandomID;
+    }
+    const newKey = `${vaultRandomID}\t${key}`;
+    allPromisesToWait.push(db.syncMappingTbl.setItem(newKey, value));
+    allPromisesToWait.push(db.syncMappingTbl.removeItem(key));
+  }
+
+  log.debug("assign vault id to any sync plan records");
+  const keysInSyncPlansTbl = await db.syncPlansTbl.keys();
+  for (const key of keysInSyncPlansTbl) {
+    if (key.startsWith(vaultRandomID)) {
+      continue;
+    }
+    const value = (await db.syncPlansTbl.getItem(key)) as SyncPlanRecord;
+    if (value === null || value === undefined) {
+      continue;
+    }
+    if (value.vaultRandomID === undefined || value.vaultRandomID === "") {
+      value.vaultRandomID = vaultRandomID;
+    }
+    const newKey = `${vaultRandomID}\t${key}`;
+    allPromisesToWait.push(db.syncPlansTbl.setItem(newKey, value));
+    allPromisesToWait.push(db.syncPlansTbl.removeItem(key));
+  }
+
+  log.debug("finally update version if everything is ok");
+  await Promise.all(allPromisesToWait);
+  await db.versionTbl.setItem("version", newVer);
+
+  log.debug(`finish upgrading internal db from ${oldVer} to ${newVer}`);
 };
 
-export const destroyDBs = async (db: lf.DatabaseConnection) => {
-  db.close();
+/**
+ * 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,
+  newVer: number,
+  vaultRandomID: string
+) => {
+  if (oldVer === newVer) {
+    return;
+  }
+  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 (
+  vaultBasePath: string,
+  vaultRandomIDFromOldConfigFile: string
+) => {
+  const db = {
+    versionTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_VERSION,
+    }),
+    fileHistoryTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_FILE_HISTORY,
+    }),
+    syncMappingTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_SYNC_MAPPING,
+    }),
+    syncPlansTbl: localforage.createInstance({
+      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,
+    }),
+  } as InternalDBs;
+
+  // 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}`
+    );
+    await db.versionTbl.setItem("version", DEFAULT_DB_VERSION_NUMBER);
+  } else if (originalVersion === DEFAULT_DB_VERSION_NUMBER) {
+    // do nothing
+  } else {
+    log.debug(
+      `trying to upgrade db version from ${originalVersion} to ${DEFAULT_DB_VERSION_NUMBER}`
+    );
+    await migrateDBs(
+      db,
+      originalVersion,
+      DEFAULT_DB_VERSION_NUMBER,
+      vaultRandomID
+    );
+  }
+
+  log.info("db connected");
+  return {
+    db: db,
+    vaultRandomID: vaultRandomID,
+  };
+};
+
+export const destroyDBs = async () => {
+  // await localforage.dropInstance({
+  //   name: DEFAULT_DB_NAME,
+  // });
+  // log.info("db deleted");
   const req = indexedDB.deleteDatabase(DEFAULT_DB_NAME);
   req.onsuccess = (event) => {
-    console.log("db deleted");
+    log.info("db deleted");
   };
   req.onblocked = (event) => {
-    console.warn("trying to delete db but it was blocked");
+    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 loadDeleteRenameHistoryTable = async (
-  db: lf.DatabaseConnection
+export const loadFileHistoryTableByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  const tbl = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-
-  const records = await db
-    .select()
-    .from(schema)
-    .orderBy(schema.col("action_when"), lf.Order.ASC)
-    .exec();
-
-  return records as FileFolderHistoryRecord[];
+  const records = [] as FileFolderHistoryRecord[];
+  await db.fileHistoryTbl.iterate((value, key, iterationNumber) => {
+    if (key.startsWith(`${vaultRandomID}\t`)) {
+      records.push(value as FileFolderHistoryRecord);
+    }
+  });
+  records.sort((a, b) => a.actionWhen - b.actionWhen); // ascending
+  return records;
 };
 
-export const clearDeleteRenameHistoryOfKey = async (
-  db: lf.DatabaseConnection,
-  key: string
+export const clearDeleteRenameHistoryOfKeyAndVault = async (
+  db: InternalDBs,
+  key: string,
+  vaultRandomID: string
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  const tbl = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-
-  await db.delete().from(tbl).where(tbl.col("key").eq(key)).exec();
+  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 insertDeleteRecord = async (
-  db: lf.DatabaseConnection,
-  fileOrFolder: TAbstractFile
+export const insertDeleteRecordByVault = async (
+  db: InternalDBs,
+  fileOrFolder: TAbstractFile,
+  vaultRandomID: string
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  const tbl = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  // console.log(fileOrFolder);
+  // log.info(fileOrFolder);
   let k: FileFolderHistoryRecord;
   if (fileOrFolder instanceof TFile) {
     k = {
@@ -146,171 +336,348 @@ export const insertDeleteRecord = async (
       ctime: fileOrFolder.stat.ctime,
       mtime: fileOrFolder.stat.mtime,
       size: fileOrFolder.stat.size,
-      action_when: Date.now(),
-      action_type: "delete",
-      key_type: "file",
-      rename_to: "",
+      actionWhen: Date.now(),
+      actionType: "delete",
+      keyType: "file",
+      renameTo: "",
+      vaultRandomID: vaultRandomID,
     };
   } 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: 0,
-      mtime: 0,
+      ctime: ctime,
+      mtime: mtime,
       size: 0,
-      action_when: Date.now(),
-      action_type: "delete",
-      key_type: "folder",
-      rename_to: "",
+      actionWhen: Date.now(),
+      actionType: "delete",
+      keyType: "folder",
+      renameTo: "",
+      vaultRandomID: vaultRandomID,
     };
   }
-  const row = tbl.createRow(k);
-  await db.insertOrReplace().into(tbl).values([row]).exec();
+  await db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
 };
 
-export const insertRenameRecord = async (
-  db: lf.DatabaseConnection,
+/**
+ * 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,
-  oldPath: string
+  oldPath: string,
+  vaultRandomID: string
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  const tbl = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  // console.log(fileOrFolder);
-  let k: FileFolderHistoryRecord;
+  // log.info(fileOrFolder);
+  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,
-      action_when: Date.now(),
-      action_type: "rename",
-      key_type: "file",
-      rename_to: fileOrFolder.path,
+      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 fileOrFolder.vault.adapter.stat(fileOrFolder.path);
+      ctime = s.ctime;
+      mtime = s.mtime;
+    }
+    k1 = {
       key: key,
-      ctime: 0,
-      mtime: 0,
+      ctime: ctime,
+      mtime: mtime,
       size: 0,
-      action_when: Date.now(),
-      action_type: "rename",
-      key_type: "folder",
-      rename_to: renameTo,
+      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,
     };
   }
-  const row = tbl.createRow(k);
-  await db.insertOrReplace().into(tbl).values([row]).exec();
+  await Promise.all([
+    db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k1.key}`, k1),
+    db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k2.key}`, k2),
+  ]);
 };
 
-export const getAllDeleteRenameRecords = async (db: lf.DatabaseConnection) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  const res1 = await db.select().from(schema).exec();
-  const res2 = res1 as FileFolderHistoryRecord[];
-  return res2;
-};
-
-export const upsertSyncMetaMappingDataS3 = async (
-  db: lf.DatabaseConnection,
+export const upsertSyncMetaMappingDataByVault = async (
+  serviceType: SUPPORTED_SERVICES_TYPE,
+  db: InternalDBs,
   localKey: string,
   localMTime: number,
   localSize: number,
   remoteKey: string,
   remoteMTime: number,
   remoteSize: number,
-  remoteExtraKey: string /* ETag from s3 */
+  remoteExtraKey: string,
+  vaultRandomID: string
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_SYNC_MAPPING);
   const aggregratedInfo: SyncMetaMappingRecord = {
-    local_key: localKey,
-    local_mtime: localMTime,
-    local_size: localSize,
-    remote_key: remoteKey,
-    remote_mtime: remoteMTime,
-    remote_size: remoteSize,
-    remote_extra_key: remoteExtraKey,
-    remote_type: "s3",
-    key_type: localKey.endsWith("/") ? "folder" : "file",
+    localKey: localKey,
+    localMtime: localMTime,
+    localSize: localSize,
+    remoteKey: remoteKey,
+    remoteMtime: remoteMTime,
+    remoteSize: remoteSize,
+    remoteExtraKey: remoteExtraKey,
+    remoteType: serviceType,
+    keyType: localKey.endsWith("/") ? "folder" : "file",
+    vaultRandomID: vaultRandomID,
   };
-  const row = schema.createRow(aggregratedInfo);
-  await db.insertOrReplace().into(schema).values([row]).exec();
+  await db.syncMappingTbl.setItem(
+    `${vaultRandomID}\t${remoteKey}`,
+    aggregratedInfo
+  );
 };
 
-export const getSyncMetaMappingByRemoteKeyS3 = async (
-  db: lf.DatabaseConnection,
+export const getSyncMetaMappingByRemoteKeyAndVault = async (
+  serviceType: SUPPORTED_SERVICES_TYPE,
+  db: InternalDBs,
   remoteKey: string,
   remoteMTime: number,
-  remoteExtraKey: string
+  remoteExtraKey: string,
+  vaultRandomID: string
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_SYNC_MAPPING);
-  const tbl = db.getSchema().table(DEFAULT_TBL_SYNC_MAPPING);
-  const res = (await db
-    .select()
-    .from(tbl)
-    .where(
-      lf.op.and(
-        tbl.col("remote_key").eq(remoteKey),
-        tbl.col("remote_mtime").eq(remoteMTime),
-        tbl.col("remote_extra_key").eq(remoteExtraKey),
-        tbl.col("remote_type").eq("s3")
-      )
-    )
-    .exec()) as SyncMetaMappingRecord[];
+  const potentialItem = (await db.syncMappingTbl.getItem(
+    `${vaultRandomID}\t${remoteKey}`
+  )) as SyncMetaMappingRecord;
 
-  if (res.length === 1) {
-    return res[0];
-  }
-
-  if (res.length === 0) {
+  if (potentialItem === null) {
+    // no result was found
     return undefined;
   }
 
-  throw Error("something bad in sync meta mapping!");
+  if (
+    potentialItem.remoteKey === remoteKey &&
+    potentialItem.remoteMtime === remoteMTime &&
+    potentialItem.remoteExtraKey === remoteExtraKey &&
+    potentialItem.remoteType === serviceType
+  ) {
+    // the result was found
+    return potentialItem;
+  } else {
+    return undefined;
+  }
 };
 
-export const clearAllSyncMetaMapping = async (db: lf.DatabaseConnection) => {
-  const tbl = db.getSchema().table(DEFAULT_TBL_SYNC_MAPPING);
-  await db.delete().from(tbl).exec();
+export const clearAllSyncMetaMapping = async (db: InternalDBs) => {
+  await db.syncMappingTbl.clear();
 };
 
-export const insertSyncPlanRecord = async (
-  db: lf.DatabaseConnection,
-  syncPlan: SyncPlanType
+export const insertSyncPlanRecordByVault = async (
+  db: InternalDBs,
+  syncPlan: SyncPlanType,
+  vaultRandomID: string
 ) => {
-  const schema = db.getSchema().table(DEFAULT_SYNC_PLANS_HISTORY);
-  const row = schema.createRow({
+  const record = {
     ts: syncPlan.ts,
-    remote_type: syncPlan.remoteType,
-    sync_plan: JSON.stringify(syncPlan, null, 2),
-  } as SyncPlanRecord);
-  await db.insertOrReplace().into(schema).values([row]).exec();
+    tsFmt: syncPlan.tsFmt,
+    vaultRandomID: vaultRandomID,
+    remoteType: syncPlan.remoteType,
+    syncPlan: JSON.stringify(syncPlan /* directly stringify */, null, 2),
+  } as SyncPlanRecord;
+  await db.syncPlansTbl.setItem(`${vaultRandomID}\t${syncPlan.ts}`, record);
 };
 
-export const clearAllSyncPlanRecords = async (db: lf.DatabaseConnection) => {
-  const tbl = db.getSchema().table(DEFAULT_SYNC_PLANS_HISTORY);
-  await db.delete().from(tbl).exec();
+export const clearAllSyncPlanRecords = async (db: InternalDBs) => {
+  await db.syncPlansTbl.clear();
 };
 
-export const readAllSyncPlanRecordTexts = async (db: lf.DatabaseConnection) => {
-  const schema = db.getSchema().table(DEFAULT_SYNC_PLANS_HISTORY);
-
-  const records = (await db
-    .select()
-    .from(schema)
-    .orderBy(schema.col("ts"), lf.Order.DESC)
-    .exec()) as SyncPlanRecord[];
+export const readAllSyncPlanRecordTextsByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string
+) => {
+  const records = [] as SyncPlanRecord[];
+  await db.syncPlansTbl.iterate((value, key, iterationNumber) => {
+    if (key.startsWith(`${vaultRandomID}\t`)) {
+      records.push(value as SyncPlanRecord);
+    }
+  });
+  records.sort((a, b) => -(a.ts - b.ts)); // descending
 
   if (records === undefined) {
     return [] as string[];
   } else {
-    return records.map((x) => x.sync_plan);
+    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);
+};

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

@@ -1,28 +1,44 @@
 import { Vault } from "obsidian";
 import * as path from "path";
 
-import { base32 } from "rfc4648";
+import { base32, base64url } from "rfc4648";
+import XRegExp from "xregexp";
+import emojiRegex from "emoji-regex";
 
-export type SUPPORTED_SERVICES_TYPE = "s3" | "webdav" | "ftp";
+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
-  // console.log(k2)
+  // log.info(k2)
   for (const singlePart of k2) {
     if (singlePart === "." || singlePart === ".." || singlePart === "") {
       continue;
     }
-    if (singlePart[0] === ".") {
+    if (dot && singlePart[0] === ".") {
       return true;
     }
-    if (loose && singlePart[0] === "_") {
+    if (underscore && singlePart[0] === "_") {
       return true;
     }
   }
@@ -36,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 === "/") {
@@ -46,20 +62,27 @@ export const getFolderLevels = (x: string) => {
   const y1 = x.split("/");
   let i = 0;
   for (let index = 0; index + 1 < y1.length; index++) {
-    res.push(y1.slice(0, index + 1).join("/"));
+    let k = y1.slice(0, index + 1).join("/");
+    if (k === "" || k === "/") {
+      continue;
+    }
+    if (addEndingSlash) {
+      k = `${k}/`;
+    }
+    res.push(k);
   }
   return res;
 };
 
 export const mkdirpInVault = async (thePath: string, vault: Vault) => {
-  // console.log(thePath);
+  // log.info(thePath);
   const foldersToBuild = getFolderLevels(thePath);
-  // console.log(foldersToBuild);
+  // log.info(foldersToBuild);
   for (const folder of foldersToBuild) {
     const r = await vault.adapter.exists(folder);
-    // console.log(r);
+    // log.info(r);
     if (!r) {
-      console.log(`mkdir ${folder}`);
+      log.info(`mkdir ${folder}`);
       await vault.adapter.mkdir(folder);
     }
   }
@@ -70,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);
 };
 
@@ -111,3 +136,275 @@ export const hexStringToTypedArray = (hex: string) => {
 export const base64ToBase32 = (a: string) => {
   return base32.stringify(Buffer.from(a, "base64"));
 };
+
+export const base64ToBase64url = (a: string, pad: boolean = false) => {
+  let b = a.replace(/\+/g, "-").replace(/\//g, "_");
+  if (!pad) {
+    b = b.replace(/=/g, "");
+  }
+  return b;
+};
+
+/**
+ * iOS Safari could decrypt string with invalid password!
+ * So we need an extra way to test the decrypted result.
+ * One simple way is testing the result are "valid", printable chars or not.
+ *
+ * https://stackoverflow.com/questions/6198986
+ * https://www.regular-expressions.info/unicode.html
+ * Manual test shows that emojis like '🍎' match '\\p{Cs}',
+ * so we need to write the regrex in a form that \p{C} minus \p{Cs}
+ * @param a
+ */
+export const isVaildText = (a: string) => {
+  // If the regex matches, the string is invalid.
+  return !XRegExp("\\p{Cc}|\\p{Cf}|\\p{Co}|\\p{Cn}|\\p{Zl}|\\p{Zp}", "A").test(
+    a
+  );
+};
+
+/**
+ * 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.
+ * @param a
+ * @returns
+ */
+export const getPathFolder = (a: string) => {
+  if (a.endsWith("/")) {
+    return a;
+  }
+  const b = path.posix.dirname(a);
+  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
+ * @param delimiter
+ * @returns
+ */
+export const setToString = (a: Set<string>, delimiter: string = ",") => {
+  return [...a].join(delimiter);
+};
+
+export const extractSvgSub = (x: string, subEl: string = "rect") => {
+  const parser = new window.DOMParser();
+  const dom = parser.parseFromString(x, "image/svg+xml");
+  const svg = dom.querySelector("svg");
+  svg.setAttribute("viewbox", "0 0 10 10");
+  return svg.innerHTML;
+};
+
+/**
+ * https://stackoverflow.com/questions/18230217
+ * @param min
+ * @param max
+ * @returns
+ */
+export const getRandomIntInclusive = (min: number, max: number) => {
+  const randomBuffer = new Uint32Array(1);
+  window.crypto.getRandomValues(randomBuffer);
+  let randomNumber = randomBuffer[0] / (0xffffffff + 1);
+  min = Math.ceil(min);
+  max = Math.floor(max);
+  return Math.floor(randomNumber * (max - min + 1)) + min;
+};
+
+/**
+ * Random buffer
+ * @param byteLength
+ * @returns
+ */
+export const getRandomArrayBuffer = (byteLength: number) => {
+  const k = window.crypto.getRandomValues(new Uint8Array(byteLength));
+  return bufferToArrayBuffer(k);
+};
+
+/**
+ * https://stackoverflow.com/questions/958908
+ * @param x
+ * @returns
+ */
+export const reverseString = (x: string) => {
+  return [...x].reverse().join("");
+};
+
+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) {
+    return undefined;
+  }
+  if (x === null) {
+    return null;
+  }
+  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}`;
+  }
+};

src/moreOnLog.ts

@@ -0,0 +1,34 @@
+// 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 } from "loglevel";
+const log2 = origLog.getLogger("rs-default");
+
+const originalFactory = log2.methodFactory;
+
+export const applyLogWriterInplace = function (writer: (...msg: any[]) => any) {
+  log2.methodFactory = function (
+    methodName: string,
+    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,124 @@
+import { Vault, Stat, ListedFiles } from "obsidian";
+import { Queue } from "@fyears/tsqueue";
+import chunk from "lodash/chunk";
+import flatten from "lodash/flatten";
+
+export interface ObsConfigDirFileType {
+  key: string;
+  ctime: number;
+  mtime: number;
+  size: number;
+  type: "folder" | "file";
+}
+
+const isFolderToSkip = (x: string) => {
+  let specialFolders = [".git", ".svn", "node_modules"];
+  for (const iterator of specialFolders) {
+    if (
+      x === iterator ||
+      x === `${iterator}/` ||
+      x.endsWith(`/${iterator}`) ||
+      x.endsWith(`/${iterator}/`)
+    ) {
+      return true;
+    }
+  }
+  return false;
+};
+
+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 vault.adapter.stat(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)) {
+              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)) {
+              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

@@ -0,0 +1,316 @@
+import { Vault } from "obsidian";
+import type {
+  DropboxConfig,
+  OnedriveConfig,
+  S3Config,
+  SUPPORTED_SERVICES_TYPE,
+  WebdavConfig,
+} from "./baseTypes";
+import * as dropbox from "./remoteForDropbox";
+import * as onedrive from "./remoteForOnedrive";
+import * as s3 from "./remoteForS3";
+import * as webdav from "./remoteForWebdav";
+
+import { log } from "./moreOnLog";
+
+export class RemoteClient {
+  readonly serviceType: SUPPORTED_SERVICES_TYPE;
+  readonly s3Config?: S3Config;
+  readonly webdavClient?: webdav.WrappedWebdavClient;
+  readonly webdavConfig?: WebdavConfig;
+  readonly dropboxClient?: dropbox.WrappedDropboxClient;
+  readonly dropboxConfig?: DropboxConfig;
+  readonly onedriveClient?: onedrive.WrappedOnedriveClient;
+  readonly onedriveConfig?: OnedriveConfig;
+
+  constructor(
+    serviceType: SUPPORTED_SERVICES_TYPE,
+    s3Config?: S3Config,
+    webdavConfig?: WebdavConfig,
+    dropboxConfig?: DropboxConfig,
+    onedriveConfig?: OnedriveConfig,
+    vaultName?: string,
+    saveUpdatedConfigFunc?: () => Promise<any>
+  ) {
+    this.serviceType = serviceType;
+    // the client may modify the config inplace,
+    // so we use a ref not copy of config here
+    if (serviceType === "s3") {
+      this.s3Config = s3Config;
+    } else if (serviceType === "webdav") {
+      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,
+        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,
+        remoteBaseDir,
+        saveUpdatedConfigFunc
+      );
+    } else if (serviceType === "onedrive") {
+      if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
+        throw Error(
+          "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,
+        remoteBaseDir,
+        saveUpdatedConfigFunc
+      );
+    } else {
+      throw Error(`not supported service type ${this.serviceType}`);
+    }
+  }
+
+  getRemoteMeta = async (fileOrFolderPath: string) => {
+    if (this.serviceType === "s3") {
+      return await s3.getRemoteMeta(
+        s3.getS3Client(this.s3Config),
+        this.s3Config,
+        fileOrFolderPath
+      );
+    } else if (this.serviceType === "webdav") {
+      return await webdav.getRemoteMeta(this.webdavClient, fileOrFolderPath);
+    } else if (this.serviceType === "dropbox") {
+      return await dropbox.getRemoteMeta(this.dropboxClient, fileOrFolderPath);
+    } else if (this.serviceType === "onedrive") {
+      return await onedrive.getRemoteMeta(
+        this.onedriveClient,
+        fileOrFolderPath
+      );
+    } else {
+      throw Error(`not supported service type ${this.serviceType}`);
+    }
+  };
+
+  uploadToRemote = async (
+    fileOrFolderPath: string,
+    vault: Vault,
+    isRecursively: boolean = false,
+    password: string = "",
+    remoteEncryptedKey: string = "",
+    foldersCreatedBefore: Set<string> | undefined = undefined,
+    uploadRaw: boolean = false,
+    rawContent: string | ArrayBuffer = ""
+  ) => {
+    if (this.serviceType === "s3") {
+      return await s3.uploadToRemote(
+        s3.getS3Client(this.s3Config),
+        this.s3Config,
+        fileOrFolderPath,
+        vault,
+        isRecursively,
+        password,
+        remoteEncryptedKey,
+        uploadRaw,
+        rawContent
+      );
+    } else if (this.serviceType === "webdav") {
+      return await webdav.uploadToRemote(
+        this.webdavClient,
+        fileOrFolderPath,
+        vault,
+        isRecursively,
+        password,
+        remoteEncryptedKey,
+        uploadRaw,
+        rawContent
+      );
+    } else if (this.serviceType === "dropbox") {
+      return await dropbox.uploadToRemote(
+        this.dropboxClient,
+        fileOrFolderPath,
+        vault,
+        isRecursively,
+        password,
+        remoteEncryptedKey,
+        foldersCreatedBefore,
+        uploadRaw,
+        rawContent
+      );
+    } else if (this.serviceType === "onedrive") {
+      return await onedrive.uploadToRemote(
+        this.onedriveClient,
+        fileOrFolderPath,
+        vault,
+        isRecursively,
+        password,
+        remoteEncryptedKey,
+        foldersCreatedBefore,
+        uploadRaw,
+        rawContent
+      );
+    } else {
+      throw Error(`not supported service type ${this.serviceType}`);
+    }
+  };
+
+  listFromRemote = async (prefix?: string) => {
+    if (this.serviceType === "s3") {
+      return await s3.listFromRemote(
+        s3.getS3Client(this.s3Config),
+        this.s3Config,
+        prefix
+      );
+    } else if (this.serviceType === "webdav") {
+      return await webdav.listFromRemote(this.webdavClient, prefix);
+    } else if (this.serviceType === "dropbox") {
+      return await dropbox.listFromRemote(this.dropboxClient, prefix);
+    } else if (this.serviceType === "onedrive") {
+      return await onedrive.listFromRemote(this.onedriveClient, prefix);
+    } else {
+      throw Error(`not supported service type ${this.serviceType}`);
+    }
+  };
+
+  downloadFromRemote = async (
+    fileOrFolderPath: string,
+    vault: Vault,
+    mtime: number,
+    password: string = "",
+    remoteEncryptedKey: string = "",
+    skipSaving: boolean = false
+  ) => {
+    if (this.serviceType === "s3") {
+      return await s3.downloadFromRemote(
+        s3.getS3Client(this.s3Config),
+        this.s3Config,
+        fileOrFolderPath,
+        vault,
+        mtime,
+        password,
+        remoteEncryptedKey,
+        skipSaving
+      );
+    } else if (this.serviceType === "webdav") {
+      return await webdav.downloadFromRemote(
+        this.webdavClient,
+        fileOrFolderPath,
+        vault,
+        mtime,
+        password,
+        remoteEncryptedKey,
+        skipSaving
+      );
+    } else if (this.serviceType === "dropbox") {
+      return await dropbox.downloadFromRemote(
+        this.dropboxClient,
+        fileOrFolderPath,
+        vault,
+        mtime,
+        password,
+        remoteEncryptedKey,
+        skipSaving
+      );
+    } else if (this.serviceType === "onedrive") {
+      return await onedrive.downloadFromRemote(
+        this.onedriveClient,
+        fileOrFolderPath,
+        vault,
+        mtime,
+        password,
+        remoteEncryptedKey,
+        skipSaving
+      );
+    } else {
+      throw Error(`not supported service type ${this.serviceType}`);
+    }
+  };
+
+  deleteFromRemote = async (
+    fileOrFolderPath: string,
+    password: string = "",
+    remoteEncryptedKey: string = ""
+  ) => {
+    if (this.serviceType === "s3") {
+      return await s3.deleteFromRemote(
+        s3.getS3Client(this.s3Config),
+        this.s3Config,
+        fileOrFolderPath,
+        password,
+        remoteEncryptedKey
+      );
+    } else if (this.serviceType === "webdav") {
+      return await webdav.deleteFromRemote(
+        this.webdavClient,
+        fileOrFolderPath,
+        password,
+        remoteEncryptedKey
+      );
+    } else if (this.serviceType === "dropbox") {
+      return await dropbox.deleteFromRemote(
+        this.dropboxClient,
+        fileOrFolderPath,
+        password,
+        remoteEncryptedKey
+      );
+    } else if (this.serviceType === "onedrive") {
+      return await onedrive.deleteFromRemote(
+        this.onedriveClient,
+        fileOrFolderPath,
+        password,
+        remoteEncryptedKey
+      );
+    } else {
+      throw Error(`not supported service type ${this.serviceType}`);
+    }
+  };
+
+  checkConnectivity = async (callbackFunc?: any) => {
+    if (this.serviceType === "s3") {
+      return await s3.checkConnectivity(
+        s3.getS3Client(this.s3Config),
+        this.s3Config,
+        callbackFunc
+      );
+    } else if (this.serviceType === "webdav") {
+      return await webdav.checkConnectivity(this.webdavClient, callbackFunc);
+    } else if (this.serviceType === "dropbox") {
+      return await dropbox.checkConnectivity(this.dropboxClient, callbackFunc);
+    } else if (this.serviceType === "onedrive") {
+      return await onedrive.checkConnectivity(
+        this.onedriveClient,
+        callbackFunc
+      );
+    } else {
+      throw Error(`not supported service type ${this.serviceType}`);
+    }
+  };
+
+  getUser = async () => {
+    if (this.serviceType === "dropbox") {
+      return await dropbox.getUserDisplayName(this.dropboxClient);
+    } else if (this.serviceType === "onedrive") {
+      return await onedrive.getUserDisplayName(this.onedriveClient);
+    } else {
+      throw Error(`not supported service type ${this.serviceType}`);
+    }
+  };
+
+  revokeAuth = async () => {
+    if (this.serviceType === "dropbox") {
+      return await dropbox.revokeAuth(this.dropboxClient);
+    } else {
+      throw Error(`not supported service type ${this.serviceType}`);
+    }
+  };
+}

src/remoteForDropbox.ts

@@ -0,0 +1,789 @@
+import delay from "delay";
+import { Dropbox, DropboxAuth } from "dropbox";
+import type { files, DropboxResponseError, DropboxResponse } from "dropbox";
+import { Vault } from "obsidian";
+import * as path from "path";
+import {
+  DropboxConfig,
+  RemoteItem,
+  COMMAND_CALLBACK_DROPBOX,
+  OAUTH2_FORCE_EXPIRE_MILLISECONDS,
+} from "./baseTypes";
+import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
+import {
+  bufferToArrayBuffer,
+  getFolderLevels,
+  hasEmojiInText,
+  headersToRecord,
+  mkdirpInVault,
+} from "./misc";
+
+export { Dropbox } from "dropbox";
+
+import { log } from "./moreOnLog";
+
+export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
+  accessToken: "",
+  clientID: process.env.DEFAULT_DROPBOX_APP_KEY,
+  refreshToken: "",
+  accessTokenExpiresInSeconds: 0,
+  accessTokenExpiresAtTime: 0,
+  accountID: "",
+  username: "",
+  credentialsShouldBeDeletedAtTime: 0,
+};
+
+export const getDropboxPath = (
+  fileOrFolderPath: string,
+  remoteBaseDir: string
+) => {
+  let key = fileOrFolderPath;
+  if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
+    // special
+    key = `/${remoteBaseDir}`;
+  }
+  if (!fileOrFolderPath.startsWith("/")) {
+    // then this is original path in Obsidian
+    key = `/${remoteBaseDir}/${fileOrFolderPath}`;
+  }
+  if (key.endsWith("/")) {
+    key = key.slice(0, key.length - 1);
+  }
+  return key;
+};
+
+const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
+  if (
+    !(
+      fileOrFolderPath === `/${remoteBaseDir}` ||
+      fileOrFolderPath.startsWith(`/${remoteBaseDir}/`)
+    )
+  ) {
+    throw Error(
+      `"${fileOrFolderPath}" doesn't starts with "/${remoteBaseDir}/"`
+    );
+  }
+  return fileOrFolderPath.slice(`/${remoteBaseDir}/`.length);
+};
+
+const fromDropboxItemToRemoteItem = (
+  x:
+    | files.FileMetadataReference
+    | files.FolderMetadataReference
+    | files.DeletedMetadataReference,
+  remoteBaseDir: string
+): RemoteItem => {
+  let key = getNormPath(x.path_display, remoteBaseDir);
+  if (x[".tag"] === "folder" && !key.endsWith("/")) {
+    key = `${key}/`;
+  }
+
+  if (x[".tag"] === "folder") {
+    return {
+      key: key,
+      lastModified: undefined,
+      size: 0,
+      remoteType: "dropbox",
+      etag: `${x.id}\t`,
+    } as RemoteItem;
+  } else if (x[".tag"] === "file") {
+    return {
+      key: key,
+      lastModified: Date.parse(x.server_modified).valueOf(),
+      size: x.size,
+      remoteType: "dropbox",
+      etag: `${x.id}\t${x.content_hash}`,
+    } as RemoteItem;
+  } else if (x[".tag"] === "deleted") {
+    throw Error("do not support deleted tag");
+  }
+};
+
+/**
+ * Dropbox api doesn't return mtime for folders.
+ * This is a try to assign mtime by using files in folder.
+ * @param allFilesFolders
+ * @returns
+ */
+const fixLastModifiedTimeInplace = (allFilesFolders: RemoteItem[]) => {
+  if (allFilesFolders.length === 0) {
+    return;
+  }
+
+  // sort by longer to shorter
+  allFilesFolders.sort((a, b) => b.key.length - a.key.length);
+
+  // a "map" from dir to mtime
+  let potentialMTime = {} as Record<string, number>;
+
+  // first sort pass, from buttom to up
+  for (const item of allFilesFolders) {
+    if (item.key.endsWith("/")) {
+      // itself is a folder, and initially doesn't have mtime
+      if (item.lastModified === undefined && item.key in potentialMTime) {
+        // previously we gathered all sub info of this folder
+        item.lastModified = potentialMTime[item.key];
+      }
+    }
+    const parent = `${path.posix.dirname(item.key)}/`;
+    if (item.lastModified !== undefined) {
+      if (parent in potentialMTime) {
+        potentialMTime[parent] = Math.max(
+          potentialMTime[parent],
+          item.lastModified
+        );
+      } else {
+        potentialMTime[parent] = item.lastModified;
+      }
+    }
+  }
+
+  // second pass, from up to buttom.
+  // fill mtime by parent folder or Date.Now() if still not available.
+  // this is only possible if no any sub-folder-files recursively.
+  // we do not sort the array again, just iterate over it by reverse
+  // using good old for loop.
+  for (let i = allFilesFolders.length - 1; i >= 0; --i) {
+    const item = allFilesFolders[i];
+    if (!item.key.endsWith("/")) {
+      continue; // skip files
+    }
+    if (item.lastModified !== undefined) {
+      continue; // don't need to deal with it
+    }
+    const parent = `${path.posix.dirname(item.key)}/`;
+    if (parent in potentialMTime) {
+      item.lastModified = potentialMTime[parent];
+    } else {
+      item.lastModified = Date.now().valueOf();
+      potentialMTime[item.key] = item.lastModified;
+    }
+  }
+
+  return allFilesFolders;
+};
+
+////////////////////////////////////////////////////////////////////////////////
+// Dropbox authorization using PKCE
+// see https://dropbox.tech/developers/pkce--what-and-why-
+////////////////////////////////////////////////////////////////////////////////
+
+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(
+      callback,
+      undefined,
+      "code",
+      "offline",
+      undefined,
+      "none",
+      true
+    )
+  ).toString();
+  const verifier = auth.getCodeVerifier();
+  return {
+    authUrl: authUrl,
+    verifier: verifier,
+  };
+};
+
+export interface DropboxSuccessAuthRes {
+  access_token: string;
+  token_type: "bearer";
+  expires_in: string;
+  refresh_token?: string;
+  scope?: string;
+  uid?: string;
+  account_id?: string;
+}
+
+export const sendAuthReq = async (
+  appKey: string,
+  verifier: string,
+  authCode: string
+) => {
+  const resp1 = await fetch("https://api.dropboxapi.com/oauth2/token", {
+    method: "POST",
+    body: new URLSearchParams({
+      code: authCode,
+      grant_type: "authorization_code",
+      code_verifier: verifier,
+      client_id: appKey,
+      redirect_uri: `obsidian://${COMMAND_CALLBACK_DROPBOX}`,
+    }),
+  });
+  const resp2 = (await resp1.json()) as DropboxSuccessAuthRes;
+  return resp2;
+};
+
+export const sendRefreshTokenReq = async (
+  appKey: string,
+  refreshToken: string
+) => {
+  log.info("start auto getting refreshed Dropbox access token.");
+  const resp1 = await fetch("https://api.dropboxapi.com/oauth2/token", {
+    method: "POST",
+    body: new URLSearchParams({
+      grant_type: "refresh_token",
+      refresh_token: refreshToken,
+      client_id: appKey,
+    }),
+  });
+  const resp2 = (await resp1.json()) as DropboxSuccessAuthRes;
+  log.info("finish auto getting refreshed Dropbox access token.");
+  return resp2;
+};
+
+export const setConfigBySuccessfullAuthInplace = async (
+  config: DropboxConfig,
+  authRes: DropboxSuccessAuthRes,
+  saveUpdatedConfigFunc: () => Promise<any> | undefined
+) => {
+  log.info("start updating local info of Dropbox token");
+
+  config.accessToken = authRes.access_token;
+  config.accessTokenExpiresInSeconds = parseInt(authRes.expires_in);
+  config.accessTokenExpiresAtTime =
+    Date.now() + parseInt(authRes.expires_in) * 1000 - 10 * 1000;
+
+  // manually set it expired after 80 days;
+  config.credentialsShouldBeDeletedAtTime =
+    Date.now() + OAUTH2_FORCE_EXPIRE_MILLISECONDS;
+
+  if (authRes.refresh_token !== undefined) {
+    config.refreshToken = authRes.refresh_token;
+  }
+  if (authRes.refresh_token !== undefined) {
+    config.accountID = authRes.account_id;
+  }
+
+  if (saveUpdatedConfigFunc !== undefined) {
+    await saveUpdatedConfigFunc();
+  }
+
+  log.info("finish updating local info of Dropbox token");
+};
+
+////////////////////////////////////////////////////////////////////////////////
+// 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 delay.range(secMin * 1000, secMax * 1000);
+    }
+  }
+}
+
+export class WrappedDropboxClient {
+  dropboxConfig: DropboxConfig;
+  remoteBaseDir: string;
+  saveUpdatedConfigFunc: () => Promise<any>;
+  dropbox: Dropbox;
+  vaultFolderExists: boolean;
+  constructor(
+    dropboxConfig: DropboxConfig,
+    remoteBaseDir: string,
+    saveUpdatedConfigFunc: () => Promise<any>
+  ) {
+    this.dropboxConfig = dropboxConfig;
+    this.remoteBaseDir = remoteBaseDir;
+    this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
+    this.vaultFolderExists = false;
+  }
+
+  init = async () => {
+    // check token
+    if (
+      this.dropboxConfig.accessToken === "" ||
+      this.dropboxConfig.refreshToken === ""
+    ) {
+      throw Error("The user has not manually auth yet.");
+    }
+    const currentTs = Date.now();
+    if (this.dropboxConfig.accessTokenExpiresAtTime > currentTs) {
+      this.dropbox = new Dropbox({
+        accessToken: this.dropboxConfig.accessToken,
+      });
+    } else {
+      if (this.dropboxConfig.refreshToken === "") {
+        throw Error(
+          "We need to automatically refresh token but none is stored."
+        );
+      }
+      const resp = await sendRefreshTokenReq(
+        this.dropboxConfig.clientID,
+        this.dropboxConfig.refreshToken
+      );
+
+      setConfigBySuccessfullAuthInplace(
+        this.dropboxConfig,
+        resp,
+        this.saveUpdatedConfigFunc
+      );
+      this.dropbox = new Dropbox({
+        accessToken: this.dropboxConfig.accessToken,
+      });
+    }
+
+    // check vault folder
+    // log.info(`checking remote has folder /${this.remoteBaseDir}`);
+    if (this.vaultFolderExists) {
+      // 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.remoteBaseDir}`) {
+          this.vaultFolderExists = true;
+          break;
+        }
+      }
+      if (!this.vaultFolderExists) {
+        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.remoteBaseDir}`,
+        });
+        log.info(`remote folder /${this.remoteBaseDir} created`);
+        this.vaultFolderExists = true;
+      } else {
+        // log.info(`remote folder /${this.remoteBaseDir} exists`);
+      }
+    }
+
+    return this.dropbox;
+  };
+}
+
+/**
+ * @param dropboxConfig
+ * @returns
+ */
+export const getDropboxClient = (
+  dropboxConfig: DropboxConfig,
+  remoteBaseDir: string,
+  saveUpdatedConfigFunc: () => Promise<any>
+) => {
+  return new WrappedDropboxClient(
+    dropboxConfig,
+    remoteBaseDir,
+    saveUpdatedConfigFunc
+  );
+};
+
+export const getRemoteMeta = async (
+  client: WrappedDropboxClient,
+  fileOrFolderPath: string
+) => {
+  await client.init();
+  if (fileOrFolderPath === "" || fileOrFolderPath === "/") {
+    // filesGetMetadata doesn't support root folder
+    // we instead try to list files
+    // if no error occurs, we ensemble a fake result.
+    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));
+    }
+    return {
+      key: fileOrFolderPath,
+      lastModified: undefined,
+      size: 0,
+      remoteType: "dropbox",
+      etag: undefined,
+    } as RemoteItem;
+  }
+
+  const key = getDropboxPath(fileOrFolderPath, client.remoteBaseDir);
+
+  const rsp = await retryReq(() =>
+    client.dropbox.filesGetMetadata({
+      path: key,
+    })
+  );
+  if (rsp.status !== 200) {
+    throw Error(JSON.stringify(rsp));
+  }
+  return fromDropboxItemToRemoteItem(rsp.result, client.remoteBaseDir);
+};
+
+export const uploadToRemote = async (
+  client: WrappedDropboxClient,
+  fileOrFolderPath: string,
+  vault: Vault,
+  isRecursively: boolean = false,
+  password: string = "",
+  remoteEncryptedKey: string = "",
+  foldersCreatedBefore: Set<string> | undefined = undefined,
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
+) => {
+  await client.init();
+
+  let uploadFile = fileOrFolderPath;
+  if (password !== "") {
+    uploadFile = remoteEncryptedKey;
+  }
+  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
+      if (foldersCreatedBefore?.has(uploadFile)) {
+        // created, pass
+      } else {
+        try {
+          await retryReq(
+            () =>
+              client.dropbox.filesCreateFolderV2({
+                path: uploadFile,
+              }),
+            fileOrFolderPath
+          );
+          foldersCreatedBefore?.add(uploadFile);
+        } catch (e: unknown) {
+          const err = e as DropboxResponseError<files.CreateFolderError>;
+          if (err.status === undefined) {
+            throw err;
+          }
+          if (err.status === 409) {
+            // pass
+            foldersCreatedBefore?.add(uploadFile);
+          } else {
+            throw err;
+          }
+        }
+      }
+      const res = await getRemoteMeta(client, uploadFile);
+      return res;
+    } else {
+      // if encrypted, upload a fake file with the encrypted file name
+      await retryReq(
+        () =>
+          client.dropbox.filesUpload({
+            path: uploadFile,
+            contents: "",
+          }),
+        fileOrFolderPath
+      );
+      return await getRemoteMeta(client, uploadFile);
+    }
+  } else {
+    // file
+    // we ignore isRecursively parameter here
+    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 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.remoteBaseDir)
+      );
+      for (const dir of dirs) {
+        foldersCreatedBefore?.add(dir);
+      }
+    }
+    return await getRemoteMeta(client, uploadFile);
+  }
+};
+
+export const listFromRemote = async (
+  client: WrappedDropboxClient,
+  prefix?: string
+) => {
+  if (prefix !== undefined) {
+    throw Error("prefix not supported (yet)");
+  }
+  await client.init();
+  let res = await client.dropbox.filesListFolder({
+    path: `/${client.remoteBaseDir}`,
+    recursive: true,
+    include_deleted: false,
+    limit: 1000,
+  });
+  if (res.status !== 200) {
+    throw Error(JSON.stringify(res));
+  }
+  // log.info(res);
+
+  const contents = res.result.entries;
+  const unifiedContents = contents
+    .filter((x) => x[".tag"] !== "deleted")
+    .filter((x) => x.path_display !== `/${client.remoteBaseDir}`)
+    .map((x) => fromDropboxItemToRemoteItem(x, client.remoteBaseDir));
+
+  while (res.result.has_more) {
+    res = await client.dropbox.filesListFolderContinue({
+      cursor: res.result.cursor,
+    });
+    if (res.status !== 200) {
+      throw Error(JSON.stringify(res));
+    }
+
+    const contents2 = res.result.entries;
+    const unifiedContents2 = contents2
+      .filter((x) => x[".tag"] !== "deleted")
+      .filter((x) => x.path_display !== `/${client.remoteBaseDir}`)
+      .map((x) => fromDropboxItemToRemoteItem(x, client.remoteBaseDir));
+    unifiedContents.push(...unifiedContents2);
+  }
+
+  fixLastModifiedTimeInplace(unifiedContents);
+
+  return {
+    Contents: unifiedContents,
+  };
+};
+
+const downloadFromRemoteRaw = async (
+  client: WrappedDropboxClient,
+  fileOrFolderPath: string
+) => {
+  await client.init();
+  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;
+    return await content.arrayBuffer();
+  } else if ((rsp.result as any).fileBinary !== undefined) {
+    // we get a Buffer
+    const content = (rsp.result as any).fileBinary as Buffer;
+    return bufferToArrayBuffer(content);
+  } else {
+    throw Error(`unknown rsp from dropbox download: ${rsp}`);
+  }
+};
+
+export const downloadFromRemote = async (
+  client: WrappedDropboxClient,
+  fileOrFolderPath: string,
+  vault: Vault,
+  mtime: number,
+  password: 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
+
+  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.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 (
+  client: WrappedDropboxClient,
+  fileOrFolderPath: string,
+  password: string = "",
+  remoteEncryptedKey: string = ""
+) => {
+  if (fileOrFolderPath === "/") {
+    return;
+  }
+  let remoteFileName = fileOrFolderPath;
+  if (password !== "") {
+    remoteFileName = remoteEncryptedKey;
+  }
+  remoteFileName = getDropboxPath(remoteFileName, client.remoteBaseDir);
+
+  await client.init();
+  try {
+    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,
+  callbackFunc?: any
+) => {
+  try {
+    const results = await getRemoteMeta(client, "/");
+    if (results === undefined) {
+      return false;
+    }
+    return true;
+  } catch (err) {
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
+    return false;
+  }
+};
+
+export const getUserDisplayName = async (client: WrappedDropboxClient) => {
+  await client.init();
+  const acct = await client.dropbox.usersGetCurrentAccount();
+  return acct.result.name.display_name;
+};
+
+export const revokeAuth = async (client: WrappedDropboxClient) => {
+  await client.init();
+  await client.dropbox.authTokenRevoke();
+};

src/remoteForOnedrive.ts

@@ -0,0 +1,916 @@
+import { CryptoProvider, PublicClientApplication } from "@azure/msal-node";
+import { AuthenticationProvider } from "@microsoft/microsoft-graph-client";
+import type {
+  DriveItem,
+  UploadSession,
+  User,
+} from "@microsoft/microsoft-graph-types";
+import cloneDeep from "lodash/cloneDeep";
+import { request, requestUrl, requireApiVersion, Vault } from "obsidian";
+import {
+  VALID_REQURL,
+  COMMAND_CALLBACK_ONEDRIVE,
+  DEFAULT_CONTENT_TYPE,
+  OAUTH2_FORCE_EXPIRE_MILLISECONDS,
+  OnedriveConfig,
+  RemoteItem,
+} from "./baseTypes";
+import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
+import {
+  bufferToArrayBuffer,
+  getRandomArrayBuffer,
+  getRandomIntInclusive,
+  mkdirpInVault,
+} from "./misc";
+
+import { log } from "./moreOnLog";
+
+const SCOPES = ["User.Read", "Files.ReadWrite.AppFolder", "offline_access"];
+const REDIRECT_URI = `obsidian://${COMMAND_CALLBACK_ONEDRIVE}`;
+
+export const DEFAULT_ONEDRIVE_CONFIG: OnedriveConfig = {
+  accessToken: "",
+  clientID: process.env.DEFAULT_ONEDRIVE_CLIENT_ID,
+  authority: process.env.DEFAULT_ONEDRIVE_AUTHORITY,
+  refreshToken: "",
+  accessTokenExpiresInSeconds: 0,
+  accessTokenExpiresAtTime: 0,
+  deltaLink: "",
+  username: "",
+  credentialsShouldBeDeletedAtTime: 0,
+};
+
+////////////////////////////////////////////////////////////////////////////////
+// Onedrive authorization using PKCE
+////////////////////////////////////////////////////////////////////////////////
+
+export async function getAuthUrlAndVerifier(
+  clientID: string,
+  authority: string
+) {
+  const cryptoProvider = new CryptoProvider();
+  const { verifier, challenge } = await cryptoProvider.generatePkceCodes();
+
+  const pkceCodes = {
+    challengeMethod: "S256", // Use SHA256 Algorithm
+    verifier: verifier,
+    challenge: challenge,
+  };
+
+  const authCodeUrlParams = {
+    redirectUri: REDIRECT_URI,
+    scopes: SCOPES,
+    codeChallenge: pkceCodes.challenge, // PKCE Code Challenge
+    codeChallengeMethod: pkceCodes.challengeMethod, // PKCE Code Challenge Method
+  };
+
+  const pca = new PublicClientApplication({
+    auth: {
+      clientId: clientID,
+      authority: authority,
+    },
+  });
+  const authCodeUrl = await pca.getAuthCodeUrl(authCodeUrlParams);
+
+  return {
+    authUrl: authCodeUrl,
+    verifier: verifier,
+  };
+}
+
+/**
+ * Check doc from
+ * https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
+ * https://docs.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth?view=odsp-graph-online#code-flow
+ */
+export interface AccessCodeResponseSuccessfulType {
+  token_type: "Bearer" | "bearer";
+  expires_in: number;
+  ext_expires_in?: number;
+  scope: string;
+  access_token: string;
+  refresh_token?: string;
+  id_token?: string;
+}
+export interface AccessCodeResponseFailedType {
+  error: string;
+  error_description: string;
+  error_codes: number[];
+  timestamp: string;
+  trace_id: string;
+  correlation_id: string;
+}
+
+export const sendAuthReq = async (
+  clientID: string,
+  authority: string,
+  authCode: string,
+  verifier: string
+) => {
+  // // original code snippets for references
+  // const authResponse = await pca.acquireTokenByCode({
+  //   redirectUri: REDIRECT_URI,
+  //   scopes: SCOPES,
+  //   code: authCode,
+  //   codeVerifier: verifier, // PKCE Code Verifier
+  // });
+  // log.info('authResponse')
+  // log.info(authResponse)
+  // return authResponse;
+
+  // Because of the CORS problem,
+  // we need to construct raw request using Obsidian request,
+  // instead of using msal
+  // https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
+  // https://docs.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth?view=odsp-graph-online#code-flow
+  const rsp1 = await request({
+    url: `${authority}/oauth2/v2.0/token`,
+    method: "POST",
+    contentType: "application/x-www-form-urlencoded",
+    body: new URLSearchParams({
+      tenant: "consumers",
+      client_id: clientID,
+      scope: SCOPES.join(" "),
+      code: authCode,
+      redirect_uri: REDIRECT_URI,
+      grant_type: "authorization_code",
+      code_verifier: verifier,
+    }).toString(),
+  });
+
+  const rsp2 = JSON.parse(rsp1);
+  // log.info(rsp2);
+
+  if (rsp2.error !== undefined) {
+    return rsp2 as AccessCodeResponseFailedType;
+  } else {
+    return rsp2 as AccessCodeResponseSuccessfulType;
+  }
+};
+
+export const sendRefreshTokenReq = async (
+  clientID: string,
+  authority: string,
+  refreshToken: string
+) => {
+  // also use Obsidian request to bypass CORS issue.
+  const rsp1 = await request({
+    url: `${authority}/oauth2/v2.0/token`,
+    method: "POST",
+    contentType: "application/x-www-form-urlencoded",
+    body: new URLSearchParams({
+      tenant: "consumers",
+      client_id: clientID,
+      scope: SCOPES.join(" "),
+      refresh_token: refreshToken,
+      grant_type: "refresh_token",
+    }).toString(),
+  });
+
+  const rsp2 = JSON.parse(rsp1);
+  // log.info(rsp2);
+
+  if (rsp2.error !== undefined) {
+    return rsp2 as AccessCodeResponseFailedType;
+  } else {
+    return rsp2 as AccessCodeResponseSuccessfulType;
+  }
+};
+
+export const setConfigBySuccessfullAuthInplace = async (
+  config: OnedriveConfig,
+  authRes: AccessCodeResponseSuccessfulType,
+  saveUpdatedConfigFunc: () => Promise<any> | undefined
+) => {
+  log.info("start updating local info of OneDrive token");
+  config.accessToken = authRes.access_token;
+  config.accessTokenExpiresAtTime =
+    Date.now() + authRes.expires_in - 5 * 60 * 1000;
+  config.accessTokenExpiresInSeconds = authRes.expires_in;
+  config.refreshToken = authRes.refresh_token;
+
+  // manually set it expired after 80 days;
+  config.credentialsShouldBeDeletedAtTime =
+    Date.now() + OAUTH2_FORCE_EXPIRE_MILLISECONDS;
+
+  if (saveUpdatedConfigFunc !== undefined) {
+    await saveUpdatedConfigFunc();
+  }
+
+  log.info("finish updating local info of Onedrive token");
+};
+
+////////////////////////////////////////////////////////////////////////////////
+// Other usual common methods
+////////////////////////////////////////////////////////////////////////////////
+
+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:/${remoteBaseDir}`;
+  if (fileOrFolderPath.startsWith(prefix)) {
+    // already transformed, return as is
+    return fileOrFolderPath;
+  }
+
+  let key = fileOrFolderPath;
+  if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
+    // special
+    return prefix;
+  }
+  if (key.endsWith("/")) {
+    key = key.slice(0, key.length - 1);
+  }
+
+  key = `${prefix}/${key}`;
+  return key;
+};
+
+const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
+  const prefix = `/drive/special/approot:/${remoteBaseDir}`;
+
+  if (
+    !(fileOrFolderPath === prefix || fileOrFolderPath.startsWith(`${prefix}/`))
+  ) {
+    throw Error(
+      `"${fileOrFolderPath}" doesn't starts with "${prefix}/" or equals to "${prefix}"`
+    );
+  }
+
+  if (fileOrFolderPath === prefix) {
+    return "/";
+  }
+  return fileOrFolderPath.slice(`${prefix}/`.length);
+};
+
+const constructFromDriveItemToRemoteItemError = (x: DriveItem) => {
+  return `parentPath="${x.parentReference.path}", selfName="${x.name}"`;
+};
+
+const fromDriveItemToRemoteItem = (
+  x: DriveItem,
+  remoteBaseDir: string
+): RemoteItem => {
+  let key = "";
+
+  // possible prefix:
+  // 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/${remoteBaseDir}
+  const SECOND_COMMON_PREFIX_REGEX = /^\/Livefolders\/[^\/]+\/remotely-save\//g;
+
+  // another possibile prefix
+  const THIRD_COMMON_PREFIX_RAW = `/drive/items/`;
+
+  const fullPathOriginal = `${x.parentReference.path}/${x.name}`;
+  const matchFirstPrefixRes = fullPathOriginal.match(FIRST_COMMON_PREFIX_REGEX);
+  const matchSecondPrefixRes = fullPathOriginal.match(
+    SECOND_COMMON_PREFIX_REGEX
+  );
+  if (
+    matchFirstPrefixRes !== null &&
+    fullPathOriginal.startsWith(`${matchFirstPrefixRes[0]}${remoteBaseDir}`)
+  ) {
+    const foundPrefix = `${matchFirstPrefixRes[0]}${remoteBaseDir}`;
+    key = fullPathOriginal.substring(foundPrefix.length + 1);
+  } else if (
+    matchSecondPrefixRes !== null &&
+    fullPathOriginal.startsWith(`${matchSecondPrefixRes[0]}${remoteBaseDir}`)
+  ) {
+    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>:/${remoteBaseDir}/<subfolder>
+    // with uri encoded!
+    const parPath = decodeURIComponent(x.parentReference.path);
+    key = parPath.substring(parPath.indexOf(":") + 1);
+    if (key.startsWith(`/${remoteBaseDir}/`)) {
+      key = key.substring(`/${remoteBaseDir}/`.length);
+      key = `${key}/${x.name}`;
+    } else if (key === `/${remoteBaseDir}`) {
+      key = x.name;
+    } else {
+      throw Error(
+        `we meet file/folder and do not know how to deal with it:\n${constructFromDriveItemToRemoteItemError(
+          x
+        )}`
+      );
+    }
+  } else {
+    throw Error(
+      `we meet file/folder and do not know how to deal with it:\n${constructFromDriveItemToRemoteItemError(
+        x
+      )}`
+    );
+  }
+
+  const isFolder = "folder" in x;
+  if (isFolder) {
+    key = `${key}/`;
+  }
+  return {
+    key: key,
+    lastModified: Date.parse(x.fileSystemInfo.lastModifiedDateTime),
+    size: isFolder ? 0 : x.size,
+    remoteType: "onedrive",
+    etag: x.cTag || "", // do NOT use x.eTag because it changes if meta changes
+  };
+};
+
+// to adapt to the required interface
+class MyAuthProvider implements AuthenticationProvider {
+  onedriveConfig: OnedriveConfig;
+  saveUpdatedConfigFunc: () => Promise<any>;
+  constructor(
+    onedriveConfig: OnedriveConfig,
+    saveUpdatedConfigFunc: () => Promise<any>
+  ) {
+    this.onedriveConfig = onedriveConfig;
+    this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
+  }
+  getAccessToken = async () => {
+    if (
+      this.onedriveConfig.accessToken === "" ||
+      this.onedriveConfig.refreshToken === ""
+    ) {
+      throw Error("The user has not manually auth yet.");
+    }
+
+    const currentTs = Date.now();
+    if (this.onedriveConfig.accessTokenExpiresAtTime > currentTs) {
+      return this.onedriveConfig.accessToken;
+    } else {
+      // use refreshToken to refresh
+      const r = await sendRefreshTokenReq(
+        this.onedriveConfig.clientID,
+        this.onedriveConfig.authority,
+        this.onedriveConfig.refreshToken
+      );
+      if ((r as any).error !== undefined) {
+        const r2 = r as AccessCodeResponseFailedType;
+        throw Error(
+          `Error while refreshing accessToken: ${r2.error}, ${r2.error_codes}: ${r2.error_description}`
+        );
+      }
+      const r2 = r as AccessCodeResponseSuccessfulType;
+      this.onedriveConfig.accessToken = r2.access_token;
+      this.onedriveConfig.refreshToken = r2.refresh_token;
+      this.onedriveConfig.accessTokenExpiresInSeconds = r2.expires_in;
+      this.onedriveConfig.accessTokenExpiresAtTime =
+        currentTs + r2.expires_in * 1000 - 60 * 2 * 1000;
+      await this.saveUpdatedConfigFunc();
+      log.info("Onedrive accessToken updated");
+      return this.onedriveConfig.accessToken;
+    }
+  };
+}
+
+export class WrappedOnedriveClient {
+  onedriveConfig: OnedriveConfig;
+  remoteBaseDir: string;
+  vaultFolderExists: boolean;
+  authGetter: MyAuthProvider;
+  saveUpdatedConfigFunc: () => Promise<any>;
+  constructor(
+    onedriveConfig: OnedriveConfig,
+    remoteBaseDir: string,
+    saveUpdatedConfigFunc: () => Promise<any>
+  ) {
+    this.onedriveConfig = onedriveConfig;
+    this.remoteBaseDir = remoteBaseDir;
+    this.vaultFolderExists = false;
+    this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
+    this.authGetter = new MyAuthProvider(onedriveConfig, saveUpdatedConfigFunc);
+  }
+
+  init = async () => {
+    // check token
+    if (
+      this.onedriveConfig.accessToken === "" ||
+      this.onedriveConfig.refreshToken === ""
+    ) {
+      throw Error("The user has not manually auth yet.");
+    }
+
+    // check vault folder
+    // log.info(`checking remote has folder /${this.remoteBaseDir}`);
+    if (this.vaultFolderExists) {
+      // log.info(`already checked, /${this.remoteBaseDir} exist before`)
+    } else {
+      const k = await this.getJson("/drive/special/approot/children");
+      // log.debug(k);
+      this.vaultFolderExists =
+        (k.value as DriveItem[]).filter((x) => x.name === this.remoteBaseDir)
+          .length > 0;
+      if (!this.vaultFolderExists) {
+        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.remoteBaseDir} created`);
+        this.vaultFolderExists = true;
+      } else {
+        // 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()}`,
+        },
+      })
+    );
+  };
+
+  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}`,
+        },
+      });
+      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,
+        },
+      });
+      return (await res.json()) as DriveItem | UploadSession;
+    }
+  };
+}
+
+export const getOnedriveClient = (
+  onedriveConfig: OnedriveConfig,
+  remoteBaseDir: string,
+  saveUpdatedConfigFunc: () => Promise<any>
+) => {
+  return new WrappedOnedriveClient(
+    onedriveConfig,
+    remoteBaseDir,
+    saveUpdatedConfigFunc
+  );
+};
+
+/**
+ * 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)");
+  }
+  await client.init();
+
+  const NEXT_LINK_KEY = "@odata.nextLink";
+  const DELTA_LINK_KEY = "@odata.deltaLink";
+
+  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.getJson(res[NEXT_LINK_KEY]);
+    driveItems.push(...cloneDeep(res.value as DriveItem[]));
+  }
+
+  // lastly we should have delta link?
+  if (DELTA_LINK_KEY in res) {
+    client.onedriveConfig.deltaLink = res[DELTA_LINK_KEY];
+    await client.saveUpdatedConfigFunc();
+  }
+
+  // unify everything to RemoteItem
+  const unifiedContents = driveItems
+    .map((x) => fromDriveItemToRemoteItem(x, client.remoteBaseDir))
+    .filter((x) => x.key !== "/");
+
+  return {
+    Contents: unifiedContents,
+  };
+};
+
+export const getRemoteMeta = async (
+  client: WrappedOnedriveClient,
+  fileOrFolderPath: string
+) => {
+  await client.init();
+  const remotePath = getOnedrivePath(fileOrFolderPath, client.remoteBaseDir);
+  // log.info(`remotePath=${remotePath}`);
+  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.remoteBaseDir);
+  // log.info(res);
+  return res;
+};
+
+export const uploadToRemote = async (
+  client: WrappedOnedriveClient,
+  fileOrFolderPath: string,
+  vault: Vault,
+  isRecursively: boolean = false,
+  password: string = "",
+  remoteEncryptedKey: string = "",
+  foldersCreatedBefore: Set<string> | undefined = undefined,
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
+) => {
+  await client.init();
+
+  let uploadFile = fileOrFolderPath;
+  if (password !== "") {
+    uploadFile = remoteEncryptedKey;
+  }
+  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
+      if (foldersCreatedBefore?.has(uploadFile)) {
+        // created, pass
+      } else {
+        // https://stackoverflow.com/questions/56479865/creating-nested-folders-in-one-go-onedrive-api
+        // use PATCH to create folder recursively!!!
+        await client.patchJson(uploadFile, {
+          folder: {},
+          "@microsoft.graph.conflictBehavior": "replace",
+        });
+      }
+      const res = await getRemoteMeta(client, uploadFile);
+      return res;
+    } else {
+      // if encrypted,
+      // upload a fake, random-size file
+      // with the encrypted file name
+      const byteLengthRandom = getRandomIntInclusive(
+        1,
+        65536 /* max allowed */
+      );
+      const arrBufRandom = await encryptArrayBuffer(
+        getRandomArrayBuffer(byteLengthRandom),
+        password
+      );
+
+      // an encrypted folder is always small, we just use put here
+      await client.putArrayBuffer(
+        `${uploadFile}:/content?${new URLSearchParams({
+          "@microsoft.graph.conflictBehavior": "replace",
+        })}`,
+        arrBufRandom
+      );
+      // log.info(uploadResult)
+      const res = await getRemoteMeta(client, uploadFile);
+      return res;
+    }
+  } else {
+    // file
+    // we ignore isRecursively parameter here
+    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);
+    }
+
+    // no need to create parent folders firstly, cool!
+
+    // 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",
+          },
+        }
+      );
+      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
+        );
+        rangeStart += RANGE_SIZE;
+      }
+    }
+
+    const res = await getRemoteMeta(client, uploadFile);
+    return res;
+  }
+};
+
+const downloadFromRemoteRaw = async (
+  client: WrappedOnedriveClient,
+  fileOrFolderPath: string
+): Promise<ArrayBuffer> => {
+  await client.init();
+  const key = getOnedrivePath(fileOrFolderPath, client.remoteBaseDir);
+  const rsp = await client.getJson(
+    `${key}?$select=@microsoft.graph.downloadUrl`
+  );
+  const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
+  if (VALID_REQURL) {
+    const content = (await requestUrl({ url: downloadUrl })).arrayBuffer;
+    return content;
+  } else {
+    const content = await (await fetch(downloadUrl)).arrayBuffer();
+    return content;
+  }
+};
+
+export const downloadFromRemote = async (
+  client: WrappedOnedriveClient,
+  fileOrFolderPath: string,
+  vault: Vault,
+  mtime: number,
+  password: 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.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 (
+  client: WrappedOnedriveClient,
+  fileOrFolderPath: string,
+  password: string = "",
+  remoteEncryptedKey: string = ""
+) => {
+  if (fileOrFolderPath === "/") {
+    return;
+  }
+  let remoteFileName = fileOrFolderPath;
+  if (password !== "") {
+    remoteFileName = remoteEncryptedKey;
+  }
+  remoteFileName = getOnedrivePath(remoteFileName, client.remoteBaseDir);
+
+  await client.init();
+  await client.deleteJson(remoteFileName);
+};
+
+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.getJson("/me?$select=displayName");
+  return res.displayName || "<unknown display name>";
+};
+
+/**
+ *
+ * https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-protocols-oidc#send-a-sign-out-request
+ * https://docs.microsoft.com/en-us/graph/api/user-revokesigninsessions
+ * https://docs.microsoft.com/en-us/graph/api/user-invalidateallrefreshtokens
+ * @param client
+ */
+// export const revokeAuth = async (client: WrappedOnedriveClient) => {
+//   await client.init();
+//   await client.postJson('/me/revokeSignInSessions', {});
+// };
+
+export const getRevokeAddr = async () => {
+  return "https://account.live.com/consent/Manage";
+};

src/remoteForS3.ts

@@ -0,0 +1,537 @@
+import type { _Object } from "@aws-sdk/client-s3";
+import {
+  DeleteObjectCommand,
+  GetObjectCommand,
+  HeadBucketCommand,
+  HeadObjectCommand,
+  HeadObjectCommandOutput,
+  ListObjectsV2Command,
+  ListObjectsV2CommandInput,
+  PutObjectCommand,
+  S3Client,
+} from "@aws-sdk/client-s3";
+import { Upload } from "@aws-sdk/lib-storage";
+import { HttpHandler, HttpRequest, HttpResponse } from "@aws-sdk/protocol-http";
+import {
+  FetchHttpHandler,
+  FetchHttpHandlerOptions,
+} from "@aws-sdk/fetch-http-handler";
+// @ts-ignore
+import { requestTimeout } from "@aws-sdk/fetch-http-handler/dist-es/request-timeout";
+import { buildQueryString } from "@aws-sdk/querystring-builder";
+import { HeaderBag, HttpHandlerOptions, Provider } from "@aws-sdk/types";
+import { Buffer } from "buffer";
+import * as mime from "mime-types";
+import { Vault, requestUrl, RequestUrlParam } from "obsidian";
+import { Readable } from "stream";
+import {
+  DEFAULT_CONTENT_TYPE,
+  RemoteItem,
+  S3Config,
+  VALID_REQURL,
+} from "./baseTypes";
+import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
+import {
+  arrayBufferToBuffer,
+  bufferToArrayBuffer,
+  mkdirpInVault,
+} from "./misc";
+
+export { S3Client } from "@aws-sdk/client-s3";
+
+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"];
+    }
+
+    if (transformedHeaders["cache-control"] === undefined) {
+      // every time is a new request
+      transformedHeaders["cache-control"] = "no-cache";
+    }
+
+    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: "",
+  s3Region: "",
+  s3AccessKeyID: "",
+  s3SecretAccessKey: "",
+  s3BucketName: "",
+  bypassCorsLocally: true,
+  partsConcurrency: 20,
+  forcePathStyle: false,
+};
+
+export type S3ObjectType = _Object;
+
+const fromS3ObjectToRemoteItem = (x: S3ObjectType) => {
+  return {
+    key: x.Key,
+    lastModified: x.LastModified.valueOf(),
+    size: x.Size,
+    remoteType: "s3",
+    etag: x.ETag,
+  } as RemoteItem;
+};
+
+const fromS3HeadObjectToRemoteItem = (
+  key: string,
+  x: HeadObjectCommandOutput
+) => {
+  return {
+    key: key,
+    lastModified: x.LastModified.valueOf(),
+    size: x.ContentLength,
+    remoteType: "s3",
+    etag: x.ETag,
+  } as RemoteItem;
+};
+
+export const getS3Client = (s3Config: S3Config) => {
+  let endpoint = s3Config.s3Endpoint;
+  if (!(endpoint.startsWith("http://") || endpoint.startsWith("https://"))) {
+    endpoint = `https://${endpoint}`;
+  }
+
+  if (VALID_REQURL && s3Config.bypassCorsLocally) {
+    const s3Client = new S3Client({
+      region: s3Config.s3Region,
+      endpoint: endpoint,
+      forcePathStyle: s3Config.forcePathStyle,
+      credentials: {
+        accessKeyId: s3Config.s3AccessKeyID,
+        secretAccessKey: s3Config.s3SecretAccessKey,
+      },
+      requestHandler: new ObsHttpHandler(),
+    });
+    return s3Client;
+  } else {
+    const s3Client = new S3Client({
+      region: s3Config.s3Region,
+      endpoint: endpoint,
+      forcePathStyle: s3Config.forcePathStyle,
+      credentials: {
+        accessKeyId: s3Config.s3AccessKeyID,
+        secretAccessKey: s3Config.s3SecretAccessKey,
+      },
+    });
+    return s3Client;
+  }
+};
+
+export const getRemoteMeta = async (
+  s3Client: S3Client,
+  s3Config: S3Config,
+  fileOrFolderPath: string
+) => {
+  const res = await s3Client.send(
+    new HeadObjectCommand({
+      Bucket: s3Config.s3BucketName,
+      Key: fileOrFolderPath,
+    })
+  );
+
+  return fromS3HeadObjectToRemoteItem(fileOrFolderPath, res);
+};
+
+export const uploadToRemote = async (
+  s3Client: S3Client,
+  s3Config: S3Config,
+  fileOrFolderPath: string,
+  vault: Vault,
+  isRecursively: boolean = false,
+  password: string = "",
+  remoteEncryptedKey: string = "",
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
+) => {
+  let uploadFile = fileOrFolderPath;
+  if (password !== "") {
+    uploadFile = remoteEncryptedKey;
+  }
+  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
+    const contentType = DEFAULT_CONTENT_TYPE;
+    await s3Client.send(
+      new PutObjectCommand({
+        Bucket: s3Config.s3BucketName,
+        Key: uploadFile,
+        Body: "",
+        ContentType: contentType,
+      })
+    );
+    return await getRemoteMeta(s3Client, s3Config, uploadFile);
+  } else {
+    // file
+    // we ignore isRecursively parameter here
+    let contentType = DEFAULT_CONTENT_TYPE;
+    if (password === "") {
+      contentType =
+        mime.contentType(
+          mime.lookup(fileOrFolderPath) || DEFAULT_CONTENT_TYPE
+        ) || DEFAULT_CONTENT_TYPE;
+    }
+    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 bytesIn5MB = 5242880;
+    const body = new Uint8Array(remoteContent);
+    const upload = new Upload({
+      client: s3Client,
+      queueSize: s3Config.partsConcurrency, // concurrency
+      partSize: bytesIn5MB, // minimal 5MB by default
+      leavePartsOnError: false,
+      params: {
+        Bucket: s3Config.s3BucketName,
+        Key: uploadFile,
+        Body: body,
+        ContentType: contentType,
+      },
+    });
+    upload.on("httpUploadProgress", (progress) => {
+      // log.info(progress);
+    });
+    await upload.done();
+
+    return await getRemoteMeta(s3Client, s3Config, uploadFile);
+  }
+};
+
+export const listFromRemote = async (
+  s3Client: S3Client,
+  s3Config: S3Config,
+  prefix?: string
+) => {
+  const confCmd = {
+    Bucket: s3Config.s3BucketName,
+  } as ListObjectsV2CommandInput;
+  if (prefix !== undefined) {
+    confCmd.Prefix = prefix;
+  }
+
+  const contents = [] as _Object[];
+
+  let isTruncated = true;
+  do {
+    const rsp = await s3Client.send(new ListObjectsV2Command(confCmd));
+
+    if (rsp.$metadata.httpStatusCode !== 200) {
+      throw Error("some thing bad while listing remote!");
+    }
+    if (rsp.Contents === undefined) {
+      break;
+    }
+    contents.push(...rsp.Contents);
+
+    isTruncated = rsp.IsTruncated;
+    confCmd.ContinuationToken = rsp.NextContinuationToken;
+    if (
+      isTruncated &&
+      (confCmd.ContinuationToken === undefined ||
+        confCmd.ContinuationToken === "")
+    ) {
+      throw Error("isTruncated is true but no continuationToken provided");
+    }
+  } while (isTruncated);
+
+  // ensemble fake rsp
+  return {
+    Contents: contents.map((x) => fromS3ObjectToRemoteItem(x)),
+  };
+};
+
+/**
+ * The Body of resp of aws GetObject has mix types
+ * and we want to get ArrayBuffer here.
+ * See https://github.com/aws/aws-sdk-js-v3/issues/1877
+ * @param b The Body of GetObject
+ * @returns Promise<ArrayBuffer>
+ */
+const getObjectBodyToArrayBuffer = async (
+  b: Readable | ReadableStream | Blob
+) => {
+  if (b instanceof Readable) {
+    return (await new Promise((resolve, reject) => {
+      const chunks: Uint8Array[] = [];
+      b.on("data", (chunk) => chunks.push(chunk));
+      b.on("error", reject);
+      b.on("end", () => resolve(bufferToArrayBuffer(Buffer.concat(chunks))));
+    })) as ArrayBuffer;
+  } else if (b instanceof ReadableStream) {
+    return await new Response(b, {}).arrayBuffer();
+  } else if (b instanceof Blob) {
+    return await b.arrayBuffer();
+  } else {
+    throw TypeError(`The type of ${b} is not one of the supported types`);
+  }
+};
+
+const downloadFromRemoteRaw = async (
+  s3Client: S3Client,
+  s3Config: S3Config,
+  fileOrFolderPath: string
+) => {
+  const data = await s3Client.send(
+    new GetObjectCommand({
+      Bucket: s3Config.s3BucketName,
+      Key: fileOrFolderPath,
+    })
+  );
+  const bodyContents = await getObjectBodyToArrayBuffer(data.Body);
+  return bodyContents;
+};
+
+export const downloadFromRemote = async (
+  s3Client: S3Client,
+  s3Config: S3Config,
+  fileOrFolderPath: string,
+  vault: Vault,
+  mtime: number,
+  password: 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
+
+  if (isFolder) {
+    // mkdirp locally is enough
+    // do nothing here
+    return new ArrayBuffer(0);
+  } else {
+    let downloadFile = fileOrFolderPath;
+    if (password !== "") {
+      downloadFile = remoteEncryptedKey;
+    }
+    const remoteContent = await downloadFromRemoteRaw(
+      s3Client,
+      s3Config,
+      downloadFile
+    );
+    let localContent = remoteContent;
+    if (password !== "") {
+      localContent = await decryptArrayBuffer(remoteContent, password);
+    }
+    if (!skipSaving) {
+      await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
+        mtime: mtime,
+      });
+    }
+    return localContent;
+  }
+};
+
+/**
+ * This function deals with file normally and "folder" recursively.
+ * @param s3Client
+ * @param s3Config
+ * @param fileOrFolderPath
+ * @returns
+ */
+export const deleteFromRemote = async (
+  s3Client: S3Client,
+  s3Config: S3Config,
+  fileOrFolderPath: string,
+  password: string = "",
+  remoteEncryptedKey: string = ""
+) => {
+  if (fileOrFolderPath === "/") {
+    return;
+  }
+  let remoteFileName = fileOrFolderPath;
+  if (password !== "") {
+    remoteFileName = remoteEncryptedKey;
+  }
+  await s3Client.send(
+    new DeleteObjectCommand({
+      Bucket: s3Config.s3BucketName,
+      Key: remoteFileName,
+    })
+  );
+
+  if (fileOrFolderPath.endsWith("/") && password === "") {
+    const x = await listFromRemote(s3Client, s3Config, fileOrFolderPath);
+    x.Contents.forEach(async (element) => {
+      await s3Client.send(
+        new DeleteObjectCommand({
+          Bucket: s3Config.s3BucketName,
+          Key: element.key,
+        })
+      );
+    });
+  } else if (fileOrFolderPath.endsWith("/") && password !== "") {
+    // TODO
+  } else {
+    // pass
+  }
+};
+
+/**
+ * Check the config of S3 by heading bucket
+ * https://stackoverflow.com/questions/50842835
+ * @param s3Client
+ * @param s3Config
+ * @returns
+ */
+export const checkConnectivity = async (
+  s3Client: S3Client,
+  s3Config: S3Config,
+  callbackFunc?: any
+) => {
+  try {
+    const results = await s3Client.send(
+      new HeadBucketCommand({ Bucket: s3Config.s3BucketName })
+    );
+    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) {
+      callbackFunc(err);
+    }
+    return false;
+  }
+};

src/remoteForWebdav.ts

@@ -0,0 +1,568 @@
+import { Buffer } from "buffer";
+import { Vault, requestUrl } from "obsidian";
+
+import { Queue } from "@fyears/tsqueue";
+import chunk from "lodash/chunk";
+import flatten from "lodash/flatten";
+import { getReasonPhrase } from "http-status-codes";
+import { RemoteItem, VALID_REQURL, WebdavConfig } from "./baseTypes";
+import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
+import { bufferToArrayBuffer, getPathFolder, mkdirpInVault } from "./misc";
+
+import { log } from "./moreOnLog";
+
+import type {
+  FileStat,
+  WebDAVClient,
+  RequestOptionsWithState,
+  Response,
+  ResponseDataDetailed,
+} from "webdav/web";
+import { getPatcher } from "webdav/web";
+if (VALID_REQURL) {
+  getPatcher().patch(
+    "request",
+    async (
+      options: RequestOptionsWithState
+    ): Promise<Response | ResponseDataDetailed<any>> => {
+      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 r2: Response | ResponseDataDetailed<any> = undefined;
+      if (options.responseType === undefined) {
+        r2 = {
+          data: undefined,
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: r.headers,
+        };
+      } else if (options.responseType === "json") {
+        r2 = {
+          data: r.json,
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: r.headers,
+        };
+      } else if (options.responseType === "text") {
+        r2 = {
+          data: r.text,
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: r.headers,
+        };
+      } else if (options.responseType === "arraybuffer") {
+        r2 = {
+          data: r.arrayBuffer,
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: r.headers,
+        };
+      } else {
+        throw Error(
+          `do not know how to deal with responseType = ${options.responseType}`
+        );
+      }
+      return r2;
+    }
+  );
+}
+// getPatcher().patch("request", (options: any) => {
+//   // console.log("using fetch");
+//   const r = fetch(options.url, {
+//     method: options.method,
+//     body: options.data as any,
+//     headers: options.headers,
+//     signal: options.signal,
+//   })
+//     .then((rsp) => {
+//       if (options.responseType === undefined) {
+//         return Promise.all([undefined, rsp]);
+//       }
+//       if (options.responseType === "json") {
+//         return Promise.all([rsp.json(), rsp]);
+//       }
+//       if (options.responseType === "text") {
+//         return Promise.all([rsp.text(), rsp]);
+//       }
+//       if (options.responseType === "arraybuffer") {
+//         return Promise.all([rsp.arrayBuffer(), rsp]);
+//       }
+//     })
+//     .then(([d, r]) => {
+//       return {
+//         data: d,
+//         status: r.status,
+//         statusText: r.statusText,
+//         headers: r.headers,
+//       };
+//     });
+//   // console.log("using fetch");
+//   return r;
+// });
+import { AuthType, BufferLike, createClient } from "webdav/web";
+export type { WebDAVClient } from "webdav/web";
+
+export const DEFAULT_WEBDAV_CONFIG = {
+  address: "",
+  username: "",
+  password: "",
+  authType: "basic",
+  manualRecursive: false,
+  depth: "auto_unknown",
+  remoteBaseDir: "",
+} as WebdavConfig;
+
+const getWebdavPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
+  let key = fileOrFolderPath;
+  if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
+    // special
+    key = `/${remoteBaseDir}/`;
+  }
+  if (!fileOrFolderPath.startsWith("/")) {
+    key = `/${remoteBaseDir}/${fileOrFolderPath}`;
+  }
+  return key;
+};
+
+const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
+  if (
+    !(
+      fileOrFolderPath === `/${remoteBaseDir}` ||
+      fileOrFolderPath.startsWith(`/${remoteBaseDir}/`)
+    )
+  ) {
+    throw Error(
+      `"${fileOrFolderPath}" doesn't starts with "/${remoteBaseDir}/"`
+    );
+  }
+  // if (fileOrFolderPath.startsWith("/")) {
+  //   return fileOrFolderPath.slice(1);
+  // }
+  return fileOrFolderPath.slice(`/${remoteBaseDir}/`.length);
+};
+
+const fromWebdavItemToRemoteItem = (x: FileStat, remoteBaseDir: string) => {
+  let key = getNormPath(x.filename, remoteBaseDir);
+  if (x.type === "directory" && !key.endsWith("/")) {
+    key = `${key}/`;
+  }
+  return {
+    key: key,
+    lastModified: Date.parse(x.lastmod).valueOf(),
+    size: x.size,
+    remoteType: "webdav",
+    etag: x.etag || undefined,
+  } as RemoteItem;
+};
+
+export class WrappedWebdavClient {
+  webdavConfig: WebdavConfig;
+  remoteBaseDir: string;
+  client: WebDAVClient;
+  vaultFolderExists: boolean;
+  saveUpdatedConfigFunc: () => Promise<any>;
+  constructor(
+    webdavConfig: WebdavConfig,
+    remoteBaseDir: string,
+    saveUpdatedConfigFunc: () => Promise<any>
+  ) {
+    this.webdavConfig = webdavConfig;
+    this.remoteBaseDir = remoteBaseDir;
+    this.vaultFolderExists = false;
+    this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
+  }
+
+  init = async () => {
+    // init client if not inited
+    if (this.client === undefined) {
+      if (
+        this.webdavConfig.username !== "" &&
+        this.webdavConfig.password !== ""
+      ) {
+        this.client = createClient(this.webdavConfig.address, {
+          username: this.webdavConfig.username,
+          password: this.webdavConfig.password,
+          authType:
+            this.webdavConfig.authType === "digest"
+              ? AuthType.Digest
+              : AuthType.Password,
+        });
+      } else {
+        log.info("no password");
+        this.client = createClient(this.webdavConfig.address);
+      }
+    }
+
+    // check vault folder
+    if (this.vaultFolderExists) {
+      // pass
+    } else {
+      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.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",
+          },
+          responseType: "text",
+        });
+        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",
+              },
+              responseType: "text",
+            }
+          );
+          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,
+  remoteBaseDir: string,
+  saveUpdatedConfigFunc: () => Promise<any>
+) => {
+  return new WrappedWebdavClient(
+    webdavConfig,
+    remoteBaseDir,
+    saveUpdatedConfigFunc
+  );
+};
+
+export const getRemoteMeta = async (
+  client: WrappedWebdavClient,
+  fileOrFolderPath: string
+) => {
+  await client.init();
+  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.remoteBaseDir);
+};
+
+export const uploadToRemote = async (
+  client: WrappedWebdavClient,
+  fileOrFolderPath: string,
+  vault: Vault,
+  isRecursively: boolean = false,
+  password: string = "",
+  remoteEncryptedKey: string = "",
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
+) => {
+  await client.init();
+  let uploadFile = fileOrFolderPath;
+  if (password !== "") {
+    uploadFile = remoteEncryptedKey;
+  }
+  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: false, // the sync algo should guarantee no need to recursive
+      });
+      const res = await getRemoteMeta(client, uploadFile);
+      return res;
+    } else {
+      // if encrypted, upload a fake file with the encrypted file name
+      await client.client.putFileContents(uploadFile, "", {
+        overwrite: true,
+        onUploadProgress: (progress: any) => {
+          // log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
+        },
+      });
+
+      return await getRemoteMeta(client, uploadFile);
+    }
+  } else {
+    // file
+    // we ignore isRecursively parameter here
+    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);
+    }
+    // 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: any) => {
+        log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
+      },
+    });
+
+    return await getRemoteMeta(client, uploadFile);
+  }
+};
+
+export const listFromRemote = async (
+  client: WrappedWebdavClient,
+  prefix?: string
+) => {
+  if (prefix !== undefined) {
+    throw Error("prefix not supported");
+  }
+  await client.init();
+
+  let contents = [] as FileStat[];
+  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.remoteBaseDir}`]);
+    const CHUNK_SIZE = 10;
+    while (q.length > 0) {
+      const itemsToFetch = [];
+      while (q.length > 0) {
+        itemsToFetch.push(q.pop());
+      }
+      const itemsToFetchChunks = chunk(itemsToFetch, CHUNK_SIZE);
+      // log.debug(itemsToFetchChunks);
+      const subContents = [] as FileStat[];
+      for (const singleChunk of itemsToFetchChunks) {
+        const r = singleChunk.map((x) => {
+          return client.client.getDirectoryContents(x, {
+            deep: false,
+            details: false /* no need for verbose details here */,
+            // 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));
+        subContents.push(...r2);
+      }
+      for (let i = 0; i < subContents.length; ++i) {
+        const f = subContents[i];
+        contents.push(f);
+        if (f.type === "directory") {
+          q.push(f.filename);
+        }
+      }
+    }
+  } else {
+    // the remote supports infinity propfind
+    contents = (await client.client.getDirectoryContents(
+      `/${client.remoteBaseDir}`,
+      {
+        deep: true,
+        details: false /* no need for verbose details here */,
+        // 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.remoteBaseDir)
+    ),
+  };
+};
+
+const downloadFromRemoteRaw = async (
+  client: WrappedWebdavClient,
+  fileOrFolderPath: string
+) => {
+  await client.init();
+  const buff = (await client.client.getFileContents(
+    getWebdavPath(fileOrFolderPath, client.remoteBaseDir)
+  )) as BufferLike;
+  if (buff instanceof ArrayBuffer) {
+    return buff;
+  } else if (buff instanceof Buffer) {
+    return bufferToArrayBuffer(buff);
+  }
+  throw Error(`unexpected file content result with type ${typeof buff}`);
+};
+
+export const downloadFromRemote = async (
+  client: WrappedWebdavClient,
+  fileOrFolderPath: string,
+  vault: Vault,
+  mtime: number,
+  password: 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
+
+  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.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 (
+  client: WrappedWebdavClient,
+  fileOrFolderPath: string,
+  password: string = "",
+  remoteEncryptedKey: string = ""
+) => {
+  if (fileOrFolderPath === "/") {
+    return;
+  }
+  let remoteFileName = fileOrFolderPath;
+  if (password !== "") {
+    remoteFileName = remoteEncryptedKey;
+  }
+  remoteFileName = getWebdavPath(remoteFileName, client.remoteBaseDir);
+
+  await client.init();
+  try {
+    await client.client.deleteFile(remoteFileName);
+    // log.info(`delete ${remoteFileName} succeeded`);
+  } catch (err) {
+    console.error("some error while deleting");
+    log.info(err);
+  }
+};
+
+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/s3.ts

@@ -1,324 +0,0 @@
-import { Buffer } from "buffer";
-import { Readable } from "stream";
-
-import { Vault } from "obsidian";
-
-import {
-  S3Client,
-  ListObjectsV2Command,
-  PutObjectCommand,
-  GetObjectCommand,
-  DeleteObjectCommand,
-  HeadObjectCommand,
-  HeadBucketCommand,
-  ListObjectsV2CommandInput,
-  ListObjectsV2CommandOutput,
-} from "@aws-sdk/client-s3";
-
-import type { _Object } from "@aws-sdk/client-s3";
-
-import {
-  arrayBufferToBuffer,
-  bufferToArrayBuffer,
-  mkdirpInVault,
-} from "./misc";
-import * as mime from "mime-types";
-import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
-
-export interface S3Config {
-  s3Endpoint: string;
-  s3Region: string;
-  s3AccessKeyID: string;
-  s3SecretAccessKey: string;
-  s3BucketName: string;
-}
-
-export const DEFAULT_S3_CONFIG = {
-  s3Endpoint: "",
-  s3Region: "",
-  s3AccessKeyID: "",
-  s3SecretAccessKey: "",
-  s3BucketName: "",
-};
-
-export type S3ObjectType = _Object;
-
-export const getS3Client = (s3Config: S3Config) => {
-  const s3Client = new S3Client({
-    region: s3Config.s3Region,
-    endpoint: s3Config.s3Endpoint,
-    credentials: {
-      accessKeyId: s3Config.s3AccessKeyID,
-      secretAccessKey: s3Config.s3SecretAccessKey,
-    },
-  });
-  return s3Client;
-};
-
-export const getRemoteMeta = async (
-  s3Client: S3Client,
-  s3Config: S3Config,
-  fileOrFolderPath: string
-) => {
-  return await s3Client.send(
-    new HeadObjectCommand({
-      Bucket: s3Config.s3BucketName,
-      Key: fileOrFolderPath,
-    })
-  );
-};
-
-export const uploadToRemote = async (
-  s3Client: S3Client,
-  s3Config: S3Config,
-  fileOrFolderPath: string,
-  vault: Vault,
-  isRecursively: boolean = false,
-  password: string = "",
-  remoteEncryptedKey: string = ""
-) => {
-  let uploadFile = fileOrFolderPath;
-  if (password !== "") {
-    uploadFile = remoteEncryptedKey;
-  }
-  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) {
-    // folder
-    const contentType = DEFAULT_CONTENT_TYPE;
-    await s3Client.send(
-      new PutObjectCommand({
-        Bucket: s3Config.s3BucketName,
-        Key: uploadFile,
-        Body: "",
-        ContentType: contentType,
-      })
-    );
-    return await getRemoteMeta(s3Client, s3Config, fileOrFolderPath);
-  } else {
-    // file
-    // we ignore isRecursively parameter here
-    let contentType = DEFAULT_CONTENT_TYPE;
-    if (password === "") {
-      contentType =
-        mime.contentType(
-          mime.lookup(fileOrFolderPath) || DEFAULT_CONTENT_TYPE
-        ) || DEFAULT_CONTENT_TYPE;
-    }
-    const localContent = await vault.adapter.readBinary(fileOrFolderPath);
-    let remoteContent = localContent;
-    if (password !== "") {
-      remoteContent = await encryptArrayBuffer(localContent, password);
-    }
-    const body = arrayBufferToBuffer(remoteContent);
-    await s3Client.send(
-      new PutObjectCommand({
-        Bucket: s3Config.s3BucketName,
-        Key: uploadFile,
-        Body: body,
-        ContentType: contentType,
-      })
-    );
-    return await getRemoteMeta(s3Client, s3Config, uploadFile);
-  }
-};
-
-export const listFromRemote = async (
-  s3Client: S3Client,
-  s3Config: S3Config,
-  prefix?: string
-) => {
-  const confCmd = {
-    Bucket: s3Config.s3BucketName,
-  } as ListObjectsV2CommandInput;
-  if (prefix !== undefined) {
-    confCmd.Prefix = prefix;
-  }
-
-  const contents = [] as _Object[];
-
-  let isTruncated = true;
-  let continuationToken = "";
-  do {
-    const rsp = await s3Client.send(new ListObjectsV2Command(confCmd));
-
-    if (rsp.$metadata.httpStatusCode !== 200) {
-      throw Error("some thing bad while listing remote!");
-    }
-    contents.push(...rsp.Contents);
-
-    isTruncated = rsp.IsTruncated;
-    confCmd.ContinuationToken = rsp.NextContinuationToken;
-    if (
-      isTruncated &&
-      (continuationToken === undefined || continuationToken === "")
-    ) {
-      throw Error("isTruncated is true but no continuationToken provided");
-    }
-  } while (isTruncated);
-
-  // ensemble fake rsp
-  return {
-    "$.metadata": {
-      httpStatusCode: 200,
-    },
-    Contents: contents,
-  };
-};
-
-/**
- * The Body of resp of aws GetObject has mix types
- * and we want to get ArrayBuffer here.
- * See https://github.com/aws/aws-sdk-js-v3/issues/1877
- * @param b The Body of GetObject
- * @returns Promise<ArrayBuffer>
- */
-const getObjectBodyToArrayBuffer = async (
-  b: Readable | ReadableStream | Blob
-) => {
-  if (b instanceof Readable) {
-    const chunks: Uint8Array[] = [];
-    for await (let chunk of b) {
-      chunks.push(chunk);
-    }
-    const buf = Buffer.concat(chunks);
-    return bufferToArrayBuffer(buf);
-  } else if (b instanceof ReadableStream) {
-    return await new Response(b, {}).arrayBuffer();
-  } else if (b instanceof Blob) {
-    return await b.arrayBuffer();
-  } else {
-    throw TypeError(`The type of ${b} is not one of the supported types`);
-  }
-};
-
-export const downloadFromRemoteRaw = async (
-  s3Client: S3Client,
-  s3Config: S3Config,
-  fileOrFolderPath: string
-) => {
-  const data = await s3Client.send(
-    new GetObjectCommand({
-      Bucket: s3Config.s3BucketName,
-      Key: fileOrFolderPath,
-    })
-  );
-  const bodyContents = await getObjectBodyToArrayBuffer(data.Body);
-  return bodyContents;
-};
-
-export const downloadFromRemote = async (
-  s3Client: S3Client,
-  s3Config: S3Config,
-  fileOrFolderPath: string,
-  vault: Vault,
-  mtime: number,
-  password: string = "",
-  remoteEncryptedKey: string = ""
-) => {
-  const isFolder = fileOrFolderPath.endsWith("/");
-
-  await mkdirpInVault(fileOrFolderPath, vault);
-
-  // the file is always local file
-  // we need to encrypt it
-
-  if (isFolder) {
-    // mkdirp locally is enough
-    // do nothing here
-  } else {
-    let downloadFile = fileOrFolderPath;
-    if (password !== "") {
-      downloadFile = remoteEncryptedKey;
-    }
-    const remoteContent = await downloadFromRemoteRaw(
-      s3Client,
-      s3Config,
-      downloadFile
-    );
-    let localContent = remoteContent;
-    if (password !== "") {
-      localContent = await decryptArrayBuffer(remoteContent, password);
-    }
-    await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
-      mtime: mtime,
-    });
-  }
-};
-
-/**
- * This function deals with file normally and "folder" recursively.
- * @param s3Client
- * @param s3Config
- * @param fileOrFolderPath
- * @returns
- */
-export const deleteFromRemote = async (
-  s3Client: S3Client,
-  s3Config: S3Config,
-  fileOrFolderPath: string,
-  password: string = "",
-  remoteEncryptedKey: string = ""
-) => {
-  if (fileOrFolderPath === "/") {
-    return;
-  }
-  let remoteFileName = fileOrFolderPath;
-  if (password !== "") {
-    remoteFileName = remoteEncryptedKey;
-  }
-  await s3Client.send(
-    new DeleteObjectCommand({
-      Bucket: s3Config.s3BucketName,
-      Key: remoteFileName,
-    })
-  );
-
-  if (fileOrFolderPath.endsWith("/") && password === "") {
-    const x = await listFromRemote(s3Client, s3Config, fileOrFolderPath);
-    x.Contents.forEach(async (element) => {
-      await s3Client.send(
-        new DeleteObjectCommand({
-          Bucket: s3Config.s3BucketName,
-          Key: element.Key,
-        })
-      );
-    });
-  } else if (fileOrFolderPath.endsWith("/") && password !== "") {
-    // TODO
-  } else {
-    // pass
-  }
-};
-
-/**
- * Check the config of S3 by heading bucket
- * https://stackoverflow.com/questions/50842835
- * @param s3Client
- * @param s3Config
- * @returns
- */
-export const checkS3Connectivity = async (
-  s3Client: S3Client,
-  s3Config: S3Config
-) => {
-  try {
-    const results = await s3Client.send(
-      new HeadBucketCommand({ Bucket: s3Config.s3BucketName })
-    );
-    if (
-      results === undefined ||
-      results.$metadata === undefined ||
-      results.$metadata.httpStatusCode === undefined
-    ) {
-      return false;
-    }
-    return results.$metadata.httpStatusCode === 200;
-  } catch (err) {
-    return false;
-  }
-};

src/syncAlgoV2Notice.ts

@@ -0,0 +1,63 @@
+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();
+    } else {
+      log.info("do not agree to use the new algorithm");
+      this.plugin.unload();
+    }
+  }
+}

styles.css

@@ -1,5 +1,58 @@
 /* set the styles */
 
-.password_second_confirm {
+.password-second-confirm {
   font-weight: bold;
 }
+
+.password-disclaimer {
+  font-weight: bold;
+}
+
+.s3-disclaimer {
+  font-weight: bold;
+}
+.s3-hide {
+  display: none;
+}
+
+.dropbox-disclaimer {
+  font-weight: bold;
+}
+.dropbox-hide {
+  display: none;
+}
+
+.dropbox-auth-button-hide {
+  display: none;
+}
+
+.dropbox-revoke-auth-button-hide {
+  display: none;
+}
+
+.onedrive-disclaimer {
+  font-weight: bold;
+}
+.onedrive-hide {
+  display: none;
+}
+
+.onedrive-auth-button-hide {
+  display: none;
+}
+
+.onedrive-revoke-auth-button-hide {
+  display: none;
+}
+
+.webdav-disclaimer {
+  font-weight: bold;
+}
+.webdav-hide {
+  display: none;
+}
+
+.qrcode-img {
+  width: 350px;
+  height: 350px;
+}

tests/configPersist.test.ts

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

tests/encrypt.test.ts

@@ -1,13 +1,20 @@
+import * as chai from "chai";
+import chaiAsPromised from "chai-as-promised";
 import * as fs from "fs";
 import * as path from "path";
-import { expect } from "chai";
-import { base64ToBase32, bufferToArrayBuffer } from "../src/misc";
 import {
   decryptArrayBuffer,
   decryptBase32ToString,
   encryptArrayBuffer,
   encryptStringToBase32,
+  encryptStringToBase64url,
+  getSizeFromEncToOrig,
+  getSizeFromOrigToEnc,
 } from "../src/encrypt";
+import { base64ToBase64url, bufferToArrayBuffer } from "../src/misc";
+
+chai.use(chaiAsPromised);
+const expect = chai.expect;
 
 describe("Encryption tests", () => {
   beforeEach(function () {
@@ -22,6 +29,14 @@ describe("Encryption tests", () => {
     expect(await encryptStringToBase32(k, password)).to.not.equal(k);
   });
 
+  it("should raise error using different password", async () => {
+    const k = "secret text";
+    const password = "hey";
+    const password2 = "hey2";
+    const enc = await encryptStringToBase32(k, password);
+    await expect(decryptBase32ToString(enc, password2)).to.be.rejected;
+  });
+
   it("should encrypt and decrypt string and get the same result returned", async () => {
     const k = "jfkkjkjbce7983ycdeknkkjckooAIUHIDIBIE((*BII)njD/d/dd/d/sjxhux";
     const password = "hfiuibec989###oiu982bj1`";
@@ -40,7 +55,7 @@ describe("Encryption tests", () => {
     ).toString("utf-8");
     const password = "somepassword";
     const saltHex = "8302F586FAB491EC";
-    const enc = await encryptStringToBase32(
+    const enc = await encryptStringToBase64url(
       fileContent,
       password,
       undefined,
@@ -48,14 +63,14 @@ describe("Encryption tests", () => {
     );
 
     // two command returns same result:
-    // cat ./sometext.txt | openssl enc -p -aes-256-cbc -S 8302F586FAB491EC -pbkdf2 -iter 10000 -base64 -pass pass:somepassword
-    // openssl enc -p -aes-256-cbc -S 8302F586FAB491EC -pbkdf2 -iter 10000 -base64 -pass pass:somepassword -in ./sometext.txt
+    // cat ./sometext.txt | openssl enc -p -aes-256-cbc -S 8302F586FAB491EC -pbkdf2 -iter 20000 -base64 -pass pass:somepassword
+    // openssl enc -p -aes-256-cbc -S 8302F586FAB491EC -pbkdf2 -iter 20000 -base64 -pass pass:somepassword -in ./sometext.txt
     const opensslBase64Res =
-      "U2FsdGVkX1+DAvWG+rSR7MSa+yJav1zCE7SSXiBooqwI5Q+LMpIthpk/pXkLj+25";
+      "U2FsdGVkX1+DAvWG+rSR7BPXMnlvSSVGMdjsx7kE1CTH+28P+yAZRdDGgFWMGkMd";
     // we output base32, so we need some transformation
-    const opensslBase32Res = base64ToBase32(opensslBase64Res);
+    const opensslBase64urlRes = base64ToBase64url(opensslBase64Res);
 
-    expect(enc).equal(opensslBase32Res);
+    expect(enc).equal(opensslBase64urlRes);
   });
 
   it("should encrypt binary file and get the same result as openssl", async () => {
@@ -77,6 +92,8 @@ describe("Encryption tests", () => {
       await fs.readFileSync(path.join(testFolder, testFileName + ".enc"))
     );
 
+    // openssl enc -p -aes-256-cbc -S 8302F586FAB491EC -pbkdf2 -iter 20000 -pass pass:somepassword -in mona_lisa/1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg -out mona_lisa/1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg.enc
+
     expect(Buffer.from(enc).equals(Buffer.from(opensslArrBuf))).to.be.true;
   });
 
@@ -95,4 +112,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));
+  });
+});

tests/misc.test.ts

@@ -1,7 +1,5 @@
-import * as fs from "fs";
-import * as path from "path";
 import { expect } from "chai";
-
+import { JSDOM } from "jsdom";
 import * as misc from "../src/misc";
 
 describe("Misc: hidden file", () => {
@@ -23,7 +21,7 @@ describe("Misc: hidden file", () => {
 
     item = "_hidden_loose";
     expect(misc.isHiddenPath(item)).to.be.true;
-    expect(misc.isHiddenPath(item, false)).to.be.false;
+    expect(misc.isHiddenPath(item, true, false)).to.be.false;
 
     item = "/sdd/_hidden_loose";
     expect(misc.isHiddenPath(item)).to.be.true;
@@ -32,10 +30,21 @@ describe("Misc: hidden file", () => {
     expect(misc.isHiddenPath(item)).to.be.true;
 
     item = "what/../_hidden_loose/what/what/what";
-    expect(misc.isHiddenPath(item, false)).to.be.false;
+    expect(misc.isHiddenPath(item, true, false)).to.be.false;
 
     item = "what/../_hidden_loose/../.hidden/what/what/what";
-    expect(misc.isHiddenPath(item, false)).to.be.true;
+    expect(misc.isHiddenPath(item, true, false)).to.be.true;
+
+    item = "what/../_hidden_loose/../.hidden/what/what/what";
+    expect(misc.isHiddenPath(item, false, true)).to.be.false;
+
+    item = "what/_hidden_loose/what/what/what";
+    expect(misc.isHiddenPath(item, false, true)).to.be.true;
+    expect(misc.isHiddenPath(item, true, false)).to.be.false;
+
+    item = "what/.hidden/what/what/what";
+    expect(misc.isHiddenPath(item, false, true)).to.be.false;
+    expect(misc.isHiddenPath(item, true, false)).to.be.true;
   });
 });
 
@@ -69,4 +78,210 @@ describe("Misc: get folder levels", () => {
     const res3 = ["xxx", "xxx/yyy", "xxx/yyy/zzz"];
     expect(misc.getFolderLevels(item3)).to.deep.equal(res3);
   });
+
+  it("should correctly add ending slash if required", () => {
+    const item = "xxx/yyy/zzz.md";
+    const res = ["xxx/", "xxx/yyy/"];
+    expect(misc.getFolderLevels(item, true)).to.deep.equal(res);
+
+    const item2 = "xxx/yyy/zzz";
+    const res2 = ["xxx/", "xxx/yyy/"];
+    expect(misc.getFolderLevels(item2, true)).to.deep.equal(res2);
+
+    const item3 = "xxx/yyy/zzz/";
+    const res3 = ["xxx/", "xxx/yyy/", "xxx/yyy/zzz/"];
+    expect(misc.getFolderLevels(item3, true)).to.deep.equal(res3);
+  });
+
+  it("should treat path starting with / correctly", () => {
+    const item = "/xxx/yyy/zzz.md";
+    const res = ["/xxx", "/xxx/yyy"];
+    expect(misc.getFolderLevels(item)).to.deep.equal(res);
+
+    const item2 = "/xxx/yyy/zzz";
+    const res2 = ["/xxx", "/xxx/yyy"];
+    expect(misc.getFolderLevels(item2)).to.deep.equal(res2);
+
+    const item3 = "/xxx/yyy/zzz/";
+    const res3 = ["/xxx", "/xxx/yyy", "/xxx/yyy/zzz"];
+    expect(misc.getFolderLevels(item3)).to.deep.equal(res3);
+
+    const item4 = "/xxx";
+    const res4 = [] as string[];
+    expect(misc.getFolderLevels(item4)).to.deep.equal(res4);
+
+    const item5 = "/";
+    const res5 = [] as string[];
+    expect(misc.getFolderLevels(item5)).to.deep.equal(res5);
+  });
+});
+
+describe("Misc: get parent folder", () => {
+  it("should treat empty path correctly", () => {
+    const item = "";
+    expect(misc.getParentFolder(item)).equals("/");
+  });
+
+  it("should treat one level path correctly", () => {
+    let item = "abc/";
+    expect(misc.getParentFolder(item)).equals("/");
+    item = "/efg/";
+    expect(misc.getParentFolder(item)).equals("/");
+  });
+
+  it("should treat more levels path correctly", () => {
+    let item = "abc/efg";
+    expect(misc.getParentFolder(item)).equals("abc/");
+    item = "/hij/klm/";
+    expect(misc.getParentFolder(item)).equals("/hij/");
+  });
+});
+
+describe("Misc: vaild file name tests", () => {
+  it("should treat no ascii correctly", async () => {
+    const x = misc.isVaildText("😄🍎 apple 苹果");
+    // console.log(x)
+    expect(x).to.be.true;
+  });
+
+  it("should find not-printable chars correctly", async () => {
+    const x = misc.isVaildText("😄🍎 apple 苹果\u0000");
+    // console.log(x)
+    expect(x).to.be.false;
+  });
+
+  it("should allow spaces/slashes/...", async () => {
+    const x = misc.isVaildText("😄🍎 apple 苹果/-_=/\\*%^&@#$`");
+    expect(x).to.be.true;
+  });
+});
+
+describe("Misc: get dirname", () => {
+  it("should return itself for folder", async () => {
+    const x = misc.getPathFolder("ssss/");
+    // console.log(x)
+    expect(x).to.equal("ssss/");
+  });
+
+  it("should return folder for file", async () => {
+    const x = misc.getPathFolder("sss/yyy");
+    // console.log(x)
+    expect(x).to.equal("sss/");
+  });
+
+  it("should treat / specially", async () => {
+    const x = misc.getPathFolder("/");
+    expect(x).to.equal("/");
+
+    const y = misc.getPathFolder("/abc");
+    expect(y).to.equal("/");
+  });
+});
+
+describe("Misc: extract svg", () => {
+  beforeEach(function () {
+    const fakeBrowser = new JSDOM("");
+    global.window = fakeBrowser.window as any;
+  });
+
+  it("should extract rect from svg correctly", () => {
+    const x = "<svg><rect/><g/></svg>";
+    const y = misc.extractSvgSub(x);
+    // console.log(x)
+    expect(y).to.equal("<rect/><g/>");
+  });
+});
+
+describe("Misc: get split ranges", () => {
+  it("should deal with big parts", () => {
+    const k = misc.getSplitRanges(10, 20);
+    const k2: misc.SplitRange[] = [
+      {
+        partNum: 1,
+        start: 0,
+        end: 10,
+      },
+    ];
+    expect(k).to.deep.equal(k2);
+  });
+
+  it("should deal with 0 remainder", () => {
+    const k = misc.getSplitRanges(20, 10);
+    const k2: misc.SplitRange[] = [
+      {
+        partNum: 1,
+        start: 0,
+        end: 10,
+      },
+      {
+        partNum: 2,
+        start: 10,
+        end: 20,
+      },
+    ];
+    expect(k).to.deep.equal(k2);
+  });
+
+  it("should deal with not-0 remainder", () => {
+    const k = misc.getSplitRanges(25, 10);
+    const k2: misc.SplitRange[] = [
+      {
+        partNum: 1,
+        start: 0,
+        end: 10,
+      },
+      {
+        partNum: 2,
+        start: 10,
+        end: 20,
+      },
+      {
+        partNum: 3,
+        start: 20,
+        end: 25,
+      },
+    ];
+    expect(k).to.deep.equal(k2);
+  });
+});
+
+describe("Misc: at which level", () => {
+  it("should throw error on some parameters", () => {
+    expect(() => misc.atWhichLevel(undefined)).to.throw();
+    expect(() => misc.atWhichLevel("")).to.throw();
+    expect(() => misc.atWhichLevel("..")).to.throw();
+    expect(() => misc.atWhichLevel(".")).to.throw();
+    expect(() => misc.atWhichLevel("/")).to.throw();
+    expect(() => misc.atWhichLevel("/xxyy")).to.throw();
+  });
+
+  it("should treat folders correctly", () => {
+    expect(misc.atWhichLevel("x/")).to.be.equal(1);
+    expect(misc.atWhichLevel("x/y/")).to.be.equal(2);
+  });
+
+  it("should treat files correctly", () => {
+    expect(misc.atWhichLevel("x.md")).to.be.equal(1);
+    expect(misc.atWhichLevel("x/y.md")).to.be.equal(2);
+    expect(misc.atWhichLevel("x/y/z.md")).to.be.equal(3);
+  });
+});
+
+describe("Misc: special char for dir", () => {
+  it("should return false for normal string", () => {
+    expect(misc.checkHasSpecialCharForDir("")).to.be.false;
+    expect(misc.checkHasSpecialCharForDir("xxx")).to.be.false;
+    expect(misc.checkHasSpecialCharForDir("yyy_xxx")).to.be.false;
+    expect(misc.checkHasSpecialCharForDir("yyy.xxx")).to.be.false;
+    expect(misc.checkHasSpecialCharForDir("yyy？xxx")).to.be.false;
+  });
+
+  it("should return true for special cases", () => {
+    expect(misc.checkHasSpecialCharForDir("?")).to.be.true;
+    expect(misc.checkHasSpecialCharForDir("/")).to.be.true;
+    expect(misc.checkHasSpecialCharForDir("\\")).to.be.true;
+    expect(misc.checkHasSpecialCharForDir("xxx/yyy")).to.be.true;
+    expect(misc.checkHasSpecialCharForDir("xxx\\yyy")).to.be.true;
+    expect(misc.checkHasSpecialCharForDir("xxx?yyy")).to.be.true;
+  });
 });

tests/presetRules.test.ts

@@ -0,0 +1,111 @@
+import { expect } from "chai";
+import type { WebdavConfig } from "../src/baseTypes";
+import { applyWebdavPresetRulesInplace } from "../src/presetRules";
+
+describe("Preset rules tests", () => {
+  it("should check undefined correctly", () => {
+    let x: Partial<WebdavConfig> | undefined = undefined;
+    const y = applyWebdavPresetRulesInplace(x);
+    expect(y.webdav === undefined);
+    expect(!y.changed);
+  });
+
+  it("should check empty object", () => {
+    let x: Partial<WebdavConfig> | undefined = {};
+    const y = applyWebdavPresetRulesInplace(x);
+    expect(y.webdav).deep.equals({});
+    expect(!y.changed);
+  });
+
+  it("should modify depths correctly", () => {
+    let x: Partial<WebdavConfig> = {
+      address: "https://example.teracloud.jp/dav/",
+      depth: "auto_unknown",
+    };
+    let y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_1");
+    expect(y.changed);
+
+    x = {
+      address: "https://example.teracloud.jp/dav/example",
+      depth: "auto_unknown",
+    };
+    y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_1");
+    expect(y.changed);
+
+    x = {
+      address: "https://dav.jianguoyun.com/dav/",
+      depth: "auto_unknown",
+    };
+    y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_1");
+    expect(y.changed);
+
+    x = {
+      address: "https://dav.jianguoyun.com/dav/",
+      depth: "auto_infinity",
+    };
+    y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_1");
+    expect(y.changed);
+  });
+
+  it("should not modify depths if depths is set automatically correctly", () => {
+    let x: Partial<WebdavConfig> = {
+      address: "https://dav.jianguoyun.com/dav/",
+      depth: "auto_1",
+    };
+    let y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_1");
+    expect(!y.changed);
+  });
+
+  it("should not modify depths if depths have been set manually", () => {
+    let x: Partial<WebdavConfig> = {
+      address: "https://example.teracloud.jp/dav/",
+      depth: "manual_infinity",
+    };
+    let y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "manual_infinity");
+    expect(!y.changed);
+
+    x = {
+      address: "https://example.teracloud.jp/dav/example",
+      depth: "manual_1",
+    };
+    y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "manual_1");
+    expect(!y.changed);
+  });
+
+  it("should not modify depths when urls are not in preset rules", () => {
+    let x: Partial<WebdavConfig> = {
+      address: "https://teracloud.jp/dav/",
+      depth: "auto_unknown",
+    };
+    applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_unknown");
+
+    x = {
+      address: "https://dav.jianguoyun.com/dav_example",
+      depth: "auto_unknown",
+    };
+    applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_unknown");
+
+    x = {
+      address: "",
+      depth: "auto_unknown",
+    };
+    applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_unknown");
+
+    x = {
+      address: "https://dav.jianguoyun.com/dav/",
+      depth: "what" as any,
+    };
+    applyWebdavPresetRulesInplace(x);
+    expect(x.depth === ("what" as any));
+  });
+});

tests/static_assets/mona_lisa/1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg.enc

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:cf67abd791f1e230bce57dd47150f262424247cbefb8be16efcd57d13955576a
+oid sha256:7687eaf60ed93f754b107dc86a437aa97fad7bedd40432171b08c22cded7b559
 size 1141568

tsconfig.json

@@ -9,8 +9,10 @@
     "noImplicitAny": true,
     "moduleResolution": "node",
     // "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
     "esModuleInterop": true,
     "importHelpers": true,
+    "isolatedModules": true,
     "lib": ["dom", "es5", "scripthost", "es2015"]
   },
   "include": ["**/*.ts"]

versions.json

@@ -1,3 +1,4 @@
 {
-  "0.0.11": "0.12.15"
+  "0.3.2": "0.12.15",
+  "0.3.21": "0.13.21"
 }

webpack.config.js

@@ -1,7 +1,12 @@
+require("dotenv").config();
 const path = require("path");
 const webpack = require("webpack");
 const TerserPlugin = require("terser-webpack-plugin");
 
+const DEFAULT_DROPBOX_APP_KEY = process.env.DROPBOX_APP_KEY || "";
+const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
+const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
+
 module.exports = {
   entry: "./src/main.ts",
   target: "web",
@@ -11,6 +16,11 @@ module.exports = {
     libraryTarget: "commonjs",
   },
   plugins: [
+    new webpack.DefinePlugin({
+      "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}"`,
+    }),
     // Work around for Buffer is undefined:
     // https://github.com/webpack/changelog-v5/issues/10
     new webpack.ProvidePlugin({
@@ -27,6 +37,10 @@ module.exports = {
         use: "ts-loader",
         exclude: /node_modules/,
       },
+      {
+        test: /\.svg?$/,
+        type: "asset/source",
+      },
     ],
   },
   resolve: {
@@ -37,11 +51,13 @@ module.exports = {
       // buffer: require.resolve("buffer/"),
       // console: require.resolve("console-browserify"),
       // constants: require.resolve("constants-browserify"),
-      // crypto: require.resolve("crypto-browserify"),
+      crypto: require.resolve("crypto-browserify"),
+      // crypto: false,
       // domain: require.resolve("domain-browser"),
       // events: require.resolve("events"),
       // http: require.resolve("stream-http"),
       // https: require.resolve("https-browserify"),
+      net: false,
       // os: require.resolve("os-browserify/browser"),
       path: require.resolve("path-browserify"),
       // punycode: require.resolve("punycode"),
@@ -51,8 +67,9 @@ module.exports = {
       // string_decoder: require.resolve("string_decoder"),
       // sys: require.resolve("util"),
       // timers: require.resolve("timers-browserify"),
+      tls: false,
       // tty: require.resolve("tty-browserify"),
-      // url: require.resolve("url"),
+      url: require.resolve("url/"),
       // util: require.resolve("util"),
       // vm: require.resolve("vm-browserify"),
       // zlib: require.resolve("browserify-zlib"),