0.3.28

Update services_connectable_or_not.md

.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/auto-build.yml

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

.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

.gitmodules

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

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

docs/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 policy.](./browser_env_cors.md)
+1. [The CORS issue (solved in the new Obsidian version on some platforms).](./browser_env_cors.md)
 2. [No Node.js environment.](./browser_env_no_nodejs.md)
 3. If the cloud service uses OAuth flow, it needs to support PKCE. More details are [here](./browser_env_oauth2_pkce.md).
 4. [No background running after Obsidian is closes.](./browser_env_no_background_after_closing.md)

docs/browser_env_cors.md

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

docs/dropbox_review_material/README.md

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

docs/dropbox_review_material/attachments/step03.png

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

docs/dropbox_review_material/attachments/step05.png

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

docs/dropbox_review_material/attachments/step06.png

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

docs/dropbox_review_material/attachments/step07.png

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

docs/dropbox_review_material/attachments/step08.png

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

docs/dropbox_review_material/attachments/step09.png

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

docs/dropbox_review_material/attachments/step10.png

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

docs/dropbox_review_material/attachments/step11.png

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

docs/dropbox_review_material/attachments/step12.png

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

docs/dropbox_review_material/attachments/step13.png

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

docs/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/remote_services/webdav_infinicloud_teracloud/README.md

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

docs/remote_services/webdav_infinicloud_teracloud/infinicloud_account.png

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

docs/remote_services/webdav_infinicloud_teracloud/infinicloud_rs_setting.png

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

docs/s3_cors_configure.md

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

docs/services_connectable_or_not.md

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

docs/sync_ignoring_large_files.md

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

esbuild.config.mjs

@@ -18,7 +18,7 @@ const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
 const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
 
 esbuild
-  .build({
+  .context({
     banner: {
       js: banner,
     },
@@ -31,13 +31,15 @@ esbuild
       "obsidian",
       "electron",
       "fs",
-      "crypto",
       "tls",
       "net",
+      "http",
+      "https",
       // ...builtins
     ],
+    inject: ["./esbuild.injecthelper.mjs"],
     format: "cjs",
-    watch: !prod,
+    // watch: !prod, // no longer valid in esbuild 0.17
     target: "es2016",
     logLevel: "info",
     sourcemap: prod ? false : "inline",
@@ -48,6 +50,20 @@ 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
     },
   })
+  .then((context) => {
+    if (process.argv.includes("--watch")) {
+      // Enable watch mode
+      context.watch();
+    } else {
+      // Build once and exit if not in watch mode
+      context.rebuild().then((result) => {
+        context.dispose();
+      });
+    }
+  })
   .catch(() => process.exit(1));

esbuild.injecthelper.mjs

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

manifest-beta.json

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

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "remotely-save",
   "name": "Remotely Save",
-  "version": "0.3.5",
+  "version": "0.3.25",
   "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,13 +1,13 @@
 {
   "name": "remotely-save",
-  "version": "0.3.5",
+  "version": "0.3.25",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
-    "dev2": "node esbuild.config.mjs",
+    "dev2": "node esbuild.config.mjs --watch",
     "build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
     "build": "webpack --mode production",
     "dev": "webpack --mode development --watch",
-    "format": "npx prettier --write .",
+    "format": "npx prettier --trailing-comma es5 --write .",
     "clean": "npx rimraf main.js",
     "test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'"
   },
@@ -23,70 +23,74 @@
   "author": "",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@microsoft/microsoft-graph-types": "^2.11.0",
+    "@microsoft/microsoft-graph-types": "^2.40.0",
-    "@types/chai": "^4.2.22",
+    "@types/chai": "^4.3.11",
-    "@types/chai-as-promised": "^7.1.4",
+    "@types/chai-as-promised": "^7.1.8",
-    "@types/feather-icons": "^4.7.0",
+    "@types/jsdom": "^21.1.6",
-    "@types/jsdom": "^16.2.13",
+    "@types/lodash": "^4.14.202",
-    "@types/lodash": "^4.14.178",
+    "@types/mime-types": "^2.1.4",
-    "@types/mime-types": "^2.1.1",
+    "@types/mocha": "^10.0.6",
-    "@types/mocha": "^9.0.0",
+    "@types/mustache": "^4.2.5",
-    "@types/node": "^14.14.37",
+    "@types/node": "^20.10.4",
-    "@types/qrcode": "^1.4.1",
+    "@types/qrcode": "^1.5.5",
-    "builtin-modules": "^3.2.0",
+    "builtin-modules": "^3.3.0",
-    "chai": "^4.3.4",
+    "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "cross-env": "^7.0.3",
-    "dotenv": "^10.0.0",
+    "dotenv": "^16.3.1",
-    "esbuild": "^0.14.3",
+    "esbuild": "^0.19.9",
-    "jsdom": "^19.0.0",
+    "jsdom": "^23.0.1",
-    "mocha": "^9.1.3",
+    "mocha": "^10.2.0",
-    "prettier": "^2.4.1",
+    "npm-check-updates": "^16.14.12",
-    "ts-loader": "^9.2.6",
+    "obsidian": "^1.4.11",
-    "ts-node": "^10.4.0",
+    "prettier": "^3.1.1",
-    "tslib": "^2.2.0",
+    "ts-loader": "^9.5.1",
-    "typescript": "^4.4.4",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3",
     "webdav-server": "^2.6.2",
-    "webpack": "^5.64.4",
+    "webpack": "^5.89.0",
-    "webpack-cli": "^4.9.1"
+    "webpack-cli": "^5.1.4"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.37.0",
+    "@aws-sdk/client-s3": "^3.474.0",
-    "@aws-sdk/fetch-http-handler": "^3.53.0",
+    "@aws-sdk/lib-storage": "^3.474.0",
-    "@aws-sdk/lib-storage": "^3.53.1",
+    "@aws-sdk/signature-v4-crt": "^3.474.0",
-    "@aws-sdk/protocol-http": "^3.53.0",
+    "@aws-sdk/types": "^3.468.0",
-    "@aws-sdk/querystring-builder": "^3.53.0",
+    "@azure/msal-node": "^2.6.0",
-    "@aws-sdk/signature-v4-crt": "^3.37.0",
-    "@aws-sdk/types": "^3.53.0",
-    "@azure/msal-node": "^1.6.0",
     "@fyears/tsqueue": "^1.0.1",
-    "@microsoft/microsoft-graph-client": "^3.0.1",
+    "@microsoft/microsoft-graph-client": "^3.0.7",
-    "acorn": "^8.5.0",
+    "@smithy/fetch-http-handler": "^2.3.1",
-    "assert": "^2.0.0",
+    "@smithy/protocol-http": "^3.0.11",
-    "aws-crt": "^1.10.1",
+    "@smithy/querystring-builder": "^2.0.15",
+    "acorn": "^8.11.2",
+    "aggregate-error": "^5.0.0",
+    "assert": "^2.1.0",
+    "aws-crt": "^1.20.0",
     "buffer": "^6.0.3",
-    "codemirror": "^5.63.1",
     "crypto-browserify": "^3.12.0",
-    "dropbox": "^10.22.0",
+    "delay": "^6.0.0",
-    "feather-icons": "^4.28.0",
+    "dropbox": "^10.34.0",
-    "http-status-codes": "^2.2.0",
+    "emoji-regex": "^10.3.0",
+    "http-status-codes": "^2.3.0",
     "localforage": "^1.10.0",
     "lodash": "^4.17.21",
-    "loglevel": "^1.8.0",
+    "loglevel": "^1.8.1",
-    "mime-types": "^2.1.33",
+    "lucide": "^0.298.0",
-    "nanoid": "^3.1.30",
+    "mime-types": "^2.1.35",
-    "obsidian": "^0.13.26",
+    "mustache": "^4.2.0",
-    "p-queue": "^7.2.0",
+    "nanoid": "^5.0.4",
+    "p-queue": "^8.0.1",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
-    "qrcode": "^1.5.0",
+    "qrcode": "^1.5.3",
-    "rfc4648": "^1.5.0",
+    "rfc4648": "^1.5.3",
-    "rimraf": "^3.0.2",
+    "rimraf": "^5.0.5",
     "stream-browserify": "^3.0.0",
-    "url": "^0.11.0",
+    "url": "^0.11.3",
-    "util": "^0.12.4",
+    "util": "^0.12.5",
-    "webdav": "^4.7.0",
+    "webdav": "^5.3.1",
-    "webdav-fs": "^4.0.0",
+    "webdav-fs": "^4.0.1",
-    "xregexp": "^5.1.0"
+    "xregexp": "^5.1.1"
   }
 }

src/baseTypes.ts

