bump to 0.3.14

commit 1c24e48f2528238aeac417866ccec9ee3deced5f
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Fri Mar 25 02:08:05 2022 +0800

    just some trying

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,5 +1,5 @@
 name: Bug Report
-description: File a bug report
+description: Fire a bug report
 title: "[Bug]: "
 labels: ["bug"]
 body:
@@ -55,6 +55,14 @@ body:
       description: What version of Obsidian are you running?
     validations:
       required: false
+  - type: checkboxes
+    id: using-password
+    attributes:
+      label: Using password or not
+      description: Are you using password (end-to-end encryption) or not?
+      options:
+        - label: Yes.
+          required: false
   - type: checkboxes
     id: ensure-no-sensitive-information
     attributes:

.github/workflows/auto-build.yml

@@ -30,6 +30,7 @@ jobs:
         uses: actions/checkout@v2
         with:
           lfs: true
+          submodules: recursive
       - name: Checkout LFS
         run: git lfs checkout
       - name: Use Node.js ${{ matrix.node-version }}

.gitmodules

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

README.md

@@ -14,7 +14,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 
 ## !!!Caution!!!
 
-As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any serious vaults.** **ALWAYS, ALWAYS, backup your vault before using this plugin.**
+**ALWAYS, ALWAYS, backup your vault before using this plugin.**
 
 ## Features
 
@@ -23,7 +23,7 @@ As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any
   - Dropbox
   - OneDrive for personal
   - Webdav
