bump to 0.3.21

Seafile is indeed connectable

.editorconfig

@@ -23,6 +23,6 @@ indent_size = 4
 indent_style = tab
 
 # Indentation override for all JS under lib directory
-[*.{js,jsx,mjs,cjs,ts,tsx,json,py}]
+[*.{js,jsx,mjs,cjs,ts,tsx,json}]
 indent_style = space
 indent_size = 2

.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/release.yml

@@ -0,0 +1,86 @@
+# modified from https://github.com/argenos/nldates-obsidian/blob/master/.github/workflows/release.yml
+# which is released under MIT License
+
+# trigger:
+# modify manifest.json, package.json, versions.json
+# git tag <version number>
+# git push origin --tags
+
+name: Release A New Version
+
+on:
+  push:
+    tags:
+      - "*" # Push events to matching any tag format, i.e. 1.0, 20.15.10
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    environment: env-for-buildci
+
+    env:
+      DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
+      ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
+      ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - name: Checkout codes
+        uses: actions/checkout@v2
+        with:
+          lfs: true
+          submodules: recursive
+      - name: Checkout LFS
+        run: git lfs checkout
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test
+      - run: npm run build
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION: ${{ github.ref }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          draft: false
+          prerelease: true
+      - name: Upload main.js
+        id: upload-main
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./main.js
+          asset_name: main.js
+          asset_content_type: text/javascript
+      - name: Upload manifest.json
+        id: upload-manifest
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./manifest.json
+          asset_name: manifest.json
+          asset_content_type: application/json
+      - name: Upload styles.css
+        id: upload-styles
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./styles.css
+          asset_name: styles.css
+          asset_content_type: text/css

README.md

@@ -4,9 +4,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 
 [![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml)
 
-[![total downloads auto count](https://remotely-save.github.io/auto-download-stats/totalDownloads.svg)](https://github.com/fyears/remotely-save/releases)
+[![downloads of latest version](https://img.shields.io/github/downloads-pre/remotely-save/remotely-save/latest/main.js?sort=semver)](https://github.com/fyears/remotely-save/releases)
-
-[![downloads of latest version](https://remotely-save.github.io/auto-download-stats/latestVersionDownloads.svg)](https://github.com/fyears/remotely-save/releases)
 
 ## Disclaimer
 
@@ -37,6 +35,9 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 - **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
 - **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
 - **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
+- **You should protect your `data.json` file.** The file contains sensitive information.
+  - It's strongly advised **NOT** to share your `data.json` file to anyone.
+  - It's usually **NOT** a good idea to check the file into version control. By default, the plugin tries to create a `.gitignore` file inside the plugin directory if it doesn't exist, for ignoring `data.json` in the `git` version control. If you know exactly what it means and want to remove the setting, please modify the `.gitignore` file or set it to be empty.
 
 ## Questions, Suggestions, Or Bugs
 
@@ -61,8 +62,8 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 - Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
 - About CORS:
-  - If you are using Obsidian >= 0.13.25, you can skip this CORS part.
+  - 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 < 0.13.25, you need to configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, and add at least `ETag` into exposed headers. Full example is [here](./docs/s3_cors_configure.md). It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
+  - If you are using 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.
@@ -87,10 +88,12 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 ### webdav
 
 - About CORS:
-  - If you are using Obsidian >= 0.13.25, you can skip this CORS part.
+  - If you are using Obsidian desktop >= 0.13.25 or iOS >= 1.1.1, you can skip this CORS part.
-  - If you are using Obsidian < 0.13.25:
+  - If you are using Obsidian desktop < 0.13.25 or iOS < 1.1.1 or any Android version:
     - The webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies unless under a upgraded Obsidian version.
     - Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin, or use a upgraded Obsidian version.
+      - **Unofficial** workaround: NextCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can install [WebAppPassword](https://apps.nextcloud.com/apps/webapppassword) app, and add `app://obsidian.md`, `capacitor://localhost`, `http://localhost` to `Allowed origins`
+      - **Unofficial** workaround: OwnCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can download `.tar.gz` of `WebAppPassword` above and manually install and configure it on their instances.
     - The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
 - Your data would be synced to a `${vaultName}` sub folder on your webdav server.
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.

docs/apache_cors_configure.md

@@ -0,0 +1,25 @@
+# How To Configure Apache CORS Rules for Webdav
+
+This method is [contributed by community](https://github.com/remotely-save/remotely-save/pull/31).
+
+You should evaluate the risk by yourself before trying this method.
+
+**You are strongly advised to backup your original Apache configuration files before making any changes.**
+
+```apacheconf
+<IfModule mod_headers.c>
+  # Obsidian webdav
+  SetEnvIf Origin "^app://obsidian.md$" IS_OBSIDIAN
+  SetEnvIf Origin "^capacitor://localhost$" IS_OBSIDIAN
+  SetEnvIf Origin "^http://localhost$" IS_OBSIDIAN
+  Header always set Access-Control-Allow-Origin "*" env=IS_OBSIDIAN
+  Header always set Access-Control-Allow-Methods "GET, HEAD, POST, PUT, OPTIONS, MOVE, DELETE, COPY, LOCK, UNLOCK, PROPFIND" env=IS_OBSIDIAN
+  Header always set Access-Control-Allow-Headers "Authorization, Depth, DNT, User-Agent, Keep-Alive, Content-Type, accept, origin, X-Requested-With" env=IS_OBSIDIAN
+  Header always set Access-Control-Expose-Headers "etag, dav" env=IS_OBSIDIAN
+
+  # Allow OPTION request without authentication and respond with status 200
+  RewriteCond %{ENV:IS_OBSIDIAN} 1
+  RewriteCond %{REQUEST_METHOD} OPTIONS
+  RewriteRule ^(.*)$ $1 [R=200,L]
+</IfModule>
+```

docs/browser_env.md

@@ -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 issue (solved in the new Obsidian version).](./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,6 +4,11 @@ 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)
 
-From Obsidian version >= insider 0.13.25, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
+1. From Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
 
-For using this plugin in Obsidian version < 0.13.25, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. Here is an example [configuration for Amazon S3](./s3_cors_configure.md).
+2. For using this plugin in Obsidian desktop < 0.13.25 or mobile < 1.1.1, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`.
+
+   Example configurations:
+
+   - [Amazon S3](./s3_cors_configure.md)
+   - [Apache](./apache_cors_configure.md) ([contributed by community](https://github.com/remotely-save/remotely-save/pull/31))

docs/how_to_debug/README.md

@@ -6,6 +6,14 @@ Ideally, users do not need to debug anything. But if something bad happened, we
 
 See [here](./export_sync_plans.md).
 
-## Advanced: Check Console Output
+## Advanced: Check Console Output Directly
+
+...of desktop and Android.
 
 See [here](./check_console_output.md).
+
+## Advanced: Save Console Output Then Read Them Later
+
+This method works for desktop and mobile devices (iOS, Android).
+
+See [here](./save_console_output_and_export.md).

docs/how_to_debug/check_console_output.md

@@ -1,6 +1,6 @@
 # Check Console Output
 
-If you are using Obsidian on desktop, you can check the Obsidian console.
+If you are using Obsidian on desktop or Android, you can check the Obsidian console.
 
 ## Disable Auto Sync Firstly
 
@@ -12,6 +12,12 @@ Go to the plugin settings, scroll down to the section "Debug" -> "alter console
 
 ## Check The Output
 
-Then, press the keyboard shortcut "ctrl+shift+i" if you are on Windows or Linux, or press "cmd+shift+i" if you are on macOS. You should be able to see the console of Obsidian.
+- If you are on desktop
+
+  Press the keyboard shortcut "ctrl+shift+i" if you are on Windows or Linux, or press "cmd+shift+i" if you are on macOS. You should be able to see the console of Obsidian.
+
+- If you are using Android
+
+  You need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on your Android, then connect your Android to a computer using USB, then open the **desktop** Chrome browser and go to the special web page <chrome://inspect>. You shall be able to see the "inspect" link inside the special page, then click the link to open the console. After debugging, remember to turn off USB debugging.
 
 Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. You could understand what happened and what goes wrong more explictly by checking the output.

docs/how_to_debug/save_console_output_and_export.md

@@ -0,0 +1,25 @@
+# Save Console Output And Read Them Later
+
+## Disable Auto Sync Firstly
+
+You should disable auto sync to avoid any unexpected running.
+
+## Set The Output Level To Debug
+
+Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
+
+## Enable Saving The Output To DB
+
+Go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "disable" to "enable". **This setting has some performance cost, so do NOT always turn this on when not necessary!**
+
+## Run The Sync
+
+Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. The the console logs are also saved into DB now.
+
+## Export The Output And Read The Logs
+
+Go to the plugin settings, scroll down to the section "Debug" -> "Export Console Logs From DB", and click the button. A new file `log_hist_exported_on_....md` should be created inside the special folder `_debug_remotely_save/`. You could read it and hopefully find something useful.
+
+## Disable Saving The Output To DB
+
+After debugging, go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "enable" to "disable".

docs/s3_cors_configure.md

@@ -1,6 +1,6 @@
 # How To Configure S3 CORS Rules
 
-If you are using the latest version of this plugin AND Obsidian >= 0.13.25, you do not need to configure it any more. If you are using Obsidian < 0.13.25, you are required to configure the rules as following.
+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).
 

docs/services_connectable_or_not.md

@@ -2,41 +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 version >= 0.13.25 to bypass the CORS issue. But if the users are still using an older version of Obsidian, they need to configure CORS on server.
+The plugin works under the browser environment in Obsidian, so CORS is an issue. Obsidian starts to provide a rich API `requestUrl` for desktop version >= 0.13.25, mobile >= 1.1.1 to bypass the CORS issue. But if the users are still using an older version of Obsidian, they need to configure CORS on server.
 
 The list is for information purposes only.
 
-| Service                                                                               | Connectable | by S3 | by WebDAV | by other protocol                                                | can bypass CORS issue in Obsidian>=0.13.25 | need CORS config in Obsidian<0.13.25             |
+| Service                                                                               | Connectable | by S3 | by WebDAV | by other protocol                                                | can bypass CORS issue in latest Obsidian | need CORS config in old Obsidian                 |
-| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------ |
+| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------ |
-| Amazon S3                                                                             | Yes         | Yes   |           |                                                                  | Yes                                        | [CORS config needed.](./s3_cors_configure.md)    |
+| Amazon S3                                                                             | Yes         | Yes   |           |                                                                  | Yes                                      | [CORS config needed.](./s3_cors_configure.md)    |
-| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储                             | Yes         | Yes   |           |                                                                  | Yes                                        | CORS config needed.                              |
+| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储                             | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |
-| Alibaba Cloud - Object Storage Service 阿里云对象存储                                 | Yes         | Yes   |           |                                                                  | Yes                                        | CORS config needed.                              |
+| Alibaba Cloud - Object Storage Service 阿里云对象存储                                 | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |
-| Backblaze B2 Cloud Storage                                                            | Yes         | Yes   |           |                                                                  | Yes                                        | Its CORS rules doesn't allow no-http(s) origins. |
+| 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   |           |                                                                  | 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       |                                                                  | 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) | Yes?        |       | Yes?      |                                                                  | Yes?                                       | ?                                                |
+| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes?        |       | Yes?      |                                                                  | Yes?                                     | ?                                                |
-| NextCloud                                                                             | Yes?        |       | Yes?      |                                                                  | Yes?                                       | No CORS config by default.                       |
+| NextCloud                                                                             | Yes?        |       | Yes?      |                                                                  | Yes?                                     | No CORS config by default.                       |
-| OwnCloud                                                                              | Yes?        |       | Yes?      |                                                                  | Yes?                                       | No CORS config by default.                       |
+| OwnCloud                                                                              | Yes?        |       | Yes?      |                                                                  | Yes?                                     | No CORS config by default.                       |
-| Seafile                                                                               | Yes?        |       | Yes?      |                                                                  | Yes?                                       |                                                  |
+| Seafile                                                                               | Yes         |       | Yes       |                                                                  | Yes?                                     | No CORS config by default.                       |
-| `rclone serve webdav`                                                                 | Yes         |       | Yes       |                                                                  | Yes                                        | No CORS support.                                 |
+| `rclone serve webdav`                                                                 | Yes         |       | Yes       |                                                                  | Yes                                      | No CORS support.                                 |
-| [Nutstore 坚果云](https://www.jianguoyun.com/)                                        | Yes         |       | Yes       |                                                                  | Yes                                        | No CORS support.                                 |
+| [Nutstore 坚果云](https://www.jianguoyun.com/)                                        | Yes         |       | Yes       |                                                                  | Yes                                      | No CORS support.                                 |
-| [TeraCLOUD](https://teracloud.jp/en/)                                                 | Yes         |       | Yes       |                                                                  | Yes                                        | No CORS support.                                 |
+| [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       |       |           | Technically never possible to be implemented.                    |                                            |                                                  |
+| FTP / FTPS                                                                            | Never       |       |           | Technically never possible to be implemented.                    |                                          |                                                  |
-| SFTP                                                                                  | Never       |       |           | Technically never possible to be implemented.                    |                                            |                                                  |
+| SFTP                                                                                  | Never       |       |           | Technically never possible to be implemented.                    |                                          |                                                  |
-| Jottacloud                                                                            | No          |       |           | No. It seems that no open api is available.                      |                                            |                                                  |
+| 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. |                                          |                                                  |
-|                                                                                       |             |       |           |                                                                  |                                            |                                                  |
+|                                                                                       |             |       |           |                                                                  |                                          |                                                  |

esbuild.config.mjs

@@ -31,11 +31,11 @@ esbuild
       "obsidian",
       "electron",
       "fs",
-      "crypto",
       "tls",
       "net",
       // ...builtins
     ],
+    inject: ["./esbuild.injecthelper.mjs"],
     format: "cjs",
     watch: !prod,
     target: "es2016",
@@ -48,6 +48,9 @@ esbuild
       "process.env.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`,
       "process.env.DEFAULT_ONEDRIVE_CLIENT_ID": `"${DEFAULT_ONEDRIVE_CLIENT_ID}"`,
       "process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`,
+      global: "window",
+      "process.env.NODE_DEBUG": `undefined`, // ugly fix
+      "process.env.DEBUG": `undefined`, // ugly fix
     },
   })
   .catch(() => process.exit(1));

esbuild.injecthelper.mjs

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

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "remotely-save",
   "name": "Remotely Save",
-  "version": "0.3.8",
+  "version": "0.3.21",
   "minAppVersion": "0.13.21",
   "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
   "author": "fyears",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "remotely-save",
-  "version": "0.3.8",
+  "version": "0.3.21",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
     "dev2": "node esbuild.config.mjs",
@@ -23,72 +23,73 @@
   "author": "",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@microsoft/microsoft-graph-types": "^2.11.0",
+    "@microsoft/microsoft-graph-types": "^2.19.0",
-    "@types/chai": "^4.2.22",
+    "@types/chai": "^4.3.1",
-    "@types/chai-as-promised": "^7.1.4",
+    "@types/chai-as-promised": "^7.1.5",
-    "@types/feather-icons": "^4.7.0",
+    "@types/jsdom": "^16.2.14",
-    "@types/jsdom": "^16.2.13",
+    "@types/lodash": "^4.14.182",
-    "@types/lodash": "^4.14.178",
     "@types/mime-types": "^2.1.1",
-    "@types/mocha": "^9.0.0",
+    "@types/mocha": "^9.1.1",
     "@types/mustache": "^4.1.2",
-    "@types/node": "^14.14.37",
+    "@types/node": "^17.0.30",
-    "@types/qrcode": "^1.4.1",
+    "@types/qrcode": "^1.4.2",
     "builtin-modules": "^3.2.0",
-    "chai": "^4.3.4",
+    "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "cross-env": "^7.0.3",
-    "dotenv": "^10.0.0",
+    "dotenv": "^16.0.0",
-    "esbuild": "^0.14.3",
+    "esbuild": "^0.14.38",
     "jsdom": "^19.0.0",
-    "mocha": "^9.1.3",
+    "mocha": "^9.2.2",
-    "prettier": "^2.4.1",
+    "prettier": "^2.6.2",
-    "ts-loader": "^9.2.6",
+    "ts-loader": "^9.2.9",
-    "ts-node": "^10.4.0",
+    "ts-node": "^10.7.0",
-    "tslib": "^2.2.0",
+    "tslib": "^2.4.0",
-    "typescript": "^4.4.4",
+    "typescript": "^4.6.4",
     "webdav-server": "^2.6.2",
-    "webpack": "^5.64.4",
+    "webpack": "^5.72.0",
-    "webpack-cli": "^4.9.1"
+    "webpack-cli": "^4.9.2"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.54.0",
+    "@aws-sdk/client-s3": "^3.81.0",
-    "@aws-sdk/fetch-http-handler": "^3.54.0",
+    "@aws-sdk/fetch-http-handler": "^3.78.0",
-    "@aws-sdk/lib-storage": "^3.54.0",
+    "@aws-sdk/lib-storage": "^3.81.0",
-    "@aws-sdk/protocol-http": "^3.54.0",
+    "@aws-sdk/protocol-http": "^3.78.0",
-    "@aws-sdk/querystring-builder": "^3.54.0",
+    "@aws-sdk/querystring-builder": "^3.78.0",
-    "@aws-sdk/signature-v4-crt": "^3.54.0",
+    "@aws-sdk/signature-v4-crt": "^3.78.0",
-    "@aws-sdk/types": "^3.54.0",
+    "@aws-sdk/types": "^3.78.0",
-    "@azure/msal-node": "^1.6.0",
+    "@azure/msal-node": "^1.8.0",
     "@fyears/tsqueue": "^1.0.1",
-    "@microsoft/microsoft-graph-client": "^3.0.1",
+    "@microsoft/microsoft-graph-client": "^3.0.2",
-    "acorn": "^8.5.0",
+    "acorn": "^8.7.1",
+    "aggregate-error": "^4.0.0",
     "assert": "^2.0.0",
-    "aws-crt": "^1.10.1",
+    "aws-crt": "^1.12.1",
     "buffer": "^6.0.3",
-    "codemirror": "^5.63.1",
     "crypto-browserify": "^3.12.0",
-    "dropbox": "^10.22.0",
+    "delay": "^5.0.0",
-    "feather-icons": "^4.28.0",
+    "dropbox": "^10.28.0",
+    "emoji-regex": "^10.1.0",
     "http-status-codes": "^2.2.0",
     "localforage": "^1.10.0",
     "lodash": "^4.17.21",
     "loglevel": "^1.8.0",
-    "mime-types": "^2.1.33",
+    "lucide": "^0.35.0",
+    "mime-types": "^2.1.35",
     "mustache": "^4.2.0",
-    "nanoid": "^3.1.30",
+    "nanoid": "^3.3.3",
-    "obsidian": "^0.13.26",
+    "obsidian": "^0.14.6",
     "p-queue": "^7.2.0",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
     "qrcode": "^1.5.0",
-    "rfc4648": "^1.5.0",
+    "rfc4648": "^1.5.1",
     "rimraf": "^3.0.2",
     "stream-browserify": "^3.0.0",
     "url": "^0.11.0",
     "util": "^0.12.4",
-    "webdav": "^4.7.0",
+    "webdav": "^4.9.0",
-    "webdav-fs": "^4.0.0",
+    "webdav-fs": "^4.0.1",
     "xregexp": "^5.1.0"
   }
 }

src/baseTypes.ts

@@ -3,10 +3,18 @@
  * To avoid circular dependency.
  */
 
+import { Platform, requireApiVersion } from "obsidian";
 import type { LangType, LangTypeAndAuto } from "./i18n";
 
+export const DEFAULT_CONTENT_TYPE = "application/octet-stream";
+
 export type SUPPORTED_SERVICES_TYPE = "s3" | "webdav" | "dropbox" | "onedrive";
 
+export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR =
+  | "webdav"
+  | "dropbox"
+  | "onedrive";
+
 export interface S3Config {
   s3Endpoint: string;
   s3Region: string;
@@ -15,6 +23,7 @@ export interface S3Config {
   s3BucketName: string;
   bypassCorsLocally?: boolean;
   partsConcurrency?: number;
+  forcePathStyle?: boolean;
 }
 
 export interface DropboxConfig {
@@ -26,6 +35,7 @@ export interface DropboxConfig {
   accountID: string;
   username: string;
   credentialsShouldBeDeletedAtTime?: number;
+  remoteBaseDir?: string;
 }
 
 export type WebdavAuthType = "digest" | "basic";
@@ -43,6 +53,7 @@ export interface WebdavConfig {
   authType: WebdavAuthType;
   manualRecursive: boolean; // deprecated in 0.3.6, use depth
   depth?: WebdavDepthType;
+  remoteBaseDir?: string;
 }
 
 export interface OnedriveConfig {
@@ -55,6 +66,7 @@ export interface OnedriveConfig {
   deltaLink: string;
   username: string;
   credentialsShouldBeDeletedAtTime?: number;
+  remoteBaseDir?: string;
 }
 
 export interface RemotelySavePluginSettings {
@@ -65,7 +77,6 @@ export interface RemotelySavePluginSettings {
   password: string;
   serviceType: SUPPORTED_SERVICES_TYPE;
   currLogLevel?: string;
-  vaultRandomID?: string;
   autoRunEveryMilliseconds?: number;
   initRunAfterMilliseconds?: number;
   agreeToUploadExtraMetadata?: boolean;
@@ -73,6 +84,12 @@ export interface RemotelySavePluginSettings {
   syncConfigDir?: boolean;
   syncUnderscoreItems?: boolean;
   lang?: LangTypeAndAuto;
+  logToDB?: boolean;
+
+  /**
+   * @deprecated
+   */
+  vaultRandomID?: string;
 }
 
 export interface RemoteItem {
@@ -123,12 +140,30 @@ export interface FileOrFolderMixedState {
   deltimeRemote?: number;
   sizeLocal?: number;
   sizeRemote?: number;
-  changeMtimeUsingMapping?: boolean;
+  changeRemoteMtimeUsingMapping?: boolean;
+  changeLocalMtimeUsingMapping?: boolean;
   decision?: DecisionType;
   decisionBranch?: number;
   syncDone?: "done";
   remoteEncryptedKey?: string;
+
+  mtimeLocalFmt?: string;
+  mtimeRemoteFmt?: string;
+  deltimeLocalFmt?: string;
+  deltimeRemoteFmt?: string;
 }
 
 export const API_VER_STAT_FOLDER = "0.13.27";
-export const API_VER_REQURL = "0.13.26";
+export const API_VER_REQURL = "0.13.26"; // desktop ver 0.13.26, iOS ver 1.1.1
+export const API_VER_REQURL_ANDROID = "0.14.6"; // Android ver 1.2.1
+
+export const VALID_REQURL =
+  (!Platform.isAndroidApp && requireApiVersion(API_VER_REQURL)) ||
+  (Platform.isAndroidApp && requireApiVersion(API_VER_REQURL_ANDROID));
+
+export const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
+export const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX =
+  "sync_plans_hist_exported_on_";
+export const DEFAULT_LOG_HISTORY_FILE_PREFIX = "log_hist_exported_on_";
+
+export type SyncTriggerSourceType = "manual" | "auto" | "dry" | "autoOnceInit";

src/configPersist.ts

@@ -3,11 +3,10 @@ import { reverseString } from "./misc";
 
 import type { RemotelySavePluginSettings } from "./baseTypes";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-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;
@@ -20,8 +19,8 @@ interface MessyConfigType {
 export const messyConfigToNormal = (
   x: MessyConfigType | RemotelySavePluginSettings | null | undefined
 ): RemotelySavePluginSettings | null | undefined => {
-  log.debug("loading, original config on disk:");
+  // log.debug("loading, original config on disk:");
-  log.debug(x);
+  // log.debug(x);
   if (x === null || x === undefined) {
     log.debug("the messy config is null or undefined, skip");
     return x as any;
@@ -36,12 +35,12 @@ export const messyConfigToNormal = (
         }) as Buffer
       ).toString("utf-8")
     );
-    log.debug("loading, parsed config is:");
+    // log.debug("loading, parsed config is:");
-    log.debug(y);
+    // log.debug(y);
     return y;
   } else {
     // return as is
-    log.debug("loading, parsed config is the same");
+    // log.debug("loading, parsed config is the same");
     return x;
   }
 };
@@ -64,7 +63,7 @@ export const normalConfigToMessy = (
       })
     ),
   };
-  log.debug("encoding, encoded config is:");
+  // log.debug("encoding, encoded config is:");
-  log.debug(y);
+  // log.debug(y);
   return y;
 };

src/debugMode.ts

@@ -1,20 +1,83 @@
 import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
 
 import type { SyncPlanType } from "./sync";
-import { readAllSyncPlanRecordTextsByVault } from "./localdb";
+import {
+  readAllSyncPlanRecordTextsByVault,
+  readAllLogRecordTextsByVault,
+} from "./localdb";
 import type { InternalDBs } from "./localdb";
 import { mkdirpInVault } from "./misc";
+import {
+  DEFAULT_DEBUG_FOLDER,
+  DEFAULT_LOG_HISTORY_FILE_PREFIX,
+  DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX,
+  FileOrFolderMixedState,
+} from "./baseTypes";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
-const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
+const turnSyncPlanToTable = (record: string) => {
-const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX = "sync_plans_hist_exported_on_";
+  const syncPlan: SyncPlanType = JSON.parse(record);
+  const { ts, tsFmt, remoteType, mixedStates } = syncPlan;
+
+  type allowedHeadersType = keyof FileOrFolderMixedState;
+  const headers: allowedHeadersType[] = [
+    "key",
+    "remoteEncryptedKey",
+    "existLocal",
+    "sizeLocal",
+    "mtimeLocal",
+    "deltimeLocal",
+    "changeLocalMtimeUsingMapping",
+    "existRemote",
+    "sizeRemote",
+    "mtimeRemote",
+    "deltimeRemote",
+    "changeRemoteMtimeUsingMapping",
+    "decision",
+    "decisionBranch",
+  ];
+
+  const lines = [
+    `ts: ${ts}${tsFmt !== undefined ? " / " + tsFmt : ""}`,
+    `remoteType: ${remoteType}`,
+    `| ${headers.join(" | ")} |`,
+    `| ${headers.map((x) => "---").join(" | ")} |`,
+  ];
+  for (const [k1, v1] of Object.entries(syncPlan.mixedStates)) {
+    const k = k1 as string;
+    const v = v1 as FileOrFolderMixedState;
+    const singleLine = [];
+    for (const h of headers) {
+      const field = v[h];
+      if (field === undefined) {
+        singleLine.push("");
+        continue;
+      }
+      if (
+        h === "mtimeLocal" ||
+        h === "deltimeLocal" ||
+        h === "mtimeRemote" ||
+        h === "deltimeRemote"
+      ) {
+        const fmt = v[(h + "Fmt") as allowedHeadersType] as string;
+        const s = `${field}${fmt !== undefined ? " / " + fmt : ""}`;
+        singleLine.push(s);
+      } else {
+        singleLine.push(field);
+      }
+    }
+    lines.push(`| ${singleLine.join(" | ")} |`);
+  }
+
+  return lines.join("\n");
+};
 
 export const exportVaultSyncPlansToFiles = async (
   db: InternalDBs,
   vault: Vault,
-  vaultRandomID: string
+  vaultRandomID: string,
+  toFormat: "table" | "json" = "json"
 ) => {
   log.info("exporting");
   await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
@@ -23,9 +86,16 @@ export const exportVaultSyncPlansToFiles = async (
   if (records.length === 0) {
     md = "No sync plans history found";
   } else {
-    md =
+    if (toFormat === "json") {
-      "Sync plans found:\n\n" +
+      md =
-      records.map((x) => "```json\n" + x + "\n```\n").join("\n");
+        "Sync plans found:\n\n" +
+        records.map((x) => "```json\n" + x + "\n```\n").join("\n");
+    } else if (toFormat === "table") {
+      md =
+        "Sync plans found:\n\n" + records.map(turnSyncPlanToTable).join("\n\n");
+    } else {
+      const _: never = toFormat;
+    }
   }
   const ts = Date.now();
   const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX}${ts}.md`;
@@ -34,3 +104,27 @@ export const exportVaultSyncPlansToFiles = async (
   });
   log.info("finish exporting");
 };
+
+export const exportVaultLoggerOutputToFiles = async (
+  db: InternalDBs,
+  vault: Vault,
+  vaultRandomID: string
+) => {
+  await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
+  const records = await readAllLogRecordTextsByVault(db, vaultRandomID);
+  let md = "";
+  if (records.length === 0) {
+    md = "No logger history found.";
+  } else {
+    md =
+      "Logger history found:\n\n" +
+      "```text\n" +
+      records.join("\n") +
+      "\n```\n";
+  }
+  const ts = Date.now();
+  const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_LOG_HISTORY_FILE_PREFIX}${ts}.md`;
+  await vault.create(filePath, md, {
+    mtime: ts,
+  });
+};

src/encrypt.ts

@@ -1,8 +1,7 @@
 import { base32, base64url } from "rfc4648";
 import { bufferToArrayBuffer, hexStringToTypedArray } from "./misc";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 const DEFAULT_ITER = 20000;
 
@@ -165,3 +164,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/importExport.ts

@@ -7,8 +7,7 @@ import {
   RemotelySavePluginSettings,
 } from "./baseTypes";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 export const exportQrCodeUri = async (
   settings: RemotelySavePluginSettings,

src/localdb.ts

@@ -1,21 +1,23 @@
 import localforage from "localforage";
-import { TAbstractFile, TFile, TFolder } from "obsidian";
-
-import type { SUPPORTED_SERVICES_TYPE } from "./baseTypes";
-import type { SyncPlanType } from "./sync";
-
 export type LocalForage = typeof localforage;
+import { nanoid } from "nanoid";
+import { requireApiVersion, TAbstractFile, TFile, TFolder } from "obsidian";
 
-import * as origLog from "loglevel";
+import { API_VER_STAT_FOLDER, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
-const log = origLog.getLogger("rs-default");
+import type { SyncPlanType } from "./sync";
+import { toText, unixTimeToStr } from "./misc";
 
-const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108];
+import { log } from "./moreOnLog";
-export const DEFAULT_DB_VERSION_NUMBER: number = 20220108;
+
+const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108, 20220326];
+export const DEFAULT_DB_VERSION_NUMBER: number = 20220326;
 export const DEFAULT_DB_NAME = "remotelysavedb";
 export const DEFAULT_TBL_VERSION = "schemaversion";
-export const DEFAULT_TBL_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 const DEFAULT_TBL_LOGGER_OUTPUT = "loggeroutput";
 
 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,11 @@ interface SyncPlanRecord {
 
 export interface InternalDBs {
   versionTbl: LocalForage;
-  deleteHistoryTbl: LocalForage;
+  fileHistoryTbl: LocalForage;
   syncMappingTbl: LocalForage;
   syncPlansTbl: LocalForage;
+  vaultRandomIDMappingTbl: LocalForage;
+  loggerOutputTbl: LocalForage;
 }
 
 /**
@@ -72,12 +76,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 +91,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 +140,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 +169,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 +208,46 @@ 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,
+    }),
+    loggerOutputTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_LOGGER_OUTPUT,
+    }),
   } 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 +268,10 @@ export const prepareDBs = async (vaultRandomID: string) => {
   }
 
   log.info("db connected");
-  return db;
+  return {
+    db: db,
+    vaultRandomID: vaultRandomID,
+  };
 };
 
 export const destroyDBs = async () => {
@@ -206,20 +284,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 +311,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 +347,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 +361,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 +381,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 (
@@ -386,6 +521,7 @@ export const insertSyncPlanRecordByVault = async (
 ) => {
   const record = {
     ts: syncPlan.ts,
+    tsFmt: syncPlan.tsFmt,
     vaultRandomID: vaultRandomID,
     remoteType: syncPlan.remoteType,
     syncPlan: JSON.stringify(syncPlan /* directly stringify */, null, 2),
@@ -415,3 +551,133 @@ export const readAllSyncPlanRecordTextsByVault = async (
     return records.map((x) => x.syncPlan);
   }
 };
+
+/**
+ * We remove records that are older than 7 days or 10000 records.
+ * It's a heavy operation, so we shall not place it in the start up.
+ * @param db
+ */
+export const clearExpiredSyncPlanRecords = async (db: InternalDBs) => {
+  const MILLISECONDS_OLD = 1000 * 60 * 60 * 24 * 7; // 7 days
+  const COUNT_TO_MANY = 10000;
+
+  const currTs = Date.now();
+  const expiredTs = currTs - MILLISECONDS_OLD;
+
+  let records = (await db.syncPlansTbl.keys()).map((key) => {
+    const ts = parseInt(key.split("\t")[1]);
+    const expired = ts <= expiredTs;
+    return {
+      ts: ts,
+      key: key,
+      expired: expired,
+    };
+  });
+
+  const keysToRemove = new Set(
+    records.filter((x) => x.expired).map((x) => x.key)
+  );
+
+  if (records.length - keysToRemove.size > COUNT_TO_MANY) {
+    // we need to find out records beyond 10000 records
+    records = records.filter((x) => !x.expired); // shrink the array
+    records.sort((a, b) => -(a.ts - b.ts)); // descending
+    records.slice(COUNT_TO_MANY).forEach((element) => {
+      keysToRemove.add(element.key);
+    });
+  }
+
+  const ps = [] as Promise<void>[];
+  keysToRemove.forEach((element) => {
+    ps.push(db.syncPlansTbl.removeItem(element));
+  });
+  await Promise.all(ps);
+};
+
+export const readAllLogRecordTextsByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string
+) => {
+  const records = [] as { ts: number; r: string }[];
+  await db.loggerOutputTbl.iterate((value, key, iterationNumber) => {
+    if (key.startsWith(`${vaultRandomID}\t`)) {
+      const item = {
+        ts: parseInt(key.split("\t")[1]),
+        r: value as string,
+      };
+      records.push(item);
+    }
+  });
+
+  // while reading the logs, we want it to be ascending
+  records.sort((a, b) => a.ts - b.ts);
+
+  if (records === undefined) {
+    return [] as string[];
+  } else {
+    return records.map((x) => x.r);
+  }
+};
+
+export const insertLoggerOutputByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string,
+  ...msg: any[]
+) => {
+  const ts = Date.now();
+  const tsFmt = unixTimeToStr(ts);
+  const key = `${vaultRandomID}\t${ts}`;
+
+  try {
+    const val = [`[${tsFmt}]`, ...msg.map((x) => toText(x))].join(" ");
+    db.loggerOutputTbl.setItem(key, val);
+  } catch (err) {
+    // give up, and let it pass
+  }
+};
+
+export const clearAllLoggerOutputRecords = async (db: InternalDBs) => {
+  await db.loggerOutputTbl.clear();
+};
+
+/**
+ * We remove records that are older than 7 days or 10000 records.
+ * It's a heavy operation, so we shall not place it in the start up.
+ * @param db
+ */
+export const clearExpiredLoggerOutputRecords = async (db: InternalDBs) => {
+  const MILLISECONDS_OLD = 1000 * 60 * 60 * 24 * 7; // 7 days
+  const COUNT_TO_MANY = 10000;
+
+  const currTs = Date.now();
+  const expiredTs = currTs - MILLISECONDS_OLD;
+
+  let records = (await db.loggerOutputTbl.keys()).map((key) => {
+    const ts = parseInt(key.split("\t")[1]);
+    const expired = ts <= expiredTs;
+    return {
+      ts: ts,
+      key: key,
+      expired: expired,
+    };
+  });
+
+  const keysToRemove = new Set(
+    records.filter((x) => x.expired).map((x) => x.key)
+  );
+
+  if (records.length - keysToRemove.size > COUNT_TO_MANY) {
+    // we need to find out records beyond 10000 records
+    records = records.filter((x) => !x.expired); // shrink the array
+    records.sort((a, b) => -(a.ts - b.ts)); // descending
+    records.slice(COUNT_TO_MANY).forEach((element) => {
+      keysToRemove.add(element.key);
+    });
+  }
+
+  const ps = [] as Promise<void>[];
+  keysToRemove.forEach((element) => {
+    ps.push(db.loggerOutputTbl.removeItem(element));
+  });
+  await Promise.all(ps);
+};

src/main.ts

@@ -1,8 +1,18 @@
-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, FileText } from "lucide";
-import feather from "feather-icons";
+import type {
-import type { RemotelySavePluginSettings } from "./baseTypes";
+  RemotelySavePluginSettings,
+  SyncTriggerSourceType,
+} from "./baseTypes";
 import {
   COMMAND_CALLBACK,
   COMMAND_CALLBACK_ONEDRIVE,
@@ -10,13 +20,16 @@ import {
   COMMAND_URI,
 } from "./baseTypes";
 import { importQrCodeUri } from "./importExport";
-import type { InternalDBs } from "./localdb";
 import {
   insertDeleteRecordByVault,
   insertRenameRecordByVault,
   insertSyncPlanRecordByVault,
-  loadDeleteRenameHistoryTableByVault,
+  loadFileHistoryTableByVault,
   prepareDBs,
+  InternalDBs,
+  insertLoggerOutputByVault,
+  clearExpiredLoggerOutputRecords,
+  clearExpiredSyncPlanRecords,
 } from "./localdb";
 import { RemoteClient } from "./remote";
 import {
@@ -41,10 +54,16 @@ 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";
 import { SyncAlgoV2Modal } from "./syncAlgoV2Notice";
-const log = origLog.getLogger("rs-default");
+import { applyPresetRulesInplace } from "./presetRules";
+
+import { applyLogWriterInplace, log } from "./moreOnLog";
+import AggregateError from "aggregate-error";
+import {
+  exportVaultLoggerOutputToFiles,
+  exportVaultSyncPlansToFiles,
+} from "./debugMode";
 
 const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   s3: DEFAULT_S3_CONFIG,
@@ -54,7 +73,7 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   password: "",
   serviceType: "s3",
   currLogLevel: "info",
-  vaultRandomID: "",
+  // vaultRandomID: "", // deprecated
   autoRunEveryMilliseconds: -1,
   initRunAfterMilliseconds: -1,
   agreeToUploadExtraMetadata: false,
@@ -62,6 +81,7 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   syncConfigDir: false,
   syncUnderscoreItems: false,
   lang: "auto",
+  logToDB: false,
 };
 
 interface OAuth2Info {
@@ -72,22 +92,34 @@ interface OAuth2Info {
   revokeAuthSetting?: Setting;
 }
 
-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({
+const iconNameLogs = `remotely-save-logs`;
-  width: 100,
+
-  height: 100,
+const getIconSvg = () => {
-});
+  const iconSvgSyncWait = createElement(RotateCcw);
-const iconSvgSyncRunning = feather.icons["refresh-ccw"].toSvg({
+  iconSvgSyncWait.setAttribute("width", "100");
-  width: 100,
+  iconSvgSyncWait.setAttribute("height", "100");
-  height: 100,
+  const iconSvgSyncRunning = createElement(RefreshCcw);
-});
+  iconSvgSyncRunning.setAttribute("width", "100");
+  iconSvgSyncRunning.setAttribute("height", "100");
+  const iconSvgLogs = createElement(FileText);
+  iconSvgLogs.setAttribute("width", "100");
+  iconSvgLogs.setAttribute("height", "100");
+  const res = {
+    iconSvgSyncWait: iconSvgSyncWait.outerHTML,
+    iconSvgSyncRunning: iconSvgSyncRunning.outerHTML,
+    iconSvgLogs: iconSvgLogs.outerHTML,
+  };
+
+  iconSvgSyncWait.empty();
+  iconSvgSyncRunning.empty();
+  iconSvgLogs.empty();
+  return res;
+};
 
 export default class RemotelySavePlugin extends Plugin {
   settings: RemotelySavePluginSettings;
-  // cm: CodeMirror.Editor;
   db: InternalDBs;
   syncStatus: SyncStatusType;
   oauth2Info: OAuth2Info;
@@ -96,17 +128,18 @@ export default class RemotelySavePlugin extends Plugin {
   syncRibbon?: HTMLElement;
   autoRunIntervalID?: number;
   i18n: I18n;
+  vaultRandomID: string;
 
   async syncRun(triggerSource: SyncTriggerSourceType = "manual") {
     const t = (x: TransItemType, vars?: any) => {
       return this.i18n.t(x, vars);
     };
 
-    const getNotice = (x: string) => {
+    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") {
@@ -182,7 +215,7 @@ export default class RemotelySavePlugin extends Plugin {
         () => self.saveSettings()
       );
       const remoteRsp = await client.listFromRemote();
-      log.debug(remoteRsp);
+      // log.debug(remoteRsp);
 
       getNotice(
         t("syncrun_step3", {
@@ -208,7 +241,7 @@ export default class RemotelySavePlugin extends Plugin {
       const { remoteStates, metadataFile } = await parseRemoteItems(
         remoteRsp.Contents,
         this.db,
-        this.settings.vaultRandomID,
+        this.vaultRandomID,
         client.serviceType,
         this.settings.password
       );
@@ -226,9 +259,9 @@ export default class RemotelySavePlugin extends Plugin {
       );
       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) {
@@ -254,6 +287,7 @@ export default class RemotelySavePlugin extends Plugin {
         origMetadataOnRemote.deletions,
         localHistory,
         client.serviceType,
+        triggerSource,
         this.app.vault,
         this.settings.syncConfigDir,
         this.app.vault.configDir,
@@ -261,13 +295,7 @@ export default class RemotelySavePlugin extends Plugin {
         this.settings.password
       );
       log.info(plan.mixedStates); // for debugging
-      if (triggerSource !== "dry") {
+      await insertSyncPlanRecordByVault(this.db, plan, this.vaultRandomID);
-        await insertSyncPlanRecordByVault(
-          this.db,
-          plan,
-          this.settings.vaultRandomID
-        );
-      }
 
       // The operations above are almost read only and kind of safe.
       // The operations below begins to write or delete (!!!) something.
@@ -283,7 +311,7 @@ export default class RemotelySavePlugin extends Plugin {
         await doActualSync(
           client,
           this.db,
-          this.settings.vaultRandomID,
+          this.vaultRandomID,
           this.app.vault,
           plan,
           sortedKeys,
@@ -330,10 +358,16 @@ export default class RemotelySavePlugin extends Plugin {
         triggerSource: triggerSource,
         syncStatus: this.syncStatus,
       });
-      log.info(msg);
+      log.error(msg);
-      log.info(error);
+      log.error(error);
-      getNotice(msg);
+      getNotice(msg, 10 * 1000);
-      getNotice(error.message);
+      if (error instanceof AggregateError) {
+        for (const e of error.errors) {
+          getNotice(e.message, 10 * 1000);
+        }
+      } else {
+        getNotice(error.message, 10 * 1000);
+      }
       this.syncStatus = "idle";
       if (this.syncRibbon !== undefined) {
         setIcon(this.syncRibbon, iconNameSyncWait);
@@ -345,8 +379,11 @@ export default class RemotelySavePlugin extends Plugin {
   async onload() {
     log.info(`loading plugin ${this.manifest.id}`);
 
+    const { iconSvgSyncWait, iconSvgSyncRunning, iconSvgLogs } = getIconSvg();
+
     addIcon(iconNameSyncWait, iconSvgSyncWait);
     addIcon(iconNameSyncRunning, iconSvgSyncRunning);
+    addIcon(iconNameLogs, iconSvgLogs);
 
     this.oauth2Info = {
       verifier: "",
@@ -359,6 +396,7 @@ export default class RemotelySavePlugin extends Plugin {
     this.currSyncMsg = "";
 
     await this.loadSettings();
+    await this.checkIfPresetRulesFollowed();
 
     // lang should be load early, but after settings
     this.i18n = new I18n(this.settings.lang, async (lang: LangTypeAndAuto) => {
@@ -374,12 +412,34 @@ export default class RemotelySavePlugin extends Plugin {
     }
 
     await this.checkIfOauthExpires();
-    await this.checkIfVaultIDAssigned(); // MUST before 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();
 
-    await this.prepareDB();
+    const vaultBasePath = this.getVaultBasePath();
+
+    try {
+      await this.prepareDBAndVaultRandomID(
+        vaultBasePath,
+        vaultRandomIDFromOldConfigFile
+      );
+    } catch (err) {
+      new Notice(err.message, 10 * 1000);
+      throw err;
+    }
+
+    // must AFTER preparing DB
+    this.addOutputToDBIfSet();
+    this.enableAutoClearOutputToDBHistIfSet();
+
+    // must AFTER preparing DB
+    this.enableAutoClearSyncPlanHist();
 
     this.syncStatus = "idle";
 
@@ -388,7 +448,7 @@ export default class RemotelySavePlugin extends Plugin {
         await insertDeleteRecordByVault(
           this.db,
           fileOrFolder,
-          this.settings.vaultRandomID
+          this.vaultRandomID
         );
       })
     );
@@ -399,7 +459,7 @@ export default class RemotelySavePlugin extends Plugin {
           this.db,
           fileOrFolder,
           oldPath,
-          this.settings.vaultRandomID
+          this.vaultRandomID
         );
       })
     );
@@ -615,6 +675,50 @@ export default class RemotelySavePlugin extends Plugin {
       },
     });
 
+    this.addCommand({
+      id: "export-sync-plans-json",
+      name: t("command_exportsyncplans_json"),
+      icon: iconNameLogs,
+      callback: async () => {
+        await exportVaultSyncPlansToFiles(
+          this.db,
+          this.app.vault,
+          this.vaultRandomID,
+          "json"
+        );
+        new Notice(t("settings_syncplans_notice"));
+      },
+    });
+
+    this.addCommand({
+      id: "export-sync-plans-table",
+      name: t("command_exportsyncplans_table"),
+      icon: iconNameLogs,
+      callback: async () => {
+        await exportVaultSyncPlansToFiles(
+          this.db,
+          this.app.vault,
+          this.vaultRandomID,
+          "table"
+        );
+        new Notice(t("settings_syncplans_notice"));
+      },
+    });
+
+    this.addCommand({
+      id: "export-logs-in-db",
+      name: t("command_exportlogsindb"),
+      icon: iconNameLogs,
+      callback: async () => {
+        await exportVaultLoggerOutputToFiles(
+          this.db,
+          this.app.vault,
+          this.vaultRandomID
+        );
+        new Notice(t("settings_logtodbexport_notice"));
+      },
+    });
+
     this.addSettingTab(new RemotelySaveSettingTab(this.app, this));
 
     // this.registerDomEvent(document, "click", (evt: MouseEvent) => {
@@ -630,9 +734,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() {
@@ -644,21 +752,40 @@ export default class RemotelySavePlugin extends Plugin {
     if (this.settings.dropbox.clientID === "") {
       this.settings.dropbox.clientID = DEFAULT_SETTINGS.dropbox.clientID;
     }
+    if (this.settings.dropbox.remoteBaseDir === undefined) {
+      this.settings.dropbox.remoteBaseDir = "";
+    }
     if (this.settings.onedrive.clientID === "") {
       this.settings.onedrive.clientID = DEFAULT_SETTINGS.onedrive.clientID;
     }
     if (this.settings.onedrive.authority === "") {
       this.settings.onedrive.authority = DEFAULT_SETTINGS.onedrive.authority;
     }
+    if (this.settings.onedrive.remoteBaseDir === undefined) {
+      this.settings.onedrive.remoteBaseDir = "";
+    }
     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.webdav.remoteBaseDir === undefined) {
+      this.settings.webdav.remoteBaseDir = "";
+    }
     if (this.settings.s3.partsConcurrency === undefined) {
       this.settings.s3.partsConcurrency = 20;
     }
+    if (this.settings.s3.forcePathStyle === undefined) {
+      this.settings.s3.forcePathStyle = false;
+    }
+  }
+
+  async checkIfPresetRulesFollowed() {
+    const res = applyPresetRulesInplace(this.settings);
+    if (res.changed) {
+      await this.saveSettings();
+    }
   }
 
   async saveSettings() {
@@ -735,14 +862,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) {
@@ -751,8 +884,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() {
@@ -790,10 +941,6 @@ export default class RemotelySavePlugin extends Plugin {
     await this.saveSettings();
   }
 
-  destroyDBs() {
-    /* destroyDBs(this.db); */
-  }
-
   async setCurrSyncMsg(
     i: number,
     totalCount: number,
@@ -804,6 +951,13 @@ export default class RemotelySavePlugin extends Plugin {
     this.currSyncMsg = msg;
   }
 
+  /**
+   * Because data.json contains sensitive information,
+   * We usually want to ignore it in the version control.
+   * However, if there's already a an ignore file (even empty),
+   * we respect the existing configure and not add any modifications.
+   * @returns
+   */
   async tryToAddIgnoreFile() {
     const pluginConfigDir =
       this.manifest.dir ||
@@ -821,15 +975,7 @@ export default class RemotelySavePlugin extends Plugin {
     const contentText = "data.json\n";
 
     try {
-      if (ignoreFileExists) {
+      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);
@@ -838,4 +984,52 @@ export default class RemotelySavePlugin extends Plugin {
       // just skip
     }
   }
+
+  addOutputToDBIfSet() {
+    if (this.settings.logToDB) {
+      applyLogWriterInplace((...msg: any[]) => {
+        insertLoggerOutputByVault(this.db, this.vaultRandomID, ...msg);
+      });
+    }
+  }
+
+  enableAutoClearOutputToDBHistIfSet() {
+    const initClearOutputToDBHistAfterMilliseconds = 1000 * 45;
+    const autoClearOutputToDBHistAfterMilliseconds = 1000 * 60 * 5;
+
+    this.app.workspace.onLayoutReady(() => {
+      // init run
+      window.setTimeout(() => {
+        if (this.settings.logToDB) {
+          clearExpiredLoggerOutputRecords(this.db);
+        }
+      }, initClearOutputToDBHistAfterMilliseconds);
+
+      // scheduled run
+      const intervalID = window.setInterval(() => {
+        if (this.settings.logToDB) {
+          clearExpiredLoggerOutputRecords(this.db);
+        }
+      }, autoClearOutputToDBHistAfterMilliseconds);
+      this.registerInterval(intervalID);
+    });
+  }
+
+  enableAutoClearSyncPlanHist() {
+    const initClearSyncPlanHistAfterMilliseconds = 1000 * 45;
+    const autoClearSyncPlanHistAfterMilliseconds = 1000 * 60 * 5;
+
+    this.app.workspace.onLayoutReady(() => {
+      // init run
+      window.setTimeout(() => {
+        clearExpiredSyncPlanRecords(this.db);
+      }, initClearSyncPlanHistAfterMilliseconds);
+
+      // scheduled run
+      const intervalID = window.setInterval(() => {
+        clearExpiredSyncPlanRecords(this.db);
+      }, autoClearSyncPlanHistAfterMilliseconds);
+      this.registerInterval(intervalID);
+    });
+  }
 }

src/metadataOnRemote.ts

@@ -1,6 +1,7 @@
 import isEqual from "lodash/isEqual";
 import { base64url } from "rfc4648";
 import { reverseString } from "./misc";
+import { log } from "./moreOnLog";
 
 const DEFAULT_README_FOR_METADATAONREMOTE =
   "Do NOT edit or delete the file manually. This file is for the plugin remotely-save to store some necessary meta data on the remote services. Its content is slightly obfuscated.";
@@ -69,19 +70,44 @@ export const deserializeMetadataOnRemote = (x: string | ArrayBuffer) => {
   } else {
     y1 = new TextDecoder().decode(x);
   }
-  const y2: any = JSON.parse(y1);
 
-  if (!("readme" in y2 && "d" in y2)) {
+  let y2: any;
-    throw Error("invalid remote meta data file!");
+  try {
+    y2 = JSON.parse(y1);
+  } catch (e) {
+    throw new Error(
+      `invalid remote meta data file with first few chars: ${y1.slice(0, 5)}`
+    );
   }
 
-  const y3 = JSON.parse(
+  if (!("readme" in y2 && "d" in y2)) {
-    (
+    throw new Error(
+      'invalid remote meta data file (no "readme" or "d" fields)!'
+    );
+  }
+
+  let y3: string;
+  try {
+    y3 = (
       base64url.parse(reverseString(y2["d"]), {
         out: Buffer.allocUnsafe as any,
         loose: true,
       }) as Buffer
-    ).toString("utf-8")
+    ).toString("utf-8");
-  ) as MetadataOnRemote;
+  } catch (e) {
-  return y3;
+    throw new Error('invalid remote meta data file (invalid "d" field)!');
+  }
+
+  let y4: MetadataOnRemote;
+  try {
+    y4 = JSON.parse(y3) as MetadataOnRemote;
+  } catch (e) {
+    throw new Error(
+      `invalid remote meta data file with \"d\" field with first few chars: ${y3.slice(
+        0,
+        5
+      )}`
+    );
+  }
+  return y4;
 };

src/misc.ts

@@ -3,9 +3,15 @@ import * as path from "path";
 
 import { base32, base64url } from "rfc4648";
 import XRegExp from "xregexp";
+import emojiRegex from "emoji-regex";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
+
+declare global {
+  interface Window {
+    moment: (...data: any) => any;
+  }
+}
 
 /**
  * If any part of the file starts with '.' or '_' then it's a hidden file.
@@ -157,6 +163,34 @@ export const isVaildText = (a: string) => {
   );
 };
 
+/**
+ * Use regex to detect a text contains emoji or not.
+ * @param a
+ * @returns
+ */
+export const hasEmojiInText = (a: string) => {
+  const regex = emojiRegex();
+  return regex.test(a);
+};
+
+/**
+ * Convert the headers to a normal object.
+ * @param h
+ * @param toLower
+ * @returns
+ */
+export const headersToRecord = (h: Headers, toLower: boolean = true) => {
+  const res: Record<string, string> = {};
+  h.forEach((v, k) => {
+    if (toLower) {
+      res[k.toLowerCase()] = v;
+    } else {
+      res[k] = v;
+    }
+  });
+  return res;
+};
+
 /**
  * If input is already a folder, returns it as is;
  * And if input is a file, returns its direname.
@@ -299,3 +333,78 @@ export const atWhichLevel = (x: string) => {
   }
   return y.split("/").length;
 };
+
+export const checkHasSpecialCharForDir = (x: string) => {
+  return /[?/\\]/.test(x);
+};
+
+export const unixTimeToStr = (x: number | undefined | null) => {
+  if (x === undefined) {
+    return undefined;
+  }
+  if (x === null) {
+    return null;
+  }
+  return window.moment(x).format() as string;
+};
+
+/**
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value#examples
+ * @returns
+ */
+const getCircularReplacer = () => {
+  const seen = new WeakSet();
+  return (key: any, value: any) => {
+    if (typeof value === "object" && value !== null) {
+      if (seen.has(value)) {
+        return;
+      }
+      seen.add(value);
+    }
+    return value;
+  };
+};
+
+/**
+ * Convert "any" value to string.
+ * @param x
+ * @returns
+ */
+export const toText = (x: any) => {
+  if (x === undefined || x === null) {
+    return `${x}`;
+  }
+  if (typeof x === "string") {
+    return x;
+  }
+  if (
+    x instanceof String ||
+    x instanceof Date ||
+    typeof x === "number" ||
+    typeof x === "bigint" ||
+    typeof x === "boolean"
+  ) {
+    return `${x}`;
+  }
+
+  if (
+    x instanceof Error ||
+    (x &&
+      x.stack &&
+      x.message &&
+      typeof x.stack === "string" &&
+      typeof x.message === "string")
+  ) {
+    return `ERROR! MESSAGE: ${x.message}, STACK: ${x.stack}`;
+  }
+
+  try {
+    const y = JSON.stringify(x, getCircularReplacer(), 2);
+    if (y !== undefined) {
+      return y;
+    }
+    throw new Error("not jsonable");
+  } catch {
+    return `${x}`;
+  }
+};

src/moreOnLog.ts

@@ -0,0 +1,34 @@
+// It's very dangerous for this file to depend on other files in the same project.
+// We should avoid this situation as much as possible.
+
+import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
+
+import * as origLog from "loglevel";
+import type { LogLevelNumbers, Logger, LogLevel, LogLevelDesc } from "loglevel";
+const log2 = origLog.getLogger("rs-default");
+
+const originalFactory = log2.methodFactory;
+
+export const applyLogWriterInplace = function (writer: (...msg: any[]) => any) {
+  log2.methodFactory = function (
+    methodName: string,
+    logLevel: LogLevelNumbers,
+    loggerName: string | symbol
+  ) {
+    const rawMethod = originalFactory(methodName, logLevel, loggerName);
+
+    return function (...msg: any[]) {
+      rawMethod.apply(undefined, msg);
+      writer(...msg);
+    };
+  };
+
+  log2.setLevel(log2.getLevel());
+};
+
+export const restoreLogWritterInplace = () => {
+  log2.methodFactory = originalFactory;
+  log2.setLevel(log2.getLevel());
+};
+
+export const log = log2;

src/obsFolderLister.ts

@@ -3,9 +3,6 @@ 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;

src/presetRules.ts

@@ -0,0 +1,69 @@
+import type {
+  RemotelySavePluginSettings,
+  WebdavConfig,
+  WebdavDepthType,
+} from "./baseTypes";
+
+const RULES = {
+  webdav: {
+    depth: [
+      {
+        url: "^https://(.+).teracloud.jp/.+",
+        depth: "auto_1",
+        manualRecursive: true,
+      },
+      {
+        url: "^https://dav.jianguoyun.com/dav/",
+        depth: "auto_1",
+        manualRecursive: true,
+      },
+    ],
+  },
+};
+
+export const applyWebdavPresetRulesInplace = (
+  webdav: Partial<WebdavConfig> | undefined
+) => {
+  if (webdav === undefined) {
+    return {
+      changed: false,
+      webdav: webdav,
+    };
+  }
+  for (const { url, depth, manualRecursive } of RULES.webdav.depth) {
+    if (
+      webdav.address !== undefined &&
+      new RegExp(url).test(webdav.address) &&
+      webdav.depth !== undefined &&
+      webdav.depth.startsWith("auto_") &&
+      webdav.depth !== depth
+    ) {
+      webdav.depth = depth as WebdavDepthType;
+      webdav.manualRecursive = manualRecursive;
+      return {
+        changed: true,
+        webdav: webdav,
+      };
+    }
+  }
+  return {
+    changed: false,
+    webdav: webdav,
+  };
+};
+
+export const applyPresetRulesInplace = (
+  settings: RemotelySavePluginSettings | undefined
+) => {
+  if (settings === undefined) {
+    return {
+      changed: false,
+      settings: settings,
+    };
+  }
+  const webdavRes = applyWebdavPresetRulesInplace(settings.webdav);
+  return {
+    changed: webdavRes.changed,
+    settings: settings,
+  };
+};

src/remote.ts

@@ -11,12 +11,10 @@ import * as onedrive from "./remoteForOnedrive";
 import * as s3 from "./remoteForS3";
 import * as webdav from "./remoteForWebdav";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 export class RemoteClient {
   readonly serviceType: SUPPORTED_SERVICES_TYPE;
-  readonly s3Client?: s3.S3Client;
   readonly s3Config?: S3Config;
   readonly webdavClient?: webdav.WrappedWebdavClient;
   readonly webdavConfig?: WebdavConfig;
@@ -39,17 +37,17 @@ export class RemoteClient {
     // so we use a ref not copy of config here
     if (serviceType === "s3") {
       this.s3Config = s3Config;
-      this.s3Client = s3.getS3Client(this.s3Config);
     } else if (serviceType === "webdav") {
       if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
         throw Error(
           "remember to provide vault name and callback while init webdav client"
         );
       }
+      const remoteBaseDir = webdavConfig.remoteBaseDir || vaultName;
       this.webdavConfig = webdavConfig;
       this.webdavClient = webdav.getWebdavClient(
         this.webdavConfig,
-        vaultName,
+        remoteBaseDir,
         saveUpdatedConfigFunc
       );
     } else if (serviceType === "dropbox") {
@@ -58,10 +56,11 @@ export class RemoteClient {
           "remember to provide vault name and callback while init dropbox client"
         );
       }
+      const remoteBaseDir = dropboxConfig.remoteBaseDir || vaultName;
       this.dropboxConfig = dropboxConfig;
       this.dropboxClient = dropbox.getDropboxClient(
         this.dropboxConfig,
-        vaultName,
+        remoteBaseDir,
         saveUpdatedConfigFunc
       );
     } else if (serviceType === "onedrive") {
@@ -70,10 +69,11 @@ export class RemoteClient {
           "remember to provide vault name and callback while init onedrive client"
         );
       }
+      const remoteBaseDir = onedriveConfig.remoteBaseDir || vaultName;
       this.onedriveConfig = onedriveConfig;
       this.onedriveClient = onedrive.getOnedriveClient(
         this.onedriveConfig,
-        vaultName,
+        remoteBaseDir,
         saveUpdatedConfigFunc
       );
     } else {
@@ -84,7 +84,7 @@ export class RemoteClient {
   getRemoteMeta = async (fileOrFolderPath: string) => {
     if (this.serviceType === "s3") {
       return await s3.getRemoteMeta(
-        this.s3Client,
+        s3.getS3Client(this.s3Config),
         this.s3Config,
         fileOrFolderPath
       );
@@ -114,7 +114,7 @@ export class RemoteClient {
   ) => {
     if (this.serviceType === "s3") {
       return await s3.uploadToRemote(
-        this.s3Client,
+        s3.getS3Client(this.s3Config),
         this.s3Config,
         fileOrFolderPath,
         vault,
@@ -166,7 +166,11 @@ export class RemoteClient {
 
   listFromRemote = async (prefix?: string) => {
     if (this.serviceType === "s3") {
-      return await s3.listFromRemote(this.s3Client, this.s3Config, prefix);
+      return await s3.listFromRemote(
+        s3.getS3Client(this.s3Config),
+        this.s3Config,
+        prefix
+      );
     } else if (this.serviceType === "webdav") {
       return await webdav.listFromRemote(this.webdavClient, prefix);
     } else if (this.serviceType === "dropbox") {
@@ -188,7 +192,7 @@ export class RemoteClient {
   ) => {
     if (this.serviceType === "s3") {
       return await s3.downloadFromRemote(
-        this.s3Client,
+        s3.getS3Client(this.s3Config),
         this.s3Config,
         fileOrFolderPath,
         vault,
@@ -239,7 +243,7 @@ export class RemoteClient {
   ) => {
     if (this.serviceType === "s3") {
       return await s3.deleteFromRemote(
-        this.s3Client,
+        s3.getS3Client(this.s3Config),
         this.s3Config,
         fileOrFolderPath,
         password,
@@ -271,15 +275,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(
+        s3.getS3Client(this.s3Config),
+        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

@@ -1,4 +1,6 @@
-import { Dropbox, DropboxAuth, files } from "dropbox";
+import delay from "delay";
+import { Dropbox, DropboxAuth } from "dropbox";
+import type { files, DropboxResponseError, DropboxResponse } from "dropbox";
 import { Vault } from "obsidian";
 import * as path from "path";
 import {
@@ -8,12 +10,17 @@ import {
   OAUTH2_FORCE_EXPIRE_MILLISECONDS,
 } from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
-import { bufferToArrayBuffer, getFolderLevels, mkdirpInVault } from "./misc";
+import {
+  bufferToArrayBuffer,
+  getFolderLevels,
+  hasEmojiInText,
+  headersToRecord,
+  mkdirpInVault,
+} from "./misc";
 
 export { Dropbox } from "dropbox";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
   accessToken: "",
@@ -26,15 +33,18 @@ export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
   credentialsShouldBeDeletedAtTime: 0,
 };
 
-export const getDropboxPath = (fileOrFolderPath: string, vaultName: string) => {
+export const getDropboxPath = (
+  fileOrFolderPath: string,
+  remoteBaseDir: string
+) => {
   let key = fileOrFolderPath;
   if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
     // special
-    key = `/${vaultName}`;
+    key = `/${remoteBaseDir}`;
   }
   if (!fileOrFolderPath.startsWith("/")) {
     // then this is original path in Obsidian
-    key = `/${vaultName}/${fileOrFolderPath}`;
+    key = `/${remoteBaseDir}/${fileOrFolderPath}`;
   }
   if (key.endsWith("/")) {
     key = key.slice(0, key.length - 1);
@@ -42,16 +52,18 @@ export const getDropboxPath = (fileOrFolderPath: string, vaultName: string) => {
   return key;
 };
 
-const getNormPath = (fileOrFolderPath: string, vaultName: string) => {
+const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
   if (
     !(
-      fileOrFolderPath === `/${vaultName}` ||
+      fileOrFolderPath === `/${remoteBaseDir}` ||
-      fileOrFolderPath.startsWith(`/${vaultName}/`)
+      fileOrFolderPath.startsWith(`/${remoteBaseDir}/`)
     )
   ) {
-    throw Error(`"${fileOrFolderPath}" doesn't starts with "/${vaultName}/"`);
+    throw Error(
+      `"${fileOrFolderPath}" doesn't starts with "/${remoteBaseDir}/"`
+    );
   }
