Compare commits

..
29 Commits
Author SHA1 Message Date
fyears dc082016d8 bump to 0.3.6 2022-03-14 00:06:32 +08:00
fyears af93af9047 Squashed commit of sync hidden files:
commit 73967756d51d246b3ca203aa3683cdfebf567000
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Mar 13 22:41:28 2022 +0800

    fix typo

commit 08e16faa9a9ace9bec71acb723e0d70ca361d49f
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Mar 13 22:41:01 2022 +0800

    add modal in settings

commit 9db7194fa28cb62b1fa4c01ac7f746d5ac3b86a8
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Mar 13 22:03:00 2022 +0800

    working sync for .obsidian and _

commit 4be24ba092181c1c3e1aabe5e9d4e9fcff28f987
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Mar 13 16:07:10 2022 +0800

    more logic for hidden path
2022-03-13 22:42:16 +08:00
fyears 0b5b9cf51a auto add ignore file 2022-03-12 23:18:27 +08:00
fyears 915d027b12 full detect code 2022-03-12 22:42:54 +08:00
fyears 479d2a4fac draft 2022-03-12 21:35:59 +08:00
fyears 2d9610cd92 optimize folder 2022-03-11 23:21:38 +08:00
fyears 832b7e92f9 add doc for cors 2022-03-11 23:07:19 +08:00
fyears 5481316b83 0.3.5 2022-03-11 09:48:21 +08:00
fyears 6586c2a43e add doc to debug 2022-03-11 09:47:46 +08:00
fyears e1d9fc1e9c fix sync delete 2022-03-11 09:11:50 +08:00
fyears ecc46f2ea1 fully bypass cors for onedrive! 2022-03-11 09:09:41 +08:00
fyears c04876e0c5 A big commit Squashed commit of CORS:
commit 8cffa38ebae2a46b7c8e855c7b21a124e35adc89
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Thu Mar 10 23:52:56 2022 +0800

    bypass more cors for onedrive

commit 1b59ac1e58032099068aab55d22ef96c6396f203
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Wed Mar 9 23:58:28 2022 +0800

    change wordings for webdav cors

commit 73142eb18b59fff20839680e866f51cfcb0a6226
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Wed Mar 9 23:38:58 2022 +0800

    remove cors hint for webdav

commit 7dbb0b49d50e529b2b72e55ea2c8503ba7fa9268
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Wed Mar 9 23:31:54 2022 +0800

    fix webdav

commit c28c4e19720a56230d483acf306463d42e619fa4
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Wed Mar 9 23:31:35 2022 +0800

    remove more headers

commit 4eeae7043fa68d669a5c23c5549c14c1260ce638
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Wed Mar 9 23:18:32 2022 +0800

    polish cors hints for s3

commit d9e55a91a1c413e9419cd6b30a3a6e3b403d483b
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Wed Mar 9 22:40:37 2022 +0800

    fix format

commit b780a3eb4e37b05b8e8b92d6a2f9283b3459d738
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Wed Mar 9 22:37:02 2022 +0800

    finally correctly inject requestUrl into s3

commit 6a55a1a43d7653d65579ab88aa816e5d54cd276a
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Wed Mar 9 22:33:18 2022 +0800

    to arraybuffer from view

commit 2f2607b4f0a3d9db5943528ced57cb2fdb419607
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Wed Mar 9 13:31:22 2022 +0800

    add split ranges

commit ea24da24dea83fdb770e7e391cf8a2e4fea78d0d
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Mar 6 22:57:50 2022 +0800

    add settings of bypassing for s3

commit 2f099dc8ca1e66ea137b28dd329be50968734ba6
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Mar 6 22:38:07 2022 +0800

    use api ver var

commit 74c7ce2449a88cbe7c7f50cbb687b36ff3732c04
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Sun Mar 6 22:37:25 2022 +0800

    correct way to inject s3

commit f29945d73132d21b2c44472ec2cafc06b9d71e8f
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Tue Mar 1 00:09:57 2022 +0800

    add new http handler

commit d55104cb08e168cbcc243cf901cbd7f46f2e324b
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Mon Feb 28 22:59:55 2022 +0800

    add types for patch

commit 50b79ade7188ee7dfab9c1d03119585db358ba6f
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Mon Feb 28 08:25:19 2022 +0800

    remove verbose

commit 83f0e71aa15aa7586f6d4e105cd77c25c2e113ce
Author: fyears <1142836+fyears@users.noreply.github.com>
Date:   Mon Feb 28 08:25:04 2022 +0800

    patch webdav!