-  - A list of connectable / not-connectable / in-the-plan / never-possible services are noted down [here](./docs/services_connectable_or_not.md).
+  - [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details.
 - **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
 - **[End-to-end encryption](./docs/encryption.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
 - **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
@@ -35,8 +35,7 @@ As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any
 
 - **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.
+- **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
-- **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
@@ -61,7 +60,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`. 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.
+- About CORS:
+  - If you are using Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, you can skip this CORS part.
+  - If you are using Obsidian desktop < 0.13.25 or mobile < 1.1.1, you need to configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, and add at least `ETag` into exposed headers. Full example is [here](./docs/s3_cors_configure.md). It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
 - Download and enable this plugin.
 - Enter your information to the settings of this plugin.
 - If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
@@ -70,15 +71,13 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 ### Dropbox
 
-- **This plugin's function for Dropbox is not as mature as functions for S3.**
 - **This plugin is NOT an official Dropbox product.** The plugin just uses Dropbox's public API.
 - After the authorization, the plugin can read your name and email (which cannot be unselected on Dropbox api), and read and write files in your Dropbox's `/Apps/remotely-save` folder.
-- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions.
+- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions. [More with screenshot is here](./docs/dropbox_review_material/README.md).
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
 
 ### OneDrive for personal
 
-- **This plugin's function for OneDrive is not as mature as functions for S3.**
 - **This plugin is NOT an official Microsoft / OneDrive product.** The plugin just uses Microsoft's [OneDrive's public API](https://docs.microsoft.com/en-us/onedrive/developer/rest-api).
 - This plugin only works for "OneDrive for personal", and not works for "OneDrive for Business" (yet). See [#11](https://github.com/fyears/remotely-save/issues/11) to further details.
 - After the authorization, the plugin can read your name and email, and read and write files in your OneDrive's `/Apps/remotely-save` folder.
@@ -87,10 +86,11 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 ### webdav
 
-- **webdav support is considered experimental.**
+- About CORS:
-- Currently only supports BASIC authorization method.
+  - If you are using Obsidian desktop >= 0.13.25 or iOS >= 1.1.1, you can skip this CORS part.
-- 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.
+  - If you are using Obsidian desktop < 0.13.25 or iOS < 1.1.1 or any Android 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.
+    - 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**.
@@ -101,6 +101,12 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 - In auto sync mode, if any error occurs, the plugin would **fail silently**.
 - Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
 
+## How To Deal With Hidden Files Or Folders
+
+**By default, all files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
+
+In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder (but not any other `.` files or folders).
+
 ## How To Debug
 
 See [here](./docs/how_to_debug/README.md) for more details.

docs/browser_env.md

@@ -6,7 +6,7 @@ Technically, the plugin (or any plugin?) runs in the js environment provided by
 
 Then some limitations are applied:
 
-1. [The CORS policy.](./browser_env_cors.md)
+1. [The CORS issue (solved in the new Obsidian version on some platforms).](./browser_env_cors.md)
 2. [No Node.js environment.](./browser_env_no_nodejs.md)
 3. If the cloud service uses OAuth flow, it needs to support PKCE. More details are [here](./browser_env_oauth2_pkce.md).
 4. [No background running after Obsidian is closes.](./browser_env_no_background_after_closing.md)

docs/browser_env_cors.md

@@ -4,18 +4,6 @@ The plugin is developed for the browser environment. The "fake" browser behind t
 
 [MDN has a doc about CORS.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
 
-To solve the issue, we have some options:
+From Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
 
-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.
+For using this plugin in Obsidian desktop < 0.13.25 or mobile < 1.1.1, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. Here is an example [configuration for Amazon S3](./s3_cors_configure.md).
-
-   [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/dropbox_review_material/README.md

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

docs/dropbox_review_material/attachments/step03.png

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

docs/dropbox_review_material/attachments/step05.png

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

docs/dropbox_review_material/attachments/step06.png

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

docs/dropbox_review_material/attachments/step07.png

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

docs/dropbox_review_material/attachments/step08.png

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

docs/dropbox_review_material/attachments/step09.png

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

docs/dropbox_review_material/attachments/step10.png

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

docs/dropbox_review_material/attachments/step11.png

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

docs/dropbox_review_material/attachments/step12.png

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

docs/dropbox_review_material/attachments/step13.png

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

docs/s3_cors_configure.md

@@ -1,5 +1,7 @@
 # How To Configure S3 CORS Rules
 
+If you are using the latest version of this plugin AND Obsidian desktop >= 0.13.25, mobile >= 1.1.1, you do not need to configure it any more. If you are using Obsidian desktop < 0.13.25, moble < 1.1.1, you are required to configure the rules as following.
+
 Thanks to [@NAL100 in the Discussion](https://github.com/fyears/remotely-save/discussions/28).
 
 Please try this config:

docs/services_connectable_or_not.md

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

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "remotely-save",
   "name": "Remotely Save",
-  "version": "0.3.5",
+  "version": "0.3.14",
   "minAppVersion": "0.13.21",
   "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.3.5",
+  "version": "0.3.14",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
     "dev2": "node esbuild.config.mjs",
@@ -26,11 +26,11 @@
     "@microsoft/microsoft-graph-types": "^2.11.0",
     "@types/chai": "^4.2.22",
     "@types/chai-as-promised": "^7.1.4",
-    "@types/feather-icons": "^4.7.0",
     "@types/jsdom": "^16.2.13",
     "@types/lodash": "^4.14.178",
     "@types/mime-types": "^2.1.1",
     "@types/mocha": "^9.0.0",
+    "@types/mustache": "^4.1.2",
     "@types/node": "^14.14.37",
     "@types/qrcode": "^1.4.1",
     "builtin-modules": "^3.2.0",
@@ -38,7 +38,7 @@
     "chai-as-promised": "^7.1.1",
     "cross-env": "^7.0.3",
     "dotenv": "^10.0.0",
-    "esbuild": "^0.14.3",
+    "esbuild": "^0.14.27",
     "jsdom": "^19.0.0",
     "mocha": "^9.1.3",
     "prettier": "^2.4.1",
@@ -51,13 +51,13 @@
     "webpack-cli": "^4.9.1"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.37.0",
+    "@aws-sdk/client-s3": "^3.54.0",
-    "@aws-sdk/fetch-http-handler": "^3.53.0",
+    "@aws-sdk/fetch-http-handler": "^3.54.0",
-    "@aws-sdk/lib-storage": "^3.53.1",
+    "@aws-sdk/lib-storage": "^3.54.0",
-    "@aws-sdk/protocol-http": "^3.53.0",
+    "@aws-sdk/protocol-http": "^3.54.0",
-    "@aws-sdk/querystring-builder": "^3.53.0",
+    "@aws-sdk/querystring-builder": "^3.54.0",
-    "@aws-sdk/signature-v4-crt": "^3.37.0",
+    "@aws-sdk/signature-v4-crt": "^3.54.0",
-    "@aws-sdk/types": "^3.53.0",
+    "@aws-sdk/types": "^3.54.0",
     "@azure/msal-node": "^1.6.0",
     "@fyears/tsqueue": "^1.0.1",
     "@microsoft/microsoft-graph-client": "^3.0.1",
@@ -65,15 +65,15 @@
     "assert": "^2.0.0",
     "aws-crt": "^1.10.1",
     "buffer": "^6.0.3",
-    "codemirror": "^5.63.1",
     "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",
+    "lucide": "^0.17.12",
     "mime-types": "^2.1.33",
+    "mustache": "^4.2.0",
     "nanoid": "^3.1.30",
     "obsidian": "^0.13.26",
     "p-queue": "^7.2.0",

src/baseTypes.ts

@@ -3,6 +3,8 @@
  * To avoid circular dependency.
  */
 
+import type { LangType, LangTypeAndAuto } from "./i18n";
+
 export type SUPPORTED_SERVICES_TYPE = "s3" | "webdav" | "dropbox" | "onedrive";
 
 export interface S3Config {
@@ -12,6 +14,8 @@ export interface S3Config {
   s3SecretAccessKey: string;
   s3BucketName: string;
   bypassCorsLocally?: boolean;
+  partsConcurrency?: number;
+  forcePathStyle?: boolean;
 }
 
 export interface DropboxConfig {
@@ -26,13 +30,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 {
@@ -55,11 +66,18 @@ export interface RemotelySavePluginSettings {
   password: string;
   serviceType: SUPPORTED_SERVICES_TYPE;
   currLogLevel?: string;
-  vaultRandomID?: string;
   autoRunEveryMilliseconds?: number;
   initRunAfterMilliseconds?: number;
   agreeToUploadExtraMetadata?: boolean;
   concurrency?: number;
+  syncConfigDir?: boolean;
+  syncUnderscoreItems?: boolean;
+  lang?: LangTypeAndAuto;
+
+  /**
+   * @deprecated
+   */
+  vaultRandomID?: string;
 }
 
 export interface RemoteItem {
@@ -110,7 +128,8 @@ export interface FileOrFolderMixedState {
   deltimeRemote?: number;
   sizeLocal?: number;
   sizeRemote?: number;
-  changeMtimeUsingMapping?: boolean;
+  changeRemoteMtimeUsingMapping?: boolean;
+  changeLocalMtimeUsingMapping?: boolean;
   decision?: DecisionType;
   decisionBranch?: number;
   syncDone?: "done";

src/configPersist.ts

@@ -7,7 +7,7 @@ import * as origLog from "loglevel";
 const log = origLog.getLogger("rs-default");
 
 const DEFAULT_README: string =
-  "Do NOT modify this manually. It's generated automatically.";
+  "The file contains sensitive info, so DO NOT take screenshot of, copy, or share it to anyone! It's also generated automatically, so do not edit it manually.";
 
 interface MessyConfigType {
   readme: string;

src/encrypt.ts

@@ -165,3 +165,23 @@ export const decryptBase64urlToString = async (
     )
   );
 };
+
+export const getSizeFromOrigToEnc = (x: number) => {
+  if (x < 0 || !Number.isInteger(x)) {
+    throw Error(`x=${x} is not a valid size`);
+  }
+  return (Math.floor(x / 16) + 1) * 16 + 16;
+};
+
+export const getSizeFromEncToOrig = (x: number) => {
+  if (x < 32 || !Number.isInteger(x)) {
+    throw Error(`${x} is not a valid size`);
+  }
+  if (x % 16 !== 0) {
+    throw Error(`${x} is not a valid encrypted file size`);
+  }
+  return {
+    minSize: ((x - 16) / 16 - 1) * 16,
+    maxSize: ((x - 16) / 16 - 1) * 16 + 15,
+  };
+};

src/i18n.ts

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

src/localdb.ts

@@ -1,21 +1,23 @@
 import localforage from "localforage";
-import { TAbstractFile, TFile, TFolder } from "obsidian";
+import { requireApiVersion, TAbstractFile, TFile, TFolder } from "obsidian";
 
-import type { SUPPORTED_SERVICES_TYPE } from "./baseTypes";
+import { API_VER_STAT_FOLDER, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
 import type { SyncPlanType } from "./sync";
 
 export type LocalForage = typeof localforage;
 
 import * as origLog from "loglevel";
+import { nanoid } from "nanoid";
 const log = origLog.getLogger("rs-default");
 
-const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108];
+const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108, 20220326];
-export const DEFAULT_DB_VERSION_NUMBER: number = 20220108;
+export const DEFAULT_DB_VERSION_NUMBER: number = 20220326;
 export const DEFAULT_DB_NAME = "remotelysavedb";
 export const DEFAULT_TBL_VERSION = "schemaversion";
-export const DEFAULT_TBL_DELETE_HISTORY = "filefolderoperationhistory";
+export const DEFAULT_TBL_FILE_HISTORY = "filefolderoperationhistory";
 export const DEFAULT_TBL_SYNC_MAPPING = "syncmetadatahistory";
 export const DEFAULT_SYNC_PLANS_HISTORY = "syncplanshistory";
+export const DEFAULT_TBL_VAULT_RANDOM_ID_MAPPING = "vaultrandomidmapping";
 
 export interface FileFolderHistoryRecord {
   key: string;
@@ -23,7 +25,7 @@ export interface FileFolderHistoryRecord {
   mtime: number;
   size: number;
   actionWhen: number;
-  actionType: "delete" | "rename";
+  actionType: "delete" | "rename" | "renameDestination";
   keyType: "folder" | "file";
   renameTo: string;
   vaultRandomID: string;
@@ -51,9 +53,10 @@ interface SyncPlanRecord {
 
 export interface InternalDBs {
   versionTbl: LocalForage;
-  deleteHistoryTbl: LocalForage;
+  fileHistoryTbl: LocalForage;
   syncMappingTbl: LocalForage;
   syncPlansTbl: LocalForage;
+  vaultRandomIDMappingTbl: LocalForage;
 }
 
 /**
@@ -72,12 +75,12 @@ const migrateDBsFrom20211114To20220108 = async (
   const allPromisesToWait: Promise<any>[] = [];
 
   log.debug("assign vault id to any delete history");
-  const keysInDeleteHistoryTbl = await db.deleteHistoryTbl.keys();
+  const keysInDeleteHistoryTbl = await db.fileHistoryTbl.keys();
   for (const key of keysInDeleteHistoryTbl) {
     if (key.startsWith(vaultRandomID)) {
       continue;
     }
-    const value = (await db.deleteHistoryTbl.getItem(
+    const value = (await db.fileHistoryTbl.getItem(
       key
     )) as FileFolderHistoryRecord;
     if (value === null || value === undefined) {
@@ -87,8 +90,8 @@ const migrateDBsFrom20211114To20220108 = async (
       value.vaultRandomID = vaultRandomID;
     }
     const newKey = `${vaultRandomID}\t${key}`;
-    allPromisesToWait.push(db.deleteHistoryTbl.setItem(newKey, value));
+    allPromisesToWait.push(db.fileHistoryTbl.setItem(newKey, value));
-    allPromisesToWait.push(db.deleteHistoryTbl.removeItem(key));
+    allPromisesToWait.push(db.fileHistoryTbl.removeItem(key));
   }
 
   log.debug("assign vault id to any sync mapping");
@@ -136,6 +139,23 @@ const migrateDBsFrom20211114To20220108 = async (
   log.debug(`finish upgrading internal db from ${oldVer} to ${newVer}`);
 };
 
+/**
+ * no need to do anything except changing version
+ * we just add more file operations in db, and no schema is changed.
+ * @param db
+ * @param vaultRandomID
+ */
+const migrateDBsFrom20220108To20220326 = async (
+  db: InternalDBs,
+  vaultRandomID: string
+) => {
+  const oldVer = 20220108;
+  const newVer = 20220326;
+  log.debug(`start upgrading internal db from ${oldVer} to ${newVer}`);
+  await db.versionTbl.setItem("version", newVer);
+  log.debug(`finish upgrading internal db from ${oldVer} to ${newVer}`);
+};
+
 const migrateDBs = async (
   db: InternalDBs,
   oldVer: number,
@@ -148,19 +168,36 @@ const migrateDBs = async (
   if (oldVer === 20211114 && newVer === 20220108) {
     return await migrateDBsFrom20211114To20220108(db, vaultRandomID);
   }
+  if (oldVer === 20220108 && newVer === 20220326) {
+    return await migrateDBsFrom20220108To20220326(db, vaultRandomID);
+  }
+  if (oldVer === 20211114 && newVer === 20220326) {
+    // TODO: more steps with more versions in the future
+    await migrateDBsFrom20211114To20220108(db, vaultRandomID);
+    await migrateDBsFrom20220108To20220326(db, vaultRandomID);
+    return;
+  }
+  if (newVer < oldVer) {
+    throw Error(
+      "You've installed a new version, but then downgrade to an old version. Stop working!"
+    );
+  }
   // not implemented
   throw Error(`not supported internal db changes from ${oldVer} to ${newVer}`);
 };
 
-export const prepareDBs = async (vaultRandomID: string) => {
+export const prepareDBs = async (
+  vaultBasePath: string,
+  vaultRandomIDFromOldConfigFile: string
+) => {
   const db = {
     versionTbl: localforage.createInstance({
       name: DEFAULT_DB_NAME,
       storeName: DEFAULT_TBL_VERSION,
     }),
-    deleteHistoryTbl: localforage.createInstance({
+    fileHistoryTbl: localforage.createInstance({
       name: DEFAULT_DB_NAME,
-      storeName: DEFAULT_TBL_DELETE_HISTORY,
+      storeName: DEFAULT_TBL_FILE_HISTORY,
     }),
     syncMappingTbl: localforage.createInstance({
       name: DEFAULT_DB_NAME,
@@ -170,9 +207,42 @@ export const prepareDBs = async (vaultRandomID: string) => {
       name: DEFAULT_DB_NAME,
       storeName: DEFAULT_SYNC_PLANS_HISTORY,
     }),
+    vaultRandomIDMappingTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_VAULT_RANDOM_ID_MAPPING,
+    }),
   } as InternalDBs;
 
-  const originalVersion = (await db.versionTbl.getItem("version")) as number;
+  // try to get vaultRandomID firstly
+  let vaultRandomID = "";
+  const vaultRandomIDInDB: string | null =
+    await db.vaultRandomIDMappingTbl.getItem(`path2id\t${vaultBasePath}`);
+  if (vaultRandomIDInDB === null) {
+    if (vaultRandomIDFromOldConfigFile !== "") {
+      // reuse the old config id
+      vaultRandomID = vaultRandomIDFromOldConfigFile;
+    } else {
+      // no old config id, we create a random one
+      vaultRandomID = nanoid();
+    }
+    // save the id back
+    await db.vaultRandomIDMappingTbl.setItem(
+      `path2id\t${vaultBasePath}`,
+      vaultRandomID
+    );
+    await db.vaultRandomIDMappingTbl.setItem(
+      `id2path\t${vaultRandomID}`,
+      vaultBasePath
+    );
+  } else {
+    vaultRandomID = vaultRandomIDInDB;
+  }
+
+  if (vaultRandomID === "") {
+    throw Error("no vaultRandomID found or generated");
+  }
+
+  const originalVersion: number | null = await db.versionTbl.getItem("version");
   if (originalVersion === null) {
     log.debug(
       `no internal db version, setting it to ${DEFAULT_DB_VERSION_NUMBER}`
@@ -193,7 +263,10 @@ export const prepareDBs = async (vaultRandomID: string) => {
   }
 
   log.info("db connected");
-  return db;
+  return {
+    db: db,
+    vaultRandomID: vaultRandomID,
+  };
 };
 
 export const destroyDBs = async () => {
@@ -206,20 +279,20 @@ export const destroyDBs = async () => {
     log.info("db deleted");
   };
   req.onblocked = (event) => {
-    console.warn("trying to delete db but it was blocked");
+    log.warn("trying to delete db but it was blocked");
   };
   req.onerror = (event) => {
-    console.error("tried to delete db but something bad!");
+    log.error("tried to delete db but something goes wrong!");
-    console.error(event);
+    log.error(event);
   };
 };
 
-export const loadDeleteRenameHistoryTableByVault = async (
+export const loadFileHistoryTableByVault = async (
   db: InternalDBs,
   vaultRandomID: string
 ) => {
   const records = [] as FileFolderHistoryRecord[];
-  await db.deleteHistoryTbl.iterate((value, key, iterationNumber) => {
+  await db.fileHistoryTbl.iterate((value, key, iterationNumber) => {
     if (key.startsWith(`${vaultRandomID}\t`)) {
       records.push(value as FileFolderHistoryRecord);
     }
@@ -233,7 +306,16 @@ export const clearDeleteRenameHistoryOfKeyAndVault = async (
   key: string,
   vaultRandomID: string
 ) => {
-  await db.deleteHistoryTbl.removeItem(`${vaultRandomID}\t${key}`);
+  const fullKey = `${vaultRandomID}\t${key}`;
+  const item: FileFolderHistoryRecord | null = await db.fileHistoryTbl.getItem(
+    fullKey
+  );
+  if (
+    item !== null &&
+    (item.actionType === "delete" || item.actionType === "rename")
+  ) {
+    await db.fileHistoryTbl.removeItem(fullKey);
+  }
 };
 
 export const insertDeleteRecordByVault = async (
@@ -260,10 +342,12 @@ export const insertDeleteRecordByVault = async (
     const key = fileOrFolder.path.endsWith("/")
       ? fileOrFolder.path
       : `${fileOrFolder.path}/`;
+    const ctime = 0; // they are deleted, so no way to get ctime, mtime
+    const mtime = 0; // they are deleted, so no way to get ctime, mtime
     k = {
       key: key,
-      ctime: 0,
+      ctime: ctime,
-      mtime: 0,
+      mtime: mtime,
       size: 0,
       actionWhen: Date.now(),
       actionType: "delete",
@@ -272,9 +356,19 @@ export const insertDeleteRecordByVault = async (
       vaultRandomID: vaultRandomID,
     };
   }
-  await db.deleteHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
+  await db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
 };
 
+/**
+ * A file/folder is renamed from A to B
+ * We insert two records:
+ * A with actionType="rename"
+ * B with actionType="renameDestination"
+ * @param db
+ * @param fileOrFolder
+ * @param oldPath
+ * @param vaultRandomID
+ */
 export const insertRenameRecordByVault = async (
   db: InternalDBs,
   fileOrFolder: TAbstractFile,
@@ -282,37 +376,73 @@ export const insertRenameRecordByVault = async (
   vaultRandomID: string
 ) => {
   // log.info(fileOrFolder);
-  let k: FileFolderHistoryRecord;
+  let k1: FileFolderHistoryRecord;
+  let k2: FileFolderHistoryRecord;
+  const actionWhen = Date.now();
   if (fileOrFolder instanceof TFile) {
-    k = {
+    k1 = {
       key: oldPath,
       ctime: fileOrFolder.stat.ctime,
       mtime: fileOrFolder.stat.mtime,
       size: fileOrFolder.stat.size,
-      actionWhen: Date.now(),
+      actionWhen: actionWhen,
       actionType: "rename",
       keyType: "file",
       renameTo: fileOrFolder.path,
       vaultRandomID: vaultRandomID,
     };
+    k2 = {
+      key: fileOrFolder.path,
+      ctime: fileOrFolder.stat.ctime,
+      mtime: fileOrFolder.stat.mtime,
+      size: fileOrFolder.stat.size,
+      actionWhen: actionWhen,
+      actionType: "renameDestination",
+      keyType: "file",
+      renameTo: "", // itself is the destination, so no need to set this field
+      vaultRandomID: vaultRandomID,
+    };
   } else if (fileOrFolder instanceof TFolder) {
     const key = oldPath.endsWith("/") ? oldPath : `${oldPath}/`;
     const renameTo = fileOrFolder.path.endsWith("/")
       ? fileOrFolder.path
       : `${fileOrFolder.path}/`;
-    k = {
+    let ctime = 0;
+    let mtime = 0;
+    if (requireApiVersion(API_VER_STAT_FOLDER)) {
+      // TAbstractFile does not contain these info
+      // but from API_VER_STAT_FOLDER we can manually stat them by path.
+      const s = await fileOrFolder.vault.adapter.stat(fileOrFolder.path);
+      ctime = s.ctime;
+      mtime = s.mtime;
+    }
+    k1 = {
       key: key,
-      ctime: 0,
+      ctime: ctime,
-      mtime: 0,
+      mtime: mtime,
       size: 0,
-      actionWhen: Date.now(),
+      actionWhen: actionWhen,
       actionType: "rename",
       keyType: "folder",
       renameTo: renameTo,
       vaultRandomID: vaultRandomID,
     };
+    k2 = {
+      key: renameTo,
+      ctime: ctime,
+      mtime: mtime,
+      size: 0,
+      actionWhen: actionWhen,
+      actionType: "renameDestination",
+      keyType: "folder",
+      renameTo: "", // itself is the destination, so no need to set this field
+      vaultRandomID: vaultRandomID,
+    };
   }
-  await db.deleteHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
+  await Promise.all([
+    db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k1.key}`, k1),
+    db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k2.key}`, k2),
+  ]);
 };
 
 export const upsertSyncMetaMappingDataByVault = async (

src/main.ts

@@ -1,7 +1,14 @@
-import { Modal, Notice, Plugin, Setting, addIcon, setIcon } from "obsidian";
+import {
+  Modal,
+  Notice,
+  Plugin,
+  Setting,
+  addIcon,
+  setIcon,
+  FileSystemAdapter,
+} from "obsidian";
 import cloneDeep from "lodash/cloneDeep";
-import { nanoid } from "nanoid";
+import { createElement, RotateCcw, RefreshCcw } from "lucide";
-import feather from "feather-icons";
 import type { RemotelySavePluginSettings } from "./baseTypes";
 import {
   COMMAND_CALLBACK,
@@ -10,13 +17,13 @@ import {
   COMMAND_URI,
 } from "./baseTypes";
 import { importQrCodeUri } from "./importExport";
-import type { InternalDBs } from "./localdb";
 import {
   insertDeleteRecordByVault,
   insertRenameRecordByVault,
   insertSyncPlanRecordByVault,
-  loadDeleteRenameHistoryTableByVault,
+  loadFileHistoryTableByVault,
   prepareDBs,
+  InternalDBs,
 } from "./localdb";
 import { RemoteClient } from "./remote";
 import {
@@ -37,6 +44,9 @@ import { RemotelySaveSettingTab } from "./settings";
 import { fetchMetadataFile, parseRemoteItems, SyncStatusType } from "./sync";
 import { doActualSync, getSyncPlan, isPasswordOk } from "./sync";
 import { messyConfigToNormal, normalConfigToMessy } from "./configPersist";
+import { ObsConfigDirFileType, listFilesInObsFolder } from "./obsFolderLister";
+import { I18n } from "./i18n";
+import type { LangType, LangTypeAndAuto, TransItemType } from "./i18n";
 
 import * as origLog from "loglevel";
 import { DeletionOnRemote, MetadataOnRemote } from "./metadataOnRemote";
@@ -51,11 +61,14 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   password: "",
   serviceType: "s3",
   currLogLevel: "info",
-  vaultRandomID: "",
+  // vaultRandomID: "", // deprecated
   autoRunEveryMilliseconds: -1,
   initRunAfterMilliseconds: -1,
   agreeToUploadExtraMetadata: false,
   concurrency: 5,
+  syncConfigDir: false,
+  syncUnderscoreItems: false,
+  lang: "auto",
 };
 
 interface OAuth2Info {
@@ -70,18 +83,26 @@ type SyncTriggerSourceType = "manual" | "auto" | "dry" | "autoOnceInit";
 
 const iconNameSyncWait = `remotely-save-sync-wait`;
 const iconNameSyncRunning = `remotely-save-sync-running`;
-const iconSvgSyncWait = feather.icons["rotate-ccw"].toSvg({
+
-  width: 100,
+const getIconSvg = () => {
-  height: 100,
+  const iconSvgSyncWait = createElement(RotateCcw);
-});
+  iconSvgSyncWait.setAttribute("width", "100");
-const iconSvgSyncRunning = feather.icons["refresh-ccw"].toSvg({
+  iconSvgSyncWait.setAttribute("height", "100");
-  width: 100,
+  const iconSvgSyncRunning = createElement(RefreshCcw);
-  height: 100,
+  iconSvgSyncRunning.setAttribute("width", "100");
-});
+  iconSvgSyncRunning.setAttribute("height", "100");
+  const res = {
+    iconSvgSyncWait: iconSvgSyncWait.outerHTML,
+    iconSvgSyncRunning: iconSvgSyncRunning.outerHTML,
+  };
+
+  iconSvgSyncWait.empty();
+  iconSvgSyncRunning.empty();
+  return res;
+};
 
 export default class RemotelySavePlugin extends Plugin {
   settings: RemotelySavePluginSettings;
-  // cm: CodeMirror.Editor;
   db: InternalDBs;
   syncStatus: SyncStatusType;
   oauth2Info: OAuth2Info;
@@ -89,18 +110,29 @@ export default class RemotelySavePlugin extends Plugin {
   currSyncMsg?: string;
   syncRibbon?: HTMLElement;
   autoRunIntervalID?: number;
+  i18n: I18n;
+  vaultRandomID: string;
 
   async syncRun(triggerSource: SyncTriggerSourceType = "manual") {
-    const getNotice = (x: string) => {
+    const t = (x: TransItemType, vars?: any) => {
+      return this.i18n.t(x, vars);
+    };
+
+    const getNotice = (x: string, timeout?: number) => {
       // only show notices in manual mode
       // no notice in auto mode
       if (triggerSource === "manual" || triggerSource === "dry") {
-        new Notice(x);
+        new Notice(x, timeout);
       }
     };
     if (this.syncStatus !== "idle") {
       // here the notice is shown regardless of triggerSource
-      new Notice(`Remotely Save already running in stage ${this.syncStatus}!`);
+      new Notice(
+        t("syncrun_alreadyrunning", {
+          pluginName: this.manifest.name,
+          syncStatus: this.syncStatus,
+        })
+      );
       if (this.currSyncMsg !== undefined && this.currSyncMsg !== "") {
         new Notice(this.currSyncMsg);
       }
@@ -123,7 +155,10 @@ export default class RemotelySavePlugin extends Plugin {
         setIcon(this.syncRibbon, iconNameSyncRunning);
         this.syncRibbon.setAttribute(
           "aria-label",
-          `${this.manifest.name}: ${triggerSource} syncing`
+          t("syncrun_syncingribbon", {
+            pluginName: this.manifest.name,
+            triggerSource: triggerSource,
+          })
         );
       }
 
@@ -131,17 +166,26 @@ export default class RemotelySavePlugin extends Plugin {
 
       if (triggerSource === "dry") {
         getNotice(
-          `0/${MAX_STEPS} Remotely Save running in dry mode, not actual file changes would happen.`
+          t("syncrun_step0", {
+            maxSteps: `${MAX_STEPS}`,
+          })
         );
       }
 
       //log.info(`huh ${this.settings.password}`)
       getNotice(
-        `1/${MAX_STEPS} Remotely Save Sync Preparing (${this.settings.serviceType})`
+        t("syncrun_step1", {
+          maxSteps: `${MAX_STEPS}`,
+          serviceType: this.settings.serviceType,
+        })
       );
       this.syncStatus = "preparing";
 
-      getNotice(`2/${MAX_STEPS} Starting to fetch remote meta data.`);
+      getNotice(
+        t("syncrun_step2", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       this.syncStatus = "getting_remote_files_list";
       const self = this;
       const client = new RemoteClient(
@@ -156,23 +200,31 @@ export default class RemotelySavePlugin extends Plugin {
       const remoteRsp = await client.listFromRemote();
       log.debug(remoteRsp);
 
-      getNotice(`3/${MAX_STEPS} Checking password correct or not.`);
+      getNotice(
+        t("syncrun_step3", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       this.syncStatus = "checking_password";
       const passwordCheckResult = await isPasswordOk(
         remoteRsp.Contents,
         this.settings.password
       );
       if (!passwordCheckResult.ok) {
-        getNotice("something goes wrong while checking password");
+        getNotice(t("syncrun_passworderr"));
         throw Error(passwordCheckResult.reason);
       }
 
-      getNotice(`4/${MAX_STEPS} Trying to fetch extra meta data from remote.`);
+      getNotice(
+        t("syncrun_step4", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       this.syncStatus = "getting_remote_extra_meta";
       const { remoteStates, metadataFile } = await parseRemoteItems(
         remoteRsp.Contents,
         this.db,
-        this.settings.vaultRandomID,
+        this.vaultRandomID,
         client.serviceType,
         this.settings.password
       );
@@ -183,47 +235,67 @@ export default class RemotelySavePlugin extends Plugin {
         this.settings.password
       );
 
-      getNotice(`5/${MAX_STEPS} Starting to fetch local meta data.`);
+      getNotice(
+        t("syncrun_step5", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       this.syncStatus = "getting_local_meta";
       const local = this.app.vault.getAllLoadedFiles();
-      const localHistory = await loadDeleteRenameHistoryTableByVault(
+      const localHistory = await loadFileHistoryTableByVault(
         this.db,
-        this.settings.vaultRandomID
+        this.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);
 
-      getNotice(`6/${MAX_STEPS} Starting to generate sync plan.`);
+      getNotice(
+        t("syncrun_step6", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       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(
+        await insertSyncPlanRecordByVault(this.db, plan, this.vaultRandomID);
-          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.
 
       if (triggerSource !== "dry") {
-        getNotice(`7/${MAX_STEPS} Remotely Save Sync data exchanging!`);
+        getNotice(
+          t("syncrun_step7", {
+            maxSteps: `${MAX_STEPS}`,
+          })
+        );
 
         this.syncStatus = "syncing";
         await doActualSync(
           client,
           this.db,
-          this.settings.vaultRandomID,
+          this.vaultRandomID,
           this.app.vault,
           plan,
           sortedKeys,
@@ -239,11 +311,17 @@ export default class RemotelySavePlugin extends Plugin {
       } else {
         this.syncStatus = "syncing";
         getNotice(
-          `7/${MAX_STEPS} Remotely Save real sync is skipped in dry run mode.`
+          t("syncrun_step7skip", {
+            maxSteps: `${MAX_STEPS}`,
+          })
         );
       }
 
-      getNotice(`8/${MAX_STEPS} Remotely Save finish!`);
+      getNotice(
+        t("syncrun_step8", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       this.syncStatus = "finish";
       this.syncStatus = "idle";
 
@@ -258,15 +336,16 @@ export default class RemotelySavePlugin extends Plugin {
         }-${Date.now()}: finish sync, triggerSource=${triggerSource}`
       );
     } catch (error) {
-      const msg = `${
+      const msg = t("syncrun_abort", {
-        this.manifest.id
+        manifestID: this.manifest.id,
-      }-${Date.now()}: abort sync, triggerSource=${triggerSource}, error while ${
+        theDate: `${Date.now()}`,
-        this.syncStatus
+        triggerSource: triggerSource,
-      }`;
+        syncStatus: this.syncStatus,
+      });
       log.info(msg);
       log.info(error);