@@ -3,8 +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;
@@ -12,6 +22,8 @@ export interface S3Config {
   s3SecretAccessKey: string;
   s3BucketName: string;
   bypassCorsLocally?: boolean;
+  partsConcurrency?: number;
+  forcePathStyle?: boolean;
 }
 
 export interface DropboxConfig {
@@ -23,16 +35,25 @@ export interface DropboxConfig {
   accountID: string;
   username: string;
   credentialsShouldBeDeletedAtTime?: number;
+  remoteBaseDir?: string;
 }
 
 export type WebdavAuthType = "digest" | "basic";
+export type WebdavDepthType =
+  | "auto_unknown"
+  | "auto_1"
+  | "auto_infinity"
+  | "manual_1"
+  | "manual_infinity";
 
 export interface WebdavConfig {
   address: string;
   username: string;
   password: string;
   authType: WebdavAuthType;
-  manualRecursive: boolean;
+  manualRecursive: boolean; // deprecated in 0.3.6, use depth
+  depth?: WebdavDepthType;
+  remoteBaseDir?: string;
 }
 
 export interface OnedriveConfig {
@@ -45,6 +66,7 @@ export interface OnedriveConfig {
   deltaLink: string;
   username: string;
   credentialsShouldBeDeletedAtTime?: number;
+  remoteBaseDir?: string;
 }
 
 export interface RemotelySavePluginSettings {
@@ -55,11 +77,20 @@ export interface RemotelySavePluginSettings {
   password: string;
   serviceType: SUPPORTED_SERVICES_TYPE;
   currLogLevel?: string;
-  vaultRandomID?: string;
   autoRunEveryMilliseconds?: number;
   initRunAfterMilliseconds?: number;
   agreeToUploadExtraMetadata?: boolean;
   concurrency?: number;
+  syncConfigDir?: boolean;
+  syncUnderscoreItems?: boolean;
+  lang?: LangTypeAndAuto;
+  logToDB?: boolean;
+  skipSizeLargerThan?: number;
+
+  /**
+   * @deprecated
+   */
+  vaultRandomID?: string;
 }
 
 export interface RemoteItem {
@@ -92,13 +123,24 @@ type DecisionTypeForFile =
   | "uploadLocalToRemote" // "skipLocal && uploadLocalToRemote && cleanLocalDelHist && cleanRemoteDelHist"
   | "downloadRemoteToLocal"; // "downloadRemoteToLocal && skipRemote && cleanLocalDelHist && cleanRemoteDelHist"
 
+type DecisionTypeForFileSize =
+  | "skipUploadingTooLarge"
+  | "skipDownloadingTooLarge"
+  | "skipUsingLocalDelTooLarge"
+  | "skipUsingRemoteDelTooLarge"
+  | "errorLocalTooLargeConflictRemote"
+  | "errorRemoteTooLargeConflictLocal";
+
 type DecisionTypeForFolder =
   | "createFolder"
   | "uploadLocalDelHistToRemoteFolder"
   | "keepRemoteDelHistFolder"
   | "skipFolder";
 
-export type DecisionType = DecisionTypeForFile | DecisionTypeForFolder;
+export type DecisionType =
+  | DecisionTypeForFile
+  | DecisionTypeForFileSize
+  | DecisionTypeForFolder;
 
 export interface FileOrFolderMixedState {
   key: string;
@@ -109,13 +151,33 @@ export interface FileOrFolderMixedState {
   deltimeLocal?: number;
   deltimeRemote?: number;
   sizeLocal?: number;
+  sizeLocalEnc?: number;
   sizeRemote?: number;
-  changeMtimeUsingMapping?: boolean;
+  sizeRemoteEnc?: number;
+  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,85 @@
 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",
+    "sizeLocalEnc",
+    "mtimeLocal",
+    "deltimeLocal",
+    "changeLocalMtimeUsingMapping",
+    "existRemote",
+    "sizeRemote",
+    "sizeRemoteEnc",
+    "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 +88,16 @@ export const exportVaultSyncPlansToFiles = async (
   if (records.length === 0) {
     md = "No sync plans history found";
   } else {
+    if (toFormat === "json") {
       md =
         "Sync plans found:\n\n" +
         records.map((x) => "```json\n" + x + "\n```\n").join("\n");
+    } else if (toFormat === "table") {
+      md =
+        "Sync plans found:\n\n" + records.map(turnSyncPlanToTable).join("\n\n");
+    } else {
+      const _: never = toFormat;
+    }
   }
   const ts = Date.now();
   const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX}${ts}.md`;
@@ -34,3 +106,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,25 @@ export const decryptBase64urlToString = async (
     )
   );
 };
+
+export const getSizeFromOrigToEnc = (x: number) => {
+  if (x < 0 || Number.isNaN(x) || !Number.isInteger(x)) {
+    throw Error(`getSizeFromOrigToEnc: x=${x} is not a valid size`);
+  }
+  return (Math.floor(x / 16) + 1) * 16 + 16;
+};
+
+export const getSizeFromEncToOrig = (x: number) => {
+  if (x < 32 || Number.isNaN(x) || !Number.isInteger(x)) {
+    throw Error(`getSizeFromEncToOrig: ${x} is not a valid size`);
+  }
+  if (x % 16 !== 0) {
+    throw Error(
+      `getSizeFromEncToOrig: ${x} is not a valid encrypted file size`
+    );
+  }
+  return {
+    minSize: ((x - 16) / 16 - 1) * 16,
+    maxSize: ((x - 16) / 16 - 1) * 16 + 15,
+  };
+};

src/i18n.ts

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

src/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 { statFix, 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,15 @@ 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 +346,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 +360,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 +380,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 statFix(fileOrFolder.vault, 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 +520,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 +550,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,19 @@
-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";
+  FileOrFolderMixedState,
+  RemotelySavePluginSettings,
+  SyncTriggerSourceType,
+} from "./baseTypes";
 import {
   COMMAND_CALLBACK,
   COMMAND_CALLBACK_ONEDRIVE,
@@ -10,13 +21,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 {
@@ -37,11 +51,21 @@ import { RemotelySaveSettingTab } from "./settings";
 import { fetchMetadataFile, parseRemoteItems, SyncStatusType } from "./sync";
 import { doActualSync, getSyncPlan, isPasswordOk } from "./sync";
 import { messyConfigToNormal, normalConfigToMessy } from "./configPersist";
+import { ObsConfigDirFileType, listFilesInObsFolder } from "./obsFolderLister";
+import { I18n } from "./i18n";
+import type { LangType, LangTypeAndAuto, TransItemType } from "./i18n";
 
-import * as origLog from "loglevel";
 import { DeletionOnRemote, MetadataOnRemote } from "./metadataOnRemote";
 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";
+import { SizesConflictModal } from "./syncSizesConflictNotice";
 
 const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   s3: DEFAULT_S3_CONFIG,
@@ -51,11 +75,16 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   password: "",
   serviceType: "s3",
   currLogLevel: "info",
-  vaultRandomID: "",
+  // vaultRandomID: "", // deprecated
   autoRunEveryMilliseconds: -1,
   initRunAfterMilliseconds: -1,
   agreeToUploadExtraMetadata: false,
   concurrency: 5,
+  syncConfigDir: false,
+  syncUnderscoreItems: false,
+  lang: "auto",
+  logToDB: false,
+  skipSizeLargerThan: -1,
 };
 
 interface OAuth2Info {
@@ -66,22 +95,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;
@@ -89,18 +130,29 @@ export default class RemotelySavePlugin extends Plugin {
   currSyncMsg?: string;
   syncRibbon?: HTMLElement;
   autoRunIntervalID?: number;
+  i18n: I18n;
+  vaultRandomID: string;
 
   async syncRun(triggerSource: SyncTriggerSourceType = "manual") {
-    const getNotice = (x: string) => {
+    const t = (x: TransItemType, vars?: any) => {
+      return this.i18n.t(x, vars);
+    };
+
+    const getNotice = (x: string, timeout?: number) => {
       // only show notices in manual mode
       // no notice in auto mode
       if (triggerSource === "manual" || triggerSource === "dry") {
-        new Notice(x);
+        new Notice(x, timeout);
       }
     };
     if (this.syncStatus !== "idle") {
       // here the notice is shown regardless of triggerSource
-      new Notice(`Remotely Save already running in stage ${this.syncStatus}!`);
+      new Notice(
+        t("syncrun_alreadyrunning", {
+          pluginName: this.manifest.name,
+          syncStatus: this.syncStatus,
+        })
+      );
       if (this.currSyncMsg !== undefined && this.currSyncMsg !== "") {
         new Notice(this.currSyncMsg);
       }
@@ -123,7 +175,10 @@ export default class RemotelySavePlugin extends Plugin {
         setIcon(this.syncRibbon, iconNameSyncRunning);
         this.syncRibbon.setAttribute(
           "aria-label",
-          `${this.manifest.name}: ${triggerSource} syncing`
+          t("syncrun_syncingribbon", {
+            pluginName: this.manifest.name,
+            triggerSource: triggerSource,
+          })
         );
       }
 
@@ -131,17 +186,26 @@ export default class RemotelySavePlugin extends Plugin {
 
       if (triggerSource === "dry") {
         getNotice(
-          `0/${MAX_STEPS} Remotely Save running in dry mode, not actual file changes would happen.`
+          t("syncrun_step0", {
+            maxSteps: `${MAX_STEPS}`,
+          })
         );
       }
 
       //log.info(`huh ${this.settings.password}`)
       getNotice(
-        `1/${MAX_STEPS} Remotely Save Sync Preparing (${this.settings.serviceType})`
+        t("syncrun_step1", {
+          maxSteps: `${MAX_STEPS}`,
+          serviceType: this.settings.serviceType,
+        })
       );
       this.syncStatus = "preparing";
 
-      getNotice(`2/${MAX_STEPS} Starting to fetch remote meta data.`);
+      getNotice(
+        t("syncrun_step2", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       this.syncStatus = "getting_remote_files_list";
       const self = this;
       const client = new RemoteClient(
@@ -154,25 +218,33 @@ export default class RemotelySavePlugin extends Plugin {
         () => self.saveSettings()
       );
       const remoteRsp = await client.listFromRemote();
-      log.debug(remoteRsp);
+      // log.debug(remoteRsp);
 
-      getNotice(`3/${MAX_STEPS} Checking password correct or not.`);
+      getNotice(
+        t("syncrun_step3", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       this.syncStatus = "checking_password";
       const passwordCheckResult = await isPasswordOk(
         remoteRsp.Contents,
         this.settings.password
       );
       if (!passwordCheckResult.ok) {
-        getNotice("something goes wrong while checking password");
+        getNotice(t("syncrun_passworderr"));
         throw Error(passwordCheckResult.reason);
       }
 
-      getNotice(`4/${MAX_STEPS} Trying to fetch extra meta data from remote.`);
+      getNotice(
+        t("syncrun_step4", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       this.syncStatus = "getting_remote_extra_meta";
       const { remoteStates, metadataFile } = await parseRemoteItems(
         remoteRsp.Contents,
         this.db,
-        this.settings.vaultRandomID,
+        this.vaultRandomID,
         client.serviceType,
         this.settings.password
       );
@@ -183,67 +255,103 @@ export default class RemotelySavePlugin extends Plugin {
         this.settings.password
       );
 
-      getNotice(`5/${MAX_STEPS} Starting to fetch local meta data.`);
+      getNotice(
+        t("syncrun_step5", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       this.syncStatus = "getting_local_meta";
       const local = this.app.vault.getAllLoadedFiles();
-      const localHistory = await loadDeleteRenameHistoryTableByVault(
+      const localHistory = await loadFileHistoryTableByVault(
         this.db,
-        this.settings.vaultRandomID
+        this.vaultRandomID
       );
+      let localConfigDirContents: ObsConfigDirFileType[] = undefined;
+      if (this.settings.syncConfigDir) {
+        localConfigDirContents = await listFilesInObsFolder(
+          this.app.vault.configDir,
+          this.app.vault,
+          this.manifest.id
+        );
+      }
       // log.info(local);
       // log.info(localHistory);
 
-      getNotice(`6/${MAX_STEPS} Starting to generate sync plan.`);
+      getNotice(
+        t("syncrun_step6", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       this.syncStatus = "generating_plan";
-      const { plan, sortedKeys, deletions } = await getSyncPlan(
+      const { plan, sortedKeys, deletions, sizesGoWrong } = await getSyncPlan(
         remoteStates,
         local,
+        localConfigDirContents,
         origMetadataOnRemote.deletions,
         localHistory,
         client.serviceType,
+        triggerSource,
         this.app.vault,
+        this.settings.syncConfigDir,
+        this.app.vault.configDir,
+        this.settings.syncUnderscoreItems,
+        this.settings.skipSizeLargerThan,
         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.
 
       if (triggerSource !== "dry") {
-        getNotice(`7/${MAX_STEPS} Remotely Save Sync data exchanging!`);
+        getNotice(
+          t("syncrun_step7", {
+            maxSteps: `${MAX_STEPS}`,
+          })
+        );
 
         this.syncStatus = "syncing";
         await doActualSync(
           client,
           this.db,
-          this.settings.vaultRandomID,
+          this.vaultRandomID,
           this.app.vault,
           plan,
           sortedKeys,
           metadataFile,
           origMetadataOnRemote,
+          sizesGoWrong,
           deletions,
           (key: string) => self.trash(key),
           this.settings.password,
           this.settings.concurrency,
+          (ss: FileOrFolderMixedState[]) => {
+            new SizesConflictModal(
+              self.app,
+              self,
+              this.settings.skipSizeLargerThan,
+              ss,
+              this.settings.password !== ""
+            ).open();
+          },
           (i: number, totalCount: number, pathName: string, decision: string) =>
             self.setCurrSyncMsg(i, totalCount, pathName, decision)
         );
       } else {
         this.syncStatus = "syncing";
         getNotice(
-          `7/${MAX_STEPS} Remotely Save real sync is skipped in dry run mode.`
+          t("syncrun_step7skip", {
+            maxSteps: `${MAX_STEPS}`,
+          })
         );
       }
 
-      getNotice(`8/${MAX_STEPS} Remotely Save finish!`);
+      getNotice(
+        t("syncrun_step8", {
+          maxSteps: `${MAX_STEPS}`,
+        })
+      );
       this.syncStatus = "finish";
       this.syncStatus = "idle";
 
@@ -258,15 +366,22 @@ export default class RemotelySavePlugin extends Plugin {
         }-${Date.now()}: finish sync, triggerSource=${triggerSource}`
       );
     } catch (error) {
-      const msg = `${
+      const msg = t("syncrun_abort", {
-        this.manifest.id
+        manifestID: this.manifest.id,
-      }-${Date.now()}: abort sync, triggerSource=${triggerSource}, error while ${
+        theDate: `${Date.now()}`,
-        this.syncStatus
+        triggerSource: triggerSource,
-      }`;
+        syncStatus: this.syncStatus,
-      log.info(msg);
+      });
-      log.info(error);
+      log.error(msg);
-      getNotice(msg);
+      log.error(error);
-      getNotice(error.message);
+      getNotice(msg, 10 * 1000);
+      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);
@@ -278,8 +393,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: "",
@@ -292,15 +410,50 @@ 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) => {
+      this.settings.lang = lang;
+      await this.saveSettings();
+    });
+    const t = (x: TransItemType, vars?: any) => {
+      return this.i18n.t(x, vars);
+    };
 
     if (this.settings.currLogLevel !== undefined) {
       log.setLevel(this.settings.currLogLevel as any);
     }
 
     await this.checkIfOauthExpires();
