add base types

commit 692bb794aea5609b9e9abf5228620f4479e50983
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Feb 27 17:52:43 2022 +0800

    bump to 0.3.0

commit 77335412ad2da2b5bd1ed5075061a5af006e3c36
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Feb 27 17:50:57 2022 +0800

    change titles for minimal intrusive design

commit 2812adebb84344d384749a62acb63fd0c6fd509d
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Feb 27 17:30:53 2022 +0800

    remove syncv1

commit 22fc24a76c9851740bbc7c0177d1cb2526e15d8b
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Feb 27 17:30:27 2022 +0800

    full notice to any one

commit d56ea24a78f6dc1fbea2740011ee1cea9c403d4c
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sat Feb 26 23:11:14 2022 +0800

    fix test

commit 759f82593bbfb9b49079cfd80dbadbbafc0287e5
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sat Feb 26 21:59:25 2022 +0800

    obfuscate metadata on remote

commit 9b6bf05288af0e52d0f02468e5ac8757f4f896df
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sat Feb 26 21:33:52 2022 +0800

    avoid re-uploading if meta not changed

commit 03be1453764e48e99207f44467ee4d5801072ed8
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sat Feb 26 00:35:52 2022 +0800

    add password condition

commit 7f899f7c2572df3e2a35e16cbdaab94db113f366
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sat Feb 26 00:22:58 2022 +0800

    add decision branch for easier debugging

commit cf4071bf3156356ae6ec3a9cb187c2cb541d1b17
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Fri Feb 25 23:40:52 2022 +0800

    change folder error

commit 964493dd998699a1d53018a201637bda192c4baa
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Fri Feb 25 23:09:44 2022 +0800

    finnaly remote remove should be working

commit 2888e65452f9c0e1dde6005f012c3ee0a6313c3f
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Fri Feb 25 01:18:15 2022 +0800

    optimize comparation

commit 024936951d6180b1296c2a5d56c5bf5d468e9ae7
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Fri Feb 25 01:14:44 2022 +0800

    allow uploading extra meta

commit 007006701d536da2b4b46389941980579bbc4e67
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Thu Feb 24 01:08:58 2022 +0800

    add logic to fetch extra meta

commit c9d3a05ca1bf45c06f22233124670e5e45b5f5f1
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Thu Feb 24 00:29:16 2022 +0800

    another way to deal with trash

commit 82d455f8bf60f7bac8eb4e299a2ca44c331a6d7f
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Thu Feb 24 00:28:51 2022 +0800

    add return buffer for downloading

commit b8e6b79bc078def2854bc73578b7f520cc39ab34
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Wed Feb 23 00:16:06 2022 +0800

    half way to actual sync

commit 90cceb1411b46af9741f2caa3ab8beafaf69c1b2
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Tue Feb 22 23:36:09 2022 +0800

    cleaner way to remember the folder being kept

commit c1afb763cc4e0f7905c83e0a8eb20f8ed969a279
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Tue Feb 22 00:03:21 2022 +0800

    simplified way to get plans for sync algo v2

commit 5c5ecce39eb3854900f1f5b79c7beb189e78a6a7
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Mon Feb 21 23:13:58 2022 +0800

    archive the old sync algo v1 doc

commit 75cdfa1ee9834600f83ded6672b102de2c5f9616
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Mon Feb 21 23:13:14 2022 +0800

    simplify sync algo v2

commit dc9275835d961de07efcbaa81657e4745242e72a
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Mon Feb 21 22:58:57 2022 +0800

    add way to skip recording removing

commit f9712ef96021dfed4ae33e6c649f78e940b7e530
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Mon Feb 21 09:38:09 2022 +0800

    fix sync

commit 9007dcf22ef317dde36ac4f1dd589d05cc8d5cf6
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Mon Feb 21 00:54:21 2022 +0800

    fix assignment

commit 77abee6ad443b62353ed3913e0945ea7d1314f87
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Mon Feb 21 00:28:43 2022 +0800

    draft of sync v2

commit a0c26238bf60692e095cfd8527abf937255b56d4
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Mon Feb 21 00:23:19 2022 +0800

    how to deal with folders

commit c10f92a7e8d3c4a4f4c585e39e0abad1a5376c02
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Feb 20 23:39:16 2022 +0800

    helper func to get parents

commit f903c98b3b7b9d1e785d04b9fc0cfcafdc6e5661
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Feb 20 23:31:21 2022 +0800

    add optional ending slash to getFolderLevels

