0.3.30

Add guide to configure Policy and User for AWS S3 Bucket

.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://remotely-save.github.io/auto-download-stats/latestVersionDownloads.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)
 
 ## Disclaimer
 
@@ -28,15 +26,19 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 - **[End-to-end encryption](./docs/encryption.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
 - **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
 - **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
+- \*\*Skip Large files and skip paths by custom regex conditions!
 - **Fully open source under [Apache-2.0 License](./LICENSE).**
 - **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.**
 
 ## 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. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
 - **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
+- **You should protect your `data.json` file.** The file contains sensitive information.
+  - It's strongly advised **NOT** to share your `data.json` file to anyone.
+  - It's usually **NOT** a good idea to check the file into version control. By default, the plugin tries to create a `.gitignore` file inside the plugin directory if it doesn't exist, for ignoring `data.json` in the `git` version control. If you know exactly what it means and want to remove the setting, please modify the `.gitignore` file or set it to be empty.
 
 ## Questions, Suggestions, Or Bugs
 
@@ -59,10 +61,12 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 ### S3
 
+- Tutorials / Examples:
+  - [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/README.md)
+  - [MinIO](./docs/remote_services/s3_minio/README.md)
 - Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
-- About CORS:
-  - If you are using Obsidian >= 0.13.25, you can skip this CORS part.
-  - If you are using Obsidian < 0.13.25, you need to configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, and add at least `ETag` into exposed headers. Full example is [here](./docs/s3_cors_configure.md). It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
+- If you are using AWS S3, create [policy and user](./docs/remote_services/s3_general/s3_user_policy.md).
+- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md).
 - Download and enable this plugin.
 - Enter your information to the settings of this plugin.
 - If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
@@ -86,12 +90,11 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 ### webdav
 