-    await this.checkIfVaultIDAssigned(); // MUST before prepareDB()
 
-    await this.prepareDB();
+    // MUST before prepareDB()
+    // And, it's also possible to be an empty string,
+    // which means the vaultRandomID is read from db later!
+    const vaultRandomIDFromOldConfigFile =
+      await this.getVaultRandomIDFromOldConfigFile();
+
+    // no need to await this
+    this.tryToAddIgnoreFile();
+
+    const vaultBasePath = this.getVaultBasePath();
+
+    try {
+      await this.prepareDBAndVaultRandomID(
+        vaultBasePath,
+        vaultRandomIDFromOldConfigFile
+      );
+    } catch (err) {
+      new Notice(err.message, 10 * 1000);
+      throw err;
+    }
+
+    // must AFTER preparing DB
+    this.addOutputToDBIfSet();
+    this.enableAutoClearOutputToDBHistIfSet();
+
+    // must AFTER preparing DB
+    this.enableAutoClearSyncPlanHist();
 
     this.syncStatus = "idle";
 
@@ -309,7 +462,7 @@ export default class RemotelySavePlugin extends Plugin {
         await insertDeleteRecordByVault(
           this.db,
           fileOrFolder,
-          this.settings.vaultRandomID
+          this.vaultRandomID
         );
       })
     );
@@ -320,7 +473,7 @@ export default class RemotelySavePlugin extends Plugin {
           this.db,
           fileOrFolder,
           oldPath,
-          this.settings.vaultRandomID
+          this.vaultRandomID
         );
       })
     );