-      getNotice(msg);
+      getNotice(msg, 10 * 1000);
-      getNotice(error.message);
+      getNotice(error.message, 10 * 1000);
       this.syncStatus = "idle";
       if (this.syncRibbon !== undefined) {
         setIcon(this.syncRibbon, iconNameSyncWait);
@@ -278,6 +357,8 @@ export default class RemotelySavePlugin extends Plugin {
   async onload() {
     log.info(`loading plugin ${this.manifest.id}`);
 
+    const { iconSvgSyncWait, iconSvgSyncRunning } = getIconSvg();
+
     addIcon(iconNameSyncWait, iconSvgSyncWait);
     addIcon(iconNameSyncRunning, iconSvgSyncRunning);
 
@@ -293,14 +374,41 @@ export default class RemotelySavePlugin extends Plugin {
 
     await this.loadSettings();
 
+    // lang should be load early, but after settings
+    this.i18n = new I18n(this.settings.lang, async (lang: LangTypeAndAuto) => {
+      this.settings.lang = lang;
+      await this.saveSettings();
+    });
+    const t = (x: TransItemType, vars?: any) => {
+      return this.i18n.t(x, vars);
+    };
+
     if (this.settings.currLogLevel !== undefined) {
       log.setLevel(this.settings.currLogLevel as any);
     }
 
     await this.checkIfOauthExpires();
-    await this.checkIfVaultIDAssigned(); // MUST before prepareDB()
 
-    await this.prepareDB();
+    // MUST before prepareDB()
+    // And, it's also possible to be an empty string,
+    // which means the vaultRandomID is read from db later!
+    const vaultRandomIDFromOldConfigFile =
+      await this.getVaultRandomIDFromOldConfigFile();
+
+    // no need to await this
+    this.tryToAddIgnoreFile();
+
+    const vaultBasePath = this.getVaultBasePath();
+
+    try {
+      await this.prepareDBAndVaultRandomID(
+        vaultBasePath,
+        vaultRandomIDFromOldConfigFile
+      );
+    } catch (err) {
+      new Notice(err.message, 10 * 1000);
+      throw err;
+    }
 
     this.syncStatus = "idle";
 
@@ -309,7 +417,7 @@ export default class RemotelySavePlugin extends Plugin {
         await insertDeleteRecordByVault(
           this.db,
           fileOrFolder,
-          this.settings.vaultRandomID
+          this.vaultRandomID
         );
       })
     );
@@ -320,7 +428,7 @@ export default class RemotelySavePlugin extends Plugin {
           this.db,
           fileOrFolder,
           oldPath,
-          this.settings.vaultRandomID
+          this.vaultRandomID
         );
       })
     );
