add upyun

Co-authored-by: ras0q <ras0q@users.noreply.github.com>

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -31,13 +31,30 @@ body:
   - type: dropdown
     id: service
     attributes:
-      label: What remote cloud services are you using?
+      label: What remote cloud services are you using? (Please choose the specified one if it's in the list)
       multiple: true
       options:
         - S3
+        - S3 (Cloudflare R2)
+        - S3 (BackBlaze B2)
+        - S3 (腾讯云 COS Tencent Cloud COS)
+        - S3 (阿里云 OSS Alibaba Cloud OSS)
+        - S3 (MinIO)
+        - S3 (Wasabi)
+        - S3 (Storj)
         - OneDrive for personal
+        - OneDrive for business
         - Dropbox
         - webdav       
+        - webdav (ownCloud)
+        - webdav (InfiniCloud (formally TeraCLOUD))
+        - webdav (AList)
+        - webdav (Cloudreve)
+        - webdav (坚果云 JianGuoYun/NutStore)
+        - webdav (NextCloud)
+        - webdav (FastMail)
+        - webdav (rclone webdav)
+        - webdav (nginx)
         - others
     validations:
       required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -21,9 +21,26 @@ body:
       multiple: true
       options:
         - S3
+        - S3 (Cloudflare R2)
+        - S3 (BackBlaze B2)
+        - S3 (腾讯云 COS Tencent Cloud COS)
+        - S3 (阿里云 OSS Alibaba Cloud OSS)
+        - S3 (MinIO)
+        - S3 (Wasabi)
+        - S3 (Storj)
         - OneDrive for personal
+        - OneDrive for business
         - Dropbox
         - webdav       
+        - webdav (ownCloud)
+        - webdav (InfiniCloud (formally TeraCLOUD))
+        - webdav (AList)
+        - webdav (Cloudreve)
+        - webdav (坚果云 JianGuoYun/NutStore)
+        - webdav (NextCloud)
+        - webdav (FastMail)
+        - webdav (rclone webdav)
+        - webdav (nginx)
         - others
     validations:
       required: false

.gitignore

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

.gitmodules

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

README.md

@@ -17,22 +17,22 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 ## Features
 
 - Supports:
-  - Amazon S3 or S3-compatible
+  - Amazon S3 or S3-compatible (Cloudflare R2 / BackBlaze B2 / MinIO / ...)
   - 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.
+- **[End-to-end encryption](./docs/encryption/README.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).**
+- **Skip Large files** and **skip paths** by custom regex conditions!
 - **Fully open source under [Apache-2.0 License](./LICENSE).**
-- **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.**
+- **[Sync Algorithm open](./docs/sync_algorithm/v3/intro.md) for discussion.**
+- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** now, more to come!
 
 ## 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.
@@ -60,15 +60,22 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 ### S3
 
+- Tutorials / Examples:
+  - [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/README.md)
+  - [BackBlaze B2](./docs/remote_services/s3_backblaze_b2/README.md)
+  - [Storj](./docs/remote_services/s3_storj_io/README.md)
+  - [腾讯云 COS](./docs/remote_services/s3_tencent_cloud_cos/README.zh-cn.md) | [Tencent Cloud COS](./docs/remote_services/s3_tencent_cloud_cos/README.md)
+  - [MinIO](./docs/remote_services/s3_minio/README.md)
+  - [又拍云](./docs/remote_services/s3_upyun/README.zh-cn.md)
 - Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
-- 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.
+- If you are using AWS S3, create [policy and user](./docs/remote_services/s3_general/s3_user_policy.md).
+- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md).
 - Download and enable this plugin.
 - Enter your information to the settings of this plugin.
 - If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
 - Click the new "circle arrow" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (Or, you could configure auto sync in the settings panel (See next chapter).) While syncing, the icon becomes "two half-circle arrows". 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.
+- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
 
 ### Dropbox
 
@@ -76,6 +83,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 - 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**.
+- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
 
 ### OneDrive for personal
 
@@ -84,19 +92,21 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 - 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**.
+- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
+- You might also want to checkout [faq for OneDrive](./docs/remote_services/onedrive/README.md).
 
 ### 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.