@@ -335,7 +488,9 @@ export default class RemotelySavePlugin extends Plugin {
         this.settings = Object.assign({}, this.settings, copied);
         this.saveSettings();
         new Notice(
-          `New not-oauth2 settings for ${this.manifest.name} saved. Reopen the plugin Settings to the effect.`
+          t("protocol_saveqr", {
+            manifestName: this.manifest.name,
+          })
         );
       }
     });
@@ -344,9 +499,9 @@ export default class RemotelySavePlugin extends Plugin {
       COMMAND_CALLBACK,
       async (inputParams) => {
         new Notice(
-          `Your uri call a callback that's not supported yet: ${JSON.stringify(
+          t("protocol_callbacknotsupported", {
-            inputParams
+            params: JSON.stringify(inputParams),
-          )}`
+          })
         );
       }
     );
@@ -357,11 +512,13 @@ export default class RemotelySavePlugin extends Plugin {
         if (inputParams.code !== undefined) {
           if (this.oauth2Info.helperModal !== undefined) {
             this.oauth2Info.helperModal.contentEl.empty();
+
+            t("protocol_dropbox_connecting")
+              .split("\n")
+              .forEach((val) => {
                 this.oauth2Info.helperModal.contentEl.createEl("p", {
-              text: "Connecting to Dropbox...",
+                  text: val,
                 });
-            this.oauth2Info.helperModal.contentEl.createEl("p", {
-              text: "Please DO NOT close this modal.",
               });
           }
 
@@ -392,7 +549,11 @@ export default class RemotelySavePlugin extends Plugin {
           this.settings.dropbox.username = username;
           await this.saveSettings();
 
-          new Notice(`Good! We've connected to Dropbox as user ${username}!`);
+          new Notice(
+            t("protocol_dropbox_connect_succ", {
+              username: username,
+            })
+          );
 
           this.oauth2Info.verifier = ""; // reset it
           this.oauth2Info.helperModal?.close(); // close it
@@ -405,7 +566,9 @@ export default class RemotelySavePlugin extends Plugin {
           this.oauth2Info.authDiv = undefined;
 
           this.oauth2Info.revokeAuthSetting?.setDesc(
-            `You've connected as user ${this.settings.dropbox.username}. If you want to disconnect, click this button.`
+            t("protocol_dropbox_connect_succ_revoke", {
+              username: this.settings.dropbox.username,
+            })
           );
           this.oauth2Info.revokeAuthSetting = undefined;
           this.oauth2Info.revokeDiv?.toggleClass(
@@ -414,13 +577,11 @@ export default class RemotelySavePlugin extends Plugin {
           );
           this.oauth2Info.revokeDiv = undefined;
         } else {
-          new Notice(
+          new Notice(t("protocol_dropbox_connect_fail"));
-            "Something went wrong from response from Dropbox. Maybe you rejected the auth?"
-          );
           throw Error(
-            `do not know how to deal with the callback: ${JSON.stringify(
+            t("protocol_dropbox_connect_unknown", {
-              inputParams
+              params: JSON.stringify(inputParams),
-            )}`
+            })
           );
         }
       }
@@ -432,11 +593,13 @@ export default class RemotelySavePlugin extends Plugin {
         if (inputParams.code !== undefined) {
           if (this.oauth2Info.helperModal !== undefined) {
             this.oauth2Info.helperModal.contentEl.empty();
+
+            t("protocol_onedrive_connecting")
+              .split("\n")
+              .forEach((val) => {
                 this.oauth2Info.helperModal.contentEl.createEl("p", {
-              text: "Connecting to Onedrive...",
+                  text: val,
                 });
-            this.oauth2Info.helperModal.contentEl.createEl("p", {
-              text: "Please DO NOT close this modal.",
               });
           }
 
@@ -481,7 +644,9 @@ export default class RemotelySavePlugin extends Plugin {
           this.oauth2Info.authDiv = undefined;
 
           this.oauth2Info.revokeAuthSetting?.setDesc(
-            `You've connected as user ${this.settings.onedrive.username}. If you want to disconnect, click this button.`
+            t("protocol_onedrive_connect_succ_revoke", {
+              username: this.settings.onedrive.username,
+            })
           );
           this.oauth2Info.revokeAuthSetting = undefined;
           this.oauth2Info.revokeDiv?.toggleClass(
@@ -490,13 +655,11 @@ export default class RemotelySavePlugin extends Plugin {
           );
           this.oauth2Info.revokeDiv = undefined;
         } else {
-          new Notice(
+          new Notice(t("protocol_onedrive_connect_fail"));
-            "Something went wrong from response from OneDrive. Maybe you rejected the auth?"
-          );
           throw Error(
-            `do not know how to deal with the callback: ${JSON.stringify(
+            t("protocol_onedrive_connect_unknown", {
-              inputParams
+              params: JSON.stringify(inputParams),
-            )}`
+            })
           );
         }
       }
@@ -510,7 +673,7 @@ export default class RemotelySavePlugin extends Plugin {
 
     this.addCommand({
       id: "start-sync",
-      name: "start sync",
+      name: t("command_startsync"),
       icon: iconNameSyncWait,
       callback: async () => {
         this.syncRun("manual");
@@ -519,13 +682,57 @@ export default class RemotelySavePlugin extends Plugin {
 
     this.addCommand({
       id: "start-sync-dry-run",
-      name: "start sync (dry run only)",
+      name: t("command_drynrun"),
       icon: iconNameSyncWait,
       callback: async () => {
         this.syncRun("dry");
       },
     });
 
+    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) => {
@@ -541,9 +748,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() {
@@ -555,15 +766,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() {
@@ -640,14 +876,20 @@ export default class RemotelySavePlugin extends Plugin {
     }
   }
 
-  async checkIfVaultIDAssigned() {
+  async getVaultRandomIDFromOldConfigFile() {
-    if (
+    let vaultRandomID = "";
-      this.settings.vaultRandomID === undefined ||
+    if (this.settings.vaultRandomID !== undefined) {
-      this.settings.vaultRandomID === ""
+      // In old version, the vault id is saved in data.json
-    ) {
+      // But we want to store it in localForage later
-      this.settings.vaultRandomID = nanoid();
+      if (this.settings.vaultRandomID !== "") {
+        // a real string was assigned before
+        vaultRandomID = this.settings.vaultRandomID;
+      }
+      log.debug("vaultRandomID is no longer saved in data.json");
+      delete this.settings.vaultRandomID;
       await this.saveSettings();
     }
+    return vaultRandomID;
   }
 
   async trash(x: string) {
@@ -656,8 +898,26 @@ export default class RemotelySavePlugin extends Plugin {
     }
   }
 
-  async prepareDB() {
+  getVaultBasePath() {
-    this.db = await prepareDBs(this.settings.vaultRandomID);
+    if (this.app.vault.adapter instanceof FileSystemAdapter) {
+      // in desktop
+      return this.app.vault.adapter.getBasePath().split("?")[0];
+    } else {
+      // in mobile
+      return this.app.vault.adapter.getResourcePath("").split("?")[0];
+    }
+  }
+
+  async prepareDBAndVaultRandomID(
+    vaultBasePath: string,
+    vaultRandomIDFromOldConfigFile: string
+  ) {
+    const { db, vaultRandomID } = await prepareDBs(
+      vaultBasePath,
+      vaultRandomIDFromOldConfigFile
+    );
+    this.db = db;
+    this.vaultRandomID = vaultRandomID;
   }
 
   enableAutoSyncIfSet() {
@@ -695,10 +955,6 @@ export default class RemotelySavePlugin extends Plugin {
     await this.saveSettings();
   }
 
-  destroyDBs() {
-    /* destroyDBs(this.db); */
-  }
-
   async setCurrSyncMsg(
     i: number,
     totalCount: number,
@@ -708,4 +964,85 @@ export default class RemotelySavePlugin extends Plugin {
     const msg = `syncing progress=${i}/${totalCount},decision=${decision},path=${pathName}`;
     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 ||
+      `${this.app.vault.configDir}/plugins/${this.manifest.dir}`;
+    const pluginConfigDirExists =
+      await this.app.vault.adapter.exists(pluginConfigDir);
+    if (!pluginConfigDirExists) {
+      // what happened?
+      return;
+    }
+    const ignoreFile = `${pluginConfigDir}/.gitignore`;
+    const ignoreFileExists = await this.app.vault.adapter.exists(ignoreFile);
+
+    const contentText = "data.json\n";
+
+    try {
+      if (!ignoreFileExists) {
+        // not exists, directly create
+        // no need to await
+        this.app.vault.adapter.write(ignoreFile, contentText);
+      }
+    } catch (error) {
+      // 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,17 +3,31 @@ 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.
  * @param item
- * @param loose
+ * @param dot
+ * @param underscore
  * @returns
  */
-export const isHiddenPath = (item: string, loose: boolean = true) => {
+export const isHiddenPath = (
+  item: string,
+  dot: boolean = true,
+  underscore: boolean = true
+) => {
+  if (!(dot || underscore)) {
+    throw Error("parameter error for isHiddenPath");
+  }
   const k = path.posix.normalize(item); // TODO: only unix path now
   const k2 = k.split("/"); // TODO: only unix path now
   // log.info(k2)
@@ -21,10 +35,10 @@ export const isHiddenPath = (item: string, loose: boolean = true) => {
     if (singlePart === "." || singlePart === ".." || singlePart === "") {
       continue;
     }
-    if (singlePart[0] === ".") {
+    if (dot && singlePart[0] === ".") {
       return true;
     }
-    if (loose && singlePart[0] === "_") {
+    if (underscore && singlePart[0] === "_") {
       return true;
     }
   }
@@ -149,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.
@@ -260,3 +302,128 @@ export const getSplitRanges = (bytesTotal: number, bytesEachPart: number) => {
   }
   return res;
 };
+
+/**
+ * https://stackoverflow.com/questions/332422
+ * @param obj anything
+ * @returns string of the name of the object
+ */
+export const getTypeName = (obj: any) => {
+  return Object.prototype.toString.call(obj).slice(8, -1);
+};
+
+/**
+ * Startting from 1
+ * @param x
+ * @returns
+ */
+export const atWhichLevel = (x: string) => {
+  if (
+    x === undefined ||
+    x === "" ||
+    x === "." ||
+    x === ".." ||
+    x.startsWith("/")
+  ) {
+    throw Error(`do not know which level for ${x}`);
+  }
+  let y = x;
+  if (x.endsWith("/")) {
+    y = x.slice(0, -1);
+  }
+  return y.split("/").length;
+};
+
+export const checkHasSpecialCharForDir = (x: string) => {
+  return /[?/\\]/.test(x);
+};
+
+export const unixTimeToStr = (x: number | undefined | null) => {
+  if (x === undefined || x === null || Number.isNaN(x)) {
+    return undefined;
+  }
+  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}`;
+  }
+};
+
+/**
+ * On Android the stat has bugs for folders. So we need a fixed version.
+ * @param vault
+ * @param path
+ */
+export const statFix = async (vault: Vault, path: string) => {
+  const s = await vault.adapter.stat(path);
+  if (s.ctime === undefined || s.ctime === null || Number.isNaN(s.ctime)) {
+    s.ctime = undefined;
+  }
+  if (s.mtime === undefined || s.mtime === null || Number.isNaN(s.mtime)) {
+    s.mtime = undefined;
+  }
+  if (
+    (s.size === undefined || s.size === null || Number.isNaN(s.size)) &&
+    s.type === "folder"
+  ) {
+    s.size = 0;
+  }
+  return s;
+};

src/moreOnLog.ts

@@ -0,0 +1,40 @@
+// 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,
+  LogLevelNames,
+} from "loglevel";
+const log2 = origLog.getLogger("rs-default");
+
+const originalFactory = log2.methodFactory;
+
+export const applyLogWriterInplace = function (writer: (...msg: any[]) => any) {
+  log2.methodFactory = function (
+    methodName: LogLevelNames,
+    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

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

src/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,23 +37,30 @@ 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) {
+      if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
-        throw Error("remember to provide vault name while init webdav client");
+        throw Error(
+          "remember to provide vault name and callback while init webdav client"
+        );
       }
+      const remoteBaseDir = webdavConfig.remoteBaseDir || vaultName;
       this.webdavConfig = webdavConfig;
-      this.webdavClient = webdav.getWebdavClient(this.webdavConfig, vaultName);
+      this.webdavClient = webdav.getWebdavClient(
+        this.webdavConfig,
+        remoteBaseDir,
+        saveUpdatedConfigFunc
+      );
     } else if (serviceType === "dropbox") {
       if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
         throw Error(
           "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") {
@@ -64,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 {
@@ -78,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
       );
@@ -108,7 +114,7 @@ export class RemoteClient {
   ) => {
     if (this.serviceType === "s3") {
       return await s3.uploadToRemote(
-        this.s3Client,
+        s3.getS3Client(this.s3Config),
         this.s3Config,
         fileOrFolderPath,
         vault,
@@ -160,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") {
@@ -182,7 +192,7 @@ export class RemoteClient {
   ) => {
     if (this.serviceType === "s3") {
       return await s3.downloadFromRemote(
-        this.s3Client,
+        s3.getS3Client(this.s3Config),
         this.s3Config,
         fileOrFolderPath,
         vault,
@@ -233,7 +243,7 @@ export class RemoteClient {
   ) => {
     if (this.serviceType === "s3") {
       return await s3.deleteFromRemote(
-        this.s3Client,
+        s3.getS3Client(this.s3Config),
         this.s3Config,
         fileOrFolderPath,
         password,
@@ -265,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 { rangeDelay } 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 rangeDelay(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;
   }
@@ -292,9 +371,13 @@ export class WrappedDropboxClient {
       throw Error("The user has not manually auth yet.");
     }
     const currentTs = Date.now();
+    const customHeaders = {
+      "Cache-Control": "no-cache",
+    };
     if (this.dropboxConfig.accessTokenExpiresAtTime > currentTs) {
       this.dropbox = new Dropbox({
         accessToken: this.dropboxConfig.accessToken,
+        customHeaders: customHeaders,
       });
     } else {
       if (this.dropboxConfig.refreshToken === "") {
@@ -314,33 +397,41 @@ export class WrappedDropboxClient {
       );
       this.dropbox = new Dropbox({
         accessToken: this.dropboxConfig.accessToken,
+        customHeaders: customHeaders,
       });
     }
 
     // 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 +445,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 +464,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({
+        path: `/${client.remoteBaseDir}`,
         recursive: false, // don't need to recursive here
-    });
+      })
+    );
     if (rsp.status !== 200) {
       throw Error(JSON.stringify(rsp));
     }
@@ -389,15 +482,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(() =>
+    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 +512,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 +535,19 @@ export const uploadToRemote = async (
         // created, pass
       } else {
         try {
-          await client.dropbox.filesCreateFolderV2({
+          await retryReq(
+            () =>
+              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 +560,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(
+        () =>
+          client.dropbox.filesUpload({
             path: uploadFile,
             contents: "",
-      });
+          }),
+        fileOrFolderPath
+      );
       return await getRemoteMeta(client, uploadFile);
     }
   } else {
@@ -476,17 +589,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({
+
+    await retryReq(
+      () =>
+        client.dropbox.filesUpload({
           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 +624,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 +637,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 +651,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 +668,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(
+    () =>
+      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 +718,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 +746,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(
+      () =>
+        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 +774,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`);
       }
     }
   };
@@ -444,6 +444,7 @@ export class WrappedOnedriveClient {
         contentType: "application/json",
         headers: {
           Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
+          "Cache-Control": "no-cache",
         },
       })
     );
@@ -484,7 +485,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 +506,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 +525,7 @@ export class WrappedOnedriveClient {
         method: "PUT",
         body: payload,
         headers: {
+          "Content-Type": DEFAULT_CONTENT_TYPE,
           Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
         },
       });
@@ -547,15 +554,19 @@ 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",
+          /* "Cache-Control": "no-cache", not allowed here!!! */
         },
       });
       return res.json as DriveItem | UploadSession;
@@ -566,7 +577,8 @@ 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,
+          /* "Cache-Control": "no-cache", not allowed here!!! */
         },
       });
       return (await res.json()) as DriveItem | UploadSession;
@@ -576,12 +588,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 +617,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 +635,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 +648,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 +677,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 +750,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 +765,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,16 +806,22 @@ 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;
+    const content = (
+      await requestUrl({
+        url: downloadUrl,
+        headers: { "Cache-Control": "no-cache" },
+      })
+    ).arrayBuffer;
     return content;
   } else {
-    const content = await (await fetch(downloadUrl)).arrayBuffer();
+    const content = await // cannot set no-cache here, will have cors error
+    (await fetch(downloadUrl)).arrayBuffer();
     return content;
   }
 };
@@ -832,7 +852,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 +880,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

@@ -11,26 +11,26 @@ import {
   S3Client,
 } from "@aws-sdk/client-s3";
 import { Upload } from "@aws-sdk/lib-storage";
-import { HttpHandler, HttpRequest, HttpResponse } from "@aws-sdk/protocol-http";
+import { HttpHandler, HttpRequest, HttpResponse } from "@smithy/protocol-http";
 import {
   FetchHttpHandler,
   FetchHttpHandlerOptions,
-} from "@aws-sdk/fetch-http-handler";
+} from "@smithy/fetch-http-handler";
 // @ts-ignore
-import { requestTimeout } from "@aws-sdk/fetch-http-handler/dist-es/request-timeout";
+import { requestTimeout } from "@smithy/fetch-http-handler/dist-es/request-timeout";
-import { buildQueryString } from "@aws-sdk/querystring-builder";
+import { buildQueryString } from "@smithy/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 AggregateError from "aggregate-error";
+import {
+  DEFAULT_CONTENT_TYPE,
+  RemoteItem,
+  S3Config,
+  VALID_REQURL,
+} from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import {
   arrayBufferToBuffer,
@@ -40,8 +40,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,11 +84,14 @@ 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) {
@@ -111,6 +113,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 +126,7 @@ class ObsHttpHandler extends FetchHttpHandler {
         });
         return {
           response: new HttpResponse({
-            headers: rsp.headers,
+            headers: headersLower,
             statusCode: rsp.status,
             body: stream,
           }),
@@ -154,6 +161,8 @@ export const DEFAULT_S3_CONFIG = {
   s3SecretAccessKey: "",
   s3BucketName: "",
   bypassCorsLocally: true,
+  partsConcurrency: 20,
+  forcePathStyle: false,
 };
 
 export type S3ObjectType = _Object;
@@ -187,28 +196,42 @@ export const getS3Client = (s3Config: S3Config) => {
     endpoint = `https://${endpoint}`;
   }
 
-  if (requireApiVersion(API_VER_REQURL) && s3Config.bypassCorsLocally) {
+  let s3Client: S3Client;
-    const s3Client = new S3Client({
+
+  if (VALID_REQURL && s3Config.bypassCorsLocally) {
+    s3Client = new S3Client({
       region: s3Config.s3Region,
       endpoint: endpoint,
+      forcePathStyle: s3Config.forcePathStyle,
       credentials: {
         accessKeyId: s3Config.s3AccessKeyID,
         secretAccessKey: s3Config.s3SecretAccessKey,
       },
       requestHandler: new ObsHttpHandler(),
     });
-    return s3Client;
   } else {
-    const s3Client = new S3Client({
+    s3Client = new S3Client({
       region: s3Config.s3Region,
       endpoint: endpoint,
+      forcePathStyle: s3Config.forcePathStyle,
       credentials: {
         accessKeyId: s3Config.s3AccessKeyID,
         secretAccessKey: s3Config.s3SecretAccessKey,
       },
     });
-    return s3Client;
   }
+
+  s3Client.middlewareStack.add(
+    (next, context) => (args) => {
+      (args.request as any).headers["cache-control"] = "no-cache";
+      return next(args);
+    },
+    {
+      step: "build",
+    }
+  );
+
+  return s3Client;
 };
 
 export const getRemoteMeta = async (
@@ -243,8 +266,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) {
@@ -291,7 +312,7 @@ export const uploadToRemote = async (
     const body = new Uint8Array(remoteContent);
     const upload = new Upload({
       client: s3Client,
-      queueSize: 20, // concurrency
+      queueSize: s3Config.partsConcurrency, // concurrency
       partSize: bytesIn5MB, // minimal 5MB by default
       leavePartsOnError: false,
       params: {
@@ -494,7 +515,8 @@ export const deleteFromRemote = async (
  */
 export const checkConnectivity = async (
   s3Client: S3Client,
-  s3Config: S3Config
+  s3Config: S3Config,
+  callbackFunc?: any
 ) => {
   try {
     const results = await s3Client.send(
@@ -505,10 +527,30 @@ 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) {
+      if (s3Config.s3Endpoint.contains(s3Config.s3BucketName)) {
+        const err2 = new AggregateError([
+          err,
+          new Error(
+            "Maybe you've included the bucket name inside the endpoint setting. Please remove the bucket name and try again."
+          ),
+        ]);
+        callbackFunc(err2);
+      } else {
+        callbackFunc(err);
+      }
+    }
+
     return false;
   }
 };

src/remoteForWebdav.ts

@@ -1,36 +1,36 @@
 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,
   WebDAVClient,
   RequestOptionsWithState,
-  Response,
+  // Response,
-  ResponseDataDetailed,
+  // ResponseDataDetailed,
-} from "webdav/web";
+} from "webdav";
-import { getPatcher } from "webdav/web";
+
-if (requireApiVersion(API_VER_REQURL)) {
+// @ts-ignore
+import { getPatcher } from "webdav/dist/web/index.js";
+if (VALID_REQURL) {
   getPatcher().patch(
     "request",
-    async (
+    async (options: RequestOptionsWithState): Promise<Response> => {
-      options: RequestOptionsWithState
-    ): Promise<Response | ResponseDataDetailed<any>> => {
       const transformedHeaders = { ...options.headers };
       delete transformedHeaders["host"];
       delete transformedHeaders["Host"];
       delete transformedHeaders["content-length"];
       delete transformedHeaders["Content-Length"];
+
       const r = await requestUrl({
         url: options.url,
         method: options.method,
@@ -38,79 +38,90 @@ if (requireApiVersion(API_VER_REQURL)) {
         headers: transformedHeaders,
       });
 
-      let r2: Response | ResponseDataDetailed<any> = undefined;
+      let contentType: string | undefined =
-      if (options.responseType === undefined) {
+        r.headers["Content-Type"] ||
-        r2 = {
+        r.headers["content-type"] ||
-          data: undefined,
+        options.headers["Content-Type"] ||
-          status: r.status,
+        options.headers["content-type"] ||
-          statusText: getReasonPhrase(r.status),
+        options.headers["Accept"] ||
-          headers: r.headers,
+        options.headers["accept"];
-        };
+      if (contentType !== undefined) {
-      } else if (options.responseType === "json") {
+        contentType = contentType.toLowerCase();
-        r2 = {
-          data: r.json,
-          status: r.status,
-          statusText: getReasonPhrase(r.status),
-          headers: r.headers,
-        };
-      } else if (options.responseType === "text") {
-        r2 = {
-          data: r.text,
-          status: r.status,
-          statusText: getReasonPhrase(r.status),
-          headers: r.headers,
-        };
-      } else if (options.responseType === "arraybuffer") {
-        r2 = {
-          data: r.arrayBuffer,
-          status: r.status,
-          statusText: getReasonPhrase(r.status),
-          headers: r.headers,
-        };
-      } else {
-        throw Error(
-          `do not know how to deal with responseType = ${options.responseType}`
-        );
       }
+      // console.log(`requesting url=${options.url}`);
+      // console.log(`contentType=${contentType}`);
+
+      // let r2: Response = undefined;
+      // if (contentType.includes("xml")) {
+      //   r2 = new Response(r.text, {
+      //     status: r.status,
+      //     statusText: getReasonPhrase(r.status),
+      //     headers: r.headers,
+      //   });
+      // } else if (
+      //   contentType.includes("json") ||
+      //   contentType.includes("javascript")
+      // ) {
+      //   console.log('inside json branch');
+      //   // const j = r.json;
+      //   // console.log(j);
+      //   r2 = new Response(
+      //     r.text,  // yea, here is the text because Response constructor expects a text
+      //     {
+      //     status: r.status,
+      //     statusText: getReasonPhrase(r.status),
+      //     headers: r.headers,
+      //   });
+      // } else if (contentType.includes("text")) {
+      //   // avoid text/json,
+      //   // so we split this out from the above xml or json branch
+      //   r2 = new Response(r.text, {
+      //     status: r.status,
+      //     statusText: getReasonPhrase(r.status),
+      //     headers: r.headers,
+      //   });
+      // } else if (
+      //   contentType.includes("octet-stream") ||
+      //   contentType.includes("binary") ||
+      //   contentType.includes("buffer")
+      // ) {
+      //   // application/octet-stream
+      //   r2 = new Response(r.arrayBuffer, {
+      //     status: r.status,
+      //     statusText: getReasonPhrase(r.status),
+      //     headers: r.headers,
+      //   });
+      // } else {
+      //   throw Error(
+      //     `do not know how to deal with requested content type = ${contentType}`
+      //   );
+      // }
+
+      let r2: Response = undefined;
+      if ([101, 103, 204, 205, 304].includes(r.status)) {
+        // A null body status is a status that is 101, 103, 204, 205, or 304.
+        // fix this: Failed to construct 'Response': Response with null body status cannot have body
+        r2 = new Response(null, {
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: r.headers,
+        });
+      } else {
+        r2 = new Response(r.arrayBuffer, {
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: r.headers,
+        });
+      }
+
       return r2;
     }
   );
 }
-// getPatcher().patch("request", (options: any) => {
+
-//   // console.log("using fetch");
+// @ts-ignore
-//   const r = fetch(options.url, {
+import { AuthType, BufferLike, createClient } from "webdav/dist/web/index.js";
-//     method: options.method,
+export type { WebDAVClient } from "webdav";
-//     body: options.data as any,
-//     headers: options.headers,
-//     signal: options.signal,
-//   })
-//     .then((rsp) => {
-//       if (options.responseType === undefined) {
-//         return Promise.all([undefined, rsp]);
-//       }
-//       if (options.responseType === "json") {
-//         return Promise.all([rsp.json(), rsp]);
-//       }
-//       if (options.responseType === "text") {
-//         return Promise.all([rsp.text(), rsp]);
-//       }
-//       if (options.responseType === "arraybuffer") {
-//         return Promise.all([rsp.arrayBuffer(), rsp]);
-//       }
-//     })
-//     .then(([d, r]) => {
-//       return {
-//         data: d,
-//         status: r.status,
-//         statusText: r.statusText,
-//         headers: r.headers,
-//       };
-//     });
-//   // console.log("using fetch");
-//   return r;
-// });
-import { AuthType, BufferLike, createClient } from "webdav/web";
-export type { WebDAVClient } from "webdav/web";
 
 export const DEFAULT_WEBDAV_CONFIG = {
   address: "",
@@ -118,37 +129,41 @@ export const DEFAULT_WEBDAV_CONFIG = {
   password: "",
   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}/`;
   }
@@ -163,17 +178,26 @@ const fromWebdavItemToRemoteItem = (x: FileStat, vaultName: string) => {
 
 export class WrappedWebdavClient {
   webdavConfig: WebdavConfig;
-  vaultName: string;
+  remoteBaseDir: string;
   client: WebDAVClient;
   vaultFolderExists: boolean;
-  constructor(webdavConfig: WebdavConfig, vaultName: string) {
+  saveUpdatedConfigFunc: () => Promise<any>;
+  constructor(
+    webdavConfig: WebdavConfig,
+    remoteBaseDir: string,
+    saveUpdatedConfigFunc: () => Promise<any>
+  ) {
     this.webdavConfig = webdavConfig;
-    this.vaultName = vaultName;
+    this.remoteBaseDir = remoteBaseDir;
     this.vaultFolderExists = false;
+    this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
   }
 
   init = async () => {
     // init client if not inited
+    const headers = {
+      "Cache-Control": "no-cache",
+    };
     if (this.client === undefined) {
       if (
         this.webdavConfig.username !== "" &&
@@ -182,6 +206,7 @@ export class WrappedWebdavClient {
         this.client = createClient(this.webdavConfig.address, {
           username: this.webdavConfig.username,
           password: this.webdavConfig.password,
+          headers: headers,
           authType:
             this.webdavConfig.authType === "digest"
               ? AuthType.Digest
@@ -189,7 +214,9 @@ export class WrappedWebdavClient {
         });
       } else {
         log.info("no password");
-        this.client = createClient(this.webdavConfig.address);
+        this.client = createClient(this.webdavConfig.address, {
+          headers: headers,
+        });
       }
     }
 
@@ -197,25 +224,84 @@ 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;
       }
     }
+
+    // adjust depth parameter
+    if (this.webdavConfig.depth === "auto_unknown") {
+      let testPassed = false;
+      try {
+        const res = await this.client.customRequest(`/${this.remoteBaseDir}/`, {
+          method: "PROPFIND",
+          headers: {
+            Depth: "infinity",
+            Accept: "text/plain,application/xml",
+          },
+          // responseType: "text",
+        } as any);
+        if (res.status === 403) {
+          throw Error("not support Infinity, get 403");
+        } else {
+          testPassed = true;
+          this.webdavConfig.depth = "auto_infinity";
+          this.webdavConfig.manualRecursive = false;
+        }
+      } catch (error) {
+        testPassed = false;
+      }
+      if (!testPassed) {
+        try {
+          const res = await this.client.customRequest(
+            `/${this.remoteBaseDir}/`,
+            {
+              method: "PROPFIND",
+              headers: {
+                Depth: "1",
+                Accept: "text/plain,application/xml",
+              },
+              // responseType: "text",
+            } as any
+          );
+          testPassed = true;
+          this.webdavConfig.depth = "auto_1";
+          this.webdavConfig.manualRecursive = true;
+        } catch (error) {
+          testPassed = false;
+        }
+      }
+      if (testPassed) {
+        // the depth option has been changed
+        // save the setting
+        if (this.saveUpdatedConfigFunc !== undefined) {
+          await this.saveUpdatedConfigFunc();
+          log.info(
+            `webdav depth="auto_unknown" is changed to ${this.webdavConfig.depth}`
+          );
+        }
+      }
+    }
   };
 }
 
 export const getWebdavClient = (
   webdavConfig: WebdavConfig,
-  vaultName: string
+  remoteBaseDir: string,
+  saveUpdatedConfigFunc: () => Promise<any>
 ) => {
-  return new WrappedWebdavClient(webdavConfig, vaultName);
+  return new WrappedWebdavClient(
+    webdavConfig,
+    remoteBaseDir,
+    saveUpdatedConfigFunc
+  );
 };
 
 export const getRemoteMeta = async (
@@ -223,12 +309,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 (
@@ -246,7 +332,7 @@ export const uploadToRemote = async (
   if (password !== "") {
     uploadFile = remoteEncryptedKey;
   }
-  uploadFile = getWebdavPath(uploadFile, client.vaultName);
+  uploadFile = getWebdavPath(uploadFile, client.remoteBaseDir);
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
@@ -260,7 +346,7 @@ export const uploadToRemote = async (
     if (password === "") {
       // if not encrypted, mkdir a remote folder
       await client.client.createDirectory(uploadFile, {
-        recursive: true,
+        recursive: false, // the sync algo should guarantee no need to recursive
       });
       const res = await getRemoteMeta(client, uploadFile);
       return res;
@@ -292,11 +378,12 @@ export const uploadToRemote = async (
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
     }
-    // we need to create folders before uploading
+    // updated 20220326: the algorithm guarantee this
-    const dir = getPathFolder(uploadFile);
+    // // we need to create folders before uploading
-    if (dir !== "/" && dir !== "") {
+    // const dir = getPathFolder(uploadFile);
-      await client.client.createDirectory(dir, { recursive: true });
+    // if (dir !== "/" && dir !== "") {
-    }
+    //   await client.client.createDirectory(dir, { recursive: false });
+    // }
     await client.client.putFileContents(uploadFile, remoteContent, {
       overwrite: true,
       onUploadProgress: (progress: any) => {
@@ -318,10 +405,13 @@ export const listFromRemote = async (
   await client.init();
 
   let contents = [] as FileStat[];
-  if (client.webdavConfig.manualRecursive) {
+  if (
+    client.webdavConfig.depth === "auto_1" ||
+    client.webdavConfig.depth === "manual_1"
+  ) {
     // the remote doesn't support infinity propfind,
     // we need to do a bfs here
-    const q = new Queue([`/${client.vaultName}`]);
+    const q = new Queue([`/${client.remoteBaseDir}`]);
     const CHUNK_SIZE = 10;
     while (q.length > 0) {
       const itemsToFetch = [];
@@ -336,7 +426,10 @@ export const listFromRemote = async (
           return client.client.getDirectoryContents(x, {
             deep: false,
             details: false /* no need for verbose details here */,
-            glob: "/**" /* avoid dot files by using glob */,
+            // TODO: to support .obsidian,
+            // we need to load all files including dot,
+            // anyway to reduce the resources?
+            // glob: "/**" /* avoid dot files by using glob */,
           }) as Promise<FileStat[]>;
         });
         const r2 = flatten(await Promise.all(r));
@@ -353,17 +446,20 @@ 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 */,
-        glob: "/**" /* avoid dot files by using glob */,
+        // TODO: to support .obsidian,
+        // we need to load all files including dot,
+        // anyway to reduce the resources?
+        // glob: "/**" /* avoid dot files by using glob */,
       }
     )) as FileStat[];
   }
   return {
     Contents: contents.map((x) =>
-      fromWebdavItemToRemoteItem(x, client.vaultName)
+      fromWebdavItemToRemoteItem(x, client.remoteBaseDir)
     ),
   };
 };
@@ -373,9 +469,9 @@ const downloadFromRemoteRaw = async (
   fileOrFolderPath: string
 ) => {
   await client.init();
-  const buff = (await client.client.getFileContents(
+  const p = getWebdavPath(fileOrFolderPath, client.remoteBaseDir);
-    getWebdavPath(fileOrFolderPath, client.vaultName)
+  // console.log(`getWebdavPath=${p}`);
-  )) as BufferLike;
+  const buff = (await client.client.getFileContents(p)) as BufferLike;
   if (buff instanceof ArrayBuffer) {
     return buff;
   } else if (buff instanceof Buffer) {
@@ -413,7 +509,8 @@ export const downloadFromRemote = async (
     if (password !== "") {
       downloadFile = remoteEncryptedKey;
     }
-    downloadFile = getWebdavPath(downloadFile, client.vaultName);
+    downloadFile = getWebdavPath(downloadFile, client.remoteBaseDir);
+    // console.log(`downloadFile=${downloadFile}`);
     const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
     let localContent = remoteContent;
     if (password !== "") {
@@ -441,7 +538,7 @@ export const deleteFromRemote = async (
   if (password !== "") {
     remoteFileName = remoteEncryptedKey;
   }
-  remoteFileName = getWebdavPath(remoteFileName, client.vaultName);
+  remoteFileName = getWebdavPath(remoteFileName, client.remoteBaseDir);
 
   await client.init();
   try {
@@ -453,15 +550,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/syncAlgoV2Notice.ts

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

src/syncSizesConflictNotice.ts

@@ -0,0 +1,90 @@
+import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
+import type RemotelySavePlugin from "./main"; // unavoidable
+import type { TransItemType } from "./i18n";
+import type { FileOrFolderMixedState } from "./baseTypes";
+
+import { log } from "./moreOnLog";
+
+export class SizesConflictModal extends Modal {
+  readonly plugin: RemotelySavePlugin;
+  readonly skipSizeLargerThan: number;
+  readonly sizesGoWrong: FileOrFolderMixedState[];
+  readonly hasPassword: boolean;
+  constructor(
+    app: App,
+    plugin: RemotelySavePlugin,
+    skipSizeLargerThan: number,
+    sizesGoWrong: FileOrFolderMixedState[],
+    hasPassword: boolean
+  ) {
+    super(app);
+    this.plugin = plugin;
+    this.skipSizeLargerThan = skipSizeLargerThan;
+    this.sizesGoWrong = sizesGoWrong;
+    this.hasPassword = hasPassword;
+  }
+  onOpen() {
+    let { contentEl } = this;
+    const t = (x: TransItemType, vars?: any) => {
+      return this.plugin.i18n.t(x, vars);
+    };
+
+    contentEl.createEl("h2", {
+      text: t("modal_sizesconflict_title"),
+    });
+
+    t("modal_sizesconflict_desc", {
+      thresholdMB: `${this.skipSizeLargerThan / 1000 / 1000}`,
+      thresholdBytes: `${this.skipSizeLargerThan}`,
+    })
+      .split("\n")
+      .forEach((val) => {
+        contentEl.createEl("p", { text: val });
+      });
+
+    const info = this.serialize();
+
+    contentEl.createDiv().createEl(
+      "button",
+      {
+        text: t("modal_sizesconflict_copybutton"),
+      },
+      (el) => {
+        el.onclick = async () => {
+          await navigator.clipboard.writeText(info);
+          new Notice(t("modal_sizesconflict_copynotice"));
+        };
+      }
+    );
+
+    contentEl.createEl("pre", {
+      text: info,
+    });
+  }
+
+  serialize() {
+    return this.sizesGoWrong
+      .map((x) => {
+        return [
+          x.key,
+          this.hasPassword
+            ? `encrypted name: ${x.remoteEncryptedKey}`
+            : undefined,
+          `local ${this.hasPassword ? "encrypted " : ""}bytes: ${
+            this.hasPassword ? x.sizeLocalEnc : x.sizeLocal
+          }`,
+          `remote ${this.hasPassword ? "encrypted " : ""}bytes: ${
+            this.hasPassword ? x.sizeRemoteEnc : x.sizeRemote
+          }`,
+        ]
+          .filter((tmp) => tmp !== undefined)
+          .join("\n");
+      })
+      .join("\n\n");
+  }
+
+  onClose() {
+    let { contentEl } = this;
+    contentEl.empty();
+  }
+}

styles.css

@@ -8,6 +8,11 @@
   font-weight: bold;
 }
 
+.settings-auth-related {
+  border-top: 1px solid var(--background-modifier-border);
+  padding-top: 18px;
+}
+
 .s3-disclaimer {
   font-weight: bold;
 }

tests/encrypt.test.ts

@@ -8,6 +8,8 @@ import {
   encryptArrayBuffer,
   encryptStringToBase32,
   encryptStringToBase64url,
+  getSizeFromEncToOrig,
+  getSizeFromOrigToEnc,
 } from "../src/encrypt";
 import { base64ToBase64url, bufferToArrayBuffer } from "../src/misc";
 
@@ -27,6 +29,14 @@ describe("Encryption tests", () => {
     expect(await encryptStringToBase32(k, password)).to.not.equal(k);
   });
 
+  it("should encrypt string and return different results each time", async () => {
+    const k = "dkjdhkfhdkjgsdklxxd";
+    const password = "hey";
+    const res1 = await encryptStringToBase32(k, password);
+    const res2 = await encryptStringToBase32(k, password);
+    expect(res1).to.not.equal(res2);
+  });
+
   it("should raise error using different password", async () => {
     const k = "secret text";
     const password = "hey";
@@ -95,7 +105,21 @@ describe("Encryption tests", () => {
     expect(Buffer.from(enc).equals(Buffer.from(opensslArrBuf))).to.be.true;
   });
 
-  it("should descypt binary file and get the same result as openssl", async () => {
+  it("should encrypt binary file not deterministically", async () => {
+    const testFolder = path.join(__dirname, "static_assets", "mona_lisa");
+    const testFileName =
+      "1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg";
+    const fileArrBuf = bufferToArrayBuffer(
+      await fs.readFileSync(path.join(testFolder, testFileName))
+    );
+    const password = "somepassword";
+    const res1 = await encryptArrayBuffer(fileArrBuf, password);
+    const res2 = await encryptArrayBuffer(fileArrBuf, password);
+
+    expect(Buffer.from(res1).equals(Buffer.from(res2))).to.be.false;
+  });
+
+  it("should decrypt binary file and get the same result as openssl", async () => {
     const testFolder = path.join(__dirname, "static_assets", "mona_lisa");
     const testFileName =
       "1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg";
@@ -110,4 +134,34 @@ describe("Encryption tests", () => {
 
     expect(Buffer.from(dec).equals(Buffer.from(opensslArrBuf))).to.be.true;
   });
+
+  it("should get size from origin to encrypted correctly", () => {
+    expect(() => getSizeFromOrigToEnc(-1)).to.throw();
+    expect(() => getSizeFromOrigToEnc(0.5)).to.throw();
+    expect(getSizeFromOrigToEnc(0)).equals(32);
+    expect(getSizeFromOrigToEnc(15)).equals(32);
+    expect(getSizeFromOrigToEnc(16)).equals(48);
+    expect(getSizeFromOrigToEnc(31)).equals(48);
+    expect(getSizeFromOrigToEnc(32)).equals(64);
+    expect(getSizeFromOrigToEnc(14787203)).equals(14787232);
+  });
+
+  it("should get size from encrypted to origin correctly", () => {
+    expect(() => getSizeFromEncToOrig(-1)).to.throw();
+    expect(() => getSizeFromEncToOrig(30)).to.throw();
+
+    expect(getSizeFromEncToOrig(32)).to.deep.equal({
+      minSize: 0,
+      maxSize: 15,
+    });
+    expect(getSizeFromEncToOrig(48)).to.deep.equal({
+      minSize: 16,
+      maxSize: 31,
+    });
+
+    expect(() => getSizeFromEncToOrig(14787231)).to.throw();
+
+    let { minSize, maxSize } = getSizeFromEncToOrig(14787232);
+    expect(minSize <= 14787203 && 14787203 <= maxSize).to.be.true;
+  });
 });

tests/misc.test.ts

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

tsconfig.json

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

versions.json

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

webpack.config.js

@@ -41,6 +41,12 @@ module.exports = {
         test: /\.svg?$/,
         type: "asset/source",
       },
+      {
+        test: /\.m?js$/,
+        resolve: {
+          fullySpecified: false, // process/browser returns some errors before
+        },
+      },
     ],
   },
   resolve: {
@@ -55,7 +61,9 @@ module.exports = {
       // crypto: false,
       // domain: require.resolve("domain-browser"),
       // events: require.resolve("events"),
+      http: false,
       // http: require.resolve("stream-http"),
+      https: false,
       // https: require.resolve("https-browserify"),
       net: false,
       // os: require.resolve("os-browserify/browser"),