bump to 0.3.6

commit 73967756d51d246b3ca203aa3683cdfebf567000
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Mar 13 22:41:28 2022 +0800

    fix typo

commit 08e16faa9a9ace9bec71acb723e0d70ca361d49f
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Mar 13 22:41:01 2022 +0800

    add modal in settings

commit 9db7194fa28cb62b1fa4c01ac7f746d5ac3b86a8
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Mar 13 22:03:00 2022 +0800

    working sync for .obsidian and _

commit 4be24ba092181c1c3e1aabe5e9d4e9fcff28f987
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Mar 13 16:07:10 2022 +0800

    more logic for hidden path

.github/ISSUE_TEMPLATE/bug_report.yml

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

.github/ISSUE_TEMPLATE/config.yml

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

.github/ISSUE_TEMPLATE/feature_request.yml

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

.github/workflows/auto-build.yml

@@ -5,7 +5,7 @@ name: BuildCI
 
 on:
   push:
-    branches: [master]
+    branches: ["**"]
   pull_request:
     branches: [master]
 

README.md

@@ -23,19 +23,21 @@ As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any
   - Dropbox
   - OneDrive for personal
   - Webdav
-- **Obsidiain Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
+  - A list of connectable / not-connectable / in-the-plan / never-possible services are noted down [here](./docs/services_connectable_or_not.md).
+- **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
 - **[End-to-end encryption](./docs/encryption.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
 - **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
 - **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
 - **Fully open source under [Apache-2.0 License](./LICENSE).**
-- **[Sync Algorithm open](./docs/sync_algorithm.md) for discussion.**
+- **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.**
 
 ## Limitations
 
-- **"deletion" operation can only be triggered from local device.** It's because of the "[minimal intrusive design](./docs/minimal_intrusive_design.md)". May be changed in the future.
+- **To support 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.
 - **All files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
+- **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
 
 ## Questions, Suggestions, Or Bugs
 
@@ -49,7 +51,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 ## Download and Install
 
-- Option #1: Search in the official "community plugin list", or click [obsidian://show-plugin?id=remotely-save](obsidian://show-plugin?id=remotely-save), then install the plugin.
+- Option #1: Search in the official "community plugin list", or visit this: [https://obsidian.md/plugins?id=remotely-save](https://obsidian.md/plugins?id=remotely-save) (which should redirect you into Obsidian app), then install the plugin.
 - Option #2: You can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin. Input `fyears/remotely-save` in the configuration of BRAT.
 - Option #3: [![GitHub release (latest by SemVer and asset including pre-releases)](https://img.shields.io/github/downloads-pre/fyears/remotely-save/latest/main.js?sort=semver)](https://github.com/fyears/remotely-save/releases) Manually download assets (`main.js`, `manifest.json`, `styles.css`) from the latest release.
 - Option #4: [![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml) Every artifacts are placed in the "Summary" under every successful builds. It's automatically generated by every commit, may break something.
@@ -59,7 +61,9 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 ### S3
 
 - Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
-- Configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
+- About CORS:
+  - If you are using Obsidian >= 0.13.25, you can skip this CORS part.
+  - If you are using Obsidian < 0.13.25, 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`. Full example is [here](./docs/s3_cors_configure.md). It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
 - Download and enable this plugin.
 - Enter your information to the settings of this plugin.
 - If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
@@ -86,10 +90,12 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 ### webdav
 
 - **webdav support is considered experimental.**
-- Currently only supports BASIC authorization method.
-- Currently webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies.
-  - Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin.
-  - The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
+- About CORS:
+  - If you are using Obsidian >= 0.13.25, you can skip this CORS part.
+  - If you are using Obsidian < 0.13.25:
+    - 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.
+    - The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
 - Your data would be synced to a `${vaultName}` sub folder on your webdav server.
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
 
@@ -99,6 +105,10 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 - In auto sync mode, if any error occurs, the plugin would **fail silently**.
 - Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
 
+## How To Debug
+
+See [here](./docs/how_to_debug/README.md) for more details.
+
 ## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
 
 See [here](./docs/import_export_some_settings.md) for more details.

docs/browser_env.md

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

docs/browser_env_cors.md

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

docs/browser_env_no_background_after_closing.md

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

docs/browser_env_no_nodejs.md

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

docs/browser_env_oauth2_pkce.md

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

docs/how_to_debug/README.md

@@ -0,0 +1,11 @@
+# How To Debug
+
+Ideally, users do not need to debug anything. But if something bad happened, we have to dig into details.
+
+## Easy: Export Sync Plans
+
+See [here](./export_sync_plans.md).
+
+## Advanced: Check Console Output
+
+See [here](./check_console_output.md).

docs/how_to_debug/check_console_output.md

@@ -0,0 +1,17 @@
+# Check Console Output
+
+If you are using Obsidian on desktop, you can check the Obsidian console.
+
+## Disable Auto Sync Firstly
+
+You should disable auto sync to avoid any unexpected running.
+
+## Set The Output Level To Debug
+
+Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
+
+## Check The Output
+
+Then, press the keyboard shortcut "ctrl+shift+i" if you are on Windows or Linux, or press "cmd+shift+i" if you are on macOS. You should be able to see the console of Obsidian.
+
+Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. You could understand what happened and what goes wrong more explictly by checking the output.

docs/how_to_debug/export_sync_plans.md

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

docs/minimal_intrusive_design.md

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

docs/s3_cors_configure.md

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

docs/services_connectable_or_not.md

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

docs/sync_algorithm_v1.md

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

docs/sync_algorithm_v2.md

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

esbuild.config.mjs

@@ -32,6 +32,8 @@ esbuild
       "electron",
       "fs",
       "crypto",
+      "tls",
+      "net",
       // ...builtins
     ],
     format: "cjs",

manifest.json

@@ -1,8 +1,8 @@
 {
   "id": "remotely-save",
   "name": "Remotely Save",
-  "version": "0.2.14",
-  "minAppVersion": "0.12.15",
+  "version": "0.3.6",
+  "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",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "remotely-save",
-  "version": "0.2.14",
+  "version": "0.3.6",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
     "dev2": "node esbuild.config.mjs",
@@ -15,7 +15,8 @@
     "path": "path-browserify",
     "process": "process/browser",
     "stream": "stream-browserify",
-    "crypto": "crypto-browserify"
+    "crypto": "crypto-browserify",
+    "url": "url/"
   },
   "source": "main.ts",
   "keywords": [],
@@ -51,9 +52,13 @@
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.37.0",
-    "@aws-sdk/lib-storage": "^3.40.1",
+    "@aws-sdk/fetch-http-handler": "^3.53.0",
+    "@aws-sdk/lib-storage": "^3.53.1",
+    "@aws-sdk/protocol-http": "^3.53.0",
+    "@aws-sdk/querystring-builder": "^3.53.0",
     "@aws-sdk/signature-v4-crt": "^3.37.0",
-    "@azure/msal-node": "^1.4.0",
+    "@aws-sdk/types": "^3.53.0",
+    "@azure/msal-node": "^1.6.0",
     "@fyears/tsqueue": "^1.0.1",
     "@microsoft/microsoft-graph-client": "^3.0.1",
     "acorn": "^8.5.0",
@@ -64,18 +69,21 @@
     "crypto-browserify": "^3.12.0",
     "dropbox": "^10.22.0",
     "feather-icons": "^4.28.0",
+    "http-status-codes": "^2.2.0",
     "localforage": "^1.10.0",
     "lodash": "^4.17.21",
     "loglevel": "^1.8.0",
     "mime-types": "^2.1.33",
     "nanoid": "^3.1.30",
-    "obsidian": "^0.12.0",
+    "obsidian": "^0.13.26",
+    "p-queue": "^7.2.0",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
     "qrcode": "^1.5.0",
     "rfc4648": "^1.5.0",
     "rimraf": "^3.0.2",
     "stream-browserify": "^3.0.0",
+    "url": "^0.11.0",
     "util": "^0.12.4",
     "webdav": "^4.7.0",
     "webdav-fs": "^4.0.0",

src/baseTypes.ts

@@ -11,6 +11,7 @@ export interface S3Config {
   s3AccessKeyID: string;
   s3SecretAccessKey: string;
   s3BucketName: string;
+  bypassCorsLocally?: boolean;
 }
 
 export interface DropboxConfig {
@@ -25,13 +26,20 @@ export interface DropboxConfig {
 }
 
 export type WebdavAuthType = "digest" | "basic";
+export type WebdavDepthType =
+  | "auto_unknown"
+  | "auto_1"
+  | "auto_infinity"
+  | "manual_1"
+  | "manual_infinity";
 
 export interface WebdavConfig {
   address: string;
   username: string;
   password: string;
   authType: WebdavAuthType;
-  manualRecursive: boolean;
+  manualRecursive: boolean; // deprecated in 0.3.6, use depth
+  depth?: WebdavDepthType;
 }
 
 export interface OnedriveConfig {
@@ -56,6 +64,11 @@ export interface RemotelySavePluginSettings {
   currLogLevel?: string;
   vaultRandomID?: string;
   autoRunEveryMilliseconds?: number;
+  initRunAfterMilliseconds?: number;
+  agreeToUploadExtraMetadata?: boolean;
+  concurrency?: number;
+  syncConfigDir?: boolean;
+  syncUnderscoreItems?: boolean;
 }
 
 export interface RemoteItem {
@@ -80,3 +93,38 @@ export interface UriParams {
 
 // 80 days
 export const OAUTH2_FORCE_EXPIRE_MILLISECONDS = 1000 * 60 * 60 * 24 * 80;
+
+type DecisionTypeForFile =
+  | "skipUploading" // special, mtimeLocal === mtimeRemote
+  | "uploadLocalDelHistToRemote" // "delLocalIfExists && delRemoteIfExists && cleanLocalDelHist && uploadLocalDelHistToRemote"
+  | "keepRemoteDelHist" // "delLocalIfExists && delRemoteIfExists && cleanLocalDelHist && keepRemoteDelHist"
+  | "uploadLocalToRemote" // "skipLocal && uploadLocalToRemote && cleanLocalDelHist && cleanRemoteDelHist"
+  | "downloadRemoteToLocal"; // "downloadRemoteToLocal && skipRemote && cleanLocalDelHist && cleanRemoteDelHist"
+
+type DecisionTypeForFolder =
+  | "createFolder"
+  | "uploadLocalDelHistToRemoteFolder"
+  | "keepRemoteDelHistFolder"
+  | "skipFolder";
+
+export type DecisionType = DecisionTypeForFile | DecisionTypeForFolder;
+
+export interface FileOrFolderMixedState {
+  key: string;
+  existLocal?: boolean;
+  existRemote?: boolean;
+  mtimeLocal?: number;
+  mtimeRemote?: number;
+  deltimeLocal?: number;
+  deltimeRemote?: number;
+  sizeLocal?: number;
+  sizeRemote?: number;
+  changeMtimeUsingMapping?: boolean;
+  decision?: DecisionType;
+  decisionBranch?: number;
+  syncDone?: "done";
+  remoteEncryptedKey?: string;
+}
+
+export const API_VER_STAT_FOLDER = "0.13.27";
+export const API_VER_REQURL = "0.13.26";

src/main.ts

@@ -34,11 +34,14 @@ import {
 import { DEFAULT_S3_CONFIG } from "./remoteForS3";
 import { DEFAULT_WEBDAV_CONFIG } from "./remoteForWebdav";
 import { RemotelySaveSettingTab } from "./settings";
-import type { SyncStatusType } from "./sync";
+import { fetchMetadataFile, parseRemoteItems, SyncStatusType } from "./sync";
 import { doActualSync, getSyncPlan, isPasswordOk } from "./sync";
 import { messyConfigToNormal, normalConfigToMessy } from "./configPersist";
+import { ObsConfigDirFileType, listFilesInObsFolder } from "./obsFolderLister";
 
 import * as origLog from "loglevel";
+import { DeletionOnRemote, MetadataOnRemote } from "./metadataOnRemote";
+import { SyncAlgoV2Modal } from "./syncAlgoV2Notice";
 const log = origLog.getLogger("rs-default");
 
 const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
@@ -51,6 +54,11 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   currLogLevel: "info",
   vaultRandomID: "",
   autoRunEveryMilliseconds: -1,
+  initRunAfterMilliseconds: -1,
+  agreeToUploadExtraMetadata: false,
+  concurrency: 5,
+  syncConfigDir: false,
+  syncUnderscoreItems: false,
 };
 
 interface OAuth2Info {
@@ -61,7 +69,7 @@ interface OAuth2Info {
   revokeAuthSetting?: Setting;
 }
 
-type SyncTriggerSourceType = "manual" | "auto";
+type SyncTriggerSourceType = "manual" | "auto" | "dry" | "autoOnceInit";
 
 const iconNameSyncWait = `remotely-save-sync-wait`;
 const iconNameSyncRunning = `remotely-save-sync-running`;
@@ -89,7 +97,7 @@ export default class RemotelySavePlugin extends Plugin {
     const getNotice = (x: string) => {
       // only show notices in manual mode
       // no notice in auto mode
-      if (triggerSource === "manual") {
+      if (triggerSource === "manual" || triggerSource === "dry") {
         new Notice(x);
       }
     };
@@ -122,14 +130,22 @@ export default class RemotelySavePlugin extends Plugin {
         );
       }
 
+      const MAX_STEPS = 8;
+
+      if (triggerSource === "dry") {
+        getNotice(
+          `0/${MAX_STEPS} Remotely Save running in dry mode, not actual file changes would happen.`
+        );
+      }
+
       //log.info(`huh ${this.settings.password}`)
       getNotice(
-        `1/7 Remotely Save Sync Preparing (${this.settings.serviceType})`
+        `1/${MAX_STEPS} Remotely Save Sync Preparing (${this.settings.serviceType})`
       );
       this.syncStatus = "preparing";
 
-      getNotice("2/7 Starting to fetch remote meta data.");
-      this.syncStatus = "getting_remote_meta";
+      getNotice(`2/${MAX_STEPS} Starting to fetch remote meta data.`);
+      this.syncStatus = "getting_remote_files_list";
       const self = this;
       const client = new RemoteClient(
         this.settings.serviceType,
@@ -141,19 +157,9 @@ export default class RemotelySavePlugin extends Plugin {
         () => self.saveSettings()
       );
       const remoteRsp = await client.listFromRemote();
-      log.info(remoteRsp);
+      log.debug(remoteRsp);
 
-      getNotice("3/7 Starting to fetch local meta data.");
-      this.syncStatus = "getting_local_meta";
-      const local = this.app.vault.getAllLoadedFiles();
-      const localHistory = await loadDeleteRenameHistoryTableByVault(
-        this.db,
-        this.settings.vaultRandomID
-      );
-      // log.info(local);
-      // log.info(localHistory);
-
-      getNotice("4/7 Checking password correct or not.");
+      getNotice(`3/${MAX_STEPS} Checking password correct or not.`);
       this.syncStatus = "checking_password";
       const passwordCheckResult = await isPasswordOk(
         remoteRsp.Contents,
@@ -164,43 +170,95 @@ export default class RemotelySavePlugin extends Plugin {
         throw Error(passwordCheckResult.reason);
       }
 
-      getNotice("5/7 Starting to generate sync plan.");
-      this.syncStatus = "generating_plan";
-      const syncPlan = await getSyncPlan(
+      getNotice(`4/${MAX_STEPS} Trying to fetch extra meta data from remote.`);
+      this.syncStatus = "getting_remote_extra_meta";
+      const { remoteStates, metadataFile } = await parseRemoteItems(
         remoteRsp.Contents,
-        local,
-        localHistory,
         this.db,
         this.settings.vaultRandomID,
         client.serviceType,
         this.settings.password
       );
-      log.info(syncPlan.mixedStates); // for debugging
-      await insertSyncPlanRecordByVault(
+      const origMetadataOnRemote = await fetchMetadataFile(
+        metadataFile,
+        client,
+        this.app.vault,
+        this.settings.password
+      );
+
+      getNotice(`5/${MAX_STEPS} Starting to fetch local meta data.`);
+      this.syncStatus = "getting_local_meta";
+      const local = this.app.vault.getAllLoadedFiles();
+      const localHistory = await loadDeleteRenameHistoryTableByVault(
         this.db,
-        syncPlan,
         this.settings.vaultRandomID
       );
+      let localConfigDirContents: ObsConfigDirFileType[] = undefined;
+      if (this.settings.syncConfigDir) {
+        localConfigDirContents = await listFilesInObsFolder(
+          this.app.vault.configDir,
+          this.app.vault,
+          this.manifest.id
+        );
+      }
+      // log.info(local);
+      // log.info(localHistory);
 
-      // The operations above are read only and kind of safe.
+      getNotice(`6/${MAX_STEPS} Starting to generate sync plan.`);
+      this.syncStatus = "generating_plan";
+      const { plan, sortedKeys, deletions } = await getSyncPlan(
+        remoteStates,
+        local,
+        localConfigDirContents,
+        origMetadataOnRemote.deletions,
+        localHistory,
+        client.serviceType,
+        this.app.vault,
+        this.settings.syncConfigDir,
+        this.app.vault.configDir,
+        this.settings.syncUnderscoreItems,
+        this.settings.password
+      );
+      log.info(plan.mixedStates); // for debugging
+      if (triggerSource !== "dry") {
+        await insertSyncPlanRecordByVault(
+          this.db,
+          plan,
+          this.settings.vaultRandomID
+        );
+      }
+
+      // The operations above are almost read only and kind of safe.
       // The operations below begins to write or delete (!!!) something.
 
-      getNotice("6/7 Remotely Save Sync data exchanging!");
+      if (triggerSource !== "dry") {
+        getNotice(`7/${MAX_STEPS} Remotely Save Sync data exchanging!`);
 
-      this.syncStatus = "syncing";
-      await doActualSync(
-        client,
-        this.db,
-        this.settings.vaultRandomID,
-        this.app.vault,
-        syncPlan,
-        this.settings.password,
-        (i: number, totalCount: number, pathName: string, decision: string) =>
-          self.setCurrSyncMsg(i, totalCount, pathName, decision)
-      );
+        this.syncStatus = "syncing";
+        await doActualSync(
+          client,
+          this.db,
+          this.settings.vaultRandomID,
+          this.app.vault,
+          plan,
+          sortedKeys,
+          metadataFile,
+          origMetadataOnRemote,
+          deletions,
+          (key: string) => self.trash(key),
+          this.settings.password,
+          this.settings.concurrency,
+          (i: number, totalCount: number, pathName: string, decision: string) =>
+            self.setCurrSyncMsg(i, totalCount, pathName, decision)
+        );
+      } else {
+        this.syncStatus = "syncing";
+        getNotice(
+          `7/${MAX_STEPS} Remotely Save real sync is skipped in dry run mode.`
+        );
+      }
 
-      getNotice("7/7 Remotely Save finish!");
-      this.currSyncMsg = "";
+      getNotice(`8/${MAX_STEPS} Remotely Save finish!`);
       this.syncStatus = "finish";
       this.syncStatus = "idle";
 
@@ -257,6 +315,9 @@ export default class RemotelySavePlugin extends Plugin {
     await this.checkIfOauthExpires();
     await this.checkIfVaultIDAssigned(); // MUST before prepareDB()
 
+    // no need to await this
+    this.tryToAddIgnoreFile();
+
     await this.prepareDB();
 
     this.syncStatus = "idle";
@@ -474,22 +535,27 @@ export default class RemotelySavePlugin extends Plugin {
       },
     });
 
+    this.addCommand({
+      id: "start-sync-dry-run",
+      name: "start sync (dry run only)",
+      icon: iconNameSyncWait,
+      callback: async () => {
+        this.syncRun("dry");
+      },
+    });
+
     this.addSettingTab(new RemotelySaveSettingTab(this.app, this));
 
     // this.registerDomEvent(document, "click", (evt: MouseEvent) => {
     //   log.info("click", evt);
     // });
 
-    if (
-      this.settings.autoRunEveryMilliseconds !== undefined &&
-      this.settings.autoRunEveryMilliseconds !== null &&
-      this.settings.autoRunEveryMilliseconds > 0
-    ) {
-      const intervalID = window.setInterval(() => {
-        this.syncRun("auto");
-      }, this.settings.autoRunEveryMilliseconds);
-      this.autoRunIntervalID = intervalID;
-      this.registerInterval(intervalID);
+    if (!this.settings.agreeToUploadExtraMetadata) {
+      const syncAlgoV2Modal = new SyncAlgoV2Modal(this.app, this);
+      syncAlgoV2Modal.open();
+    } else {
+      this.enableAutoSyncIfSet();
+      this.enableInitSyncIfSet();
     }
   }
 
@@ -516,6 +582,9 @@ export default class RemotelySavePlugin extends Plugin {
     if (this.settings.webdav.manualRecursive === undefined) {
       this.settings.webdav.manualRecursive = false;
     }
+    if (this.settings.webdav.depth === undefined) {
+      this.settings.webdav.depth = "auto_unknown";
+    }
   }
 
   async saveSettings() {
@@ -602,10 +671,51 @@ export default class RemotelySavePlugin extends Plugin {
     }
   }
 
+  async trash(x: string) {
+    if (!(await this.app.vault.adapter.trashSystem(x))) {
+      await this.app.vault.adapter.trashLocal(x);
+    }
+  }
+
   async prepareDB() {
     this.db = await prepareDBs(this.settings.vaultRandomID);
   }
 
+  enableAutoSyncIfSet() {
+    if (
+      this.settings.autoRunEveryMilliseconds !== undefined &&
+      this.settings.autoRunEveryMilliseconds !== null &&
+      this.settings.autoRunEveryMilliseconds > 0
+    ) {
+      this.app.workspace.onLayoutReady(() => {
+        const intervalID = window.setInterval(() => {
+          this.syncRun("auto");
+        }, this.settings.autoRunEveryMilliseconds);
+        this.autoRunIntervalID = intervalID;
+        this.registerInterval(intervalID);
+      });
+    }
+  }
+
+  enableInitSyncIfSet() {
+    if (
+      this.settings.initRunAfterMilliseconds !== undefined &&
+      this.settings.initRunAfterMilliseconds !== null &&
+      this.settings.initRunAfterMilliseconds > 0
+    ) {
+      this.app.workspace.onLayoutReady(() => {
+        window.setTimeout(() => {
+          this.syncRun("autoOnceInit");
+        }, this.settings.initRunAfterMilliseconds);
+      });
+    }
+  }
+
+  async saveAgreeToUseNewSyncAlgorithm() {
+    this.settings.agreeToUploadExtraMetadata = true;
+    await this.saveSettings();
+  }
+
   destroyDBs() {
     /* destroyDBs(this.db); */
   }
@@ -619,4 +729,39 @@ export default class RemotelySavePlugin extends Plugin {
     const msg = `syncing progress=${i}/${totalCount},decision=${decision},path=${pathName}`;
     this.currSyncMsg = msg;
   }
+
+  async tryToAddIgnoreFile() {
+    const pluginConfigDir =
+      this.manifest.dir ||
+      `${this.app.vault.configDir}/plugins/${this.manifest.dir}`;
+    const pluginConfigDirExists = await this.app.vault.adapter.exists(
+      pluginConfigDir
+    );
+    if (!pluginConfigDirExists) {
+      // what happened?
+      return;
+    }
+    const ignoreFile = `${pluginConfigDir}/.gitignore`;
+    const ignoreFileExists = await this.app.vault.adapter.exists(ignoreFile);
+
+    const contentText = "data.json\n";
+
+    try {
+      if (ignoreFileExists) {
+        // check empty, if empty, we can write it
+        // if not empty, we do nothing
+        const content = (await this.app.vault.adapter.read(ignoreFile)).trim();
+        if (content === "") {
+          // no need to await writing
+          this.app.vault.adapter.write(ignoreFile, contentText);
+        }
+      } else {
+        // not exists, directly create
+        // no need to await
+        this.app.vault.adapter.write(ignoreFile, contentText);
+      }
+    } catch (error) {
+      // just skip
+    }
+  }
 }

src/metadataOnRemote.ts

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

src/misc.ts

@@ -10,10 +10,18 @@ const log = origLog.getLogger("rs-default");
 /**
  * If any part of the file starts with '.' or '_' then it's a hidden file.
  * @param item
- * @param loose
+ * @param dot
+ * @param underscore
  * @returns
  */
-export const isHiddenPath = (item: string, loose: boolean = true) => {
+export const isHiddenPath = (
+  item: string,
+  dot: boolean = true,
+  underscore: boolean = true
+) => {
+  if (!(dot || underscore)) {
+    throw Error("parameter error for isHiddenPath");
+  }
   const k = path.posix.normalize(item); // TODO: only unix path now
   const k2 = k.split("/"); // TODO: only unix path now
   // log.info(k2)
@@ -21,10 +29,10 @@ export const isHiddenPath = (item: string, loose: boolean = true) => {
     if (singlePart === "." || singlePart === ".." || singlePart === "") {
       continue;
     }
-    if (singlePart[0] === ".") {
+    if (dot && singlePart[0] === ".") {
       return true;
     }
-    if (loose && singlePart[0] === "_") {
+    if (underscore && singlePart[0] === "_") {
       return true;
     }
   }
@@ -38,7 +46,7 @@ export const isHiddenPath = (item: string, loose: boolean = true) => {
  * @param x string
  * @returns string[] might be empty
  */
-export const getFolderLevels = (x: string) => {
+export const getFolderLevels = (x: string, addEndingSlash: boolean = false) => {
   const res: string[] = [];
 
   if (x === "" || x === "/") {
@@ -48,10 +56,14 @@ export const getFolderLevels = (x: string) => {
   const y1 = x.split("/");
   let i = 0;
   for (let index = 0; index + 1 < y1.length; index++) {
-    const k = y1.slice(0, index + 1).join("/");
-    if (k !== "" && k !== "/") {
-      res.push(k);
+    let k = y1.slice(0, index + 1).join("/");
+    if (k === "" || k === "/") {
+      continue;
     }
+    if (addEndingSlash) {
+      k = `${k}/`;
+    }
+    res.push(k);
   }
   return res;
 };
@@ -75,7 +87,9 @@ export const mkdirpInVault = async (thePath: string, vault: Vault) => {
  * @param b Buffer
  * @returns ArrayBuffer
  */
-export const bufferToArrayBuffer = (b: Buffer | Uint8Array) => {
+export const bufferToArrayBuffer = (
+  b: Buffer | Uint8Array | ArrayBufferView
+) => {
   return b.buffer.slice(b.byteOffset, b.byteOffset + b.byteLength);
 };
 
@@ -157,6 +171,24 @@ export const getPathFolder = (a: string) => {
   return b.endsWith("/") ? b : `${b}/`;
 };
 
+/**
+ * If input is already a folder, returns its folder;
+ * And if input is a file, returns its direname.
+ * @param a
+ * @returns
+ */
+export const getParentFolder = (a: string) => {
+  const b = path.posix.dirname(a);
+  if (b === "." || b === "/") {
+    // the root
+    return "/";
+  }
+  if (b.endsWith("/")) {
+    return b;
+  }
+  return `${b}/`;
+};
+
 /**
  * https://stackoverflow.com/questions/54511144
  * @param a
@@ -208,3 +240,31 @@ export const getRandomArrayBuffer = (byteLength: number) => {
 export const reverseString = (x: string) => {
   return [...x].reverse().join("");
 };
+
+export interface SplitRange {
+  partNum: number; // startting from 1
+  start: number;
+  end: number; // exclusive
+}
+export const getSplitRanges = (bytesTotal: number, bytesEachPart: number) => {
+  const res: SplitRange[] = [];
+  if (bytesEachPart >= bytesTotal) {
+    res.push({
+      partNum: 1,
+      start: 0,
+      end: bytesTotal,
+    });
+    return res;
+  }
+  const remainder = bytesTotal % bytesEachPart;
+  const howMany =
+    Math.floor(bytesTotal / bytesEachPart) + (remainder === 0 ? 0 : 1);
+  for (let i = 0; i < howMany; ++i) {
+    res.push({
+      partNum: i + 1,
+      start: bytesEachPart * i,
+      end: Math.min(bytesEachPart * (i + 1), bytesTotal),
+    });
+  }
+  return res;
+};

src/obsFolderLister.ts

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

src/remote.ts

@@ -41,11 +41,17 @@ export class RemoteClient {
       this.s3Config = s3Config;
       this.s3Client = s3.getS3Client(this.s3Config);
     } else if (serviceType === "webdav") {
-      if (vaultName === undefined) {
-        throw Error("remember to provide vault name while init webdav client");
+      if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
+        throw Error(
+          "remember to provide vault name and callback while init webdav client"
+        );
       }
       this.webdavConfig = webdavConfig;
-      this.webdavClient = webdav.getWebdavClient(this.webdavConfig, vaultName);
+      this.webdavClient = webdav.getWebdavClient(
+        this.webdavConfig,
+        vaultName,
+        saveUpdatedConfigFunc
+      );
     } else if (serviceType === "dropbox") {
       if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
         throw Error(
@@ -102,7 +108,9 @@ export class RemoteClient {
     isRecursively: boolean = false,
     password: string = "",
     remoteEncryptedKey: string = "",
-    foldersCreatedBefore: Set<string> | undefined = undefined
+    foldersCreatedBefore: Set<string> | undefined = undefined,
+    uploadRaw: boolean = false,
+    rawContent: string | ArrayBuffer = ""
   ) => {
     if (this.serviceType === "s3") {
       return await s3.uploadToRemote(
@@ -112,7 +120,9 @@ export class RemoteClient {
         vault,
         isRecursively,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        uploadRaw,
+        rawContent
       );
     } else if (this.serviceType === "webdav") {
       return await webdav.uploadToRemote(
@@ -121,7 +131,9 @@ export class RemoteClient {
         vault,
         isRecursively,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        uploadRaw,
+        rawContent
       );
     } else if (this.serviceType === "dropbox") {
       return await dropbox.uploadToRemote(
@@ -131,7 +143,9 @@ export class RemoteClient {
         isRecursively,
         password,
         remoteEncryptedKey,
-        foldersCreatedBefore
+        foldersCreatedBefore,
+        uploadRaw,
+        rawContent
       );
     } else if (this.serviceType === "onedrive") {
       return await onedrive.uploadToRemote(
@@ -141,7 +155,9 @@ export class RemoteClient {
         isRecursively,
         password,
         remoteEncryptedKey,
-        foldersCreatedBefore
+        foldersCreatedBefore,
+        uploadRaw,
+        rawContent
       );
     } else {
       throw Error(`not supported service type ${this.serviceType}`);
@@ -167,7 +183,8 @@ export class RemoteClient {
     vault: Vault,
     mtime: number,
     password: string = "",
-    remoteEncryptedKey: string = ""
+    remoteEncryptedKey: string = "",
+    skipSaving: boolean = false
   ) => {
     if (this.serviceType === "s3") {
       return await s3.downloadFromRemote(
@@ -177,7 +194,8 @@ export class RemoteClient {
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else if (this.serviceType === "webdav") {
       return await webdav.downloadFromRemote(
@@ -186,7 +204,8 @@ export class RemoteClient {
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else if (this.serviceType === "dropbox") {
       return await dropbox.downloadFromRemote(
@@ -195,7 +214,8 @@ export class RemoteClient {
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else if (this.serviceType === "onedrive") {
       return await onedrive.downloadFromRemote(
@@ -204,7 +224,8 @@ export class RemoteClient {
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else {
       throw Error(`not supported service type ${this.serviceType}`);

src/remoteForDropbox.ts

@@ -156,13 +156,20 @@ const fixLastModifiedTimeInplace = (allFilesFolders: RemoteItem[]) => {
 // see https://dropbox.tech/developers/pkce--what-and-why-
 ////////////////////////////////////////////////////////////////////////////////
 
-export const getAuthUrlAndVerifier = async (appKey: string) => {
+export const getAuthUrlAndVerifier = async (
+  appKey: string,
+  needManualPatse: boolean = false
+) => {
   const auth = new DropboxAuth({
     clientId: appKey,
   });
+
+  const callback = needManualPatse
+    ? undefined
+    : `obsidian://${COMMAND_CALLBACK_DROPBOX}`;
   const authUrl = (
     await auth.getAuthenticationUrl(
-      `obsidian://${COMMAND_CALLBACK_DROPBOX}`,
+      callback,
       undefined,
       "code",
       "offline",
@@ -400,7 +407,9 @@ export const uploadToRemote = async (
   isRecursively: boolean = false,
   password: string = "",
   remoteEncryptedKey: string = "",
-  foldersCreatedBefore: Set<string> | undefined = undefined
+  foldersCreatedBefore: Set<string> | undefined = undefined,
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
 ) => {
   await client.init();
 
@@ -415,6 +424,9 @@ export const uploadToRemote = async (
   if (isFolder && isRecursively) {
     throw Error("upload function doesn't implement recursive function yet!");
   } else if (isFolder && !isRecursively) {
+    if (uploadRaw) {
+      throw Error(`you specify uploadRaw, but you also provide a folder key!`);
+    }
     // folder
     if (password === "") {
       // if not encrypted, mkdir a remote folder
@@ -448,7 +460,16 @@ export const uploadToRemote = async (
   } else {
     // file
     // we ignore isRecursively parameter here
-    const localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    let localContent = undefined;
+    if (uploadRaw) {
+      if (typeof rawContent === "string") {
+        localContent = new TextEncoder().encode(rawContent).buffer;
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
@@ -551,13 +572,16 @@ export const downloadFromRemote = async (
   vault: Vault,
   mtime: number,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  skipSaving: boolean = false
 ) => {
   await client.init();
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
-  await mkdirpInVault(fileOrFolderPath, vault);
+  if (!skipSaving) {
+    await mkdirpInVault(fileOrFolderPath, vault);
+  }
 
   // the file is always local file
   // we need to encrypt it
@@ -565,6 +589,7 @@ export const downloadFromRemote = async (
   if (isFolder) {
     // mkdirp locally is enough
     // do nothing here
+    return new ArrayBuffer(0);
   } else {
     let downloadFile = fileOrFolderPath;
     if (password !== "") {
@@ -576,9 +601,12 @@ export const downloadFromRemote = async (
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
-    await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
-      mtime: mtime,
-    });
+    if (!skipSaving) {
+      await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
+        mtime: mtime,
+      });
+    }
+    return localContent;
   }
 };
 

src/remoteForOnedrive.ts

@@ -7,8 +7,9 @@ import type {
 } from "@microsoft/microsoft-graph-types";
 import cloneDeep from "lodash/cloneDeep";
 import * as origLog from "loglevel";
-import { request, Vault } from "obsidian";
+import { request, requestUrl, requireApiVersion, Vault } from "obsidian";
 import {
+  API_VER_REQURL,
   COMMAND_CALLBACK_ONEDRIVE,
   OAUTH2_FORCE_EXPIRE_MILLISECONDS,
   OnedriveConfig,
@@ -16,6 +17,7 @@ import {
 } from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import {
+  bufferToArrayBuffer,
   getRandomArrayBuffer,
   getRandomIntInclusive,
   mkdirpInVault,
@@ -482,28 +484,45 @@ export class WrappedOnedriveClient {
   deleteJson = async (pathFragOrig: string) => {
     const theUrl = this.buildUrl(pathFragOrig);
     log.debug(`deleteJson, theUrl=${theUrl}`);
-    // TODO: delete does not have response, so Obsidian request may have error
-    // currently downgraded to fetch()!
-    await fetch(theUrl, {
-      method: "DELETE",
-      headers: {
-        Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
-      },
-    });
+    if (requireApiVersion(API_VER_REQURL)) {
+      await requestUrl({
+        url: theUrl,
+        method: "DELETE",
+        headers: {
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      });
+    } else {
+      await fetch(theUrl, {
+        method: "DELETE",
+        headers: {
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      });
+    }
   };
 
   putArrayBuffer = async (pathFragOrig: string, payload: ArrayBuffer) => {
     const theUrl = this.buildUrl(pathFragOrig);
     log.debug(`putArrayBuffer, theUrl=${theUrl}`);
-    // TODO: Obsidian doesn't support ArrayBuffer
-    // currently downgraded to fetch()!
-    await fetch(theUrl, {
-      method: "PUT",
-      body: payload,
-      headers: {
-        Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
-      },
-    });
+    if (requireApiVersion(API_VER_REQURL)) {
+      await requestUrl({
+        url: theUrl,
+        method: "PUT",
+        body: payload,
+        headers: {
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      });
+    } else {
+      await fetch(theUrl, {
+        method: "PUT",
+        body: payload,
+        headers: {
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      });
+    }
   };
 
   /**
@@ -527,20 +546,31 @@ export class WrappedOnedriveClient {
         rangeEnd - 1
       }, len=${rangeEnd - rangeStart}, size=${size}`
     );
-    // TODO: Obsidian doesn't support ArrayBuffer
-    // currently downgraded to fetch()!
-    // AND, NO AUTH HEADER here!
-    const res = await fetch(theUrl, {
-      method: "PUT",
-      body: payload.subarray(rangeStart, rangeEnd),
-      headers: {
-        "Content-Length": `${rangeEnd - rangeStart}`,
-        "Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
-        "Content-Type": "application/octet-stream",
-      },
-    });
-
-    return res.json() as DriveItem | UploadSession;
+    // NO AUTH HEADER here!
+    if (requireApiVersion(API_VER_REQURL)) {
+      const res = await requestUrl({
+        url: theUrl,
+        method: "PUT",
+        body: bufferToArrayBuffer(payload.subarray(rangeStart, rangeEnd)),
+        headers: {
+          // no "Content-Length" allowed here
+          "Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
+          "Content-Type": "application/octet-stream",
+        },
+      });
+      return res.json as DriveItem | UploadSession;
+    } else {
+      const res = await fetch(theUrl, {
+        method: "PUT",
+        body: payload.subarray(rangeStart, rangeEnd),
+        headers: {
+          "Content-Length": `${rangeEnd - rangeStart}`,
+          "Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
+          "Content-Type": "application/octet-stream",
+        },
+      });
+      return (await res.json()) as DriveItem | UploadSession;
+    }
   };
 }
 
@@ -624,7 +654,9 @@ export const uploadToRemote = async (
   isRecursively: boolean = false,
   password: string = "",
   remoteEncryptedKey: string = "",
-  foldersCreatedBefore: Set<string> | undefined = undefined
+  foldersCreatedBefore: Set<string> | undefined = undefined,
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
 ) => {
   await client.init();
 
@@ -640,6 +672,9 @@ export const uploadToRemote = async (
   if (isFolder && isRecursively) {
     throw Error("upload function doesn't implement recursive function yet!");
   } else if (isFolder && !isRecursively) {
+    if (uploadRaw) {
+      throw Error(`you specify uploadRaw, but you also provide a folder key!`);
+    }
     // folder
     if (password === "") {
       // if not encrypted, mkdir a remote folder
@@ -682,7 +717,16 @@ export const uploadToRemote = async (
   } else {
     // file
     // we ignore isRecursively parameter here
-    const localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    let localContent = undefined;
+    if (uploadRaw) {
+      if (typeof rawContent === "string") {
+        localContent = new TextEncoder().encode(rawContent).buffer;
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
@@ -690,40 +734,52 @@ export const uploadToRemote = async (
 
     // no need to create parent folders firstly, cool!
 
-    // upload large files!
-    // ref: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createuploadsession?view=odsp-graph-online
-
-    // 1. create uploadSession
-    // uploadFile already starts with /drive/special/approot:/${vaultName}
-    const s: UploadSession = await client.postJson(
-      `${uploadFile}:/createUploadSession`,
-      {
-        item: {
-          "@microsoft.graph.conflictBehavior": "replace",
-        },
-      }
-    );
-    const uploadUrl = s.uploadUrl;
-    log.debug("uploadSession = ");
-    log.debug(s);
-
-    // 2. upload by ranges
-    // convert to uint8
-    const uint8 = new Uint8Array(remoteContent);
     // hard code range size
     const MIN_UNIT = 327680; // bytes in msft doc, about 0.32768 MB
     const RANGE_SIZE = MIN_UNIT * 20; // about 6.5536 MB
-    // upload the ranges one by one
-    let rangeStart = 0;
-    while (rangeStart < uint8.byteLength) {
-      await client.putUint8ArrayByRange(
-        uploadUrl,
-        uint8,
-        rangeStart,
-        Math.min(rangeStart + RANGE_SIZE, uint8.byteLength),
-        uint8.byteLength
+
+    if (remoteContent.byteLength <= RANGE_SIZE) {
+      // directly using put!
+      await client.putArrayBuffer(
+        `${uploadFile}:/content?${new URLSearchParams({
+          "@microsoft.graph.conflictBehavior": "replace",
+        })}`,
+        remoteContent
       );
-      rangeStart += RANGE_SIZE;
+    } else {
+      // upload large files!
+      // ref: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createuploadsession?view=odsp-graph-online
+
+      // 1. create uploadSession
+      // uploadFile already starts with /drive/special/approot:/${vaultName}
+      const s: UploadSession = await client.postJson(
+        `${uploadFile}:/createUploadSession`,
+        {
+          item: {
+            "@microsoft.graph.conflictBehavior": "replace",
+          },
+        }
+      );
+      const uploadUrl = s.uploadUrl;
+      log.debug("uploadSession = ");
+      log.debug(s);
+
+      // 2. upload by ranges
+      // convert to uint8
+      const uint8 = new Uint8Array(remoteContent);
+
+      // upload the ranges one by one
+      let rangeStart = 0;
+      while (rangeStart < uint8.byteLength) {
+        await client.putUint8ArrayByRange(
+          uploadUrl,
+          uint8,
+          rangeStart,
+          Math.min(rangeStart + RANGE_SIZE, uint8.byteLength),
+          uint8.byteLength
+        );
+        rangeStart += RANGE_SIZE;
+      }
     }
 
     const res = await getRemoteMeta(client, uploadFile);
@@ -741,8 +797,13 @@ const downloadFromRemoteRaw = async (
     `${key}?$select=@microsoft.graph.downloadUrl`
   );
   const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
-  const content = await (await fetch(downloadUrl)).arrayBuffer();
-  return content;
+  if (requireApiVersion(API_VER_REQURL)) {
+    const content = (await requestUrl({ url: downloadUrl })).arrayBuffer;
+    return content;
+  } else {
+    const content = await (await fetch(downloadUrl)).arrayBuffer();
+    return content;
+  }
 };
 
 export const downloadFromRemote = async (
@@ -751,17 +812,21 @@ export const downloadFromRemote = async (
   vault: Vault,
   mtime: number,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  skipSaving: boolean = false
 ) => {
   await client.init();
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
-  await mkdirpInVault(fileOrFolderPath, vault);
+  if (!skipSaving) {
+    await mkdirpInVault(fileOrFolderPath, vault);
+  }
 
   if (isFolder) {
     // mkdirp locally is enough
     // do nothing here
+    return new ArrayBuffer(0);
   } else {
     let downloadFile = fileOrFolderPath;
     if (password !== "") {
@@ -773,9 +838,12 @@ export const downloadFromRemote = async (
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
-    await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
-      mtime: mtime,
-    });
+    if (!skipSaving) {
+      await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
+        mtime: mtime,
+      });
+    }
+    return localContent;
   }
 };
 

src/remoteForS3.ts

@@ -11,11 +11,26 @@ import {
   S3Client,
 } from "@aws-sdk/client-s3";
 import { Upload } from "@aws-sdk/lib-storage";
+import { HttpHandler, HttpRequest, HttpResponse } from "@aws-sdk/protocol-http";
+import {
+  FetchHttpHandler,
+  FetchHttpHandlerOptions,
+} from "@aws-sdk/fetch-http-handler";
+// @ts-ignore
+import { requestTimeout } from "@aws-sdk/fetch-http-handler/dist-es/request-timeout";
+import { buildQueryString } from "@aws-sdk/querystring-builder";
+import { HeaderBag, HttpHandlerOptions, Provider } from "@aws-sdk/types";
 import { Buffer } from "buffer";
 import * as mime from "mime-types";
-import { Vault } from "obsidian";
+import {
+  Vault,
+  requestUrl,
+  RequestUrlParam,
+  RequestUrlResponse,
+  requireApiVersion,
+} from "obsidian";
 import { Readable } from "stream";
-import { RemoteItem, S3Config } from "./baseTypes";
+import { API_VER_REQURL, RemoteItem, S3Config } from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import {
   arrayBufferToBuffer,
@@ -28,12 +43,117 @@ export { S3Client } from "@aws-sdk/client-s3";
 import * as origLog from "loglevel";
 const log = origLog.getLogger("rs-default");
 
+////////////////////////////////////////////////////////////////////////////////
+// special handler using Obsidian requestUrl
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * This is close to origin implementation of FetchHttpHandler
+ * https://github.com/aws/aws-sdk-js-v3/blob/main/packages/fetch-http-handler/src/fetch-http-handler.ts
+ * that is released under Apache 2 License.
+ * But this uses Obsidian requestUrl instead.
+ */
+class ObsHttpHandler extends FetchHttpHandler {
+  requestTimeoutInMs: number;
+  constructor(options?: FetchHttpHandlerOptions) {
+    super(options);
+    this.requestTimeoutInMs =
+      options === undefined ? undefined : options.requestTimeout;
+  }
+  async handle(
+    request: HttpRequest,
+    { abortSignal }: HttpHandlerOptions = {}
+  ): Promise<{ response: HttpResponse }> {
+    if (abortSignal?.aborted) {
+      const abortError = new Error("Request aborted");
+      abortError.name = "AbortError";
+      return Promise.reject(abortError);
+    }
+
+    let path = request.path;
+    if (request.query) {
+      const queryString = buildQueryString(request.query);
+      if (queryString) {
+        path += `?${queryString}`;
+      }
+    }
+
+    const { port, method } = request;
+    const url = `${request.protocol}//${request.hostname}${
+      port ? `:${port}` : ""
+    }${path}`;
+    const body =
+      method === "GET" || method === "HEAD" ? undefined : request.body;
+
+    const transformedHeaders = { ...request.headers };
+    delete transformedHeaders["host"];
+    delete transformedHeaders["Host"];
+    delete transformedHeaders["content-length"];
+    delete transformedHeaders["Content-Length"];
+
+    let contentType: string = undefined;
+    if (transformedHeaders["content-type"] !== undefined) {
+      contentType = transformedHeaders["content-type"];
+    }
+
+    let transformedBody: any = body;
+    if (ArrayBuffer.isView(body)) {
+      transformedBody = bufferToArrayBuffer(body);
+    }
+
+    const param: RequestUrlParam = {
+      body: transformedBody,
+      headers: transformedHeaders,
+      method: method,
+      url: url,
+      contentType: contentType,
+    };
+
+    const raceOfPromises = [
+      requestUrl(param).then((rsp) => {
+        const stream = new ReadableStream<Uint8Array>({
+          start(controller) {
+            controller.enqueue(new Uint8Array(rsp.arrayBuffer));
+            controller.close();
+          },
+        });
+        return {
+          response: new HttpResponse({
+            headers: rsp.headers,
+            statusCode: rsp.status,
+            body: stream,
+          }),
+        };
+      }),
+      requestTimeout(this.requestTimeoutInMs),
+    ];
+
+    if (abortSignal) {
+      raceOfPromises.push(
+        new Promise<never>((resolve, reject) => {
+          abortSignal.onabort = () => {
+            const abortError = new Error("Request aborted");
+            abortError.name = "AbortError";
+            reject(abortError);
+          };
+        })
+      );
+    }
+    return Promise.race(raceOfPromises);
+  }
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// other stuffs
+////////////////////////////////////////////////////////////////////////////////
+
 export const DEFAULT_S3_CONFIG = {
   s3Endpoint: "",
   s3Region: "",
   s3AccessKeyID: "",
   s3SecretAccessKey: "",
   s3BucketName: "",
+  bypassCorsLocally: true,
 };
 
 export type S3ObjectType = _Object;
@@ -66,15 +186,29 @@ export const getS3Client = (s3Config: S3Config) => {
   if (!(endpoint.startsWith("http://") || endpoint.startsWith("https://"))) {
     endpoint = `https://${endpoint}`;
   }
-  const s3Client = new S3Client({
-    region: s3Config.s3Region,
-    endpoint: endpoint,
-    credentials: {
-      accessKeyId: s3Config.s3AccessKeyID,
-      secretAccessKey: s3Config.s3SecretAccessKey,
-    },
-  });
-  return s3Client;
+
+  if (requireApiVersion(API_VER_REQURL) && s3Config.bypassCorsLocally) {
+    const s3Client = new S3Client({
+      region: s3Config.s3Region,
+      endpoint: endpoint,
+      credentials: {
+        accessKeyId: s3Config.s3AccessKeyID,
+        secretAccessKey: s3Config.s3SecretAccessKey,
+      },
+      requestHandler: new ObsHttpHandler(),
+    });
+    return s3Client;
+  } else {
+    const s3Client = new S3Client({
+      region: s3Config.s3Region,
+      endpoint: endpoint,
+      credentials: {
+        accessKeyId: s3Config.s3AccessKeyID,
+        secretAccessKey: s3Config.s3SecretAccessKey,
+      },
+    });
+    return s3Client;
+  }
 };
 
 export const getRemoteMeta = async (
@@ -99,7 +233,9 @@ export const uploadToRemote = async (
   vault: Vault,
   isRecursively: boolean = false,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
 ) => {
   let uploadFile = fileOrFolderPath;
   if (password !== "") {
@@ -112,6 +248,9 @@ export const uploadToRemote = async (
   if (isFolder && isRecursively) {
     throw Error("upload function doesn't implement recursive function yet!");
   } else if (isFolder && !isRecursively) {
+    if (uploadRaw) {
+      throw Error(`you specify uploadRaw, but you also provide a folder key!`);
+    }
     // folder
     const contentType = DEFAULT_CONTENT_TYPE;
     await s3Client.send(
@@ -133,17 +272,27 @@ export const uploadToRemote = async (
           mime.lookup(fileOrFolderPath) || DEFAULT_CONTENT_TYPE
         ) || DEFAULT_CONTENT_TYPE;
     }
-    const localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    let localContent = undefined;
+    if (uploadRaw) {
+      if (typeof rawContent === "string") {
+        localContent = new TextEncoder().encode(rawContent).buffer;
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
     }
-    const body = arrayBufferToBuffer(remoteContent);
 
+    const bytesIn5MB = 5242880;
+    const body = new Uint8Array(remoteContent);
     const upload = new Upload({
       client: s3Client,
       queueSize: 20, // concurrency
-      partSize: 5242880, // minimal 5MB by default
+      partSize: bytesIn5MB, // minimal 5MB by default
       leavePartsOnError: false,
       params: {
         Bucket: s3Config.s3BucketName,
@@ -176,7 +325,6 @@ export const listFromRemote = async (
   const contents = [] as _Object[];
 
   let isTruncated = true;
-  let continuationToken = "";
   do {
     const rsp = await s3Client.send(new ListObjectsV2Command(confCmd));
 
@@ -192,7 +340,8 @@ export const listFromRemote = async (
     confCmd.ContinuationToken = rsp.NextContinuationToken;
     if (
       isTruncated &&
-      (continuationToken === undefined || continuationToken === "")
+      (confCmd.ContinuationToken === undefined ||
+        confCmd.ContinuationToken === "")
     ) {
       throw Error("isTruncated is true but no continuationToken provided");
     }
@@ -252,11 +401,14 @@ export const downloadFromRemote = async (
   vault: Vault,
   mtime: number,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  skipSaving: boolean = false
 ) => {
   const isFolder = fileOrFolderPath.endsWith("/");
 
-  await mkdirpInVault(fileOrFolderPath, vault);
+  if (!skipSaving) {
+    await mkdirpInVault(fileOrFolderPath, vault);
+  }
 
   // the file is always local file
   // we need to encrypt it
@@ -264,6 +416,7 @@ export const downloadFromRemote = async (
   if (isFolder) {
     // mkdirp locally is enough
     // do nothing here
+    return new ArrayBuffer(0);
   } else {
     let downloadFile = fileOrFolderPath;
     if (password !== "") {
@@ -278,9 +431,12 @@ export const downloadFromRemote = async (
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
-    await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
-      mtime: mtime,
-    });
+    if (!skipSaving) {
+      await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
+        mtime: mtime,
+      });
+    }
+    return localContent;
   }
 };
 

src/remoteForWebdav.ts

@@ -1,24 +1,124 @@
 import { Buffer } from "buffer";
-import { Vault } from "obsidian";
-import type { FileStat, WebDAVClient } from "webdav/web";
-import { AuthType, BufferLike, createClient } from "webdav/web";
+import { Vault, request, requestUrl, requireApiVersion } from "obsidian";
+
 import { Queue } from "@fyears/tsqueue";
 import chunk from "lodash/chunk";
 import flatten from "lodash/flatten";
-import type { RemoteItem, WebdavConfig } from "./baseTypes";
+import { getReasonPhrase } from "http-status-codes";
+import { API_VER_REQURL, RemoteItem, WebdavConfig } from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import { bufferToArrayBuffer, getPathFolder, mkdirpInVault } from "./misc";
-export type { WebDAVClient } from "webdav/web";
 
 import * as origLog from "loglevel";
 const log = origLog.getLogger("rs-default");
 
+import type {
+  FileStat,
+  WebDAVClient,
+  RequestOptionsWithState,
+  Response,
+  ResponseDataDetailed,
+} from "webdav/web";
+import { getPatcher } from "webdav/web";
+if (requireApiVersion(API_VER_REQURL)) {
+  getPatcher().patch(
+    "request",
+    async (
+      options: RequestOptionsWithState
+    ): Promise<Response | ResponseDataDetailed<any>> => {
+      const transformedHeaders = { ...options.headers };
+      delete transformedHeaders["host"];
+      delete transformedHeaders["Host"];
+      delete transformedHeaders["content-length"];
+      delete transformedHeaders["Content-Length"];
+      const r = await requestUrl({
+        url: options.url,
+        method: options.method,
+        body: options.data as string | ArrayBuffer,
+        headers: transformedHeaders,
+      });
+
+      let r2: Response | ResponseDataDetailed<any> = undefined;
+      if (options.responseType === undefined) {
+        r2 = {
+          data: undefined,
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: r.headers,
+        };
+      } else if (options.responseType === "json") {
+        r2 = {
+          data: r.json,
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: r.headers,
+        };
+      } else if (options.responseType === "text") {
+        r2 = {
+          data: r.text,
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: r.headers,
+        };
+      } else if (options.responseType === "arraybuffer") {
+        r2 = {
+          data: r.arrayBuffer,
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: r.headers,
+        };
+      } else {
+        throw Error(
+          `do not know how to deal with responseType = ${options.responseType}`
+        );
+      }
+      return r2;
+    }
+  );
+}
+// getPatcher().patch("request", (options: any) => {
+//   // console.log("using fetch");
+//   const r = fetch(options.url, {
+//     method: options.method,
+//     body: options.data as any,
+//     headers: options.headers,
+//     signal: options.signal,
+//   })
+//     .then((rsp) => {
+//       if (options.responseType === undefined) {
+//         return Promise.all([undefined, rsp]);
+//       }
+//       if (options.responseType === "json") {
+//         return Promise.all([rsp.json(), rsp]);
+//       }
+//       if (options.responseType === "text") {
+//         return Promise.all([rsp.text(), rsp]);
+//       }
+//       if (options.responseType === "arraybuffer") {
+//         return Promise.all([rsp.arrayBuffer(), rsp]);
+//       }
+//     })
+//     .then(([d, r]) => {
+//       return {
+//         data: d,
+//         status: r.status,
+//         statusText: r.statusText,
+//         headers: r.headers,
+//       };
+//     });
+//   // console.log("using fetch");
+//   return r;
+// });
+import { AuthType, BufferLike, createClient } from "webdav/web";
+export type { WebDAVClient } from "webdav/web";
+
 export const DEFAULT_WEBDAV_CONFIG = {
   address: "",
   username: "",
   password: "",
   authType: "basic",
   manualRecursive: false,
+  depth: "auto_unknown",
 } as WebdavConfig;
 
 const getWebdavPath = (fileOrFolderPath: string, vaultName: string) => {
@@ -67,10 +167,16 @@ export class WrappedWebdavClient {
   vaultName: string;
   client: WebDAVClient;
   vaultFolderExists: boolean;
-  constructor(webdavConfig: WebdavConfig, vaultName: string) {
+  saveUpdatedConfigFunc: () => Promise<any>;
+  constructor(
+    webdavConfig: WebdavConfig,
+    vaultName: string,
+    saveUpdatedConfigFunc: () => Promise<any>
+  ) {
     this.webdavConfig = webdavConfig;
     this.vaultName = vaultName;
     this.vaultFolderExists = false;
+    this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
   }
 
   init = async () => {
@@ -109,14 +215,68 @@ export class WrappedWebdavClient {
         this.vaultFolderExists = true;
       }
     }
+
+    // adjust depth parameter
+    if (this.webdavConfig.depth === "auto_unknown") {
+      let testPassed = false;
+      try {
+        const res = await this.client.customRequest(`/${this.vaultName}`, {
+          method: "PROPFIND",
+          headers: {
+            Depth: "Infinity",
+          },
+          responseType: "text",
+        });
+        if (res.status === 403) {
+          throw Error("not support Infinity, get 403");
+        } else {
+          testPassed = true;
+          this.webdavConfig.depth = "auto_infinity";
+          this.webdavConfig.manualRecursive = false;
+        }
+      } catch (error) {
+        testPassed = false;
+      }
+      if (!testPassed) {
+        try {
+          const res = await this.client.customRequest(`/${this.vaultName}`, {
+            method: "PROPFIND",
+            headers: {
+              Depth: "1",
+            },
+            responseType: "text",
+          });
+          testPassed = true;
+          this.webdavConfig.depth = "auto_1";
+          this.webdavConfig.manualRecursive = true;
+        } catch (error) {
+          testPassed = false;
+        }
+      }
+      if (testPassed) {
+        // the depth option has been changed
+        // save the setting
+        if (this.saveUpdatedConfigFunc !== undefined) {
+          await this.saveUpdatedConfigFunc();
+          log.info(
+            `webdav depth="auto_unknown" is changed to ${this.webdavConfig.depth}`
+          );
+        }
+      }
+    }
   };
 }
 
 export const getWebdavClient = (
   webdavConfig: WebdavConfig,
-  vaultName: string
+  vaultName: string,
+  saveUpdatedConfigFunc: () => Promise<any>
 ) => {
-  return new WrappedWebdavClient(webdavConfig, vaultName);
+  return new WrappedWebdavClient(
+    webdavConfig,
+    vaultName,
+    saveUpdatedConfigFunc
+  );
 };
 
 export const getRemoteMeta = async (
@@ -138,7 +298,9 @@ export const uploadToRemote = async (
   vault: Vault,
   isRecursively: boolean = false,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  uploadRaw: boolean = false,
+  rawContent: string | ArrayBuffer = ""
 ) => {
   await client.init();
   let uploadFile = fileOrFolderPath;
@@ -152,6 +314,9 @@ export const uploadToRemote = async (
   if (isFolder && isRecursively) {
     throw Error("upload function doesn't implement recursive function yet!");
   } else if (isFolder && !isRecursively) {
+    if (uploadRaw) {
+      throw Error(`you specify uploadRaw, but you also provide a folder key!`);
+    }
     // folder
     if (password === "") {
       // if not encrypted, mkdir a remote folder
@@ -164,7 +329,7 @@ export const uploadToRemote = async (
       // if encrypted, upload a fake file with the encrypted file name
       await client.client.putFileContents(uploadFile, "", {
         overwrite: true,
-        onUploadProgress: (progress) => {
+        onUploadProgress: (progress: any) => {
           // log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
         },
       });
@@ -174,7 +339,16 @@ export const uploadToRemote = async (
   } else {
     // file
     // we ignore isRecursively parameter here
-    const localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    let localContent = undefined;
+    if (uploadRaw) {
+      if (typeof rawContent === "string") {
+        localContent = new TextEncoder().encode(rawContent).buffer;
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
@@ -186,7 +360,7 @@ export const uploadToRemote = async (
     }
     await client.client.putFileContents(uploadFile, remoteContent, {
       overwrite: true,
-      onUploadProgress: (progress) => {
+      onUploadProgress: (progress: any) => {
         log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
       },
     });
@@ -205,7 +379,10 @@ export const listFromRemote = async (
   await client.init();
 
   let contents = [] as FileStat[];
-  if (client.webdavConfig.manualRecursive) {
+  if (
+    client.webdavConfig.depth === "auto_1" ||
+    client.webdavConfig.depth === "manual_1"
+  ) {
     // the remote doesn't support infinity propfind,
     // we need to do a bfs here
     const q = new Queue([`/${client.vaultName}`]);
@@ -223,7 +400,10 @@ export const listFromRemote = async (
           return client.client.getDirectoryContents(x, {
             deep: false,
             details: false /* no need for verbose details here */,
-            glob: "/**" /* avoid dot files by using glob */,
+            // TODO: to support .obsidian,
+            // we need to load all files including dot,
+            // anyway to reduce the resources?
+            // glob: "/**" /* avoid dot files by using glob */,
           }) as Promise<FileStat[]>;
         });
         const r2 = flatten(await Promise.all(r));
@@ -244,7 +424,10 @@ export const listFromRemote = async (
       {
         deep: true,
         details: false /* no need for verbose details here */,
-        glob: "/**" /* avoid dot files by using glob */,
+        // TODO: to support .obsidian,
+        // we need to load all files including dot,
+        // anyway to reduce the resources?
+        // glob: "/**" /* avoid dot files by using glob */,
       }
     )) as FileStat[];
   }
@@ -277,13 +460,16 @@ export const downloadFromRemote = async (
   vault: Vault,
   mtime: number,
   password: string = "",
-  remoteEncryptedKey: string = ""
+  remoteEncryptedKey: string = "",
+  skipSaving: boolean = false
 ) => {
   await client.init();
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
-  await mkdirpInVault(fileOrFolderPath, vault);
+  if (!skipSaving) {
+    await mkdirpInVault(fileOrFolderPath, vault);
+  }
 
   // the file is always local file
   // we need to encrypt it
@@ -291,6 +477,7 @@ export const downloadFromRemote = async (
   if (isFolder) {
     // mkdirp locally is enough
     // do nothing here
+    return new ArrayBuffer(0);
   } else {
     let downloadFile = fileOrFolderPath;
     if (password !== "") {
@@ -302,9 +489,12 @@ export const downloadFromRemote = async (
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
-    await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
-      mtime: mtime,
-    });
+    if (!skipSaving) {
+      await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
+        mtime: mtime,
+      });
+    }
+    return localContent;
   }
 };
 

src/settings.ts

@@ -1,5 +1,18 @@
-import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
-import type { SUPPORTED_SERVICES_TYPE, WebdavAuthType } from "./baseTypes";
+import {
+  App,
+  Modal,
+  Notice,
+  PluginSettingTab,
+  Setting,
+  Platform,
+  requireApiVersion,
+} from "obsidian";
+import {
+  API_VER_REQURL,
+  SUPPORTED_SERVICES_TYPE,
+  WebdavAuthType,
+  WebdavDepthType,
+} from "./baseTypes";
 import { exportVaultSyncPlansToFiles } from "./debugMode";
 import { exportQrCodeUri } from "./importExport";
 import {
@@ -110,17 +123,45 @@ class DropboxAuthModal extends Modal {
   async onOpen() {
     let { contentEl } = this;
 
-    const { authUrl, verifier } = await getAuthUrlAndVerifierDropbox(
-      this.plugin.settings.dropbox.clientID
-    );
-    this.plugin.oauth2Info.verifier = verifier;
+    let needManualPatse = false;
+    const userAgent = window.navigator.userAgent.toLocaleLowerCase() || "";
+    // some users report that,
+    // the Linux would open another instance Obsidian if jumping back,
+    // so fallback to manual paste on Linux
+    if (
+      Platform.isDesktopApp &&
+      !Platform.isMacOS &&
+      (/linux/.test(userAgent) ||
+        /ubuntu/.test(userAgent) ||
+        /debian/.test(userAgent) ||
+        /fedora/.test(userAgent) ||
+        /centos/.test(userAgent))
+    ) {
+      needManualPatse = true;
+    }
 
-    contentEl.createEl("p", {
-      text: "Visit the address in a browser, and follow the steps.",
-    });
-    contentEl.createEl("p", {
-      text: "Finally you should be redirected to Obsidian.",
-    });
+    const { authUrl, verifier } = await getAuthUrlAndVerifierDropbox(
+      this.plugin.settings.dropbox.clientID,
+      needManualPatse
+    );
+
+    if (needManualPatse) {
+      contentEl.createEl("p", {
+        text: "Step 1: Visit the address in a browser, and follow the steps.",
+      });
+      contentEl.createEl("p", {
+        text: 'Step 2: In the end of the web flow, you obtain a long code. Paste it here then click "Submit".',
+      });
+    } else {
+      this.plugin.oauth2Info.verifier = verifier;
+
+      contentEl.createEl("p", {
+        text: "Visit the address in a browser, and follow the steps.",
+      });
+      contentEl.createEl("p", {
+        text: "Finally you should be redirected to Obsidian.",
+      });
+    }
 
     const div2 = contentEl.createDiv();
     div2.createEl(
@@ -140,6 +181,70 @@ class DropboxAuthModal extends Modal {
       href: authUrl,
       text: authUrl,
     });
+
+    if (needManualPatse) {
+      let authCode = "";
+      new Setting(contentEl)
+        .setName("Auth Code from web page")
+        .setDesc('You need to click "Confirm".')
+        .addText((text) =>
+          text
+            .setPlaceholder("")
+            .setValue("")
+            .onChange((val) => {
+              authCode = val.trim();
+            })
+        )
+        .addButton(async (button) => {
+          button.setButtonText("Confirm");
+          button.onClick(async () => {
+            new Notice("Trying to connect to Dropbox");
+            try {
+              const authRes = await sendAuthReqDropbox(
+                this.plugin.settings.dropbox.clientID,
+                verifier,
+                authCode
+              );
+              const self = this;
+              setConfigBySuccessfullAuthInplace(
+                this.plugin.settings.dropbox,
+                authRes,
+                () => self.plugin.saveSettings()
+              );
+              const client = new RemoteClient(
+                "dropbox",
+                undefined,
+                undefined,
+                this.plugin.settings.dropbox,
+                undefined,
+                this.app.vault.getName(),
+                () => self.plugin.saveSettings()
+              );
+              const username = await client.getUser();
+              this.plugin.settings.dropbox.username = username;
+              await this.plugin.saveSettings();
+              new Notice(
+                `Good! We've connected to Dropbox as user ${username}!`
+              );
+              this.authDiv.toggleClass(
+                "dropbox-auth-button-hide",
+                this.plugin.settings.dropbox.username !== ""
+              );
+              this.revokeAuthDiv.toggleClass(
+                "dropbox-revoke-auth-button-hide",
+                this.plugin.settings.dropbox.username === ""
+              );
+              this.revokeAuthSetting.setDesc(
+                `You've connected as user ${this.plugin.settings.dropbox.username}. If you want to disconnect, click this button.`
+              );
+              this.close();
+            } catch (err) {
+              console.error(err);
+              new Notice("Something goes wrong while connecting to Dropbox.");
+            }
+          });
+        });
+    }
   }
 
   onClose() {
@@ -279,6 +384,59 @@ export class OnedriveRevokeAuthModal extends Modal {
   }
 }
 
+class SyncConfigDirModal extends Modal {
+  plugin: RemotelySavePlugin;
+  saveDropdownFunc: () => void;
+  constructor(
+    app: App,
+    plugin: RemotelySavePlugin,
+    saveDropdownFunc: () => void
+  ) {
+    super(app);
+    this.plugin = plugin;
+    this.saveDropdownFunc = saveDropdownFunc;
+  }
+
+  async onOpen() {
+    let { contentEl } = this;
+
+    const texts = [
+      "Attention 1/3: This only syncs (copies) the whole Obsidian config dir, not other . folders or files. It also doesn't understand the inner structure of the config dir.",
+      "Attention 2/3: After the config dir is synced, plugins settings might be corrupted, and Obsidian might need to be restarted to load the new settings.",
+      "Attention 3/3: The deletion (uninstallation) operations of or inside Obsidian config dir cannot be tracked. So if you want to uninstall a plugin, you need to manually uninstall it on all device, before next sync.",
+      "If you are agreed to take your own risk, please click the following second confirm button.",
+    ];
+    for (const t of texts) {
+      contentEl.createEl("p", {
+        text: t,
+      });
+    }
+
+    new Setting(contentEl)
+      .addButton((button) => {
+        button.setButtonText("The Second Confirm To Enable.");
+        button.onClick(async () => {
+          this.plugin.settings.syncConfigDir = true;
+          await this.plugin.saveSettings();
+          this.saveDropdownFunc();
+          new Notice("You've enabled syncing config folder!");
+          this.close();
+        });
+      })
+      .addButton((button) => {
+        button.setButtonText("Go Back");
+        button.onClick(() => {
+          this.close();
+        });
+      });
+  }
+
+  onClose() {
+    let { contentEl } = this;
+    contentEl.empty();
+  }
+}
+
 class ExportSettingsQrCodeModal extends Modal {
   plugin: RemotelySavePlugin;
   constructor(app: App, plugin: RemotelySavePlugin) {
@@ -422,6 +580,31 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
           });
       });
 
+    const runOnceStartUpDiv = generalDiv.createEl("div");
+    new Setting(runOnceStartUpDiv)
+      .setName("run once on start up automatically")
+      .setDesc(
+        `This settings allows setting running ONCE on start up automatically. This will take effect on NEXT start up after changing. This setting, is different from "schedule for auto run" which starts syncing after EVERY interval.`
+      )
+      .addDropdown((dropdown) => {
+        dropdown.addOption("-1", "(not set)");
+        dropdown.addOption(
+          `${1000 * 10 * 1}`,
+          "sync once after 10 seconds of start up"
+        );
+        dropdown.addOption(
+          `${1000 * 30 * 1}`,
+          "sync once after 30 seconds of start up"
+        );
+        dropdown
+          .setValue(`${this.plugin.settings.initRunAfterMilliseconds}`)
+          .onChange(async (val: string) => {
+            const realVal = parseInt(val);
+            this.plugin.settings.initRunAfterMilliseconds = realVal;
+            await this.plugin.saveSettings();
+          });
+      });
+
     //////////////////////////////////////////////////
     // below for general chooser (part 1/2)
     //////////////////////////////////////////////////
@@ -447,9 +630,11 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       cls: "s3-disclaimer",
     });
 
-    s3Div.createEl("p", {
-      text: "You need to configure CORS to allow requests from origin app://obsidian.md and capacitor://localhost and http://localhost",
-    });
+    if (!requireApiVersion(API_VER_REQURL)) {
+      s3Div.createEl("p", {
+        text: "You need to configure CORS to allow requests from origin app://obsidian.md and capacitor://localhost and http://localhost",
+      });
+    }
 
     s3Div.createEl("p", {
       text: "Some Amazon S3 official docs for references:",
@@ -467,10 +652,12 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       text: "Access key ID and Secret access key info",
     });
 
-    s3LinksUl.createEl("li").createEl("a", {
-      href: "https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html",
-      text: "Configuring CORS",
-    });
+    if (!requireApiVersion(API_VER_REQURL)) {
+      s3LinksUl.createEl("li").createEl("a", {
+        href: "https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html",
+        text: "Configuring CORS",
+      });
+    }
 
     new Setting(s3Div)
       .setName("s3Endpoint")
@@ -487,7 +674,9 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
 
     new Setting(s3Div)
       .setName("s3Region")
-      .setDesc("s3Region")
+      .setDesc(
+        "s3Region: If you are not sure what to enter, you could try the vaule: us-east-1"
+      )
       .addText((text) =>
         text
           .setPlaceholder("")
@@ -537,6 +726,34 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
           })
       );
 
+    if (requireApiVersion(API_VER_REQURL)) {
+      new Setting(s3Div)
+        .setName("bypass CORS issue locally")
+        .setDesc(
+          `The plugin allows skipping server CORS config in new version (Obsidian>=${API_VER_REQURL}). If you encounter any issues, please disable this setting and config CORS (app://obsidian.md and capacitor://localhost and http://localhost) on server.`
+        )
+        .addDropdown((dropdown) => {
+          dropdown
+            .addOption("disable", "disable")
+            .addOption("enable", "enable");
+
+          dropdown
+            .setValue(
+              `${
+                this.plugin.settings.s3.bypassCorsLocally ? "enable" : "disable"
+              }`
+            )
+            .onChange(async (value) => {
+              if (value === "enable") {
+                this.plugin.settings.s3.bypassCorsLocally = true;
+              } else {
+                this.plugin.settings.s3.bypassCorsLocally = false;
+              }
+              await this.plugin.saveSettings();
+            });
+        });
+    }
+
     new Setting(s3Div)
       .setName("check connectivity")
       .setDesc("check connectivity")
@@ -810,9 +1027,11 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       cls: "webdav-disclaimer",
     });
 
-    webdavDiv.createEl("p", {
-      text: "You need to configure CORS to allow requests from origin app://obsidian.md and capacitor://localhost and http://localhost",
-    });
+    if (!requireApiVersion(API_VER_REQURL)) {
+      webdavDiv.createEl("p", {
+        text: "You need to configure CORS to allow requests from origin app://obsidian.md and capacitor://localhost and http://localhost",
+      });
+    }
 
     webdavDiv.createEl("p", {
       text: `We will create and sync inside the folder /${this.app.vault.getName()} on your server.`,
@@ -860,9 +1079,20 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
     new Setting(webdavDiv)
       .setName("server auth type")
       .setDesc("If no password, this option would be ignored.")
-      .addDropdown((dropdown) => {
+      .addDropdown(async (dropdown) => {
         dropdown.addOption("basic", "basic");
-        // dropdown.addOption("digest", "digest");
+        if (requireApiVersion(API_VER_REQURL)) {
+          dropdown.addOption("digest", "digest");
+        }
+
+        // new version config, copied to old version, we need to reset it
+        if (
+          !requireApiVersion(API_VER_REQURL) &&
+          this.plugin.settings.webdav.authType !== "basic"
+        ) {
+          this.plugin.settings.webdav.authType = "basic";
+          await this.plugin.saveSettings();
+        }
 
         dropdown
           .setValue(this.plugin.settings.webdav.authType)
@@ -873,29 +1103,41 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       });
 
     new Setting(webdavDiv)
-      .setName("server supports infinity propfind or not")
+      .setName("depth header sent to servers")
       .setDesc(
-        "The plugin needs to get all files and folders recursively using probfind. If your webdav server only supports depth='1' (such as NGINX), you need to adjust the setting here, then the plugin consumes more network requests, but better than not working."
+        "Webdav servers should be configured to allow requests with header Depth being '1' or 'Infinity'. The plugin needs to know this info. If you are not sure what's this, choose \"auto\"."
       )
       .addDropdown((dropdown) => {
-        dropdown.addOption("infinity", "supports depth='infinity'");
-        dropdown.addOption("1", "only supports depth='1'");
+        dropdown.addOption("auto", "auto detect");
+        dropdown.addOption("manual_1", "only supports depth='1'");
+        dropdown.addOption("manual_infinity", "only supports depth='infinity'");
 
-        type Depth = "1" | "infinity";
-        dropdown
-          .setValue(
-            this.plugin.settings.webdav.manualRecursive === false
-              ? "infinity"
-              : "1"
-          )
-          .onChange(async (val: Depth) => {
-            if (val === "1") {
-              this.plugin.settings.webdav.manualRecursive = true;
-            } else if (val === "infinity") {
-              this.plugin.settings.webdav.manualRecursive = false;
-            }
-            await this.plugin.saveSettings();
-          });
+        let initVal = "auto";
+        const autoOptions: Set<WebdavDepthType> = new Set([
+          "auto_unknown",
+          "auto_1",
+          "auto_infinity",
+        ]);
+        if (autoOptions.has(this.plugin.settings.webdav.depth)) {
+          initVal = "auto";
+        } else {
+          initVal = this.plugin.settings.webdav.depth || "auto";
+        }
+
+        type DepthOption = "auto" | "manual_1" | "manual_infinity";
+        dropdown.setValue(initVal).onChange(async (val: DepthOption) => {
+          if (val === "auto") {
+            this.plugin.settings.webdav.depth = "auto_unknown";
+            this.plugin.settings.webdav.manualRecursive = false;
+          } else if (val === "manual_1") {
+            this.plugin.settings.webdav.depth = "manual_1";
+            this.plugin.settings.webdav.manualRecursive = true;
+          } else if (val === "manual_infinity") {
+            this.plugin.settings.webdav.depth = "manual_infinity";
+            this.plugin.settings.webdav.manualRecursive = false;
+          }
+          await this.plugin.saveSettings();
+        });
       });
 
     new Setting(webdavDiv)
@@ -905,20 +1147,27 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         button.setButtonText("Check");
         button.onClick(async () => {
           new Notice("Checking...");
+          const self = this;
           const client = new RemoteClient(
             "webdav",
             undefined,
             this.plugin.settings.webdav,
             undefined,
             undefined,
-            this.app.vault.getName()
+            this.app.vault.getName(),
+            () => self.plugin.saveSettings()
           );
           const res = await client.checkConnectivity();
           if (res) {
             new Notice("Great! The webdav server can be accessed.");
           } else {
+            let corsErrMsg = "/CORS";
+            if (requireApiVersion(API_VER_REQURL)) {
+              corsErrMsg = "";
+            }
+
             new Notice(
-              "The webdav server cannot be reached (possible to be any of address/username/password/authtype/CORS errors)."
+              `The webdav server cannot be reached (possible to be any of address/username/password/authtype${corsErrMsg} errors).`
             );
           }
         });
@@ -962,6 +1211,92 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
           });
       });
 
+    //////////////////////////////////////////////////
+    // below for advanced settings
+    //////////////////////////////////////////////////
+    const advDiv = containerEl.createEl("div");
+    advDiv.createEl("h2", {
+      text: "Advanced Settings",
+    });
+
+    const concurrencyDiv = advDiv.createEl("div");
+    new Setting(concurrencyDiv)
+      .setName("Concurrency")
+      .setDesc(
+        "How many files do you want to download or upload in parallel at most? By default it's set to 5. If you meet any problems such as rate limit, you can reduce the concurrency to a lower value."
+      )
+      .addDropdown((dropdown) => {
+        dropdown.addOption("1", "1");
+        dropdown.addOption("2", "2");
+        dropdown.addOption("3", "3");
+        dropdown.addOption("5", "5 (default)");
+        dropdown.addOption("10", "10");
+        dropdown.addOption("15", "15");
+        dropdown.addOption("20", "20");
+
+        dropdown
+          .setValue(`${this.plugin.settings.concurrency}`)
+          .onChange(async (val) => {
+            const realVal = parseInt(val);
+            this.plugin.settings.concurrency = realVal;
+            await this.plugin.saveSettings();
+          });
+      });
+
+    const syncUnderscoreItemsDiv = advDiv.createEl("div");
+    new Setting(syncUnderscoreItemsDiv)
+      .setName("sync _ files or folders")
+      .setDesc(`Sync files or folders startting with _ ("underscore") or not.`)
+      .addDropdown((dropdown) => {
+        dropdown.addOption("disable", "disable");
+        dropdown.addOption("enable", "enable");
+        dropdown
+          .setValue(
+            `${this.plugin.settings.syncUnderscoreItems ? "enable" : "disable"}`
+          )
+          .onChange(async (val) => {
+            this.plugin.settings.syncUnderscoreItems = val === "enable";
+            await this.plugin.saveSettings();
+          });
+      });
+
+    const syncConfigDirDiv = advDiv.createEl("div");
+    new Setting(syncConfigDirDiv)
+      .setName("sync config dir (experimental)")
+      .setDesc(
+        `Sync config dir ${this.app.vault.configDir} or not. Please be aware that this may impact all your plugins' or Obsidian's settings, and may require you restart Obsidian after sync. Enable this at your own risk.`
+      )
+      .addDropdown((dropdown) => {
+        dropdown.addOption("disable", "disable");
+        dropdown.addOption("enable", "enable");
+
+        const bridge = {
+          secondConfirm: false,
+        };
+        dropdown
+          .setValue(
+            `${this.plugin.settings.syncConfigDir ? "enable" : "disable"}`
+          )
+          .onChange(async (val) => {
+            if (val === "enable" && !bridge.secondConfirm) {
+              dropdown.setValue("disable");
+              const modal = new SyncConfigDirModal(
+                this.app,
+                this.plugin,
+                () => {
+                  bridge.secondConfirm = true;
+                  dropdown.setValue("enable");
+                }
+              );
+              modal.open();
+            } else {
+              bridge.secondConfirm = false;
+              this.plugin.settings.syncConfigDir = false;
+              await this.plugin.saveSettings();
+            }
+          });
+      });
+
     //////////////////////////////////////////////////
     // below for import and export functions
     //////////////////////////////////////////////////

src/syncAlgoV2Notice.ts

@@ -0,0 +1,69 @@
+import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
+import type RemotelySavePlugin from "./main"; // unavoidable
+import * as origLog from "loglevel";
+const log = origLog.getLogger("rs-default");
+
+export class SyncAlgoV2Modal extends Modal {
+  agree: boolean;
+  readonly plugin: RemotelySavePlugin;
+  constructor(app: App, plugin: RemotelySavePlugin) {
+    super(app);
+    this.plugin = plugin;
+    this.agree = false;
+  }
+  onOpen() {
+    let { contentEl } = this;
+    contentEl.createEl("h2", {
+      text: "Remotely Save has a better sync algorithm",
+    });
+
+    const texts = [
+      "Welcome to use Remotely Save!",
+
+      "From version 0.3.0, a new algorithm has been developed, but it needs uploading extra meta data files _remotely-save-metadata-on-remote.{json,bin} to YOUR configured cloud destinations, besides your notes.",
+
+      "So that, for example, the second device can know that what files/folders have been deleted on the first device by reading those files.",
+
+      'If you agree, plase click the button "agree", and enjoy the plugin! AND PLEASE REMEMBER TO BACKUP YOUR VAULT FIRSTLY!',
+
+      'If you do not agree, you should stop using the current and later versions of Remotely Save. You could consider manually install the old version 0.2.14 which uses old algorithm and does not upload any extra meta data files. By clicking the "Do not agree" button, the plugin will unload itself, and you need to manually disable it in Obsidian settings.',
+    ];
+
+    const ul = contentEl.createEl("ul");
+
+    for (const t of texts) {
+      ul.createEl("li", {
+        text: t,
+      });
+    }
+
+    new Setting(contentEl)
+      .addButton((button) => {
+        button.setButtonText("Agree");
+        button.onClick(async () => {
+          this.agree = true;
+          this.close();
+        });
+      })
+      .addButton((button) => {
+        button.setButtonText("Do not agree");
+        button.onClick(() => {
+          this.close();
+        });
+      });
+  }
+
+  onClose() {
+    let { contentEl } = this;
+    contentEl.empty();
+    if (this.agree) {
+      log.info("agree to use the new algorithm");
+      this.plugin.saveAgreeToUseNewSyncAlgorithm();
+      this.plugin.enableAutoSyncIfSet();
+      this.plugin.enableInitSyncIfSet();
+    } else {
+      log.info("do not agree to use the new algorithm");
+      this.plugin.unload();
+    }
+  }
+}

tests/metadataOnRemote.test.ts

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

tests/misc.test.ts

@@ -21,7 +21,7 @@ describe("Misc: hidden file", () => {
 
     item = "_hidden_loose";
     expect(misc.isHiddenPath(item)).to.be.true;
-    expect(misc.isHiddenPath(item, false)).to.be.false;
+    expect(misc.isHiddenPath(item, true, false)).to.be.false;
 
     item = "/sdd/_hidden_loose";
     expect(misc.isHiddenPath(item)).to.be.true;
@@ -30,10 +30,21 @@ describe("Misc: hidden file", () => {
     expect(misc.isHiddenPath(item)).to.be.true;
 
     item = "what/../_hidden_loose/what/what/what";
-    expect(misc.isHiddenPath(item, false)).to.be.false;
+    expect(misc.isHiddenPath(item, true, false)).to.be.false;
 
     item = "what/../_hidden_loose/../.hidden/what/what/what";
-    expect(misc.isHiddenPath(item, false)).to.be.true;
+    expect(misc.isHiddenPath(item, true, false)).to.be.true;
+
+    item = "what/../_hidden_loose/../.hidden/what/what/what";
+    expect(misc.isHiddenPath(item, false, true)).to.be.false;
+
+    item = "what/_hidden_loose/what/what/what";
+    expect(misc.isHiddenPath(item, false, true)).to.be.true;
+    expect(misc.isHiddenPath(item, true, false)).to.be.false;
+
+    item = "what/.hidden/what/what/what";
+    expect(misc.isHiddenPath(item, false, true)).to.be.false;
+    expect(misc.isHiddenPath(item, true, false)).to.be.true;
   });
 });
 
@@ -68,6 +79,20 @@ describe("Misc: get folder levels", () => {
     expect(misc.getFolderLevels(item3)).to.deep.equal(res3);
   });
 
+  it("should correctly add ending slash if required", () => {
+    const item = "xxx/yyy/zzz.md";
+    const res = ["xxx/", "xxx/yyy/"];
+    expect(misc.getFolderLevels(item, true)).to.deep.equal(res);
+
+    const item2 = "xxx/yyy/zzz";
+    const res2 = ["xxx/", "xxx/yyy/"];
+    expect(misc.getFolderLevels(item2, true)).to.deep.equal(res2);
+
+    const item3 = "xxx/yyy/zzz/";
+    const res3 = ["xxx/", "xxx/yyy/", "xxx/yyy/zzz/"];
+    expect(misc.getFolderLevels(item3, true)).to.deep.equal(res3);
+  });
+
   it("should treat path starting with / correctly", () => {
     const item = "/xxx/yyy/zzz.md";
     const res = ["/xxx", "/xxx/yyy"];
@@ -91,6 +116,27 @@ describe("Misc: get folder levels", () => {
   });
 });
 
+describe("Misc: get parent folder", () => {
+  it("should treat empty path correctly", () => {
+    const item = "";
+    expect(misc.getParentFolder(item)).equals("/");
+  });
+
+  it("should treat one level path correctly", () => {
+    let item = "abc/";
+    expect(misc.getParentFolder(item)).equals("/");
+    item = "/efg/";
+    expect(misc.getParentFolder(item)).equals("/");
+  });
+
+  it("should treat more levels path correctly", () => {
+    let item = "abc/efg";
+    expect(misc.getParentFolder(item)).equals("abc/");
+    item = "/hij/klm/";
+    expect(misc.getParentFolder(item)).equals("/hij/");
+  });
+});
+
 describe("Misc: vaild file name tests", () => {
   it("should treat no ascii correctly", async () => {
     const x = misc.isVaildText("😄🍎 apple 苹果");
@@ -145,3 +191,56 @@ describe("Misc: extract svg", () => {
     expect(y).to.equal("<rect/><g/>");
   });
 });
+
+describe("Misc: get split ranges", () => {
+  it("should deal with big parts", () => {
+    const k = misc.getSplitRanges(10, 20);
+    const k2: misc.SplitRange[] = [
+      {
+        partNum: 1,
+        start: 0,
+        end: 10,
+      },
+    ];
+    expect(k).to.deep.equal(k2);
+  });
+
+  it("should deal with 0 remainder", () => {
+    const k = misc.getSplitRanges(20, 10);
+    const k2: misc.SplitRange[] = [
+      {
+        partNum: 1,
+        start: 0,
+        end: 10,
+      },
+      {
+        partNum: 2,
+        start: 10,
+        end: 20,
+      },
+    ];
+    expect(k).to.deep.equal(k2);
+  });
+
+  it("should deal with not-0 remainder", () => {
+    const k = misc.getSplitRanges(25, 10);
+    const k2: misc.SplitRange[] = [
+      {
+        partNum: 1,
+        start: 0,
+        end: 10,
+      },
+      {
+        partNum: 2,
+        start: 10,
+        end: 20,
+      },
+      {
+        partNum: 3,
+        start: 20,
+        end: 25,
+      },
+    ];
+    expect(k).to.deep.equal(k2);
+  });
+});

versions.json

@@ -1,3 +1,4 @@
 {
-  "0.2.14": "0.12.15"
+  "0.3.2": "0.12.15",
+  "0.3.6": "0.13.21"
 }

webpack.config.js

@@ -57,6 +57,7 @@ module.exports = {
       // events: require.resolve("events"),
       // http: require.resolve("stream-http"),
       // https: require.resolve("https-browserify"),
+      net: false,
       // os: require.resolve("os-browserify/browser"),
       path: require.resolve("path-browserify"),
       // punycode: require.resolve("punycode"),
@@ -66,8 +67,9 @@ module.exports = {
       // string_decoder: require.resolve("string_decoder"),
       // sys: require.resolve("util"),
       // timers: require.resolve("timers-browserify"),
+      tls: false,
       // tty: require.resolve("tty-browserify"),
-      // url: require.resolve("url"),
+      url: require.resolve("url/"),
       // util: require.resolve("util"),
       // vm: require.resolve("vm-browserify"),
       // zlib: require.resolve("browserify-zlib"),