+- Tutorials / Examples:
+  - [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
+  - [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
+  - [Synology webdav server](./docs/remote_services/webdav_synology_webdav_server/README.md) | [群晖 webdav server](./docs/remote_services/webdav_synology_webdav_server/README.zh-cn.md)
+  - [AList（中文）](./docs/remote_services/webdav_alist/README.zh-cn.md) | [AList (English)](./docs/remote_services/webdav_alist/README.md)
+  - [坚果云](./docs/remote_services/webdav_jianguoyun/README.zh-cn.md) | [JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
+- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md).
 - Your data would be synced to a `${vaultName}` sub folder on your webdav server.
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
+- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
 
 ## Scheduled Auto Sync
 

debugServer.js

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

docs/encryption/README.md

@@ -0,0 +1,8 @@
+# Encryption
+
+Currently (March 2024), Remotely Save supports two end to end encryption format:
+
+1. [RClone Crypt](./rclone.md) format, which is the recommend way now.
+2. [OpenSSL enc](./openssl.md) format
+
+Here is also the [comparation](./comparation.md).

docs/encryption/comparation.md

@@ -0,0 +1,23 @@
+# Comparation Between Encryption Formats
+
+## Warning
+
+**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
+
+If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
+
+## The feature table
+
+|                          | RClone Crypt                                                                               | OpenSSL enc                                                    | comments                                                                                                                                                            |
+| ------------------------ | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| key generation           | scrypt with fixed salt                                                                     | PBKDF2 with dynamic salt                                       | scrypt is better than PBKDF2 from the algorithm aspect. But RClone uses fixed salt by default. Also the parameters might affect the result.                         |
+| content encryption       | XSalsa20Poly1305 on chunks                                                                 | AES-256-CBC                                                    | XSalsa20Poly1305 is way better than AES-256-CBC. And encryption by chunks should require less resources.                                                            |
+| file name encryption     | EME on each segment of the path                                                            | AES-256-CBC on the whole path                                  | RClone has the benefit as well as pitfall that the path structure is preserved. Maybe it's more of a design decision difference? No comment on EME and AES-256-CBC. |
+| viewing decrypted result | RClone has command that can mount the encrypted vault as if the encryption is transparent. | No convenient way except writing some scripts we are aware of. | RClone is way more convenient.                                                                                                                                      |
+
+## Some notes
+
+1. Anyway, security is a hard problem. The author of Remotely Save doesn't have sufficient knowledge to "judge" which one is the better format. **Use them at your own risk.**
+2. Currently the RClone Crypt format is recommended by default in Remotely Save. Just because of the taste from the Remotely Save author, who likes RClone.
+3. **Always use a long password.**
+4. Both algorithms are selected deliberately to **be compatible with some well-known third-party tools** (instead of some home-made methods) and **have many tests to ensure the correctness**.

docs/encryption/openssl.md

@@ -1,10 +1,22 @@
-# Encryption
+# OpenSSL enc format
 
 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.
+## Warning
 
-1. The encryption algorithm is implemented using web-crypto.
+**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
+
+If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
+
+## Comparation between encryption formats
+
+See the doc [Comparation](./comparation.md).
+
+## Interoperability with official OpenSSL
+
+This encryption algorithm is delibrately designed to be aligned with openssl format.
+
+1. The encryption algorithm is implemented using web-crypto. Using AES-256-CBC.
 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

docs/encryption/rclone.md

@@ -0,0 +1,46 @@
+# RClone Crypt format
+
+The encryption is compatible with RClone Crypt with **base64** name encryption format.
+
+It's developed based on another js project by the same author of Remotely Save: [`@fyears/rclone-crypt`](https://github.com/fyears/rclone-crypt), which is NOT an official library from RClone, and is NOT affiliated with RClone.
+
+Reasonable tests are also ported from official RClone code, to ensure the compatibility and correctness of the encryption.
+
+## Warning
+
+**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
+
+If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
+
+## Comparation between encryption formats
+
+See the doc [Comparation](./comparation.md).
+
+## Interoperability with official RClone
+
+Please pay attention that the plugin uses **base64** of encrypted file names, while official RClone by default uses **base32** file names. The intention is purely for potentially support longer file names.
+
+You could set up the RClone profile by calling `rclone config`. You need to create two profiles, one for your original connection and the other for RClone Crypt.
+
+Finally, a working config file should like this:
+
+```ini
+[webdav1]
+type = webdav
+url = https://example.com/sharefolder1/subfolder1 # the same as the web address in Remotely Save settings.
+vendor = other
+user = <some webdav username>
+pass = <some webdav password, obfuscated>
+
+[webdav1crypt]
+type = crypt
+remote = nas1test:vaultname # the same as your "Remote Base Directory" (usually the vault name) in Remotely Save settings
+password = <some encryption password, obfuscated>
+filename_encoding = base64 # don't forget this!!!
+```
+
+You can use the `mount` command to view and see the files in file explorer! On Windows, the command should like this (the remote vault is mounted to drive `X:`):
+
+```bash
+rclone mount webdav1crypt: X: --network-mode
+```

docs/how_to_debug/README.md

@@ -12,8 +12,8 @@ See [here](./export_sync_plans.md).
 
 See [here](./check_console_output.md).
 
-## Advanced: Save Console Output Then Read Them Later
+## Advanced: Use `Logstravaganza` to export logs
 
-This method works for desktop and mobile devices (iOS, Android).
+This method works for desktop and mobile devices (iOS, Android), especially useful for iOS.
 
-See [here](./save_console_output_and_export.md).
+See [here](./use_logstravaganza.md).

docs/how_to_debug/save_console_output_and_export.md

@@ -1,25 +0,0 @@
-# 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/how_to_debug/use_logstravaganza.md

@@ -0,0 +1,14 @@
+# Use `Logstravaganza`
+
+On iOS, it's quite hard to directly check the console logs.
+
+Luckily, there is a third-party plugin: [`Logstravaganza`](https://obsidian.md/plugins?search=Logstravaganza#), by Carlo Zottmann, that can redirect the output to a note.
+
+You can just:
+
+1. Install it.
+2. Enable it.
+3. Do something, to trigger some console logs.
+4. Checkout `LOGGING-NOTE (device name).md` in the root of your vault.
+
+See more on its site: <https://github.com/czottmann/obsidian-logstravaganza>.

docs/linux.md

@@ -0,0 +1,56 @@
+# How to receive `obsidian://` in Linux
+
+## Background
+
+For example, when we are authorizing OneDrive, we have to jump back to Obsidian automatically using `obsidian://`.
+
+## Short Desc From Official Obsidian Doc
+
+Official doc has some explanation:
+
+<https://help.obsidian.md/Extending+Obsidian/Obsidian+URI#Register+Obsidian+URI>
+
+# Long Desc
+
+Assuming the username is `somebody`, and the `.AppImage` file is downloaded to `~/Desktop`.
+
+1. Download and **extract** the app image file in terminal
+
+   ```bash
+   cd /home/somebody/Desktop
+   chmod +x Obsidian-x.y.z.AppImage
+   ./Obsidian-x.y.z.AppImage --appimage-extract
+
+   # you should have the folder squashfs-root
+   # we want to rename it
+   mv squashfs-root Obsidian
+   ```
+
+2. Create a `.desktop` file
+
+   ```bash
+   # copy and paste the follow MULTI LINE command
+   # you might need to input your password because it requires root privilege
+   # remember to adjust the path
+   cat > ~/Desktop/obsidian.desktop <<EOF
+   [Desktop Entry]
+   Name=Obsidian
+   Comment=obsidian
+   Exec=/home/somebody/Desktop/Obsidian/obsidian %u
+   Keywords=obsidian
+   StartupNotify=true
+   Terminal=false
+   Type=Application
+   Icon=/home/somebody/Desktop/Obsidian/obsidian.png
+   MimeType=x-scheme-handler/obsidian;
+   EOF
+
+   # yeah we can check out the output
+   cat ~/Desktop/obsidian.desktop
+   ## [Desktop Entry]
+   ## ...
+   ```
+
+3. Right click the `obsidian.desktop` file on the Desktop, and click "Allow launching"
+
+4. Double click the `obsidian.desktop` file.

docs/minimal_intrusive_design.md

@@ -1,8 +1,10 @@
 # Minimal Intrusive Design
 
-Before version 0.3.0, the plugin did not upload additional meta data to the remote.
+~~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.
+~~From version 0.3.0 ~ 0.3.40, the plugin just upload minimal extra necessary meta data to the remote.~~
+
+From version 0.4.1 and above, the plugin doesn't need uploading meta data due to the sync algorithm upgrade.
 
 ## Benefits
 
@@ -12,10 +14,14 @@ For example, it's possbile for a uses to manually upload a file to s3, and next
 
 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
+## ~~Necessarity Of Uploading Extra Metadata from 0.3.0 ~ 0.3.40~~
 
-The main issue comes from deletions (and renamings which is actually interpreted as "deletion-then-creation").
+~~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.
+~~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.
+~~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.~~
+
+## No uploading extra metadata from 0.4.1
+
+Some information, including previous successful sync status of each file, is kept locally.

docs/remote_services/onedrive/README.md

@@ -0,0 +1,23 @@
+# OneDrive
+
+- **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).
+- 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**.
+- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
+
+## FAQ
+
+### How about OneDrive for Business?
+
+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.
+
+### I cannot find `/Apps/remotely-save` folder
+
+Mystically some users report that their OneDrive generate `/Application/Graph` instead of `/Apps/remotely-save`. See [#517](https://github.com/remotely-save/remotely-save/issues/517).
+
+The solution is simple:
+
+1. Backup your vault manually.
+2. Go to onedrive website (<https://onedrive.live.com/>), and rename `/Application/Graph` to `/Application/remotely-save` (right click on the folder and you will see rename option)
+3. Come back to Obsidian and try to sync!

docs/remote_services/s3_backblaze_b2/README.md

@@ -0,0 +1,53 @@
+# Backblaze B2
+
+## Links
+
+https://www.backblaze.com/cloud-storage
+
+## Steps
+
+1. Create a Backblaze account [on this page](https://www.backblaze.com/cloud-storage). Credit card info _is not_ required. Backblaze B2 offers 10 GB of free storage.
+
+2. Please be aware that, though B2 provides some free quota, **it may still cost you money if the usage of storage or api requests exceed a certain value!!!** Especially pay attention to the api requests!!!
+
+3. Create a **bucket**, you can leave the default settings, or you can enable the encryption (which is different from what you can set in Remotely Save):
+
+   ![](./s3_backblaze_b2-1-bucket.png)
+   ![](./s3_backblaze_b2-2-create_bucket.png)
+
+4. Copy `Endpoint`, eg. `s3.us-east-005.backblazeb2.com` — it'll be used later.
+
+5. Copy `bucketname` near the 🪣 icon (the "bucket icon") — it'll be used later.
+
+   ![](./s3_backblaze_b2-3-copy.png)
+
+6. Go to **Application Keys**:
+
+   ![](./s3_backblaze_b2-4-app_keys.png)
+
+7. **Add a new key**:
+
+   ![](./s3_backblaze_b2-5-add_new_app_keys.png)
+   ![](./s3_backblaze_b2-6-app_keys_copy.png)
+
+8. Save `keyID` and `applicationKey` — they will be used later.
+
+9. Go to Remotely Save settings in Obsidian and:
+
+   - Choose `S3 or compatibile` in **Remote Service**:
+   - Copy `Endpoint` from Backblaze (see 3. above) to `Endpoint` in Remotely Save
+   - From `endpoint` take `region` (eg. `us-east-005`) and paste it in `endpoint` in Remotely Save
+   - Copy `keyID` (see 7. above) to `Access Key ID` in Remotely Save
+   - Copy `applicationKey` (see 7. above) to `Secret Access Key` in Remotely Save
+   - Copy `bucketname` (see 4. above) to `Bucket Name` in Remotely Save
+     ![](./s3_backblaze_b2-7-copy_paste.png)
+
+10. **Enable Bypass CORS**:
+    ![](./s3_backblaze_b2-8-cors.png)
+
+11. Click **Check** in _Check Connectivity_ to see if you can connect to B2 bucket:
+    ![](./s3_backblaze_b2-9-check_connectionpng.png)
+
+12. Sync!
+
+    ![](./s3_backblaze_b2-10-sync.png)

docs/remote_services/s3_backblaze_b2/s3_backblaze_b2-1-bucket.png

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

docs/remote_services/s3_backblaze_b2/s3_backblaze_b2-10-sync.png

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

docs/remote_services/s3_backblaze_b2/s3_backblaze_b2-2-create_bucket.png

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

docs/remote_services/s3_backblaze_b2/s3_backblaze_b2-3-copy.png

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

docs/remote_services/s3_backblaze_b2/s3_backblaze_b2-4-app_keys.png

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

docs/remote_services/s3_backblaze_b2/s3_backblaze_b2-5-add_new_app_keys.png

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

docs/remote_services/s3_backblaze_b2/s3_backblaze_b2-6-app_keys_copy.png

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

docs/remote_services/s3_backblaze_b2/s3_backblaze_b2-7-copy_paste.png

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

docs/remote_services/s3_backblaze_b2/s3_backblaze_b2-8-cors.png

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

docs/remote_services/s3_backblaze_b2/s3_backblaze_b2-9-check_connectionpng.png

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

docs/remote_services/s3_cloudflare_r2/README.md

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

docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_api_token.png

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

docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_bucket.png

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

docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_rs_settings.png

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

docs/remote_services/s3_general/s3_user_policy.md

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

docs/remote_services/s3_minio/README.md

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

docs/remote_services/s3_minio/minio_access_key.png

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

docs/remote_services/s3_minio/minio_create_bucket.png

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

docs/remote_services/s3_minio/minio_custom_port.png

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

docs/remote_services/s3_minio/minio_region.png

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

docs/remote_services/s3_minio/minio_rs_settings.png

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

docs/remote_services/s3_minio/minio_sync_success.png

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

docs/remote_services/s3_storj_io/README.md

@@ -0,0 +1,17 @@
+# Storj
+
+## Links
+
+<https://www.storj.io/>
+
+## Steps
+
+1. Register an account. Login.
+2. Create a bucket.
+3. Create S3 Credentials in Access Management. Allow all permissions for the bucket. Remember the access key and secret key and the end point. The end point is likely to be [`https://gateway.storjshare.io`](https://docs.storj.io/dcs/api/s3/s3-compatible-gateway).
+   ![](./storj_create_s3_cred_1.png)
+   ![](./storj_create_s3_cred_2.png)
+4. Input your credentials into remotely-save settings. Region [should be `global`](https://docs.storj.io/dcs/api/s3/s3-compatibility).
+   ![](storj_remotely_save_settings.png)
+5. Check connectivity.
+6. Sync!

docs/remote_services/s3_storj_io/storj_create_s3_cred_1.png

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

docs/remote_services/s3_storj_io/storj_create_s3_cred_2.png

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

docs/remote_services/s3_storj_io/storj_remotely_save_settings.png

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

docs/remote_services/s3_tencent_cloud_cos/README.md

@@ -0,0 +1,23 @@
+# Tencent Cloud COS
+
+English | [中文](./README.zh-cn.md)
+
+## Link
+
+- international <https://console.tencentcloud.com/cos>
+
+## 步骤 Steps
+
+The example shows the steps of China version. International version should be similar.
+
+1. Create a bucket with **private read-write permissions** and recommendly enable server-side-encryption.
+2. In bucket list page, enter the bucket overview page of the bucket you just created. You should see the bucket name (your texts with the number of your account id), region, and access address.
+   ![](./cos_bucket_info.png)
+3. In CAM page, create api key, and note down the SecretID and SecretKey.
+   ![](./cos_create_secret.png)
+4. **Remove the bucket name from your access address to obtain your endpoint address! If your access address on the website is `https://<bucket-name-with-number>.cos.<region>.myqcloud.com`, then the endpoint address you are going to use is `https://cos.<region>.myqcloud.com`.**
+5. In remotely-save settings page, enter your endpoint adress, SecretID, SecretKey,and bucket name.
+   ![](./cos_setting.png)
+6. Check Connectivity.
+   ![](./cos_connection.png)
+7. Sync!

docs/remote_services/s3_tencent_cloud_cos/README.zh-cn.md

@@ -0,0 +1,23 @@
+# 腾讯云 COS
+
+[English](./README.md) | 中文
+
+## 链接
+
+- 中国区 <https://console.cloud.tencent.com/cos>
+
+## 步骤
+
+注意这里用中国区示例，国际区配置应该类似。
+
+1. 在“存储桶列表”页，[“创建存储桶”](https://console.cloud.tencent.com/cos/bucket?action=create)。注意创建**私有读写**，建议打开服务端加密。
+2. 在桶列表页，点击刚刚存储的桶，进入概览页。可以见到桶名称（一般来说是之前指定的英文加账号数字），地域，访问域名。记录下来。
+   ![](./cos_bucket_info.png)
+3. 在[“访问管理页”](https://console.cloud.tencent.com/cam/capi) ，“API 密钥管理”，“创建密钥”，要记录 SecretID 和 SecretKey。
+   ![](./cos_create_secret.png)
+4. **把桶名称从访问域名移除，才是你即将输入的服务地址！假如你在腾讯云网站看到访问域名是 `https://<bucket-name-with-number>.cos.<region>.myqcloud.com`，那么“服务地址”是 `https://cos.<region>.myqcloud.com`.**
+5. 在 remotely-save 设置，输入服务地址，SecretID，SecretKey，和 桶名称。
+   ![](./cos_setting.png)
+6. 检查连接。
+   ![](./cos_connection.png)
+7. 可以同步了！

docs/remote_services/s3_tencent_cloud_cos/cos_bucket_info.png

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

docs/remote_services/s3_tencent_cloud_cos/cos_connection.png

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

docs/remote_services/s3_tencent_cloud_cos/cos_create_secret.png

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

docs/remote_services/s3_tencent_cloud_cos/cos_setting.png

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

docs/remote_services/s3_upyun/README.zh-cn.md

@@ -0,0 +1,19 @@
+# 又拍云
+
+## 链接
+
+* 官网 <https://www.upyun.com/>
+* 官网的 S3 文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/>
+
+## 步骤
+
+1. 注册，新建对象存储。
+2. 参考官网文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/>，创建操作员然后创建 S3 访问凭证。
+3. 在 Remotely Save 设置以下：
+    * 服务地址（Endpoint）：`s3.api.upyun.com`  **一定是这个域名**
+    * 区域（Region）：`us-east-1`
+    * Acccess Key ID：您获取到的访问凭证的 AccessKey
+    * Secret Access Key：您获取到的访问凭证的 SecretAccessKey
+    * 存储桶（Bucket）的名字：您创建的“服务名”
+    * 是否生成文件夹 Object：不生成（默认） **一定要选择不生成**
+4. 同步。

docs/remote_services/webdav_alist/README.md

@@ -0,0 +1,23 @@
+# AList
+
+English | [中文](./README.zh-cn.md)
+
+## Links
+
+- English official website: <https://alist.nn.ci/> and <https://alist.nn.ci/guide/webdav.html>
+
+## Steps
+
+1. Install and run AList. Get the account and password. Login using the web page.
+2. Add new storage. Pay attention to the mount path. The screenshot shows the mount path as `/alisttest davpath`.
+   ![](./alist_mount_path.zh.png)
+   ![](./alist_mount_path.en.png)
+3. Construct the webdav address as: **http(s)://domain** + **port** + **`/dav`** + **mount path**, and the space inside the mount path should be replaced with `%20`:
+   ```
+   http[s]://domain:port/dav/[mountpath url encoded]
+   http://127.0.0.1:5244/dav/alisttest%20davpath
+   ```
+4. In remotely-save setting page, select webdav type, then input the **full address with mount path**/account/password.
+   ![](./alist_rs_settings.en.png)
+5. In remotely-save setting page, click "Check Connectivity".
+6. Sync!

docs/remote_services/webdav_alist/README.zh-cn.md

@@ -0,0 +1,23 @@
+# AList
+
+[English](./README.md) | 中文
+
+## 链接
+
+- 中文官网：<https://alist.nn.ci/zh/> 和 <https://alist.nn.ci/zh/guide/webdav.html>
+
+## 步骤
+
+1. 安装和使用 AList。获取账号名和密码。在网页上登录。
+2. 新建挂载，检查挂载路径。如图所示是 `/alisttest davpath`。
+   ![](./alist_mount_path.zh.png)
+   ![](./alist_mount_path.en.png)
+3. 从而构建 webdav 网址如下，**http(s)://域名** + **端口** + **`/dav`** + **挂载路径**，其中挂载路径中假如有空格，换成 `%20`：
+   ```
+   http[s]://domain:port/dav/[mountpath url encoded]
+   http://127.0.0.1:5244/dav/alisttest%20davpath
+   ```
+4. 在 remotely-save 设置，输入**带域名端口`/dav`和挂载路径的网址**、账号、密码。
+   ![](./alist_rs_settings.en.png)
+5. 在 remotely-save 设置，检查连接。
+6. 同步文件！

docs/remote_services/webdav_alist/alist_mount_path.en.png

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

docs/remote_services/webdav_alist/alist_mount_path.zh.png

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

docs/remote_services/webdav_alist/alist_rs_settings.en.png

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

docs/remote_services/webdav_general/webav_cors.md

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

docs/remote_services/webdav_infinicloud_teracloud/README.md

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

docs/remote_services/webdav_infinicloud_teracloud/infinicloud_account.png

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

docs/remote_services/webdav_infinicloud_teracloud/infinicloud_rs_setting.png

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

docs/remote_services/webdav_jianguoyun/README.md

@@ -0,0 +1,22 @@
+# JianGuoYun/NutStore
+
+English | [中文](./README.zh-cn.md)
+
+## Link
+
+<https://www.jianguoyun.com/>
+
+## Attentions!!!
+
+JianGuoYun/NutStore has api limits. The plugin may generate many queries, and it's possible to reach the api limits if there are many files, then do not work properly. It's not a bug and there's no way to fix this situation.
+
+## Steps
+
+1. **Be aware that JianGuoYun/NutStore has api limits, and the plugin may not work properly because of this.**
+2. Register an account.
+3. Go to "settings"->"Security", click "Add Application", then obtain the WebDAV account (email), and WebDAV password (a string different from web site password).
+   ![](./webdav_jianguoyun.cn.png)
+4. Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
+   ![](./webdav_jianguoyun_rs_settting.cn.png)
+5. In remotely-save setting page, click "Check Connectivity".
+6. Sync!

docs/remote_services/webdav_jianguoyun/README.zh-cn.md

@@ -0,0 +1,22 @@
+# 坚果云
+
+[English](./README.md) | 中文
+
+## 链接
+
+<https://www.jianguoyun.com/>
+
+## 注意！！！
+
+坚果云有限制 api 数量等设定。本插件会产生若干查询，如果文件较多很容易触发 api 上限，从而工作不正常。这不是插件 bug，也没有办法解决。
+
+## 步骤
+
+1. **知悉坚果云有 api 限制，本插件可能因此工作不正常。**
+2. 注册账号，登录。
+3. 去“个人信息”->“安全”，“添加应用”，从而获取了 webDAV 账号（应该是 email）和 WebDAV 密码（一串特殊的字符，不等于网站密码）。
+   ![](./webdav_jianguoyun.cn.png)
+4. 在 remotely-save 设置，输入网址、账号、密码、**“发送到服务器的 Depth Header”设置为“只支持 depth='1'”**。
+   ![](./webdav_jianguoyun_rs_settting.cn.png)
+5. 在 remotely-save 设置，检查连接。
+6. 同步文件！

docs/remote_services/webdav_jianguoyun/webdav_jianguoyun.cn.png

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

docs/remote_services/webdav_jianguoyun/webdav_jianguoyun_rs_settting.cn.png

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

docs/remote_services/webdav_owncloud/README.md

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

docs/remote_services/webdav_owncloud/owncloud_address.png

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

docs/remote_services/webdav_owncloud/owncloud_files.png

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

docs/remote_services/webdav_owncloud/owncloud_rs_settings.png

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

docs/remote_services/webdav_synology_webdav_server/README.md

@@ -0,0 +1,55 @@
+# Synology Webdav Server
+
+English | [中文](./README.zh-cn.md)
+
+## Link
+
+<https://kb.synology.com/en-global/DSM/tutorial/How_to_access_files_on_Synology_NAS_with_WebDAV>
+
+## Attention
+
+The tutorial author (the author of Remotely Save) is NOT an expert of NAS / Synology. Please read the doc carefully and change it to accommodate your needs by yourself.
+
+**It's dangerous to expose your NAS into public Internet if you don't know how to set up firewalls and other protections.**
+
+## Steps
+
+Synology DSM 7 is used in this tutorial.
+
+1. Create a new shared folder if you don't have one. For this tutorial, a new shared folder `share2` is created. You should assing a proper user to read / write the shared folder.
+   ![](./synology_create_shared_folder.png)
+
+2. Assuming you want to sync your vault into sub folder `哈哈哈/sub folder`, please create the sub folder(s) correspondingly inide the shared folder `share2`.
+
+3. Install webdav server from package center.
+   ![](./synology_install_webdav_server.png)
+
+4. Enter the webdav server settings.
+
+5. If you know how to configure https certificates correctly, you are strongly recommend to enable https.
+
+   For the demonstration purpose, this tutorial enable http server for the later steps.
+
+   Also "Enable DavDepthInfinity", which could speed up the plugin runnings greatly.
+
+   "Apply".
+
+   ![](./synology_webdav_server_settings.png)
+
+6. In Remotely Save settings, you should input your address as:
+
+   `http(s)://<your synology ip or domain>:<port>/<shared folder>/<sub folders>`
+
+   For example, in the tutorial, the proper url should be:
+
+   `http://<ip>:5000/share2/哈哈哈/sub folder`
+
+   Username and password should be the user you configured before with read / write permissions to `share2`.
+
+   Depth header should be "supports depth="infinity"".
+
+   Check connectivity!
+
+   ![](./synology_remotely_save_settings.png)
+
+7. Sync!

docs/remote_services/webdav_synology_webdav_server/README.zh-cn.md

@@ -0,0 +1,56 @@
+# 群晖 Webdav Server
+
+[English](./README.md) | 中文
+
+## 链接
+
+<https://kb.synology.cn/zh-cn/DSM/tutorial/How_to_access_files_on_Synology_NAS_with_WebDAV>
+
+## 注意
+
+教程作者（Remotely Save 作者）**不是** NAS、群晖专家。请仔细阅读文档，并自行改动以适应您自身需求。
+
+**没有设置防火墙和其他保护措施的话，将 NAS 暴露到公网上非常危险。**
+
+## 步骤
+
+本教程有用到群晖 DSM 7。
+
+1. 创建共享文件夹。本教程示例创建了 `share2`。你需要允许某个账号对此的读写权限。
+
+   ![](./synology_create_shared_folder.png)
+
+2. 假设之后你想同步你的库到子文件夹，`哈哈哈/sub folder`，请先在共享文件夹 `share2` 底下创建好。
+
+3. 从套件中心安装 webdav server 。
+   ![](./synology_install_webdav_server.png)
+
+4. 进入 webdav server 设置。
+
+5. 如果你知道如何正确配置 https 证书的话，强烈建议开启 https。
+
+   本教程简化示例，开启了 http。
+
+   也设置“Enable DavDepthInfinity”，这可以加速插件连接速度。
+
+   “Apply”。
+
+   ![](./synology_webdav_server_settings.png)
+
+6. 在 Remotely Save 设置页，你的地址应如下格式输入：
+
+   `http(s)://<your synology ip or domain>:<port>/<shared folder>/<sub folders>`
+
+   比如说，本教程里，正确的地址类似于：
+
+   `http://<ip>:5000/share2/哈哈哈/sub folder`
+
+   用户名和密码是你之前配置了允许读写 `share2` 的那个账号。
+
+   Depth 设置应为“supports depth="infinity"”。
+
+   检查连接！
+
+   ![](./synology_remotely_save_settings.png)
+
+7. 同步！

docs/remote_services/webdav_synology_webdav_server/synology_create_shared_folder.png

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

docs/remote_services/webdav_synology_webdav_server/synology_install_webdav_server.png

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

docs/remote_services/webdav_synology_webdav_server/synology_remotely_save_settings.png

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

docs/remote_services/webdav_synology_webdav_server/synology_webdav_server_settings.png

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

docs/services_connectable_or_not.md

@@ -18,7 +18,7 @@ The list is for information purposes only.
 | [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.                       |
+| 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.                                 |
@@ -26,7 +26,7 @@ The list is for information purposes only.
 | [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 |       |           | ?                                                                |                                          |                                                  |
+| OneDrive for Business                                                                 | Yes         |       |           | ?                                                                |                                          |                                                  |
 | Google Drive                                                                          | In the plan |       |           | ?                                                                |                                          |                                                  |
 | [Box](https://www.box.com/)                                                           | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |
 | Google Cloud Storage                                                                  | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |

docs/sync_algorithm/README.md

@@ -0,0 +1,7 @@
+# Sync Algorithm
+
+- [v1](./v1/README.md)
+- [v2](./v2/README.md)
+- v3
+  - [intro doc for end users](./v3/intro.md)
+  - [design doc](./v3/design.md)

docs/sync_algorithm/sync_ignoring_large_files.md

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

docs/sync_algorithm/v3/README.md

@@ -0,0 +1,4 @@
+# Sync Algorithm V3
+
+- [intro doc for end users](./intro.md)
+- [design doc](./design.md)

docs/sync_algorithm/v3/design.md

@@ -0,0 +1,71 @@
+# Sync Algorithm V3
+
+Drafted on 20240117.
+
+An absolutely better sync algorithm. Better for tracking deletions and better for subbranching.
+
+## Huge Thanks
+
+Basically a combination of algorithm v2 + [synclone](https://github.com/Jwink3101/syncrclone/blob/master/docs/algorithm.md) + [rsinc](https://github.com/ConorWilliams/rsinc) + (some of rclone [bisync](https://rclone.org/bisync/)). All of the later three are released under MIT License so no worries about the licenses.
+
+## Features
+
+Must have
+
+1. true deletion detection
+2. deletion protection (blocking) with a setting
+3. transaction from the old algorithm
+4. user warning show up, **new algorithm needs all clients to be updated!** (deliberately corrput the metadata file??)
+5. filters
+6. conflict warning
+7. partial sync
+
+Nice to have
+
+1. true time and hash
+2. conflict rename
+
+## Description
+
+We have _five_ input sources:
+
+1. local all files
+2. remote all files
+3. _local previous succeeded sync history_
+4. local deletions
+5. remote deletions.
+
+Init run, consuming remote deletions :
+
+Change history data into _local previous succeeded sync history_.
+
+Later runs, use the first, second, third sources **only**.
+
+Bidirectional table is modified based on synclone and rsinc. Incremental push / pull only tables is further modified based on the bidirectional table. The number inside the table cell is the decision branch in the code.
+
+Bidirectional:
+
+| local\remote    | remote unchanged   | remote modified           | remote deleted     | remote created            |
+| --------------- | ------------------ | ------------------------- | ------------------ | ------------------------- |
+| local unchanged | (02/21) do nothing | (09) pull                 | (07) delete local  | (??) conflict             |
+| local modified  | (10) push          | (16/17/18/19/20) conflict | (08) push          | (??) conflict             |
+| local deleted   | (04) delete remote | (05) pull                 | (01) clean history | (03) pull                 |
+| local created   | (??) conflict      | (??) conflict             | (06) push          | (11/12/13/14/15) conflict |
+
+Incremental push only:
+
+| local\remote    | remote unchanged             | remote modified              | remote deleted         | remote created               |
+| --------------- | ---------------------------- | ---------------------------- | ---------------------- | ---------------------------- |
+| local unchanged | (02/21) do nothing           | **(26) conflict push**       | **(32) conflict push** | (??) conflict                |
+| local modified  | (10) push                    | **(25) conflict push**       | (08) push              | (??) conflict                |
+| local deleted   | **(29) conflict do nothing** | **(30) conflict do nothing** | (01) clean history     | **(28) conflict do nothing** |
+| local created   | (??) conflict                | (??) conflict                | (06) push              | **(23) conflict push**       |
+
+Incremental pull only:
+
+| local\remote    | remote unchanged       | remote modified        | remote deleted               | remote created         |
+| --------------- | ---------------------- | ---------------------- | ---------------------------- | ---------------------- |
+| local unchanged | (02/21) do nothing     | (09) pull              | **(33) conflict do nothing** | (??) conflict          |
+| local modified  | **(27) conflict pull** | **(24) conflict pull** | **(34) conflict do nothing** | (??) conflict          |
+| local deleted   | **(35) conflict pull** | (05) pull              | (01) clean history           | (03) pull              |
+| local created   | (??) conflict          | (??) conflict          | **(31) conflict do nothing** | **(22) conflict pull** |

docs/sync_algorithm/v3/intro.md

@@ -0,0 +1,14 @@
+# Introduction To Sync Algorithm V3
+
+- [x] sync conflict: keep newer
+- [x] sync conflict: keep larger
+- [ ] sync conflict: keep both and rename
+- [ ] sync conflict: show warning
+- [x] deletion: true deletion status computation
+- [x] meta data: no remote meta data any more
+- [x] migration: old data auto transfer to new db (hopefully)
+- [x] sync direction: incremental push only
+- [x] sync direction: incremental pull only
+- [x] sync protection: warning based on the threshold
+- [ ] partial sync: better sync on save
+- [x] encrpytion: new encryption method, see [this](../../encryption/)

esbuild.config.mjs

@@ -1,6 +1,7 @@
 import dotenv from "dotenv/config";
 import esbuild from "esbuild";
 import process from "process";
+import inlineWorkerPlugin from "esbuild-plugin-inline-worker";
 // import builtins from 'builtin-modules'
 
 const banner = `/*
@@ -18,7 +19,7 @@ const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
 const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
 
 esbuild
-  .build({
+  .context({
     banner: {
       js: banner,
     },
@@ -33,11 +34,14 @@ esbuild
       "fs",
       "tls",
       "net",
+      "http",
+      "https",
+      "vm",
       // ...builtins
     ],
     inject: ["./esbuild.injecthelper.mjs"],
     format: "cjs",
-    watch: !prod,
+    // watch: !prod, // no longer valid in esbuild 0.17
     target: "es2016",
     logLevel: "info",
     sourcemap: prod ? false : "inline",
@@ -52,5 +56,17 @@ esbuild
       "process.env.NODE_DEBUG": `undefined`, // ugly fix
       "process.env.DEBUG": `undefined`, // ugly fix
     },
+    plugins: [inlineWorkerPlugin()],
+  })
+  .then((context) => {
+    if (process.argv.includes("--watch")) {
+      // Enable watch mode
+      context.watch();
+    } else {
+      // Build once and exit if not in watch mode
+      context.rebuild().then((result) => {
+        context.dispose();
+      });
+    }
   })
   .catch(() => process.exit(1));

manifest-beta.json

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

manifest.json

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

package.json

@@ -1,13 +1,13 @@
 {
   "name": "remotely-save",
-  "version": "0.3.20",
+  "version": "0.4.16",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
-    "dev2": "node esbuild.config.mjs",
+    "dev2": "node esbuild.config.mjs --watch",
     "build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
     "build": "webpack --mode production",
     "dev": "webpack --mode development --watch",
-    "format": "npx prettier --write .",
+    "format": "npx prettier --trailing-comma es5 --write .",
     "clean": "npx rimraf main.js",
     "test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'"
   },
@@ -16,80 +16,82 @@
     "process": "process/browser",
     "stream": "stream-browserify",
     "crypto": "crypto-browserify",
-    "url": "url/"
+    "url": "url/",
+    "fs": false,
+    "vm": false
   },
   "source": "main.ts",
   "keywords": [],
   "author": "",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@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.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",
+    "@microsoft/microsoft-graph-types": "^2.40.0",
+    "@types/chai": "^4.3.14",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/jsdom": "^21.1.6",
+    "@types/lodash": "^4.17.0",
+    "@types/mime-types": "^2.1.4",
+    "@types/mocha": "^10.0.6",
+    "@types/mustache": "^4.2.5",
+    "@types/node": "^20.12.7",
+    "@types/qrcode": "^1.5.5",
+    "builtin-modules": "^3.3.0",
     "cross-env": "^7.0.3",
-    "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",
+    "dotenv": "^16.4.5",
+    "esbuild": "^0.20.2",
+    "esbuild-plugin-inline-worker": "^0.1.1",
+    "jsdom": "^24.0.0",
+    "mocha": "^10.4.0",
+    "npm-check-updates": "^16.14.20",
+    "obsidian": "^1.5.7",
+    "prettier": "^3.2.5",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
+    "typescript": "^5.4.5",
     "webdav-server": "^2.6.2",
-    "webpack": "^5.72.0",
-    "webpack-cli": "^4.9.2"
+    "webpack": "^5.91.0",
+    "webpack-cli": "^5.1.4",
+    "worker-loader": "^3.0.8"
   },
   "dependencies": {
-    "@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",
+    "@aws-sdk/client-s3": "^3.563.0",
+    "@aws-sdk/lib-storage": "^3.563.0",
+    "@aws-sdk/signature-v4-crt": "^3.556.0",
+    "@aws-sdk/types": "^3.535.0",
+    "@azure/msal-node": "^2.7.0",
+    "@fyears/rclone-crypt": "^0.0.7",
     "@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",
+    "@microsoft/microsoft-graph-client": "^3.0.7",
+    "@smithy/fetch-http-handler": "^2.5.0",
+    "@smithy/protocol-http": "^3.3.0",
+    "@smithy/querystring-builder": "^2.2.0",
+    "acorn": "^8.11.3",
+    "aggregate-error": "^5.0.0",
+    "assert": "^2.1.0",
+    "aws-crt": "^1.21.2",
     "buffer": "^6.0.3",
     "crypto-browserify": "^3.12.0",
-    "delay": "^5.0.0",
-    "dropbox": "^10.28.0",
-    "emoji-regex": "^10.1.0",
-    "http-status-codes": "^2.2.0",
+    "dropbox": "^10.34.0",
+    "emoji-regex": "^10.3.0",
+    "http-status-codes": "^2.3.0",
     "localforage": "^1.10.0",
+    "localforage-getitems": "^1.4.2",
     "lodash": "^4.17.21",
-    "loglevel": "^1.8.0",
-    "lucide": "^0.35.0",
+    "lucide": "^0.376.1",
     "mime-types": "^2.1.35",
     "mustache": "^4.2.0",
-    "nanoid": "^3.3.3",
-    "obsidian": "^0.14.6",
-    "p-queue": "^7.2.0",
+    "nanoid": "^5.0.7",
+    "p-queue": "^8.0.1",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
-    "qrcode": "^1.5.0",
-    "rfc4648": "^1.5.1",
-    "rimraf": "^3.0.2",
+    "qrcode": "^1.5.3",
+    "rfc4648": "^1.5.3",
+    "rimraf": "^5.0.5",
     "stream-browserify": "^3.0.0",
-    "url": "^0.11.0",
-    "util": "^0.12.4",
-    "webdav": "^4.9.0",
-    "webdav-fs": "^4.0.1",
-    "xregexp": "^5.1.0"
+    "url": "^0.11.3",
+    "util": "^0.12.5",
+    "webdav": "^5.6.0",
+    "xregexp": "^5.1.1"
   }
 }

src/baseTypes.ts

@@ -21,9 +21,20 @@ export interface S3Config {
   s3AccessKeyID: string;
   s3SecretAccessKey: string;
   s3BucketName: string;
-  bypassCorsLocally?: boolean;
+
   partsConcurrency?: number;
   forcePathStyle?: boolean;
+  remotePrefix?: string;
+
+  useAccurateMTime?: boolean;
+  reverseProxyNoSignUrl?: string;
+
+  generateFolderObject?: boolean;
+
+  /**
+   * @deprecated
+   */
+  bypassCorsLocally?: boolean;
 }
 
 export interface DropboxConfig {
@@ -40,9 +51,10 @@ export interface DropboxConfig {
 
 export type WebdavAuthType = "digest" | "basic";
 export type WebdavDepthType =
-  | "auto_unknown"
-  | "auto_1"
-  | "auto_infinity"
+  | "auto" // deprecated on 20240116
+  | "auto_unknown" // deprecated on 20240116
+  | "auto_1" // deprecated on 20240116
+  | "auto_infinity" // deprecated on 20240116
   | "manual_1"
   | "manual_infinity";
 
@@ -51,9 +63,14 @@ export interface WebdavConfig {
   username: string;
   password: string;
   authType: WebdavAuthType;
-  manualRecursive: boolean; // deprecated in 0.3.6, use depth
+
   depth?: WebdavDepthType;
   remoteBaseDir?: string;
+
+  /**
+   * @deprecated
+   */
+  manualRecursive: boolean; // deprecated in 0.3.6, use depth
 }
 
 export interface OnedriveConfig {
@@ -69,6 +86,15 @@ export interface OnedriveConfig {
   remoteBaseDir?: string;
 }
 
+export type SyncDirectionType =
+  | "bidirectional"
+  | "incremental_pull_only"
+  | "incremental_push_only";
+
+export type CipherMethodType = "rclone-base64" | "openssl-base64" | "unknown";
+
+export type QRExportType = "all_but_oauth2" | "dropbox" | "onedrive";
+
 export interface RemotelySavePluginSettings {
   s3: S3Config;
   webdav: WebdavConfig;
@@ -79,25 +105,43 @@ export interface RemotelySavePluginSettings {
   currLogLevel?: string;
   autoRunEveryMilliseconds?: number;
   initRunAfterMilliseconds?: number;
-  agreeToUploadExtraMetadata?: boolean;
+  syncOnSaveAfterMilliseconds?: number;
+
   concurrency?: number;
   syncConfigDir?: boolean;
   syncUnderscoreItems?: boolean;
   lang?: LangTypeAndAuto;
-  logToDB?: boolean;
+  agreeToUseSyncV3?: boolean;
+  skipSizeLargerThan?: number;
+  ignorePaths?: string[];
+  enableStatusBarInfo?: boolean;
+  deleteToWhere?: "system" | "obsidian";
+  conflictAction?: ConflictActionType;
+  howToCleanEmptyFolder?: EmptyFolderCleanType;
+
+  protectModifyPercentage?: number;
+  syncDirection?: SyncDirectionType;
+
+  obfuscateSettingFile?: boolean;
+
+  enableMobileStatusBar?: boolean;
+
+  encryptionMethod?: CipherMethodType;
+
+  /**
+   * @deprecated
+   */
+  agreeToUploadExtraMetadata?: boolean;
 
   /**
    * @deprecated
    */
   vaultRandomID?: string;
-}
 
-export interface RemoteItem {
-  key: string;
-  lastModified: number;
-  size: number;
-  remoteType: SUPPORTED_SERVICES_TYPE;
-  etag?: string;
+  /**
+   * @deprecated
+   */
+  logToDB?: boolean;
 }
 
 export const COMMAND_URI = "remotely-save";
@@ -115,21 +159,83 @@ export interface UriParams {
 // 80 days
 export const OAUTH2_FORCE_EXPIRE_MILLISECONDS = 1000 * 60 * 60 * 24 * 80;
 
-type DecisionTypeForFile =
-  | "skipUploading" // special, mtimeLocal === mtimeRemote
-  | "uploadLocalDelHistToRemote" // "delLocalIfExists && delRemoteIfExists && cleanLocalDelHist && uploadLocalDelHistToRemote"
-  | "keepRemoteDelHist" // "delLocalIfExists && delRemoteIfExists && cleanLocalDelHist && keepRemoteDelHist"
-  | "uploadLocalToRemote" // "skipLocal && uploadLocalToRemote && cleanLocalDelHist && cleanRemoteDelHist"
-  | "downloadRemoteToLocal"; // "downloadRemoteToLocal && skipRemote && cleanLocalDelHist && cleanRemoteDelHist"
+export type EmptyFolderCleanType = "skip" | "clean_both";
 
-type DecisionTypeForFolder =
-  | "createFolder"
-  | "uploadLocalDelHistToRemoteFolder"
-  | "keepRemoteDelHistFolder"
-  | "skipFolder";
+export type ConflictActionType = "keep_newer" | "keep_larger" | "rename_both";
 
-export type DecisionType = DecisionTypeForFile | DecisionTypeForFolder;
+export type DecisionTypeForMixedEntity =
+  | "only_history"
+  | "equal"
+  | "local_is_modified_then_push"
+  | "remote_is_modified_then_pull"
+  | "local_is_created_then_push"
+  | "remote_is_created_then_pull"
+  | "local_is_created_too_large_then_do_nothing"
+  | "remote_is_created_too_large_then_do_nothing"
+  | "local_is_deleted_thus_also_delete_remote"
+  | "remote_is_deleted_thus_also_delete_local"
+  | "conflict_created_then_keep_local"
+  | "conflict_created_then_keep_remote"
+  | "conflict_created_then_keep_both"
+  | "conflict_created_then_do_nothing"
+  | "conflict_modified_then_keep_local"
+  | "conflict_modified_then_keep_remote"
+  | "conflict_modified_then_keep_both"
+  | "folder_existed_both_then_do_nothing"
+  | "folder_existed_local_then_also_create_remote"
+  | "folder_existed_remote_then_also_create_local"
+  | "folder_to_be_created"
+  | "folder_to_skip"
+  | "folder_to_be_deleted_on_both"
+  | "folder_to_be_deleted_on_remote"
+  | "folder_to_be_deleted_on_local";
 
+/**
+ * uniform representation
+ * everything should be flat and primitive, so that we can copy.
+ */
+export interface Entity {
+  key?: string;
+  keyEnc?: string;
+  keyRaw: string;
+  mtimeCli?: number;
+  mtimeCliFmt?: string;
+  mtimeSvr?: number;
+  mtimeSvrFmt?: string;
+  prevSyncTime?: number;
+  prevSyncTimeFmt?: string;
+  size?: number; // might be unknown or to be filled
+  sizeEnc?: number;
+  sizeRaw: number;
+  hash?: string;
+  etag?: string;
+  synthesizedFolder?: boolean;
+}
+
+export interface UploadedType {
+  entity: Entity;
+  mtimeCli?: number;
+}
+
+/**
+ * A replacement of FileOrFolderMixedState
+ */
+export interface MixedEntity {
+  key: string;
+  local?: Entity;
+  prevSync?: Entity;
+  remote?: Entity;
+
+  decisionBranch?: number;
+  decision?: DecisionTypeForMixedEntity;
+  conflictAction?: ConflictActionType;
+
+  sideNotes?: any;
+}
+
+/**
+ * @deprecated
+ */
 export interface FileOrFolderMixedState {
   key: string;
   existLocal?: boolean;
@@ -139,10 +245,12 @@ export interface FileOrFolderMixedState {
   deltimeLocal?: number;
   deltimeRemote?: number;
   sizeLocal?: number;
+  sizeLocalEnc?: number;
   sizeRemote?: number;
+  sizeRemoteEnc?: number;
   changeRemoteMtimeUsingMapping?: boolean;
   changeLocalMtimeUsingMapping?: boolean;
-  decision?: DecisionType;
+  decision?: string; // old DecisionType is deleted, fallback to string
   decisionBranch?: number;
   syncDone?: "done";
   remoteEncryptedKey?: string;
@@ -156,6 +264,7 @@ export interface FileOrFolderMixedState {
 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 API_VER_ENSURE_REQURL_OK = "1.0.0"; // always bypass CORS here
 
 export const VALID_REQURL =
   (!Platform.isAndroidApp && requireApiVersion(API_VER_REQURL)) ||
@@ -165,5 +274,15 @@ 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 const DEFAULT_PROFILER_RESULT_FILE_PREFIX =
+  "profiler_results_exported_on_";
 
-export type SyncTriggerSourceType = "manual" | "auto" | "dry" | "autoOnceInit";
+export type SyncTriggerSourceType =
+  | "manual"
+  | "dry"
+  | "auto"
+  | "auto_once_init"
+  | "auto_sync_on_save";
+
+export const REMOTELY_SAVE_VERSION_2022 = "0.3.25";
+export const REMOTELY_SAVE_VERSION_2024PREPARE = "0.3.32";

src/configPersist.ts

@@ -3,8 +3,6 @@ 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.";
 
@@ -19,10 +17,10 @@ interface MessyConfigType {
 export const messyConfigToNormal = (
   x: MessyConfigType | RemotelySavePluginSettings | null | undefined
 ): RemotelySavePluginSettings | null | undefined => {
-  // log.debug("loading, original config on disk:");
-  // log.debug(x);
+  // console.debug("loading, original config on disk:");
+  // console.debug(x);
   if (x === null || x === undefined) {
-    log.debug("the messy config is null or undefined, skip");
+    console.debug("the messy config is null or undefined, skip");
     return x as any;
   }
   if ("readme" in x && "d" in x) {
@@ -35,12 +33,12 @@ export const messyConfigToNormal = (
         }) as Buffer
       ).toString("utf-8")
     );
-    // log.debug("loading, parsed config is:");
-    // log.debug(y);
+    // console.debug("loading, parsed config is:");
+    // console.debug(y);
     return y;
   } else {
     // return as is
-    // log.debug("loading, parsed config is the same");
+    // console.debug("loading, parsed config is the same");
     return x;
   }
 };
@@ -52,7 +50,7 @@ export const normalConfigToMessy = (
   x: RemotelySavePluginSettings | null | undefined
 ) => {
   if (x === null || x === undefined) {
-    log.debug("the normal config is null or undefined, skip");
+    console.debug("the normal config is null or undefined, skip");
     return x;
   }
   const y = {
@@ -63,7 +61,7 @@ export const normalConfigToMessy = (
       })
     ),
   };
-  // log.debug("encoding, encoded config is:");
-  // log.debug(y);
+  // console.debug("encoding, encoded config is:");
+  // console.debug(y);
   return y;
 };

src/debugMode.ts

@@ -1,100 +1,41 @@
 import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
 
-import type { SyncPlanType } from "./sync";
 import {
+  readAllProfilerResultsByVault,
   readAllSyncPlanRecordTextsByVault,
-  readAllLogRecordTextsByVault,
 } from "./localdb";
 import type { InternalDBs } from "./localdb";
-import { mkdirpInVault } from "./misc";
+import { mkdirpInVault, unixTimeToStr } from "./misc";
 import {
   DEFAULT_DEBUG_FOLDER,
-  DEFAULT_LOG_HISTORY_FILE_PREFIX,
+  DEFAULT_PROFILER_RESULT_FILE_PREFIX,
   DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX,
-  FileOrFolderMixedState,
 } from "./baseTypes";
 
-import { log } from "./moreOnLog";
-
-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"
+  howMany: number
 ) => {
-  log.info("exporting");
+  console.info("exporting sync plans");
   await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
   const records = await readAllSyncPlanRecordTextsByVault(db, vaultRandomID);
   let md = "";
   if (records.length === 0) {
     md = "No sync plans history found";
   } else {
-    if (toFormat === "json") {
+    if (howMany <= 0) {
       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;
+      md =
+        "Sync plans found:\n\n" +
+        records
+          .map((x) => "```json\n" + x + "\n```\n")
+          .slice(0, howMany)
+          .join("\n");
     }
   }
   const ts = Date.now();
@@ -102,29 +43,29 @@ export const exportVaultSyncPlansToFiles = async (
   await vault.create(filePath, md, {
     mtime: ts,
   });
-  log.info("finish exporting");
+  console.info("finish exporting sync plans");
 };
 
-export const exportVaultLoggerOutputToFiles = async (
+export const exportVaultProfilerResultsToFiles = async (
   db: InternalDBs,
   vault: Vault,
   vaultRandomID: string
 ) => {
+  console.info("exporting profiler results");
   await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
-  const records = await readAllLogRecordTextsByVault(db, vaultRandomID);
+  const records = await readAllProfilerResultsByVault(db, vaultRandomID);
   let md = "";
   if (records.length === 0) {
-    md = "No logger history found.";
+    md = "No profiler results found";
   } else {
     md =
-      "Logger history found:\n\n" +
-      "```text\n" +
-      records.join("\n") +
-      "\n```\n";
+      "Profiler results found:\n\n" +
+      records.map((x) => "```\n" + x + "\n```\n").join("\n");
   }
   const ts = Date.now();
-  const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_LOG_HISTORY_FILE_PREFIX}${ts}.md`;
+  const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_PROFILER_RESULT_FILE_PREFIX}${ts}.md`;
   await vault.create(filePath, md, {
     mtime: ts,
   });
+  console.info("finish exporting profiler results");
 };

src/encryptOpenSSL.ts

@@ -1,8 +1,6 @@
 import { base32, base64url } from "rfc4648";
 import { bufferToArrayBuffer, hexStringToTypedArray } from "./misc";
 
-import { log } from "./moreOnLog";
-
 const DEFAULT_ITER = 20000;
 
 // base32.stringify(Buffer.from('Salted__'))
@@ -166,18 +164,20 @@ export const decryptBase64urlToString = async (
 };
 
 export const getSizeFromOrigToEnc = (x: number) => {
-  if (x < 0 || !Number.isInteger(x)) {
-    throw Error(`x=${x} is not a valid size`);
+  if (x < 0 || Number.isNaN(x) || !Number.isInteger(x)) {
+    throw Error(`getSizeFromOrigToEnc: x=${x} is not a valid size`);
   }
   return (Math.floor(x / 16) + 1) * 16 + 16;
 };
 
 export const getSizeFromEncToOrig = (x: number) => {
-  if (x < 32 || !Number.isInteger(x)) {
-    throw Error(`${x} is not a valid size`);
+  if (x < 32 || Number.isNaN(x) || !Number.isInteger(x)) {
+    throw Error(`getSizeFromEncToOrig: ${x} is not a valid size`);
   }
   if (x % 16 !== 0) {
-    throw Error(`${x} is not a valid encrypted file size`);
+    throw Error(
+      `getSizeFromEncToOrig: ${x} is not a valid encrypted file size`
+    );
   }
   return {
     minSize: ((x - 16) / 16 - 1) * 16,

src/encryptRClone.ts

@@ -0,0 +1,251 @@
+import {
+  Cipher as CipherRCloneCryptPack,
+  encryptedSize,
+} from "@fyears/rclone-crypt";
+
+// @ts-ignore
+import EncryptWorker from "./encryptRClone.worker";
+
+interface RecvMsg {
+  status: "ok" | "error";
+  outputName?: string;
+  outputContent?: ArrayBuffer;
+  error?: any;
+}
+
+export const getSizeFromOrigToEnc = encryptedSize;
+
+export class CipherRclone {
+  readonly password: string;
+  readonly cipher: CipherRCloneCryptPack;
+  readonly workers: Worker[];
+  init: boolean;
+  workerIdx: number;
+  constructor(password: string, workerNum: number) {
+    this.password = password;
+    this.init = false;
+    this.workerIdx = 0;
+
+    // console.debug("begin creating CipherRCloneCryptPack");
+    this.cipher = new CipherRCloneCryptPack("base64");
+    // console.debug("finish creating CipherRCloneCryptPack");
+
+    // console.debug("begin creating EncryptWorker");
+    this.workers = [];
+    for (let i = 0; i < workerNum; ++i) {
+      this.workers.push(new (EncryptWorker as any)() as Worker);
+    }
+
+    // console.debug("finish creating EncryptWorker");
+  }
+
+  closeResources() {
+    for (let i = 0; i < this.workers.length; ++i) {
+      this.workers[i].terminate();
+    }
+  }
+
+  async prepareByCallingWorker(): Promise<void> {
+    if (this.init) {
+      return;
+    }
+    // console.debug("begin prepareByCallingWorker");
+    await this.cipher.key(this.password, "");
+    // console.debug("finish getting key");
+
+    const res: Promise<void>[] = [];
+    for (let i = 0; i < this.workers.length; ++i) {
+      res.push(
+        new Promise((resolve, reject) => {
+          const channel = new MessageChannel();
+
+          channel.port2.onmessage = (event) => {
+            // console.debug("main: receiving msg in prepare");
+            const { status } = event.data as RecvMsg;
+            if (status === "ok") {
+              // console.debug("main: receiving init ok in prepare");
+              this.init = true;
+              resolve(); // return the class object itself
+            } else {
+              reject("error after prepareByCallingWorker");
+            }
+          };
+
+          channel.port2.onmessageerror = (event) => {
+            // console.debug("main: receiving error in prepare");
+            reject(event);
+          };
+
+          // console.debug("main: before postMessage in prepare");
+          this.workers[i].postMessage(
+            {
+              action: "prepare",
+              dataKeyBuf: this.cipher.dataKey.buffer,
+              nameKeyBuf: this.cipher.nameKey.buffer,
+              nameTweakBuf: this.cipher.nameTweak.buffer,
+            },
+            [channel.port1 /* buffer no transfered because we need to copy */]
+          );
+        })
+      );
+    }
+    await Promise.all(res);
+  }
+
+  async encryptNameByCallingWorker(inputName: string): Promise<string> {
+    // console.debug("main: start encryptNameByCallingWorker");
+    await this.prepareByCallingWorker();
+    // console.debug(
+    //   "main: really start generate promise in encryptNameByCallingWorker"
+    // );
+    ++this.workerIdx;
+    const whichWorker = this.workerIdx % this.workers.length;
+    return await new Promise((resolve, reject) => {
+      const channel = new MessageChannel();
+
+      channel.port2.onmessage = (event) => {
+        // console.debug("main: receiving msg in encryptNameByCallingWorker");
+        const { outputName } = event.data as RecvMsg;
+        if (outputName === undefined) {
+          reject("unknown outputName after encryptNameByCallingWorker");
+        } else {
+          resolve(outputName);
+        }
+      };
+
+      channel.port2.onmessageerror = (event) => {
+        // console.debug("main: receiving error in encryptNameByCallingWorker");
+        reject(event);
+      };
+
+      // console.debug("main: before postMessage in encryptNameByCallingWorker");
+      this.workers[whichWorker].postMessage(
+        {
+          action: "encryptName",
+          inputName: inputName,
+        },
+        [channel.port1]
+      );
+    });
+  }
+
+  async decryptNameByCallingWorker(inputName: string): Promise<string> {
+    await this.prepareByCallingWorker();
+    ++this.workerIdx;
+    const whichWorker = this.workerIdx % this.workers.length;
+    return await new Promise((resolve, reject) => {
+      const channel = new MessageChannel();
+
+      channel.port2.onmessage = (event) => {
+        // console.debug("main: receiving msg in decryptNameByCallingWorker");
+        const { outputName, status } = event.data as RecvMsg;
+
+        if (status === "error") {
+          reject("error");
+        } else {
+          if (outputName === undefined) {
+            reject("unknown outputName after decryptNameByCallingWorker");
+          } else {
+            resolve(outputName);
+          }
+        }
+      };
+
+      channel.port2.onmessageerror = (event) => {
+        // console.debug("main: receiving error in decryptNameByCallingWorker");
+        reject(event);
+        channel;
+      };
+
+      // console.debug("main: before postMessage in decryptNameByCallingWorker");
+      this.workers[whichWorker].postMessage(
+        {
+          action: "decryptName",
+          inputName: inputName,
+        },
+        [channel.port1]
+      );
+    });
+  }
+
+  async encryptContentByCallingWorker(
+    input: ArrayBuffer
+  ): Promise<ArrayBuffer> {
+    await this.prepareByCallingWorker();
+    ++this.workerIdx;
+    const whichWorker = this.workerIdx % this.workers.length;
+    return await new Promise((resolve, reject) => {
+      const channel = new MessageChannel();
+
+      channel.port2.onmessage = (event) => {
+        // console.debug("main: receiving msg in encryptContentByCallingWorker");
+        const { outputContent } = event.data as RecvMsg;
+        if (outputContent === undefined) {
+          reject("unknown outputContent after encryptContentByCallingWorker");
+        } else {
+          resolve(outputContent);
+        }
+      };
+
+      channel.port2.onmessageerror = (event) => {
+        // console.debug("main: receiving error in encryptContentByCallingWorker");
+        reject(event);
+      };
+
+      // console.debug(
+      //   "main: before postMessage in encryptContentByCallingWorker"
+      // );
+      this.workers[whichWorker].postMessage(
+        {
+          action: "encryptContent",
+          inputContent: input,
+        },
+        [channel.port1, input]
+      );
+    });
+  }
+
+  async decryptContentByCallingWorker(
+    input: ArrayBuffer
+  ): Promise<ArrayBuffer> {
+    await this.prepareByCallingWorker();
+    ++this.workerIdx;
+    const whichWorker = this.workerIdx % this.workers.length;
+    return await new Promise((resolve, reject) => {
+      const channel = new MessageChannel();
+
+      channel.port2.onmessage = (event) => {
+        // console.debug("main: receiving msg in decryptContentByCallingWorker");
+        const { outputContent, status } = event.data as RecvMsg;
+
+        if (status === "error") {
+          reject("error");
+        } else {
+          if (outputContent === undefined) {
+            reject("unknown outputContent after decryptContentByCallingWorker");
+          } else {
+            resolve(outputContent);
+          }
+        }
+      };
+
+      channel.port2.onmessageerror = (event) => {
+        // console.debug(
+        //   "main: receiving onmessageerror in decryptContentByCallingWorker"
+        // );
+        reject(event);
+      };
+
+      // console.debug(
+      //   "main: before postMessage in decryptContentByCallingWorker"
+      // );
+      this.workers[whichWorker].postMessage(
+        {
+          action: "decryptContent",
+          inputContent: input,
+        },
+        [channel.port1, input]
+      );
+    });
+  }
+}

src/encryptRClone.worker.ts

@@ -0,0 +1,184 @@
+import { nanoid } from "nanoid";
+import { Cipher as CipherRCloneCryptPack } from "@fyears/rclone-crypt";
+
+const ctx: WorkerGlobalScope = self as any;
+
+const workerNanoID = nanoid();
+const cipher = new CipherRCloneCryptPack("base64");
+
+// console.debug(`worker [${workerNanoID}]: cipher created`);
+
+async function encryptNameStr(input: string) {
+  const res = await cipher.encryptFileName(input);
+  return res;
+}
+
+async function decryptNameStr(input: string) {
+  return await cipher.decryptFileName(input);
+}
+
+async function encryptContentBuf(input: ArrayBuffer) {
+  return (await cipher.encryptData(new Uint8Array(input), undefined)).buffer;
+}
+
+async function decryptContentBuf(input: ArrayBuffer) {
+  return (await cipher.decryptData(new Uint8Array(input))).buffer;
+}
+
+ctx.addEventListener("message", async (event: any) => {
+  const port: MessagePort = event.ports[0];
+  const {
+    action,
+    dataKeyBuf,
+    nameKeyBuf,
+    nameTweakBuf,
+    inputName,
+    inputContent,
+  } = event.data as {
+    action:
+      | "prepare"
+      | "encryptContent"
+      | "decryptContent"
+      | "encryptName"
+      | "decryptName";
+    dataKeyBuf?: ArrayBuffer;
+    nameKeyBuf?: ArrayBuffer;
+    nameTweakBuf?: ArrayBuffer;
+    inputName?: string;
+    inputContent?: ArrayBuffer;
+  };
+
+  // console.debug(`worker [${workerNanoID}]: receiving action=${action}`);
+
+  if (action === "prepare") {
+    // console.debug(`worker [${workerNanoID}]: prepare: start`);
+    try {
+      if (
+        dataKeyBuf === undefined ||
+        nameKeyBuf === undefined ||
+        nameTweakBuf === undefined
+      ) {
+        // console.debug(`worker [${workerNanoID}]: prepare: no buffer??`);
+        throw Error(
+          `worker [${workerNanoID}]: prepare: internal keys not transferred to worker properly`
+        );
+      }
+      // console.debug(`worker [${workerNanoID}]: prepare: so we update`);
+      cipher.updateInternalKey(
+        new Uint8Array(dataKeyBuf),
+        new Uint8Array(nameKeyBuf),
+        new Uint8Array(nameTweakBuf)
+      );
+      port.postMessage({
+        status: "ok",
+      });
+    } catch (error) {
+      console.error(error);
+      port.postMessage({
+        status: "error",
+        error: error,
+      });
+    }
+  } else if (action === "encryptName") {
+    try {
+      if (inputName === undefined) {
+        throw Error(
+          `worker [${workerNanoID}]: encryptName: internal inputName not transferred to worker properly`
+        );
+      }
+      const outputName = await encryptNameStr(inputName);
+      // console.debug(
+      //   `worker [${workerNanoID}]: after encryptNameStr, before postMessage`
+      // );
+      port.postMessage({
+        status: "ok",
+        outputName: outputName,
+      });
+    } catch (error) {
+      console.error(`worker [${workerNanoID}]: encryptName=${inputName}`);
+      console.error(error);
+      port.postMessage({
+        status: "error",
+        error: error,
+      });
+    }
+  } else if (action === "decryptName") {
+    try {
+      if (inputName === undefined) {
+        throw Error(
+          `worker [${workerNanoID}]: decryptName: internal inputName not transferred to worker properly`
+        );
+      }
+      const outputName = await decryptNameStr(inputName);
+      // console.debug(
+      //   `worker [${workerNanoID}]: after decryptNameStr, before postMessage`
+      // );
+      port.postMessage({
+        status: "ok",
+        outputName: outputName,
+      });
+    } catch (error) {
+      console.error(`worker [${workerNanoID}]: decryptName=${inputName}`);
+      console.error(error);
+      port.postMessage({
+        status: "error",
+        error: error,
+      });
+    }
+  } else if (action === "encryptContent") {
+    try {
+      if (inputContent === undefined) {
+        throw Error(
+          `worker [${workerNanoID}]: encryptContent: internal inputContent not transferred to worker properly`
+        );
+      }
+      const outputContent = await encryptContentBuf(inputContent);
+      // console.debug(
+      //   `worker [${workerNanoID}]: after encryptContentBuf, before postMessage`
+      // );
+      port.postMessage(
+        {
+          status: "ok",
+          outputContent: outputContent,
+        },
+        [outputContent]
+      );
+    } catch (error) {
+      console.error(error);
+      port.postMessage({
+        status: "error",
+        error: error,
+      });
+    }
+  } else if (action === "decryptContent") {
+    try {
+      if (inputContent === undefined) {
+        throw Error(
+          `worker [${workerNanoID}]: decryptContent: internal inputContent not transferred to worker properly`
+        );
+      }
+      const outputContent = await decryptContentBuf(inputContent);
+      // console.debug(
+      //   `worker [${workerNanoID}]: after decryptContentBuf, before postMessage`
+      // );
+      port.postMessage(
+        {
+          status: "ok",
+          outputContent: outputContent,
+        },
+        [outputContent]
+      );
+    } catch (error) {
+      console.error(error);
+      port.postMessage({
+        status: "error",
+        error: error,
+      });
+    }
+  } else {
+    port.postMessage({
+      status: "error",
+      error: `worker [${workerNanoID}]: unknown action=${action}`,
+    });
+  }
+});

src/fsAll.ts

@@ -0,0 +1,19 @@
+import { Entity } from "./baseTypes";
+
+export abstract class FakeFs {
+  abstract kind: string;
+  abstract walk(): Promise<Entity[]>;
+  abstract stat(key: string): Promise<Entity>;
+  abstract mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity>;
+  abstract writeFile(
+    key: string,
+    content: ArrayBuffer,
+    mtime: number,
+    ctime: number
+  ): Promise<Entity>;
+  abstract readFile(key: string): Promise<ArrayBuffer>;
+  abstract rm(key: string): Promise<void>;
+  abstract checkConnect(callbackFunc?: any): Promise<boolean>;
+  abstract getUserDisplayName(): Promise<string>;
+  abstract revokeAuth(): Promise<any>;
+}

src/fsDropbox.ts

@@ -0,0 +1,739 @@
+import { FakeFs } from "./fsAll";
+import { Dropbox, DropboxAuth } from "dropbox";
+import type { files, DropboxResponseError, DropboxResponse } from "dropbox";
+import {
+  DropboxConfig,
+  COMMAND_CALLBACK_DROPBOX,
+  OAUTH2_FORCE_EXPIRE_MILLISECONDS,
+  Entity,
+} from "./baseTypes";
+import random from "lodash/random";
+import {
+  bufferToArrayBuffer,
+  delay,
+  getFolderLevels,
+  getParentFolder,
+  hasEmojiInText,
+  headersToRecord,
+} from "./misc";
+
+export { Dropbox } from "dropbox";
+
+export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
+  accessToken: "",
+  clientID: process.env.DEFAULT_DROPBOX_APP_KEY ?? "",
+  refreshToken: "",
+  accessTokenExpiresInSeconds: 0,
+  accessTokenExpiresAtTime: 0,
+  accountID: "",
+  username: "",
+  credentialsShouldBeDeletedAtTime: 0,
+};
+
+const getDropboxPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
+  let key = fileOrFolderPath;
+  if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
+    // special
+    key = `/${remoteBaseDir}`;
+  } else if (fileOrFolderPath.startsWith("/")) {
+    console.warn(
+      `why the path ${fileOrFolderPath} starts with '/'? but we just go on.`
+    );
+    key = `/${remoteBaseDir}${fileOrFolderPath}`;
+  } else {
+    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 fromDropboxItemToEntity = (
+  x:
+    | files.FileMetadataReference
+    | files.FolderMetadataReference
+    | files.DeletedMetadataReference,
+  remoteBaseDir: string
+): Entity => {
+  let key = getNormPath(x.path_display!, remoteBaseDir);
+  if (x[".tag"] === "folder" && !key.endsWith("/")) {
+    key = `${key}/`;
+  }
+
+  if (x[".tag"] === "folder") {
+    return {
+      key: key,
+      keyRaw: key,
+      size: 0,
+      sizeRaw: 0,
+    } as Entity;
+  } else if (x[".tag"] === "file") {
+    const mtimeCli = Date.parse(x.client_modified).valueOf();
+    const mtimeSvr = Date.parse(x.server_modified).valueOf();
+    return {
+      key: key,
+      keyRaw: key,
+      mtimeCli: mtimeCli,
+      mtimeSvr: mtimeSvr,
+      size: x.size,
+      sizeRaw: x.size,
+      hash: x.content_hash,
+    } as Entity;
+  } else {
+    // x[".tag"] === "deleted"
+    throw Error("do not support deleted tag");
+  }
+};
+
+/**
+ * https://github.com/remotely-save/remotely-save/issues/567
+ * https://www.dropboxforum.com/t5/Dropbox-API-Support-Feedback/Case-Sensitivity-in-API-2/td-p/191279
+ * @param entities
+ */
+export const fixEntityListCasesInplace = (entities: { key?: string }[]) => {
+  for (const iterator of entities) {
+    if (iterator.key === undefined) {
+      throw Error(`dropbox list should all have key, but meet undefined`);
+    }
+  }
+
+  entities.sort((a, b) => a.key!.length - b.key!.length);
+  // console.log(JSON.stringify(entities,null,2));
+
+  const caseMapping: Record<string, string> = { "": "" };
+  for (const e of entities) {
+    // console.log(`looking for: ${JSON.stringify(e, null, 2)}`);
+
+    let parentFolder = getParentFolder(e.key!);
+    if (parentFolder === "/") {
+      parentFolder = "";
+    }
+    const parentFolderLower = parentFolder.toLocaleLowerCase();
+    const segs = e.key!.split("/");
+    if (e.key!.endsWith("/")) {
+      // folder
+      if (caseMapping.hasOwnProperty(parentFolderLower)) {
+        const newKey = `${caseMapping[parentFolderLower]}${segs
+          .slice(-2)
+          .join("/")}`;
+        caseMapping[newKey.toLocaleLowerCase()] = newKey;
+        e.key = newKey;
+        // console.log(JSON.stringify(caseMapping,null,2));
+        continue;
+      } else {
+        throw Error(`${parentFolder} doesn't have cases record??`);
+      }
+    } else {
+      // file
+      if (caseMapping.hasOwnProperty(parentFolderLower)) {
+        const newKey = `${caseMapping[parentFolderLower]}${segs
+          .slice(-1)
+          .join("/")}`;
+        e.key = newKey;
+        continue;
+      } else {
+        throw Error(`${parentFolder} doesn't have cases record??`);
+      }
+    }
+  }
+
+  return entities;
+};
+
+////////////////////////////////////////////////////////////////////////////////
+// Other usual common methods
+////////////////////////////////////////////////////////////////////////////////
+
+interface ErrSubType {
+  error: {
+    retry_after: number;
+  };
+}
+
+async function retryReq<T>(
+  reqFunc: () => Promise<DropboxResponse<T>>,
+  extraHint: string = ""
+): Promise<DropboxResponse<T> | undefined> {
+  const waitSeconds = [1, 2, 4, 8]; // hard code exponential backoff
+  for (let idx = 0; idx < waitSeconds.length; ++idx) {
+    try {
+      if (idx !== 0) {
+        console.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);
+      console.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(random(secMin * 1000, secMax * 1000));
+    }
+  }
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// 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 as any,
+      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,
+  errorCallBack: any
+) => {
+  try {
+    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;
+  } catch (e) {
+    console.error(e);
+    if (errorCallBack !== undefined) {
+      await errorCallBack(e);
+    }
+  }
+};
+
+export const sendRefreshTokenReq = async (
+  appKey: string,
+  refreshToken: string
+) => {
+  try {
+    console.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;
+    console.info("finish auto getting refreshed Dropbox access token.");
+    return resp2;
+  } catch (e) {
+    console.error(e);
+    throw e;
+  }
+};
+
+export const setConfigBySuccessfullAuthInplace = async (
+  config: DropboxConfig,
+  authRes: DropboxSuccessAuthRes,
+  saveUpdatedConfigFunc: () => Promise<any> | undefined
+) => {
+  console.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;
+    config.accountID = authRes.account_id!;
+  }
+
+  if (saveUpdatedConfigFunc !== undefined) {
+    await saveUpdatedConfigFunc();
+  }
+
+  console.info("finish updating local info of Dropbox token");
+};
+
+////////////////////////////////////////////////////////////////////////////////
+// real exported interface
+////////////////////////////////////////////////////////////////////////////////
+
+export class FakeFsDropbox extends FakeFs {
+  kind: "dropbox";
+  dropboxConfig: DropboxConfig;
+  remoteBaseDir: string;
+  saveUpdatedConfigFunc: () => Promise<any>;
+  dropbox!: Dropbox;
+  vaultFolderExists: boolean;
+  foldersCreatedBefore: Set<string>;
+
+  constructor(
+    dropboxConfig: DropboxConfig,
+    vaultName: string,
+    saveUpdatedConfigFunc: () => Promise<any>
+  ) {
+    super();
+    this.kind = "dropbox";
+    this.dropboxConfig = dropboxConfig;
+    this.remoteBaseDir = this.dropboxConfig.remoteBaseDir || vaultName || "";
+    this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
+    this.vaultFolderExists = false;
+    this.foldersCreatedBefore = new Set();
+  }
+
+  async _init() {
+    // check token
+    if (
+      this.dropboxConfig.accessToken === "" ||
+      this.dropboxConfig.refreshToken === ""
+    ) {
+      throw Error("The user has not manually auth yet.");
+    }
+    const currentTs = Date.now();
+    const customHeaders = {
+      "Cache-Control": "no-cache",
+    };
+    if (this.dropboxConfig.accessTokenExpiresAtTime > currentTs) {
+      this.dropbox = new Dropbox({
+        accessToken: this.dropboxConfig.accessToken,
+        customHeaders: customHeaders,
+      });
+    } else {
+      if (this.dropboxConfig.refreshToken === "") {
+        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,
+        customHeaders: customHeaders,
+      });
+    }
+
+    // check vault folder
+    // console.info(`checking remote has folder /${this.remoteBaseDir}`);
+    if (this.vaultFolderExists) {
+      // console.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) {
+        console.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}`,
+        });
+        console.info(`remote folder /${this.remoteBaseDir} created`);
+        this.vaultFolderExists = true;
+      } else {
+        // console.info(`remote folder /${this.remoteBaseDir} exists`);
+      }
+    }
+
+    return this;
+  }
+
+  async walk(): Promise<Entity[]> {
+    await this._init();
+
+    let res = await this.dropbox.filesListFolder({
+      path: `/${this.remoteBaseDir}`,
+      recursive: true,
+      include_deleted: false,
+      limit: 1000,
+    });
+    if (res.status !== 200) {
+      throw Error(JSON.stringify(res));
+    }
+    // console.info(res);
+
+    const contents = res.result.entries;
+    const unifiedContents = contents
+      .filter((x) => x[".tag"] !== "deleted")
+      .filter((x) => x.path_display !== `/${this.remoteBaseDir}`)
+      .map((x) => fromDropboxItemToEntity(x, this.remoteBaseDir));
+
+    while (res.result.has_more) {
+      res = await this.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 !== `/${this.remoteBaseDir}`)
+        .map((x) => fromDropboxItemToEntity(x, this.remoteBaseDir));
+      unifiedContents.push(...unifiedContents2);
+    }
+
+    fixEntityListCasesInplace(unifiedContents);
+
+    return unifiedContents;
+  }
+
+  async stat(key: string): Promise<Entity> {
+    await this._init();
+    return await this._statFromRoot(getDropboxPath(key, this.remoteBaseDir));
+  }
+
+  async _statFromRoot(key: string): Promise<Entity> {
+    // if (key === "" || key === "/") {
+    //   // 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.key}`,
+    //       recursive: false, // don't need to recursive here
+    //     })
+    //   );
+    //   if (rsp.status !== 200) {
+    //     throw Error(JSON.stringify(rsp));
+    //   }
+    //   return {
+    //     key: remotePath,
+    //     lastModified: undefined,
+    //     size: 0,
+    //     remoteType: "dropbox",
+    //     etag: undefined,
+    //   } as Entity;
+    // }
+
+    const rsp = await retryReq(() =>
+      this.dropbox.filesGetMetadata({
+        path: key,
+      })
+    );
+    if (rsp === undefined) {
+      throw Error("dropbox.filesGetMetadata undefinded");
+    }
+    if (rsp.status !== 200) {
+      throw Error(JSON.stringify(rsp));
+    }
+    return fromDropboxItemToEntity(rsp.result, this.remoteBaseDir);
+  }
+
+  async mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity> {
+    if (!key.endsWith("/")) {
+      throw Error(`you should not call mkdir on ${key}`);
+    }
+    await this._init();
+
+    const uploadFile = getDropboxPath(key, this.remoteBaseDir);
+
+    return await this._mkdirFromRoot(uploadFile, mtime, ctime);
+  }
+
+  async _mkdirFromRoot(
+    key: string,
+    mtime?: number,
+    ctime?: number
+  ): Promise<Entity> {
+    if (hasEmojiInText(key)) {
+      throw new Error(
+        `${key}: Error: Dropbox does not support emoji in file / folder names.`
+      );
+    }
+    if (this.foldersCreatedBefore?.has(key)) {
+      // created, pass
+    } else {
+      try {
+        await retryReq(
+          () =>
+            this.dropbox.filesCreateFolderV2({
+              path: key,
+            }),
+          key // just a hint
+        );
+        this.foldersCreatedBefore?.add(key);
+      } catch (e: unknown) {
+        const err = e as DropboxResponseError<files.CreateFolderError>;
+        if (err.status === undefined) {
+          throw err;
+        }
+        if (err.status === 409) {
+          // pass
+          this.foldersCreatedBefore?.add(key);
+        } else {
+          throw err;
+        }
+      }
+    }
+    return await this._statFromRoot(key);
+  }
+
+  async writeFile(
+    key: string,
+    content: ArrayBuffer,
+    mtime: number,
+    ctime: number
+  ): Promise<Entity> {
+    if (key.endsWith("/")) {
+      throw Error(`you should not call writeFile on ${key}`);
+    }
+
+    await this._init();
+    const uploadFile = getDropboxPath(key, this.remoteBaseDir);
+
+    return await this._writeFileFromRoot(
+      uploadFile,
+      content,
+      mtime,
+      ctime,
+      key
+    );
+  }
+
+  async _writeFileFromRoot(
+    key: string,
+    content: ArrayBuffer,
+    mtime: number,
+    ctime: number,
+    origKey: string
+  ): Promise<Entity> {
+    if (hasEmojiInText(origKey)) {
+      throw new Error(
+        `${origKey}: Error: Dropbox does not support emoji in file / folder names.`
+      );
+    }
+
+    const mtimeFixed = Math.floor(mtime / 1000.0) * 1000;
+    const ctimeFixed = Math.floor(ctime / 1000.0) * 1000;
+    const mtimeStr = new Date(mtimeFixed)
+      .toISOString()
+      .replace(/\.\d{3}Z$/, "Z");
+
+    // in dropbox, we don't need to create folders before uploading! cool!
+    // TODO: filesUploadSession for larger files (>=150 MB)
+
+    await retryReq(
+      () =>
+        this.dropbox.filesUpload({
+          path: key,
+          contents: content,
+          mode: {
+            ".tag": "overwrite",
+          },
+          client_modified: mtimeStr,
+        }),
+      origKey // hint
+    );
+
+    // we want to mark that parent folders are created
+    if (this.foldersCreatedBefore !== undefined) {
+      const dirs = getFolderLevels(origKey).map((x) =>
+        getDropboxPath(x, this.remoteBaseDir)
+      );
+      for (const dir of dirs) {
+        this.foldersCreatedBefore?.add(dir);
+      }
+    }
+    return await this._statFromRoot(key);
+  }
+
+  async readFile(key: string): Promise<ArrayBuffer> {
+    await this._init();
+    if (key.endsWith("/")) {
+      throw new Error(`you should not call readFile on folder ${key}`);
+    }
+    const downloadFile = getDropboxPath(key, this.remoteBaseDir);
+    return await this._readFileFromRoot(downloadFile);
+  }
+
+  async _readFileFromRoot(key: string): Promise<ArrayBuffer> {
+    const rsp = await retryReq(
+      () =>
+        this.dropbox.filesDownload({
+          path: key,
+        }),
+      `downloadFromRemoteRaw=${key}`
+    );
+    if (rsp === undefined) {
+      throw Error(`unknown rsp from dropbox download: ${rsp}`);
+    }
+    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}`);
+    }
+  }
+
+  async rm(key: string): Promise<void> {
+    if (key === "/") {
+      return;
+    }
+    const remoteFileName = getDropboxPath(key, this.remoteBaseDir);
+
+    await this._init();
+    try {
+      await retryReq(
+        () =>
+          this.dropbox.filesDeleteV2({
+            path: remoteFileName,
+          }),
+        key // just a hint here
+      );
+    } catch (err) {
+      console.error("some error while deleting");
+      console.error(err);
+    }
+  }
+
+  async checkConnect(callbackFunc?: any): Promise<boolean> {
+    try {
+      await this._init();
+      const results = await this._statFromRoot(`/${this.remoteBaseDir}`);
+      if (results === undefined) {
+        return false;
+      }
+      return true;
+    } catch (err) {
+      console.debug(err);
+      callbackFunc?.(err);
+      return false;
+    }
+  }
+
+  async getUserDisplayName() {
+    await this._init();
+    const acct = await this.dropbox.usersGetCurrentAccount();
+    return acct.result.name.display_name;
+  }
+
+  async revokeAuth() {
+    try {
+      await this._init();
+      await this.dropbox.authTokenRevoke();
+      return true;
+    } catch (e) {
+      return false;
+    }
+  }
+}

src/fsEncrypt.ts

@@ -0,0 +1,557 @@
+import { CipherMethodType, Entity } from "./baseTypes";
+import * as openssl from "./encryptOpenSSL";
+import * as rclone from "./encryptRClone";
+import { isVaildText } from "./misc";
+
+import { FakeFs } from "./fsAll";
+import cloneDeep from "lodash/cloneDeep";
+
+/**
+ * quick guess, no actual decryption here
+ * @param name
+ * @returns
+ */
+function isLikelyOpenSSLEncryptedName(name: string): boolean {
+  if (
+    name.startsWith(openssl.MAGIC_ENCRYPTED_PREFIX_BASE32) ||
+    name.startsWith(openssl.MAGIC_ENCRYPTED_PREFIX_BASE64URL)
+  ) {
+    return true;
+  }
+  return false;
+}
+
+/**
+ * quick guess, no actual decryption here
+ * @param name
+ * @returns
+ */
+function isLikelyEncryptedName(name: string): boolean {
+  return isLikelyOpenSSLEncryptedName(name);
+}
+
+/**
+ * quick guess, no actual decryption here, only openssl can be guessed here
+ * @param name
+ * @returns
+ */
+function isLikelyEncryptedNameNotMatchMethod(
+  name: string,
+  method: CipherMethodType
+): boolean {
+  if (isLikelyOpenSSLEncryptedName(name) && method !== "openssl-base64") {
+    return true;
+  }
+  if (!isLikelyOpenSSLEncryptedName(name) && method === "openssl-base64") {
+    return true;
+  }
+  return false;
+}
+
+export interface PasswordCheckType {
+  ok: boolean;
+  reason:
+    | "empty_remote"
+    | "unknown_encryption_method"
+    | "remote_encrypted_local_no_password"
+    | "password_matched"
+    | "password_or_method_not_matched_or_remote_not_encrypted"
+    | "likely_no_password_both_sides"
+    | "encryption_method_not_matched";
+}
+
+/**
+ * Useful if isPasswordEmpty()
+ */
+function copyEntityAndCopyKeyEncSizeEnc(entity: Entity) {
+  const res = cloneDeep(entity);
+  res["keyEnc"] = res["keyRaw"];
+  res["sizeEnc"] = res["sizeRaw"];
+  return res;
+}
+
+export class FakeFsEncrypt extends FakeFs {
+  innerFs: FakeFs;
+  readonly password: string;
+  readonly method: CipherMethodType;
+  cipherRClone?: rclone.CipherRclone;
+  cacheMapOrigToEnc: Record<string, string>;
+  hasCacheMap: boolean;
+  kind: string;
+  innerWalkResultCache?: Entity[];
+  innerWalkResultCacheTime?: number;
+
+  constructor(innerFs: FakeFs, password: string, method: CipherMethodType) {
+    super();
+    this.innerFs = innerFs;
+    this.password = password ?? "";
+    this.method = method;
+    this.cacheMapOrigToEnc = {};
+    this.hasCacheMap = false;
+
+    this.kind = `encrypt(${this.innerFs.kind},${method})`;
+
+    if (method === "rclone-base64") {
+      this.cipherRClone = new rclone.CipherRclone(password, 5);
+    }
+  }
+
+  isPasswordEmpty() {
+    return this.password === "";
+  }
+
+  isFolderAware() {
+    if (this.method === "openssl-base64") {
+      return false;
+    }
+    if (this.method === "rclone-base64") {
+      return true;
+    }
+    throw Error(`no idea about isFolderAware for method=${this.method}`);
+  }
+
+  /**
+   * we want a little caching here.
+   */
+  async _getInnerWalkResult(): Promise<Entity[]> {
+    let innerWalkResult: Entity[] | undefined = undefined;
+    if (
+      this.innerWalkResultCacheTime !== undefined &&
+      this.innerWalkResultCacheTime >= Date.now() - 1000
+    ) {
+      innerWalkResult = this.innerWalkResultCache!;
+    } else {
+      innerWalkResult = await this.innerFs.walk();
+      this.innerWalkResultCache = innerWalkResult;
+      this.innerWalkResultCacheTime = Date.now();
+    }
+    return innerWalkResult;
+  }
+
+  async isPasswordOk(): Promise<PasswordCheckType> {
+    const innerWalkResult = await this._getInnerWalkResult();
+
+    if (innerWalkResult === undefined || innerWalkResult.length === 0) {
+      // remote empty
+      return {
+        ok: true,
+        reason: "empty_remote",
+      };
+    }
+    const santyCheckKey = innerWalkResult[0].keyRaw;
+
+    if (this.isPasswordEmpty()) {
+      // TODO: no way to distinguish remote rclone encrypted
+      //       if local has no password??
+      if (isLikelyEncryptedName(santyCheckKey)) {
+        return {
+          ok: false,
+          reason: "remote_encrypted_local_no_password",
+        };
+      } else {
+        return {
+          ok: true,
+          reason: "likely_no_password_both_sides",
+        };
+      }
+    } else {
+      if (this.method === "unknown") {
+        return {
+          ok: false,
+          reason: "unknown_encryption_method",
+        };
+      }
+      if (isLikelyEncryptedNameNotMatchMethod(santyCheckKey, this.method)) {
+        return {
+          ok: false,
+          reason: "encryption_method_not_matched",
+        };
+      }
+      try {
+        const k = await this._decryptName(santyCheckKey);
+        if (k === undefined) {
+          throw Error(`decryption failed`);
+        }
+        return {
+          ok: true,
+          reason: "password_matched",
+        };
+      } catch (error) {
+        return {
+          ok: false,
+          reason: "password_or_method_not_matched_or_remote_not_encrypted",
+        };
+      }
+    }
+  }
+
+  async walk(): Promise<Entity[]> {
+    const innerWalkResult = await this._getInnerWalkResult();
+
+    const res: Entity[] = [];
+
+    if (this.isPasswordEmpty()) {
+      for (const innerEntity of innerWalkResult) {
+        res.push(copyEntityAndCopyKeyEncSizeEnc(innerEntity));
+        this.cacheMapOrigToEnc[innerEntity.key!] = innerEntity.key!;
+      }
+      this.hasCacheMap = true;
+      return res;
+    } else {
+      for (const innerEntity of innerWalkResult) {
+        const key = await this._decryptName(innerEntity.keyRaw);
+        const size = key.endsWith("/") ? 0 : undefined;
+        res.push({
+          key: key,
+          keyRaw: innerEntity.keyRaw,
+          keyEnc: innerEntity.key!,
+          mtimeCli: innerEntity.mtimeCli,
+          mtimeSvr: innerEntity.mtimeSvr,
+          size: size,
+          sizeEnc: innerEntity.size!,
+          sizeRaw: innerEntity.sizeRaw,
+          hash: undefined,
+          synthesizedFolder: innerEntity.synthesizedFolder,
+        });
+
+        this.cacheMapOrigToEnc[key] = innerEntity.keyRaw;
+      }
+      this.hasCacheMap = true;
+      return res;
+    }
+  }
+
+  async stat(key: string): Promise<Entity> {
+    if (!this.hasCacheMap) {
+      throw new Error("You have to build the cacheMap firstly for stat");
+    }
+    const keyEnc = this.cacheMapOrigToEnc[key];
+    if (keyEnc === undefined) {
+      throw new Error(`no encrypted key ${key} before!`);
+    }
+
+    const innerEntity = await this.innerFs.stat(keyEnc);
+    if (this.isPasswordEmpty()) {
+      return copyEntityAndCopyKeyEncSizeEnc(innerEntity);
+    } else {
+      return {
+        key: key,
+        keyRaw: innerEntity.keyRaw,
+        keyEnc: innerEntity.key!,
+        mtimeCli: innerEntity.mtimeCli,
+        mtimeSvr: innerEntity.mtimeSvr,
+        size: undefined,
+        sizeEnc: innerEntity.size!,
+        sizeRaw: innerEntity.sizeRaw,
+        hash: undefined,
+        synthesizedFolder: innerEntity.synthesizedFolder,
+      };
+    }
+  }
+
+  async mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity> {
+    if (!this.hasCacheMap) {
+      throw new Error("You have to build the cacheMap firstly for mkdir");
+    }
+
+    if (!key.endsWith("/")) {
+      throw new Error(`should not call mkdir on ${key}`);
+    }
+
+    let keyEnc = this.cacheMapOrigToEnc[key];
+    if (keyEnc === undefined) {
+      if (this.isPasswordEmpty()) {
+        keyEnc = key;
+      } else {
+        keyEnc = await this._encryptName(key);
+      }
+      this.cacheMapOrigToEnc[key] = keyEnc;
+    }
+
+    if (this.isPasswordEmpty() || this.isFolderAware()) {
+      const innerEntity = await this.innerFs.mkdir(keyEnc, mtime, ctime);
+      return copyEntityAndCopyKeyEncSizeEnc(innerEntity);
+    } else {
+      const now = Date.now();
+      const innerEntity = await this.innerFs.writeFile(
+        keyEnc,
+        new ArrayBuffer(0),
+        mtime ?? now,
+        ctime ?? now
+      );
+      return {
+        key: key,
+        keyRaw: innerEntity.keyRaw,
+        keyEnc: innerEntity.key!,
+        mtimeCli: innerEntity.mtimeCli,
+        mtimeSvr: innerEntity.mtimeSvr,
+        size: 0,
+        sizeEnc: innerEntity.size!,
+        sizeRaw: innerEntity.sizeRaw,
+        hash: undefined,
+        synthesizedFolder: innerEntity.synthesizedFolder,
+      };
+    }
+  }
+
+  async writeFile(
+    key: string,
+    content: ArrayBuffer,
+    mtime: number,
+    ctime: number
+  ): Promise<Entity> {
+    if (!this.hasCacheMap) {
+      throw new Error("You have to build the cacheMap firstly for readFile");
+    }
+    let keyEnc = this.cacheMapOrigToEnc[key];
+    if (keyEnc === undefined) {
+      if (this.isPasswordEmpty()) {
+        keyEnc = key;
+      } else {
+        keyEnc = await this._encryptName(key);
+      }
+      this.cacheMapOrigToEnc[key] = keyEnc;
+    }
+
+    if (this.isPasswordEmpty()) {
+      const innerEntity = await this.innerFs.writeFile(
+        keyEnc,
+        content,
+        mtime,
+        ctime
+      );
+      return copyEntityAndCopyKeyEncSizeEnc(innerEntity);
+    } else {
+      const contentEnc = await this._encryptContent(content);
+      const innerEntity = await this.innerFs.writeFile(
+        keyEnc,
+        contentEnc,
+        mtime,
+        ctime
+      );
+      return {
+        key: key,
+        keyRaw: innerEntity.keyRaw,
+        keyEnc: innerEntity.key!,
+        mtimeCli: innerEntity.mtimeCli,
+        mtimeSvr: innerEntity.mtimeSvr,
+        size: undefined,
+        sizeEnc: innerEntity.size!,
+        sizeRaw: innerEntity.sizeRaw,
+        hash: undefined,
+        synthesizedFolder: innerEntity.synthesizedFolder,
+      };
+    }
+  }
+
+  async readFile(key: string): Promise<ArrayBuffer> {
+    if (!this.hasCacheMap) {
+      throw new Error("You have to build the cacheMap firstly for readFile");
+    }
+    const keyEnc = this.cacheMapOrigToEnc[key];
+    if (keyEnc === undefined) {
+      throw new Error(`no encrypted key ${key} before! cannot readFile`);
+    }
+
+    const contentEnc = await this.innerFs.readFile(keyEnc);
+    if (this.isPasswordEmpty()) {
+      return contentEnc;
+    } else {
+      const res = await this._decryptContent(contentEnc);
+      return res;
+    }
+  }
+
+  async rm(key: string): Promise<void> {
+    if (!this.hasCacheMap) {
+      throw new Error("You have to build the cacheMap firstly for rm");
+    }
+    const keyEnc = this.cacheMapOrigToEnc[key];
+    if (keyEnc === undefined) {
+      throw new Error(`no encrypted key ${key} before! cannot rm`);
+    }
+    return await this.innerFs.rm(keyEnc);
+  }
+
+  async checkConnect(callbackFunc?: any): Promise<boolean> {
+    return await this.innerFs.checkConnect(callbackFunc);
+  }
+
+  async closeResources() {
+    if (this.method === "rclone-base64" && this.cipherRClone !== undefined) {
+      this.cipherRClone.closeResources();
+    }
+  }
+
+  async encryptEntity(input: Entity): Promise<Entity> {
+    if (input.key === undefined) {
+      // input.key should always have value
+      throw Error(`input ${input.keyRaw} is abnormal without key`);
+    }
+
+    if (this.isPasswordEmpty()) {
+      return copyEntityAndCopyKeyEncSizeEnc(input);
+    }
+
+    // below is for having password
+    const local = cloneDeep(input);
+    if (local.sizeEnc === undefined && local.size !== undefined) {
+      // it's not filled yet, we fill it
+      // local.size is possibly undefined if it's "prevSync" Entity
+      // but local.key should always have value
+      local.sizeEnc = this._getSizeFromOrigToEnc(local.size);
+    }
+
+    if (local.keyEnc === undefined || local.keyEnc === "") {
+      let keyEnc = this.cacheMapOrigToEnc[input.key];
+      if (keyEnc !== undefined && keyEnc !== "" && keyEnc !== local.key) {
+        // we can reuse remote encrypted key if any
+        local.keyEnc = keyEnc;
+      } else {
+        // we assign a new encrypted key because of no remote
+        keyEnc = await this._encryptName(input.key);
+        local.keyEnc = keyEnc;
+        // remember to add back to cache!
+        this.cacheMapOrigToEnc[input.key] = keyEnc;
+      }
+    }
+    return local;
+  }
+
+  async _encryptContent(content: ArrayBuffer) {
+    // console.debug("start encryptContent");
+    if (this.password === "") {
+      return content;
+    }
+    if (this.method === "openssl-base64") {
+      const res = await openssl.encryptArrayBuffer(content, this.password);
+      if (res === undefined) {
+        throw Error(`cannot encrypt content`);
+      }
+      return res;
+    } else if (this.method === "rclone-base64") {
+      const res =
+        await this.cipherRClone!.encryptContentByCallingWorker(content);
+      if (res === undefined) {
+        throw Error(`cannot encrypt content`);
+      }
+      return res;
+    } else {
+      throw Error(`not supported encrypt method=${this.method}`);
+    }
+  }
+
+  async _decryptContent(content: ArrayBuffer) {
+    // console.debug("start decryptContent");
+    if (this.password === "") {
+      return content;
+    }
+    if (this.method === "openssl-base64") {
+      const res = await openssl.decryptArrayBuffer(content, this.password);
+      if (res === undefined) {
+        throw Error(`cannot decrypt content`);
+      }
+      return res;
+    } else if (this.method === "rclone-base64") {
+      const res =
+        await this.cipherRClone!.decryptContentByCallingWorker(content);
+      if (res === undefined) {
+        throw Error(`cannot decrypt content`);
+      }
+      return res;
+    } else {
+      throw Error(`not supported decrypt method=${this.method}`);
+    }
+  }
+
+  async _encryptName(name: string) {
+    // console.debug("start encryptName");
+    if (this.password === "") {
+      return name;
+    }
+    if (this.method === "openssl-base64") {
+      const res = await openssl.encryptStringToBase64url(name, this.password);
+      if (res === undefined) {
+        throw Error(`cannot encrypt name=${name}`);
+      }
+      return res;
+    } else if (this.method === "rclone-base64") {
+      const res = await this.cipherRClone!.encryptNameByCallingWorker(name);
+      if (res === undefined) {
+        throw Error(`cannot encrypt name=${name}`);
+      }
+      return res;
+    } else {
+      throw Error(`not supported encrypt method=${this.method}`);
+    }
+  }
+
+  async _decryptName(name: string): Promise<string> {
+    // console.debug("start decryptName");
+    if (this.password === "") {
+      return name;
+    }
+    if (this.method === "openssl-base64") {
+      if (name.startsWith(openssl.MAGIC_ENCRYPTED_PREFIX_BASE32)) {
+        // backward compitable with the openssl-base32
+        try {
+          const res = await openssl.decryptBase32ToString(name, this.password);
+          if (res !== undefined && isVaildText(res)) {
+            return res;
+          } else {
+            throw Error(`cannot decrypt name=${name}`);
+          }
+        } catch (error) {
+          throw Error(`cannot decrypt name=${name}`);
+        }
+      } else if (name.startsWith(openssl.MAGIC_ENCRYPTED_PREFIX_BASE64URL)) {
+        try {
+          const res = await openssl.decryptBase64urlToString(
+            name,
+            this.password
+          );
+          if (res !== undefined && isVaildText(res)) {
+            return res;
+          } else {
+            throw Error(`cannot decrypt name=${name}`);
+          }
+        } catch (error) {
+          throw Error(`cannot decrypt name=${name}`);
+        }
+      } else {
+        throw Error(
+          `method=${this.method} but the name=${name}, likely mismatch`
+        );
+      }
+    } else if (this.method === "rclone-base64") {
+      const res = await this.cipherRClone!.decryptNameByCallingWorker(name);
+      if (res === undefined) {
+        throw Error(`cannot decrypt name=${name}`);
+      }
+      return res;
+    } else {
+      throw Error(`not supported decrypt method=${this.method}`);
+    }
+  }
+
+  _getSizeFromOrigToEnc(x: number) {
+    if (this.password === "") {
+      return x;
+    }
+    if (this.method === "openssl-base64") {
+      return openssl.getSizeFromOrigToEnc(x);
+    } else if (this.method === "rclone-base64") {
+      return rclone.getSizeFromOrigToEnc(x);
+    } else {
+      throw Error(`not supported encrypt method=${this.method}`);
+    }
+  }
+
+  async getUserDisplayName(): Promise<string> {
+    return await this.innerFs.getUserDisplayName();
+  }
+
+  async revokeAuth(): Promise<any> {
+    return await this.innerFs.revokeAuth();
+  }
+}

src/fsGetter.ts

@@ -0,0 +1,45 @@
+import { RemotelySavePluginSettings } from "./baseTypes";
+import { FakeFs } from "./fsAll";
+import { FakeFsDropbox } from "./fsDropbox";
+import { FakeFsOnedrive } from "./fsOnedrive";
+import { FakeFsS3 } from "./fsS3";
+import { FakeFsWebdav } from "./fsWebdav";
+
+/**
+ * To avoid circular dependency, we need a new file here.
+ */
+export function getClient(
+  settings: RemotelySavePluginSettings,
+  vaultName: string,
+  saveUpdatedConfigFunc: () => Promise<any>
+): FakeFs {
+  switch (settings.serviceType) {
+    case "s3":
+      return new FakeFsS3(settings.s3);
+      break;
+    case "webdav":
+      return new FakeFsWebdav(
+        settings.webdav,
+        vaultName,
+        saveUpdatedConfigFunc
+      );
+      break;
+    case "dropbox":
+      return new FakeFsDropbox(
+        settings.dropbox,
+        vaultName,
+        saveUpdatedConfigFunc
+      );
+      break;
+    case "onedrive":
+      return new FakeFsOnedrive(
+        settings.onedrive,
+        vaultName,
+        saveUpdatedConfigFunc
+      );
+      break;
+    default:
+      throw Error(`cannot init client for serviceType=${settings.serviceType}`);
+      break;
+  }
+}

src/fsLocal.ts

@@ -0,0 +1,171 @@
+import { DEFAULT_DEBUG_FOLDER, Entity } from "./baseTypes";
+import { FakeFs } from "./fsAll";
+
+import { TFile, TFolder, type Vault } from "obsidian";
+import { listFilesInObsFolder } from "./obsFolderLister";
+import { Profiler } from "./profiler";
+import { getFolderLevels, mkdirpInVault, statFix } from "./misc";
+
+export class FakeFsLocal extends FakeFs {
+  vault: Vault;
+  syncConfigDir: boolean;
+  configDir: string;
+  pluginID: string;
+  profiler: Profiler;
+  deleteToWhere: "obsidian" | "system";
+  kind: "local";
+  constructor(
+    vault: Vault,
+    syncConfigDir: boolean,
+    configDir: string,
+    pluginID: string,
+    profiler: Profiler,
+    deleteToWhere: "obsidian" | "system"
+  ) {
+    super();
+
+    this.vault = vault;
+    this.syncConfigDir = syncConfigDir;
+    this.configDir = configDir;
+    this.pluginID = pluginID;
+    this.profiler = profiler;
+    this.deleteToWhere = deleteToWhere;
+    this.kind = "local";
+  }
+
+  async walk(): Promise<Entity[]> {
+    this.profiler.addIndent();
+    this.profiler.insert("enter walk for local");
+    const local: Entity[] = [];
+
+    const localTAbstractFiles = this.vault.getAllLoadedFiles();
+    this.profiler.insert("finish getting walk for local");
+    for (const entry of localTAbstractFiles) {
+      let r: Entity | undefined = undefined;
+      let key = entry.path;
+
+      if (entry.path === "/") {
+        // ignore
+        continue;
+      } else if (entry instanceof TFile) {
+        let mtimeLocal: number | undefined = entry.stat.mtime;
+        if (mtimeLocal <= 0) {
+          mtimeLocal = entry.stat.ctime;
+        }
+        if (mtimeLocal === 0) {
+          mtimeLocal = undefined;
+        }
+        if (mtimeLocal === undefined) {
+          throw Error(
+            `Your file has last modified time 0: ${key}, don't know how to deal with it`
+          );
+        }
+        r = {
+          key: entry.path, // local always unencrypted
+          keyRaw: entry.path,
+          mtimeCli: mtimeLocal,
+          mtimeSvr: mtimeLocal,
+          size: entry.stat.size, // local always unencrypted
+          sizeRaw: entry.stat.size,
+        };
+      } else if (entry instanceof TFolder) {
+        key = `${entry.path}/`;
+        r = {
+          key: key,
+          keyRaw: key,
+          size: 0,
+          sizeRaw: 0,
+        };
+      } else {
+        throw Error(`unexpected ${entry}`);
+      }
+
+      if (r.keyRaw.startsWith(DEFAULT_DEBUG_FOLDER)) {
+        // skip listing the debug folder,
+        // which should always not involved in sync
+        continue;
+      } else {
+        local.push(r);
+      }
+    }
+
+    this.profiler.insert("finish transforming walk for local");
+
+    if (this.syncConfigDir) {
+      this.profiler.insert("into syncConfigDir");
+      const syncFiles = await listFilesInObsFolder(
+        this.configDir,
+        this.vault,
+        this.pluginID
+      );
+      for (const f of syncFiles) {
+        local.push(f);
+      }
+      this.profiler.insert("finish syncConfigDir");
+    }
+
+    this.profiler.insert("finish walk for local");
+    this.profiler.removeIndent();
+    return local;
+  }
+
+  async stat(key: string): Promise<Entity> {
+    const statRes = await statFix(this.vault, key);
+    if (statRes === undefined || statRes === null) {
+      throw Error(`${key} does not exist! cannot stat for local`);
+    }
+    const isFolder = statRes.type === "folder";
+    return {
+      key: isFolder ? `${key}/` : key, // local always unencrypted
+      keyRaw: isFolder ? `${key}/` : key,
+      mtimeCli: statRes.mtime,
+      mtimeSvr: statRes.mtime,
+      size: statRes.size, // local always unencrypted
+      sizeRaw: statRes.size,
+    };
+  }
+
+  async mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity> {
+    // console.debug(`mkdir: ${key}`);
+    await mkdirpInVault(key, this.vault);
+    return await this.stat(key);
+  }
+
+  async writeFile(
+    key: string,
+    content: ArrayBuffer,
+    mtime: number,
+    ctime: number
+  ): Promise<Entity> {
+    await this.vault.adapter.writeBinary(key, content, {
+      mtime: mtime,
+    });
+    return await this.stat(key);
+  }
+
+  async readFile(key: string): Promise<ArrayBuffer> {
+    return await this.vault.adapter.readBinary(key);
+  }
+
+  async rm(key: string): Promise<void> {
+    if (this.deleteToWhere === "obsidian") {
+      await this.vault.adapter.trashLocal(key);
+    } else {
+      // "system"
+      if (!(await this.vault.adapter.trashSystem(key))) {
+        await this.vault.adapter.trashLocal(key);
+      }
+    }
+  }
+  async checkConnect(callbackFunc?: any): Promise<boolean> {
+    return true;
+  }
+
+  async getUserDisplayName(): Promise<string> {
+    throw new Error("Method not implemented.");
+  }
+
+  async revokeAuth(): Promise<any> {
+    throw new Error("Method not implemented.");
+  }
+}

src/fsMock.ts

@@ -0,0 +1,52 @@
+import { Entity } from "./baseTypes";
+import { FakeFs } from "./fsAll";
+
+export class FakeFsMock extends FakeFs {
+  kind: "mock";
+
+  constructor() {
+    super();
+    this.kind = "mock";
+  }
+
+  async walk(): Promise<Entity[]> {
+    throw new Error("Method not implemented.");
+  }
+
+  async stat(key: string): Promise<Entity> {
+    throw new Error("Method not implemented.");
+  }
+
+  async mkdir(key: string, mtime: number, ctime: number): Promise<Entity> {
+    throw new Error("Method not implemented.");
+  }
+
+  async writeFile(
+    key: string,
+    content: ArrayBuffer,
+    mtime: number,
+    ctime: number
+  ): Promise<Entity> {
+    throw new Error("Method not implemented.");
+  }
+
+  async readFile(key: string): Promise<ArrayBuffer> {
+    throw new Error("Method not implemented.");
+  }
+
+  async rm(key: string): Promise<void> {
+    throw new Error("Method not implemented.");
+  }
+
+  async checkConnect(callbackFunc?: any): Promise<boolean> {
+    return true;
+  }
+
+  async getUserDisplayName(): Promise<string> {
+    throw new Error("Method not implemented.");
+  }
+
+  async revokeAuth(): Promise<any> {
+    throw new Error("Method not implemented.");
+  }
+}