@@ -335,7 +443,9 @@ export default class RemotelySavePlugin extends Plugin {
         this.settings = Object.assign({}, this.settings, copied);
         this.saveSettings();
         new Notice(
-          `New not-oauth2 settings for ${this.manifest.name} saved. Reopen the plugin Settings to the effect.`
+          t("protocol_saveqr", {
+            manifestName: this.manifest.name,
+          })
         );
       }
     });
@@ -344,9 +454,9 @@ export default class RemotelySavePlugin extends Plugin {
       COMMAND_CALLBACK,
       async (inputParams) => {
         new Notice(
-          `Your uri call a callback that's not supported yet: ${JSON.stringify(
+          t("protocol_callbacknotsupported", {
-            inputParams
+            params: JSON.stringify(inputParams),
-          )}`
+          })
         );
       }
     );
@@ -357,11 +467,13 @@ export default class RemotelySavePlugin extends Plugin {
         if (inputParams.code !== undefined) {
           if (this.oauth2Info.helperModal !== undefined) {
             this.oauth2Info.helperModal.contentEl.empty();
+
+            t("protocol_dropbox_connecting")
+              .split("\n")
+              .forEach((val) => {
                 this.oauth2Info.helperModal.contentEl.createEl("p", {
-              text: "Connecting to Dropbox...",
+                  text: val,
                 });
-            this.oauth2Info.helperModal.contentEl.createEl("p", {
-              text: "Please DO NOT close this modal.",
               });
           }
 
@@ -392,7 +504,11 @@ export default class RemotelySavePlugin extends Plugin {
           this.settings.dropbox.username = username;
           await this.saveSettings();
 
-          new Notice(`Good! We've connected to Dropbox as user ${username}!`);
+          new Notice(
+            t("protocol_dropbox_connect_succ", {
+              username: username,
+            })
+          );
 
           this.oauth2Info.verifier = ""; // reset it
           this.oauth2Info.helperModal?.close(); // close it
@@ -405,7 +521,9 @@ export default class RemotelySavePlugin extends Plugin {
           this.oauth2Info.authDiv = undefined;
 
           this.oauth2Info.revokeAuthSetting?.setDesc(
-            `You've connected as user ${this.settings.dropbox.username}. If you want to disconnect, click this button.`
+            t("protocol_dropbox_connect_succ_revoke", {
+              username: this.settings.dropbox.username,
+            })
           );
           this.oauth2Info.revokeAuthSetting = undefined;
           this.oauth2Info.revokeDiv?.toggleClass(
@@ -414,13 +532,11 @@ export default class RemotelySavePlugin extends Plugin {
           );
           this.oauth2Info.revokeDiv = undefined;
         } else {
-          new Notice(
+          new Notice(t("protocol_dropbox_connect_fail"));
-            "Something went wrong from response from Dropbox. Maybe you rejected the auth?"
-          );
           throw Error(
-            `do not know how to deal with the callback: ${JSON.stringify(
+            t("protocol_dropbox_connect_unknown", {
-              inputParams
+              params: JSON.stringify(inputParams),
-            )}`
+            })
           );
         }
       }
@@ -432,11 +548,13 @@ export default class RemotelySavePlugin extends Plugin {
         if (inputParams.code !== undefined) {
           if (this.oauth2Info.helperModal !== undefined) {
             this.oauth2Info.helperModal.contentEl.empty();
+
+            t("protocol_onedrive_connecting")
+              .split("\n")
+              .forEach((val) => {
                 this.oauth2Info.helperModal.contentEl.createEl("p", {
-              text: "Connecting to Onedrive...",
+                  text: val,
                 });
-            this.oauth2Info.helperModal.contentEl.createEl("p", {
-              text: "Please DO NOT close this modal.",
               });
           }
 
@@ -481,7 +599,9 @@ export default class RemotelySavePlugin extends Plugin {
           this.oauth2Info.authDiv = undefined;
 
           this.oauth2Info.revokeAuthSetting?.setDesc(
-            `You've connected as user ${this.settings.onedrive.username}. If you want to disconnect, click this button.`
+            t("protocol_onedrive_connect_succ_revoke", {
+              username: this.settings.onedrive.username,
+            })
           );
           this.oauth2Info.revokeAuthSetting = undefined;
           this.oauth2Info.revokeDiv?.toggleClass(
@@ -490,13 +610,11 @@ export default class RemotelySavePlugin extends Plugin {
           );
           this.oauth2Info.revokeDiv = undefined;
         } else {
-          new Notice(
+          new Notice(t("protocol_onedrive_connect_fail"));
-            "Something went wrong from response from OneDrive. Maybe you rejected the auth?"
-          );
           throw Error(
-            `do not know how to deal with the callback: ${JSON.stringify(
+            t("protocol_onedrive_connect_unknown", {
-              inputParams
+              params: JSON.stringify(inputParams),
-            )}`
+            })
           );
         }
       }
@@ -510,7 +628,7 @@ export default class RemotelySavePlugin extends Plugin {
 
     this.addCommand({
       id: "start-sync",
-      name: "start sync",
+      name: t("command_startsync"),
       icon: iconNameSyncWait,
       callback: async () => {
         this.syncRun("manual");
@@ -519,7 +637,7 @@ export default class RemotelySavePlugin extends Plugin {
 
     this.addCommand({
       id: "start-sync-dry-run",
-      name: "start sync (dry run only)",
+      name: t("command_drynrun"),
       icon: iconNameSyncWait,
       callback: async () => {
         this.syncRun("dry");
@@ -541,9 +659,13 @@ export default class RemotelySavePlugin extends Plugin {
     }
   }
 
-  onunload() {
+  async onunload() {
     log.info(`unloading plugin ${this.manifest.id}`);
-    this.destroyDBs();
+    this.syncRibbon = undefined;
+    if (this.oauth2Info !== undefined) {
+      this.oauth2Info.helperModal = undefined;
+      this.oauth2Info = undefined;
+    }
   }
 
   async loadSettings() {
@@ -564,6 +686,15 @@ 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";
+    }
+    if (this.settings.s3.partsConcurrency === undefined) {
+      this.settings.s3.partsConcurrency = 20;
+    }
+    if (this.settings.s3.forcePathStyle === undefined) {
+      this.settings.s3.forcePathStyle = false;
+    }
   }
 
   async saveSettings() {
@@ -640,14 +771,20 @@ export default class RemotelySavePlugin extends Plugin {
     }
   }
 
-  async checkIfVaultIDAssigned() {
+  async getVaultRandomIDFromOldConfigFile() {
-    if (
+    let vaultRandomID = "";
-      this.settings.vaultRandomID === undefined ||
+    if (this.settings.vaultRandomID !== undefined) {
-      this.settings.vaultRandomID === ""
+      // In old version, the vault id is saved in data.json
-    ) {
+      // But we want to store it in localForage later
-      this.settings.vaultRandomID = nanoid();
+      if (this.settings.vaultRandomID !== "") {
+        // a real string was assigned before
+        vaultRandomID = this.settings.vaultRandomID;
+      }
+      log.debug("vaultRandomID is no longer saved in data.json");
+      delete this.settings.vaultRandomID;
       await this.saveSettings();
     }
+    return vaultRandomID;
   }
 
   async trash(x: string) {
@@ -656,8 +793,26 @@ export default class RemotelySavePlugin extends Plugin {
     }
   }
 
-  async prepareDB() {
+  getVaultBasePath() {
-    this.db = await prepareDBs(this.settings.vaultRandomID);
+    if (this.app.vault.adapter instanceof FileSystemAdapter) {
+      // in desktop
+      return this.app.vault.adapter.getBasePath().split("?")[0];
+    } else {
+      // in mobile
+      return this.app.vault.adapter.getResourcePath("").split("?")[0];
+    }
+  }
+
+  async prepareDBAndVaultRandomID(
+    vaultBasePath: string,
+    vaultRandomIDFromOldConfigFile: string
+  ) {
+    const { db, vaultRandomID } = await prepareDBs(
+      vaultBasePath,
+      vaultRandomIDFromOldConfigFile
+    );
+    this.db = db;
+    this.vaultRandomID = vaultRandomID;
   }
 
   enableAutoSyncIfSet() {
@@ -695,10 +850,6 @@ export default class RemotelySavePlugin extends Plugin {
     await this.saveSettings();
   }
 
-  destroyDBs() {
-    /* destroyDBs(this.db); */
-  }
-
   async setCurrSyncMsg(
     i: number,
     totalCount: number,
@@ -708,4 +859,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/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;
     }
   }
@@ -260,3 +268,34 @@ export const getSplitRanges = (bytesTotal: number, bytesEachPart: number) => {
   }
   return res;
 };
+
+/**
+ * https://stackoverflow.com/questions/332422
+ * @param obj anything
+ * @returns string of the name of the object
+ */
+export const getTypeName = (obj: any) => {
+  return Object.prototype.toString.call(obj).slice(8, -1);
+};
+
+/**
+ * Startting from 1
+ * @param x
+ * @returns
+ */
+export const atWhichLevel = (x: string) => {
+  if (
+    x === undefined ||
+    x === "" ||
+    x === "." ||
+    x === ".." ||
+    x.startsWith("/")
+  ) {
+    throw Error(`do not know which level for ${x}`);
+  }
+  let y = x;
+  if (x.endsWith("/")) {
+    y = x.slice(0, -1);
+  }
+  return y.split("/").length;
+};

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) {
+      if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
-        throw Error("remember to provide vault name while init webdav client");
+        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(
@@ -265,15 +271,22 @@ export class RemoteClient {
     }
   };
 
-  checkConnectivity = async () => {
+  checkConnectivity = async (callbackFunc?: any) => {
     if (this.serviceType === "s3") {
-      return await s3.checkConnectivity(this.s3Client, this.s3Config);
+      return await s3.checkConnectivity(
+        this.s3Client,
+        this.s3Config,
+        callbackFunc
+      );
     } else if (this.serviceType === "webdav") {
-      return await webdav.checkConnectivity(this.webdavClient);
+      return await webdav.checkConnectivity(this.webdavClient, callbackFunc);
     } else if (this.serviceType === "dropbox") {
-      return await dropbox.checkConnectivity(this.dropboxClient);
+      return await dropbox.checkConnectivity(this.dropboxClient, callbackFunc);
     } else if (this.serviceType === "onedrive") {
-      return await onedrive.checkConnectivity(this.onedriveClient);
+      return await onedrive.checkConnectivity(
+        this.onedriveClient,
+        callbackFunc
+      );
     } else {
       throw Error(`not supported service type ${this.serviceType}`);
     }

src/remoteForDropbox.ts

@@ -636,7 +636,10 @@ export const deleteFromRemote = async (
   }
 };
 
-export const checkConnectivity = async (client: WrappedDropboxClient) => {
+export const checkConnectivity = async (
+  client: WrappedDropboxClient,
+  callbackFunc?: any
+) => {
   try {
     const results = await getRemoteMeta(client, "/");
     if (results === undefined) {
@@ -644,8 +647,10 @@ export const checkConnectivity = async (client: WrappedDropboxClient) => {
     }
     return true;
   } catch (err) {
-    console.error("dropbox connectivity error:");
+    log.debug(err);
-    console.error(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };

src/remoteForOnedrive.ts

@@ -866,11 +866,18 @@ export const deleteFromRemote = async (
   await client.deleteJson(remoteFileName);
 };
 
-export const checkConnectivity = async (client: WrappedOnedriveClient) => {
+export const checkConnectivity = async (
+  client: WrappedOnedriveClient,
+  callbackFunc?: any
+) => {
   try {
     const k = await getUserDisplayName(client);
     return k !== "<unknown display name>";
   } catch (err) {
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };

src/remoteForS3.ts

@@ -154,6 +154,8 @@ export const DEFAULT_S3_CONFIG = {
   s3SecretAccessKey: "",
   s3BucketName: "",
   bypassCorsLocally: true,
+  partsConcurrency: 20,
+  forcePathStyle: false,
 };
 
 export type S3ObjectType = _Object;
@@ -191,6 +193,7 @@ export const getS3Client = (s3Config: S3Config) => {
     const s3Client = new S3Client({
       region: s3Config.s3Region,
       endpoint: endpoint,
+      forcePathStyle: s3Config.forcePathStyle,
       credentials: {
         accessKeyId: s3Config.s3AccessKeyID,
         secretAccessKey: s3Config.s3SecretAccessKey,
@@ -202,6 +205,7 @@ export const getS3Client = (s3Config: S3Config) => {
     const s3Client = new S3Client({
       region: s3Config.s3Region,
       endpoint: endpoint,
+      forcePathStyle: s3Config.forcePathStyle,
       credentials: {
         accessKeyId: s3Config.s3AccessKeyID,
         secretAccessKey: s3Config.s3SecretAccessKey,
@@ -291,7 +295,7 @@ export const uploadToRemote = async (
     const body = new Uint8Array(remoteContent);
     const upload = new Upload({
       client: s3Client,
-      queueSize: 20, // concurrency
+      queueSize: s3Config.partsConcurrency, // concurrency
       partSize: bytesIn5MB, // minimal 5MB by default
       leavePartsOnError: false,
       params: {
@@ -494,7 +498,8 @@ export const deleteFromRemote = async (
  */
 export const checkConnectivity = async (
   s3Client: S3Client,
-  s3Config: S3Config
+  s3Config: S3Config,
+  callbackFunc?: any
 ) => {
   try {
     const results = await s3Client.send(
@@ -505,10 +510,19 @@ export const checkConnectivity = async (
       results.$metadata === undefined ||
       results.$metadata.httpStatusCode === undefined
     ) {
+      const err = "results or $metadata or httStatusCode is undefined";
+      log.debug(err);
+      if (callbackFunc !== undefined) {
+        callbackFunc(err);
+      }
       return false;
     }
     return results.$metadata.httpStatusCode === 200;
   } catch (err) {
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };

src/remoteForWebdav.ts

@@ -1,5 +1,13 @@
 import { Buffer } from "buffer";
-import { Vault, request, requestUrl, requireApiVersion } from "obsidian";
+import {
+  Vault,
+  request,
+  requestUrl,
+  requireApiVersion,
+  Platform,
+  Notice,
+  RequestUrlResponse,
+} from "obsidian";
 
 import { Queue } from "@fyears/tsqueue";
 import chunk from "lodash/chunk";
@@ -20,7 +28,7 @@ import type {
   ResponseDataDetailed,
 } from "webdav/web";
 import { getPatcher } from "webdav/web";
-if (requireApiVersion(API_VER_REQURL)) {
+if (requireApiVersion(API_VER_REQURL) && !Platform.isAndroidApp) {
   getPatcher().patch(
     "request",
     async (
@@ -118,6 +126,7 @@ export const DEFAULT_WEBDAV_CONFIG = {
   password: "",
   authType: "basic",
   manualRecursive: false,
+  depth: "auto_unknown",
 } as WebdavConfig;
 
 const getWebdavPath = (fileOrFolderPath: string, vaultName: string) => {
@@ -166,10 +175,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 () => {
@@ -197,25 +212,79 @@ export class WrappedWebdavClient {
     if (this.vaultFolderExists) {
       // pass
     } else {
-      const res = await this.client.exists(`/${this.vaultName}`);
+      const res = await this.client.exists(`/${this.vaultName}/`);
       if (res) {
         // log.info("remote vault folder exits!");
         this.vaultFolderExists = true;
       } else {
         log.info("remote vault folder not exists, creating");
-        await this.client.createDirectory(`/${this.vaultName}`);
+        await this.client.createDirectory(`/${this.vaultName}/`);
         log.info("remote vault folder created!");
         this.vaultFolderExists = true;
       }
     }
+
+    // adjust depth parameter
+    if (this.webdavConfig.depth === "auto_unknown") {
+      let testPassed = false;
+      try {
+        const res = await this.client.customRequest(`/${this.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 (
@@ -260,7 +329,7 @@ export const uploadToRemote = async (
     if (password === "") {
       // if not encrypted, mkdir a remote folder
       await client.client.createDirectory(uploadFile, {
-        recursive: true,
+        recursive: false, // the sync algo should guarantee no need to recursive
       });
       const res = await getRemoteMeta(client, uploadFile);
       return res;
@@ -292,11 +361,12 @@ export const uploadToRemote = async (
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
     }
-    // we need to create folders before uploading
+    // updated 20220326: the algorithm guarantee this
-    const dir = getPathFolder(uploadFile);
+    // // we need to create folders before uploading
-    if (dir !== "/" && dir !== "") {
+    // const dir = getPathFolder(uploadFile);
-      await client.client.createDirectory(dir, { recursive: true });
+    // if (dir !== "/" && dir !== "") {
-    }
+    //   await client.client.createDirectory(dir, { recursive: false });
+    // }
     await client.client.putFileContents(uploadFile, remoteContent, {
       overwrite: true,
       onUploadProgress: (progress: any) => {
@@ -318,7 +388,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}`]);
@@ -336,7 +409,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));
@@ -357,7 +433,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[];
   }
@@ -453,15 +532,40 @@ export const deleteFromRemote = async (
   }
 };
 
-export const checkConnectivity = async (client: WrappedWebdavClient) => {
+export const checkConnectivity = async (
+  client: WrappedWebdavClient,
+  callbackFunc?: any
+) => {
+  if (
+    !(
+      client.webdavConfig.address.startsWith("http://") ||
+      client.webdavConfig.address.startsWith("https://")
+    )
+  ) {
+    const err = "Error: the url should start with http(s):// but it does not!";
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
+    return false;
+  }
   try {
     await client.init();
     const results = await getRemoteMeta(client, "/");
     if (results === undefined) {
+      const err = "results is undefined";
+      log.debug(err);
+      if (callbackFunc !== undefined) {
+        callbackFunc(err);
+      }
       return false;
     }
     return true;
   } catch (err) {
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };

src/sync.ts

@@ -32,6 +32,7 @@ import {
   mkdirpInVault,
   getFolderLevels,
   getParentFolder,
+  atWhichLevel,
 } from "./misc";
 import { RemoteClient } from "./remote";
 import {
@@ -43,9 +44,9 @@ import {
   DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2,
   isEqualMetadataOnRemote,
 } from "./metadataOnRemote";
+import { isInsideObsFolder, ObsConfigDirFileType } from "./obsFolderLister";
 
 import * as origLog from "loglevel";
-import { padEnd } from "lodash";
 const log = origLog.getLogger("rs-default");
 
 export type SyncStatusType =
@@ -217,7 +218,7 @@ export const parseRemoteItems = async (
         mtimeRemote: backwardMapping.localMtime || entry.lastModified,
         sizeRemote: backwardMapping.localSize || entry.size,
         remoteEncryptedKey: remoteEncryptedKey,
-        changeMtimeUsingMapping: true,
+        changeRemoteMtimeUsingMapping: true,
       };
     } else {
       r = {
@@ -226,7 +227,7 @@ export const parseRemoteItems = async (
         mtimeRemote: entry.lastModified,
         sizeRemote: entry.size,
         remoteEncryptedKey: remoteEncryptedKey,
-        changeMtimeUsingMapping: false,
+        changeRemoteMtimeUsingMapping: false,
       };
     }
 
@@ -272,18 +273,39 @@ export const fetchMetadataFile = async (
   return metadata;
 };
 
+const isSkipItem = (
+  key: string,
+  syncConfigDir: boolean,
+  syncUnderscoreItems: boolean,
+  configDir: string
+) => {
+  if (syncConfigDir && isInsideObsFolder(key, configDir)) {
+    return false;
+  }
+  return (
+    isHiddenPath(key, true, false) ||
+    (!syncUnderscoreItems && isHiddenPath(key, false, true)) ||
+    key === DEFAULT_FILE_NAME_FOR_METADATAONREMOTE ||
+    key === DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2
+  );
+};
+
 const ensembleMixedStates = async (
   remoteStates: FileOrFolderMixedState[],
   local: TAbstractFile[],
+  localConfigDirContents: ObsConfigDirFileType[] | undefined,
   remoteDeleteHistory: DeletionOnRemote[],
-  localDeleteHistory: FileFolderHistoryRecord[]
+  localFileHistory: FileFolderHistoryRecord[],
+  syncConfigDir: boolean,
+  configDir: string,
+  syncUnderscoreItems: boolean
 ) => {
   const results = {} as Record<string, FileOrFolderMixedState>;
 
   for (const r of remoteStates) {
     const key = r.key;
 
-    if (isHiddenPath(key)) {
+    if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
       continue;
     }
     results[key] = r;
@@ -301,7 +323,7 @@ const ensembleMixedStates = async (
       r = {
         key: entry.path,
         existLocal: true,
-        mtimeLocal: Math.max(entry.stat.mtime, entry.stat.ctime),
+        mtimeLocal: Math.max(entry.stat.mtime || 0, entry.stat.ctime || 0),
         sizeLocal: entry.stat.size,
       };
     } else if (entry instanceof TFolder) {
@@ -316,9 +338,10 @@ const ensembleMixedStates = async (
       throw Error(`unexpected ${entry}`);
     }
 
-    if (isHiddenPath(key)) {
+    if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
       continue;
     }
+
     if (results.hasOwnProperty(key)) {
       results[key].key = r.key;
       results[key].existLocal = r.existLocal;
@@ -330,6 +353,28 @@ const ensembleMixedStates = async (
     }
   }
 
+  if (syncConfigDir && localConfigDirContents !== undefined) {
+    for (const entry of localConfigDirContents) {
+      const key = entry.key;
+      const r: FileOrFolderMixedState = {
+        key: key,
+        existLocal: true,
+        mtimeLocal: Math.max(entry.mtime, entry.ctime),
+        sizeLocal: entry.size,
+      };
+
+      if (results.hasOwnProperty(key)) {
+        results[key].key = r.key;
+        results[key].existLocal = r.existLocal;
+        results[key].mtimeLocal = r.mtimeLocal;
+        results[key].sizeLocal = r.sizeLocal;
+      } else {
+        results[key] = r;
+        results[key].existRemote = false;
+      }
+    }
+  }
+
   for (const entry of remoteDeleteHistory) {
     const key = entry.key;
     const r = {
@@ -337,6 +382,10 @@ const ensembleMixedStates = async (
       deltimeRemote: entry.actionWhen,
     } as FileOrFolderMixedState;
 
+    if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
+      continue;
+    }
+
     if (results.hasOwnProperty(key)) {
       results[key].key = r.key;
       results[key].deltimeRemote = r.deltimeRemote;
@@ -348,7 +397,7 @@ const ensembleMixedStates = async (
     }
   }
 
-  for (const entry of localDeleteHistory) {
+  for (const entry of localFileHistory) {
     let key = entry.key;
     if (entry.keyType === "folder") {
       if (!entry.key.endsWith("/")) {
@@ -360,22 +409,45 @@ const ensembleMixedStates = async (
       throw Error(`unexpected ${entry}`);
     }
 
+    if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
+      continue;
+    }
+
+    if (entry.actionType === "delete" || entry.actionType === "rename") {
       const r = {
         key: key,
         deltimeLocal: entry.actionWhen,
       } as FileOrFolderMixedState;
 
-    if (isHiddenPath(key)) {
-      continue;
-    }
       if (results.hasOwnProperty(key)) {
-      results[key].key = r.key;
         results[key].deltimeLocal = r.deltimeLocal;
       } else {
         results[key] = r;
-
+        results[key].existLocal = false; // we have already checked local
-      results[key].existLocal = false;
+        results[key].existRemote = false; // we have already checked remote
-      results[key].existRemote = false;
+      }
+    } else if (entry.actionType === "renameDestination") {
+      const r = {
+        key: key,
+        mtimeLocal: entry.actionWhen,
+        changeLocalMtimeUsingMapping: true,
+      };
+      if (results.hasOwnProperty(key)) {
+        results[key].mtimeLocal = Math.max(
+          r.mtimeLocal || 0,
+          results[key].mtimeLocal || 0
+        );
+        results[key].changeLocalMtimeUsingMapping =
+          r.changeLocalMtimeUsingMapping;
+      } else {
+        results[key] = r;
+        results[key].existLocal = false; // we have already checked local
+        results[key].existRemote = false; // we have already checked remote
+      }
+    } else {
+      throw Error(
+        `do not know how to deal with local file history ${entry.key} with ${entry.actionType}`
+      );
     }
   }
 
@@ -400,34 +472,42 @@ const assignOperationToFileInplace = (
   // 0. find anything inconsistent
   if (r.existLocal && (r.mtimeLocal === undefined || r.mtimeLocal <= 0)) {
     throw Error(
-      `Error: File ${r.key} has a last modified time <=0 or undefined in the local file system. It's abnormal and the plugin stops.`
+      `Error: Abnormal last modified time locally: ${JSON.stringify(
+        r,
+        null,
+        2
+      )}`
     );
   }
   if (r.existRemote && (r.mtimeRemote === undefined || r.mtimeRemote <= 0)) {
     throw Error(
-      `Error: File ${r.key} has a last modified time <=0 or undefined on the remote service. It's abnormal and the plugin stops.`
+      `Error: Abnormal last modified time remotely: ${JSON.stringify(
+        r,
+        null,
+        2
+      )}`
     );
   }
   if (r.deltimeLocal !== undefined && r.deltimeLocal <= 0) {
     throw Error(
-      `Error: File ${r.key} has a local deletion time <=0. It's abnormal and the plugin stops.`
+      `Error: Abnormal deletion time locally: ${JSON.stringify(r, null, 2)}`
     );
   }
   if (r.deltimeRemote !== undefined && r.deltimeRemote <= 0) {
     throw Error(
-      `Error: File ${r.key} has a remote deletion time <=0. It's abnormal and the plugin stops.`
+      `Error: Abnormal deletion time remotely: ${JSON.stringify(r, null, 2)}`
     );
   }
 
   // 1. mtimeLocal
   if (r.existLocal) {
     const mtimeRemote = r.existRemote ? r.mtimeRemote : -1;
-    const deltime_remote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
+    const deltimeRemote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
     const deltimeLocal = r.deltimeLocal !== undefined ? r.deltimeLocal : -1;
     if (
       r.mtimeLocal >= mtimeRemote &&
       r.mtimeLocal >= deltimeLocal &&
-      r.mtimeLocal >= deltime_remote
+      r.mtimeLocal >= deltimeRemote
     ) {
       if (r.mtimeLocal === r.mtimeRemote) {
         // mtime the same
@@ -458,12 +538,12 @@ const assignOperationToFileInplace = (
   // 2. mtimeRemote
   if (r.existRemote) {
     const mtimeLocal = r.existLocal ? r.mtimeLocal : -1;
-    const deltime_remote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
+    const deltimeRemote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
     const deltimeLocal = r.deltimeLocal !== undefined ? r.deltimeLocal : -1;
     if (
       r.mtimeRemote > mtimeLocal &&
       r.mtimeRemote >= deltimeLocal &&
-      r.mtimeRemote >= deltime_remote
+      r.mtimeRemote >= deltimeRemote
     ) {
       r.decision = "downloadRemoteToLocal";
       r.decisionBranch = 5;
@@ -476,11 +556,11 @@ const assignOperationToFileInplace = (
   if (r.deltimeLocal !== undefined && r.deltimeLocal !== 0) {
     const mtimeLocal = r.existLocal ? r.mtimeLocal : -1;
     const mtimeRemote = r.existRemote ? r.mtimeRemote : -1;
-    const deltime_remote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
+    const deltimeRemote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
     if (
       r.deltimeLocal >= mtimeLocal &&
       r.deltimeLocal >= mtimeRemote &&
-      r.deltimeLocal >= deltime_remote
+      r.deltimeLocal >= deltimeRemote
     ) {
       r.decision = "uploadLocalDelHistToRemote";
       r.decisionBranch = 6;
@@ -491,7 +571,7 @@ const assignOperationToFileInplace = (
     }
   }
 
-  // 4. deltime_remote
+  // 4. deltimeRemote
   if (r.deltimeRemote !== undefined && r.deltimeRemote !== 0) {
     const mtimeLocal = r.existLocal ? r.mtimeLocal : -1;
     const mtimeRemote = r.existRemote ? r.mtimeRemote : -1;
@@ -540,14 +620,9 @@ const assignOperationToFolderInplace = async (
       // if it was created after deletion, we should keep it as is
       if (requireApiVersion(API_VER_STAT_FOLDER)) {
         if (r.existLocal) {
-          try {
           const { ctime, mtime } = await vault.adapter.stat(r.key);
           const cmtime = Math.max(ctime, mtime);
-            if (
+          if (cmtime > 0 && cmtime >= deltimeLocal && cmtime >= deltimeRemote) {
-              cmtime > 0 &&
-              cmtime >= deltimeLocal &&
-              cmtime >= deltimeRemote
-            ) {
             keptFolder.add(getParentFolder(r.key));
             if (r.existLocal && r.existRemote) {
               r.decision = "skipFolder";
@@ -561,12 +636,36 @@ const assignOperationToFolderInplace = async (
               );
             }
           }
-          } catch (error) {
-            // pass
-          }
         }
       }
 
+      // If it was moved to here, after deletion, we should keep it as is.
+      // The logic not necessarily needs API_VER_STAT_FOLDER.
+      // The folder needs this logic because it's also determined by file children.
+      // But the file do not need this logic because the mtimeLocal is checked firstly.
+      if (
+        r.existLocal &&
+        r.changeLocalMtimeUsingMapping &&
+        r.mtimeLocal > 0 &&
+        r.mtimeLocal > deltimeLocal &&
+        r.mtimeLocal > deltimeRemote
+      ) {
+        keptFolder.add(getParentFolder(r.key));
+        if (r.existLocal && r.existRemote) {
+          r.decision = "skipFolder";
+          r.decisionBranch = 16;
+        } else if (r.existLocal || r.existRemote) {
+          r.decision = "createFolder";
+          r.decisionBranch = 17;
+        } else {
+          throw Error(
+            `Error: Folder ${r.key} doesn't exist locally and remotely but is marked must be kept. Abort.`
+          );
+        }
+      }
+
+      if (r.decision === undefined) {
+        // not yet decided by the above reason
         if (deltimeLocal > 0 && deltimeLocal > deltimeRemote) {
           r.decision = "uploadLocalDelHistToRemoteFolder";
           r.decisionBranch = 8;
@@ -574,6 +673,7 @@ const assignOperationToFolderInplace = async (
           r.decision = "keepRemoteDelHistFolder";
           r.decisionBranch = 9;
         }
+      }
     } else {
       // it does not have any deletion commands
       // keep it as is, and create it if necessary
@@ -623,17 +723,25 @@ const DELETION_DECISIONS: Set<DecisionType> = new Set([
 export const getSyncPlan = async (
   remoteStates: FileOrFolderMixedState[],
   local: TAbstractFile[],
+  localConfigDirContents: ObsConfigDirFileType[] | undefined,
   remoteDeleteHistory: DeletionOnRemote[],
-  localDeleteHistory: FileFolderHistoryRecord[],
+  localFileHistory: FileFolderHistoryRecord[],
   remoteType: SUPPORTED_SERVICES_TYPE,
   vault: Vault,
+  syncConfigDir: boolean,
+  configDir: string,
+  syncUnderscoreItems: boolean,
   password: string = ""
 ) => {
   const mixedStates = await ensembleMixedStates(
     remoteStates,
     local,
+    localConfigDirContents,
     remoteDeleteHistory,
-    localDeleteHistory
+    localFileHistory,
+    syncConfigDir,
+    configDir,
+    syncUnderscoreItems
   );
 
   const sortedKeys = Object.keys(mixedStates).sort(
@@ -880,6 +988,70 @@ const dispatchOperationToActual = async (
   }
 };
 
+const splitThreeSteps = (syncPlan: SyncPlanType, sortedKeys: string[]) => {
+  const mixedStates = syncPlan.mixedStates;
+  const totalCount = sortedKeys.length || 0;
+
+  const folderCreationOps: FileOrFolderMixedState[][] = [];
+  const deletionOps: FileOrFolderMixedState[][] = [];
+  const uploadDownloads: FileOrFolderMixedState[][] = [];
+  let realTotalCount = 0;
+
+  for (let i = 0; i < sortedKeys.length; ++i) {
+    const key = sortedKeys[i];
+    const val: FileOrFolderMixedState = Object.assign({}, mixedStates[key]); // copy to avoid issue
+
+    if (val.decision === "skipFolder" || val.decision === "skipUploading") {
+      // pass
+    } else if (val.decision === "createFolder") {
+      const level = atWhichLevel(key);
+      if (folderCreationOps[level - 1] === undefined) {
+        folderCreationOps[level - 1] = [val];
+      } else {
+        folderCreationOps[level - 1].push(val);
+      }
+      realTotalCount += 1;
+    } else if (
+      val.decision === "uploadLocalDelHistToRemoteFolder" ||
+      val.decision === "keepRemoteDelHistFolder" ||
+      val.decision === "uploadLocalDelHistToRemote" ||
+      val.decision === "keepRemoteDelHist"
+    ) {
+      const level = atWhichLevel(key);
+      if (deletionOps[level - 1] === undefined) {
+        deletionOps[level - 1] = [val];
+      } else {
+        deletionOps[level - 1].push(val);
+      }
+      realTotalCount += 1;
+    } else if (
+      val.decision === "uploadLocalToRemote" ||
+      val.decision === "downloadRemoteToLocal"
+    ) {
+      if (uploadDownloads.length === 0) {
+        uploadDownloads[0] = [val];
+      } else {
+        uploadDownloads[0].push(val); // only one level needed here
+      }
+      realTotalCount += 1;
+    } else {
+      throw Error(`unknown decision ${val.decision} for ${key}`);
+    }
+  }
+
+  // the deletionOps should be run from max level to min level
+  // right now it is sorted by level from min to max (NOT length of key!)
+  // so we need to reverse it!
+  deletionOps.reverse(); // inplace reverse
+
+  return {
+    folderCreationOps: folderCreationOps,
+    deletionOps: deletionOps,
+    uploadDownloads: uploadDownloads,
+    realTotalCount: realTotalCount,
+  };
+};
+
 export const doActualSync = async (
   client: RemoteClient,
   db: InternalDBs,
@@ -934,95 +1106,47 @@ export const doActualSync = async (
       );
       log.debug(`finished ${key}`);
     }
-  } else {
+
+    return; // shortcut return, avoid too many nests below
+  }
+
+  const { folderCreationOps, deletionOps, uploadDownloads, realTotalCount } =
+    splitThreeSteps(syncPlan, sortedKeys);
+  const nested = [folderCreationOps, deletionOps, uploadDownloads];
+  const logTexts = [
+    `1. create all folders from shadowest to deepest, also check undefined decision`,
+    `2. delete files and folders from deepest to shadowest`,
+    `3. upload or download files in parallel, with the desired concurrency=${concurrency}`,
+  ];
+
   let realCounter = 0;
 
-    log.debug(
+  for (let i = 0; i < nested.length; ++i) {
-      `1. create all folders from shadowest to deepest, also check undefined decision`
+    log.debug(logTexts[i]);
-    );
-    for (let i = sortedKeys.length - 1; i >= 0; --i) {
-      const key = sortedKeys[i];
-      const val = mixedStates[key];
 
-      if (
+    const operations: FileOrFolderMixedState[][] = nested[i];
-        val.decision === undefined ||
-        val.decision === "skipFolder" ||
-        val.decision === "createFolder"
-      ) {
-        log.debug(`start syncing "${key}" with plan ${JSON.stringify(val)}`);
 
-        if (callbackSyncProcess !== undefined) {
+    for (let j = 0; j < operations.length; ++j) {
-          await callbackSyncProcess(realCounter, totalCount, key, val.decision);
+      const singleLevelOps: FileOrFolderMixedState[] | undefined =
-        }
+        operations[j];
-        realCounter += 1;
 
-        await dispatchOperationToActual(
+      if (singleLevelOps === undefined || singleLevelOps === null) {
-          key,
+        continue;
-          vaultRandomID,
-          val,
-          client,
-          db,
-          vault,
-          localDeleteFunc,
-          password
-        );
-        log.debug(`finished ${key}`);
-      }
       }
 
-    log.debug(`2. delete files and folders from deepest to shadowest`);
-    for (let i = 0; i < sortedKeys.length; ++i) {
-      const key = sortedKeys[i];
-      const val = mixedStates[key];
-      if (
-        val.decision === "uploadLocalDelHistToRemoteFolder" ||
-        val.decision === "keepRemoteDelHistFolder" ||
-        val.decision === "uploadLocalDelHistToRemote" ||
-        val.decision === "keepRemoteDelHist"
-      ) {
-        log.debug(`start syncing "${key}" with plan ${JSON.stringify(val)}`);
-
-        if (callbackSyncProcess !== undefined) {
-          await callbackSyncProcess(realCounter, totalCount, key, val.decision);
-        }
-        realCounter += 1;
-
-        await dispatchOperationToActual(
-          key,
-          vaultRandomID,
-          val,
-          client,
-          db,
-          vault,
-          localDeleteFunc,
-          password
-        );
-        log.debug(`finished ${key}`);
-      }
-    }
-
-    log.debug(
-      `3. upload or download files in parallel, with the desired concurrency=${concurrency}`
-    );
       const queue = new PQueue({ concurrency: concurrency, autoStart: true });
 
-    // const commands: any[] = [];
+      for (let k = 0; k < singleLevelOps.length; ++k) {
+        const val: FileOrFolderMixedState = singleLevelOps[k];
+        const key = val.key;
 
-    for (let i = 0; i < sortedKeys.length; ++i) {
-      const key = sortedKeys[i];
-      const val = mixedStates[key];
-      if (
-        val.decision === "skipUploading" ||
-        val.decision === "uploadLocalToRemote" ||
-        val.decision === "downloadRemoteToLocal"
-      ) {
         const fn = async () => {
           log.debug(`start syncing "${key}" with plan ${JSON.stringify(val)}`);
 
           if (callbackSyncProcess !== undefined) {
             await callbackSyncProcess(
               realCounter,
-              totalCount,
+              realTotalCount,
               key,
               val.decision
             );
@@ -1045,8 +1169,8 @@ export const doActualSync = async (
         };
         queue.add(fn);
       }
-    }
 
       await queue.onIdle();
     }
+  }
 };

src/syncAlgoV2Notice.ts

@@ -1,5 +1,6 @@
 import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
 import type RemotelySavePlugin from "./main"; // unavoidable
+import type { TransItemType } from "./i18n";
 import * as origLog from "loglevel";
 const log = origLog.getLogger("rs-default");
 
@@ -13,40 +14,33 @@ export class SyncAlgoV2Modal extends Modal {
   }
   onOpen() {
     let { contentEl } = this;
+    const t = (x: TransItemType, vars?: any) => {
+      return this.plugin.i18n.t(x, vars);
+    };
+
     contentEl.createEl("h2", {
-      text: "Remotely Save has a better sync algorithm",
+      text: t("syncalgov2_title"),
     });
 
-    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");
-
+    t("syncalgov2_texts")
-    for (const t of texts) {
+      .split("\n")
+      .forEach((val) => {
         ul.createEl("li", {
-        text: t,
+          text: val,
+        });
       });
-    }
 
     new Setting(contentEl)
       .addButton((button) => {
-        button.setButtonText("Agree");
+        button.setButtonText(t("syncalgov2_button_agree"));
         button.onClick(async () => {
           this.agree = true;
           this.close();
         });
       })
       .addButton((button) => {
-        button.setButtonText("Do not agree");
+        button.setButtonText(t("syncalgov2_button_disagree"));
         button.onClick(() => {
           this.close();
         });

tests/encrypt.test.ts

@@ -8,6 +8,8 @@ import {
   encryptArrayBuffer,
   encryptStringToBase32,
   encryptStringToBase64url,
+  getSizeFromEncToOrig,
+  getSizeFromOrigToEnc,
 } from "../src/encrypt";
 import { base64ToBase64url, bufferToArrayBuffer } from "../src/misc";
 
@@ -110,4 +112,34 @@ describe("Encryption tests", () => {
 
     expect(Buffer.from(dec).equals(Buffer.from(opensslArrBuf))).to.be.true;
   });
+
+  it("should get size from origin to encrypted correctly", () => {
+    expect(() => getSizeFromOrigToEnc(-1)).to.throw();
+    expect(() => getSizeFromOrigToEnc(0.5)).to.throw();
+    expect(getSizeFromOrigToEnc(0)).equals(32);
+    expect(getSizeFromOrigToEnc(15)).equals(32);
+    expect(getSizeFromOrigToEnc(16)).equals(48);
+    expect(getSizeFromOrigToEnc(31)).equals(48);
+    expect(getSizeFromOrigToEnc(32)).equals(64);
+    expect(getSizeFromOrigToEnc(14787203)).equals(14787232);
+  });
+
+  it("should get size from encrypted to origin correctly", () => {
+    expect(() => getSizeFromEncToOrig(-1)).to.throw();
+    expect(() => getSizeFromEncToOrig(30)).to.throw();
+
+    expect(getSizeFromEncToOrig(32)).to.deep.equal({
+      minSize: 0,
+      maxSize: 15,
+    });
+    expect(getSizeFromEncToOrig(48)).to.deep.equal({
+      minSize: 16,
+      maxSize: 31,
+    });
+
+    expect(() => getSizeFromEncToOrig(14787231)).to.throw();
+
+    let { minSize, maxSize } = getSizeFromEncToOrig(14787232);
+    expect(minSize <= 14787203 && 14787203 <= maxSize).to.be.true;
+  });
 });

tests/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;
   });
 });
 
@@ -233,3 +244,25 @@ describe("Misc: get split ranges", () => {
     expect(k).to.deep.equal(k2);
   });
 });
+
+describe("Misc: at which level", () => {
+  it("should throw error on some parameters", () => {
+    expect(() => misc.atWhichLevel(undefined)).to.throw();
+    expect(() => misc.atWhichLevel("")).to.throw();
+    expect(() => misc.atWhichLevel("..")).to.throw();
+    expect(() => misc.atWhichLevel(".")).to.throw();
+    expect(() => misc.atWhichLevel("/")).to.throw();
+    expect(() => misc.atWhichLevel("/xxyy")).to.throw();
+  });
+
+  it("should treat folders correctly", () => {
+    expect(misc.atWhichLevel("x/")).to.be.equal(1);
+    expect(misc.atWhichLevel("x/y/")).to.be.equal(2);
+  });
+
+  it("should treat files correctly", () => {
+    expect(misc.atWhichLevel("x.md")).to.be.equal(1);
+    expect(misc.atWhichLevel("x/y.md")).to.be.equal(2);
+    expect(misc.atWhichLevel("x/y/z.md")).to.be.equal(3);
+  });
+});

tsconfig.json

@@ -9,6 +9,7 @@
     "noImplicitAny": true,
     "moduleResolution": "node",
     // "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
     "esModuleInterop": true,
     "importHelpers": true,
     "isolatedModules": true,

versions.json

@@ -1,4 +1,4 @@
 {
   "0.3.2": "0.12.15",
-  "0.3.5": "0.13.21"
+  "0.3.14": "0.13.21"
 }