-- About CORS:
-  - If you are using Obsidian >= 0.13.25, you can skip this CORS part.
-  - If you are using Obsidian < 0.13.25:
-    - The webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies unless under a upgraded Obsidian version.
-    - Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin, or use a upgraded Obsidian version.
-    - The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
+- Tutorials / Examples:
+  - [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
+  - [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
+  - [坚果云 JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
+- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md).
 - Your data would be synced to a `${vaultName}` sub folder on your webdav server.
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
 

docs/browser_env.md

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

docs/browser_env_cors.md

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

docs/how_to_debug/README.md

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

docs/how_to_debug/check_console_output.md

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

docs/how_to_debug/save_console_output_and_export.md

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

docs/remote_services/s3_cloudflare_r2/README.md

@@ -0,0 +1,27 @@
+# Cloudflare R2
+
+## Links
+
+<https://www.cloudflare.com/developer-platform/r2/>
+
+## Steps
+
+1. **Be aware that it may cost you money.**
+2. Create a Cloudflare account and enable R2 feature. **Credit card info might be required by Cloudflare**, though Cloudflare provides generous free tier and zero egress fee.
+3. Create a bucket.
+   ![](./s3_cloudflare_r2_create_bucket.png)
+4. Create an Access Key with "Object Read & Write" permission, and add specify to your created bucket. During the creation, you will also get the auto-generated secret key, and the endpoint address.
+   ![](./s3_cloudflare_r2_create_api_token.png)
+5. In remotely-save setting page, input the address / bucket / access key / secret key. **Region being set to `us-east-1` is sufficient.** Enable "Bypass CORS", because usually that's what you want.
+
+   Click "check connectivity". (If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.)
+
+   ![](./s3_cloudflare_r2_rs_settings.png)
+
+6. Sync!
+
+## And Issue Related To "Check Connectivity"
+
+If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.
+
+Cloudflare doesn't allow `HeadBucket` for access keys with "Object Read & Write". So it may be possible that checking connectivity is not ok but actual syncing is ok. New version >= 0.3.29 of the plugin fix this problem by using `ListObjects` instead of `HeadBucket`.

docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_api_token.png

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

docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_bucket.png

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

docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_rs_settings.png

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

docs/remote_services/s3_general/s3_cors_configure.md

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

docs/remote_services/s3_general/s3_user_policy.md

@@ -0,0 +1,83 @@
+# AWS S3 Bucket: How to configure user's policy
+
+## Attention
+
+Please read the doc carefully and adjust the optional fields accordingly. The doc is not fully tested and contributions are welcome.
+
+## AWS Official Docs
+
+- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html>
+- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html>
+- <https://docs.aws.amazon.com/AmazonS3/latest/API/API_Operations.html>
+
+## Prerequisites
+
+Using the principle of least privilege is crucial for security when allowing a third party system to access your AWS resources.
+
+**Prerequisites**: Ensure you have an AWS account and administrative access to manage IAM policies.
+
+## Step 1: Create a new IAM Policy
+
+1. Log in to your AWS Management Console.
+1. Navigate to the IAM Policies section.
+1. Create a new policy with the following configuration.
+
+**Note**: `my-bucket` is a placeholder. For example, if your bucket's name is `obsidian-data`, the resource line should read `arn:aws:s3:::obsidian-data`.
+
+```JSON
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "ObsidianBucket",
+            "Effect": "Allow",
+            "Action": [
+                "s3:HeadBucket"
+            ],
+            "Resource": "arn:aws:s3:::my-bucket"
+        },
+        {
+            "Sid": "ObsidianObjects",
+            "Effect": "Allow",
+            "Action": [
+                "s3:HeadObject",
+                "s3:PutObject",
+                "s3:CopyObject",
+                "s3:UploadPart",
+                "s3:UploadPartCopy",
+                "s3:ListMultipartUploads",
+                "s3:AbortMultipartUpload",
+                "s3:CompleteMultipartUpload",
+                "s3:ListObjects",
+                "s3:ListObjectsV2",
+                "s3:ListParts",
+                "s3:GetObject",
+                "s3:GetObjectAttributes",
+                "s3:DeleteObject",
+                "s3:DeleteObjects"
+            ],
+            "Resource": "arn:aws:s3:::my-bucket/*"
+        }
+    ]
+}
+```
+
+> The policy allows the Obsidian plugin to list, add, retrieve, and delete objects in the specified S3 bucket.
+
+## Step 2: Attach the Policy to Obsidian user
+
+1. Create a new user in the IAM console. (Never use your own root user, as it would have full access to your AWS account).
+1. When creating the user, select "Attach policy directly" and select the policy created.
+1. Edit the recent created user and go to "Security Credentials" tab to create your access key.
+1. Create an Access Key. If asked for a "use case", select "other"
+1. Use the credentials in the plugin settings. (NEVER share these credentials)
+
+> PS. The bucket doesn't need to have a policy, only the user.
+
+## Verifying the Policy
+
+After attaching the policy, test it by trying to access the S3 bucket through the Obsidian plugin. Ensure that all intended actions can be performed without errors.
+
+## Troubleshooting
+
+If you encounter permission errors, check the policy for typos in the bucket name or actions. Ensure the policy is attached to the correct user.

docs/remote_services/s3_minio/README.md

@@ -0,0 +1,27 @@
+# MinIO
+
+## Links
+
+<https://min.io/>
+
+## Steps
+
+1. Configure your minio instance and get an account.
+2. Create an Access Key (during the creation, you will also get the auto-generated secret key).
+   ![](./minio_access_key.png)
+3. Check or set the region.
+   ![](./minio_region.png)
+4. Create a bucket.
+   ![](./minio_create_bucket.png)
+5. In remotely-save setting page, input the address / bucket / access key / secret key. **Usually minio instances may need "S3 URL style"="Path Style".** Enable "Bypass CORS", because usually that's what you want.
+   ![](./minio_rs_settings.png)
+6. Sync!
+   ![](./minio_sync_success.png)
+
+## Ports In Address
+
+Just type in the full address with `http(s)://` and `:port` in remotely-save settings, for example `http://192.168.31.198:9000`.
+
+It's verified that everything is ok.
+
+![](./minio_custom_port.png)

docs/remote_services/s3_minio/minio_access_key.png

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

docs/remote_services/s3_minio/minio_create_bucket.png

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

docs/remote_services/s3_minio/minio_custom_port.png

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

docs/remote_services/s3_minio/minio_region.png

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

docs/remote_services/s3_minio/minio_rs_settings.png

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

docs/remote_services/s3_minio/minio_sync_success.png

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

docs/remote_services/webdav_alist/README.md

@@ -0,0 +1,22 @@
+# AList
+
+## 链接 Links
+
+- English official website: <https://alist.nn.ci/> and <https://alist.nn.ci/guide/webdav.html>
+- 中文官网：<https://alist.nn.ci/zh/> 和 <https://alist.nn.ci/zh/guide/webdav.html>
+
+## 步骤 Steps
+
+1. 安装和使用 AList。获取账号名和密码。在网页上登录。Install and run AList. Get the account and password. Login using the web page.
+2. 新建挂载，检查挂载路径。如图所示是 `/alisttest davpath`。Add new storage. Pay attention to the mount path. The screenshot shows the mount path as `/alisttest davpath`.
+   ![](./alist_mount_path.zh.png)
+   ![](./alist_mount_path.en.png)
+3. 从而构建 webdav 网址如下，**http(s)://域名** + **端口** + **`/dav`** + **挂载路径**，其中挂载路径中假如有空格，换成 `%20`：Construct the webdav address as: **http(s)://domain** + **port** + **`/dav`** + **mount path**, and the space inside the mount path should be replaced with `%20`:
+   ```
+   http[s]://domain:port/dav/[mountpath url encoded]
+   http://127.0.0.1:5244/dav/alisttest%20davpath
+   ```
+4. 在 remotely-save 设置，输入**带域名端口`/dav`和挂载路径的网址**、账号、密码。In remotely-save setting page, select webdav type, then input the **full address with mount path**/account/password.
+   ![](./alist_rs_settings.en.png)
+5. 在 remotely-save 设置，检查连接。In remotely-save setting page, click "Check Connectivity".
+6. 同步文件！Sync!

docs/remote_services/webdav_alist/alist_mount_path.en.png

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

docs/remote_services/webdav_alist/alist_mount_path.zh.png

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

docs/remote_services/webdav_alist/alist_rs_settings.en.png

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

docs/remote_services/webdav_general/webav_cors.md

@@ -0,0 +1,10 @@
+If you are using Obsidian desktop >= 0.13.25 or iOS >= 1.1.1, you can skip this CORS part.
+
+If you are using Obsidian desktop < 0.13.25 or iOS < 1.1.1 or any Android version:
+
+- The webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies unless under a upgraded Obsidian version.
+- Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin, or use a upgraded Obsidian version.
+  - **Unofficial** workaround: NextCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can install [WebAppPassword](https://apps.nextcloud.com/apps/webapppassword) app, and add `app://obsidian.md`, `capacitor://localhost`, `http://localhost` to `Allowed origins`
+  - **Unofficial** workaround: OwnCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can download `.tar.gz` of `WebAppPassword` above and manually install and configure it on their instances.
+- [Apache is also possible](./webdav_apache_cors.md).
+- 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.

docs/remote_services/webdav_general/webdav_apache_cors.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/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/remote_services/webdav_jianguoyun/README.md

@@ -0,0 +1,22 @@
+# 坚果云 JianGuoYun/NutStore
+
+## 链接 Link
+
+<https://www.jianguoyun.com/>
+
+## 注意！！！Attentions!!!
+
+坚果云有限制 api 数量等设定。本插件会产生若干查询，如果文件较多很容易触发 api 上限，从而工作不正常。这不是插件 bug，也没有办法解决。
+
+JianGuoYun/NutStore has api limits. The plugin may generate many queries, and it's possible to reach the api limits if there are many files, then do not work properly. It's not a bug and there's no way to fix this situation.
+
+## 步骤 Steps
+
+1. **知悉坚果云有 api 限制，本插件可能因此工作不正常。Be aware that JianGuoYun/NutStore has api limits, and the plugin may not work properly because of this.**
+2. 注册账号，登录。Register an account.
+3. 去“个人信息”->“安全”，“添加应用”，从而获取了 webDAV 账号（应该是 email）和 WebDAV 密码（一串特殊的字符，不等于网站密码）。Go to "settings"->"Security", click "Add Application", then obtain the WebDAV account (email), and WebDAV password (a string different from web site password).
+   ![](./webdav_jianguoyun.cn.png)
+4. 在 remotely-save 设置，输入网址、账号、密码、**“发送到服务器的 Depth Header”设置为“只支持 depth='1'”**。Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
+   ![](./webdav_jianguoyun_rs_settting.cn.png)
+5. 在 remotely-save 设置，检查连接。In remotely-save setting page, click "Check Connectivity".
+6. 同步文件！Sync!

docs/remote_services/webdav_jianguoyun/webdav_jianguoyun.cn.png

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

docs/remote_services/webdav_jianguoyun/webdav_jianguoyun_rs_settting.cn.png

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

docs/remote_services/webdav_owncloud/README.md

@@ -0,0 +1,17 @@
+# ownCloud Webdav
+
+## Link
+
+<https://owncloud.com/>
+
+# Steps
+
+1. Create an account.
+2. Login.
+3. In the Settings position, enable the "Show hidden files" and find out the WebDAV address.
+   ![](./owncloud_address.png)
+4. Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
+   ![](./owncloud_rs_settings.png)
+5. In remotely-save setting page, click "Check Connectivity".
+6. Sync!
+   ![](./owncloud_files.png)

docs/remote_services/webdav_owncloud/owncloud_address.png

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

docs/remote_services/webdav_owncloud/owncloud_files.png

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

docs/remote_services/webdav_owncloud/owncloud_rs_settings.png

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

docs/services_connectable_or_not.md

@@ -2,12 +2,12 @@
 
 Here is an overview of the connectability ("connectable" or "not connectable" or "in the plan" or "never") to some services by this plugin.
 
-The plugin works under the browser environment in Obsidian, so CORS is an issue. Obsidian starts to provide a rich API `requestUrl` for version >= 0.13.25 to bypass the CORS issue. But if the users are still using an older version of Obsidian, they need to configure CORS on server.
+The plugin works under the browser environment in Obsidian, so CORS is an issue. Obsidian starts to provide a rich API `requestUrl` for desktop version >= 0.13.25, mobile >= 1.1.1 to bypass the CORS issue. But if the users are still using an older version of Obsidian, they need to configure CORS on server.
 
 The list is for information purposes only.
 
-| Service                                                                               | Connectable | by S3 | by WebDAV | by other protocol                                                | can bypass CORS issue in Obsidian>=0.13.25 | need CORS config in Obsidian<0.13.25             |
-| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------ |
+| Service                                                                               | Connectable | by S3 | by WebDAV | by other protocol                                                | can bypass CORS issue in latest Obsidian | need CORS config in old Obsidian                 |
+| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------ |
 | Amazon S3                                                                             | Yes         | Yes   |           |                                                                  | Yes                                      | [CORS config needed.](./s3_cors_configure.md)    |
 | Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储                             | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |
 | Alibaba Cloud - Object Storage Service 阿里云对象存储                                 | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |
@@ -18,15 +18,15 @@ The list is for information purposes only.
 | [MinIO](https://min.io/)                                                              | ?           | ?     |           |                                                                  |                                          |                                                  |
 | [WsgiDAV](https://github.com/mar10/wsgidav)                                           | Yes         |       | Yes       |                                                                  | Yes                                      | CORS rules can be set.                           |
 | [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes?        |       | Yes?      |                                                                  | Yes?                                     | ?                                                |
-| NextCloud                                                                             | Yes?        |       | Yes?      |                                                                  | Yes?                                       | No CORS config by default.                       |
+| NextCloud                                                                             | Yes         |       | Yes       |                                                                  | Yes?                                     | No CORS config by default.                       |
 | OwnCloud                                                                              | Yes?        |       | Yes?      |                                                                  | Yes?                                     | No CORS config by default.                       |
-| Seafile                                                                               | Yes?        |       | Yes?      |                                                                  | Yes?                                       |                                                  |
+| Seafile                                                                               | Yes         |       | Yes       |                                                                  | Yes?                                     | No CORS config by default.                       |
 | `rclone serve webdav`                                                                 | Yes         |       | Yes       |                                                                  | Yes                                      | No CORS support.                                 |
 | [Nutstore 坚果云](https://www.jianguoyun.com/)                                        | Yes         |       | Yes       |                                                                  | Yes                                      | No CORS support.                                 |
 | [TeraCLOUD](https://teracloud.jp/en/)                                                 | Yes         |       | Yes       |                                                                  | Yes                                      | No CORS support.                                 |
 | Dropbox                                                                               | Yes         |       |           | Yes                                                              |                                          |                                                  |
 | OneDrive for personal                                                                 | Yes         |       |           | Yes                                                              |                                          |                                                  |
-| OneDrive for Business                                                                 | In the plan |       |           | ?                                                                |                                            |                                                  |
+| OneDrive for Business                                                                 | Yes         |       |           | ?                                                                |                                          |                                                  |
 | Google Drive                                                                          | In the plan |       |           | ?                                                                |                                          |                                                  |
 | [Box](https://www.box.com/)                                                           | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |
 | Google Cloud Storage                                                                  | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |

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.30",
+  "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.7",
+  "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.7",
+  "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",
-    "@types/chai": "^4.2.22",
-    "@types/chai-as-promised": "^7.1.4",
-    "@types/feather-icons": "^4.7.0",
-    "@types/jsdom": "^16.2.13",
-    "@types/lodash": "^4.14.178",
-    "@types/mime-types": "^2.1.1",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^14.14.37",
-    "@types/qrcode": "^1.4.1",
-    "builtin-modules": "^3.2.0",
-    "chai": "^4.3.4",
+    "@microsoft/microsoft-graph-types": "^2.40.0",
+    "@types/chai": "^4.3.11",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/jsdom": "^21.1.6",
+    "@types/lodash": "^4.14.202",
+    "@types/mime-types": "^2.1.4",
+    "@types/mocha": "^10.0.6",
+    "@types/mustache": "^4.2.5",
+    "@types/node": "^20.10.4",
+    "@types/qrcode": "^1.5.5",
+    "builtin-modules": "^3.3.0",
+    "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "cross-env": "^7.0.3",
-    "dotenv": "^10.0.0",
-    "esbuild": "^0.14.3",
-    "jsdom": "^19.0.0",
-    "mocha": "^9.1.3",
-    "prettier": "^2.4.1",
-    "ts-loader": "^9.2.6",
-    "ts-node": "^10.4.0",
-    "tslib": "^2.2.0",
-    "typescript": "^4.4.4",
+    "dotenv": "^16.3.1",
+    "esbuild": "^0.19.9",
+    "jsdom": "^23.0.1",
+    "mocha": "^10.2.0",
+    "npm-check-updates": "^16.14.12",
+    "obsidian": "^1.4.11",
+    "prettier": "^3.1.1",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3",
     "webdav-server": "^2.6.2",
-    "webpack": "^5.64.4",
-    "webpack-cli": "^4.9.1"
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.54.0",
-    "@aws-sdk/fetch-http-handler": "^3.54.0",
-    "@aws-sdk/lib-storage": "^3.54.0",
-    "@aws-sdk/protocol-http": "^3.54.0",
-    "@aws-sdk/querystring-builder": "^3.54.0",
-    "@aws-sdk/signature-v4-crt": "^3.54.0",
-    "@aws-sdk/types": "^3.54.0",
-    "@azure/msal-node": "^1.6.0",
+    "@aws-sdk/client-s3": "^3.474.0",
+    "@aws-sdk/lib-storage": "^3.474.0",
+    "@aws-sdk/signature-v4-crt": "^3.474.0",
+    "@aws-sdk/types": "^3.468.0",
+    "@azure/msal-node": "^2.6.0",
     "@fyears/tsqueue": "^1.0.1",
-    "@microsoft/microsoft-graph-client": "^3.0.1",
-    "acorn": "^8.5.0",
-    "assert": "^2.0.0",
-    "aws-crt": "^1.10.1",
+    "@microsoft/microsoft-graph-client": "^3.0.7",
+    "@smithy/fetch-http-handler": "^2.3.1",
+    "@smithy/protocol-http": "^3.0.11",
+    "@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",
-    "feather-icons": "^4.28.0",
-    "http-status-codes": "^2.2.0",
+    "delay": "^6.0.0",
+    "dropbox": "^10.34.0",
+    "emoji-regex": "^10.3.0",
+    "http-status-codes": "^2.3.0",
     "localforage": "^1.10.0",
     "lodash": "^4.17.21",
-    "loglevel": "^1.8.0",
-    "mime-types": "^2.1.33",
-    "nanoid": "^3.1.30",
-    "obsidian": "^0.13.26",
-    "p-queue": "^7.2.0",
+    "loglevel": "^1.8.1",
+    "lucide": "^0.298.0",
+    "mime-types": "^2.1.35",
+    "mustache": "^4.2.0",
+    "nanoid": "^5.0.4",
+    "p-queue": "^8.0.1",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
-    "qrcode": "^1.5.0",
-    "rfc4648": "^1.5.0",
-    "rimraf": "^3.0.2",
+    "qrcode": "^1.5.3",
+    "rfc4648": "^1.5.3",
+    "rimraf": "^5.0.5",
     "stream-browserify": "^3.0.0",
-    "url": "^0.11.0",
-    "util": "^0.12.4",
-    "webdav": "^4.7.0",
-    "webdav-fs": "^4.0.0",
-    "xregexp": "^5.1.0"
+    "url": "^0.11.3",
+    "util": "^0.12.5",
+    "webdav": "^5.3.1",
+    "webdav-fs": "^4.0.1",
+    "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;
@@ -13,6 +23,7 @@ export interface S3Config {
   s3BucketName: string;
   bypassCorsLocally?: boolean;
   partsConcurrency?: number;
+  forcePathStyle?: boolean;
 }
 
 export interface DropboxConfig {
@@ -24,6 +35,7 @@ export interface DropboxConfig {
   accountID: string;
   username: string;
   credentialsShouldBeDeletedAtTime?: number;
+  remoteBaseDir?: string;
 }
 
 export type WebdavAuthType = "digest" | "basic";
@@ -41,6 +53,7 @@ export interface WebdavConfig {
   authType: WebdavAuthType;
   manualRecursive: boolean; // deprecated in 0.3.6, use depth
   depth?: WebdavDepthType;
+  remoteBaseDir?: string;
 }
 
 export interface OnedriveConfig {
@@ -53,6 +66,7 @@ export interface OnedriveConfig {
   deltaLink: string;
   username: string;
   credentialsShouldBeDeletedAtTime?: number;
+  remoteBaseDir?: string;
 }
 
 export interface RemotelySavePluginSettings {
@@ -63,13 +77,22 @@ 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;
+  ignorePaths?: string[];
+  enableStatusBarInfo?: boolean;
+
+  /**
+   * @deprecated
+   */
+  vaultRandomID?: string;
 }
 
 export interface RemoteItem {
@@ -102,13 +125,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;
@@ -119,13 +153,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";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 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(x);
+  // log.debug("loading, original config on disk:");
+  // 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(y);
+    // log.debug("loading, parsed config is:");
+    // 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(y);
+  // log.debug("encoding, encoded config is:");
+  // 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";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
-const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
-const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX = "sync_plans_hist_exported_on_";
+const turnSyncPlanToTable = (record: string) => {
+  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";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 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";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 export const exportQrCodeUri = async (
   settings: RemotelySavePluginSettings,

src/localdb.ts

@@ -1,21 +1,24 @@
 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";
-const log = origLog.getLogger("rs-default");
+import { API_VER_STAT_FOLDER, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
+import type { SyncPlanType } from "./sync";
+import { statFix, toText, unixTimeToStr } from "./misc";
 
-const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108];
-export const DEFAULT_DB_VERSION_NUMBER: number = 20220108;
+import { log } from "./moreOnLog";
+
+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 const DEFAULT_TBL_SIMPLE_KV_FOR_MISC = "simplekvformisc";
 
 export interface FileFolderHistoryRecord {
   key: string;
@@ -23,7 +26,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 +54,12 @@ interface SyncPlanRecord {
 
 export interface InternalDBs {
   versionTbl: LocalForage;
-  deleteHistoryTbl: LocalForage;
+  fileHistoryTbl: LocalForage;
   syncMappingTbl: LocalForage;
   syncPlansTbl: LocalForage;
+  vaultRandomIDMappingTbl: LocalForage;
+  loggerOutputTbl: LocalForage;
+  simpleKVForMiscTbl: LocalForage;
 }
 
 /**
@@ -72,12 +78,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 +93,8 @@ const migrateDBsFrom20211114To20220108 = async (
       value.vaultRandomID = vaultRandomID;
     }
     const newKey = `${vaultRandomID}\t${key}`;
-    allPromisesToWait.push(db.deleteHistoryTbl.setItem(newKey, value));
-    allPromisesToWait.push(db.deleteHistoryTbl.removeItem(key));
+    allPromisesToWait.push(db.fileHistoryTbl.setItem(newKey, value));
+    allPromisesToWait.push(db.fileHistoryTbl.removeItem(key));
   }
 
   log.debug("assign vault id to any sync mapping");
@@ -136,6 +142,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 +171,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 +210,50 @@ 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,
+    }),
+    simpleKVForMiscTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_SIMPLE_KV_FOR_MISC,
+    }),
   } 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 +274,10 @@ export const prepareDBs = async (vaultRandomID: string) => {
   }
 
   log.info("db connected");
-  return db;
+  return {
+    db: db,
+    vaultRandomID: vaultRandomID,
+  };
 };
 
 export const destroyDBs = async () => {
@@ -206,20 +290,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!");
-    console.error(event);
+    log.error("tried to delete db but something goes wrong!");
+    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 +317,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 +352,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,
-      mtime: 0,
+      ctime: ctime,
+      mtime: mtime,
       size: 0,
       actionWhen: Date.now(),
       actionType: "delete",
@@ -272,9 +366,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 +386,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,
-      mtime: 0,
+      ctime: ctime,
+      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 +526,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 +556,153 @@ 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);
+};
+
+export const upsertLastSuccessSyncByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string,
+  millis: number
+) => {
+  await db.simpleKVForMiscTbl.setItem(
+    `${vaultRandomID}-lastSuccessSyncMillis`,
+    millis
+  );
+};
+
+export const getLastSuccessSyncByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string
+) => {
+  return (await db.simpleKVForMiscTbl.getItem(
+    `${vaultRandomID}-lastSuccessSyncMillis`
+  )) as number;
+};

src/main.ts

@@ -1,8 +1,20 @@
-import { Modal, Notice, Plugin, Setting, addIcon, setIcon } from "obsidian";
+import {
+  Modal,
+  Notice,
+  Plugin,
+  Setting,
+  addIcon,
+  setIcon,
+  FileSystemAdapter,
+  Platform,
+} from "obsidian";
 import cloneDeep from "lodash/cloneDeep";
-import { nanoid } from "nanoid";
-import feather from "feather-icons";
-import type { RemotelySavePluginSettings } from "./baseTypes";
+import { createElement, RotateCcw, RefreshCcw, FileText } from "lucide";
+import type {
+  FileOrFolderMixedState,
+  RemotelySavePluginSettings,
+  SyncTriggerSourceType,
+} from "./baseTypes";
 import {
   COMMAND_CALLBACK,
   COMMAND_CALLBACK_ONEDRIVE,
@@ -10,13 +22,18 @@ 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,
+  upsertLastSuccessSyncByVault,
+  getLastSuccessSyncByVault,
 } from "./localdb";
 import { RemoteClient } from "./remote";
 import {
@@ -38,11 +55,20 @@ 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,
@@ -52,13 +78,18 @@ 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,
+  ignorePaths: [],
+  enableStatusBarInfo: true,
 };
 
 interface OAuth2Info {
@@ -69,41 +100,65 @@ 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({
-  width: 100,
-  height: 100,
-});
-const iconSvgSyncRunning = feather.icons["refresh-ccw"].toSvg({
-  width: 100,
-  height: 100,
-});
+const iconNameLogs = `remotely-save-logs`;
+
+const getIconSvg = () => {
+  const iconSvgSyncWait = createElement(RotateCcw);
+  iconSvgSyncWait.setAttribute("width", "100");
+  iconSvgSyncWait.setAttribute("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;
+  statusBarElement: HTMLSpanElement;
   oauth2Info: OAuth2Info;
   currLogLevel: string;
   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);
       }
@@ -126,7 +181,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,
+          })
         );
       }
 
@@ -134,17 +192,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(
@@ -157,25 +224,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
       );
@@ -186,12 +261,16 @@ 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) {
@@ -204,84 +283,123 @@ export default class RemotelySavePlugin extends Plugin {
       // 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.ignorePaths,
         this.settings.password
       );
       log.info(plan.mixedStates); // for debugging
-      if (triggerSource !== "dry") {
-        await insertSyncPlanRecordByVault(
-          this.db,
-          plan,
-          this.settings.vaultRandomID
-        );
-      }
+      await insertSyncPlanRecordByVault(this.db, plan, this.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";
 
+      const lastSuccessSyncMillis = Date.now();
+      await upsertLastSuccessSyncByVault(
+        this.db,
+        this.vaultRandomID,
+        lastSuccessSyncMillis
+      );
+
       if (this.syncRibbon !== undefined) {
         setIcon(this.syncRibbon, iconNameSyncWait);
         this.syncRibbon.setAttribute("aria-label", originLabel);
       }
 
+      if (this.statusBarElement !== undefined) {
+        this.updateLastSuccessSyncMsg(lastSuccessSyncMillis);
+      }
+
       log.info(
         `${
           this.manifest.id
         }-${Date.now()}: finish sync, triggerSource=${triggerSource}`
       );
     } catch (error) {
-      const msg = `${
-        this.manifest.id
-      }-${Date.now()}: abort sync, triggerSource=${triggerSource}, error while ${
-        this.syncStatus
-      }`;
-      log.info(msg);
-      log.info(error);
-      getNotice(msg);
-      getNotice(error.message);
+      const msg = t("syncrun_abort", {
+        manifestID: this.manifest.id,
+        theDate: `${Date.now()}`,
+        triggerSource: triggerSource,
+        syncStatus: this.syncStatus,
+      });
+      log.error(msg);
+      log.error(error);
+      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);
@@ -293,8 +411,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: "",
@@ -307,18 +428,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()
+
+    // MUST before prepareDB()
+    // And, it's also possible to be an empty string,
+    // which means the vaultRandomID is read from db later!
+    const vaultRandomIDFromOldConfigFile =
+      await this.getVaultRandomIDFromOldConfigFile();
 
     // no need to await this
     this.tryToAddIgnoreFile();
 
-    await this.prepareDB();
+    const vaultBasePath = this.getVaultBasePath();
+
+    try {
+      await this.prepareDBAndVaultRandomID(
+        vaultBasePath,
+        vaultRandomIDFromOldConfigFile
+      );
+    } catch (err) {
+      new Notice(err.message, 10 * 1000);
+      throw err;
+    }
+
+    // must AFTER preparing DB
+    this.addOutputToDBIfSet();
+    this.enableAutoClearOutputToDBHistIfSet();
+
+    // must AFTER preparing DB
+    this.enableAutoClearSyncPlanHist();
 
     this.syncStatus = "idle";
 
@@ -327,7 +480,7 @@ export default class RemotelySavePlugin extends Plugin {
         await insertDeleteRecordByVault(
           this.db,
           fileOrFolder,
-          this.settings.vaultRandomID
+          this.vaultRandomID
         );
       })
     );
@@ -338,7 +491,7 @@ export default class RemotelySavePlugin extends Plugin {
           this.db,
           fileOrFolder,
           oldPath,
-          this.settings.vaultRandomID
+          this.vaultRandomID
         );
       })
     );
@@ -353,7 +506,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,
+          })
         );
       }
     });
@@ -362,9 +517,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(
-            inputParams
-          )}`
+          t("protocol_callbacknotsupported", {
+            params: JSON.stringify(inputParams),
+          })
         );
       }
     );
@@ -375,11 +530,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.",
               });
           }
 
@@ -410,7 +567,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
@@ -423,7 +584,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(
@@ -432,13 +595,11 @@ export default class RemotelySavePlugin extends Plugin {
           );
           this.oauth2Info.revokeDiv = undefined;
         } else {
-          new Notice(
-            "Something went wrong from response from Dropbox. Maybe you rejected the auth?"
-          );
+          new Notice(t("protocol_dropbox_connect_fail"));
           throw Error(
-            `do not know how to deal with the callback: ${JSON.stringify(
-              inputParams
-            )}`
+            t("protocol_dropbox_connect_unknown", {
+              params: JSON.stringify(inputParams),
+            })
           );
         }
       }
@@ -450,11 +611,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.",
               });
           }
 
@@ -499,7 +662,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(
@@ -508,13 +673,11 @@ export default class RemotelySavePlugin extends Plugin {
           );
           this.oauth2Info.revokeDiv = undefined;
         } else {
-          new Notice(
-            "Something went wrong from response from OneDrive. Maybe you rejected the auth?"
-          );
+          new Notice(t("protocol_onedrive_connect_fail"));
           throw Error(
-            `do not know how to deal with the callback: ${JSON.stringify(
-              inputParams
-            )}`
+            t("protocol_onedrive_connect_unknown", {
+              params: JSON.stringify(inputParams),
+            })
           );
         }
       }
@@ -526,9 +689,28 @@ export default class RemotelySavePlugin extends Plugin {
       async () => this.syncRun("manual")
     );
 
+    // Create Status Bar Item (not supported on mobile)
+    if (!Platform.isMobileApp && this.settings.enableStatusBarInfo === true) {
+      const statusBarItem = this.addStatusBarItem();
+      this.statusBarElement = statusBarItem.createEl("span");
+      this.statusBarElement.setAttribute("aria-label-position", "top");
+
+      this.updateLastSuccessSyncMsg(
+        await getLastSuccessSyncByVault(this.db, this.vaultRandomID)
+      );
+      // update statusbar text every 30 seconds
+      this.registerInterval(
+        window.setInterval(async () => {
+          this.updateLastSuccessSyncMsg(
+            await getLastSuccessSyncByVault(this.db, this.vaultRandomID)
+          );
+        }, 1000 * 30)
+      );
+    }
+
     this.addCommand({
       id: "start-sync",
-      name: "start sync",
+      name: t("command_startsync"),
       icon: iconNameSyncWait,
       callback: async () => {
         this.syncRun("manual");
@@ -537,13 +719,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) => {
@@ -559,9 +785,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() {
@@ -573,21 +803,46 @@ 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;
+    }
+    if (this.settings.ignorePaths === undefined) {
+      this.settings.ignorePaths = [];
+    }
+    if (this.settings.enableStatusBarInfo === undefined) {
+      this.settings.enableStatusBarInfo = true;
+    }
+  }
+
+  async checkIfPresetRulesFollowed() {
+    const res = applyPresetRulesInplace(this.settings);
+    if (res.changed) {
+      await this.saveSettings();
+    }
   }
 
   async saveSettings() {
@@ -664,14 +919,20 @@ export default class RemotelySavePlugin extends Plugin {
     }
   }
 
-  async checkIfVaultIDAssigned() {
-    if (
-      this.settings.vaultRandomID === undefined ||
-      this.settings.vaultRandomID === ""
-    ) {
-      this.settings.vaultRandomID = nanoid();
+  async getVaultRandomIDFromOldConfigFile() {
+    let vaultRandomID = "";
+    if (this.settings.vaultRandomID !== undefined) {
+      // In old version, the vault id is saved in data.json
+      // But we want to store it in localForage later
+      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) {
@@ -680,8 +941,26 @@ export default class RemotelySavePlugin extends Plugin {
     }
   }
 
-  async prepareDB() {
-    this.db = await prepareDBs(this.settings.vaultRandomID);
+  getVaultBasePath() {
+    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() {
@@ -719,10 +998,6 @@ export default class RemotelySavePlugin extends Plugin {
     await this.saveSettings();
   }
 
-  destroyDBs() {
-    /* destroyDBs(this.db); */
-  }
-
   async setCurrSyncMsg(
     i: number,
     totalCount: number,
@@ -733,13 +1008,75 @@ export default class RemotelySavePlugin extends Plugin {
     this.currSyncMsg = msg;
   }
 
+  updateLastSuccessSyncMsg(lastSuccessSyncMillis?: number) {
+    if (this.statusBarElement === undefined) return;
+
+    const t = (x: TransItemType, vars?: any) => {
+      return this.i18n.t(x, vars);
+    };
+
+    let lastSyncMsg = t("statusbar_lastsync_never");
+    let lastSyncLabelMsg = t("statusbar_lastsync_never_label");
+
+    if (lastSuccessSyncMillis !== undefined && lastSuccessSyncMillis > 0) {
+      const deltaTime = Date.now() - lastSuccessSyncMillis;
+
+      // create human readable time
+      const years = Math.floor(deltaTime / 31556952000);
+      const months = Math.floor(deltaTime / 2629746000);
+      const weeks = Math.floor(deltaTime / 604800000);
+      const days = Math.floor(deltaTime / 86400000);
+      const hours = Math.floor(deltaTime / 3600000);
+      const minutes = Math.floor(deltaTime / 60000);
+      let timeText = "";
+
+      if (years > 0) {
+        timeText = t("statusbar_time_years", { time: years });
+      } else if (months > 0) {
+        timeText = t("statusbar_time_months", { time: months });
+      } else if (weeks > 0) {
+        timeText = t("statusbar_time_weeks", { time: weeks });
+      } else if (days > 0) {
+        timeText = t("statusbar_time_days", { time: days });
+      } else if (hours > 0) {
+        timeText = t("statusbar_time_hours", { time: hours });
+      } else if (minutes > 0) {
+        timeText = t("statusbar_time_minutes", { time: minutes });
+      } else {
+        timeText = t("statusbar_time_lessminute");
+      }
+
+      let dateText = new Date(lastSuccessSyncMillis).toLocaleTimeString(
+        navigator.language,
+        {
+          weekday: "long",
+          year: "numeric",
+          month: "long",
+          day: "numeric",
+        }
+      );
+
+      lastSyncMsg = t("statusbar_lastsync", { time: timeText });
+      lastSyncLabelMsg = t("statusbar_lastsync_label", { date: dateText });
+    }
+
+    this.statusBarElement.setText(lastSyncMsg);
+    this.statusBarElement.setAttribute("aria-label", lastSyncLabelMsg);
+  }
+
+  /**
+   * 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
-    );
+    const pluginConfigDirExists =
+      await this.app.vault.adapter.exists(pluginConfigDir);
     if (!pluginConfigDirExists) {
       // what happened?
       return;
@@ -750,15 +1087,7 @@ export default class RemotelySavePlugin extends Plugin {
     const contentText = "data.json\n";
 
     try {
-      if (ignoreFileExists) {
-        // check empty, if empty, we can write it
-        // if not empty, we do nothing
-        const content = (await this.app.vault.adapter.read(ignoreFile)).trim();
-        if (content === "") {
-          // no need to await writing
-          this.app.vault.adapter.write(ignoreFile, contentText);
-        }
-      } else {
+      if (!ignoreFileExists) {
         // not exists, directly create
         // no need to await
         this.app.vault.adapter.write(ignoreFile, contentText);
@@ -767,4 +1096,52 @@ export default class RemotelySavePlugin extends Plugin {
       // just skip
     }
   }
+
+  addOutputToDBIfSet() {
+    if (this.settings.logToDB) {
+      applyLogWriterInplace((...msg: any[]) => {
+        insertLoggerOutputByVault(this.db, this.vaultRandomID, ...msg);
+      });
+    }
+  }
+
+  enableAutoClearOutputToDBHistIfSet() {
+    const initClearOutputToDBHistAfterMilliseconds = 1000 * 45;
+    const autoClearOutputToDBHistAfterMilliseconds = 1000 * 60 * 5;
+
+    this.app.workspace.onLayoutReady(() => {
+      // init run
+      window.setTimeout(() => {
+        if (this.settings.logToDB) {
+          clearExpiredLoggerOutputRecords(this.db);
+        }
+      }, initClearOutputToDBHistAfterMilliseconds);
+
+      // scheduled run
+      const intervalID = window.setInterval(() => {
+        if (this.settings.logToDB) {
+          clearExpiredLoggerOutputRecords(this.db);
+        }
+      }, autoClearOutputToDBHistAfterMilliseconds);
+      this.registerInterval(intervalID);
+    });
+  }
+
+  enableAutoClearSyncPlanHist() {
+    const initClearSyncPlanHistAfterMilliseconds = 1000 * 45;
+    const autoClearSyncPlanHistAfterMilliseconds = 1000 * 60 * 5;
+
+    this.app.workspace.onLayoutReady(() => {
+      // init run
+      window.setTimeout(() => {
+        clearExpiredSyncPlanRecords(this.db);
+      }, initClearSyncPlanHistAfterMilliseconds);
+
+      // scheduled run
+      const intervalID = window.setInterval(() => {
+        clearExpiredSyncPlanRecords(this.db);
+      }, autoClearSyncPlanHistAfterMilliseconds);
+      this.registerInterval(intervalID);
+    });
+  }
 }

src/metadataOnRemote.ts

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

src/misc.ts

@@ -3,9 +3,15 @@ import * as path from "path";
 
 import { base32, base64url } from "rfc4648";
 import XRegExp from "xregexp";
+import emojiRegex from "emoji-regex";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
+
+declare global {
+  interface Window {
+    moment: (...data: any) => any;
+  }
+}
 
 /**
  * If any part of the file starts with '.' or '_' then it's a hidden file.
@@ -157,6 +163,34 @@ export const isVaildText = (a: string) => {
   );
 };
 
+/**
+ * Use regex to detect a text contains emoji or not.
+ * @param a
+ * @returns
+ */
+export const hasEmojiInText = (a: string) => {
+  const regex = emojiRegex();
+  return regex.test(a);
+};
+
+/**
+ * Convert the headers to a normal object.
+ * @param h
+ * @param toLower
+ * @returns
+ */
+export const headersToRecord = (h: Headers, toLower: boolean = true) => {
+  const res: Record<string, string> = {};
+  h.forEach((v, k) => {
+    if (toLower) {
+      res[k.toLowerCase()] = v;
+    } else {
+      res[k] = v;
+    }
+  });
+  return res;
+};
+
 /**
  * If input is already a folder, returns it as is;
  * And if input is a file, returns its direname.
@@ -299,3 +333,97 @@ export const atWhichLevel = (x: string) => {
   }
   return y.split("/").length;
 };
+
+export const checkHasSpecialCharForDir = (x: string) => {
+  return /[?/\\]/.test(x);
+};
+
+export const unixTimeToStr = (x: number | undefined | null) => {
+  if (x === undefined || 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

@@ -2,9 +2,7 @@ import { Vault, Stat, ListedFiles } from "obsidian";
 import { Queue } from "@fyears/tsqueue";
 import chunk from "lodash/chunk";
 import flatten from "lodash/flatten";
-
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { statFix } from "./misc";
 
 export interface ObsConfigDirFileType {
   key: string;
@@ -15,7 +13,14 @@ export interface ObsConfigDirFileType {
 }
 
 const isFolderToSkip = (x: string) => {
-  let specialFolders = [".git", ".svn", "node_modules"];
+  let specialFolders = [
+    ".git",
+    ".github",
+    ".gitlab",
+    ".svn",
+    "node_modules",
+    ".DS_Store",
+  ];
   for (const iterator of specialFolders) {
     if (
       x === iterator ||
@@ -78,7 +83,8 @@ export const listFilesInObsFolder = async (
     const itemsToFetchChunks = chunk(itemsToFetch, CHUNK_SIZE);
     for (const singleChunk of itemsToFetchChunks) {
       const r = singleChunk.map(async (x) => {
-        const statRes = await vault.adapter.stat(x);
+        const statRes = await statFix(vault, x);
+
         const isFolder = statRes.type === "folder";
         let children: ListedFiles = undefined;
         if (isFolder) {

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

src/remoteForDropbox.ts

@@ -1,4 +1,6 @@
-import { Dropbox, DropboxAuth, files } from "dropbox";
+import { 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";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 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.startsWith(`/${vaultName}/`)
+      fileOrFolderPath === `/${remoteBaseDir}` ||
+      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({
-      path: `/${client.vaultName}`,
+    const rsp = await retryReq(() =>
+      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}`)
-    .map((x) => fromDropboxItemToRemoteItem(x, client.vaultName));
+    .filter((x) => x.path_display !== `/${client.remoteBaseDir}`)
+    .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}`)
-      .map((x) => fromDropboxItemToRemoteItem(x, client.vaultName));
+      .filter((x) => x.path_display !== `/${client.remoteBaseDir}`)
+      .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 rsp = await client.dropbox.filesDownload({
+  const key = getDropboxPath(fileOrFolderPath, client.remoteBaseDir);
+  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:");
-    console.error(err);
+    log.debug(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 prefix = `/drive/special/approot:/${vaultName}`;
+const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
+  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}
-  // or localized, e.g.: /drive/root:/应用/remotely-save/${vaultName}
+  // pure english: /drive/root:/Apps/remotely-save/${remoteBaseDir}
+  // 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}/`)) {
-      key = key.substring(`/${vaultName}/`.length);
+    if (key.startsWith(`/${remoteBaseDir}/`)) {
+      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)) {
-    const content = (await requestUrl({ url: downloadUrl })).arrayBuffer;
+  if (VALID_REQURL) {
+    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 { buildQueryString } from "@aws-sdk/querystring-builder";
+import { requestTimeout } from "@smithy/fetch-http-handler/dist-es/request-timeout";
+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 {
-  Vault,
-  requestUrl,
-  RequestUrlParam,
-  RequestUrlResponse,
-  requireApiVersion,
-} from "obsidian";
+import { Vault, requestUrl, RequestUrlParam } 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";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 ////////////////////////////////////////////////////////////////////////////////
 // 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 };
-    delete transformedHeaders["host"];
-    delete transformedHeaders["Host"];
-    delete transformedHeaders["content-length"];
-    delete transformedHeaders["Content-Length"];
+    const transformedHeaders: Record<string, string> = {};
+    for (const key of Object.keys(request.headers)) {
+      const keyLower = key.toLowerCase();
+      if (keyLower === "host" || keyLower === "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,
           }),
@@ -155,6 +162,7 @@ export const DEFAULT_S3_CONFIG = {
   s3BucketName: "",
   bypassCorsLocally: true,
   partsConcurrency: 20,
+  forcePathStyle: false,
 };
 
 export type S3ObjectType = _Object;
@@ -188,28 +196,42 @@ export const getS3Client = (s3Config: S3Config) => {
     endpoint = `https://${endpoint}`;
   }
 
-  if (requireApiVersion(API_VER_REQURL) && s3Config.bypassCorsLocally) {
-    const s3Client = new S3Client({
+  let s3Client: 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 (
@@ -244,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) {
@@ -489,27 +509,59 @@ export const deleteFromRemote = async (
 /**
  * Check the config of S3 by heading bucket
  * https://stackoverflow.com/questions/50842835
+ *
+ * Updated on 20240102:
+ * Users are not always have permission of heading bucket,
+ * so we need to use listing objects instead...
+ *
  * @param s3Client
  * @param s3Config
  * @returns
  */
 export const checkConnectivity = async (
   s3Client: S3Client,
-  s3Config: S3Config
+  s3Config: S3Config,
+  callbackFunc?: any
 ) => {
   try {
-    const results = await s3Client.send(
-      new HeadBucketCommand({ Bucket: s3Config.s3BucketName })
-    );
+    // const results = await s3Client.send(
+    //   new HeadBucketCommand({ Bucket: s3Config.s3BucketName })
+    // );
+    // very simplified version of listing objects
+    const confCmd = {
+      Bucket: s3Config.s3BucketName,
+    } as ListObjectsV2CommandInput;
+    const results = await s3Client.send(new ListObjectsV2Command(confCmd));
+
     if (
       results === undefined ||
       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";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 import type {
   FileStat,
   WebDAVClient,
   RequestOptionsWithState,
-  Response,
-  ResponseDataDetailed,
-} from "webdav/web";
-import { getPatcher } from "webdav/web";
-if (requireApiVersion(API_VER_REQURL)) {
+  // Response,
+  // ResponseDataDetailed,
+} from "webdav";
+
+// @ts-ignore
+import { getPatcher } from "webdav/dist/web/index.js";
+if (VALID_REQURL) {
   getPatcher().patch(
     "request",
-    async (
-      options: RequestOptionsWithState
-    ): Promise<Response | ResponseDataDetailed<any>> => {
+    async (options: RequestOptionsWithState): Promise<Response> => {
       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,100 @@ if (requireApiVersion(API_VER_REQURL)) {
         headers: transformedHeaders,
       });
 
-      let r2: Response | ResponseDataDetailed<any> = undefined;
-      if (options.responseType === undefined) {
-        r2 = {
-          data: undefined,
-          status: r.status,
-          statusText: getReasonPhrase(r.status),
-          headers: r.headers,
-        };
-      } else if (options.responseType === "json") {
-        r2 = {
-          data: r.json,
-          status: r.status,
-          statusText: getReasonPhrase(r.status),
-          headers: r.headers,
-        };
-      } else if (options.responseType === "text") {
-        r2 = {
-          data: r.text,
-          status: r.status,
-          statusText: getReasonPhrase(r.status),
-          headers: r.headers,
-        };
-      } else if (options.responseType === "arraybuffer") {
-        r2 = {
-          data: r.arrayBuffer,
-          status: r.status,
-          statusText: getReasonPhrase(r.status),
-          headers: r.headers,
-        };
-      } else {
-        throw Error(
-          `do not know how to deal with responseType = ${options.responseType}`
-        );
+      let contentType: string | undefined =
+        r.headers["Content-Type"] ||
+        r.headers["content-type"] ||
+        options.headers["Content-Type"] ||
+        options.headers["content-type"] ||
+        options.headers["Accept"] ||
+        options.headers["accept"];
+      if (contentType !== undefined) {
+        contentType = contentType.toLowerCase();
       }
+      const rspHeaders = { ...r.headers };
+      for (let key in rspHeaders) {
+        if (rspHeaders.hasOwnProperty(key)) {
+          if (key === "content-disposition" || key === "Content-Disposition") {
+            rspHeaders[key] = encodeURIComponent(rspHeaders[key]);
+          }
+        }
+      }
+      // console.log(`requesting url=${options.url}`);
+      // console.log(`contentType=${contentType}`);
+      // console.log(`rspHeaders=${JSON.stringify(rspHeaders)}`)
+
+      // let r2: Response = undefined;
+      // if (contentType.includes("xml")) {
+      //   r2 = new Response(r.text, {
+      //     status: r.status,
+      //     statusText: getReasonPhrase(r.status),
+      //     headers: rspHeaders,
+      //   });
+      // } 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: rspHeaders,
+      //   });
+      // } 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: rspHeaders,
+      //   });
+      // } 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: rspHeaders,
+      //   });
+      // } 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.
+        // https://fetch.spec.whatwg.org/#statuses
+        // 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: rspHeaders,
+        });
+      } else {
+        r2 = new Response(r.arrayBuffer, {
+          status: r.status,
+          statusText: getReasonPhrase(r.status),
+          headers: rspHeaders,
+        });
+      }
+
       return r2;
     }
   );
 }
-// getPatcher().patch("request", (options: any) => {
-//   // console.log("using fetch");
-//   const r = fetch(options.url, {
-//     method: options.method,
-//     body: options.data as any,
-//     headers: options.headers,
-//     signal: options.signal,
-//   })
-//     .then((rsp) => {
-//       if (options.responseType === undefined) {
-//         return Promise.all([undefined, rsp]);
-//       }
-//       if (options.responseType === "json") {
-//         return Promise.all([rsp.json(), rsp]);
-//       }
-//       if (options.responseType === "text") {
-//         return Promise.all([rsp.text(), rsp]);
-//       }
-//       if (options.responseType === "arraybuffer") {
-//         return Promise.all([rsp.arrayBuffer(), rsp]);
-//       }
-//     })
-//     .then(([d, r]) => {
-//       return {
-//         data: d,
-//         status: r.status,
-//         statusText: r.statusText,
-//         headers: r.headers,
-//       };
-//     });
-//   // console.log("using fetch");
-//   return r;
-// });
-import { AuthType, BufferLike, createClient } from "webdav/web";
-export type { WebDAVClient } from "webdav/web";
+
+// @ts-ignore
+import { AuthType, BufferLike, createClient } from "webdav/dist/web/index.js";
+export type { WebDAVClient } from "webdav";
 
 export const DEFAULT_WEBDAV_CONFIG = {
   address: "",
@@ -119,37 +140,40 @@ export const DEFAULT_WEBDAV_CONFIG = {
   authType: "basic",
   manualRecursive: false,
   depth: "auto_unknown",
+  remoteBaseDir: "",
 } as WebdavConfig;
 
-const getWebdavPath = (fileOrFolderPath: string, vaultName: string) => {
+const getWebdavPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
   let key = fileOrFolderPath;
   if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
     // special
-    key = `/${vaultName}/`;
+    key = `/${remoteBaseDir}/`;
   }
   if (!fileOrFolderPath.startsWith("/")) {
-    key = `/${vaultName}/${fileOrFolderPath}`;
+    key = `/${remoteBaseDir}/${fileOrFolderPath}`;
   }
   return key;
 };
 
-const getNormPath = (fileOrFolderPath: string, vaultName: string) => {
+const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
   if (
     !(
-      fileOrFolderPath === `/${vaultName}` ||
-      fileOrFolderPath.startsWith(`/${vaultName}/`)
+      fileOrFolderPath === `/${remoteBaseDir}` ||
+      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) => {
-  let key = getNormPath(x.filename, vaultName);
+const fromWebdavItemToRemoteItem = (x: FileStat, remoteBaseDir: string) => {
+  let key = getNormPath(x.filename, remoteBaseDir);
   if (x.type === "directory" && !key.endsWith("/")) {
     key = `${key}/`;
   }
@@ -164,23 +188,26 @@ const fromWebdavItemToRemoteItem = (x: FileStat, vaultName: string) => {
 
 export class WrappedWebdavClient {
   webdavConfig: WebdavConfig;
-  vaultName: string;
+  remoteBaseDir: string;
   client: WebDAVClient;
   vaultFolderExists: boolean;
   saveUpdatedConfigFunc: () => Promise<any>;
   constructor(
     webdavConfig: WebdavConfig,
-    vaultName: string,
+    remoteBaseDir: string,
     saveUpdatedConfigFunc: () => Promise<any>
   ) {
     this.webdavConfig = webdavConfig;
-    this.vaultName = vaultName;
+    this.remoteBaseDir = remoteBaseDir;
     this.vaultFolderExists = false;
     this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
   }
 
   init = async () => {
     // init client if not inited
+    const headers = {
+      "Cache-Control": "no-cache",
+    };
     if (this.client === undefined) {
       if (
         this.webdavConfig.username !== "" &&
@@ -189,6 +216,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
@@ -196,7 +224,9 @@ export class WrappedWebdavClient {
         });
       } else {
         log.info("no password");
-        this.client = createClient(this.webdavConfig.address);
+        this.client = createClient(this.webdavConfig.address, {
+          headers: headers,
+        });
       }
     }
 
@@ -204,13 +234,13 @@ export class WrappedWebdavClient {
     if (this.vaultFolderExists) {
       // pass
     } else {
-      const res = await this.client.exists(`/${this.vaultName}`);
+      const res = await this.client.exists(`/${this.remoteBaseDir}/`);
       if (res) {
         // log.info("remote vault folder exits!");
         this.vaultFolderExists = true;
       } else {
         log.info("remote vault folder not exists, creating");
-        await this.client.createDirectory(`/${this.vaultName}`);
+        await this.client.createDirectory(`/${this.remoteBaseDir}/`);
         log.info("remote vault folder created!");
         this.vaultFolderExists = true;
       }
@@ -220,13 +250,14 @@ export class WrappedWebdavClient {
     if (this.webdavConfig.depth === "auto_unknown") {
       let testPassed = false;
       try {
-        const res = await this.client.customRequest(`/${this.vaultName}`, {
+        const res = await this.client.customRequest(`/${this.remoteBaseDir}/`, {
           method: "PROPFIND",
           headers: {
-            Depth: "Infinity",
+            Depth: "infinity",
+            Accept: "text/plain,application/xml",
           },
-          responseType: "text",
-        });
+          // responseType: "text",
+        } as any);
         if (res.status === 403) {
           throw Error("not support Infinity, get 403");
         } else {
@@ -239,13 +270,17 @@ export class WrappedWebdavClient {
       }
       if (!testPassed) {
         try {
-          const res = await this.client.customRequest(`/${this.vaultName}`, {
+          const res = await this.client.customRequest(
+            `/${this.remoteBaseDir}/`,
+            {
               method: "PROPFIND",
               headers: {
                 Depth: "1",
+                Accept: "text/plain,application/xml",
               },
-            responseType: "text",
-          });
+              // responseType: "text",
+            } as any
+          );
           testPassed = true;
           this.webdavConfig.depth = "auto_1";
           this.webdavConfig.manualRecursive = true;
@@ -269,12 +304,12 @@ export class WrappedWebdavClient {
 
 export const getWebdavClient = (
   webdavConfig: WebdavConfig,
-  vaultName: string,
+  remoteBaseDir: string,
   saveUpdatedConfigFunc: () => Promise<any>
 ) => {
   return new WrappedWebdavClient(
     webdavConfig,
-    vaultName,
+    remoteBaseDir,
     saveUpdatedConfigFunc
   );
 };
@@ -284,12 +319,12 @@ export const getRemoteMeta = async (
   fileOrFolderPath: string
 ) => {
   await client.init();
-  const remotePath = getWebdavPath(fileOrFolderPath, client.vaultName);
+  const remotePath = getWebdavPath(fileOrFolderPath, client.remoteBaseDir);
   // log.info(`remotePath = ${remotePath}`);
   const res = (await client.client.stat(remotePath, {
     details: false,
   })) as FileStat;
-  return fromWebdavItemToRemoteItem(res, client.vaultName);
+  return fromWebdavItemToRemoteItem(res, client.remoteBaseDir);
 };
 
 export const uploadToRemote = async (
@@ -307,7 +342,7 @@ export const uploadToRemote = async (
   if (password !== "") {
     uploadFile = remoteEncryptedKey;
   }
-  uploadFile = getWebdavPath(uploadFile, client.vaultName);
+  uploadFile = getWebdavPath(uploadFile, client.remoteBaseDir);
 
   const isFolder = fileOrFolderPath.endsWith("/");
 
@@ -321,7 +356,7 @@ export const uploadToRemote = async (
     if (password === "") {
       // if not encrypted, mkdir a remote folder
       await client.client.createDirectory(uploadFile, {
-        recursive: true,
+        recursive: false, // the sync algo should guarantee no need to recursive
       });
       const res = await getRemoteMeta(client, uploadFile);
       return res;
@@ -353,11 +388,12 @@ export const uploadToRemote = async (
     if (password !== "") {
       remoteContent = await encryptArrayBuffer(localContent, password);
     }
-    // we need to create folders before uploading
-    const dir = getPathFolder(uploadFile);
-    if (dir !== "/" && dir !== "") {
-      await client.client.createDirectory(dir, { recursive: true });
-    }
+    // updated 20220326: the algorithm guarantee this
+    // // we need to create folders before uploading
+    // const dir = getPathFolder(uploadFile);
+    // if (dir !== "/" && dir !== "") {
+    //   await client.client.createDirectory(dir, { recursive: false });
+    // }
     await client.client.putFileContents(uploadFile, remoteContent, {
       overwrite: true,
       onUploadProgress: (progress: any) => {
@@ -385,7 +421,7 @@ export const listFromRemote = async (
   ) {
     // the remote doesn't support infinity propfind,
     // we need to do a bfs here
-    const q = new Queue([`/${client.vaultName}`]);
+    const q = new Queue([`/${client.remoteBaseDir}`]);
     const CHUNK_SIZE = 10;
     while (q.length > 0) {
       const itemsToFetch = [];
@@ -420,7 +456,7 @@ export const listFromRemote = async (
   } else {
     // the remote supports infinity propfind
     contents = (await client.client.getDirectoryContents(
-      `/${client.vaultName}`,
+      `/${client.remoteBaseDir}`,
       {
         deep: true,
         details: false /* no need for verbose details here */,
@@ -433,7 +469,7 @@ export const listFromRemote = async (
   }
   return {
     Contents: contents.map((x) =>
-      fromWebdavItemToRemoteItem(x, client.vaultName)
+      fromWebdavItemToRemoteItem(x, client.remoteBaseDir)
     ),
   };
 };
@@ -443,9 +479,9 @@ const downloadFromRemoteRaw = async (
   fileOrFolderPath: string
 ) => {
   await client.init();
-  const buff = (await client.client.getFileContents(
-    getWebdavPath(fileOrFolderPath, client.vaultName)
-  )) as BufferLike;
+  const p = getWebdavPath(fileOrFolderPath, client.remoteBaseDir);
+  // console.log(`getWebdavPath=${p}`);
+  const buff = (await client.client.getFileContents(p)) as BufferLike;
   if (buff instanceof ArrayBuffer) {
     return buff;
   } else if (buff instanceof Buffer) {
@@ -483,7 +519,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 !== "") {
@@ -511,7 +548,7 @@ export const deleteFromRemote = async (
   if (password !== "") {
     remoteFileName = remoteEncryptedKey;
   }
-  remoteFileName = getWebdavPath(remoteFileName, client.vaultName);
+  remoteFileName = getWebdavPath(remoteFileName, client.remoteBaseDir);
 
   await client.init();
   try {
@@ -523,15 +560,40 @@ export const deleteFromRemote = async (
   }
 };
 
-export const checkConnectivity = async (client: WrappedWebdavClient) => {
+export const checkConnectivity = async (
+  client: WrappedWebdavClient,
+  callbackFunc?: any
+) => {
+  if (
+    !(
+      client.webdavConfig.address.startsWith("http://") ||
+      client.webdavConfig.address.startsWith("https://")
+    )
+  ) {
+    const err = "Error: the url should start with http(s):// but it does not!";
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
+    return false;
+  }
   try {
     await client.init();
     const results = await getRemoteMeta(client, "/");
     if (results === undefined) {
+      const err = "results is undefined";
+      log.debug(err);
+      if (callbackFunc !== undefined) {
+        callbackFunc(err);
+      }
       return false;
     }
     return true;
   } catch (err) {
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };

src/sync.ts

@@ -5,18 +5,22 @@ import {
   Vault,
   requireApiVersion,
 } from "obsidian";
+import AggregateError from "aggregate-error";
 import PQueue from "p-queue";
-import {
+import XRegExp from "xregexp";
+import type {
   RemoteItem,
-  SUPPORTED_SERVICES_TYPE,
+  SyncTriggerSourceType,
   DecisionType,
   FileOrFolderMixedState,
-  API_VER_STAT_FOLDER,
+  SUPPORTED_SERVICES_TYPE,
 } from "./baseTypes";
+import { API_VER_STAT_FOLDER } from "./baseTypes";
 import {
   decryptBase32ToString,
   decryptBase64urlToString,
   encryptStringToBase64url,
+  getSizeFromOrigToEnc,
   MAGIC_ENCRYPTED_PREFIX_BASE32,
   MAGIC_ENCRYPTED_PREFIX_BASE64URL,
 } from "./encrypt";
@@ -33,6 +37,8 @@ import {
   getFolderLevels,
   getParentFolder,
   atWhichLevel,
+  unixTimeToStr,
+  statFix,
 } from "./misc";
 import { RemoteClient } from "./remote";
 import {
@@ -46,8 +52,7 @@ import {
 } from "./metadataOnRemote";
 import { isInsideObsFolder, ObsConfigDirFileType } from "./obsFolderLister";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 export type SyncStatusType =
   | "idle"
@@ -63,6 +68,8 @@ export type SyncStatusType =
 
 export interface SyncPlanType {
   ts: number;
+  tsFmt?: string;
+  syncTriggerSource?: SyncTriggerSourceType;
   remoteType: SUPPORTED_SERVICES_TYPE;
   mixedStates: Record<string, FileOrFolderMixedState>;
 }
@@ -212,22 +219,32 @@ export const parseRemoteItems = async (
     let r = {} as FileOrFolderMixedState;
     if (backwardMapping !== undefined) {
       key = backwardMapping.localKey;
+      const mtimeRemote = backwardMapping.localMtime || entry.lastModified;
+
+      // the backwardMapping.localSize is the file BEFORE encryption
+      // we want to split two sizes for comparation later
+
       r = {
         key: key,
         existRemote: true,
-        mtimeRemote: backwardMapping.localMtime || entry.lastModified,
-        sizeRemote: backwardMapping.localSize || entry.size,
+        mtimeRemote: mtimeRemote,
+        mtimeRemoteFmt: unixTimeToStr(mtimeRemote),
+        sizeRemote: backwardMapping.localSize,
+        sizeRemoteEnc: password === "" ? undefined : entry.size,
         remoteEncryptedKey: remoteEncryptedKey,
-        changeMtimeUsingMapping: true,
+        changeRemoteMtimeUsingMapping: true,
       };
     } else {
+      // do not have backwardMapping
       r = {
         key: key,
         existRemote: true,
         mtimeRemote: entry.lastModified,
-        sizeRemote: entry.size,
+        mtimeRemoteFmt: unixTimeToStr(entry.lastModified),
+        sizeRemote: password === "" ? entry.size : undefined,
+        sizeRemoteEnc: password === "" ? undefined : entry.size,
         remoteEncryptedKey: remoteEncryptedKey,
-        changeMtimeUsingMapping: false,
+        changeRemoteMtimeUsingMapping: false,
       };
     }
 
@@ -277,8 +294,16 @@ const isSkipItem = (
   key: string,
   syncConfigDir: boolean,
   syncUnderscoreItems: boolean,
-  configDir: string
+  configDir: string,
+  ignorePaths: string[]
 ) => {
+  if (ignorePaths !== undefined && ignorePaths.length > 0) {
+    for (const r of ignorePaths) {
+      if (XRegExp(r, "A").test(key)) {
+        return true;
+      }
+    }
+  }
   if (syncConfigDir && isInsideObsFolder(key, configDir)) {
     return false;
   }
@@ -295,17 +320,27 @@ const ensembleMixedStates = async (
   local: TAbstractFile[],
   localConfigDirContents: ObsConfigDirFileType[] | undefined,
   remoteDeleteHistory: DeletionOnRemote[],
-  localDeleteHistory: FileFolderHistoryRecord[],
+  localFileHistory: FileFolderHistoryRecord[],
   syncConfigDir: boolean,
   configDir: string,
-  syncUnderscoreItems: boolean
+  syncUnderscoreItems: boolean,
+  ignorePaths: string[],
+  password: string
 ) => {
   const results = {} as Record<string, FileOrFolderMixedState>;
 
   for (const r of remoteStates) {
     const key = r.key;
 
-    if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
+    if (
+      isSkipItem(
+        key,
+        syncConfigDir,
+        syncUnderscoreItems,
+        configDir,
+        ignorePaths
+      )
+    ) {
       continue;
     }
     results[key] = r;
@@ -320,11 +355,15 @@ const ensembleMixedStates = async (
       // ignore
       continue;
     } else if (entry instanceof TFile) {
+      const mtimeLocal = Math.max(entry.stat.mtime ?? 0, entry.stat.ctime ?? 0);
       r = {
         key: entry.path,
         existLocal: true,
-        mtimeLocal: Math.max(entry.stat.mtime, entry.stat.ctime),
+        mtimeLocal: mtimeLocal,
+        mtimeLocalFmt: unixTimeToStr(mtimeLocal),
         sizeLocal: entry.stat.size,
+        sizeLocalEnc:
+          password === "" ? undefined : getSizeFromOrigToEnc(entry.stat.size),
       };
     } else if (entry instanceof TFolder) {
       key = `${entry.path}/`;
@@ -332,13 +371,23 @@ const ensembleMixedStates = async (
         key: key,
         existLocal: true,
         mtimeLocal: undefined,
+        mtimeLocalFmt: undefined,
         sizeLocal: 0,
+        sizeLocalEnc: password === "" ? undefined : getSizeFromOrigToEnc(0),
       };
     } else {
       throw Error(`unexpected ${entry}`);
     }
 
-    if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
+    if (
+      isSkipItem(
+        key,
+        syncConfigDir,
+        syncUnderscoreItems,
+        configDir,
+        ignorePaths
+      )
+    ) {
       continue;
     }
 
@@ -346,7 +395,9 @@ const ensembleMixedStates = async (
       results[key].key = r.key;
       results[key].existLocal = r.existLocal;
       results[key].mtimeLocal = r.mtimeLocal;
+      results[key].mtimeLocalFmt = r.mtimeLocalFmt;
       results[key].sizeLocal = r.sizeLocal;
+      results[key].sizeLocalEnc = r.sizeLocalEnc;
     } else {
       results[key] = r;
       results[key].existRemote = false;
@@ -356,18 +407,39 @@ const ensembleMixedStates = async (
   if (syncConfigDir && localConfigDirContents !== undefined) {
     for (const entry of localConfigDirContents) {
       const key = entry.key;
+      let mtimeLocal = Math.max(entry.mtime ?? 0, entry.ctime ?? 0);
+      if (Number.isNaN(mtimeLocal) || mtimeLocal === 0) {
+        mtimeLocal = undefined;
+      }
       const r: FileOrFolderMixedState = {
         key: key,
         existLocal: true,
-        mtimeLocal: Math.max(entry.mtime, entry.ctime),
+        mtimeLocal: mtimeLocal,
+        mtimeLocalFmt: unixTimeToStr(mtimeLocal),
         sizeLocal: entry.size,
+        sizeLocalEnc:
+          password === "" ? undefined : getSizeFromOrigToEnc(entry.size),
       };
 
+      if (
+        isSkipItem(
+          key,
+          syncConfigDir,
+          syncUnderscoreItems,
+          configDir,
+          ignorePaths
+        )
+      ) {
+        continue;
+      }
+
       if (results.hasOwnProperty(key)) {
         results[key].key = r.key;
         results[key].existLocal = r.existLocal;
         results[key].mtimeLocal = r.mtimeLocal;
+        results[key].mtimeLocalFmt = r.mtimeLocalFmt;
         results[key].sizeLocal = r.sizeLocal;
+        results[key].sizeLocalEnc = r.sizeLocalEnc;
       } else {
         results[key] = r;
         results[key].existRemote = false;
@@ -380,15 +452,25 @@ const ensembleMixedStates = async (
     const r = {
       key: key,
       deltimeRemote: entry.actionWhen,
+      deltimeRemoteFmt: unixTimeToStr(entry.actionWhen),
     } as FileOrFolderMixedState;
 
-    if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
+    if (
+      isSkipItem(
+        key,
+        syncConfigDir,
+        syncUnderscoreItems,
+        configDir,
+        ignorePaths
+      )
+    ) {
       continue;
     }
 
     if (results.hasOwnProperty(key)) {
       results[key].key = r.key;
       results[key].deltimeRemote = r.deltimeRemote;
+      results[key].deltimeRemoteFmt = r.deltimeRemoteFmt;
     } else {
       results[key] = r;
 
@@ -397,7 +479,7 @@ const ensembleMixedStates = async (
     }
   }
 
-  for (const entry of localDeleteHistory) {
+  for (const entry of localFileHistory) {
     let key = entry.key;
     if (entry.keyType === "folder") {
       if (!entry.key.endsWith("/")) {
@@ -409,23 +491,67 @@ const ensembleMixedStates = async (
       throw Error(`unexpected ${entry}`);
     }
 
-    const r = {
-      key: key,
-      deltimeLocal: entry.actionWhen,
-    } as FileOrFolderMixedState;
-
-    if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
+    if (
+      isSkipItem(
+        key,
+        syncConfigDir,
+        syncUnderscoreItems,
+        configDir,
+        ignorePaths
+      )
+    ) {
       continue;
     }
 
+    if (entry.actionType === "delete" || entry.actionType === "rename") {
+      const r = {
+        key: key,
+        deltimeLocal: entry.actionWhen,
+        deltimeLocalFmt: unixTimeToStr(entry.actionWhen),
+      } as FileOrFolderMixedState;
+
       if (results.hasOwnProperty(key)) {
-      results[key].key = r.key;
         results[key].deltimeLocal = r.deltimeLocal;
+        results[key].deltimeLocalFmt = r.deltimeLocalFmt;
       } else {
         results[key] = r;
-
-      results[key].existLocal = false;
-      results[key].existRemote = false;
+        results[key].existLocal = false; // we have already checked local
+        results[key].existRemote = false; // we have already checked remote
+      }
+    } else if (entry.actionType === "renameDestination") {
+      const r = {
+        key: key,
+        mtimeLocal: entry.actionWhen,
+        mtimeLocalFmt: unixTimeToStr(entry.actionWhen),
+        changeLocalMtimeUsingMapping: true,
+      };
+      if (results.hasOwnProperty(key)) {
+        let mtimeLocal = Math.max(
+          r.mtimeLocal ?? 0,
+          results[key].mtimeLocal ?? 0
+        );
+        if (Number.isNaN(mtimeLocal) || mtimeLocal === 0) {
+          mtimeLocal = undefined;
+        }
+        results[key].mtimeLocal = mtimeLocal;
+        results[key].mtimeLocalFmt = unixTimeToStr(mtimeLocal);
+        results[key].changeLocalMtimeUsingMapping =
+          r.changeLocalMtimeUsingMapping;
+      } else {
+        // So, the file doesn't exist,
+        // except that it existed in the "renamed to" history records.
+        // Most likely because that the user deleted the file while Obsidian was closed,
+        // so Obsidian could not track the deletions.
+        // We are not sure how to deal with this, so do not generate anything here!
+        // // // The following 3 lines are of old logic, and have been removed:
+        // // results[key] = r;
+        // // results[key].existLocal = false; // we have already checked local
+        // // results[key].existRemote = false; // we have already checked remote
+      }
+    } else {
+      throw Error(
+        `do not know how to deal with local file history ${entry.key} with ${entry.actionType}`
+      );
     }
   }
 
@@ -435,6 +561,7 @@ const ensembleMixedStates = async (
 const assignOperationToFileInplace = (
   origRecord: FileOrFolderMixedState,
   keptFolder: Set<string>,
+  skipSizeLargerThan: number,
   password: string = ""
 ) => {
   let r = origRecord;
@@ -450,55 +577,128 @@ const assignOperationToFileInplace = (
   // 0. find anything inconsistent
   if (r.existLocal && (r.mtimeLocal === undefined || r.mtimeLocal <= 0)) {
     throw Error(
-      `Error: File ${r.key} has a last modified time <=0 or undefined in the local file system. It's abnormal and the plugin stops.`
+      `Error: Abnormal last modified time locally: ${JSON.stringify(
+        r,
+        null,
+        2
+      )}`
     );
   }
   if (r.existRemote && (r.mtimeRemote === undefined || r.mtimeRemote <= 0)) {
     throw Error(
-      `Error: File ${r.key} has a last modified time <=0 or undefined on the remote service. It's abnormal and the plugin stops.`
+      `Error: Abnormal last modified time remotely: ${JSON.stringify(
+        r,
+        null,
+        2
+      )}`
     );
   }
   if (r.deltimeLocal !== undefined && r.deltimeLocal <= 0) {
     throw Error(
-      `Error: File ${r.key} has a local deletion time <=0. It's abnormal and the plugin stops.`
+      `Error: Abnormal deletion time locally: ${JSON.stringify(r, null, 2)}`
     );
   }
   if (r.deltimeRemote !== undefined && r.deltimeRemote <= 0) {
     throw Error(
-      `Error: File ${r.key} has a remote deletion time <=0. It's abnormal and the plugin stops.`
+      `Error: Abnormal deletion time remotely: ${JSON.stringify(r, null, 2)}`
     );
   }
 
+  if (
+    (r.existLocal && password !== "" && r.sizeLocalEnc === undefined) ||
+    (r.existRemote && password !== "" && r.sizeRemoteEnc === undefined)
+  ) {
+    throw new Error(
+      `Error: No encryption sizes: ${JSON.stringify(r, null, 2)}`
+    );
+  }
+
+  const sizeLocalComp = password === "" ? r.sizeLocal : r.sizeLocalEnc;
+  const sizeRemoteComp = password === "" ? r.sizeRemote : r.sizeRemoteEnc;
+
   // 1. mtimeLocal
   if (r.existLocal) {
     const mtimeRemote = r.existRemote ? r.mtimeRemote : -1;
-    const deltime_remote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
+    const deltimeRemote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
     const deltimeLocal = r.deltimeLocal !== undefined ? r.deltimeLocal : -1;
     if (
       r.mtimeLocal >= mtimeRemote &&
       r.mtimeLocal >= deltimeLocal &&
-      r.mtimeLocal >= deltime_remote
+      r.mtimeLocal >= deltimeRemote
     ) {
+      if (sizeLocalComp === undefined) {
+        throw new Error(
+          `Error: no local size but has local mtime: ${JSON.stringify(
+            r,
+            null,
+            2
+          )}`
+        );
+      }
       if (r.mtimeLocal === r.mtimeRemote) {
-        // mtime the same
-        if (password === "") {
-          // no password, we can also compare the sizes!
-          if (r.sizeLocal === r.sizeRemote) {
+        // local and remote both exist and mtimes are the same
+        if (sizeLocalComp === sizeRemoteComp) {
+          // do not need to consider skipSizeLargerThan in this case
           r.decision = "skipUploading";
           r.decisionBranch = 1;
         } else {
+          if (skipSizeLargerThan <= 0) {
             r.decision = "uploadLocalToRemote";
             r.decisionBranch = 2;
+          } else {
+            // limit the sizes
+            if (sizeLocalComp <= skipSizeLargerThan) {
+              if (sizeRemoteComp <= skipSizeLargerThan) {
+                r.decision = "uploadLocalToRemote";
+                r.decisionBranch = 18;
+              } else {
+                r.decision = "errorRemoteTooLargeConflictLocal";
+                r.decisionBranch = 19;
               }
             } else {
-          // we have password, then the sizes are always unequal
-          // we can only rely on mtime
-          r.decision = "skipUploading";
-          r.decisionBranch = 3;
+              if (sizeRemoteComp <= skipSizeLargerThan) {
+                r.decision = "errorLocalTooLargeConflictRemote";
+                r.decisionBranch = 20;
+              } else {
+                r.decision = "skipUploadingTooLarge";
+                r.decisionBranch = 21;
+              }
+            }
+          }
         }
       } else {
+        // we have local laregest mtime,
+        // and the remote not existing or smaller mtime
+        if (skipSizeLargerThan <= 0) {
+          // no need to consider sizes
           r.decision = "uploadLocalToRemote";
           r.decisionBranch = 4;
+        } else {
+          // need to consider sizes
+          if (sizeLocalComp <= skipSizeLargerThan) {
+            if (sizeRemoteComp === undefined) {
+              r.decision = "uploadLocalToRemote";
+              r.decisionBranch = 22;
+            } else if (sizeRemoteComp <= skipSizeLargerThan) {
+              r.decision = "uploadLocalToRemote";
+              r.decisionBranch = 23;
+            } else {
+              r.decision = "errorRemoteTooLargeConflictLocal";
+              r.decisionBranch = 24;
+            }
+          } else {
+            if (sizeRemoteComp === undefined) {
+              r.decision = "skipUploadingTooLarge";
+              r.decisionBranch = 25;
+            } else if (sizeRemoteComp <= skipSizeLargerThan) {
+              r.decision = "errorLocalTooLargeConflictRemote";
+              r.decisionBranch = 26;
+            } else {
+              r.decision = "skipUploadingTooLarge";
+              r.decisionBranch = 27;
+            }
+          }
+        }
       }
       keptFolder.add(getParentFolder(r.key));
       return r;
@@ -508,15 +708,56 @@ const assignOperationToFileInplace = (
   // 2. mtimeRemote
   if (r.existRemote) {
     const mtimeLocal = r.existLocal ? r.mtimeLocal : -1;
-    const deltime_remote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
+    const deltimeRemote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
     const deltimeLocal = r.deltimeLocal !== undefined ? r.deltimeLocal : -1;
     if (
       r.mtimeRemote > mtimeLocal &&
       r.mtimeRemote >= deltimeLocal &&
-      r.mtimeRemote >= deltime_remote
+      r.mtimeRemote >= deltimeRemote
     ) {
+      // we have remote laregest mtime,
+      // and the local not existing or smaller mtime
+      if (sizeRemoteComp === undefined) {
+        throw new Error(
+          `Error: no remote size but has remote mtime: ${JSON.stringify(
+            r,
+            null,
+            2
+          )}`
+        );
+      }
+
+      if (skipSizeLargerThan <= 0) {
+        // no need to consider sizes
         r.decision = "downloadRemoteToLocal";
         r.decisionBranch = 5;
+      } else {
+        // need to consider sizes
+        if (sizeRemoteComp <= skipSizeLargerThan) {
+          if (sizeLocalComp === undefined) {
+            r.decision = "downloadRemoteToLocal";
+            r.decisionBranch = 28;
+          } else if (sizeLocalComp <= skipSizeLargerThan) {
+            r.decision = "downloadRemoteToLocal";
+            r.decisionBranch = 29;
+          } else {
+            r.decision = "errorLocalTooLargeConflictRemote";
+            r.decisionBranch = 30;
+          }
+        } else {
+          if (sizeLocalComp === undefined) {
+            r.decision = "skipDownloadingTooLarge";
+            r.decisionBranch = 31;
+          } else if (sizeLocalComp <= skipSizeLargerThan) {
+            r.decision = "errorRemoteTooLargeConflictLocal";
+            r.decisionBranch = 32;
+          } else {
+            r.decision = "skipDownloadingTooLarge";
+            r.decisionBranch = 33;
+          }
+        }
+      }
+
       keptFolder.add(getParentFolder(r.key));
       return r;
     }
@@ -526,22 +767,56 @@ const assignOperationToFileInplace = (
   if (r.deltimeLocal !== undefined && r.deltimeLocal !== 0) {
     const mtimeLocal = r.existLocal ? r.mtimeLocal : -1;
     const mtimeRemote = r.existRemote ? r.mtimeRemote : -1;
-    const deltime_remote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
+    const deltimeRemote = r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
     if (
       r.deltimeLocal >= mtimeLocal &&
       r.deltimeLocal >= mtimeRemote &&
-      r.deltimeLocal >= deltime_remote
+      r.deltimeLocal >= deltimeRemote
     ) {
+      if (skipSizeLargerThan <= 0) {
         r.decision = "uploadLocalDelHistToRemote";
         r.decisionBranch = 6;
         if (r.existLocal || r.existRemote) {
           // actual deletion would happen
         }
+      } else {
+        const localTooLargeToDelete =
+          r.existLocal && sizeLocalComp > skipSizeLargerThan;
+        const remoteTooLargeToDelete =
+          r.existRemote && sizeRemoteComp > skipSizeLargerThan;
+        if (localTooLargeToDelete) {
+          if (remoteTooLargeToDelete) {
+            r.decision = "skipUsingLocalDelTooLarge";
+            r.decisionBranch = 34;
+          } else {
+            if (r.existRemote) {
+              r.decision = "errorLocalTooLargeConflictRemote";
+              r.decisionBranch = 35;
+            } else {
+              r.decision = "skipUsingLocalDelTooLarge";
+              r.decisionBranch = 36;
+            }
+          }
+        } else {
+          if (remoteTooLargeToDelete) {
+            if (r.existLocal) {
+              r.decision = "errorLocalTooLargeConflictRemote";
+              r.decisionBranch = 37;
+            } else {
+              r.decision = "skipUsingLocalDelTooLarge";
+              r.decisionBranch = 38;
+            }
+          } else {
+            r.decision = "uploadLocalDelHistToRemote";
+            r.decisionBranch = 39;
+          }
+        }
+      }
       return r;
     }
   }
 
-  // 4. deltime_remote
+  // 4. deltimeRemote
   if (r.deltimeRemote !== undefined && r.deltimeRemote !== 0) {
     const mtimeLocal = r.existLocal ? r.mtimeLocal : -1;
     const mtimeRemote = r.existRemote ? r.mtimeRemote : -1;
@@ -551,11 +826,45 @@ const assignOperationToFileInplace = (
       r.deltimeRemote >= mtimeRemote &&
       r.deltimeRemote >= deltimeLocal
     ) {
+      if (skipSizeLargerThan <= 0) {
         r.decision = "keepRemoteDelHist";
         r.decisionBranch = 7;
         if (r.existLocal || r.existRemote) {
           // actual deletion would happen
         }
+      } else {
+        const localTooLargeToDelete =
+          r.existLocal && sizeLocalComp > skipSizeLargerThan;
+        const remoteTooLargeToDelete =
+          r.existRemote && sizeRemoteComp > skipSizeLargerThan;
+        if (localTooLargeToDelete) {
+          if (remoteTooLargeToDelete) {
+            r.decision = "skipUsingRemoteDelTooLarge";
+            r.decisionBranch = 40;
+          } else {
+            if (r.existRemote) {
+              r.decision = "errorLocalTooLargeConflictRemote";
+              r.decisionBranch = 41;
+            } else {
+              r.decision = "skipUsingRemoteDelTooLarge";
+              r.decisionBranch = 42;
+            }
+          }
+        } else {
+          if (remoteTooLargeToDelete) {
+            if (r.existLocal) {
+              r.decision = "errorLocalTooLargeConflictRemote";
+              r.decisionBranch = 43;
+            } else {
+              r.decision = "skipUsingRemoteDelTooLarge";
+              r.decisionBranch = 44;
+            }
+          } else {
+            r.decision = "keepRemoteDelHist";
+            r.decisionBranch = 45;
+          }
+        }
+      }
       return r;
     }
   }
@@ -590,9 +899,14 @@ const assignOperationToFolderInplace = async (
       // if it was created after deletion, we should keep it as is
       if (requireApiVersion(API_VER_STAT_FOLDER)) {
         if (r.existLocal) {
-          const { ctime, mtime } = await vault.adapter.stat(r.key);
-          const cmtime = Math.max(ctime, mtime);
-          if (cmtime > 0 && cmtime >= deltimeLocal && cmtime >= deltimeRemote) {
+          const { ctime, mtime } = await statFix(vault, r.key);
+          const cmtime = Math.max(ctime ?? 0, mtime ?? 0);
+          if (
+            !Number.isNaN(cmtime) &&
+            cmtime > 0 &&
+            cmtime >= deltimeLocal &&
+            cmtime >= deltimeRemote
+          ) {
             keptFolder.add(getParentFolder(r.key));
             if (r.existLocal && r.existRemote) {
               r.decision = "skipFolder";
@@ -609,6 +923,31 @@ const assignOperationToFolderInplace = async (
         }
       }
 
+      // If it was moved to here, after deletion, we should keep it as is.
+      // The logic not necessarily needs API_VER_STAT_FOLDER.
+      // The folder needs this logic because it's also determined by file children.
+      // But the file do not need this logic because the mtimeLocal is checked firstly.
+      if (
+        r.existLocal &&
+        r.changeLocalMtimeUsingMapping &&
+        r.mtimeLocal > 0 &&
+        r.mtimeLocal > deltimeLocal &&
+        r.mtimeLocal > deltimeRemote
+      ) {
+        keptFolder.add(getParentFolder(r.key));
+        if (r.existLocal && r.existRemote) {
+          r.decision = "skipFolder";
+          r.decisionBranch = 16;
+        } else if (r.existLocal || r.existRemote) {
+          r.decision = "createFolder";
+          r.decisionBranch = 17;
+        } else {
+          throw Error(
+            `Error: Folder ${r.key} doesn't exist locally and remotely but is marked must be kept. Abort.`
+          );
+        }
+      }
+
       if (r.decision === undefined) {
         // not yet decided by the above reason
         if (deltimeLocal > 0 && deltimeLocal > deltimeRemote) {
@@ -664,18 +1003,25 @@ const DELETION_DECISIONS: Set<DecisionType> = new Set([
   "uploadLocalDelHistToRemoteFolder",
   "keepRemoteDelHistFolder",
 ]);
+const SIZES_GO_WRONG_DECISIONS: Set<DecisionType> = new Set([
+  "errorLocalTooLargeConflictRemote",
+  "errorRemoteTooLargeConflictLocal",
+]);
 
 export const getSyncPlan = async (
   remoteStates: FileOrFolderMixedState[],
   local: TAbstractFile[],
   localConfigDirContents: ObsConfigDirFileType[] | undefined,
   remoteDeleteHistory: DeletionOnRemote[],
-  localDeleteHistory: FileFolderHistoryRecord[],
+  localFileHistory: FileFolderHistoryRecord[],
   remoteType: SUPPORTED_SERVICES_TYPE,
+  triggerSource: SyncTriggerSourceType,
   vault: Vault,
   syncConfigDir: boolean,
   configDir: string,
   syncUnderscoreItems: boolean,
+  skipSizeLargerThan: number,
+  ignorePaths: string[],
   password: string = ""
 ) => {
   const mixedStates = await ensembleMixedStates(
@@ -683,16 +1029,19 @@ export const getSyncPlan = async (
     local,
     localConfigDirContents,
     remoteDeleteHistory,
-    localDeleteHistory,
+    localFileHistory,
     syncConfigDir,
     configDir,
-    syncUnderscoreItems
+    syncUnderscoreItems,
+    ignorePaths,
+    password
   );
 
   const sortedKeys = Object.keys(mixedStates).sort(
     (k1, k2) => k2.length - k1.length
   );
 
+  const sizesGoWrong: FileOrFolderMixedState[] = [];
   const deletions: DeletionOnRemote[] = [];
 
   const keptFolder = new Set<string>();
@@ -708,7 +1057,16 @@ export const getSyncPlan = async (
     } else {
       // get all operations of files
       // and at the same time get some helper info for folders
-      assignOperationToFileInplace(val, keptFolder, password);
+      assignOperationToFileInplace(
+        val,
+        keptFolder,
+        skipSizeLargerThan,
+        password
+      );
+    }
+
+    if (SIZES_GO_WRONG_DECISIONS.has(val.decision)) {
+      sizesGoWrong.push(val);
     }
 
     if (DELETION_DECISIONS.has(val.decision)) {
@@ -738,15 +1096,20 @@ export const getSyncPlan = async (
     }
   }
 
+  const currTs = Date.now();
+  const currTsFmt = unixTimeToStr(currTs);
   const plan = {
-    ts: Date.now(),
+    ts: currTs,
+    tsFmt: currTsFmt,
     remoteType: remoteType,
+    syncTriggerSource: triggerSource,
     mixedStates: mixedStates,
   } as SyncPlanType;
   return {
     plan: plan,
     sortedKeys: sortedKeys,
     deletions: deletions,
+    sizesGoWrong: sizesGoWrong,
   };
 };
 
@@ -928,6 +1291,14 @@ const dispatchOperationToActual = async (
     await clearDeleteRenameHistoryOfKeyAndVault(db, r.key, vaultRandomID);
   } else if (r.decision === "skipFolder") {
     // do nothing!
+  } else if (r.decision === "skipUploadingTooLarge") {
+    // do nothing!
+  } else if (r.decision === "skipDownloadingTooLarge") {
+    // do nothing!
+  } else if (r.decision === "skipUsingLocalDelTooLarge") {
+    // do nothing!
+  } else if (r.decision === "skipUsingRemoteDelTooLarge") {
+    // do nothing!
   } else {
     throw Error(`unknown decision in ${JSON.stringify(r)}`);
   }
@@ -946,7 +1317,14 @@ const splitThreeSteps = (syncPlan: SyncPlanType, sortedKeys: string[]) => {
     const key = sortedKeys[i];
     const val: FileOrFolderMixedState = Object.assign({}, mixedStates[key]); // copy to avoid issue
 
-    if (val.decision === "skipFolder" || val.decision === "skipUploading") {
+    if (
+      val.decision === "skipFolder" ||
+      val.decision === "skipUploading" ||
+      val.decision === "skipDownloadingTooLarge" ||
+      val.decision === "skipUploadingTooLarge" ||
+      val.decision === "skipUsingLocalDelTooLarge" ||
+      val.decision === "skipUsingRemoteDelTooLarge"
+    ) {
       // pass
     } else if (val.decision === "createFolder") {
       const level = atWhichLevel(key);
@@ -984,7 +1362,8 @@ const splitThreeSteps = (syncPlan: SyncPlanType, sortedKeys: string[]) => {
     }
   }
 
-  // the deletionOps should be run from shadowest to deepest
+  // the deletionOps should be run from max level to min level
+  // right now it is sorted by level from min to max (NOT length of key!)
   // so we need to reverse it!
   deletionOps.reverse(); // inplace reverse
 
@@ -1005,15 +1384,23 @@ export const doActualSync = async (
   sortedKeys: string[],
   metadataFile: FileOrFolderMixedState,
   origMetadata: MetadataOnRemote,
+  sizesGoWrong: FileOrFolderMixedState[],
   deletions: DeletionOnRemote[],
   localDeleteFunc: any,
   password: string = "",
   concurrency: number = 1,
+  callbackSizesGoWrong?: any,
   callbackSyncProcess?: any
 ) => {
   const mixedStates = syncPlan.mixedStates;
   const totalCount = sortedKeys.length || 0;
 
+  if (sizesGoWrong.length > 0) {
+    log.debug(`some sizes are larger than the threshold, abort and show hints`);
+    callbackSizesGoWrong(sizesGoWrong);
+    return;
+  }
+
   log.debug(`start syncing extra data firstly`);
   await uploadExtraMeta(
     client,
@@ -1079,6 +1466,8 @@ export const doActualSync = async (
       }
 
       const queue = new PQueue({ concurrency: concurrency, autoStart: true });
+      const potentialErrors: Error[] = [];
+      let tooManyErrors = false;
 
       for (let k = 0; k < singleLevelOps.length; ++k) {
         const val: FileOrFolderMixedState = singleLevelOps[k];
@@ -1111,10 +1500,28 @@ export const doActualSync = async (
 
           log.debug(`finished ${key}`);
         };
-        queue.add(fn);
+
+        queue.add(fn).catch((e) => {
+          const msg = `${key}: ${e.message}`;
+          potentialErrors.push(new Error(msg));
+          if (potentialErrors.length >= 3) {
+            tooManyErrors = true;
+            queue.pause();
+            queue.clear();
+          }
+        });
       }
 
       await queue.onIdle();
+
+      if (potentialErrors.length > 0) {
+        if (tooManyErrors) {
+          potentialErrors.push(
+            new Error("too many errors, stop the remaining tasks")
+          );
+        }
+        throw new AggregateError(potentialErrors);
+      }
     }
   }
 };

src/syncAlgoV2Notice.ts

@@ -1,7 +1,8 @@
 import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
 import type RemotelySavePlugin from "./main"; // unavoidable
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+import type { TransItemType } from "./i18n";
+
+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");
-
-    for (const t of texts) {
+    t("syncalgov2_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;
 }
@@ -56,3 +61,7 @@
   width: 350px;
   height: 350px;
 }
+
+.ignorepaths-textarea {
+  font-family: monospace;
+}

tests/configPersist.test.ts

@@ -23,6 +23,8 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   password: "password",
   serviceType: "s3",
   currLogLevel: "info",
+  ignorePaths: ["somefoldertoignore"],
+  enableStatusBarInfo: true,
 };
 
 describe("Config Persist tests", () => {

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

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

tests/presetRules.test.ts

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

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