2022-03-10 23:54:35 +08:00
fyears 5402baed0a update link 2022-03-06 23:42:13 +08:00
fyears 5aa96a4ddb 0.3.4 2022-03-06 23:16:34 +08:00
fyears 2e6848f901 combine mtime and ctime 2022-03-06 23:15:59 +08:00
fyears 9c830c2c14 check for undefined decision 2022-03-06 19:03:24 +08:00
fyears 3574b56acb add more options to concurrency 2022-03-06 18:52:56 +08:00
fyears 18cb8ba413 add sync once after start up 2022-03-06 18:49:15 +08:00
fyears 76e61b6ebf upload and download in parallel 2022-03-06 18:12:49 +08:00
fyears 3dfe215103 better sync operations for folders 2022-03-06 13:22:24 +08:00
fyears 94c7a4a874 0.3.2 2022-03-05 22:33:45 +08:00
fyears b573b2859c add fallback for dropbox 2022-03-05 22:32:58 +08:00
fyears e2c4d158b1 fix format 2022-03-05 22:31:01 +08:00
fyears 55890611e2 fix s3 pagnation 2022-03-05 12:55:33 +08:00
fyears 5acd1551c9 change wording 2022-02-27 21:48:28 +08:00
fyears ef2c45a11d to 0.3.1 2022-02-27 21:45:38 +08:00
fyears c1771bb117 use arraybuffer instead of uint8array 2022-02-27 21:45:00 +08:00
fyears ddb86745dd add tmpl for fr 2022-02-27 21:14:20 +08:00
fyears 971719b710 add issue tmpl 2022-02-27 21:09:05 +08:00
28 changed files with 1730 additions and 275 deletions
+65
View File
@@ -0,0 +1,65 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: What did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: dropdown
id: os
attributes:
label: What OS are you using?
multiple: true
options:
- Windows
- Linux
- macOS
- iOS (iPhone, iPad)
- Android
validations:
required: true
- type: dropdown
id: service
attributes:
label: What remote cloud services are you using?
multiple: true
options:
- S3
- OneDrive for personal
- Dropbox
- webdav
- others
validations:
required: true
- type: input
id: version-plugin
attributes:
label: Version of the plugin
description: What version of the plugin are you running?
validations:
required: false
- type: input
id: version-obsidian
attributes:
label: Version of Obsidian
description: What version of Obsidian are you running?
validations:
required: false
- type: checkboxes
id: ensure-no-sensitive-information
attributes:
label: Ensure no sensitive information
description: By submitting this issue, you ensure that no sensitive information is submitted in the issue.
options:
- label: I ensure that no sensitive information is submitted in the issue.
required: true
+1
View File
@@ -0,0 +1 @@
blank_issues_enabled: false
@@ -0,0 +1,37 @@
name: Feature Request
description: Some idea about new features
title: "[Feature Request]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-are-you-expecting
attributes:
label: What feature are you suggesting?
description: What feature are you suggesting?
validations:
required: true
- type: dropdown
id: service
attributes:
label: What remote cloud services are you using, or suggesting adding the feature to?
multiple: true
options:
- S3
- OneDrive for personal
- Dropbox
- webdav
- others
validations:
required: false
- type: checkboxes
id: ensure-no-sensitive-information
attributes:
label: Ensure no sensitive information
description: By submitting this issue, you ensure that no sensitive information is submitted in the issue.
options:
- label: I ensure that no sensitive information is submitted in the issue.
required: true
+13 -5
View File
@@ -51,7 +51,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
## Download and Install ## Download and Install
- Option #1: Search in the official "community plugin list", or click [obsidian://show-plugin?id=remotely-save](obsidian://show-plugin?id=remotely-save), then install the plugin. - Option #1: Search in the official "community plugin list", or visit this: [https://obsidian.md/plugins?id=remotely-save](https://obsidian.md/plugins?id=remotely-save) (which should redirect you into Obsidian app), then install the plugin.
- Option #2: You can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin. Input `fyears/remotely-save` in the configuration of BRAT. - Option #2: You can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin. Input `fyears/remotely-save` in the configuration of BRAT.
- Option #3: [![GitHub release (latest by SemVer and asset including pre-releases)](https://img.shields.io/github/downloads-pre/fyears/remotely-save/latest/main.js?sort=semver)](https://github.com/fyears/remotely-save/releases) Manually download assets (`main.js`, `manifest.json`, `styles.css`) from the latest release. - Option #3: [![GitHub release (latest by SemVer and asset including pre-releases)](https://img.shields.io/github/downloads-pre/fyears/remotely-save/latest/main.js?sort=semver)](https://github.com/fyears/remotely-save/releases) Manually download assets (`main.js`, `manifest.json`, `styles.css`) from the latest release.
- Option #4: [![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) Every artifacts are placed in the "Summary" under every successful builds. It's automatically generated by every commit, may break something. - Option #4: [![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) Every artifacts are placed in the "Summary" under every successful builds. It's automatically generated by every commit, may break something.
@@ -61,7 +61,9 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
### S3 ### S3
- Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault. - Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
- Configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. Full example is [here](./docs/s3_cors_configure.md). It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android. - About CORS:
- If you are using Obsidian >= 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`. Full example is [here](./docs/s3_cors_configure.md). It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
- Download and enable this plugin. - Download and enable this plugin.
- Enter your information to the settings of 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. - 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.
@@ -88,9 +90,11 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
### webdav ### webdav
- **webdav support is considered experimental.** - **webdav support is considered experimental.**
- Currently only supports BASIC authorization method. - About CORS:
- Currently webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies. - If you are using Obsidian >= 0.13.25, you can skip this CORS part.
- 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. - 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. - The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
- Your data would be synced to a `${vaultName}` sub folder on your webdav server. - 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**. - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
@@ -101,6 +105,10 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
- In auto sync mode, if any error occurs, the plugin would **fail silently**. - In auto sync mode, if any error occurs, the plugin would **fail silently**.
- Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian. - Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
## How To Debug
See [here](./docs/how_to_debug/README.md) for more details.
## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code ## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
See [here](./docs/import_export_some_settings.md) for more details. See [here](./docs/import_export_some_settings.md) for more details.
+1 -1
View File
@@ -6,7 +6,7 @@ Technically, the plugin (or any plugin?) runs in the js environment provided by
Then some limitations are applied: Then some limitations are applied:
1. [The CORS policy.](./browser_env_cors.md) 1. [The CORS issue (solved in the new Obsidian version).](./browser_env_cors.md)
2. [No Node.js environment.](./browser_env_no_nodejs.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). 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) 4. [No background running after Obsidian is closes.](./browser_env_no_background_after_closing.md)
+2 -14
View File
@@ -4,18 +4,6 @@ The plugin is developed for the browser environment. The "fake" browser behind t
[MDN has a doc about CORS.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) [MDN has a doc about CORS.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
To solve the issue, we have some options: From Obsidian 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. The server side needs to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. Sometimes in the future, the header `Access-Control-Expose-Headers` with some values being set might be also needed. For using this plugin in Obsidian 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).
[Here is an example configuration for Amazon S3.](./s3_cors_configure.md)
However, some cloud services do not allow configuring or exposing these headers. (Notably most public WebDAV services.)
It's of course possible if the users build the services by themselves.
2. Obsidian implements and exposes a new api helping developers to bypass the CORS policy.
Currently (as of Feb 2022), an api `request()` indeed exists, but it only deals with text-like data, and does not support binary data or response headers reading yet.
Because this plugin allows uploading and downloading binary data, so a more feature-rich api is needed.
+11
View File
@@ -0,0 +1,11 @@
# How To Debug
Ideally, users do not need to debug anything. But if something bad happened, we have to dig into details.
## Easy: Export Sync Plans
See [here](./export_sync_plans.md).
## Advanced: Check Console Output
See [here](./check_console_output.md).
+17
View File
@@ -0,0 +1,17 @@
# Check Console Output
If you are using Obsidian on desktop, you can check the Obsidian console.
## 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".
## 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.
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.
+95
View File
@@ -0,0 +1,95 @@
# Export Sync Plans
## What's this?
Everytime the plugin starts a sync, it gathers all required information together, generates a "sync plan" of every operations to every files and folders, and assign the corresponding actual operations.
Thus, if something goes wrong, we should check the sync plan firstly.
## How To Export The Plans?
Please read through the following instructions.
### Disable Auto Sync Firstly
You should disable auto sync to avoid any unexpected running.
### Manual Sync If Not Yet
You should at least sync once, so that at least one sync plan is generated and saved. If you have synced the vualt before, there should be some sync plans already saved.
### Export To The File
Go to the plugin settings, scroll down to the section "Debug" -> "export sync plans", and click the button "Export". \*\*It would generate a new folder `_debug_remotely_save/` in your vault, and generate a file `sync_plans_hist_exported_on_{a_timestamp},md.` inside that folder.
## How To Read The Plans
Open the genrated `sync_plans_hist_exported_on_{a_timestamp},md.`. You should see a json, or multiple jsons. Every json represents a sync plan.
A sync plan looks like this:
```json
{
"ts": 1646960867560,
"remoteType": "onedrive",
"mixedStates": {
"abc.md": {
"key": "abc.md",
"existRemote": true,
"mtimeRemote": 1646566632000,
"sizeRemote": 56797,
"remoteEncryptedKey": "abc.md",
"changeMtimeUsingMapping": true,
"existLocal": true,
"mtimeLocal": 1646566632000,
"sizeLocal": 56797,
"decision": "skipUploading",
"decisionBranch": 1
},
"New folder/": {
"key": "New folder/",
"deltimeRemote": 1646925354372,
"existLocal": false,
"existRemote": false,
"decision": "keepRemoteDelHistFolder",
"decisionBranch": 9
}
}
}
```
We usually care about the `mixedStates` property. As you may guess, every item in `mixedStates` represent a file or a folder.
We should find out the file/folder we are interested in (or we believe something goes wrong), then checkout the following properties:
```
decision
What decision is made.
decisionBranch
It's a mark of the actual logic in the sync code. Useful to debug.
existRemote
Does the file/folder exist on the remote service?
mtimeRemote
The "last modeified time" on the remote service.
deltimeRemote
The "deletion time" on the remote record.
existLocal
Does the file/folder exist locally?
mtimeLocal
The max of "last modeified time" and "creation time" locally.
deltimeLocal
The "deletion time" locally.
```
The `decision` SHOULD be determined by the modified times and deletion times, by the logic described in [the doc of sync alogorithm](../sync_algorithm_v2.md). In short, we collect four timestamps (`mtimeRemote`, `deltimeRemote`, `mtimeLocal`, `deltimeLocal`), and respect the max timestamp and its corresponding operation.
## Common Issues
Some users report that their "last modeified time"s or "creation time"s are not set correctly by the operating system. In this case, the plugin cannot do anything because it determines the sync plan by comparing the timestamps. It's suggested to check the settings of the operating system or check whether other programs are doing something to the files.
+2
View File
@@ -1,5 +1,7 @@
# How To Configure S3 CORS Rules # 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.
Thanks to [@NAL100 in the Discussion](https://github.com/fyears/remotely-save/discussions/28). Thanks to [@NAL100 in the Discussion](https://github.com/fyears/remotely-save/discussions/28).
Please try this config: Please try this config:
+36 -34
View File
@@ -2,39 +2,41 @@
Here is an overview of the connectability ("connectable" or "not connectable" or "in the plan" or "never") to some services by this plugin. 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 list is for information purposes only. The list is for information purposes only.
| Service | Connectable | by S3 | by WebDAV | by other protocol | More Info | | Service | Connectable | by S3 | by WebDAV | by other protocol | can bypass CORS issue in Obsidian>=0.13.25 | need CORS config in Obsidian<0.13.25 |
| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ----------------- | ------------------------------------------------------------ | | ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------ |
| Amazon S3 | Yes | Yes | | | [CORS config needed.](./s3_cors_configure.md) | | Amazon S3 | Yes | Yes | | | Yes | [CORS config needed.](./s3_cors_configure.md) |
| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储 | Yes | Yes | | | CORS config needed. | | Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储 | Yes | Yes | | | Yes | CORS config needed. |
| Alibaba Cloud - Object Storage Service 阿里云对象存储 | Yes | Yes | | | CORS config needed. | | Alibaba Cloud - Object Storage Service 阿里云对象存储 | Yes | Yes | | | Yes | CORS config needed. |
| Backblaze B2 Cloud Storage | No | No | | | Its CORS rules doesn't allow no-http(s) origins. | | Backblaze B2 Cloud Storage | Yes | Yes | | | Yes | Its CORS rules doesn't allow no-http(s) origins. |
| [Wasabi](https://wasabi.com) | ? | ? | | | | | [Wasabi](https://wasabi.com) | ? | ? | | | | |
| [filebase](https://filebase.com/) | Yes | Yes | | | CORS config needed. | | [filebase](https://filebase.com/) | Yes | Yes | | | Yes | CORS config needed. |
| QingStor 青云 | ? | ? | | | | | QingStor 青云 | ? | ? | | | | |
| [MinIO](https://min.io/) | ? | ? | | | | | [MinIO](https://min.io/) | ? | ? | | | | |
| [WsgiDAV](https://github.com/mar10/wsgidav) | Yes | | Yes | | CORS rules can be set. | | [WsgiDAV](https://github.com/mar10/wsgidav) | Yes | | Yes | | Yes | CORS rules can be set. |
| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | ? | | ? | | Should be possible? | | [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes? | | Yes? | | Yes? | ? |
| NextCloud | No? | | No? | | No CORS config by default. | | NextCloud | Yes? | | Yes? | | Yes? | No CORS config by default. |
| OwnCloud | No? | | No? | | No CORS config by default. | | OwnCloud | Yes? | | Yes? | | Yes? | No CORS config by default. |
| Seafile | ? | | ? | | | | Seafile | Yes? | | Yes? | | Yes? | |
| `rclone serve webdav` | No | | No | | No CORS support. | | `rclone serve webdav` | Yes | | Yes | | Yes | No CORS support. |
| [Nutstore 坚果云](https://www.jianguoyun.com/) | No | | No | | No CORS support. | | [Nutstore 坚果云](https://www.jianguoyun.com/) | Yes | | Yes | | Yes | No CORS support. |
| [TeraCLOUD](https://teracloud.jp/en/) | No | | No | | No CORS support. | | [TeraCLOUD](https://teracloud.jp/en/) | Yes | | Yes | | Yes | No CORS support. |
| Dropbox | Yes | | | Yes | | | Dropbox | Yes | | | Yes | | |
| OneDrive for personal | Yes | | | Yes | | | OneDrive for personal | Yes | | | Yes | | |
| OneDrive for Business | In the plan | | | ? | | | OneDrive for Business | In the plan | | | ? | | |
| Google Drive | In the plan | | | ? | | | Google Drive | In the plan | | | ? | | |
| [Box](https://www.box.com/) | ? | | | ? | May be possible but needs further development. | | [Box](https://www.box.com/) | ? | | | May be possible but needs further development. | | |
| Google Cloud Storage | ? | | | ? | May be possible but needs further development. | | Google Cloud Storage | ? | | | May be possible but needs further development. | | |
| Microsoft Azure Blob Storage | ? | | | ? | May be possible but needs further development. | | Microsoft Azure Blob Storage | ? | | | May be possible but needs further development. | | |
| [OpenStack Storage (Swift)](https://github.com/openstack/swift) | ? | | | ? | May be possible but needs further development. | | [OpenStack Storage (Swift)](https://github.com/openstack/swift) | ? | | | May be possible but needs further development. | | |
| https://put.io/ | ? | | | ? | | | https://put.io/ | ? | | | ? | | |
| Yandex Disk | ? | | | ? | | | Yandex Disk | ? | | | ? | | |
| FTP / FTPS | Never | | | No | Technically never possible to be implemented. | | FTP / FTPS | Never | | | Technically never possible to be implemented. | | |
| SFTP | Never | | | No | Technically never possible to be implemented. | | SFTP | Never | | | Technically never possible to be implemented. | | |
| Jottacloud | No | | | No | It seems that no open api is available. | | Jottacloud | No | | | No. It seems that no open api is available. | | |
| Mega | Never | | | No | No js api is available. | | Mega | Never | | | No. No js api is available. | | |
| Git | Never | | | No | Technically very hard, if not impossible, to be implemented. | | Git | Never | | | No. Technically very hard, if not impossible, to be implemented. | | |
| | | | | | | | | | | | | | |
+2
View File
@@ -17,6 +17,8 @@ We list all combinations mutually exclusive and collectively exhaustive.
### Files ### Files
In short, we collect four timestamps, and respect the max timestamp and its corresponding operation.
| t1 | t2 | t3 | t4 | local file to do | remote file to do | local del history to do | remote del history to do | equal to sync v2 branch | | t1 | t2 | t3 | t4 | local file to do | remote file to do | local del history to do | remote del history to do | equal to sync v2 branch |
| -------------- | -------------- | -------------- | -------------- | ---------------- | ----------------- | ----------------------- | ------------------------ | ----------------------- | | -------------- | -------------- | -------------- | -------------- | ---------------- | ----------------- | ----------------------- | ------------------------ | ----------------------- |
| mtime_remote | mtime_local | deltime_remote | deltime_local | del_if_exists | del_if_exists | clean | upload_local_del_history | | | mtime_remote | mtime_local | deltime_remote | deltime_local | del_if_exists | del_if_exists | clean | upload_local_del_history | |
+2 -2
View File
@@ -1,8 +1,8 @@
{ {
"id": "remotely-save", "id": "remotely-save",
"name": "Remotely Save", "name": "Remotely Save",
"version": "0.3.0", "version": "0.3.6",
"minAppVersion": "0.12.15", "minAppVersion": "0.13.21",
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.", "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
"author": "fyears", "author": "fyears",
"authorUrl": "https://github.com/fyears", "authorUrl": "https://github.com/fyears",
+9 -3
View File
@@ -1,6 +1,6 @@
{ {
"name": "remotely-save", "name": "remotely-save",
"version": "0.3.0", "version": "0.3.6",
"description": "This is yet another sync plugin for Obsidian app.", "description": "This is yet another sync plugin for Obsidian app.",
"scripts": { "scripts": {
"dev2": "node esbuild.config.mjs", "dev2": "node esbuild.config.mjs",
@@ -52,8 +52,12 @@
}, },
"dependencies": { "dependencies": {
"@aws-sdk/client-s3": "^3.37.0", "@aws-sdk/client-s3": "^3.37.0",
"@aws-sdk/lib-storage": "^3.40.1", "@aws-sdk/fetch-http-handler": "^3.53.0",
"@aws-sdk/lib-storage": "^3.53.1",
"@aws-sdk/protocol-http": "^3.53.0",
"@aws-sdk/querystring-builder": "^3.53.0",
"@aws-sdk/signature-v4-crt": "^3.37.0", "@aws-sdk/signature-v4-crt": "^3.37.0",
"@aws-sdk/types": "^3.53.0",
"@azure/msal-node": "^1.6.0", "@azure/msal-node": "^1.6.0",
"@fyears/tsqueue": "^1.0.1", "@fyears/tsqueue": "^1.0.1",
"@microsoft/microsoft-graph-client": "^3.0.1", "@microsoft/microsoft-graph-client": "^3.0.1",
@@ -65,12 +69,14 @@
"crypto-browserify": "^3.12.0", "crypto-browserify": "^3.12.0",
"dropbox": "^10.22.0", "dropbox": "^10.22.0",
"feather-icons": "^4.28.0", "feather-icons": "^4.28.0",
"http-status-codes": "^2.2.0",
"localforage": "^1.10.0", "localforage": "^1.10.0",
"lodash": "^4.17.21", "lodash": "^4.17.21",
"loglevel": "^1.8.0", "loglevel": "^1.8.0",
"mime-types": "^2.1.33", "mime-types": "^2.1.33",
"nanoid": "^3.1.30", "nanoid": "^3.1.30",
"obsidian": "^0.12.0", "obsidian": "^0.13.26",
"p-queue": "^7.2.0",
"path-browserify": "^1.0.1", "path-browserify": "^1.0.1",
"process": "^0.11.10", "process": "^0.11.10",
"qrcode": "^1.5.0", "qrcode": "^1.5.0",
+16 -1
View File
@@ -11,6 +11,7 @@ export interface S3Config {
s3AccessKeyID: string; s3AccessKeyID: string;
s3SecretAccessKey: string; s3SecretAccessKey: string;
s3BucketName: string; s3BucketName: string;
bypassCorsLocally?: boolean;
} }
export interface DropboxConfig { export interface DropboxConfig {
@@ -25,13 +26,20 @@ export interface DropboxConfig {
} }
export type WebdavAuthType = "digest" | "basic"; export type WebdavAuthType = "digest" | "basic";
export type WebdavDepthType =
| "auto_unknown"
| "auto_1"
| "auto_infinity"
| "manual_1"
| "manual_infinity";
export interface WebdavConfig { export interface WebdavConfig {
address: string; address: string;
username: string; username: string;
password: string; password: string;
authType: WebdavAuthType; authType: WebdavAuthType;
manualRecursive: boolean; manualRecursive: boolean; // deprecated in 0.3.6, use depth
depth?: WebdavDepthType;
} }
export interface OnedriveConfig { export interface OnedriveConfig {
@@ -56,7 +64,11 @@ export interface RemotelySavePluginSettings {
currLogLevel?: string; currLogLevel?: string;
vaultRandomID?: string; vaultRandomID?: string;
autoRunEveryMilliseconds?: number; autoRunEveryMilliseconds?: number;
initRunAfterMilliseconds?: number;
agreeToUploadExtraMetadata?: boolean; agreeToUploadExtraMetadata?: boolean;
concurrency?: number;
syncConfigDir?: boolean;
syncUnderscoreItems?: boolean;
} }
export interface RemoteItem { export interface RemoteItem {
@@ -113,3 +125,6 @@ export interface FileOrFolderMixedState {
syncDone?: "done"; syncDone?: "done";
remoteEncryptedKey?: string; remoteEncryptedKey?: string;
} }
export const API_VER_STAT_FOLDER = "0.13.27";
export const API_VER_REQURL = "0.13.26";
+81 -2
View File
@@ -37,6 +37,7 @@ import { RemotelySaveSettingTab } from "./settings";
import { fetchMetadataFile, parseRemoteItems, SyncStatusType } from "./sync"; import { fetchMetadataFile, parseRemoteItems, SyncStatusType } from "./sync";
import { doActualSync, getSyncPlan, isPasswordOk } from "./sync"; import { doActualSync, getSyncPlan, isPasswordOk } from "./sync";
import { messyConfigToNormal, normalConfigToMessy } from "./configPersist"; import { messyConfigToNormal, normalConfigToMessy } from "./configPersist";
import { ObsConfigDirFileType, listFilesInObsFolder } from "./obsFolderLister";
import * as origLog from "loglevel"; import * as origLog from "loglevel";
import { DeletionOnRemote, MetadataOnRemote } from "./metadataOnRemote"; import { DeletionOnRemote, MetadataOnRemote } from "./metadataOnRemote";
@@ -53,7 +54,11 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
currLogLevel: "info", currLogLevel: "info",
vaultRandomID: "", vaultRandomID: "",
autoRunEveryMilliseconds: -1, autoRunEveryMilliseconds: -1,
initRunAfterMilliseconds: -1,
agreeToUploadExtraMetadata: false, agreeToUploadExtraMetadata: false,
concurrency: 5,
syncConfigDir: false,
syncUnderscoreItems: false,
}; };
interface OAuth2Info { interface OAuth2Info {
@@ -64,7 +69,7 @@ interface OAuth2Info {
revokeAuthSetting?: Setting; revokeAuthSetting?: Setting;
} }
type SyncTriggerSourceType = "manual" | "auto" | "dry"; type SyncTriggerSourceType = "manual" | "auto" | "dry" | "autoOnceInit";
const iconNameSyncWait = `remotely-save-sync-wait`; const iconNameSyncWait = `remotely-save-sync-wait`;
const iconNameSyncRunning = `remotely-save-sync-running`; const iconNameSyncRunning = `remotely-save-sync-running`;
@@ -152,7 +157,7 @@ export default class RemotelySavePlugin extends Plugin {
() => self.saveSettings() () => self.saveSettings()
); );
const remoteRsp = await client.listFromRemote(); const remoteRsp = await client.listFromRemote();
log.info(remoteRsp); log.debug(remoteRsp);
getNotice(`3/${MAX_STEPS} Checking password correct or not.`); getNotice(`3/${MAX_STEPS} Checking password correct or not.`);
this.syncStatus = "checking_password"; this.syncStatus = "checking_password";
@@ -188,6 +193,14 @@ export default class RemotelySavePlugin extends Plugin {
this.db, this.db,
this.settings.vaultRandomID this.settings.vaultRandomID
); );
let localConfigDirContents: ObsConfigDirFileType[] = undefined;
if (this.settings.syncConfigDir) {
localConfigDirContents = await listFilesInObsFolder(
this.app.vault.configDir,
this.app.vault,
this.manifest.id
);
}
// log.info(local); // log.info(local);
// log.info(localHistory); // log.info(localHistory);
@@ -196,9 +209,14 @@ export default class RemotelySavePlugin extends Plugin {
const { plan, sortedKeys, deletions } = await getSyncPlan( const { plan, sortedKeys, deletions } = await getSyncPlan(
remoteStates, remoteStates,
local, local,
localConfigDirContents,
origMetadataOnRemote.deletions, origMetadataOnRemote.deletions,
localHistory, localHistory,
client.serviceType, client.serviceType,
this.app.vault,
this.settings.syncConfigDir,
this.app.vault.configDir,
this.settings.syncUnderscoreItems,
this.settings.password this.settings.password
); );
log.info(plan.mixedStates); // for debugging log.info(plan.mixedStates); // for debugging
@@ -229,6 +247,7 @@ export default class RemotelySavePlugin extends Plugin {
deletions, deletions,
(key: string) => self.trash(key), (key: string) => self.trash(key),
this.settings.password, this.settings.password,
this.settings.concurrency,
(i: number, totalCount: number, pathName: string, decision: string) => (i: number, totalCount: number, pathName: string, decision: string) =>
self.setCurrSyncMsg(i, totalCount, pathName, decision) self.setCurrSyncMsg(i, totalCount, pathName, decision)
); );
@@ -296,6 +315,9 @@ export default class RemotelySavePlugin extends Plugin {
await this.checkIfOauthExpires(); await this.checkIfOauthExpires();
await this.checkIfVaultIDAssigned(); // MUST before prepareDB() await this.checkIfVaultIDAssigned(); // MUST before prepareDB()
// no need to await this
this.tryToAddIgnoreFile();
await this.prepareDB(); await this.prepareDB();
this.syncStatus = "idle"; this.syncStatus = "idle";
@@ -531,6 +553,9 @@ export default class RemotelySavePlugin extends Plugin {
if (!this.settings.agreeToUploadExtraMetadata) { if (!this.settings.agreeToUploadExtraMetadata) {
const syncAlgoV2Modal = new SyncAlgoV2Modal(this.app, this); const syncAlgoV2Modal = new SyncAlgoV2Modal(this.app, this);
syncAlgoV2Modal.open(); syncAlgoV2Modal.open();
} else {
this.enableAutoSyncIfSet();
this.enableInitSyncIfSet();
} }
} }
@@ -557,6 +582,9 @@ export default class RemotelySavePlugin extends Plugin {
if (this.settings.webdav.manualRecursive === undefined) { if (this.settings.webdav.manualRecursive === undefined) {
this.settings.webdav.manualRecursive = false; this.settings.webdav.manualRecursive = false;
} }
if (this.settings.webdav.depth === undefined) {
this.settings.webdav.depth = "auto_unknown";
}
} }
async saveSettings() { async saveSettings() {
@@ -659,11 +687,27 @@ export default class RemotelySavePlugin extends Plugin {
this.settings.autoRunEveryMilliseconds !== null && this.settings.autoRunEveryMilliseconds !== null &&
this.settings.autoRunEveryMilliseconds > 0 this.settings.autoRunEveryMilliseconds > 0
) { ) {
this.app.workspace.onLayoutReady(() => {
const intervalID = window.setInterval(() => { const intervalID = window.setInterval(() => {
this.syncRun("auto"); this.syncRun("auto");
}, this.settings.autoRunEveryMilliseconds); }, this.settings.autoRunEveryMilliseconds);
this.autoRunIntervalID = intervalID; this.autoRunIntervalID = intervalID;
this.registerInterval(intervalID); this.registerInterval(intervalID);
});
}
}
enableInitSyncIfSet() {
if (
this.settings.initRunAfterMilliseconds !== undefined &&
this.settings.initRunAfterMilliseconds !== null &&
this.settings.initRunAfterMilliseconds > 0
) {
this.app.workspace.onLayoutReady(() => {
window.setTimeout(() => {
this.syncRun("autoOnceInit");
}, this.settings.initRunAfterMilliseconds);
});
} }
} }
@@ -685,4 +729,39 @@ export default class RemotelySavePlugin extends Plugin {
const msg = `syncing progress=${i}/${totalCount},decision=${decision},path=${pathName}`; const msg = `syncing progress=${i}/${totalCount},decision=${decision},path=${pathName}`;
this.currSyncMsg = msg; this.currSyncMsg = msg;
} }
async tryToAddIgnoreFile() {
const pluginConfigDir =
this.manifest.dir ||
`${this.app.vault.configDir}/plugins/${this.manifest.dir}`;
const pluginConfigDirExists = await this.app.vault.adapter.exists(
pluginConfigDir
);
if (!pluginConfigDirExists) {
// what happened?
return;
}
const ignoreFile = `${pluginConfigDir}/.gitignore`;
const ignoreFileExists = await this.app.vault.adapter.exists(ignoreFile);
const contentText = "data.json\n";
try {
if (ignoreFileExists) {
// check empty, if empty, we can write it
// if not empty, we do nothing
const content = (await this.app.vault.adapter.read(ignoreFile)).trim();
if (content === "") {
// no need to await writing
this.app.vault.adapter.write(ignoreFile, contentText);
}
} else {
// not exists, directly create
// no need to await
this.app.vault.adapter.write(ignoreFile, contentText);
}
} catch (error) {
// just skip
}
}
} }
+43 -5
View File
@@ -10,10 +10,18 @@ const log = origLog.getLogger("rs-default");
/** /**
* If any part of the file starts with '.' or '_' then it's a hidden file. * If any part of the file starts with '.' or '_' then it's a hidden file.
* @param item * @param item
* @param loose * @param dot
* @param underscore
* @returns * @returns
*/ */
export const isHiddenPath = (item: string, loose: boolean = true) => { export const isHiddenPath = (
item: string,
dot: boolean = true,
underscore: boolean = true
) => {
if (!(dot || underscore)) {
throw Error("parameter error for isHiddenPath");
}
const k = path.posix.normalize(item); // TODO: only unix path now const k = path.posix.normalize(item); // TODO: only unix path now
const k2 = k.split("/"); // TODO: only unix path now const k2 = k.split("/"); // TODO: only unix path now
// log.info(k2) // log.info(k2)
@@ -21,10 +29,10 @@ export const isHiddenPath = (item: string, loose: boolean = true) => {
if (singlePart === "." || singlePart === ".." || singlePart === "") { if (singlePart === "." || singlePart === ".." || singlePart === "") {
continue; continue;
} }
if (singlePart[0] === ".") { if (dot && singlePart[0] === ".") {
return true; return true;
} }
if (loose && singlePart[0] === "_") { if (underscore && singlePart[0] === "_") {
return true; return true;
} }
} }
@@ -79,7 +87,9 @@ export const mkdirpInVault = async (thePath: string, vault: Vault) => {
* @param b Buffer * @param b Buffer
* @returns ArrayBuffer * @returns ArrayBuffer
*/ */
export const bufferToArrayBuffer = (b: Buffer | Uint8Array) => { export const bufferToArrayBuffer = (
b: Buffer | Uint8Array | ArrayBufferView
) => {
return b.buffer.slice(b.byteOffset, b.byteOffset + b.byteLength); return b.buffer.slice(b.byteOffset, b.byteOffset + b.byteLength);
}; };
@@ -230,3 +240,31 @@ export const getRandomArrayBuffer = (byteLength: number) => {
export const reverseString = (x: string) => { export const reverseString = (x: string) => {
return [...x].reverse().join(""); return [...x].reverse().join("");
}; };
export interface SplitRange {
partNum: number; // startting from 1
start: number;
end: number; // exclusive
}
export const getSplitRanges = (bytesTotal: number, bytesEachPart: number) => {
const res: SplitRange[] = [];
if (bytesEachPart >= bytesTotal) {
res.push({
partNum: 1,
start: 0,
end: bytesTotal,
});
return res;
}
const remainder = bytesTotal % bytesEachPart;
const howMany =
Math.floor(bytesTotal / bytesEachPart) + (remainder === 0 ? 0 : 1);
for (let i = 0; i < howMany; ++i) {
res.push({
partNum: i + 1,
start: bytesEachPart * i,
end: Math.min(bytesEachPart * (i + 1), bytesTotal),
});
}
return res;
};
+127
View File
@@ -0,0 +1,127 @@
import { Vault, Stat, ListedFiles } from "obsidian";
import { Queue } from "@fyears/tsqueue";
import chunk from "lodash/chunk";
import flatten from "lodash/flatten";
import * as origLog from "loglevel";
const log = origLog.getLogger("rs-default");
export interface ObsConfigDirFileType {
key: string;
ctime: number;
mtime: number;
size: number;
type: "folder" | "file";
}
const isFolderToSkip = (x: string) => {
let specialFolders = [".git", ".svn", "node_modules"];
for (const iterator of specialFolders) {
if (
x === iterator ||
x === `${iterator}/` ||
x.endsWith(`/${iterator}`) ||
x.endsWith(`/${iterator}/`)
) {
return true;
}
}
return false;
};
const isPluginDirItself = (x: string, pluginId: string) => {
return (
x === pluginId ||
x === `${pluginId}/` ||
x.endsWith(`/${pluginId}`) ||
x.endsWith(`/${pluginId}/`)
);
};
const isLikelyPluginSubFiles = (x: string) => {
const reqFiles = [
"data.json",
"main.js",
"manifest.json",
".gitignore",
"styles.css",
];
for (const iterator of reqFiles) {
if (x === iterator || x.endsWith(`/${iterator}`)) {
return true;
}
}
return false;
};
export const isInsideObsFolder = (x: string, configDir: string) => {
if (!configDir.startsWith(".")) {
throw Error(`configDir should starts with . but we get ${configDir}`);
}
return x === configDir || x.startsWith(`${configDir}/`);
};
export const listFilesInObsFolder = async (
configDir: string,
vault: Vault,
pluginId: string
) => {
const q = new Queue([configDir]);
const CHUNK_SIZE = 10;
const contents: ObsConfigDirFileType[] = [];
while (q.length > 0) {
const itemsToFetch = [];
while (q.length > 0) {
itemsToFetch.push(q.pop());
}
const itemsToFetchChunks = chunk(itemsToFetch, CHUNK_SIZE);
for (const singleChunk of itemsToFetchChunks) {
const r = singleChunk.map(async (x) => {
const statRes = await vault.adapter.stat(x);
const isFolder = statRes.type === "folder";
let children: ListedFiles = undefined;
if (isFolder) {
children = await vault.adapter.list(x);
}
return {
itself: {
key: isFolder ? `${x}/` : x,
...statRes,
} as ObsConfigDirFileType,
children: children,
};
});
const r2 = flatten(await Promise.all(r));
for (const iter of r2) {
contents.push(iter.itself);
const isInsideSelfPlugin = isPluginDirItself(iter.itself.key, pluginId);
if (iter.children !== undefined) {
for (const iter2 of iter.children.folders) {
if (isFolderToSkip(iter2)) {
continue;
}
if (isInsideSelfPlugin && !isLikelyPluginSubFiles(iter2)) {
// special treatment for remotely-save folder
continue;
}
q.push(iter2);
}
for (const iter2 of iter.children.files) {
if (isFolderToSkip(iter2)) {
continue;
}
if (isInsideSelfPlugin && !isLikelyPluginSubFiles(iter2)) {
// special treatment for remotely-save folder
continue;
}
q.push(iter2);
}
}
}
}
}
return contents;
};
+9 -3
View File
@@ -41,11 +41,17 @@ export class RemoteClient {
this.s3Config = s3Config; this.s3Config = s3Config;
this.s3Client = s3.getS3Client(this.s3Config); this.s3Client = s3.getS3Client(this.s3Config);
} else if (serviceType === "webdav") { } else if (serviceType === "webdav") {
if (vaultName === undefined) { if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
throw Error("remember to provide vault name while init webdav client"); throw Error(
"remember to provide vault name and callback while init webdav client"
);
} }
this.webdavConfig = webdavConfig; this.webdavConfig = webdavConfig;
this.webdavClient = webdav.getWebdavClient(this.webdavConfig, vaultName); this.webdavClient = webdav.getWebdavClient(
this.webdavConfig,
vaultName,
saveUpdatedConfigFunc
);
} else if (serviceType === "dropbox") { } else if (serviceType === "dropbox") {
if (vaultName === undefined || saveUpdatedConfigFunc === undefined) { if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
throw Error( throw Error(
+10 -3
View File
@@ -156,13 +156,20 @@ const fixLastModifiedTimeInplace = (allFilesFolders: RemoteItem[]) => {
// see https://dropbox.tech/developers/pkce--what-and-why- // see https://dropbox.tech/developers/pkce--what-and-why-
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
export const getAuthUrlAndVerifier = async (appKey: string) => { export const getAuthUrlAndVerifier = async (
appKey: string,
needManualPatse: boolean = false
) => {
const auth = new DropboxAuth({ const auth = new DropboxAuth({
clientId: appKey, clientId: appKey,
}); });
const callback = needManualPatse
? undefined
: `obsidian://${COMMAND_CALLBACK_DROPBOX}`;
const authUrl = ( const authUrl = (
await auth.getAuthenticationUrl( await auth.getAuthenticationUrl(
`obsidian://${COMMAND_CALLBACK_DROPBOX}`, callback,
undefined, undefined,
"code", "code",
"offline", "offline",
@@ -456,7 +463,7 @@ export const uploadToRemote = async (
let localContent = undefined; let localContent = undefined;
if (uploadRaw) { if (uploadRaw) {
if (typeof rawContent === "string") { if (typeof rawContent === "string") {
localContent = new TextEncoder().encode(rawContent); localContent = new TextEncoder().encode(rawContent).buffer;
} else { } else {
localContent = rawContent; localContent = rawContent;
} }
+61 -14
View File
@@ -7,8 +7,9 @@ import type {
} from "@microsoft/microsoft-graph-types"; } from "@microsoft/microsoft-graph-types";
import cloneDeep from "lodash/cloneDeep"; import cloneDeep from "lodash/cloneDeep";
import * as origLog from "loglevel"; import * as origLog from "loglevel";
import { request, Vault } from "obsidian"; import { request, requestUrl, requireApiVersion, Vault } from "obsidian";
import { import {
API_VER_REQURL,
COMMAND_CALLBACK_ONEDRIVE, COMMAND_CALLBACK_ONEDRIVE,
OAUTH2_FORCE_EXPIRE_MILLISECONDS, OAUTH2_FORCE_EXPIRE_MILLISECONDS,
OnedriveConfig, OnedriveConfig,
@@ -16,6 +17,7 @@ import {
} from "./baseTypes"; } from "./baseTypes";
import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt"; import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
import { import {
bufferToArrayBuffer,
getRandomArrayBuffer, getRandomArrayBuffer,
getRandomIntInclusive, getRandomIntInclusive,
mkdirpInVault, mkdirpInVault,
@@ -482,21 +484,37 @@ export class WrappedOnedriveClient {
deleteJson = async (pathFragOrig: string) => { deleteJson = async (pathFragOrig: string) => {
const theUrl = this.buildUrl(pathFragOrig); const theUrl = this.buildUrl(pathFragOrig);
log.debug(`deleteJson, theUrl=${theUrl}`); log.debug(`deleteJson, theUrl=${theUrl}`);
// TODO: delete does not have response, so Obsidian request may have error if (requireApiVersion(API_VER_REQURL)) {
// currently downgraded to fetch()! await requestUrl({
url: theUrl,
method: "DELETE",
headers: {
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
},
});
} else {
await fetch(theUrl, { await fetch(theUrl, {
method: "DELETE", method: "DELETE",
headers: { headers: {
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`, Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
}, },
}); });
}
}; };
putArrayBuffer = async (pathFragOrig: string, payload: ArrayBuffer) => { putArrayBuffer = async (pathFragOrig: string, payload: ArrayBuffer) => {
const theUrl = this.buildUrl(pathFragOrig); const theUrl = this.buildUrl(pathFragOrig);
log.debug(`putArrayBuffer, theUrl=${theUrl}`); log.debug(`putArrayBuffer, theUrl=${theUrl}`);
// TODO: Obsidian doesn't support ArrayBuffer if (requireApiVersion(API_VER_REQURL)) {
// currently downgraded to fetch()! await requestUrl({
url: theUrl,
method: "PUT",
body: payload,
headers: {
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
},
});
} else {
await fetch(theUrl, { await fetch(theUrl, {
method: "PUT", method: "PUT",
body: payload, body: payload,
@@ -504,6 +522,7 @@ export class WrappedOnedriveClient {
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`, Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
}, },
}); });
}
}; };
/** /**
@@ -527,9 +546,20 @@ export class WrappedOnedriveClient {
rangeEnd - 1 rangeEnd - 1
}, len=${rangeEnd - rangeStart}, size=${size}` }, len=${rangeEnd - rangeStart}, size=${size}`
); );
// TODO: Obsidian doesn't support ArrayBuffer // NO AUTH HEADER here!
// currently downgraded to fetch()! if (requireApiVersion(API_VER_REQURL)) {
// AND, NO AUTH HEADER here! const res = await requestUrl({
url: theUrl,
method: "PUT",
body: bufferToArrayBuffer(payload.subarray(rangeStart, rangeEnd)),
headers: {
// no "Content-Length" allowed here
"Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
"Content-Type": "application/octet-stream",
},
});
return res.json as DriveItem | UploadSession;
} else {
const res = await fetch(theUrl, { const res = await fetch(theUrl, {
method: "PUT", method: "PUT",
body: payload.subarray(rangeStart, rangeEnd), body: payload.subarray(rangeStart, rangeEnd),
@@ -539,8 +569,8 @@ export class WrappedOnedriveClient {
"Content-Type": "application/octet-stream", "Content-Type": "application/octet-stream",
}, },
}); });
return (await res.json()) as DriveItem | UploadSession;
return res.json() as DriveItem | UploadSession; }
}; };
} }
@@ -690,7 +720,7 @@ export const uploadToRemote = async (
let localContent = undefined; let localContent = undefined;
if (uploadRaw) { if (uploadRaw) {
if (typeof rawContent === "string") { if (typeof rawContent === "string") {
localContent = new TextEncoder().encode(rawContent); localContent = new TextEncoder().encode(rawContent).buffer;
} else { } else {
localContent = rawContent; localContent = rawContent;
} }
@@ -704,6 +734,19 @@ export const uploadToRemote = async (
// no need to create parent folders firstly, cool! // no need to create parent folders firstly, cool!
// 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
if (remoteContent.byteLength <= RANGE_SIZE) {
// directly using put!
await client.putArrayBuffer(
`${uploadFile}:/content?${new URLSearchParams({
"@microsoft.graph.conflictBehavior": "replace",
})}`,
remoteContent
);
} else {
// upload large files! // upload large files!
// ref: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createuploadsession?view=odsp-graph-online // ref: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createuploadsession?view=odsp-graph-online
@@ -724,9 +767,7 @@ export const uploadToRemote = async (
// 2. upload by ranges // 2. upload by ranges
// convert to uint8 // convert to uint8
const uint8 = new Uint8Array(remoteContent); const uint8 = new Uint8Array(remoteContent);
// hard code range size
const MIN_UNIT = 327680; // bytes in msft doc, about 0.32768 MB
const RANGE_SIZE = MIN_UNIT * 20; // about 6.5536 MB
// upload the ranges one by one // upload the ranges one by one
let rangeStart = 0; let rangeStart = 0;
while (rangeStart < uint8.byteLength) { while (rangeStart < uint8.byteLength) {
@@ -739,6 +780,7 @@ export const uploadToRemote = async (
); );
rangeStart += RANGE_SIZE; rangeStart += RANGE_SIZE;
} }
}
const res = await getRemoteMeta(client, uploadFile); const res = await getRemoteMeta(client, uploadFile);
return res; return res;
@@ -755,8 +797,13 @@ const downloadFromRemoteRaw = async (
`${key}?$select=@microsoft.graph.downloadUrl` `${key}?$select=@microsoft.graph.downloadUrl`
); );
const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"]; const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
if (requireApiVersion(API_VER_REQURL)) {
const content = (await requestUrl({ url: downloadUrl })).arrayBuffer;
return content;
} else {
const content = await (await fetch(downloadUrl)).arrayBuffer(); const content = await (await fetch(downloadUrl)).arrayBuffer();
return content; return content;
}
}; };
export const downloadFromRemote = async ( export const downloadFromRemote = async (
+142 -7
View File
@@ -11,11 +11,26 @@ import {
S3Client, S3Client,
} from "@aws-sdk/client-s3"; } from "@aws-sdk/client-s3";
import { Upload } from "@aws-sdk/lib-storage"; import { Upload } from "@aws-sdk/lib-storage";
import { HttpHandler, HttpRequest, HttpResponse } from "@aws-sdk/protocol-http";
import {
FetchHttpHandler,
FetchHttpHandlerOptions,
} from "@aws-sdk/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 { HeaderBag, HttpHandlerOptions, Provider } from "@aws-sdk/types";
import { Buffer } from "buffer"; import { Buffer } from "buffer";
import * as mime from "mime-types"; import * as mime from "mime-types";
import { Vault } from "obsidian"; import {
Vault,
requestUrl,
RequestUrlParam,
RequestUrlResponse,
requireApiVersion,
} from "obsidian";
import { Readable } from "stream"; import { Readable } from "stream";
import { RemoteItem, S3Config } from "./baseTypes"; import { API_VER_REQURL, RemoteItem, S3Config } from "./baseTypes";
import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt"; import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
import { import {
arrayBufferToBuffer, arrayBufferToBuffer,
@@ -28,12 +43,117 @@ export { S3Client } from "@aws-sdk/client-s3";
import * as origLog from "loglevel"; import * as origLog from "loglevel";
const log = origLog.getLogger("rs-default"); const log = origLog.getLogger("rs-default");
////////////////////////////////////////////////////////////////////////////////
// special handler using Obsidian requestUrl
////////////////////////////////////////////////////////////////////////////////
/**
* This is close to origin implementation of FetchHttpHandler
* https://github.com/aws/aws-sdk-js-v3/blob/main/packages/fetch-http-handler/src/fetch-http-handler.ts
* that is released under Apache 2 License.
* But this uses Obsidian requestUrl instead.
*/
class ObsHttpHandler extends FetchHttpHandler {
requestTimeoutInMs: number;
constructor(options?: FetchHttpHandlerOptions) {
super(options);
this.requestTimeoutInMs =
options === undefined ? undefined : options.requestTimeout;
}
async handle(
request: HttpRequest,
{ abortSignal }: HttpHandlerOptions = {}
): Promise<{ response: HttpResponse }> {
if (abortSignal?.aborted) {
const abortError = new Error("Request aborted");
abortError.name = "AbortError";
return Promise.reject(abortError);
}
let path = request.path;
if (request.query) {
const queryString = buildQueryString(request.query);
if (queryString) {
path += `?${queryString}`;
}
}
const { port, method } = request;
const url = `${request.protocol}//${request.hostname}${
port ? `:${port}` : ""
}${path}`;
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"];
let contentType: string = undefined;
if (transformedHeaders["content-type"] !== undefined) {
contentType = transformedHeaders["content-type"];
}
let transformedBody: any = body;
if (ArrayBuffer.isView(body)) {
transformedBody = bufferToArrayBuffer(body);
}
const param: RequestUrlParam = {
body: transformedBody,
headers: transformedHeaders,
method: method,
url: url,
contentType: contentType,
};
const raceOfPromises = [
requestUrl(param).then((rsp) => {
const stream = new ReadableStream<Uint8Array>({
start(controller) {
controller.enqueue(new Uint8Array(rsp.arrayBuffer));
controller.close();
},
});
return {
response: new HttpResponse({
headers: rsp.headers,
statusCode: rsp.status,
body: stream,
}),
};
}),
requestTimeout(this.requestTimeoutInMs),
];
if (abortSignal) {
raceOfPromises.push(
new Promise<never>((resolve, reject) => {
abortSignal.onabort = () => {
const abortError = new Error("Request aborted");
abortError.name = "AbortError";
reject(abortError);
};
})
);
}
return Promise.race(raceOfPromises);
}
}
////////////////////////////////////////////////////////////////////////////////
// other stuffs
////////////////////////////////////////////////////////////////////////////////
export const DEFAULT_S3_CONFIG = { export const DEFAULT_S3_CONFIG = {
s3Endpoint: "", s3Endpoint: "",
s3Region: "", s3Region: "",
s3AccessKeyID: "", s3AccessKeyID: "",
s3SecretAccessKey: "", s3SecretAccessKey: "",
s3BucketName: "", s3BucketName: "",
bypassCorsLocally: true,
}; };
export type S3ObjectType = _Object; export type S3ObjectType = _Object;
@@ -66,6 +186,19 @@ export const getS3Client = (s3Config: S3Config) => {
if (!(endpoint.startsWith("http://") || endpoint.startsWith("https://"))) { if (!(endpoint.startsWith("http://") || endpoint.startsWith("https://"))) {
endpoint = `https://${endpoint}`; endpoint = `https://${endpoint}`;
} }
if (requireApiVersion(API_VER_REQURL) && s3Config.bypassCorsLocally) {
const s3Client = new S3Client({
region: s3Config.s3Region,
endpoint: endpoint,
credentials: {
accessKeyId: s3Config.s3AccessKeyID,
secretAccessKey: s3Config.s3SecretAccessKey,
},
requestHandler: new ObsHttpHandler(),
});
return s3Client;
} else {
const s3Client = new S3Client({ const s3Client = new S3Client({
region: s3Config.s3Region, region: s3Config.s3Region,
endpoint: endpoint, endpoint: endpoint,
@@ -75,6 +208,7 @@ export const getS3Client = (s3Config: S3Config) => {
}, },
}); });
return s3Client; return s3Client;
}
}; };
export const getRemoteMeta = async ( export const getRemoteMeta = async (
@@ -141,7 +275,7 @@ export const uploadToRemote = async (
let localContent = undefined; let localContent = undefined;
if (uploadRaw) { if (uploadRaw) {
if (typeof rawContent === "string") { if (typeof rawContent === "string") {
localContent = new TextEncoder().encode(rawContent); localContent = new TextEncoder().encode(rawContent).buffer;
} else { } else {
localContent = rawContent; localContent = rawContent;
} }
@@ -152,12 +286,13 @@ export const uploadToRemote = async (
if (password !== "") { if (password !== "") {
remoteContent = await encryptArrayBuffer(localContent, password); remoteContent = await encryptArrayBuffer(localContent, password);
} }
const body = arrayBufferToBuffer(remoteContent);
const bytesIn5MB = 5242880;
const body = new Uint8Array(remoteContent);
const upload = new Upload({ const upload = new Upload({
client: s3Client, client: s3Client,
queueSize: 20, // concurrency queueSize: 20, // concurrency
partSize: 5242880, // minimal 5MB by default partSize: bytesIn5MB, // minimal 5MB by default
leavePartsOnError: false, leavePartsOnError: false,
params: { params: {
Bucket: s3Config.s3BucketName, Bucket: s3Config.s3BucketName,
@@ -190,7 +325,6 @@ export const listFromRemote = async (
const contents = [] as _Object[]; const contents = [] as _Object[];
let isTruncated = true; let isTruncated = true;
let continuationToken = "";
do { do {
const rsp = await s3Client.send(new ListObjectsV2Command(confCmd)); const rsp = await s3Client.send(new ListObjectsV2Command(confCmd));
@@ -206,7 +340,8 @@ export const listFromRemote = async (
confCmd.ContinuationToken = rsp.NextContinuationToken; confCmd.ContinuationToken = rsp.NextContinuationToken;
if ( if (
isTruncated && isTruncated &&
(continuationToken === undefined || continuationToken === "") (confCmd.ContinuationToken === undefined ||
confCmd.ContinuationToken === "")
) { ) {
throw Error("isTruncated is true but no continuationToken provided"); throw Error("isTruncated is true but no continuationToken provided");
} }
+183 -14
View File
@@ -1,24 +1,124 @@
import { Buffer } from "buffer"; import { Buffer } from "buffer";
import { Vault } from "obsidian"; import { Vault, request, requestUrl, requireApiVersion } from "obsidian";
import type { FileStat, WebDAVClient } from "webdav/web";
import { AuthType, BufferLike, createClient } from "webdav/web";
import { Queue } from "@fyears/tsqueue"; import { Queue } from "@fyears/tsqueue";
import chunk from "lodash/chunk"; import chunk from "lodash/chunk";
import flatten from "lodash/flatten"; import flatten from "lodash/flatten";
import type { RemoteItem, WebdavConfig } from "./baseTypes"; import { getReasonPhrase } from "http-status-codes";
import { API_VER_REQURL, RemoteItem, WebdavConfig } from "./baseTypes";
import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt"; import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
import { bufferToArrayBuffer, getPathFolder, mkdirpInVault } from "./misc"; import { bufferToArrayBuffer, getPathFolder, mkdirpInVault } from "./misc";
export type { WebDAVClient } from "webdav/web";
import * as origLog from "loglevel"; import * as origLog from "loglevel";
const log = origLog.getLogger("rs-default"); const log = origLog.getLogger("rs-default");
import type {
FileStat,
WebDAVClient,
RequestOptionsWithState,
Response,
ResponseDataDetailed,
} from "webdav/web";
import { getPatcher } from "webdav/web";
if (requireApiVersion(API_VER_REQURL)) {
getPatcher().patch(
"request",
async (
options: RequestOptionsWithState
): Promise<Response | ResponseDataDetailed<any>> => {
const transformedHeaders = { ...options.headers };
delete transformedHeaders["host"];
delete transformedHeaders["Host"];
delete transformedHeaders["content-length"];
delete transformedHeaders["Content-Length"];
const r = await requestUrl({
url: options.url,
method: options.method,
body: options.data as string | ArrayBuffer,
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}`
);
}
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";
export const DEFAULT_WEBDAV_CONFIG = { export const DEFAULT_WEBDAV_CONFIG = {
address: "", address: "",
username: "", username: "",
password: "", password: "",
authType: "basic", authType: "basic",
manualRecursive: false, manualRecursive: false,
depth: "auto_unknown",
} as WebdavConfig; } as WebdavConfig;
const getWebdavPath = (fileOrFolderPath: string, vaultName: string) => { const getWebdavPath = (fileOrFolderPath: string, vaultName: string) => {
@@ -67,10 +167,16 @@ export class WrappedWebdavClient {
vaultName: string; vaultName: string;
client: WebDAVClient; client: WebDAVClient;
vaultFolderExists: boolean; vaultFolderExists: boolean;
constructor(webdavConfig: WebdavConfig, vaultName: string) { saveUpdatedConfigFunc: () => Promise<any>;
constructor(
webdavConfig: WebdavConfig,
vaultName: string,
saveUpdatedConfigFunc: () => Promise<any>
) {
this.webdavConfig = webdavConfig; this.webdavConfig = webdavConfig;
this.vaultName = vaultName; this.vaultName = vaultName;
this.vaultFolderExists = false; this.vaultFolderExists = false;
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
} }
init = async () => { init = async () => {
@@ -109,14 +215,68 @@ export class WrappedWebdavClient {
this.vaultFolderExists = true; this.vaultFolderExists = true;
} }
} }
// adjust depth parameter
if (this.webdavConfig.depth === "auto_unknown") {
let testPassed = false;
try {
const res = await this.client.customRequest(`/${this.vaultName}`, {
method: "PROPFIND",
headers: {
Depth: "Infinity",
},
responseType: "text",
});
if (res.status === 403) {
throw Error("not support Infinity, get 403");
} else {
testPassed = true;
this.webdavConfig.depth = "auto_infinity";
this.webdavConfig.manualRecursive = false;
}
} catch (error) {
testPassed = false;
}
if (!testPassed) {
try {
const res = await this.client.customRequest(`/${this.vaultName}`, {
method: "PROPFIND",
headers: {
Depth: "1",
},
responseType: "text",
});
testPassed = true;
this.webdavConfig.depth = "auto_1";
this.webdavConfig.manualRecursive = true;
} catch (error) {
testPassed = false;
}
}
if (testPassed) {
// the depth option has been changed
// save the setting
if (this.saveUpdatedConfigFunc !== undefined) {
await this.saveUpdatedConfigFunc();
log.info(
`webdav depth="auto_unknown" is changed to ${this.webdavConfig.depth}`
);
}
}
}
}; };
} }
export const getWebdavClient = ( export const getWebdavClient = (
webdavConfig: WebdavConfig, webdavConfig: WebdavConfig,
vaultName: string vaultName: string,
saveUpdatedConfigFunc: () => Promise<any>
) => { ) => {
return new WrappedWebdavClient(webdavConfig, vaultName); return new WrappedWebdavClient(
webdavConfig,
vaultName,
saveUpdatedConfigFunc
);
}; };
export const getRemoteMeta = async ( export const getRemoteMeta = async (
@@ -169,7 +329,7 @@ export const uploadToRemote = async (
// if encrypted, upload a fake file with the encrypted file name // if encrypted, upload a fake file with the encrypted file name
await client.client.putFileContents(uploadFile, "", { await client.client.putFileContents(uploadFile, "", {
overwrite: true, overwrite: true,
onUploadProgress: (progress) => { onUploadProgress: (progress: any) => {
// log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`); // log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
}, },
}); });
@@ -182,7 +342,7 @@ export const uploadToRemote = async (
let localContent = undefined; let localContent = undefined;
if (uploadRaw) { if (uploadRaw) {
if (typeof rawContent === "string") { if (typeof rawContent === "string") {
localContent = new TextEncoder().encode(rawContent); localContent = new TextEncoder().encode(rawContent).buffer;
} else { } else {
localContent = rawContent; localContent = rawContent;
} }
@@ -200,7 +360,7 @@ export const uploadToRemote = async (
} }
await client.client.putFileContents(uploadFile, remoteContent, { await client.client.putFileContents(uploadFile, remoteContent, {
overwrite: true, overwrite: true,
onUploadProgress: (progress) => { onUploadProgress: (progress: any) => {
log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`); log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
}, },
}); });
@@ -219,7 +379,10 @@ export const listFromRemote = async (
await client.init(); await client.init();
let contents = [] as FileStat[]; let contents = [] as FileStat[];
if (client.webdavConfig.manualRecursive) { if (
client.webdavConfig.depth === "auto_1" ||
client.webdavConfig.depth === "manual_1"
) {
// the remote doesn't support infinity propfind, // the remote doesn't support infinity propfind,
// we need to do a bfs here // we need to do a bfs here
const q = new Queue([`/${client.vaultName}`]); const q = new Queue([`/${client.vaultName}`]);
@@ -237,7 +400,10 @@ export const listFromRemote = async (
return client.client.getDirectoryContents(x, { return client.client.getDirectoryContents(x, {
deep: false, deep: false,
details: false /* no need for verbose details here */, details: false /* no need for verbose details here */,
glob: "/**" /* avoid dot files by using glob */, // TODO: to support .obsidian,
// we need to load all files including dot,
// anyway to reduce the resources?
// glob: "/**" /* avoid dot files by using glob */,
}) as Promise<FileStat[]>; }) as Promise<FileStat[]>;
}); });
const r2 = flatten(await Promise.all(r)); const r2 = flatten(await Promise.all(r));
@@ -258,7 +424,10 @@ export const listFromRemote = async (
{ {
deep: true, deep: true,
details: false /* no need for verbose details here */, details: false /* no need for verbose details here */,
glob: "/**" /* avoid dot files by using glob */, // TODO: to support .obsidian,
// we need to load all files including dot,
// anyway to reduce the resources?
// glob: "/**" /* avoid dot files by using glob */,
} }
)) as FileStat[]; )) as FileStat[];
} }
+354 -21
View File
@@ -1,5 +1,18 @@
import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian"; import {
import type { SUPPORTED_SERVICES_TYPE, WebdavAuthType } from "./baseTypes"; App,
Modal,
Notice,
PluginSettingTab,
Setting,
Platform,
requireApiVersion,
} from "obsidian";
import {
API_VER_REQURL,
SUPPORTED_SERVICES_TYPE,
WebdavAuthType,
WebdavDepthType,
} from "./baseTypes";
import { exportVaultSyncPlansToFiles } from "./debugMode"; import { exportVaultSyncPlansToFiles } from "./debugMode";
import { exportQrCodeUri } from "./importExport"; import { exportQrCodeUri } from "./importExport";
import { import {
@@ -110,9 +123,36 @@ class DropboxAuthModal extends Modal {
async onOpen() { async onOpen() {
let { contentEl } = this; let { contentEl } = this;
let needManualPatse = false;
const userAgent = window.navigator.userAgent.toLocaleLowerCase() || "";
// some users report that,
// the Linux would open another instance Obsidian if jumping back,
// so fallback to manual paste on Linux
if (
Platform.isDesktopApp &&
!Platform.isMacOS &&
(/linux/.test(userAgent) ||
/ubuntu/.test(userAgent) ||
/debian/.test(userAgent) ||
/fedora/.test(userAgent) ||
/centos/.test(userAgent))
) {
needManualPatse = true;
}
const { authUrl, verifier } = await getAuthUrlAndVerifierDropbox( const { authUrl, verifier } = await getAuthUrlAndVerifierDropbox(
this.plugin.settings.dropbox.clientID this.plugin.settings.dropbox.clientID,
needManualPatse
); );
if (needManualPatse) {
contentEl.createEl("p", {
text: "Step 1: Visit the address in a browser, and follow the steps.",
});
contentEl.createEl("p", {
text: 'Step 2: In the end of the web flow, you obtain a long code. Paste it here then click "Submit".',
});
} else {
this.plugin.oauth2Info.verifier = verifier; this.plugin.oauth2Info.verifier = verifier;
contentEl.createEl("p", { contentEl.createEl("p", {
@@ -121,6 +161,7 @@ class DropboxAuthModal extends Modal {
contentEl.createEl("p", { contentEl.createEl("p", {
text: "Finally you should be redirected to Obsidian.", text: "Finally you should be redirected to Obsidian.",
}); });
}
const div2 = contentEl.createDiv(); const div2 = contentEl.createDiv();
div2.createEl( div2.createEl(
@@ -140,6 +181,70 @@ class DropboxAuthModal extends Modal {
href: authUrl, href: authUrl,
text: authUrl, text: authUrl,
}); });
if (needManualPatse) {
let authCode = "";
new Setting(contentEl)
.setName("Auth Code from web page")
.setDesc('You need to click "Confirm".')
.addText((text) =>
text
.setPlaceholder("")
.setValue("")
.onChange((val) => {
authCode = val.trim();
})
)
.addButton(async (button) => {
button.setButtonText("Confirm");
button.onClick(async () => {
new Notice("Trying to connect to Dropbox");
try {
const authRes = await sendAuthReqDropbox(
this.plugin.settings.dropbox.clientID,
verifier,
authCode
);
const self = this;
setConfigBySuccessfullAuthInplace(
this.plugin.settings.dropbox,
authRes,
() => self.plugin.saveSettings()
);
const client = new RemoteClient(
"dropbox",
undefined,
undefined,
this.plugin.settings.dropbox,
undefined,
this.app.vault.getName(),
() => self.plugin.saveSettings()
);
const username = await client.getUser();
this.plugin.settings.dropbox.username = username;
await this.plugin.saveSettings();
new Notice(
`Good! We've connected to Dropbox as user ${username}!`
);
this.authDiv.toggleClass(
"dropbox-auth-button-hide",
this.plugin.settings.dropbox.username !== ""
);
this.revokeAuthDiv.toggleClass(
"dropbox-revoke-auth-button-hide",
this.plugin.settings.dropbox.username === ""
);
this.revokeAuthSetting.setDesc(
`You've connected as user ${this.plugin.settings.dropbox.username}. If you want to disconnect, click this button.`
);
this.close();
} catch (err) {
console.error(err);
new Notice("Something goes wrong while connecting to Dropbox.");
}
});
});
}
} }
onClose() { onClose() {
@@ -279,6 +384,59 @@ export class OnedriveRevokeAuthModal extends Modal {
} }
} }
class SyncConfigDirModal extends Modal {
plugin: RemotelySavePlugin;
saveDropdownFunc: () => void;
constructor(
app: App,
plugin: RemotelySavePlugin,
saveDropdownFunc: () => void
) {
super(app);
this.plugin = plugin;
this.saveDropdownFunc = saveDropdownFunc;
}
async onOpen() {
let { contentEl } = this;
const texts = [
"Attention 1/3: This only syncs (copies) the whole Obsidian config dir, not other . folders or files. It also doesn't understand the inner structure of the config dir.",
"Attention 2/3: After the config dir is synced, plugins settings might be corrupted, and Obsidian might need to be restarted to load the new settings.",
"Attention 3/3: The deletion (uninstallation) operations of or inside Obsidian config dir cannot be tracked. So if you want to uninstall a plugin, you need to manually uninstall it on all device, before next sync.",
"If you are agreed to take your own risk, please click the following second confirm button.",
];
for (const t of texts) {
contentEl.createEl("p", {
text: t,
});
}
new Setting(contentEl)
.addButton((button) => {
button.setButtonText("The Second Confirm To Enable.");
button.onClick(async () => {
this.plugin.settings.syncConfigDir = true;
await this.plugin.saveSettings();
this.saveDropdownFunc();
new Notice("You've enabled syncing config folder!");
this.close();
});
})
.addButton((button) => {
button.setButtonText("Go Back");
button.onClick(() => {
this.close();
});
});
}
onClose() {
let { contentEl } = this;
contentEl.empty();
}
}
class ExportSettingsQrCodeModal extends Modal { class ExportSettingsQrCodeModal extends Modal {
plugin: RemotelySavePlugin; plugin: RemotelySavePlugin;
constructor(app: App, plugin: RemotelySavePlugin) { constructor(app: App, plugin: RemotelySavePlugin) {
@@ -422,6 +580,31 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
}); });
}); });
const runOnceStartUpDiv = generalDiv.createEl("div");
new Setting(runOnceStartUpDiv)
.setName("run once on start up automatically")
.setDesc(
`This settings allows setting running ONCE on start up automatically. This will take effect on NEXT start up after changing. This setting, is different from "schedule for auto run" which starts syncing after EVERY interval.`
)
.addDropdown((dropdown) => {
dropdown.addOption("-1", "(not set)");
dropdown.addOption(
`${1000 * 10 * 1}`,
"sync once after 10 seconds of start up"
);
dropdown.addOption(
`${1000 * 30 * 1}`,
"sync once after 30 seconds of start up"
);
dropdown
.setValue(`${this.plugin.settings.initRunAfterMilliseconds}`)
.onChange(async (val: string) => {
const realVal = parseInt(val);
this.plugin.settings.initRunAfterMilliseconds = realVal;
await this.plugin.saveSettings();
});
});
////////////////////////////////////////////////// //////////////////////////////////////////////////
// below for general chooser (part 1/2) // below for general chooser (part 1/2)
////////////////////////////////////////////////// //////////////////////////////////////////////////
@@ -447,9 +630,11 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
cls: "s3-disclaimer", cls: "s3-disclaimer",
}); });
if (!requireApiVersion(API_VER_REQURL)) {
s3Div.createEl("p", { s3Div.createEl("p", {
text: "You need to configure CORS to allow requests from origin app://obsidian.md and capacitor://localhost and http://localhost", text: "You need to configure CORS to allow requests from origin app://obsidian.md and capacitor://localhost and http://localhost",
}); });
}
s3Div.createEl("p", { s3Div.createEl("p", {
text: "Some Amazon S3 official docs for references:", text: "Some Amazon S3 official docs for references:",
@@ -467,10 +652,12 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
text: "Access key ID and Secret access key info", text: "Access key ID and Secret access key info",
}); });
if (!requireApiVersion(API_VER_REQURL)) {
s3LinksUl.createEl("li").createEl("a", { s3LinksUl.createEl("li").createEl("a", {
href: "https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html", href: "https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html",
text: "Configuring CORS", text: "Configuring CORS",
}); });
}
new Setting(s3Div) new Setting(s3Div)
.setName("s3Endpoint") .setName("s3Endpoint")
@@ -539,6 +726,34 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
}) })
); );
if (requireApiVersion(API_VER_REQURL)) {
new Setting(s3Div)
.setName("bypass CORS issue locally")
.setDesc(
`The plugin allows skipping server CORS config in new version (Obsidian>=${API_VER_REQURL}). If you encounter any issues, please disable this setting and config CORS (app://obsidian.md and capacitor://localhost and http://localhost) on server.`
)
.addDropdown((dropdown) => {
dropdown
.addOption("disable", "disable")
.addOption("enable", "enable");
dropdown
.setValue(
`${
this.plugin.settings.s3.bypassCorsLocally ? "enable" : "disable"
}`
)
.onChange(async (value) => {
if (value === "enable") {
this.plugin.settings.s3.bypassCorsLocally = true;
} else {
this.plugin.settings.s3.bypassCorsLocally = false;
}
await this.plugin.saveSettings();
});
});
}
new Setting(s3Div) new Setting(s3Div)
.setName("check connectivity") .setName("check connectivity")
.setDesc("check connectivity") .setDesc("check connectivity")
@@ -812,9 +1027,11 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
cls: "webdav-disclaimer", cls: "webdav-disclaimer",
}); });
if (!requireApiVersion(API_VER_REQURL)) {
webdavDiv.createEl("p", { webdavDiv.createEl("p", {
text: "You need to configure CORS to allow requests from origin app://obsidian.md and capacitor://localhost and http://localhost", text: "You need to configure CORS to allow requests from origin app://obsidian.md and capacitor://localhost and http://localhost",
}); });
}
webdavDiv.createEl("p", { webdavDiv.createEl("p", {
text: `We will create and sync inside the folder /${this.app.vault.getName()} on your server.`, text: `We will create and sync inside the folder /${this.app.vault.getName()} on your server.`,
@@ -862,9 +1079,20 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
new Setting(webdavDiv) new Setting(webdavDiv)
.setName("server auth type") .setName("server auth type")
.setDesc("If no password, this option would be ignored.") .setDesc("If no password, this option would be ignored.")
.addDropdown((dropdown) => { .addDropdown(async (dropdown) => {
dropdown.addOption("basic", "basic"); dropdown.addOption("basic", "basic");
// dropdown.addOption("digest", "digest"); if (requireApiVersion(API_VER_REQURL)) {
dropdown.addOption("digest", "digest");
}
// new version config, copied to old version, we need to reset it
if (
!requireApiVersion(API_VER_REQURL) &&
this.plugin.settings.webdav.authType !== "basic"
) {
this.plugin.settings.webdav.authType = "basic";
await this.plugin.saveSettings();
}
dropdown dropdown
.setValue(this.plugin.settings.webdav.authType) .setValue(this.plugin.settings.webdav.authType)
@@ -875,25 +1103,37 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
}); });
new Setting(webdavDiv) new Setting(webdavDiv)
.setName("server supports infinity propfind or not") .setName("depth header sent to servers")
.setDesc( .setDesc(
"The plugin needs to get all files and folders recursively using probfind. If your webdav server only supports depth='1' (such as NGINX), you need to adjust the setting here, then the plugin consumes more network requests, but better than not working." "Webdav servers should be configured to allow requests with header Depth being '1' or 'Infinity'. The plugin needs to know this info. If you are not sure what's this, choose \"auto\"."
) )
.addDropdown((dropdown) => { .addDropdown((dropdown) => {
dropdown.addOption("infinity", "supports depth='infinity'"); dropdown.addOption("auto", "auto detect");
dropdown.addOption("1", "only supports depth='1'"); dropdown.addOption("manual_1", "only supports depth='1'");
dropdown.addOption("manual_infinity", "only supports depth='infinity'");
type Depth = "1" | "infinity"; let initVal = "auto";
dropdown const autoOptions: Set<WebdavDepthType> = new Set([
.setValue( "auto_unknown",
this.plugin.settings.webdav.manualRecursive === false "auto_1",
? "infinity" "auto_infinity",
: "1" ]);
) if (autoOptions.has(this.plugin.settings.webdav.depth)) {
.onChange(async (val: Depth) => { initVal = "auto";
if (val === "1") { } else {
initVal = this.plugin.settings.webdav.depth || "auto";
}
type DepthOption = "auto" | "manual_1" | "manual_infinity";
dropdown.setValue(initVal).onChange(async (val: DepthOption) => {
if (val === "auto") {
this.plugin.settings.webdav.depth = "auto_unknown";
this.plugin.settings.webdav.manualRecursive = false;
} else if (val === "manual_1") {
this.plugin.settings.webdav.depth = "manual_1";
this.plugin.settings.webdav.manualRecursive = true; this.plugin.settings.webdav.manualRecursive = true;
} else if (val === "infinity") { } else if (val === "manual_infinity") {
this.plugin.settings.webdav.depth = "manual_infinity";
this.plugin.settings.webdav.manualRecursive = false; this.plugin.settings.webdav.manualRecursive = false;
} }
await this.plugin.saveSettings(); await this.plugin.saveSettings();
@@ -907,20 +1147,27 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
button.setButtonText("Check"); button.setButtonText("Check");
button.onClick(async () => { button.onClick(async () => {
new Notice("Checking..."); new Notice("Checking...");
const self = this;
const client = new RemoteClient( const client = new RemoteClient(
"webdav", "webdav",
undefined, undefined,
this.plugin.settings.webdav, this.plugin.settings.webdav,
undefined, undefined,
undefined, undefined,
this.app.vault.getName() this.app.vault.getName(),
() => self.plugin.saveSettings()
); );
const res = await client.checkConnectivity(); const res = await client.checkConnectivity();
if (res) { if (res) {
new Notice("Great! The webdav server can be accessed."); new Notice("Great! The webdav server can be accessed.");
} else { } else {
let corsErrMsg = "/CORS";
if (requireApiVersion(API_VER_REQURL)) {
corsErrMsg = "";
}
new Notice( new Notice(
"The webdav server cannot be reached (possible to be any of address/username/password/authtype/CORS errors)." `The webdav server cannot be reached (possible to be any of address/username/password/authtype${corsErrMsg} errors).`
); );
} }
}); });
@@ -964,6 +1211,92 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
}); });
}); });
//////////////////////////////////////////////////
// below for advanced settings
//////////////////////////////////////////////////
const advDiv = containerEl.createEl("div");
advDiv.createEl("h2", {
text: "Advanced Settings",
});
const concurrencyDiv = advDiv.createEl("div");
new Setting(concurrencyDiv)
.setName("Concurrency")
.setDesc(
"How many files do you want to download or upload in parallel at most? By default it's set to 5. If you meet any problems such as rate limit, you can reduce the concurrency to a lower value."
)
.addDropdown((dropdown) => {
dropdown.addOption("1", "1");
dropdown.addOption("2", "2");
dropdown.addOption("3", "3");
dropdown.addOption("5", "5 (default)");
dropdown.addOption("10", "10");
dropdown.addOption("15", "15");
dropdown.addOption("20", "20");
dropdown
.setValue(`${this.plugin.settings.concurrency}`)
.onChange(async (val) => {
const realVal = parseInt(val);
this.plugin.settings.concurrency = realVal;
await this.plugin.saveSettings();
});
});
const syncUnderscoreItemsDiv = advDiv.createEl("div");
new Setting(syncUnderscoreItemsDiv)
.setName("sync _ files or folders")
.setDesc(`Sync files or folders startting with _ ("underscore") or not.`)
.addDropdown((dropdown) => {
dropdown.addOption("disable", "disable");
dropdown.addOption("enable", "enable");
dropdown
.setValue(
`${this.plugin.settings.syncUnderscoreItems ? "enable" : "disable"}`
)
.onChange(async (val) => {
this.plugin.settings.syncUnderscoreItems = val === "enable";
await this.plugin.saveSettings();
});
});
const syncConfigDirDiv = advDiv.createEl("div");
new Setting(syncConfigDirDiv)
.setName("sync config dir (experimental)")
.setDesc(
`Sync config dir ${this.app.vault.configDir} or not. Please be aware that this may impact all your plugins' or Obsidian's settings, and may require you restart Obsidian after sync. Enable this at your own risk.`
)
.addDropdown((dropdown) => {
dropdown.addOption("disable", "disable");
dropdown.addOption("enable", "enable");
const bridge = {
secondConfirm: false,
};
dropdown
.setValue(
`${this.plugin.settings.syncConfigDir ? "enable" : "disable"}`
)
.onChange(async (val) => {
if (val === "enable" && !bridge.secondConfirm) {
dropdown.setValue("disable");
const modal = new SyncConfigDirModal(
this.app,
this.plugin,
() => {
bridge.secondConfirm = true;
dropdown.setValue("enable");
}
);
modal.open();
} else {
bridge.secondConfirm = false;
this.plugin.settings.syncConfigDir = false;
await this.plugin.saveSettings();
}
});
});
////////////////////////////////////////////////// //////////////////////////////////////////////////
// below for import and export functions // below for import and export functions
////////////////////////////////////////////////// //////////////////////////////////////////////////
+228 -29
View File
@@ -1,9 +1,17 @@
import { TAbstractFile, TFile, TFolder, Vault } from "obsidian"; import {
import type { TAbstractFile,
TFile,
TFolder,
Vault,
requireApiVersion,
} from "obsidian";
import PQueue from "p-queue";
import {
RemoteItem, RemoteItem,
SUPPORTED_SERVICES_TYPE, SUPPORTED_SERVICES_TYPE,
DecisionType, DecisionType,
FileOrFolderMixedState, FileOrFolderMixedState,
API_VER_STAT_FOLDER,
} from "./baseTypes"; } from "./baseTypes";
import { import {
decryptBase32ToString, decryptBase32ToString,
@@ -38,6 +46,7 @@ import {
import * as origLog from "loglevel"; import * as origLog from "loglevel";
import { padEnd } from "lodash"; import { padEnd } from "lodash";
import { isInsideObsFolder, ObsConfigDirFileType } from "./obsFolderLister";
const log = origLog.getLogger("rs-default"); const log = origLog.getLogger("rs-default");
export type SyncStatusType = export type SyncStatusType =
@@ -264,18 +273,39 @@ export const fetchMetadataFile = async (
return metadata; return metadata;
}; };
const isSkipItem = (
key: string,
syncConfigDir: boolean,
syncUnderscoreItems: boolean,
configDir: string
) => {
if (syncConfigDir && isInsideObsFolder(key, configDir)) {
return false;
}
return (
isHiddenPath(key, true, false) ||
(!syncUnderscoreItems && isHiddenPath(key, false, true)) ||
key === DEFAULT_FILE_NAME_FOR_METADATAONREMOTE ||
key === DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2
);
};
const ensembleMixedStates = async ( const ensembleMixedStates = async (
remoteStates: FileOrFolderMixedState[], remoteStates: FileOrFolderMixedState[],
local: TAbstractFile[], local: TAbstractFile[],
localConfigDirContents: ObsConfigDirFileType[] | undefined,
remoteDeleteHistory: DeletionOnRemote[], remoteDeleteHistory: DeletionOnRemote[],
localDeleteHistory: FileFolderHistoryRecord[] localDeleteHistory: FileFolderHistoryRecord[],
syncConfigDir: boolean,
configDir: string,
syncUnderscoreItems: boolean
) => { ) => {
const results = {} as Record<string, FileOrFolderMixedState>; const results = {} as Record<string, FileOrFolderMixedState>;
for (const r of remoteStates) { for (const r of remoteStates) {
const key = r.key; const key = r.key;
if (isHiddenPath(key)) { if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
continue; continue;
} }
results[key] = r; results[key] = r;
@@ -293,7 +323,7 @@ const ensembleMixedStates = async (
r = { r = {
key: entry.path, key: entry.path,
existLocal: true, existLocal: true,
mtimeLocal: entry.stat.mtime, mtimeLocal: Math.max(entry.stat.mtime, entry.stat.ctime),
sizeLocal: entry.stat.size, sizeLocal: entry.stat.size,
}; };
} else if (entry instanceof TFolder) { } else if (entry instanceof TFolder) {
@@ -308,9 +338,10 @@ const ensembleMixedStates = async (
throw Error(`unexpected ${entry}`); throw Error(`unexpected ${entry}`);
} }
if (isHiddenPath(key)) { if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
continue; continue;
} }
if (results.hasOwnProperty(key)) { if (results.hasOwnProperty(key)) {
results[key].key = r.key; results[key].key = r.key;
results[key].existLocal = r.existLocal; results[key].existLocal = r.existLocal;
@@ -322,6 +353,28 @@ const ensembleMixedStates = async (
} }
} }
if (syncConfigDir && localConfigDirContents !== undefined) {
for (const entry of localConfigDirContents) {
const key = entry.key;
const r: FileOrFolderMixedState = {
key: key,
existLocal: true,
mtimeLocal: Math.max(entry.mtime, entry.ctime),
sizeLocal: entry.size,
};
if (results.hasOwnProperty(key)) {
results[key].key = r.key;
results[key].existLocal = r.existLocal;
results[key].mtimeLocal = r.mtimeLocal;
results[key].sizeLocal = r.sizeLocal;
} else {
results[key] = r;
results[key].existRemote = false;
}
}
}
for (const entry of remoteDeleteHistory) { for (const entry of remoteDeleteHistory) {
const key = entry.key; const key = entry.key;
const r = { const r = {
@@ -329,6 +382,10 @@ const ensembleMixedStates = async (
deltimeRemote: entry.actionWhen, deltimeRemote: entry.actionWhen,
} as FileOrFolderMixedState; } as FileOrFolderMixedState;
if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
continue;
}
if (results.hasOwnProperty(key)) { if (results.hasOwnProperty(key)) {
results[key].key = r.key; results[key].key = r.key;
results[key].deltimeRemote = r.deltimeRemote; results[key].deltimeRemote = r.deltimeRemote;
@@ -357,9 +414,10 @@ const ensembleMixedStates = async (
deltimeLocal: entry.actionWhen, deltimeLocal: entry.actionWhen,
} as FileOrFolderMixedState; } as FileOrFolderMixedState;
if (isHiddenPath(key)) { if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
continue; continue;
} }
if (results.hasOwnProperty(key)) { if (results.hasOwnProperty(key)) {
results[key].key = r.key; results[key].key = r.key;
results[key].deltimeLocal = r.deltimeLocal; results[key].deltimeLocal = r.deltimeLocal;
@@ -505,9 +563,10 @@ const assignOperationToFileInplace = (
throw Error(`no decision for ${JSON.stringify(r)}`); throw Error(`no decision for ${JSON.stringify(r)}`);
}; };
const assignOperationToFolderInplace = ( const assignOperationToFolderInplace = async (
origRecord: FileOrFolderMixedState, origRecord: FileOrFolderMixedState,
keptFolder: Set<string>, keptFolder: Set<string>,
vault: Vault,
password: string = "" password: string = ""
) => { ) => {
let r = origRecord; let r = origRecord;
@@ -523,16 +582,43 @@ const assignOperationToFolderInplace = (
if (r.deltimeLocal !== undefined || r.deltimeRemote !== undefined) { if (r.deltimeLocal !== undefined || r.deltimeRemote !== undefined) {
// it has some deletion "commands" // it has some deletion "commands"
if (
r.deltimeLocal !== undefined && const deltimeLocal = r.deltimeLocal !== undefined ? r.deltimeLocal : -1;
r.deltimeLocal >= (r.deltimeRemote !== undefined ? r.deltimeRemote : -1) const deltimeRemote =
) { r.deltimeRemote !== undefined ? r.deltimeRemote : -1;
// 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) {
keptFolder.add(getParentFolder(r.key));
if (r.existLocal && r.existRemote) {
r.decision = "skipFolder";
r.decisionBranch = 14;
} else if (r.existLocal || r.existRemote) {
r.decision = "createFolder";
r.decisionBranch = 15;
} else {
throw Error(
`Error: Folder ${r.key} doesn't exist locally and remotely but is marked must be kept. Abort.`
);
}
}
}
}
if (r.decision === undefined) {
// not yet decided by the above reason
if (deltimeLocal > 0 && deltimeLocal > deltimeRemote) {
r.decision = "uploadLocalDelHistToRemoteFolder"; r.decision = "uploadLocalDelHistToRemoteFolder";
r.decisionBranch = 8; r.decisionBranch = 8;
} else { } else {
r.decision = "keepRemoteDelHistFolder"; r.decision = "keepRemoteDelHistFolder";
r.decisionBranch = 9; r.decisionBranch = 9;
} }
}
} else { } else {
// it does not have any deletion commands // it does not have any deletion commands
// keep it as is, and create it if necessary // keep it as is, and create it if necessary
@@ -582,16 +668,25 @@ const DELETION_DECISIONS: Set<DecisionType> = new Set([
export const getSyncPlan = async ( export const getSyncPlan = async (
remoteStates: FileOrFolderMixedState[], remoteStates: FileOrFolderMixedState[],
local: TAbstractFile[], local: TAbstractFile[],
localConfigDirContents: ObsConfigDirFileType[] | undefined,
remoteDeleteHistory: DeletionOnRemote[], remoteDeleteHistory: DeletionOnRemote[],
localDeleteHistory: FileFolderHistoryRecord[], localDeleteHistory: FileFolderHistoryRecord[],
remoteType: SUPPORTED_SERVICES_TYPE, remoteType: SUPPORTED_SERVICES_TYPE,
vault: Vault,
syncConfigDir: boolean,
configDir: string,
syncUnderscoreItems: boolean,
password: string = "" password: string = ""
) => { ) => {
const mixedStates = await ensembleMixedStates( const mixedStates = await ensembleMixedStates(
remoteStates, remoteStates,
local, local,
localConfigDirContents,
remoteDeleteHistory, remoteDeleteHistory,
localDeleteHistory localDeleteHistory,
syncConfigDir,
configDir,
syncUnderscoreItems
); );
const sortedKeys = Object.keys(mixedStates).sort( const sortedKeys = Object.keys(mixedStates).sort(
@@ -609,7 +704,7 @@ export const getSyncPlan = async (
// decide some folders // decide some folders
// because the keys are sorted by length // because the keys are sorted by length
// so all the children must have been shown up before in the iteration // so all the children must have been shown up before in the iteration
assignOperationToFolderInplace(val, keptFolder, password); await assignOperationToFolderInplace(val, keptFolder, vault, password);
} else { } else {
// get all operations of files // get all operations of files
// and at the same time get some helper info for folders // and at the same time get some helper info for folders
@@ -850,10 +945,10 @@ export const doActualSync = async (
deletions: DeletionOnRemote[], deletions: DeletionOnRemote[],
localDeleteFunc: any, localDeleteFunc: any,
password: string = "", password: string = "",
concurrency: number = 1,
callbackSyncProcess?: any callbackSyncProcess?: any
) => { ) => {
const mixedStates = syncPlan.mixedStates; const mixedStates = syncPlan.mixedStates;
let i = 0;
const totalCount = sortedKeys.length || 0; const totalCount = sortedKeys.length || 0;
log.debug(`start syncing extra data firstly`); log.debug(`start syncing extra data firstly`);
@@ -866,6 +961,10 @@ export const doActualSync = async (
); );
log.debug(`finish syncing extra data firstly`); log.debug(`finish syncing extra data firstly`);
log.debug(`concurrency === ${concurrency}`);
if (concurrency === 1) {
// run everything in sequence
// good old way
for (let i = 0; i < sortedKeys.length; ++i) { for (let i = 0; i < sortedKeys.length; ++i) {
const key = sortedKeys[i]; const key = sortedKeys[i];
const val = mixedStates[key]; const val = mixedStates[key];
@@ -887,20 +986,120 @@ export const doActualSync = async (
password password
); );
log.debug(`finished ${key}`); log.debug(`finished ${key}`);
}
} else {
let realCounter = 0;
// await Promise.all( log.debug(
// Object.entries(mixedStates).map(async ([k, v]) => `1. create all folders from shadowest to deepest, also check undefined decision`
// dispatchOperationToActual( );
// k as string, for (let i = sortedKeys.length - 1; i >= 0; --i) {
// vaultRandomID, const key = sortedKeys[i];
// v as FileOrFolderMixedState, const val = mixedStates[key];
// client,
// db, if (
// vault, val.decision === undefined ||
// localDeleteFunc, val.decision === "skipFolder" ||
// password val.decision === "createFolder"
// ) ) {
// ) log.debug(`start syncing "${key}" with plan ${JSON.stringify(val)}`);
// );
if (callbackSyncProcess !== undefined) {
await callbackSyncProcess(realCounter, totalCount, key, val.decision);
}
realCounter += 1;
await dispatchOperationToActual(
key,
vaultRandomID,
val,
client,
db,
vault,
localDeleteFunc,
password
);
log.debug(`finished ${key}`);
}
}
log.debug(`2. delete files and folders from deepest to shadowest`);
for (let i = 0; i < sortedKeys.length; ++i) {
const key = sortedKeys[i];
const val = mixedStates[key];
if (
val.decision === "uploadLocalDelHistToRemoteFolder" ||
val.decision === "keepRemoteDelHistFolder" ||
val.decision === "uploadLocalDelHistToRemote" ||
val.decision === "keepRemoteDelHist"
) {
log.debug(`start syncing "${key}" with plan ${JSON.stringify(val)}`);
if (callbackSyncProcess !== undefined) {
await callbackSyncProcess(realCounter, totalCount, key, val.decision);
}
realCounter += 1;
await dispatchOperationToActual(
key,
vaultRandomID,
val,
client,
db,
vault,
localDeleteFunc,
password
);
log.debug(`finished ${key}`);
}
}
log.debug(
`3. upload or download files in parallel, with the desired concurrency=${concurrency}`
);
const queue = new PQueue({ concurrency: concurrency, autoStart: true });
// const commands: any[] = [];
for (let i = 0; i < sortedKeys.length; ++i) {
const key = sortedKeys[i];
const val = mixedStates[key];
if (
val.decision === "skipUploading" ||
val.decision === "uploadLocalToRemote" ||
val.decision === "downloadRemoteToLocal"
) {
const fn = async () => {
log.debug(`start syncing "${key}" with plan ${JSON.stringify(val)}`);
if (callbackSyncProcess !== undefined) {
await callbackSyncProcess(
realCounter,
totalCount,
key,
val.decision
);
realCounter += 1;
}
await dispatchOperationToActual(
key,
vaultRandomID,
val,
client,
db,
vault,
localDeleteFunc,
password
);
log.debug(`finished ${key}`);
};
queue.add(fn);
}
}
await queue.onIdle();
} }
}; };
+2 -1
View File
@@ -20,7 +20,7 @@ export class SyncAlgoV2Modal extends Modal {
const texts = [ const texts = [
"Welcome to use Remotely Save!", "Welcome to use Remotely Save!",
"From this version 0.3.0, a new algorithm has been developed, but it needs uploading extra meta data files _remotely-save-metadata-on-remote.{json,bin} to YOUR configured cloud destinations, besides your notes.", "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.", "So that, for example, the second device can know that what files/folders have been deleted on the first device by reading those files.",
@@ -60,6 +60,7 @@ export class SyncAlgoV2Modal extends Modal {
log.info("agree to use the new algorithm"); log.info("agree to use the new algorithm");
this.plugin.saveAgreeToUseNewSyncAlgorithm(); this.plugin.saveAgreeToUseNewSyncAlgorithm();
this.plugin.enableAutoSyncIfSet(); this.plugin.enableAutoSyncIfSet();
this.plugin.enableInitSyncIfSet();
} else { } else {
log.info("do not agree to use the new algorithm"); log.info("do not agree to use the new algorithm");
this.plugin.unload(); this.plugin.unload();
+67 -3
View File
@@ -21,7 +21,7 @@ describe("Misc: hidden file", () => {
item = "_hidden_loose"; item = "_hidden_loose";
expect(misc.isHiddenPath(item)).to.be.true; expect(misc.isHiddenPath(item)).to.be.true;
expect(misc.isHiddenPath(item, false)).to.be.false; expect(misc.isHiddenPath(item, true, false)).to.be.false;
item = "/sdd/_hidden_loose"; item = "/sdd/_hidden_loose";
expect(misc.isHiddenPath(item)).to.be.true; expect(misc.isHiddenPath(item)).to.be.true;
@@ -30,10 +30,21 @@ describe("Misc: hidden file", () => {
expect(misc.isHiddenPath(item)).to.be.true; expect(misc.isHiddenPath(item)).to.be.true;
item = "what/../_hidden_loose/what/what/what"; item = "what/../_hidden_loose/what/what/what";
expect(misc.isHiddenPath(item, false)).to.be.false; expect(misc.isHiddenPath(item, true, false)).to.be.false;
item = "what/../_hidden_loose/../.hidden/what/what/what"; item = "what/../_hidden_loose/../.hidden/what/what/what";
expect(misc.isHiddenPath(item, false)).to.be.true; expect(misc.isHiddenPath(item, true, false)).to.be.true;
item = "what/../_hidden_loose/../.hidden/what/what/what";
expect(misc.isHiddenPath(item, false, true)).to.be.false;
item = "what/_hidden_loose/what/what/what";
expect(misc.isHiddenPath(item, false, true)).to.be.true;
expect(misc.isHiddenPath(item, true, false)).to.be.false;
item = "what/.hidden/what/what/what";
expect(misc.isHiddenPath(item, false, true)).to.be.false;
expect(misc.isHiddenPath(item, true, false)).to.be.true;
}); });
}); });
@@ -180,3 +191,56 @@ describe("Misc: extract svg", () => {
expect(y).to.equal("<rect/><g/>"); expect(y).to.equal("<rect/><g/>");
}); });
}); });
describe("Misc: get split ranges", () => {
it("should deal with big parts", () => {
const k = misc.getSplitRanges(10, 20);
const k2: misc.SplitRange[] = [
{
partNum: 1,
start: 0,
end: 10,
},
];
expect(k).to.deep.equal(k2);
});
it("should deal with 0 remainder", () => {
const k = misc.getSplitRanges(20, 10);
const k2: misc.SplitRange[] = [
{
partNum: 1,
start: 0,
end: 10,
},
{
partNum: 2,
start: 10,
end: 20,
},
];
expect(k).to.deep.equal(k2);
});
it("should deal with not-0 remainder", () => {
const k = misc.getSplitRanges(25, 10);
const k2: misc.SplitRange[] = [
{
partNum: 1,
start: 0,
end: 10,
},
{
partNum: 2,
start: 10,
end: 20,
},
{
partNum: 3,
start: 20,
end: 25,
},
];
expect(k).to.deep.equal(k2);
});
});
+2 -1
View File
@@ -1,3 +1,4 @@
{ {
"0.3.0": "0.12.15" "0.3.2": "0.12.15",
"0.3.6": "0.13.21"
} }