-  return fileOrFolderPath.slice(`/${vaultName}/`.length);
+  return fileOrFolderPath.slice(`/${remoteBaseDir}/`.length);
 };
 
 const fromDropboxItemToRemoteItem = (
@@ -59,9 +71,9 @@ const fromDropboxItemToRemoteItem = (
     | files.FileMetadataReference
     | files.FolderMetadataReference
     | files.DeletedMetadataReference,
-  vaultName: string
+  remoteBaseDir: string
 ): RemoteItem => {
-  let key = getNormPath(x.path_display, vaultName);
+  let key = getNormPath(x.path_display, remoteBaseDir);
   if (x[".tag"] === "folder" && !key.endsWith("/")) {
     key = `${key}/`;
   }
@@ -266,19 +278,86 @@ export const setConfigBySuccessfullAuthInplace = async (
 // Other usual common methods
 ////////////////////////////////////////////////////////////////////////////////
 
+interface ErrSubType {
+  error: {
+    retry_after: number;
+  };
+}
+
+async function retryReq<T>(
+  reqFunc: () => Promise<DropboxResponse<T>>,
+  extraHint: string = ""
+): Promise<DropboxResponse<T>> {
+  const waitSeconds = [1, 2, 4, 8]; // hard code exponential backoff
+  for (let idx = 0; idx < waitSeconds.length; ++idx) {
+    try {
+      if (idx !== 0) {
+        log.warn(
+          `${extraHint === "" ? "" : extraHint + ": "}The ${
+            idx + 1
+          }-th try starts at time ${Date.now()}`
+        );
+      }
+      return await reqFunc();
+    } catch (e: unknown) {
+      const err = e as DropboxResponseError<ErrSubType>;
+      if (err.status === undefined) {
+        // then the err is not DropboxResponseError
+        throw err;
+      }
+      if (err.status !== 429) {
+        // then the err is not "too many requests", give up
+        throw err;
+      }
+
+      if (idx === waitSeconds.length - 1) {
+        // the last retry also failed, give up
+        throw new Error(
+          `${
+            extraHint === "" ? "" : extraHint + ": "
+          }"429 too many requests", after retrying for ${
+            idx + 1
+          } times still failed.`
+        );
+      }
+
+      const headers = headersToRecord(err.headers);
+      const svrSec =
+        err.error.error.retry_after ||
+        parseInt(headers["retry-after"] || "1") ||
+        1;
+      const fallbackSec = waitSeconds[idx];
+      const secMin = Math.max(svrSec, fallbackSec);
+      const secMax = Math.max(secMin * 1.8, 2);
+      log.warn(
+        `${
+          extraHint === "" ? "" : extraHint + ": "
+        }We have "429 too many requests" error of ${
+          idx + 1
+        }-th try, at time ${Date.now()}, and wait for ${secMin} ~ ${secMax} seconds to retry. Original info: ${JSON.stringify(
+          err.error,
+          null,
+          2
+        )}`
+      );
+      await delay.range(secMin * 1000, secMax * 1000);
+    }
+  }
+}
+
 export class WrappedDropboxClient {
   dropboxConfig: DropboxConfig;
-  vaultName: string;
+  remoteBaseDir: string;
   saveUpdatedConfigFunc: () => Promise<any>;
   dropbox: Dropbox;
   vaultFolderExists: boolean;
   constructor(
     dropboxConfig: DropboxConfig,
-    vaultName: string,
+    remoteBaseDir: string,
     saveUpdatedConfigFunc: () => Promise<any>
   ) {
     this.dropboxConfig = dropboxConfig;
-    this.vaultName = vaultName;
+    this.remoteBaseDir = remoteBaseDir;
     this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
     this.vaultFolderExists = false;
   }
@@ -318,29 +397,36 @@ export class WrappedDropboxClient {
     }
 
     // check vault folder
-    // log.info(`checking remote has folder /${this.vaultName}`);
+    // log.info(`checking remote has folder /${this.remoteBaseDir}`);
     if (this.vaultFolderExists) {
-      // log.info(`already checked, /${this.vaultName} exist before`)
+      // log.info(`already checked, /${this.remoteBaseDir} exist before`)
     } else {
       const res = await this.dropbox.filesListFolder({
         path: "",
         recursive: false,
       });
       for (const item of res.result.entries) {
-        if (item.path_display === `/${this.vaultName}`) {
+        if (item.path_display === `/${this.remoteBaseDir}`) {
           this.vaultFolderExists = true;
           break;
         }
       }
       if (!this.vaultFolderExists) {
-        log.info(`remote does not have folder /${this.vaultName}`);
+        log.info(`remote does not have folder /${this.remoteBaseDir}`);
+
+        if (hasEmojiInText(`/${this.remoteBaseDir}`)) {
+          throw new Error(
+            `/${this.remoteBaseDir}: Error: Dropbox does not support emoji in folder names.`
+          );
+        }
+
         await this.dropbox.filesCreateFolderV2({
-          path: `/${this.vaultName}`,
+          path: `/${this.remoteBaseDir}`,
         });
-        log.info(`remote folder /${this.vaultName} created`);
+        log.info(`remote folder /${this.remoteBaseDir} created`);
         this.vaultFolderExists = true;
       } else {
-        // log.info(`remote folder /${this.vaultName} exists`);
+        // log.info(`remote folder /${this.remoteBaseDir} exists`);
       }
     }
 
@@ -354,12 +440,12 @@ export class WrappedDropboxClient {
  */
 export const getDropboxClient = (
   dropboxConfig: DropboxConfig,
-  vaultName: string,
+  remoteBaseDir: string,
   saveUpdatedConfigFunc: () => Promise<any>
 ) => {
   return new WrappedDropboxClient(
     dropboxConfig,
-    vaultName,
+    remoteBaseDir,
     saveUpdatedConfigFunc
   );
 };
@@ -373,10 +459,12 @@ export const getRemoteMeta = async (
     // filesGetMetadata doesn't support root folder
     // we instead try to list files
     // if no error occurs, we ensemble a fake result.
-    const rsp = await client.dropbox.filesListFolder({
+    const rsp = await retryReq(() =>
-      path: `/${client.vaultName}`,
+      client.dropbox.filesListFolder({
-      recursive: false, // don't need to recursive here
+        path: `/${client.remoteBaseDir}`,
-    });
+        recursive: false, // don't need to recursive here
+      })
+    );
     if (rsp.status !== 200) {
       throw Error(JSON.stringify(rsp));
     }
@@ -389,15 +477,17 @@ export const getRemoteMeta = async (
     } as RemoteItem;
   }
 
-  const key = getDropboxPath(fileOrFolderPath, client.vaultName);
+  const key = getDropboxPath(fileOrFolderPath, client.remoteBaseDir);
 
-  const rsp = await client.dropbox.filesGetMetadata({
+  const rsp = await retryReq(() =>
-    path: key,
+    client.dropbox.filesGetMetadata({
-  });
+      path: key,
+    })
+  );
   if (rsp.status !== 200) {
     throw Error(JSON.stringify(rsp));
   }
-  return fromDropboxItemToRemoteItem(rsp.result, client.vaultName);
+  return fromDropboxItemToRemoteItem(rsp.result, client.remoteBaseDir);
 };
 
 export const uploadToRemote = async (
@@ -417,7 +507,13 @@ export const uploadToRemote = async (
   if (password !== "") {
     uploadFile = remoteEncryptedKey;
   }
-  uploadFile = getDropboxPath(uploadFile, client.vaultName);
+  uploadFile = getDropboxPath(uploadFile, client.remoteBaseDir);
+
+  if (hasEmojiInText(uploadFile)) {
+    throw new Error(
+      `${uploadFile}: Error: Dropbox does not support emoji in file / folder names.`
+    );
+  }
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
@@ -434,11 +530,19 @@ export const uploadToRemote = async (
         // created, pass
       } else {
         try {
-          await client.dropbox.filesCreateFolderV2({
+          await retryReq(
-            path: uploadFile,
+            () =>
-          });
+              client.dropbox.filesCreateFolderV2({
+                path: uploadFile,
+              }),
+            fileOrFolderPath
+          );
           foldersCreatedBefore?.add(uploadFile);
-        } catch (err) {
+        } catch (e: unknown) {
+          const err = e as DropboxResponseError<files.CreateFolderError>;
+          if (err.status === undefined) {
+            throw err;
+          }
           if (err.status === 409) {
             // pass
             foldersCreatedBefore?.add(uploadFile);
@@ -451,10 +555,14 @@ export const uploadToRemote = async (
       return res;
     } else {
       // if encrypted, upload a fake file with the encrypted file name
-      await client.dropbox.filesUpload({
+      await retryReq(
-        path: uploadFile,
+        () =>
-        contents: "",
+          client.dropbox.filesUpload({
-      });
+            path: uploadFile,
+            contents: "",
+          }),
+        fileOrFolderPath
+      );
       return await getRemoteMeta(client, uploadFile);
     }
   } else {
@@ -476,17 +584,23 @@ export const uploadToRemote = async (
     }
     // in dropbox, we don't need to create folders before uploading! cool!
     // TODO: filesUploadSession for larger files (>=150 MB)
-    await client.dropbox.filesUpload({
+
-      path: uploadFile,
+    await retryReq(
-      contents: remoteContent,
+      () =>
-      mode: {
+        client.dropbox.filesUpload({
-        ".tag": "overwrite",
+          path: uploadFile,
-      },
+          contents: remoteContent,
-    });
+          mode: {
+            ".tag": "overwrite",
+          },
+        }),
+      fileOrFolderPath
+    );
+
     // we want to mark that parent folders are created
     if (foldersCreatedBefore !== undefined) {
       const dirs = getFolderLevels(uploadFile).map((x) =>
-        getDropboxPath(x, client.vaultName)
+        getDropboxPath(x, client.remoteBaseDir)
       );
       for (const dir of dirs) {
         foldersCreatedBefore?.add(dir);
@@ -505,7 +619,7 @@ export const listFromRemote = async (
   }
   await client.init();
   let res = await client.dropbox.filesListFolder({
-    path: `/${client.vaultName}`,
+    path: `/${client.remoteBaseDir}`,
     recursive: true,
     include_deleted: false,
     limit: 1000,
@@ -518,8 +632,8 @@ export const listFromRemote = async (
   const contents = res.result.entries;
   const unifiedContents = contents
     .filter((x) => x[".tag"] !== "deleted")
-    .filter((x) => x.path_display !== `/${client.vaultName}`)
+    .filter((x) => x.path_display !== `/${client.remoteBaseDir}`)
-    .map((x) => fromDropboxItemToRemoteItem(x, client.vaultName));
+    .map((x) => fromDropboxItemToRemoteItem(x, client.remoteBaseDir));
 
   while (res.result.has_more) {
     res = await client.dropbox.filesListFolderContinue({
@@ -532,8 +646,8 @@ export const listFromRemote = async (
     const contents2 = res.result.entries;
     const unifiedContents2 = contents2
       .filter((x) => x[".tag"] !== "deleted")
-      .filter((x) => x.path_display !== `/${client.vaultName}`)
+      .filter((x) => x.path_display !== `/${client.remoteBaseDir}`)
-      .map((x) => fromDropboxItemToRemoteItem(x, client.vaultName));
+      .map((x) => fromDropboxItemToRemoteItem(x, client.remoteBaseDir));
     unifiedContents.push(...unifiedContents2);
   }
 
@@ -549,10 +663,14 @@ const downloadFromRemoteRaw = async (
   fileOrFolderPath: string
 ) => {
   await client.init();
-  const key = getDropboxPath(fileOrFolderPath, client.vaultName);
+  const key = getDropboxPath(fileOrFolderPath, client.remoteBaseDir);
-  const rsp = await client.dropbox.filesDownload({
+  const rsp = await retryReq(
-    path: key,
+    () =>
-  });
+      client.dropbox.filesDownload({
+        path: key,
+      }),
+    fileOrFolderPath
+  );
   if ((rsp.result as any).fileBlob !== undefined) {
     // we get a Blob
     const content = (rsp.result as any).fileBlob as Blob;
@@ -595,7 +713,7 @@ export const downloadFromRemote = async (
     if (password !== "") {
       downloadFile = remoteEncryptedKey;
     }
-    downloadFile = getDropboxPath(downloadFile, client.vaultName);
+    downloadFile = getDropboxPath(downloadFile, client.remoteBaseDir);
     const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
     let localContent = remoteContent;
     if (password !== "") {
@@ -623,20 +741,27 @@ export const deleteFromRemote = async (
   if (password !== "") {
     remoteFileName = remoteEncryptedKey;
   }
-  remoteFileName = getDropboxPath(remoteFileName, client.vaultName);
+  remoteFileName = getDropboxPath(remoteFileName, client.remoteBaseDir);
 
   await client.init();
   try {
-    await client.dropbox.filesDeleteV2({
+    await retryReq(
-      path: remoteFileName,
+      () =>
-    });
+        client.dropbox.filesDeleteV2({
+          path: remoteFileName,
+        }),
+      fileOrFolderPath
+    );
   } catch (err) {
     console.error("some error while deleting");
     console.error(err);
   }
 };
 
-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 +769,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

@@ -6,11 +6,11 @@ import type {
   User,
 } from "@microsoft/microsoft-graph-types";
 import cloneDeep from "lodash/cloneDeep";
-import * as origLog from "loglevel";
 import { request, requestUrl, requireApiVersion, Vault } from "obsidian";
 import {
-  API_VER_REQURL,
+  VALID_REQURL,
   COMMAND_CALLBACK_ONEDRIVE,
+  DEFAULT_CONTENT_TYPE,
   OAUTH2_FORCE_EXPIRE_MILLISECONDS,
   OnedriveConfig,
   RemoteItem,
@@ -23,7 +23,7 @@ import {
   mkdirpInVault,
 } from "./misc";
 
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 const SCOPES = ["User.Read", "Files.ReadWrite.AppFolder", "offline_access"];
 const REDIRECT_URI = `obsidian://${COMMAND_CALLBACK_ONEDRIVE}`;
@@ -204,9 +204,9 @@ export const setConfigBySuccessfullAuthInplace = async (
 // Other usual common methods
 ////////////////////////////////////////////////////////////////////////////////
 
-const getOnedrivePath = (fileOrFolderPath: string, vaultName: string) => {
+const getOnedrivePath = (fileOrFolderPath: string, remoteBaseDir: string) => {
   // https://docs.microsoft.com/en-us/onedrive/developer/rest-api/concepts/special-folders-appfolder?view=odsp-graph-online
-  const prefix = `/drive/special/approot:/${vaultName}`;
+  const prefix = `/drive/special/approot:/${remoteBaseDir}`;
   if (fileOrFolderPath.startsWith(prefix)) {
     // already transformed, return as is
     return fileOrFolderPath;
@@ -225,8 +225,8 @@ const getOnedrivePath = (fileOrFolderPath: string, vaultName: string) => {
   return key;
 };
 
-const getNormPath = (fileOrFolderPath: string, vaultName: string) => {
+const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
-  const prefix = `/drive/special/approot:/${vaultName}`;
+  const prefix = `/drive/special/approot:/${remoteBaseDir}`;
 
   if (
     !(fileOrFolderPath === prefix || fileOrFolderPath.startsWith(`${prefix}/`))
@@ -248,16 +248,16 @@ const constructFromDriveItemToRemoteItemError = (x: DriveItem) => {
 
 const fromDriveItemToRemoteItem = (
   x: DriveItem,
-  vaultName: string
+  remoteBaseDir: string
 ): RemoteItem => {
   let key = "";
 
   // possible prefix:
-  // pure english: /drive/root:/Apps/remotely-save/${vaultName}
+  // pure english: /drive/root:/Apps/remotely-save/${remoteBaseDir}
-  // or localized, e.g.: /drive/root:/应用/remotely-save/${vaultName}
+  // or localized, e.g.: /drive/root:/应用/remotely-save/${remoteBaseDir}
   const FIRST_COMMON_PREFIX_REGEX = /^\/drive\/root:\/[^\/]+\/remotely-save\//g;
   // or the root is absolute path /Livefolders,
-  // e.g.: /Livefolders/应用/remotely-save/${vaultName}
+  // e.g.: /Livefolders/应用/remotely-save/${remoteBaseDir}
   const SECOND_COMMON_PREFIX_REGEX = /^\/Livefolders\/[^\/]+\/remotely-save\//g;
 
   // another possibile prefix
@@ -270,26 +270,26 @@ const fromDriveItemToRemoteItem = (
   );
   if (
     matchFirstPrefixRes !== null &&
-    fullPathOriginal.startsWith(`${matchFirstPrefixRes[0]}${vaultName}`)
+    fullPathOriginal.startsWith(`${matchFirstPrefixRes[0]}${remoteBaseDir}`)
   ) {
-    const foundPrefix = `${matchFirstPrefixRes[0]}${vaultName}`;
+    const foundPrefix = `${matchFirstPrefixRes[0]}${remoteBaseDir}`;
     key = fullPathOriginal.substring(foundPrefix.length + 1);
   } else if (
     matchSecondPrefixRes !== null &&
-    fullPathOriginal.startsWith(`${matchSecondPrefixRes[0]}${vaultName}`)
+    fullPathOriginal.startsWith(`${matchSecondPrefixRes[0]}${remoteBaseDir}`)
   ) {
-    const foundPrefix = `${matchSecondPrefixRes[0]}${vaultName}`;
+    const foundPrefix = `${matchSecondPrefixRes[0]}${remoteBaseDir}`;
     key = fullPathOriginal.substring(foundPrefix.length + 1);
   } else if (x.parentReference.path.startsWith(THIRD_COMMON_PREFIX_RAW)) {
     // it's something like
-    // /drive/items/<some_id>!<another_id>:/${vaultName}/<subfolder>
+    // /drive/items/<some_id>!<another_id>:/${remoteBaseDir}/<subfolder>
     // with uri encoded!
     const parPath = decodeURIComponent(x.parentReference.path);
     key = parPath.substring(parPath.indexOf(":") + 1);
-    if (key.startsWith(`/${vaultName}/`)) {
+    if (key.startsWith(`/${remoteBaseDir}/`)) {
-      key = key.substring(`/${vaultName}/`.length);
+      key = key.substring(`/${remoteBaseDir}/`.length);
       key = `${key}/${x.name}`;
-    } else if (key === `/${vaultName}`) {
+    } else if (key === `/${remoteBaseDir}`) {
       key = x.name;
     } else {
       throw Error(
@@ -369,17 +369,17 @@ class MyAuthProvider implements AuthenticationProvider {
 
 export class WrappedOnedriveClient {
   onedriveConfig: OnedriveConfig;
-  vaultName: string;
+  remoteBaseDir: string;
   vaultFolderExists: boolean;
   authGetter: MyAuthProvider;
   saveUpdatedConfigFunc: () => Promise<any>;
   constructor(
     onedriveConfig: OnedriveConfig,
-    vaultName: string,
+    remoteBaseDir: string,
     saveUpdatedConfigFunc: () => Promise<any>
   ) {
     this.onedriveConfig = onedriveConfig;
-    this.vaultName = vaultName;
+    this.remoteBaseDir = remoteBaseDir;
     this.vaultFolderExists = false;
     this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
     this.authGetter = new MyAuthProvider(onedriveConfig, saveUpdatedConfigFunc);
@@ -395,26 +395,26 @@ export class WrappedOnedriveClient {
     }
 
     // check vault folder
-    // log.info(`checking remote has folder /${this.vaultName}`);
+    // log.info(`checking remote has folder /${this.remoteBaseDir}`);
     if (this.vaultFolderExists) {
-      // log.info(`already checked, /${this.vaultName} exist before`)
+      // log.info(`already checked, /${this.remoteBaseDir} exist before`)
     } else {
       const k = await this.getJson("/drive/special/approot/children");
-      log.debug(k);
+      // log.debug(k);
       this.vaultFolderExists =
-        (k.value as DriveItem[]).filter((x) => x.name === this.vaultName)
+        (k.value as DriveItem[]).filter((x) => x.name === this.remoteBaseDir)
           .length > 0;
       if (!this.vaultFolderExists) {
-        log.info(`remote does not have folder /${this.vaultName}`);
+        log.info(`remote does not have folder /${this.remoteBaseDir}`);
         await this.postJson("/drive/special/approot/children", {
-          name: `${this.vaultName}`,
+          name: `${this.remoteBaseDir}`,
           folder: {},
           "@microsoft.graph.conflictBehavior": "replace",
         });
-        log.info(`remote folder /${this.vaultName} created`);
+        log.info(`remote folder /${this.remoteBaseDir} created`);
         this.vaultFolderExists = true;
       } else {
-        // log.info(`remote folder /${this.vaultName} exists`);
+        // log.info(`remote folder /${this.remoteBaseDir} exists`);
       }
     }
   };
@@ -484,7 +484,7 @@ export class WrappedOnedriveClient {
   deleteJson = async (pathFragOrig: string) => {
     const theUrl = this.buildUrl(pathFragOrig);
     log.debug(`deleteJson, theUrl=${theUrl}`);
-    if (requireApiVersion(API_VER_REQURL)) {
+    if (VALID_REQURL) {
       await requestUrl({
         url: theUrl,
         method: "DELETE",
@@ -505,12 +505,17 @@ export class WrappedOnedriveClient {
   putArrayBuffer = async (pathFragOrig: string, payload: ArrayBuffer) => {
     const theUrl = this.buildUrl(pathFragOrig);
     log.debug(`putArrayBuffer, theUrl=${theUrl}`);
-    if (requireApiVersion(API_VER_REQURL)) {
+    // TODO:
+    // 20220401: On Android, requestUrl has issue that text becomes base64.
+    // Use fetch everywhere instead!
+    if (false /*VALID_REQURL*/) {
       await requestUrl({
         url: theUrl,
         method: "PUT",
         body: payload,
+        contentType: DEFAULT_CONTENT_TYPE,
         headers: {
+          "Content-Type": DEFAULT_CONTENT_TYPE,
           Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
         },
       });
@@ -519,6 +524,7 @@ export class WrappedOnedriveClient {
         method: "PUT",
         body: payload,
         headers: {
+          "Content-Type": DEFAULT_CONTENT_TYPE,
           Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
         },
       });
@@ -547,15 +553,18 @@ export class WrappedOnedriveClient {
       }, len=${rangeEnd - rangeStart}, size=${size}`
     );
     // NO AUTH HEADER here!
-    if (requireApiVersion(API_VER_REQURL)) {
+    // TODO:
+    // 20220401: On Android, requestUrl has issue that text becomes base64.
+    // Use fetch everywhere instead!
+    if (false /*VALID_REQURL*/) {
       const res = await requestUrl({
         url: theUrl,
         method: "PUT",
         body: bufferToArrayBuffer(payload.subarray(rangeStart, rangeEnd)),
+        contentType: DEFAULT_CONTENT_TYPE,
         headers: {
           // no "Content-Length" allowed here
           "Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
-          "Content-Type": "application/octet-stream",
         },
       });
       return res.json as DriveItem | UploadSession;
@@ -566,7 +575,7 @@ export class WrappedOnedriveClient {
         headers: {
           "Content-Length": `${rangeEnd - rangeStart}`,
           "Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
-          "Content-Type": "application/octet-stream",
+          "Content-Type": DEFAULT_CONTENT_TYPE,
         },
       });
       return (await res.json()) as DriveItem | UploadSession;
@@ -576,12 +585,12 @@ export class WrappedOnedriveClient {
 
 export const getOnedriveClient = (
   onedriveConfig: OnedriveConfig,
-  vaultName: string,
+  remoteBaseDir: string,
   saveUpdatedConfigFunc: () => Promise<any>
 ) => {
   return new WrappedOnedriveClient(
     onedriveConfig,
-    vaultName,
+    remoteBaseDir,
     saveUpdatedConfigFunc
   );
 };
@@ -605,9 +614,10 @@ export const listFromRemote = async (
   const DELTA_LINK_KEY = "@odata.deltaLink";
 
   let res = await client.getJson(
-    `/drive/special/approot:/${client.vaultName}:/delta`
+    `/drive/special/approot:/${client.remoteBaseDir}:/delta`
   );
   let driveItems = res.value as DriveItem[];
+  // log.debug(driveItems);
 
   while (NEXT_LINK_KEY in res) {
     res = await client.getJson(res[NEXT_LINK_KEY]);
@@ -622,7 +632,7 @@ export const listFromRemote = async (
 
   // unify everything to RemoteItem
   const unifiedContents = driveItems
-    .map((x) => fromDriveItemToRemoteItem(x, client.vaultName))
+    .map((x) => fromDriveItemToRemoteItem(x, client.remoteBaseDir))
     .filter((x) => x.key !== "/");
 
   return {
@@ -635,14 +645,14 @@ export const getRemoteMeta = async (
   fileOrFolderPath: string
 ) => {
   await client.init();
-  const remotePath = getOnedrivePath(fileOrFolderPath, client.vaultName);
+  const remotePath = getOnedrivePath(fileOrFolderPath, client.remoteBaseDir);
   // log.info(`remotePath=${remotePath}`);
   const rsp = await client.getJson(
     `${remotePath}?$select=cTag,eTag,fileSystemInfo,folder,file,name,parentReference,size`
   );
   // log.info(rsp);
   const driveItem = rsp as DriveItem;
-  const res = fromDriveItemToRemoteItem(driveItem, client.vaultName);
+  const res = fromDriveItemToRemoteItem(driveItem, client.remoteBaseDir);
   // log.info(res);
   return res;
 };
@@ -664,7 +674,7 @@ export const uploadToRemote = async (
   if (password !== "") {
     uploadFile = remoteEncryptedKey;
   }
-  uploadFile = getOnedrivePath(uploadFile, client.vaultName);
+  uploadFile = getOnedrivePath(uploadFile, client.remoteBaseDir);
   log.debug(`uploadFile=${uploadFile}`);
 
   const isFolder = fileOrFolderPath.endsWith("/");
@@ -737,8 +747,9 @@ export const uploadToRemote = async (
     // hard code range size
     const MIN_UNIT = 327680; // bytes in msft doc, about 0.32768 MB
     const RANGE_SIZE = MIN_UNIT * 20; // about 6.5536 MB
+    const DIRECT_UPLOAD_MAX_SIZE = 1000 * 1000 * 4; // 4 Megabyte
 
-    if (remoteContent.byteLength <= RANGE_SIZE) {
+    if (remoteContent.byteLength < DIRECT_UPLOAD_MAX_SIZE) {
       // directly using put!
       await client.putArrayBuffer(
         `${uploadFile}:/content?${new URLSearchParams({
@@ -751,7 +762,7 @@ export const uploadToRemote = async (
       // ref: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createuploadsession?view=odsp-graph-online
 
       // 1. create uploadSession
-      // uploadFile already starts with /drive/special/approot:/${vaultName}
+      // uploadFile already starts with /drive/special/approot:/${remoteBaseDir}
       const s: UploadSession = await client.postJson(
         `${uploadFile}:/createUploadSession`,
         {
@@ -792,12 +803,12 @@ const downloadFromRemoteRaw = async (
   fileOrFolderPath: string
 ): Promise<ArrayBuffer> => {
   await client.init();
-  const key = getOnedrivePath(fileOrFolderPath, client.vaultName);
+  const key = getOnedrivePath(fileOrFolderPath, client.remoteBaseDir);
   const rsp = await client.getJson(
     `${key}?$select=@microsoft.graph.downloadUrl`
   );
   const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
-  if (requireApiVersion(API_VER_REQURL)) {
+  if (VALID_REQURL) {
     const content = (await requestUrl({ url: downloadUrl })).arrayBuffer;
     return content;
   } else {
@@ -832,7 +843,7 @@ export const downloadFromRemote = async (
     if (password !== "") {
       downloadFile = remoteEncryptedKey;
     }
-    downloadFile = getOnedrivePath(downloadFile, client.vaultName);
+    downloadFile = getOnedrivePath(downloadFile, client.remoteBaseDir);
     const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
     let localContent = remoteContent;
     if (password !== "") {
@@ -860,17 +871,24 @@ export const deleteFromRemote = async (
   if (password !== "") {
     remoteFileName = remoteEncryptedKey;
   }
-  remoteFileName = getOnedrivePath(remoteFileName, client.vaultName);
+  remoteFileName = getOnedrivePath(remoteFileName, client.remoteBaseDir);
 
   await client.init();
   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

@@ -22,15 +22,14 @@ import { buildQueryString } from "@aws-sdk/querystring-builder";
 import { HeaderBag, HttpHandlerOptions, Provider } from "@aws-sdk/types";
 import { Buffer } from "buffer";
 import * as mime from "mime-types";
-import {
+import { Vault, requestUrl, RequestUrlParam } from "obsidian";
-  Vault,
-  requestUrl,
-  RequestUrlParam,
-  RequestUrlResponse,
-  requireApiVersion,
-} from "obsidian";
 import { Readable } from "stream";
-import { API_VER_REQURL, RemoteItem, S3Config } from "./baseTypes";
+import {
+  DEFAULT_CONTENT_TYPE,
+  RemoteItem,
+  S3Config,
+  VALID_REQURL,
+} from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import {
   arrayBufferToBuffer,
@@ -40,8 +39,7 @@ import {
 
 export { S3Client } from "@aws-sdk/client-s3";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 ////////////////////////////////////////////////////////////////////////////////
 // special handler using Obsidian requestUrl
@@ -85,17 +83,25 @@ class ObsHttpHandler extends FetchHttpHandler {
     const body =
       method === "GET" || method === "HEAD" ? undefined : request.body;
 
-    const transformedHeaders = { ...request.headers };
+    const transformedHeaders: Record<string, string> = {};
-    delete transformedHeaders["host"];
+    for (const key of Object.keys(request.headers)) {
-    delete transformedHeaders["Host"];
+      const keyLower = key.toLowerCase();
-    delete transformedHeaders["content-length"];
+      if (keyLower === "host" || keyLower === "content-length") {
-    delete transformedHeaders["Content-Length"];
+        continue;
+      }
+      transformedHeaders[keyLower] = request.headers[key];
+    }
 
     let contentType: string = undefined;
     if (transformedHeaders["content-type"] !== undefined) {
       contentType = transformedHeaders["content-type"];
     }
 
+    if (transformedHeaders["cache-control"] === undefined) {
+      // every time is a new request
+      transformedHeaders["cache-control"] = "no-cache";
+    }
+
     let transformedBody: any = body;
     if (ArrayBuffer.isView(body)) {
       transformedBody = bufferToArrayBuffer(body);
@@ -111,6 +117,11 @@ class ObsHttpHandler extends FetchHttpHandler {
 
     const raceOfPromises = [
       requestUrl(param).then((rsp) => {
+        const headers = rsp.headers;
+        const headersLower: Record<string, string> = {};
+        for (const key of Object.keys(headers)) {
+          headersLower[key.toLowerCase()] = headers[key];
+        }
         const stream = new ReadableStream<Uint8Array>({
           start(controller) {
             controller.enqueue(new Uint8Array(rsp.arrayBuffer));
@@ -119,7 +130,7 @@ class ObsHttpHandler extends FetchHttpHandler {
         });
         return {
           response: new HttpResponse({
-            headers: rsp.headers,
+            headers: headersLower,
             statusCode: rsp.status,
             body: stream,
           }),
@@ -155,6 +166,7 @@ export const DEFAULT_S3_CONFIG = {
   s3BucketName: "",
   bypassCorsLocally: true,
   partsConcurrency: 20,
+  forcePathStyle: false,
 };
 
 export type S3ObjectType = _Object;
@@ -188,10 +200,11 @@ export const getS3Client = (s3Config: S3Config) => {
     endpoint = `https://${endpoint}`;
   }
 
-  if (requireApiVersion(API_VER_REQURL) && s3Config.bypassCorsLocally) {
+  if (VALID_REQURL && s3Config.bypassCorsLocally) {
     const s3Client = new S3Client({
       region: s3Config.s3Region,
       endpoint: endpoint,
+      forcePathStyle: s3Config.forcePathStyle,
       credentials: {
         accessKeyId: s3Config.s3AccessKeyID,
         secretAccessKey: s3Config.s3SecretAccessKey,
@@ -203,6 +216,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,
@@ -244,8 +258,6 @@ export const uploadToRemote = async (
   }
   const isFolder = fileOrFolderPath.endsWith("/");
 
-  const DEFAULT_CONTENT_TYPE = "application/octet-stream";
-
   if (isFolder && isRecursively) {
     throw Error("upload function doesn't implement recursive function yet!");
   } else if (isFolder && !isRecursively) {
@@ -495,7 +507,8 @@ export const deleteFromRemote = async (
  */
 export const checkConnectivity = async (
   s3Client: S3Client,
-  s3Config: S3Config
+  s3Config: S3Config,
+  callbackFunc?: any
 ) => {
   try {
     const results = await s3Client.send(
@@ -506,10 +519,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,16 +1,15 @@
 import { Buffer } from "buffer";
-import { Vault, request, requestUrl, requireApiVersion } from "obsidian";
+import { Vault, requestUrl } from "obsidian";
 
 import { Queue } from "@fyears/tsqueue";
 import chunk from "lodash/chunk";
 import flatten from "lodash/flatten";
 import { getReasonPhrase } from "http-status-codes";
-import { API_VER_REQURL, RemoteItem, WebdavConfig } from "./baseTypes";
+import { RemoteItem, VALID_REQURL, WebdavConfig } from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import { bufferToArrayBuffer, getPathFolder, mkdirpInVault } from "./misc";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 import type {
   FileStat,
@@ -20,7 +19,7 @@ import type {
   ResponseDataDetailed,
 } from "webdav/web";
 import { getPatcher } from "webdav/web";
-if (requireApiVersion(API_VER_REQURL)) {
+if (VALID_REQURL) {
   getPatcher().patch(
     "request",
     async (
@@ -119,37 +118,40 @@ export const DEFAULT_WEBDAV_CONFIG = {
   authType: "basic",
   manualRecursive: false,
   depth: "auto_unknown",
+  remoteBaseDir: "",
 } as WebdavConfig;
 
-const getWebdavPath = (fileOrFolderPath: string, vaultName: string) => {
+const getWebdavPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
   let key = fileOrFolderPath;
   if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
     // special
-    key = `/${vaultName}/`;
+    key = `/${remoteBaseDir}/`;
   }
   if (!fileOrFolderPath.startsWith("/")) {
-    key = `/${vaultName}/${fileOrFolderPath}`;
+    key = `/${remoteBaseDir}/${fileOrFolderPath}`;
   }
   return key;
 };
 
-const getNormPath = (fileOrFolderPath: string, vaultName: string) => {
+const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
   if (
     !(
-      fileOrFolderPath === `/${vaultName}` ||
+      fileOrFolderPath === `/${remoteBaseDir}` ||
-      fileOrFolderPath.startsWith(`/${vaultName}/`)
+      fileOrFolderPath.startsWith(`/${remoteBaseDir}/`)
     )
   ) {
-    throw Error(`"${fileOrFolderPath}" doesn't starts with "/${vaultName}/"`);
+    throw Error(
+      `"${fileOrFolderPath}" doesn't starts with "/${remoteBaseDir}/"`
+    );
   }
   // if (fileOrFolderPath.startsWith("/")) {
   //   return fileOrFolderPath.slice(1);
   // }
-  return fileOrFolderPath.slice(`/${vaultName}/`.length);
+  return fileOrFolderPath.slice(`/${remoteBaseDir}/`.length);
 };
 
-const fromWebdavItemToRemoteItem = (x: FileStat, vaultName: string) => {
+const fromWebdavItemToRemoteItem = (x: FileStat, remoteBaseDir: string) => {
-  let key = getNormPath(x.filename, vaultName);
+  let key = getNormPath(x.filename, remoteBaseDir);
   if (x.type === "directory" && !key.endsWith("/")) {
     key = `${key}/`;
   }
@@ -164,17 +166,17 @@ const fromWebdavItemToRemoteItem = (x: FileStat, vaultName: string) => {
 
 export class WrappedWebdavClient {
   webdavConfig: WebdavConfig;
-  vaultName: string;
+  remoteBaseDir: string;
   client: WebDAVClient;
   vaultFolderExists: boolean;
   saveUpdatedConfigFunc: () => Promise<any>;
   constructor(
     webdavConfig: WebdavConfig,
-    vaultName: string,
+    remoteBaseDir: string,
     saveUpdatedConfigFunc: () => Promise<any>
   ) {
     this.webdavConfig = webdavConfig;
-    this.vaultName = vaultName;
+    this.remoteBaseDir = remoteBaseDir;
     this.vaultFolderExists = false;
     this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
   }
@@ -204,13 +206,13 @@ export class WrappedWebdavClient {
     if (this.vaultFolderExists) {
       // pass
     } else {
-      const res = await this.client.exists(`/${this.vaultName}`);
+      const res = await this.client.exists(`/${this.remoteBaseDir}/`);
       if (res) {
         // log.info("remote vault folder exits!");
         this.vaultFolderExists = true;
       } else {
         log.info("remote vault folder not exists, creating");
-        await this.client.createDirectory(`/${this.vaultName}`);
+        await this.client.createDirectory(`/${this.remoteBaseDir}/`);
         log.info("remote vault folder created!");
         this.vaultFolderExists = true;
       }
@@ -220,10 +222,10 @@ export class WrappedWebdavClient {
     if (this.webdavConfig.depth === "auto_unknown") {
       let testPassed = false;
       try {
-        const res = await this.client.customRequest(`/${this.vaultName}`, {
+        const res = await this.client.customRequest(`/${this.remoteBaseDir}/`, {
           method: "PROPFIND",
           headers: {
-            Depth: "Infinity",
+            Depth: "infinity",
           },
           responseType: "text",
         });
@@ -239,13 +241,16 @@ export class WrappedWebdavClient {
       }
       if (!testPassed) {
         try {
-          const res = await this.client.customRequest(`/${this.vaultName}`, {
+          const res = await this.client.customRequest(
-            method: "PROPFIND",
+            `/${this.remoteBaseDir}/`,
-            headers: {
+            {
-              Depth: "1",
+              method: "PROPFIND",
-            },
+              headers: {
-            responseType: "text",
+                Depth: "1",
-          });
+              },
+              responseType: "text",
+            }
+          );
           testPassed = true;
           this.webdavConfig.depth = "auto_1";
           this.webdavConfig.manualRecursive = true;
@@ -269,12 +274,12 @@ export class WrappedWebdavClient {
 
 export const getWebdavClient = (
   webdavConfig: WebdavConfig,
-  vaultName: string,
+  remoteBaseDir: string,
   saveUpdatedConfigFunc: () => Promise<any>
 ) => {
   return new WrappedWebdavClient(
     webdavConfig,
-    vaultName,
+    remoteBaseDir,
     saveUpdatedConfigFunc
   );
 };
@@ -284,12 +289,12 @@ export const getRemoteMeta = async (
   fileOrFolderPath: string
 ) => {
   await client.init();
-  const remotePath = getWebdavPath(fileOrFolderPath, client.vaultName);
+  const remotePath = getWebdavPath(fileOrFolderPath, client.remoteBaseDir);
   // log.info(`remotePath = ${remotePath}`);
   const res = (await client.client.stat(remotePath, {
     details: false,
   })) as FileStat;
-  return fromWebdavItemToRemoteItem(res, client.vaultName);
+  return fromWebdavItemToRemoteItem(res, client.remoteBaseDir);
 };
 
 export const uploadToRemote = async (
@@ -307,7 +312,7 @@ export const uploadToRemote = async (
   if (password !== "") {
     uploadFile = remoteEncryptedKey;
   }
-  uploadFile = getWebdavPath(uploadFile, client.vaultName);
+  uploadFile = getWebdavPath(uploadFile, client.remoteBaseDir);
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
@@ -321,7 +326,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;
@@ -353,11 +358,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) => {
@@ -385,7 +391,7 @@ export const listFromRemote = async (
   ) {
     // the remote doesn't support infinity propfind,
     // we need to do a bfs here
-    const q = new Queue([`/${client.vaultName}`]);
+    const q = new Queue([`/${client.remoteBaseDir}`]);
     const CHUNK_SIZE = 10;
     while (q.length > 0) {
       const itemsToFetch = [];
@@ -420,7 +426,7 @@ export const listFromRemote = async (
   } else {
     // the remote supports infinity propfind
     contents = (await client.client.getDirectoryContents(
-      `/${client.vaultName}`,
+      `/${client.remoteBaseDir}`,
       {
         deep: true,
         details: false /* no need for verbose details here */,
@@ -433,7 +439,7 @@ export const listFromRemote = async (
   }
   return {
     Contents: contents.map((x) =>
-      fromWebdavItemToRemoteItem(x, client.vaultName)
+      fromWebdavItemToRemoteItem(x, client.remoteBaseDir)
     ),
   };
 };
@@ -444,7 +450,7 @@ const downloadFromRemoteRaw = async (
 ) => {
   await client.init();
   const buff = (await client.client.getFileContents(
-    getWebdavPath(fileOrFolderPath, client.vaultName)
+    getWebdavPath(fileOrFolderPath, client.remoteBaseDir)
   )) as BufferLike;
   if (buff instanceof ArrayBuffer) {
     return buff;
@@ -483,7 +489,7 @@ export const downloadFromRemote = async (
     if (password !== "") {
       downloadFile = remoteEncryptedKey;
     }
-    downloadFile = getWebdavPath(downloadFile, client.vaultName);
+    downloadFile = getWebdavPath(downloadFile, client.remoteBaseDir);
     const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
     let localContent = remoteContent;
     if (password !== "") {
@@ -511,7 +517,7 @@ export const deleteFromRemote = async (
   if (password !== "") {
     remoteFileName = remoteEncryptedKey;
   }
-  remoteFileName = getWebdavPath(remoteFileName, client.vaultName);
+  remoteFileName = getWebdavPath(remoteFileName, client.remoteBaseDir);
 
   await client.init();
   try {
@@ -523,15 +529,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/settings.ts

@@ -7,18 +7,29 @@ import {
   Platform,
   requireApiVersion,
 } from "obsidian";
+import type { TextComponent } from "obsidian";
+import { createElement, Eye, EyeOff } from "lucide";
 import {
   API_VER_REQURL,
+  DEFAULT_DEBUG_FOLDER,
   SUPPORTED_SERVICES_TYPE,
+  SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR,
+  VALID_REQURL,
   WebdavAuthType,
   WebdavDepthType,
 } from "./baseTypes";
-import { exportVaultSyncPlansToFiles } from "./debugMode";
+import {
+  exportVaultSyncPlansToFiles,
+  exportVaultLoggerOutputToFiles,
+} from "./debugMode";
 import { exportQrCodeUri } from "./importExport";
 import {
   clearAllSyncMetaMapping,
   clearAllSyncPlanRecords,
   destroyDBs,
+  clearAllLoggerOutputRecords,
+  insertLoggerOutputByVault,
+  clearExpiredLoggerOutputRecords,
 } from "./localdb";
 import type RemotelySavePlugin from "./main"; // unavoidable
 import { RemoteClient } from "./remote";
@@ -34,9 +45,14 @@ import {
 } from "./remoteForOnedrive";
 import { messyConfigToNormal } from "./configPersist";
 import type { TransItemType } from "./i18n";
+import { checkHasSpecialCharForDir } from "./misc";
+import { applyWebdavPresetRulesInplace } from "./presetRules";
 
-import * as origLog from "loglevel";
+import {
-const log = origLog.getLogger("rs-default");
+  applyLogWriterInplace,
+  log,
+  restoreLogWritterInplace,
+} from "./moreOnLog";
 
 class PasswordModal extends Modal {
   plugin: RemotelySavePlugin;
@@ -108,6 +124,100 @@ class PasswordModal extends Modal {
   }
 }
 
+class ChangeRemoteBaseDirModal extends Modal {
+  readonly plugin: RemotelySavePlugin;
+  readonly newRemoteBaseDir: string;
+  readonly service: SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR;
+  constructor(
+    app: App,
+    plugin: RemotelySavePlugin,
+    newRemoteBaseDir: string,
+    service: SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR
+  ) {
+    super(app);
+    this.plugin = plugin;
+    this.newRemoteBaseDir = newRemoteBaseDir;
+    this.service = service;
+  }
+
+  onOpen() {
+    let { contentEl } = this;
+
+    const t = (x: TransItemType, vars?: any) => {
+      return this.plugin.i18n.t(x, vars);
+    };
+
+    contentEl.createEl("h2", { text: t("modal_remotebasedir_title") });
+    t("modal_remotebasedir_shortdesc")
+      .split("\n")
+      .forEach((val, idx) => {
+        contentEl.createEl("p", {
+          text: val,
+        });
+      });
+
+    if (
+      this.newRemoteBaseDir === "" ||
+      this.newRemoteBaseDir === this.app.vault.getName()
+    ) {
+      new Setting(contentEl)
+        .addButton((button) => {
+          button.setButtonText(
+            t("modal_remotebasedir_secondconfirm_vaultname")
+          );
+          button.onClick(async () => {
+            // in the settings, the value is reset to the special case ""
+            this.plugin.settings[this.service].remoteBaseDir = "";
+            await this.plugin.saveSettings();
+            new Notice(t("modal_remotebasedir_notice"));
+            this.close();
+          });
+          button.setClass("remotebasedir-second-confirm");
+        })
+        .addButton((button) => {
+          button.setButtonText(t("goback"));
+          button.onClick(() => {
+            this.close();
+          });
+        });
+    } else if (checkHasSpecialCharForDir(this.newRemoteBaseDir)) {
+      contentEl.createEl("p", {
+        text: t("modal_remotebasedir_invaliddirhint"),
+      });
+      new Setting(contentEl).addButton((button) => {
+        button.setButtonText(t("goback"));
+        button.onClick(() => {
+          this.close();
+        });
+      });
+    } else {
+      new Setting(contentEl)
+        .addButton((button) => {
+          button.setButtonText(t("modal_remotebasedir_secondconfirm_change"));
+          button.onClick(async () => {
+            this.plugin.settings[this.service].remoteBaseDir =
+              this.newRemoteBaseDir;
+            await this.plugin.saveSettings();
+            new Notice(t("modal_remotebasedir_notice"));
+            this.close();
+          });
+          button.setClass("remotebasedir-second-confirm");
+        })
+        .addButton((button) => {
+          button.setButtonText(t("goback"));
+          button.onClick(() => {
+            this.close();
+          });
+        });
+    }
+  }
+
+  onClose() {
+    let { contentEl } = this;
+    contentEl.empty();
+  }
+}
+
 class DropboxAuthModal extends Modal {
   readonly plugin: RemotelySavePlugin;
   readonly authDiv: HTMLDivElement;
@@ -519,8 +629,34 @@ class ExportSettingsQrCodeModal extends Modal {
   }
 }
 
+const getEyesElements = () => {
+  const eyeEl = createElement(Eye);
+  const eyeOffEl = createElement(EyeOff);
+  return {
+    eye: eyeEl.outerHTML,
+    eyeOff: eyeOffEl.outerHTML,
+  };
+};
+
+const wrapTextWithPasswordHide = (text: TextComponent) => {
+  const { eye, eyeOff } = getEyesElements();
+  const hider = text.inputEl.insertAdjacentElement("afterend", createSpan());
+  // the init type of hider is "hidden" === eyeOff === password
+  hider.innerHTML = eyeOff;
+  hider.addEventListener("click", (e) => {
+    const isText = text.inputEl.getAttribute("type") === "text";
+    hider.innerHTML = isText ? eyeOff : eye;
+    text.inputEl.setAttribute("type", isText ? "password" : "text");
+    text.inputEl.focus();
+  });
+
+  // the init type of text el is password
+  text.inputEl.setAttribute("type", "password");
+  return text;
+};
+
 export class RemotelySaveSettingTab extends PluginSettingTab {
-  plugin: RemotelySavePlugin;
+  readonly plugin: RemotelySavePlugin;
 
   constructor(app: App, plugin: RemotelySavePlugin) {
     super(app, plugin);
@@ -550,14 +686,15 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
     new Setting(passwordDiv)
       .setName(t("settings_password"))
       .setDesc(t("settings_password_desc"))
-      .addText((text) =>
+      .addText((text) => {
+        wrapTextWithPasswordHide(text);
         text
           .setPlaceholder("")
           .setValue(`${this.plugin.settings.password}`)
           .onChange(async (value) => {
             newPassword = value.trim();
-          })
+          });
-      )
+      })
       .addButton(async (button) => {
         button.setButtonText(t("confirm"));
         button.onClick(async () => {
@@ -609,6 +746,10 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       .setDesc(t("settings_runoncestartup_desc"))
       .addDropdown((dropdown) => {
         dropdown.addOption("-1", t("settings_runoncestartup_notset"));
+        dropdown.addOption(
+          `${1000 * 1 * 1}`,
+          t("settings_runoncestartup_1sec")
+        );
         dropdown.addOption(
           `${1000 * 10 * 1}`,
           t("settings_runoncestartup_10sec")
@@ -651,7 +792,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       });
     }
 
-    if (!requireApiVersion(API_VER_REQURL)) {
+    if (!VALID_REQURL) {
       s3Div.createEl("p", {
         text: t("settings_s3_cors"),
       });
@@ -673,7 +814,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       text: t("settings_s3_prod2"),
     });
 
-    if (!requireApiVersion(API_VER_REQURL)) {
+    if (!VALID_REQURL) {
       s3LinksUl.createEl("li").createEl("a", {
         href: "https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html",
         text: t("settings_s3_prod3"),
@@ -708,29 +849,31 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
 
     new Setting(s3Div)
       .setName(t("settings_s3_accesskeyid"))
-      .setDesc(t("settings_s3_accesskeyid"))
+      .setDesc(t("settings_s3_accesskeyid_desc"))
-      .addText((text) =>
+      .addText((text) => {
+        wrapTextWithPasswordHide(text);
         text
           .setPlaceholder("")
           .setValue(`${this.plugin.settings.s3.s3AccessKeyID}`)
           .onChange(async (value) => {
             this.plugin.settings.s3.s3AccessKeyID = value.trim();
             await this.plugin.saveSettings();
-          })
+          });
-      );
+      });
 
     new Setting(s3Div)
       .setName(t("settings_s3_secretaccesskey"))
-      .setDesc(t("settings_s3_secretaccesskey"))
+      .setDesc(t("settings_s3_secretaccesskey_desc"))
-      .addText((text) =>
+      .addText((text) => {
+        wrapTextWithPasswordHide(text);
         text
           .setPlaceholder("")
           .setValue(`${this.plugin.settings.s3.s3SecretAccessKey}`)
           .onChange(async (value) => {
             this.plugin.settings.s3.s3SecretAccessKey = value.trim();
             await this.plugin.saveSettings();
-          })
+          });
-      );
+      });
 
     new Setting(s3Div)
       .setName(t("settings_s3_bucketname"))
@@ -745,14 +888,31 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
           })
       );
 
-    if (requireApiVersion(API_VER_REQURL)) {
+    new Setting(s3Div)
+      .setName(t("settings_s3_urlstyle"))
+      .setDesc(t("settings_s3_urlstyle_desc"))
+      .addDropdown((dropdown) => {
+        dropdown.addOption(
+          "virtualHostedStyle",
+          "Virtual Hosted-Style (default)"
+        );
+        dropdown.addOption("pathStyle", "Path-Style");
+        dropdown
+          .setValue(
+            this.plugin.settings.s3.forcePathStyle
+              ? "pathStyle"
+              : "virtualHostedStyle"
+          )
+          .onChange(async (val: string) => {
+            this.plugin.settings.s3.forcePathStyle = val === "pathStyle";
+            await this.plugin.saveSettings();
+          });
+      });
+
+    if (VALID_REQURL) {
       new Setting(s3Div)
         .setName(t("settings_s3_bypasscorslocally"))
-        .setDesc(
+        .setDesc(t("settings_s3_bypasscorslocally_desc"))
-          t("settings_s3_bypasscorslocally_desc", {
-            ver: API_VER_REQURL,
-          })
-        )
         .addDropdown((dropdown) => {
           dropdown
             .addOption("disable", t("disable"))
@@ -805,11 +965,15 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         button.onClick(async () => {
           new Notice(t("settings_checkonnectivity_checking"));
           const client = new RemoteClient("s3", this.plugin.settings.s3);
-          const res = await client.checkConnectivity();
+          const errors = { msg: "" };
+          const res = await client.checkConnectivity((err: any) => {
+            errors.msg = err;
+          });
           if (res) {
             new Notice(t("settings_s3_connect_succ"));
           } else {
             new Notice(t("settings_s3_connect_fail"));
+            new Notice(errors.msg);
           }
         });
       });
@@ -836,7 +1000,9 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
     dropboxDiv.createEl("p", {
       text: t("settings_dropbox_folder", {
         pluginID: this.plugin.manifest.id,
-        vaultName: this.app.vault.getName(),
+        remoteBaseDir:
+          this.plugin.settings.dropbox.remoteBaseDir ||
+          this.app.vault.getName(),
       }),
     });
 
@@ -890,6 +1056,28 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         });
       });
 
+    new Setting(dropboxRevokeAuthDiv)
+      .setName(t("settings_dropbox_clearlocal"))
+      .setDesc(t("settings_dropbox_clearlocal_desc"))
+      .addButton(async (button) => {
+        button.setButtonText(t("settings_dropbox_clearlocal_button"));
+        button.onClick(async () => {
+          this.plugin.settings.dropbox = JSON.parse(
+            JSON.stringify(DEFAULT_DROPBOX_CONFIG)
+          );
+          await this.plugin.saveSettings();
+          dropboxAuthDiv.toggleClass(
+            "dropbox-auth-button-hide",
+            this.plugin.settings.dropbox.username !== ""
+          );
+          dropboxRevokeAuthDiv.toggleClass(
+            "dropbox-revoke-auth-button-hide",
+            this.plugin.settings.dropbox.username === ""
+          );
+          new Notice(t("settings_dropbox_clearlocal_notice"));
+        });
+      });
+
     new Setting(dropboxAuthDiv)
       .setName(t("settings_dropbox_auth"))
       .setDesc(t("settings_dropbox_auth_desc"))
@@ -920,6 +1108,31 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       this.plugin.settings.dropbox.username === ""
     );
 
+    let newDropboxRemoteBaseDir =
+      this.plugin.settings.dropbox.remoteBaseDir || "";
+    new Setting(dropboxDiv)
+      .setName(t("settings_remotebasedir"))
+      .setDesc(t("settings_remotebasedir_desc"))
+      .addText((text) =>
+        text
+          .setPlaceholder(this.app.vault.getName())
+          .setValue(newDropboxRemoteBaseDir)
+          .onChange((value) => {
+            newDropboxRemoteBaseDir = value.trim();
+          })
+      )
+      .addButton((button) => {
+        button.setButtonText(t("confirm"));
+        button.onClick(() => {
+          new ChangeRemoteBaseDirModal(
+            this.app,
+            this.plugin,
+            newDropboxRemoteBaseDir,
+            "dropbox"
+          ).open();
+        });
+      });
+
     new Setting(dropboxDiv)
       .setName(t("settings_checkonnectivity"))
       .setDesc(t("settings_checkonnectivity_desc"))
@@ -938,11 +1151,15 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
             () => self.plugin.saveSettings()
           );
 
-          const res = await client.checkConnectivity();
+          const errors = { msg: "" };
+          const res = await client.checkConnectivity((err: any) => {
+            errors.msg = `${err}`;
+          });
           if (res) {
             new Notice(t("settings_dropbox_connect_succ"));
           } else {
             new Notice(t("settings_dropbox_connect_fail"));
+            new Notice(errors.msg);
           }
         });
       });
@@ -970,7 +1187,9 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
     onedriveDiv.createEl("p", {
       text: t("settings_onedrive_folder", {
         pluginID: this.plugin.manifest.id,
-        vaultName: this.app.vault.getName(),
+        remoteBaseDir:
+          this.plugin.settings.onedrive.remoteBaseDir ||
+          this.app.vault.getName(),
       }),
     });
 
@@ -1035,6 +1254,31 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       this.plugin.settings.onedrive.username === ""
     );
 
+    let newOnedriveRemoteBaseDir =
+      this.plugin.settings.onedrive.remoteBaseDir || "";
+    new Setting(onedriveDiv)
+      .setName(t("settings_remotebasedir"))
+      .setDesc(t("settings_remotebasedir_desc"))
+      .addText((text) =>
+        text
+          .setPlaceholder(this.app.vault.getName())
+          .setValue(newOnedriveRemoteBaseDir)
+          .onChange((value) => {
+            newOnedriveRemoteBaseDir = value.trim();
+          })
+      )
+      .addButton((button) => {
+        button.setButtonText(t("confirm"));
+        button.onClick(() => {
+          new ChangeRemoteBaseDirModal(
+            this.app,
+            this.plugin,
+            newOnedriveRemoteBaseDir,
+            "onedrive"
+          ).open();
+        });
+      });
+
     new Setting(onedriveDiv)
       .setName(t("settings_checkonnectivity"))
       .setDesc(t("settings_checkonnectivity_desc"))
@@ -1053,11 +1297,15 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
             () => self.plugin.saveSettings()
           );
 
-          const res = await client.checkConnectivity();
+          const errors = { msg: "" };
+          const res = await client.checkConnectivity((err: any) => {
+            errors.msg = `${err}`;
+          });
           if (res) {
             new Notice(t("settings_onedrive_connect_succ"));
           } else {
             new Notice(t("settings_onedrive_connect_fail"));
+            new Notice(errors.msg);
           }
         });
       });
@@ -1079,7 +1327,11 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       cls: "webdav-disclaimer",
     });
 
-    if (!requireApiVersion(API_VER_REQURL)) {
+    if (!VALID_REQURL) {
+      webdavDiv.createEl("p", {
+        text: t("settings_webdav_cors_os"),
+      });
+
       webdavDiv.createEl("p", {
         text: t("settings_webdav_cors"),
       });
@@ -1087,7 +1339,8 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
 
     webdavDiv.createEl("p", {
       text: t("settings_webdav_folder", {
-        vaultName: this.app.vault.getName(),
+        remoteBaseDir:
+          this.plugin.settings.webdav.remoteBaseDir || this.app.vault.getName(),
       }),
     });
 
@@ -1100,6 +1353,17 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
           .setValue(this.plugin.settings.webdav.address)
           .onChange(async (value) => {
             this.plugin.settings.webdav.address = value.trim();
+            if (
+              this.plugin.settings.webdav.depth === "auto_1" ||
+              this.plugin.settings.webdav.depth === "auto_infinity"
+            ) {
+              this.plugin.settings.webdav.depth = "auto_unknown";
+            }
+
+            // TODO: any more elegant way?
+            applyWebdavPresetRulesInplace(this.plugin.settings.webdav);
+
+            // normally saved
             await this.plugin.saveSettings();
           })
       );
@@ -1107,43 +1371,54 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
     new Setting(webdavDiv)
       .setName(t("settings_webdav_user"))
       .setDesc(t("settings_webdav_user_desc"))
-      .addText((text) =>
+      .addText((text) => {
+        wrapTextWithPasswordHide(text);
         text
           .setPlaceholder("")
           .setValue(this.plugin.settings.webdav.username)
           .onChange(async (value) => {
             this.plugin.settings.webdav.username = value.trim();
+            if (
+              this.plugin.settings.webdav.depth === "auto_1" ||
+              this.plugin.settings.webdav.depth === "auto_infinity"
+            ) {
+              this.plugin.settings.webdav.depth = "auto_unknown";
+            }
             await this.plugin.saveSettings();
-          })
+          });
-      );
+      });
 
     new Setting(webdavDiv)
       .setName(t("settings_webdav_password"))
       .setDesc(t("settings_webdav_password_desc"))
-      .addText((text) =>
+      .addText((text) => {
+        wrapTextWithPasswordHide(text);
         text
           .setPlaceholder("")
           .setValue(this.plugin.settings.webdav.password)
           .onChange(async (value) => {
             this.plugin.settings.webdav.password = value.trim();
+            if (
+              this.plugin.settings.webdav.depth === "auto_1" ||
+              this.plugin.settings.webdav.depth === "auto_infinity"
+            ) {
+              this.plugin.settings.webdav.depth = "auto_unknown";
+            }
             await this.plugin.saveSettings();
-          })
+          });
-      );
+      });
 
     new Setting(webdavDiv)
       .setName(t("settings_webdav_auth"))
       .setDesc(t("settings_webdav_auth_desc"))
       .addDropdown(async (dropdown) => {
         dropdown.addOption("basic", "basic");
-        if (requireApiVersion(API_VER_REQURL)) {
+        if (VALID_REQURL) {
           dropdown.addOption("digest", "digest");
         }
 
         // new version config, copied to old version, we need to reset it
-        if (
+        if (!VALID_REQURL && this.plugin.settings.webdav.authType !== "basic") {
-          !requireApiVersion(API_VER_REQURL) &&
-          this.plugin.settings.webdav.authType !== "basic"
-        ) {
           this.plugin.settings.webdav.authType = "basic";
           await this.plugin.saveSettings();
         }
@@ -1188,10 +1463,40 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
             this.plugin.settings.webdav.depth = "manual_infinity";
             this.plugin.settings.webdav.manualRecursive = false;
           }
+
+          // TODO: any more elegant way?
+          applyWebdavPresetRulesInplace(this.plugin.settings.webdav);
+
+          // normally save
           await this.plugin.saveSettings();
         });
       });
 
+    let newWebdavRemoteBaseDir =
+      this.plugin.settings.webdav.remoteBaseDir || "";
+    new Setting(webdavDiv)
+      .setName(t("settings_remotebasedir"))
+      .setDesc(t("settings_remotebasedir_desc"))
+      .addText((text) =>
+        text
+          .setPlaceholder(this.app.vault.getName())
+          .setValue(newWebdavRemoteBaseDir)
+          .onChange((value) => {
+            newWebdavRemoteBaseDir = value.trim();
+          })
+      )
+      .addButton((button) => {
+        button.setButtonText(t("confirm"));
+        button.onClick(() => {
+          new ChangeRemoteBaseDirModal(
+            this.app,
+            this.plugin,
+            newWebdavRemoteBaseDir,
+            "webdav"
+          ).open();
+        });
+      });
+
     new Setting(webdavDiv)
       .setName(t("settings_checkonnectivity"))
       .setDesc(t("settings_checkonnectivity_desc"))
@@ -1209,20 +1514,19 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
             this.app.vault.getName(),
             () => self.plugin.saveSettings()
           );
-          const res = await client.checkConnectivity();
+          const errors = { msg: "" };
+          const res = await client.checkConnectivity((err: any) => {
+            errors.msg = `${err}`;
+          });
           if (res) {
             new Notice(t("settings_webdav_connect_succ"));
           } else {
-            let corsErrMsg = "/CORS";
+            if (VALID_REQURL) {
-            if (requireApiVersion(API_VER_REQURL)) {
+              new Notice(t("settings_webdav_connect_fail"));
-              corsErrMsg = "";
+            } else {
+              new Notice(t("settings_webdav_connect_fail_withcors"));
             }
-
+            new Notice(errors.msg);
-            new Notice(
-              t("settings_webdav_connect_fail", {
-                corsErrMsg: corsErrMsg,
-              })
-            );
           }
         });
       });
@@ -1334,15 +1638,10 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
           .onChange(async (val) => {
             if (val === "enable" && !bridge.secondConfirm) {
               dropdown.setValue("disable");
-              const modal = new SyncConfigDirModal(
+              new SyncConfigDirModal(this.app, this.plugin, () => {
-                this.app,
+                bridge.secondConfirm = true;
-                this.plugin,
+                dropdown.setValue("enable");
-                () => {
+              }).open();
-                  bridge.secondConfirm = true;
-                  dropdown.setValue("enable");
-                }
-              );
-              modal.open();
             } else {
               bridge.secondConfirm = false;
               this.plugin.settings.syncConfigDir = false;
@@ -1406,11 +1705,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         button.setButtonText(t("settings_outputsettingsconsole_button"));
         button.onClick(async () => {
           const c = messyConfigToNormal(await this.plugin.loadData());
-          if (c.currLogLevel === "debug") {
+          log.info(c);
-            // no need to ouput it again because debug mode already output it
-          } else {
-            log.info(c);
-          }
           new Notice(t("settings_outputsettingsconsole_notice"));
         });
       });
@@ -1419,12 +1714,25 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       .setName(t("settings_syncplans"))
       .setDesc(t("settings_syncplans_desc"))
       .addButton(async (button) => {
-        button.setButtonText(t("settings_syncplans_button"));
+        button.setButtonText(t("settings_syncplans_button_json"));
         button.onClick(async () => {
           await exportVaultSyncPlansToFiles(
             this.plugin.db,
             this.app.vault,
-            this.plugin.settings.vaultRandomID
+            this.plugin.vaultRandomID,
+            "json"
+          );
+          new Notice(t("settings_syncplans_notice"));
+        });
+      })
+      .addButton(async (button) => {
+        button.setButtonText(t("settings_syncplans_button_table"));
+        button.onClick(async () => {
+          await exportVaultSyncPlansToFiles(
+            this.plugin.db,
+            this.app.vault,
+            this.plugin.vaultRandomID,
+            "table"
           );
           new Notice(t("settings_syncplans_notice"));
         });
@@ -1440,6 +1748,64 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         });
       });
 
+    const logToDBDiv = debugDiv.createEl("div");
+    new Setting(logToDBDiv)
+      .setName(t("settings_logtodb"))
+      .setDesc(t("settings_logtodb_desc"))
+      .addDropdown(async (dropdown) => {
+        dropdown.addOption("enable", t("enable"));
+        dropdown.addOption("disable", t("disable"));
+        dropdown
+          .setValue(this.plugin.settings.logToDB ? "enable" : "disable")
+          .onChange(async (val: string) => {
+            const logToDB = val === "enable";
+            if (logToDB) {
+              applyLogWriterInplace((...msg: any[]) => {
+                insertLoggerOutputByVault(
+                  this.plugin.db,
+                  this.plugin.vaultRandomID,
+                  ...msg
+                );
+              });
+            } else {
+              restoreLogWritterInplace();
+            }
+            clearExpiredLoggerOutputRecords(this.plugin.db);
+            this.plugin.settings.logToDB = logToDB;
+            await this.plugin.saveSettings();
+          });
+      });
+
+    new Setting(logToDBDiv)
+      .setName(t("settings_logtodbexport"))
+      .setDesc(
+        t("settings_logtodbexport_desc", {
+          debugFolder: DEFAULT_DEBUG_FOLDER,
+        })
+      )
+      .addButton(async (button) => {
+        button.setButtonText(t("settings_logtodbexport_button"));
+        button.onClick(async () => {
+          await exportVaultLoggerOutputToFiles(
+            this.plugin.db,
+            this.app.vault,
+            this.plugin.vaultRandomID
+          );
+          new Notice(t("settings_logtodbexport_notice"));
+        });
+      });
+
+    new Setting(logToDBDiv)
+      .setName(t("settings_logtodbclear"))
+      .setDesc(t("settings_logtodbclear_desc"))
+      .addButton(async (button) => {
+        button.setButtonText(t("settings_logtodbclear_button"));
+        button.onClick(async () => {
+          await clearAllLoggerOutputRecords(this.plugin.db);
+          new Notice(t("settings_logtodbclear_notice"));
+        });
+      });
+
     const syncMappingDiv = debugDiv.createEl("div");
     new Setting(syncMappingDiv)
       .setName(t("settings_delsyncmap"))
@@ -1452,6 +1818,18 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         });
       });
 
+    const outputCurrBasePathVaultIDDiv = debugDiv.createDiv("div");
+    new Setting(outputCurrBasePathVaultIDDiv)
+      .setName(t("settings_outputbasepathvaultid"))
+      .setDesc(t("settings_outputbasepathvaultid_desc"))
+      .addButton(async (button) => {
+        button.setButtonText(t("settings_outputbasepathvaultid_button"));
+        button.onClick(async () => {
+          new Notice(this.plugin.getVaultBasePath());
+          new Notice(this.plugin.vaultRandomID);
+        });
+      });
+
     const dbsResetDiv = debugDiv.createEl("div");
     new Setting(dbsResetDiv)
       .setName(t("settings_resetcache"))
@@ -1464,4 +1842,10 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         });
       });
   }
+
+  hide() {
+    let { containerEl } = this;
+    containerEl.empty();
+    super.hide();
+  }
 }

src/sync.ts

@@ -5,14 +5,16 @@ import {
   Vault,
   requireApiVersion,
 } from "obsidian";
+import AggregateError from "aggregate-error";
 import PQueue from "p-queue";
-import {
+import type {
   RemoteItem,
-  SUPPORTED_SERVICES_TYPE,
+  SyncTriggerSourceType,
   DecisionType,
   FileOrFolderMixedState,
-  API_VER_STAT_FOLDER,
+  SUPPORTED_SERVICES_TYPE,
 } from "./baseTypes";
+import { API_VER_STAT_FOLDER } from "./baseTypes";
 import {
   decryptBase32ToString,
   decryptBase64urlToString,
@@ -33,6 +35,7 @@ import {
   getFolderLevels,
   getParentFolder,
   atWhichLevel,
+  unixTimeToStr,
 } from "./misc";
 import { RemoteClient } from "./remote";
 import {
@@ -46,8 +49,7 @@ import {
 } from "./metadataOnRemote";
 import { isInsideObsFolder, ObsConfigDirFileType } from "./obsFolderLister";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 export type SyncStatusType =
   | "idle"
@@ -63,6 +65,8 @@ export type SyncStatusType =
 
 export interface SyncPlanType {
   ts: number;
+  tsFmt?: string;
+  syncTriggerSource?: SyncTriggerSourceType;
   remoteType: SUPPORTED_SERVICES_TYPE;
   mixedStates: Record<string, FileOrFolderMixedState>;
 }
@@ -212,22 +216,25 @@ export const parseRemoteItems = async (
     let r = {} as FileOrFolderMixedState;
     if (backwardMapping !== undefined) {
       key = backwardMapping.localKey;
+      const mtimeRemote = backwardMapping.localMtime || entry.lastModified;
       r = {
         key: key,
         existRemote: true,
-        mtimeRemote: backwardMapping.localMtime || entry.lastModified,
+        mtimeRemote: mtimeRemote,
+        mtimeRemoteFmt: unixTimeToStr(mtimeRemote),
         sizeRemote: backwardMapping.localSize || entry.size,
         remoteEncryptedKey: remoteEncryptedKey,
-        changeMtimeUsingMapping: true,
+        changeRemoteMtimeUsingMapping: true,
       };
     } else {
       r = {
         key: key,
         existRemote: true,
         mtimeRemote: entry.lastModified,
+        mtimeRemoteFmt: unixTimeToStr(entry.lastModified),
         sizeRemote: entry.size,
         remoteEncryptedKey: remoteEncryptedKey,
-        changeMtimeUsingMapping: false,
+        changeRemoteMtimeUsingMapping: false,
       };
     }
 
@@ -295,7 +302,7 @@ const ensembleMixedStates = async (
   local: TAbstractFile[],
   localConfigDirContents: ObsConfigDirFileType[] | undefined,
   remoteDeleteHistory: DeletionOnRemote[],
-  localDeleteHistory: FileFolderHistoryRecord[],
+  localFileHistory: FileFolderHistoryRecord[],
   syncConfigDir: boolean,
   configDir: string,
   syncUnderscoreItems: boolean
@@ -320,10 +327,12 @@ const ensembleMixedStates = async (
       // ignore
       continue;
     } else if (entry instanceof TFile) {
+      const mtimeLocal = Math.max(entry.stat.mtime || 0, entry.stat.ctime || 0);
       r = {
         key: entry.path,
         existLocal: true,
-        mtimeLocal: Math.max(entry.stat.mtime, entry.stat.ctime),
+        mtimeLocal: mtimeLocal,
+        mtimeLocalFmt: unixTimeToStr(mtimeLocal),
         sizeLocal: entry.stat.size,
       };
     } else if (entry instanceof TFolder) {
@@ -332,6 +341,7 @@ const ensembleMixedStates = async (
         key: key,
         existLocal: true,
         mtimeLocal: undefined,
+        mtimeLocalFmt: undefined,
         sizeLocal: 0,
       };
     } else {
@@ -346,6 +356,7 @@ const ensembleMixedStates = async (
       results[key].key = r.key;
       results[key].existLocal = r.existLocal;
       results[key].mtimeLocal = r.mtimeLocal;
+      results[key].mtimeLocalFmt = r.mtimeLocalFmt;
       results[key].sizeLocal = r.sizeLocal;
     } else {
       results[key] = r;
@@ -356,10 +367,12 @@ const ensembleMixedStates = async (
   if (syncConfigDir && localConfigDirContents !== undefined) {
     for (const entry of localConfigDirContents) {
       const key = entry.key;
+      const mtimeLocal = Math.max(entry.mtime, entry.ctime);
       const r: FileOrFolderMixedState = {
         key: key,
         existLocal: true,
-        mtimeLocal: Math.max(entry.mtime, entry.ctime),
+        mtimeLocal: mtimeLocal,
+        mtimeLocalFmt: unixTimeToStr(mtimeLocal),
         sizeLocal: entry.size,
       };
 
@@ -367,6 +380,7 @@ const ensembleMixedStates = async (
         results[key].key = r.key;
         results[key].existLocal = r.existLocal;
         results[key].mtimeLocal = r.mtimeLocal;
+        results[key].mtimeLocalFmt = r.mtimeLocalFmt;
         results[key].sizeLocal = r.sizeLocal;
       } else {
         results[key] = r;
@@ -380,6 +394,7 @@ const ensembleMixedStates = async (
     const r = {
       key: key,
       deltimeRemote: entry.actionWhen,
+      deltimeRemoteFmt: unixTimeToStr(entry.actionWhen),
     } as FileOrFolderMixedState;
 
     if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
@@ -389,6 +404,7 @@ const ensembleMixedStates = async (
     if (results.hasOwnProperty(key)) {
       results[key].key = r.key;
       results[key].deltimeRemote = r.deltimeRemote;
+      results[key].deltimeRemoteFmt = r.deltimeRemoteFmt;
     } else {
       results[key] = r;
 
@@ -397,7 +413,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("/")) {
@@ -409,23 +425,56 @@ const ensembleMixedStates = async (
       throw Error(`unexpected ${entry}`);
     }
 
-    const r = {
-      key: key,
-      deltimeLocal: entry.actionWhen,
-    } as FileOrFolderMixedState;
-
     if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
       continue;
     }
 
-    if (results.hasOwnProperty(key)) {
+    if (entry.actionType === "delete" || entry.actionType === "rename") {
-      results[key].key = r.key;
+      const r = {
-      results[key].deltimeLocal = r.deltimeLocal;
+        key: key,
-    } else {
+        deltimeLocal: entry.actionWhen,
-      results[key] = r;
+        deltimeLocalFmt: unixTimeToStr(entry.actionWhen),
+      } as FileOrFolderMixedState;
 
-      results[key].existLocal = false;
+      if (results.hasOwnProperty(key)) {
-      results[key].existRemote = false;
+        results[key].deltimeLocal = r.deltimeLocal;
+        results[key].deltimeLocalFmt = r.deltimeLocalFmt;
+      } else {
+        results[key] = r;
+        results[key].existLocal = false; // we have already checked local
+        results[key].existRemote = false; // we have already checked remote
+      }
+    } else if (entry.actionType === "renameDestination") {
+      const r = {
+        key: key,
+        mtimeLocal: entry.actionWhen,
+        mtimeLocalFmt: unixTimeToStr(entry.actionWhen),
+        changeLocalMtimeUsingMapping: true,
+      };
+      if (results.hasOwnProperty(key)) {
+        const mtimeLocal = Math.max(
+          r.mtimeLocal || 0,
+          results[key].mtimeLocal || 0
+        );
+        results[key].mtimeLocal = mtimeLocal;
+        results[key].mtimeLocalFmt = unixTimeToStr(mtimeLocal);
+        results[key].changeLocalMtimeUsingMapping =
+          r.changeLocalMtimeUsingMapping;
+      } else {
+        // So, the file doesn't exist,
+        // except that it existed in the "renamed to" history records.
+        // Most likely because that the user deleted the file while Obsidian was closed,
+        // so Obsidian could not track the deletions.
+        // We are not sure how to deal with this, so do not generate anything here!
+        // // // The following 3 lines are of old logic, and have been removed:
+        // // 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}`
+      );
     }
   }
 
@@ -450,34 +499,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
@@ -508,12 +565,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;
@@ -526,11 +583,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;
@@ -541,7 +598,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;
@@ -609,6 +666,31 @@ const assignOperationToFolderInplace = async (
         }
       }
 
+      // 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) {
@@ -670,8 +752,9 @@ export const getSyncPlan = async (
   local: TAbstractFile[],
   localConfigDirContents: ObsConfigDirFileType[] | undefined,
   remoteDeleteHistory: DeletionOnRemote[],
-  localDeleteHistory: FileFolderHistoryRecord[],
+  localFileHistory: FileFolderHistoryRecord[],
   remoteType: SUPPORTED_SERVICES_TYPE,
+  triggerSource: SyncTriggerSourceType,
   vault: Vault,
   syncConfigDir: boolean,
   configDir: string,
@@ -683,7 +766,7 @@ export const getSyncPlan = async (
     local,
     localConfigDirContents,
     remoteDeleteHistory,
-    localDeleteHistory,
+    localFileHistory,
     syncConfigDir,
     configDir,
     syncUnderscoreItems
@@ -738,9 +821,13 @@ export const getSyncPlan = async (
     }
   }
 
+  const currTs = Date.now();
+  const currTsFmt = unixTimeToStr(currTs);
   const plan = {
-    ts: Date.now(),
+    ts: currTs,
+    tsFmt: currTsFmt,
     remoteType: remoteType,
+    syncTriggerSource: triggerSource,
     mixedStates: mixedStates,
   } as SyncPlanType;
   return {
@@ -1080,6 +1167,8 @@ export const doActualSync = async (
       }
 
       const queue = new PQueue({ concurrency: concurrency, autoStart: true });
+      const potentialErrors: Error[] = [];
+      let tooManyErrors = false;
 
       for (let k = 0; k < singleLevelOps.length; ++k) {
         const val: FileOrFolderMixedState = singleLevelOps[k];
@@ -1112,10 +1201,28 @@ export const doActualSync = async (
 
           log.debug(`finished ${key}`);
         };
-        queue.add(fn);
+
+        queue.add(fn).catch((e) => {
+          const msg = `${key}: ${e.message}`;
+          potentialErrors.push(new Error(msg));
+          if (potentialErrors.length >= 3) {
+            tooManyErrors = true;
+            queue.pause();
+            queue.clear();
+          }
+        });
       }
 
       await queue.onIdle();
+
+      if (potentialErrors.length > 0) {
+        if (tooManyErrors) {
+          potentialErrors.push(
+            new Error("too many errors, stop the remaining tasks")
+          );
+        }
+        throw new AggregateError(potentialErrors);
+      }
     }
   }
 };

src/syncAlgoV2Notice.ts

@@ -1,8 +1,8 @@
 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");
+import { log } from "./moreOnLog";
 
 export class SyncAlgoV2Modal extends Modal {
   agree: boolean;

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

@@ -266,3 +266,22 @@ describe("Misc: at which level", () => {
     expect(misc.atWhichLevel("x/y/z.md")).to.be.equal(3);
   });
 });
+
+describe("Misc: special char for dir", () => {
+  it("should return false for normal string", () => {
+    expect(misc.checkHasSpecialCharForDir("")).to.be.false;
+    expect(misc.checkHasSpecialCharForDir("xxx")).to.be.false;
+    expect(misc.checkHasSpecialCharForDir("yyy_xxx")).to.be.false;
+    expect(misc.checkHasSpecialCharForDir("yyy.xxx")).to.be.false;
+    expect(misc.checkHasSpecialCharForDir("yyy？xxx")).to.be.false;
+  });
+
+  it("should return true for special cases", () => {
+    expect(misc.checkHasSpecialCharForDir("?")).to.be.true;
+    expect(misc.checkHasSpecialCharForDir("/")).to.be.true;
+    expect(misc.checkHasSpecialCharForDir("\\")).to.be.true;
+    expect(misc.checkHasSpecialCharForDir("xxx/yyy")).to.be.true;
+    expect(misc.checkHasSpecialCharForDir("xxx\\yyy")).to.be.true;
+    expect(misc.checkHasSpecialCharForDir("xxx?yyy")).to.be.true;
+  });
+});

tests/presetRules.test.ts

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

versions.json

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