commit 2d67c9b2b941e676588fa43ab289fab79f567e5e
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Feb 20 14:44:44 2022 +0800

    update sync algo v2

commit 491ed1bb85759df2411706fd02d740acb5598ce6
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Feb 20 14:34:51 2022 +0800

    dry run mode

commit dfd588dcef512ba7dfe760008bcf97138b97e339
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sat Feb 19 23:14:32 2022 +0800

    prettier

commit eae580f882a045ae9df799b816e68c3500704131
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sat Feb 19 23:12:29 2022 +0800

    draft design for sync algo v2

.github/workflows/auto-build.yml

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

README.md

@@ -4,7 +4,9 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 
 [![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml)
 
-[![total downloads auto count)](https://remotely-save.github.io/auto-download-stats/totalDownloads.svg)](https://github.com/fyears/remotely-save/releases)
+[![total downloads auto count](https://remotely-save.github.io/auto-download-stats/totalDownloads.svg)](https://github.com/fyears/remotely-save/releases)
+
+[![downloads of latest version](https://remotely-save.github.io/auto-download-stats/latestVersionDownloads.svg)](https://github.com/fyears/remotely-save/releases)
 
 ## Disclaimer
 
@@ -21,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
 
@@ -57,7 +61,7 @@ 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.
+- 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.

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 policy.](./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,21 @@
+# 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)
+
+To solve the issue, we have some options:
+
+1. The server side needs to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. Sometimes in the future, the header `Access-Control-Expose-Headers` with some values being set might be also needed.
+
+   [Here is an example configuration for Amazon S3.](./s3_cors_configure.md)
+
+   However, some cloud services do not allow configuring or exposing these headers. (Notably most public WebDAV services.)
+
+   It's of course possible if the users build the services by themselves.
+
+2. Obsidian implements and exposes a new api helping developers to bypass the CORS policy.
+
+   Currently (as of Feb 2022), an api `request()` indeed exists, but it only deals with text-like data, and does not support binary data or response headers reading yet.
+
+   Because this plugin allows uploading and downloading binary data, so a more feature-rich api is needed.

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/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.
+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.
-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.

docs/s3_cors_configure.md

@@ -0,0 +1,31 @@
+# How To Configure S3 CORS Rules
+
+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,40 @@
+# 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 list is for information purposes only.
+
+| Service                                                                               | Connectable | by S3 | by WebDAV | by other protocol | More Info                                                    |
+| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ----------------- | ------------------------------------------------------------ |
+| Amazon S3                                                                             | Yes         | Yes   |           |                   | [CORS config needed.](./s3_cors_configure.md)                |
+| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储                             | Yes         | Yes   |           |                   | CORS config needed.                                          |
+| Alibaba Cloud - Object Storage Service 阿里云对象存储                                 | Yes         | Yes   |           |                   | CORS config needed.                                          |
+| Backblaze B2 Cloud Storage                                                            | No          | No    |           |                   | Its CORS rules doesn't allow no-http(s) origins.             |
+| [Wasabi](https://wasabi.com)                                                          | ?           | ?     |           |                   |                                                              |
+| [filebase](https://filebase.com/)                                                     | Yes         | Yes   |           |                   | CORS config needed.                                          |
+| QingStor 青云                                                                         | ?           | ?     |           |                   |                                                              |
+| [MinIO](https://min.io/)                                                              | ?           | ?     |           |                   |                                                              |
+| [WsgiDAV](https://github.com/mar10/wsgidav)                                           | Yes         |       | Yes       |                   | CORS rules can be set.                                       |
+| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | ?           |       | ?         |                   | Should be possible?                                          |
+| NextCloud                                                                             | No?         |       | No?       |                   | No CORS config by default.                                   |
+| OwnCloud                                                                              | No?         |       | No?       |                   | No CORS config by default.                                   |
+| Seafile                                                                               | ?           |       | ?         |                   |                                                              |
+| `rclone serve webdav`                                                                 | No          |       | No        |                   | No CORS support.                                             |
+| [Nutstore 坚果云](https://www.jianguoyun.com/)                                        | No          |       | No        |                   | No CORS support.                                             |
+| [TeraCLOUD](https://teracloud.jp/en/)                                                 | No          |       | No        |                   | 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       |       |           | No                | Technically never possible to be implemented.                |
+| SFTP                                                                                  | Never       |       |           | No                | 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
+1. Local files. By scanning all files in the vault locally. Actually Obsidian provides an api directly returning this.
-2. Remote files
+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.
+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,61 @@
+# 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
+
+| 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,7 +1,7 @@
 {
   "id": "remotely-save",
   "name": "Remotely Save",
-  "version": "0.2.13",
+  "version": "0.3.0",
   "minAppVersion": "0.12.15",
   "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
   "author": "fyears",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "remotely-save",
-  "version": "0.2.13",
+  "version": "0.3.0",
   "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": [],
@@ -53,7 +54,7 @@
     "@aws-sdk/client-s3": "^3.37.0",
     "@aws-sdk/lib-storage": "^3.40.1",
     "@aws-sdk/signature-v4-crt": "^3.37.0",
-    "@azure/msal-node": "^1.4.0",
+    "@azure/msal-node": "^1.6.0",
     "@fyears/tsqueue": "^1.0.1",
     "@microsoft/microsoft-graph-client": "^3.0.1",
     "acorn": "^8.5.0",
@@ -76,6 +77,7 @@
     "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

@@ -56,6 +56,7 @@ export interface RemotelySavePluginSettings {
   currLogLevel?: string;
   vaultRandomID?: string;
   autoRunEveryMilliseconds?: number;
+  agreeToUploadExtraMetadata?: boolean;
 }
 
 export interface RemoteItem {
@@ -80,3 +81,35 @@ 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;
+}

src/main.ts

@@ -34,11 +34,13 @@ 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 * 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 +53,7 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   currLogLevel: "info",
   vaultRandomID: "",
   autoRunEveryMilliseconds: -1,
+  agreeToUploadExtraMetadata: false,
 };
 
 interface OAuth2Info {
@@ -61,7 +64,7 @@ interface OAuth2Info {
   revokeAuthSetting?: Setting;
 }
 
-type SyncTriggerSourceType = "manual" | "auto";
+type SyncTriggerSourceType = "manual" | "auto" | "dry";
 
 const iconNameSyncWait = `remotely-save-sync-wait`;
 const iconNameSyncRunning = `remotely-save-sync-running`;
@@ -89,7 +92,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 +125,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.");
+      getNotice(`2/${MAX_STEPS} Starting to fetch remote meta data.`);
-      this.syncStatus = "getting_remote_meta";
+      this.syncStatus = "getting_remote_files_list";
       const self = this;
       const client = new RemoteClient(
         this.settings.serviceType,
@@ -143,17 +154,7 @@ export default class RemotelySavePlugin extends Plugin {
       const remoteRsp = await client.listFromRemote();
       log.info(remoteRsp);
 
-      getNotice("3/7 Starting to fetch local meta data.");
+      getNotice(`3/${MAX_STEPS} Checking password correct or not.`);
-      this.syncStatus = "getting_local_meta";
-      const local = this.app.vault.getAllLoadedFiles();
-      const localHistory = await loadDeleteRenameHistoryTableByVault(
-        this.db,
-        this.settings.vaultRandomID
-      );
-      // log.info(local);
-      // log.info(localHistory);
-
-      getNotice("4/7 Checking password correct or not.");
       this.syncStatus = "checking_password";
       const passwordCheckResult = await isPasswordOk(
         remoteRsp.Contents,
@@ -164,43 +165,81 @@ export default class RemotelySavePlugin extends Plugin {
         throw Error(passwordCheckResult.reason);
       }
 
-      getNotice("5/7 Starting to generate sync plan.");
+      getNotice(`4/${MAX_STEPS} Trying to fetch extra meta data from remote.`);
-      this.syncStatus = "generating_plan";
+      this.syncStatus = "getting_remote_extra_meta";
-      const syncPlan = await getSyncPlan(
+      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
+      const origMetadataOnRemote = await fetchMetadataFile(
-      await insertSyncPlanRecordByVault(
+        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
       );
+      // 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,
+        origMetadataOnRemote.deletions,
+        localHistory,
+        client.serviceType,
+        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";
+        this.syncStatus = "syncing";
-      await doActualSync(
+        await doActualSync(
-        client,
+          client,
-        this.db,
+          this.db,
-        this.settings.vaultRandomID,
+          this.settings.vaultRandomID,
-        this.app.vault,
+          this.app.vault,
-        syncPlan,
+          plan,
-        this.settings.password,
+          sortedKeys,
-        (i: number, totalCount: number, pathName: string, decision: string) =>
+          metadataFile,
-          self.setCurrSyncMsg(i, totalCount, pathName, decision)
+          origMetadataOnRemote,
-      );
+          deletions,
+          (key: string) => self.trash(key),
+          this.settings.password,
+          (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!");
+      getNotice(`8/${MAX_STEPS} Remotely Save finish!`);
-      this.currSyncMsg = "";
       this.syncStatus = "finish";
       this.syncStatus = "idle";
 
@@ -474,22 +513,24 @@ 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 (
+    if (!this.settings.agreeToUploadExtraMetadata) {
-      this.settings.autoRunEveryMilliseconds !== undefined &&
+      const syncAlgoV2Modal = new SyncAlgoV2Modal(this.app, this);
-      this.settings.autoRunEveryMilliseconds !== null &&
+      syncAlgoV2Modal.open();
-      this.settings.autoRunEveryMilliseconds > 0
-    ) {
-      const intervalID = window.setInterval(() => {
-        this.syncRun("auto");
-      }, this.settings.autoRunEveryMilliseconds);
-      this.autoRunIntervalID = intervalID;
-      this.registerInterval(intervalID);
     }
   }
 
@@ -602,10 +643,35 @@ 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
+    ) {
+      const intervalID = window.setInterval(() => {
+        this.syncRun("auto");
+      }, this.settings.autoRunEveryMilliseconds);
+      this.autoRunIntervalID = intervalID;
+      this.registerInterval(intervalID);
+    }
+  }
+
+  async saveAgreeToUseNewSyncAlgorithm() {
+    this.settings.agreeToUploadExtraMetadata = true;
+    await this.saveSettings();
+  }
+
   destroyDBs() {
     /* destroyDBs(this.db); */
   }

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

@@ -38,7 +38,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 +48,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("/");
+    let k = y1.slice(0, index + 1).join("/");
-    if (k !== "" && k !== "/") {
+    if (k === "" || k === "/") {
-      res.push(k);
+      continue;
     }
+    if (addEndingSlash) {
+      k = `${k}/`;
+    }
+    res.push(k);
   }
   return res;
 };
@@ -157,6 +161,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

src/remote.ts

@@ -102,7 +102,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 +114,9 @@ export class RemoteClient {
         vault,
         isRecursively,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        uploadRaw,
+        rawContent
       );
     } else if (this.serviceType === "webdav") {
       return await webdav.uploadToRemote(
@@ -121,7 +125,9 @@ export class RemoteClient {
         vault,
         isRecursively,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        uploadRaw,
+        rawContent
       );
     } else if (this.serviceType === "dropbox") {
       return await dropbox.uploadToRemote(
@@ -131,7 +137,9 @@ export class RemoteClient {
         isRecursively,
         password,
         remoteEncryptedKey,
-        foldersCreatedBefore
+        foldersCreatedBefore,
+        uploadRaw,
+        rawContent
       );
     } else if (this.serviceType === "onedrive") {
       return await onedrive.uploadToRemote(
@@ -141,7 +149,9 @@ export class RemoteClient {
         isRecursively,
         password,
         remoteEncryptedKey,
-        foldersCreatedBefore
+        foldersCreatedBefore,
+        uploadRaw,
+        rawContent
       );
     } else {
       throw Error(`not supported service type ${this.serviceType}`);
@@ -167,7 +177,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 +188,8 @@ export class RemoteClient {
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else if (this.serviceType === "webdav") {
       return await webdav.downloadFromRemote(
@@ -186,7 +198,8 @@ export class RemoteClient {
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else if (this.serviceType === "dropbox") {
       return await dropbox.downloadFromRemote(
@@ -195,7 +208,8 @@ export class RemoteClient {
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else if (this.serviceType === "onedrive") {
       return await onedrive.downloadFromRemote(
@@ -204,7 +218,8 @@ export class RemoteClient {
         vault,
         mtime,
         password,
-        remoteEncryptedKey
+        remoteEncryptedKey,
+        skipSaving
       );
     } else {
       throw Error(`not supported service type ${this.serviceType}`);

src/remoteForDropbox.ts

@@ -400,7 +400,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 +417,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 +453,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);
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
@@ -551,13 +565,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 +582,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 +594,12 @@ export const downloadFromRemote = async (
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
-    await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
+    if (!skipSaving) {
-      mtime: mtime,
+      await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
-    });
+        mtime: mtime,
+      });
+    }
+    return localContent;
   }
 };
 

src/remoteForOnedrive.ts

@@ -1,26 +1,19 @@
 import { CryptoProvider, PublicClientApplication } from "@azure/msal-node";
-import {
+import { AuthenticationProvider } from "@microsoft/microsoft-graph-client";
-  AuthenticationProvider,
+import type {
-  Client,
+  DriveItem,
-  FileUpload,
+  UploadSession,
-  LargeFileUploadSession,
+  User,
-  LargeFileUploadTask,
+} from "@microsoft/microsoft-graph-types";
-  LargeFileUploadTaskOptions,
-  Range,
-  UploadEventHandlers,
-  UploadResult,
-} from "@microsoft/microsoft-graph-client";
-import type { DriveItem, User } from "@microsoft/microsoft-graph-types";
 import cloneDeep from "lodash/cloneDeep";
+import * as origLog from "loglevel";
 import { request, Vault } from "obsidian";
-import * as path from "path";
 import {
-  DropboxConfig,
+  COMMAND_CALLBACK_ONEDRIVE,
   OAUTH2_FORCE_EXPIRE_MILLISECONDS,
   OnedriveConfig,
   RemoteItem,
 } from "./baseTypes";
-import { COMMAND_CALLBACK_ONEDRIVE } from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import {
   getRandomArrayBuffer,
@@ -28,7 +21,6 @@ import {
   mkdirpInVault,
 } from "./misc";
 
-import * as origLog from "loglevel";
 const log = origLog.getLogger("rs-default");
 
 const SCOPES = ["User.Read", "Files.ReadWrite.AppFolder", "offline_access"];
@@ -321,7 +313,7 @@ const fromDriveItemToRemoteItem = (
     lastModified: Date.parse(x.fileSystemInfo.lastModifiedDateTime),
     size: isFolder ? 0 : x.size,
     remoteType: "onedrive",
-    etag: x.eTag || x.cTag || "",
+    etag: x.cTag || "", // do NOT use x.eTag because it changes if meta changes
   };
 };
 
@@ -376,8 +368,8 @@ class MyAuthProvider implements AuthenticationProvider {
 export class WrappedOnedriveClient {
   onedriveConfig: OnedriveConfig;
   vaultName: string;
-  client: Client;
   vaultFolderExists: boolean;
+  authGetter: MyAuthProvider;
   saveUpdatedConfigFunc: () => Promise<any>;
   constructor(
     onedriveConfig: OnedriveConfig,
@@ -388,9 +380,7 @@ export class WrappedOnedriveClient {
     this.vaultName = vaultName;
     this.vaultFolderExists = false;
     this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
-    this.client = Client.initWithMiddleware({
+    this.authGetter = new MyAuthProvider(onedriveConfig, saveUpdatedConfigFunc);
-      authProvider: new MyAuthProvider(onedriveConfig, saveUpdatedConfigFunc),
-    });
   }
 
   init = async () => {
@@ -407,14 +397,14 @@ export class WrappedOnedriveClient {
     if (this.vaultFolderExists) {
       // log.info(`already checked, /${this.vaultName} exist before`)
     } else {
-      const k = await this.client.api("/drive/special/approot/children").get();
+      const k = await this.getJson("/drive/special/approot/children");
-      // log.info(k);
+      log.debug(k);
       this.vaultFolderExists =
         (k.value as DriveItem[]).filter((x) => x.name === this.vaultName)
           .length > 0;
       if (!this.vaultFolderExists) {
         log.info(`remote does not have folder /${this.vaultName}`);
-        await this.client.api("/drive/special/approot/children").post({
+        await this.postJson("/drive/special/approot/children", {
           name: `${this.vaultName}`,
           folder: {},
           "@microsoft.graph.conflictBehavior": "replace",
@@ -426,6 +416,132 @@ export class WrappedOnedriveClient {
       }
     }
   };
+
+  buildUrl = (pathFragOrig: string) => {
+    const API_PREFIX = "https://graph.microsoft.com/v1.0";
+    let theUrl = "";
+    if (
+      pathFragOrig.startsWith("http://") ||
+      pathFragOrig.startsWith("https://")
+    ) {
+      theUrl = pathFragOrig;
+    } else {
+      const pathFrag = encodeURI(pathFragOrig);
+      theUrl = `${API_PREFIX}${pathFrag}`;
+    }
+    return theUrl;
+  };
+
+  getJson = async (pathFragOrig: string) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(`getJson, theUrl=${theUrl}`);
+    return JSON.parse(
+      await request({
+        url: theUrl,
+        method: "GET",
+        contentType: "application/json",
+        headers: {
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      })
+    );
+  };
+
+  postJson = async (pathFragOrig: string, payload: any) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(`postJson, theUrl=${theUrl}`);
+    return JSON.parse(
+      await request({
+        url: theUrl,
+        method: "POST",
+        contentType: "application/json",
+        body: JSON.stringify(payload),
+        headers: {
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      })
+    );
+  };
+
+  patchJson = async (pathFragOrig: string, payload: any) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(`patchJson, theUrl=${theUrl}`);
+    return JSON.parse(
+      await request({
+        url: theUrl,
+        method: "PATCH",
+        contentType: "application/json",
+        body: JSON.stringify(payload),
+        headers: {
+          Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+        },
+      })
+    );
+  };
+
+  deleteJson = async (pathFragOrig: string) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(`deleteJson, theUrl=${theUrl}`);
+    // TODO: delete does not have response, so Obsidian request may have error
+    // currently downgraded to fetch()!
+    await fetch(theUrl, {
+      method: "DELETE",
+      headers: {
+        Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+      },
+    });
+  };
+
+  putArrayBuffer = async (pathFragOrig: string, payload: ArrayBuffer) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(`putArrayBuffer, theUrl=${theUrl}`);
+    // TODO: Obsidian doesn't support ArrayBuffer
+    // currently downgraded to fetch()!
+    await fetch(theUrl, {
+      method: "PUT",
+      body: payload,
+      headers: {
+        Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+      },
+    });
+  };
+
+  /**
+   * A specialized function to upload large files by parts
+   * @param pathFragOrig
+   * @param payload
+   * @param rangeMin
+   * @param rangeEnd the end, exclusive
+   * @param size
+   */
+  putUint8ArrayByRange = async (
+    pathFragOrig: string,
+    payload: Uint8Array,
+    rangeStart: number,
+    rangeEnd: number,
+    size: number
+  ) => {
+    const theUrl = this.buildUrl(pathFragOrig);
+    log.debug(
+      `putUint8ArrayByRange, theUrl=${theUrl}, range=${rangeStart}-${
+        rangeEnd - 1
+      }, len=${rangeEnd - rangeStart}, size=${size}`
+    );
+    // TODO: Obsidian doesn't support ArrayBuffer
+    // currently downgraded to fetch()!
+    // AND, NO AUTH HEADER here!
+    const res = await fetch(theUrl, {
+      method: "PUT",
+      body: payload.subarray(rangeStart, rangeEnd),
+      headers: {
+        "Content-Length": `${rangeEnd - rangeStart}`,
+        "Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
+        "Content-Type": "application/octet-stream",
+      },
+    });
+
+    return res.json() as DriveItem | UploadSession;
+  };
 }
 
 export const getOnedriveClient = (
@@ -457,13 +573,14 @@ export const listFromRemote = async (
 
   const NEXT_LINK_KEY = "@odata.nextLink";
   const DELTA_LINK_KEY = "@odata.deltaLink";
-  let res = await client.client
+
-    .api(`/drive/special/approot:/${client.vaultName}:/delta`)
+  let res = await client.getJson(
-    .get();
+    `/drive/special/approot:/${client.vaultName}:/delta`
+  );
   let driveItems = res.value as DriveItem[];
 
   while (NEXT_LINK_KEY in res) {
-    res = await client.client.api(res[NEXT_LINK_KEY]).get();
+    res = await client.getJson(res[NEXT_LINK_KEY]);
     driveItems.push(...cloneDeep(res.value as DriveItem[]));
   }
 
@@ -473,16 +590,11 @@ export const listFromRemote = async (
     await client.saveUpdatedConfigFunc();
   }
 
-  driveItems = driveItems.map((x) => {
-    const y = cloneDeep(x);
-    y.parentReference.path = y.parentReference.path.replace("/Apps", "/应用");
-    return y;
-  });
-
   // unify everything to RemoteItem
   const unifiedContents = driveItems
     .map((x) => fromDriveItemToRemoteItem(x, client.vaultName))
     .filter((x) => x.key !== "/");
+
   return {
     Contents: unifiedContents,
   };
@@ -495,10 +607,9 @@ export const getRemoteMeta = async (
   await client.init();
   const remotePath = getOnedrivePath(fileOrFolderPath, client.vaultName);
   // log.info(`remotePath=${remotePath}`);
-  const rsp = await client.client
+  const rsp = await client.getJson(
-    .api(remotePath)
+    `${remotePath}?$select=cTag,eTag,fileSystemInfo,folder,file,name,parentReference,size`
-    .select("cTag,eTag,fileSystemInfo,folder,file,name,parentReference,size")
+  );
-    .get();
   // log.info(rsp);
   const driveItem = rsp as DriveItem;
   const res = fromDriveItemToRemoteItem(driveItem, client.vaultName);
@@ -513,7 +624,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();
 
@@ -522,13 +635,16 @@ export const uploadToRemote = async (
     uploadFile = remoteEncryptedKey;
   }
   uploadFile = getOnedrivePath(uploadFile, client.vaultName);
-  // log.info(`uploadFile=${uploadFile}`);
+  log.debug(`uploadFile=${uploadFile}`);
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
   if (isFolder && isRecursively) {
     throw Error("upload function doesn't implement recursive function yet!");
   } else if (isFolder && !isRecursively) {
+    if (uploadRaw) {
+      throw Error(`you specify uploadRaw, but you also provide a folder key!`);
+    }
     // folder
     if (password === "") {
       // if not encrypted, mkdir a remote folder
@@ -537,7 +653,7 @@ export const uploadToRemote = async (
       } else {
         // https://stackoverflow.com/questions/56479865/creating-nested-folders-in-one-go-onedrive-api
         // use PATCH to create folder recursively!!!
-        await client.client.api(uploadFile).patch({
+        await client.patchJson(uploadFile, {
           folder: {},
           "@microsoft.graph.conflictBehavior": "replace",
         });
@@ -557,39 +673,13 @@ export const uploadToRemote = async (
         password
       );
 
-      const uploadSession: LargeFileUploadSession =
+      // an encrypted folder is always small, we just use put here
-        await LargeFileUploadTask.createUploadSession(
+      await client.putArrayBuffer(
-          client.client,
+        `${uploadFile}:/content?${new URLSearchParams({
-          `https://graph.microsoft.com/v1.0/me${encodeURIComponent(
+          "@microsoft.graph.conflictBehavior": "replace",
-            uploadFile
+        })}`,
-          )}:/createUploadSession`,
+        arrBufRandom
-          {
-            item: {
-              "@microsoft.graph.conflictBehavior": "replace",
-            },
-          }
-        );
-      const task = new LargeFileUploadTask(
-        client.client,
-        new FileUpload(
-          arrBufRandom,
-          path.posix.basename(uploadFile),
-          arrBufRandom.byteLength
-        ),
-        uploadSession,
-        {
-          rangeSize: 1024 * 1024,
-          uploadEventHandlers: {
-            progress: (range?: Range) => {
-              // Handle progress event
-              // log.info(
-              //   `uploading ${range.minValue}-${range.maxValue} of ${fileOrFolderPath}`
-              // );
-            },
-          } as UploadEventHandlers,
-        } as LargeFileUploadTaskOptions
       );
-      const uploadResult: UploadResult = await task.upload();
       // log.info(uploadResult)
       const res = await getRemoteMeta(client, uploadFile);
       return res;
@@ -597,7 +687,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);
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
@@ -605,48 +704,42 @@ export const uploadToRemote = async (
 
     // no need to create parent folders firstly, cool!
 
-    // we need to customize the special root folder,
+    // upload large files!
-    // so use LargeFileUploadTask instead of OneDriveLargeFileUploadTask
+    // ref: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createuploadsession?view=odsp-graph-online
-    const progress = (range?: Range) => {
+
-      // Handle progress event
+    // 1. create uploadSession
-      // log.info(
-      //   `uploading ${range.minValue}-${range.maxValue} of ${fileOrFolderPath}`
-      // );
-    };
-    const uploadEventHandlers: UploadEventHandlers = {
-      progress: progress,
-    };
-    const options: LargeFileUploadTaskOptions = {
-      rangeSize: 1024 * 1024,
-      uploadEventHandlers: uploadEventHandlers,
-    };
-    const payload = {
-      item: {
-        "@microsoft.graph.conflictBehavior": "replace",
-      },
-    };
     // uploadFile already starts with /drive/special/approot:/${vaultName}
-    const uploadSession: LargeFileUploadSession =
+    const s: UploadSession = await client.postJson(
-      await LargeFileUploadTask.createUploadSession(
+      `${uploadFile}:/createUploadSession`,
-        client.client,
+      {
-        `https://graph.microsoft.com/v1.0/me${encodeURIComponent(
+        item: {
-          uploadFile
+          "@microsoft.graph.conflictBehavior": "replace",
-        )}:/createUploadSession`,
+        },
-        payload
+      }
+    );
+    const uploadUrl = s.uploadUrl;
+    log.debug("uploadSession = ");
+    log.debug(s);
+
+    // 2. upload by ranges
+    // convert to uint8
+    const uint8 = new Uint8Array(remoteContent);
+    // hard code range size
+    const MIN_UNIT = 327680; // bytes in msft doc, about 0.32768 MB
+    const RANGE_SIZE = MIN_UNIT * 20; // about 6.5536 MB
+    // upload the ranges one by one
+    let rangeStart = 0;
+    while (rangeStart < uint8.byteLength) {
+      await client.putUint8ArrayByRange(
+        uploadUrl,
+        uint8,
+        rangeStart,
+        Math.min(rangeStart + RANGE_SIZE, uint8.byteLength),
+        uint8.byteLength
       );
-    const fileObject = new FileUpload(
+      rangeStart += RANGE_SIZE;
-      remoteContent,
+    }
-      path.posix.basename(uploadFile),
+
-      remoteContent.byteLength
-    );
-    const task = new LargeFileUploadTask(
-      client.client,
-      fileObject,
-      uploadSession,
-      options
-    );
-    const uploadResult: UploadResult = await task.upload();
-    // log.info(uploadResult)
     const res = await getRemoteMeta(client, uploadFile);
     return res;
   }
@@ -658,10 +751,9 @@ const downloadFromRemoteRaw = async (
 ): Promise<ArrayBuffer> => {
   await client.init();
   const key = getOnedrivePath(fileOrFolderPath, client.vaultName);
-  const rsp = await client.client
+  const rsp = await client.getJson(
-    .api(key)
+    `${key}?$select=@microsoft.graph.downloadUrl`
-    .select("@microsoft.graph.downloadUrl")
+  );
-    .get();
   const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
   const content = await (await fetch(downloadUrl)).arrayBuffer();
   return content;
@@ -673,17 +765,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 !== "") {
@@ -695,9 +791,12 @@ export const downloadFromRemote = async (
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
-    await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
+    if (!skipSaving) {
-      mtime: mtime,
+      await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
-    });
+        mtime: mtime,
+      });
+    }
+    return localContent;
   }
 };
 
@@ -717,7 +816,7 @@ export const deleteFromRemote = async (
   remoteFileName = getOnedrivePath(remoteFileName, client.vaultName);
 
   await client.init();
-  await client.client.api(remoteFileName).delete();
+  await client.deleteJson(remoteFileName);
 };
 
 export const checkConnectivity = async (client: WrappedOnedriveClient) => {
@@ -731,7 +830,7 @@ export const checkConnectivity = async (client: WrappedOnedriveClient) => {
 
 export const getUserDisplayName = async (client: WrappedOnedriveClient) => {
   await client.init();
-  const res: User = await client.client.api("/me").select("displayName").get();
+  const res: User = await client.getJson("/me?$select=displayName");
   return res.displayName || "<unknown display name>";
 };
 
@@ -744,7 +843,7 @@ export const getUserDisplayName = async (client: WrappedOnedriveClient) => {
  */
 // export const revokeAuth = async (client: WrappedOnedriveClient) => {
 //   await client.init();
-//   await client.client.api('/me/revokeSignInSessions').post(undefined);
+//   await client.postJson('/me/revokeSignInSessions', {});
 // };
 
 export const getRevokeAddr = async () => {

src/remoteForS3.ts

@@ -99,7 +99,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 +114,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,7 +138,16 @@ 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);
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
@@ -252,11 +266,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 +281,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 +296,12 @@ export const downloadFromRemote = async (
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
-    await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
+    if (!skipSaving) {
-      mtime: mtime,
+      await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
-    });
+        mtime: mtime,
+      });
+    }
+    return localContent;
   }
 };
 

src/remoteForWebdav.ts

@@ -138,7 +138,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 +154,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
@@ -174,7 +179,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);
+      } else {
+        localContent = rawContent;
+      }
+    } else {
+      localContent = await vault.adapter.readBinary(fileOrFolderPath);
+    }
     let remoteContent = localContent;
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
@@ -277,13 +291,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 +308,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 +320,12 @@ export const downloadFromRemote = async (
     if (password !== "") {
       localContent = await decryptArrayBuffer(remoteContent, password);
     }
-    await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
+    if (!skipSaving) {
-      mtime: mtime,
+      await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
-    });
+        mtime: mtime,
+      });
+    }
+    return localContent;
   }
 };
 

src/settings.ts

@@ -487,7 +487,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("")

src/syncAlgoV2Notice.ts

@@ -0,0 +1,68 @@
+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 this 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();
+    } 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

@@ -68,6 +68,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 +105,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 苹果");

versions.json

@@ -1,3 +1,3 @@
 {
-  "0.2.13": "0.12.15"
+  "0.3.0": "0.12.15"
 }

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"),