Compare commits

...
74 Commits
Author SHA1 Message Date
fyears d38ac34362 0.3.29
Release A New Version / build (16.x) (push) Failing after 41s
2024-01-04 00:26:37 +08:00
fyears 6a651b844f ignore paths by regexgit add . 2024-01-04 00:26:02 +08:00
fyears 9e4d3826fd add langs for ignorepath 2024-01-03 23:37:08 +08:00
ras0q d7e034f070 remove debug console.table 2024-01-03 23:36:12 +08:00
ras0q 79a0b9f44d add ignorePaths setting 2024-01-03 23:36:12 +08:00
fyears 81c79ab848 minio custom port 2024-01-03 23:25:08 +08:00
fyears af71758ef7 add cloudflare r2 2024-01-03 00:08:51 +08:00
fyears ee8a3df0be change method of s3 check connect 2024-01-02 23:52:36 +08:00
fyears f55fad0e29 fix compability issue 2024-01-02 00:26:03 +08:00
fyears 15c163e73d alist 2024-01-02 00:08:09 +08:00
fyears d8f613bbb6 minio 2024-01-01 11:57:55 +08:00
fyears c8016b5f30 finally jianguoyun doc 2024-01-01 11:12:08 +08:00
fyears f66a7031b2 format 2024-01-01 11:06:04 +08:00
fyears bbc69715e8 add webdav links 2024-01-01 11:05:49 +08:00
fyears d6c39615d7 owncloud 2024-01-01 10:40:38 +08:00
fyears bbb909cda4 add link for null body 2024-01-01 01:32:22 +08:00
fyears 200d25de70 0.3.28
Release A New Version / build (16.x) (push) Failing after 36s
2024-01-01 01:26:00 +08:00
fyears cd0a9a395f fix null body webdav 2024-01-01 01:25:25 +08:00
fyears 2deb3be8eb bump 0.3.27 2024-01-01 01:16:39 +08:00
fyears 9519793860 finally a real working compat for webdav 2024-01-01 01:15:51 +08:00
fyears 2d7c33fb1a add docs for webdav infinicloud 2024-01-01 00:45:22 +08:00
fyears 6a009b93cb fix webdav for new er 2024-01-01 00:43:59 +08:00
fyears ce8d8d1c62 beta 2023-12-31 22:41:48 +08:00
fyears 881147e91a format doc 2023-12-17 23:51:03 +08:00
fyears 6e282c86af skip .DS_Store 2023-12-17 23:50:52 +08:00
fyears c689235ff0 ensure the encryption generate 'random' results 2023-12-17 23:50:32 +08:00
fyears b238988012 Merge pull request #346 from GryphonIs/master
Update services_connectable_or_not.md
2023-12-17 15:32:44 +08:00
fyears 24fb9e1675 Merge branch 'master' into master 2023-12-17 15:32:20 +08:00
fyears f6a1a7c032 Merge pull request #241 from PassionPenguin/patch-1
Update services_connectable_or_not.md
2023-12-17 15:30:38 +08:00
fyears cfe7ae9826 Merge pull request #270 from Flectomancer/patch-1
Update services_connectable_or_not.md
2023-12-17 15:23:33 +08:00
fyears 186cff9c36 Merge pull request #214 from davidangel/patch-1
Fix typo in docs
2023-12-17 15:22:42 +08:00
fyears 44dbec175b update all the npm after 2 years 2023-12-17 15:18:23 +08:00
GryphonIs 7ecddf29fa Update services_connectable_or_not.md
Tested With NextCloud WebDAV and it works fine.
2023-07-10 16:38:26 -04:00
Flectomancer d23183395c Update services_connectable_or_not.md
nginx access tested
2022-12-12 18:59:28 +01:00
Hoarfroster 8dd7879c5d Update services_connectable_or_not.md 2022-11-08 22:24:19 +08:00
David Angel f0d2766f48 Fix typo in docs 2022-10-10 22:06:27 -04:00
fyears 92183e0fb6 bump to 0.3.25
Release A New Version / build (16.x) (push) Failing after 43s
2022-05-10 21:25:20 +08:00
fyears 28bd861c9e fix stat on Android, add operations to nan ctime mtime and undefined size 2022-05-10 21:15:30 +08:00
fyears 4e8bec9511 bump to 0.3.24
Release A New Version / build (16.x) (push) Failing after 33s
2022-05-04 00:23:31 +08:00
fyears c98d91ab60 make auth settings styles cleaner 2022-05-04 00:22:55 +08:00
fyears 8bd456b08e make settings styles much cleaner 2022-05-04 00:12:03 +08:00
fyears a5c25aecd0 normalize words 2022-05-03 23:00:03 +08:00
fyears 806438964c fix import export settings styles 2022-05-03 22:48:03 +08:00
fyears 069e993fb0 split chooser and basic settings 2022-05-03 22:45:23 +08:00
fyears 7c2a17c404 fix format 2022-05-03 22:43:53 +08:00
fyears f26e491922 bump to 0.3.23
Release A New Version / build (16.x) (push) Failing after 47s
2022-05-03 10:06:25 +08:00
fyears dbf80c3359 properly deal with cache-control for onedrive 2022-05-03 10:04:36 +08:00
fyears 9ddb840077 bump to 0.3.22
Release A New Version / build (16.x) (push) Failing after 40s
2022-05-01 18:14:14 +08:00
fyears 17135abbd4 bypassing large files 2022-05-01 18:13:06 +08:00
fyears af8357ba6e more verbose error hint for s3 2022-04-30 23:39:44 +08:00
fyears bfa23eb8a5 add no-cache for webdav 2022-04-30 23:23:51 +08:00
fyears d3d26bfe49 add no-cache for dropbox 2022-04-30 23:11:16 +08:00
fyears f6f7d83a35 correct way to skip cache for onedrive 2022-04-30 19:07:12 +08:00
fyears 9e29405103 more robust way to add cache-control for s3 2022-04-30 18:50:45 +08:00
fyears 3e7e05fc3d bump to 0.3.21
Release A New Version / build (16.x) (push) Failing after 40s
2022-04-30 16:01:24 +08:00
fyears 391df3ed2d adjust focus 2022-04-30 16:00:53 +08:00
fyears c542789c93 update sync 1 sec 2022-04-30 15:55:25 +08:00
fyears 48e5601a52 bump to 0.3.20
Release A New Version / build (16.x) (push) Failing after 37s
2022-04-30 15:45:23 +08:00
fyears 054a9a3c01 add more verbose hint about the json 2022-04-30 15:40:56 +08:00
fyears 66dcaf4e4c add debug log 2022-04-30 15:23:16 +08:00
fyears 6d29554033 force refresh req every time for s3 2022-04-30 15:22:52 +08:00
fyears 4ed0d735a2 update all packages to latest 2022-04-30 14:22:34 +08:00
fyears 26dff02daa format 2022-04-30 11:59:38 +08:00
fyears 1b1083d746 better esbuild 2022-04-30 11:59:18 +08:00
fyears 6db005018d Merge branch 'moritzlang-add-apache-example-conf' 2022-04-27 23:39:26 +08:00
fyears 8d25ddb636 Merge branch 'add-apache-example-conf' of https://github.com/moritzlang/remotely-save into moritzlang-add-apache-example-conf 2022-04-27 23:39:03 +08:00
fyears b0d41478a3 Merge branch 'n0k0m3-master' 2022-04-27 23:32:27 +08:00
fyears f69adf273a add special hints 2022-04-27 23:32:15 +08:00
n0k0m3 4b4a9b0989 Add CORS header guide for Nextcloud/Owncloud 2022-04-18 11:22:23 -04:00
fyears bfe11f44dc make more s3 req to lower 2022-04-18 21:30:02 +08:00
fyears d25303cfac update s3 pack 2022-04-18 21:29:38 +08:00
fyears ebd62b1581 new s3 every request to avoid request expired 2022-04-18 00:56:25 +08:00
fyears 13537d1481 insert dry run into plan records 2022-04-18 00:22:00 +08:00
Moritz 2eda5618df Add apache example configuration 2022-02-20 22:54:30 +01:00
58 changed files with 1329 additions and 400 deletions
+11 -1
View File
@@ -26,12 +26,13 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
- **[End-to-end encryption](./docs/encryption.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
- **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
- **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
- **Skip Large files and skip paths by custom regex conditions!
- **Fully open source under [Apache-2.0 License](./LICENSE).**
- **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.**
## Limitations
- **To support deltions sync, extra metadata will also be uploaded.** See [Minimal Intrusive](./docs/minimal_intrusive_design.md).
- **To support deletions sync, extra metadata will also be uploaded.** See [Minimal Intrusive](./docs/minimal_intrusive_design.md).
- **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
- **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
- **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
@@ -60,6 +61,9 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
### S3
- Tutorials / Examples:
- [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/README.md)
- [MinIO](./docs/remote_services/s3_minio/README.md)
- Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
- About CORS:
- If you are using Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, you can skip this CORS part.
@@ -87,11 +91,17 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
### webdav
- Tutorials / Examples:
- [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
- [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
- [坚果云 JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
- About CORS:
- If you are using Obsidian desktop >= 0.13.25 or iOS >= 1.1.1, you can skip this CORS part.
- If you are using Obsidian desktop < 0.13.25 or iOS < 1.1.1 or any Android version:
- The webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies unless under a upgraded Obsidian version.
- Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin, or use a upgraded Obsidian version.
- **Unofficial** workaround: NextCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can install [WebAppPassword](https://apps.nextcloud.com/apps/webapppassword) app, and add `app://obsidian.md`, `capacitor://localhost`, `http://localhost` to `Allowed origins`
- **Unofficial** workaround: OwnCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can download `.tar.gz` of `WebAppPassword` above and manually install and configure it on their instances.
- The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
- Your data would be synced to a `${vaultName}` sub folder on your webdav server.
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
+25
View File
@@ -0,0 +1,25 @@
# How To Configure Apache CORS Rules for Webdav
This method is [contributed by community](https://github.com/remotely-save/remotely-save/pull/31).
You should evaluate the risk by yourself before trying this method.
**You are strongly advised to backup your original Apache configuration files before making any changes.**
```apacheconf
<IfModule mod_headers.c>
# Obsidian webdav
SetEnvIf Origin "^app://obsidian.md$" IS_OBSIDIAN
SetEnvIf Origin "^capacitor://localhost$" IS_OBSIDIAN
SetEnvIf Origin "^http://localhost$" IS_OBSIDIAN
Header always set Access-Control-Allow-Origin "*" env=IS_OBSIDIAN
Header always set Access-Control-Allow-Methods "GET, HEAD, POST, PUT, OPTIONS, MOVE, DELETE, COPY, LOCK, UNLOCK, PROPFIND" env=IS_OBSIDIAN
Header always set Access-Control-Allow-Headers "Authorization, Depth, DNT, User-Agent, Keep-Alive, Content-Type, accept, origin, X-Requested-With" env=IS_OBSIDIAN
Header always set Access-Control-Expose-Headers "etag, dav" env=IS_OBSIDIAN
# Allow OPTION request without authentication and respond with status 200
RewriteCond %{ENV:IS_OBSIDIAN} 1
RewriteCond %{REQUEST_METHOD} OPTIONS
RewriteRule ^(.*)$ $1 [R=200,L]
</IfModule>
```
+7 -2
View File
@@ -4,6 +4,11 @@ The plugin is developed for the browser environment. The "fake" browser behind t
[MDN has a doc about CORS.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
From Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
1. From Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
For using this plugin in Obsidian desktop < 0.13.25 or mobile < 1.1.1, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. Here is an example [configuration for Amazon S3](./s3_cors_configure.md).
2. For using this plugin in Obsidian desktop < 0.13.25 or mobile < 1.1.1, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`.
Example configurations:
- [Amazon S3](./s3_cors_configure.md)
- [Apache](./apache_cors_configure.md) ([contributed by community](https://github.com/remotely-save/remotely-save/pull/31))
@@ -0,0 +1,27 @@
# Cloudflare R2
## Links
<https://www.cloudflare.com/developer-platform/r2/>
## Steps
1. **Be aware that it may cost you money.**
2. Create a Cloudflare account and enable R2 feature. **Credit card info might be required by Cloudflare**, though Cloudflare provides generous free tier and zero egress fee.
3. Create a bucket.
![](./s3_cloudflare_r2_create_bucket.png)
4. Create an Access Key with "Object Read & Write" permission, and add specify to your created bucket. During the creation, you will also get the auto-generated secret key, and the endpoint address.
![](./s3_cloudflare_r2_create_api_token.png)
5. In remotely-save setting page, input the address / bucket / access key / secret key. **Region being set to `us-east-1` is sufficient.** Enable "Bypass CORS", because usually that's what you want.
Click "check connectivity". (If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.)
![](./s3_cloudflare_r2_rs_settings.png)
6. Sync!
## And Issue Related To "Check Connectivity"
If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.
Cloudflare doesn't allow `HeadBucket` for access keys with "Object Read & Write". So it may be possible that checking connectivity is not ok but actual syncing is ok. New version >= 0.3.29 of the plugin fix this problem by using `ListObjects` instead of `HeadBucket`.
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:49a5cd07e538205ba733dc3ccb30e4e7da1290a4a80aefe08afac19fd2db2232
size 467448
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:61fc0812fe96871eed507d2f6b7bbad790ab70e95ff5fe764f8f8b2ab8ce82c2
size 153015
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:02f9c0fea36679e54c8c3fac979bc41d15ae4f7992b269bc2b67255059af1d2f
size 579889
+27
View File
@@ -0,0 +1,27 @@
# MinIO
## Links
<https://min.io/>
## Steps
1. Configure your minio instance and get an account.
2. Create an Access Key (during the creation, you will also get the auto-generated secret key).
![](./minio_access_key.png)
3. Check or set the region.
![](./minio_region.png)
4. Create a bucket.
![](./minio_create_bucket.png)
5. In remotely-save setting page, input the address / bucket / access key / secret key. **Usually minio instances may need "S3 URL style"="Path Style".** Enable "Bypass CORS", because usually that's what you want.
![](./minio_rs_settings.png)
6. Sync!
![](./minio_sync_success.png)
## Ports In Address
Just type in the full address with `http(s)://` and `:port` in remotely-save settings, for example `http://192.168.31.198:9000`.
It's verified that everything is ok.
![](./minio_custom_port.png)
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:c384ec32a43fcac1e63dbc81d4fbb7fbfaffcd67d0f5a66104482a39475ad639
size 323050
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:894a6a10b7f41754936d77a935b4a5a4ae722796fa5680c9c6d0dd53c3cdc1a2
size 269705
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:b25c1209875ad781a29d3ac1cde5bd9c2137622e3919987c4d4e5f77dc8e3ec7
size 68997
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:bfcc526281d2c6a9f1261f489603f3dd768f8b94f099a1b26649fa37c9318575
size 315030
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:83615a6c2fbf7ff74679b480d29d222db8835bc067aee33a646e4b8d500c3aca
size 467575
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:fd1bb9a6e285a1e63b545d714ca269eb714e980a5177392b967556f1f1754afe
size 147218
@@ -0,0 +1,22 @@
# AList
## 链接 Links
- English official website: <https://alist.nn.ci/> and <https://alist.nn.ci/guide/webdav.html>
- 中文官网:<https://alist.nn.ci/zh/> 和 <https://alist.nn.ci/zh/guide/webdav.html>
## 步骤 Steps
1. 安装和使用 AList。获取账号名和密码。在网页上登录。Install and run AList. Get the account and password. Login using the web page.
2. 新建挂载,检查挂载路径。如图所示是 `/alisttest davpath`。Add new storage. Pay attention to the mount path. The screenshot shows the mount path as `/alisttest davpath`.
![](./alist_mount_path.zh.png)
![](./alist_mount_path.en.png)
3. 从而构建 webdav 网址如下,**http(s)://域名** + **端口** + **`/dav`** + **挂载路径**,其中挂载路径中假如有空格,换成 `%20`Construct the webdav address as: **http(s)://domain** + **port** + **`/dav`** + **mount path**, and the space inside the mount path should be replaced with `%20`:
```
http[s]://domain:port/dav/[mountpath url encoded]
http://127.0.0.1:5244/dav/alisttest%20davpath
```
4. 在 remotely-save 设置,输入**带域名端口`/dav`和挂载路径的网址**、账号、密码。In remotely-save setting page, select webdav type, then input the **full address with mount path**/account/password.
![](./alist_rs_settings.en.png)
5. 在 remotely-save 设置,检查连接。In remotely-save setting page, click "Check Connectivity".
6. 同步文件!Sync!
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:ea05f67782b8f84518f13cf5587df719bdaa15f9e35b79f2801f91e695de6480
size 46798
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:dcaaa5e64e894f0e9c8b0242b64bf4dd364c16d7314b09bc004f7ed0a0f1e0e5
size 60853
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:0b792320e2a4aaa16a17d82e80225ab35da05fd1f407fe067de72651beca088e
size 426289
@@ -0,0 +1,15 @@
# InfiniCLOUD (formally TeraCLOUD) Webdav
## Link
<https://infini-cloud.net/en/>
## Steps
1. Register an acount.
2. Go to <https://infini-cloud.net/en/modules/mypage/usage/>, in section "Apps Connection", enable "Turn on Apps Connection". Here you get the address and account and webdav password (different from your account password):
![](./infinicloud_account.png)
3. In remotely-save setting page, select webdav type, then input the address/account/**webdav password**(not your account password).
![](./infinicloud_rs_setting.png)
4. In remotely-save setting page, click "Check Connectivity".
5. Sync!
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:0e16bc9d86b30ab907fc176087701474f4ca2b8d887f649302f2e184f69d0cbc
size 373845
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:8d707f6997df57b9c6b74d72bcfd567995d15062269761ee404e6596a266a241
size 91012
@@ -0,0 +1,22 @@
# 坚果云 JianGuoYun/NutStore
## 链接 Link
<https://www.jianguoyun.com/>
## 注意!!!Attentions!!!
坚果云有限制 api 数量等设定。本插件会产生若干查询,如果文件较多很容易触发 api 上限,从而工作不正常。这不是插件 bug,也没有办法解决。
JianGuoYun/NutStore has api limits. The plugin may generate many queries, and it's possible to reach the api limits if there are many files, then do not work properly. It's not a bug and there's no way to fix this situation.
## 步骤 Steps
1. **知悉坚果云有 api 限制,本插件可能因此工作不正常。Be aware that JianGuoYun/NutStore has api limits, and the plugin may not work properly because of this.**
2. 注册账号,登录。Register an account.
3. 去“个人信息”->“安全”,“添加应用”,从而获取了 webDAV 账号(应该是 email)和 WebDAV 密码(一串特殊的字符,不等于网站密码)。Go to "settings"->"Security", click "Add Application", then obtain the WebDAV account (email), and WebDAV password (a string different from web site password).
![](./webdav_jianguoyun.cn.png)
4. 在 remotely-save 设置,输入网址、账号、密码、**“发送到服务器的 Depth Header”设置为“只支持 depth='1'”**。Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
![](./webdav_jianguoyun_rs_settting.cn.png)
5. 在 remotely-save 设置,检查连接。In remotely-save setting page, click "Check Connectivity".
6. 同步文件!Sync!
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:fd5aaab1e1ac0ea8996517c819bf5ac0d2a828483037419ba289b538957f4752
size 515913
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:112778176af954e16c93c582d968e7c14e5b950d64facce8593855f5fb75fbcc
size 431527
@@ -0,0 +1,17 @@
# ownCloud Webdav
## Link
<https://owncloud.com/>
# Steps
1. Create an account.
2. Login.
3. In the Settings position, enable the "Show hidden files" and find out the WebDAV address.
![](./owncloud_address.png)
4. Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
![](./owncloud_rs_settings.png)
5. In remotely-save setting page, click "Check Connectivity".
6. Sync!
![](./owncloud_files.png)
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:e0d025b4ccf1be7fa2cc74e914e9a1a89a8d8f12a1b917bd4b26b975bf208294
size 27796
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:b3d24d416016b2676a86166fcc35fa89f8befb7a872503b8da2be4374ef360ce
size 53503
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:2e8bf9a51e5d5bed66fb45fe085f37943bd90a51b33ef752d898c5b2caa71c2d
size 448797
+2 -2
View File
@@ -18,7 +18,7 @@ The list is for information purposes only.
| [MinIO](https://min.io/) | ? | ? | | | | |
| [WsgiDAV](https://github.com/mar10/wsgidav) | Yes | | Yes | | Yes | CORS rules can be set. |
| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes? | | Yes? | | Yes? | ? |
| NextCloud | Yes? | | Yes? | | Yes? | No CORS config by default. |
| NextCloud | Yes | | Yes | | Yes? | No CORS config by default. |
| OwnCloud | Yes? | | Yes? | | Yes? | No CORS config by default. |
| Seafile | Yes | | Yes | | Yes? | No CORS config by default. |
| `rclone serve webdav` | Yes | | Yes | | Yes | No CORS support. |
@@ -26,7 +26,7 @@ The list is for information purposes only.
| [TeraCLOUD](https://teracloud.jp/en/) | Yes | | Yes | | Yes | No CORS support. |
| Dropbox | Yes | | | Yes | | |
| OneDrive for personal | Yes | | | Yes | | |
| OneDrive for Business | In the plan | | | ? | | |
| OneDrive for Business | Yes | | | ? | | |
| Google Drive | In the plan | | | ? | | |
| [Box](https://www.box.com/) | ? | | | May be possible but needs further development. | | |
| Google Cloud Storage | ? | | | May be possible but needs further development. | | |
+17
View File
@@ -0,0 +1,17 @@
# Sync Ignoring Large Files
Initially, the plugin does not ignore large files.
From the new version in May 2022, it can ignore all files with some sizes. But we need some rules to make the function compatible with existing conditions.
1. If users are using E2E password mode, then the file sizes are compared on the **encrypted sizes**, rather than the original unencripted file sizes. The reasons are: the encrypted ones are in transferations, and the encrypted sizes can be computed from unencrypted sizes but not the reverse.
2. Assuming the file A, is already synced between local device and remote service before.
- If the local size and remote size are both below the threshold, then the file can be synced normally.
- If the local size and remote size are both above the threshold, then the file will be ignored normally.
- If the local size is below the threshold, and the remote size is above the threshold, then the plugin **rejects** the sync, and throws the error to the user.
- If the local size is above the threshold, and the remote size is below the threshold, then the plugin **rejects** the sync, and throws the error to the user.
- When it somes to deletions, the same rules apply.
The main point is that, if the file sizes "cross the line", the plugin does not introduce any further trouble and just reject to work for this file.
+19 -3
View File
@@ -18,7 +18,7 @@ const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
esbuild
.build({
.context({
banner: {
js: banner,
},
@@ -31,13 +31,15 @@ esbuild
"obsidian",
"electron",
"fs",
"crypto",
"tls",
"net",
"http",
"https",
// ...builtins
],
inject: ["./esbuild.injecthelper.mjs"],
format: "cjs",
watch: !prod,
// watch: !prod, // no longer valid in esbuild 0.17
target: "es2016",
logLevel: "info",
sourcemap: prod ? false : "inline",
@@ -48,6 +50,20 @@ esbuild
"process.env.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`,
"process.env.DEFAULT_ONEDRIVE_CLIENT_ID": `"${DEFAULT_ONEDRIVE_CLIENT_ID}"`,
"process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`,
global: "window",
"process.env.NODE_DEBUG": `undefined`, // ugly fix
"process.env.DEBUG": `undefined`, // ugly fix
},
})
.then((context) => {
if (process.argv.includes("--watch")) {
// Enable watch mode
context.watch();
} else {
// Build once and exit if not in watch mode
context.rebuild().then((result) => {
context.dispose();
});
}
})
.catch(() => process.exit(1));
+2
View File
@@ -0,0 +1,2 @@
export let Buffer = require("buffer").Buffer;
export let process = require("process/browser");
+10
View File
@@ -0,0 +1,10 @@
{
"id": "remotely-save",
"name": "Remotely Save",
"version": "0.3.29",
"minAppVersion": "0.13.21",
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
"author": "fyears",
"authorUrl": "https://github.com/fyears",
"isDesktopOnly": false
}
+1 -1
View File
@@ -1,7 +1,7 @@
{
"id": "remotely-save",
"name": "Remotely Save",
"version": "0.3.19",
"version": "0.3.25",
"minAppVersion": "0.13.21",
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
"author": "fyears",
+58 -57
View File
@@ -1,13 +1,13 @@
{
"name": "remotely-save",
"version": "0.3.19",
"version": "0.3.25",
"description": "This is yet another sync plugin for Obsidian app.",
"scripts": {
"dev2": "node esbuild.config.mjs",
"dev2": "node esbuild.config.mjs --watch",
"build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
"build": "webpack --mode production",
"dev": "webpack --mode development --watch",
"format": "npx prettier --write .",
"format": "npx prettier --trailing-comma es5 --write .",
"clean": "npx rimraf main.js",
"test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'"
},
@@ -23,73 +23,74 @@
"author": "",
"license": "Apache-2.0",
"devDependencies": {
"@microsoft/microsoft-graph-types": "^2.11.0",
"@types/chai": "^4.2.22",
"@types/chai-as-promised": "^7.1.4",
"@types/jsdom": "^16.2.13",
"@types/lodash": "^4.14.178",
"@types/mime-types": "^2.1.1",
"@types/mocha": "^9.0.0",
"@types/mustache": "^4.1.2",
"@types/node": "^14.14.37",
"@types/qrcode": "^1.4.1",
"builtin-modules": "^3.2.0",
"chai": "^4.3.4",
"@microsoft/microsoft-graph-types": "^2.40.0",
"@types/chai": "^4.3.11",
"@types/chai-as-promised": "^7.1.8",
"@types/jsdom": "^21.1.6",
"@types/lodash": "^4.14.202",
"@types/mime-types": "^2.1.4",
"@types/mocha": "^10.0.6",
"@types/mustache": "^4.2.5",
"@types/node": "^20.10.4",
"@types/qrcode": "^1.5.5",
"builtin-modules": "^3.3.0",
"chai": "^4.3.10",
"chai-as-promised": "^7.1.1",
"cross-env": "^7.0.3",
"dotenv": "^10.0.0",
"esbuild": "^0.14.27",
"jsdom": "^19.0.0",
"mocha": "^9.1.3",
"prettier": "^2.4.1",
"ts-loader": "^9.2.6",
"ts-node": "^10.4.0",
"tslib": "^2.2.0",
"typescript": "^4.4.4",
"dotenv": "^16.3.1",
"esbuild": "^0.19.9",
"jsdom": "^23.0.1",
"mocha": "^10.2.0",
"npm-check-updates": "^16.14.12",
"obsidian": "^1.4.11",
"prettier": "^3.1.1",
"ts-loader": "^9.5.1",
"ts-node": "^10.9.2",
"tslib": "^2.6.2",
"typescript": "^5.3.3",
"webdav-server": "^2.6.2",
"webpack": "^5.64.4",
"webpack-cli": "^4.9.1"
"webpack": "^5.89.0",
"webpack-cli": "^5.1.4"
},
"dependencies": {
"@aws-sdk/client-s3": "^3.67.0",
"@aws-sdk/fetch-http-handler": "^3.58.0",
"@aws-sdk/lib-storage": "^3.67.0",
"@aws-sdk/protocol-http": "^3.58.0",
"@aws-sdk/querystring-builder": "^3.55.0",
"@aws-sdk/signature-v4-crt": "^3.66.0",
"@aws-sdk/types": "^3.55.0",
"@azure/msal-node": "^1.6.0",
"@aws-sdk/client-s3": "^3.474.0",
"@aws-sdk/lib-storage": "^3.474.0",
"@aws-sdk/signature-v4-crt": "^3.474.0",
"@aws-sdk/types": "^3.468.0",
"@azure/msal-node": "^2.6.0",
"@fyears/tsqueue": "^1.0.1",
"@microsoft/microsoft-graph-client": "^3.0.1",
"acorn": "^8.5.0",
"aggregate-error": "^4.0.0",
"assert": "^2.0.0",
"aws-crt": "^1.10.1",
"@microsoft/microsoft-graph-client": "^3.0.7",
"@smithy/fetch-http-handler": "^2.3.1",
"@smithy/protocol-http": "^3.0.11",
"@smithy/querystring-builder": "^2.0.15",
"acorn": "^8.11.2",
"aggregate-error": "^5.0.0",
"assert": "^2.1.0",
"aws-crt": "^1.20.0",
"buffer": "^6.0.3",
"crypto-browserify": "^3.12.0",
"delay": "^5.0.0",
"dropbox": "^10.22.0",
"emoji-regex": "^10.1.0",
"http-status-codes": "^2.2.0",
"delay": "^6.0.0",
"dropbox": "^10.34.0",
"emoji-regex": "^10.3.0",
"http-status-codes": "^2.3.0",
"localforage": "^1.10.0",
"lodash": "^4.17.21",
"loglevel": "^1.8.0",
"lucide": "^0.17.12",
"mime-types": "^2.1.33",
"loglevel": "^1.8.1",
"lucide": "^0.298.0",
"mime-types": "^2.1.35",
"mustache": "^4.2.0",
"nanoid": "^3.1.30",
"obsidian": "^0.13.26",
"p-queue": "^7.2.0",
"nanoid": "^5.0.4",
"p-queue": "^8.0.1",
"path-browserify": "^1.0.1",
"process": "^0.11.10",
"qrcode": "^1.5.0",
"rfc4648": "^1.5.0",
"rimraf": "^3.0.2",
"qrcode": "^1.5.3",
"rfc4648": "^1.5.3",
"rimraf": "^5.0.5",
"stream-browserify": "^3.0.0",
"url": "^0.11.0",
"util": "^0.12.4",
"webdav": "^4.7.0",
"webdav-fs": "^4.0.0",
"xregexp": "^5.1.0"
"url": "^0.11.3",
"util": "^0.12.5",
"webdav": "^5.3.1",
"webdav-fs": "^4.0.1",
"xregexp": "^5.1.1"
}
}
+18 -1
View File
@@ -85,6 +85,8 @@ export interface RemotelySavePluginSettings {
syncUnderscoreItems?: boolean;
lang?: LangTypeAndAuto;
logToDB?: boolean;
skipSizeLargerThan?: number;
ignorePaths?: string[];
/**
* @deprecated
@@ -122,13 +124,24 @@ type DecisionTypeForFile =
| "uploadLocalToRemote" // "skipLocal && uploadLocalToRemote && cleanLocalDelHist && cleanRemoteDelHist"
| "downloadRemoteToLocal"; // "downloadRemoteToLocal && skipRemote && cleanLocalDelHist && cleanRemoteDelHist"
type DecisionTypeForFileSize =
| "skipUploadingTooLarge"
| "skipDownloadingTooLarge"
| "skipUsingLocalDelTooLarge"
| "skipUsingRemoteDelTooLarge"
| "errorLocalTooLargeConflictRemote"
| "errorRemoteTooLargeConflictLocal";
type DecisionTypeForFolder =
| "createFolder"
| "uploadLocalDelHistToRemoteFolder"
| "keepRemoteDelHistFolder"
| "skipFolder";
export type DecisionType = DecisionTypeForFile | DecisionTypeForFolder;
export type DecisionType =
| DecisionTypeForFile
| DecisionTypeForFileSize
| DecisionTypeForFolder;
export interface FileOrFolderMixedState {
key: string;
@@ -139,7 +152,9 @@ export interface FileOrFolderMixedState {
deltimeLocal?: number;
deltimeRemote?: number;
sizeLocal?: number;
sizeLocalEnc?: number;
sizeRemote?: number;
sizeRemoteEnc?: number;
changeRemoteMtimeUsingMapping?: boolean;
changeLocalMtimeUsingMapping?: boolean;
decision?: DecisionType;
@@ -165,3 +180,5 @@ export const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
export const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX =
"sync_plans_hist_exported_on_";
export const DEFAULT_LOG_HISTORY_FILE_PREFIX = "log_hist_exported_on_";
export type SyncTriggerSourceType = "manual" | "auto" | "dry" | "autoOnceInit";
+2
View File
@@ -26,11 +26,13 @@ const turnSyncPlanToTable = (record: string) => {
"remoteEncryptedKey",
"existLocal",
"sizeLocal",
"sizeLocalEnc",
"mtimeLocal",
"deltimeLocal",
"changeLocalMtimeUsingMapping",
"existRemote",
"sizeRemote",
"sizeRemoteEnc",
"mtimeRemote",
"deltimeRemote",
"changeRemoteMtimeUsingMapping",
+7 -5
View File
@@ -166,18 +166,20 @@ export const decryptBase64urlToString = async (
};
export const getSizeFromOrigToEnc = (x: number) => {
if (x < 0 || !Number.isInteger(x)) {
throw Error(`x=${x} is not a valid size`);
if (x < 0 || Number.isNaN(x) || !Number.isInteger(x)) {
throw Error(`getSizeFromOrigToEnc: x=${x} is not a valid size`);
}
return (Math.floor(x / 16) + 1) * 16 + 16;
};
export const getSizeFromEncToOrig = (x: number) => {
if (x < 32 || !Number.isInteger(x)) {
throw Error(`${x} is not a valid size`);
if (x < 32 || Number.isNaN(x) || !Number.isInteger(x)) {
throw Error(`getSizeFromEncToOrig: ${x} is not a valid size`);
}
if (x % 16 !== 0) {
throw Error(`${x} is not a valid encrypted file size`);
throw Error(
`getSizeFromEncToOrig: ${x} is not a valid encrypted file size`
);
}
return {
minSize: ((x - 16) / 16 - 1) * 16,
+2 -2
View File
@@ -5,7 +5,7 @@ import { LANGS } from "./langs";
export type LangType = keyof typeof LANGS;
export type LangTypeAndAuto = LangType | "auto";
export type TransItemType = keyof typeof LANGS["en"];
export type TransItemType = keyof (typeof LANGS)["en"];
export class I18n {
lang: LangTypeAndAuto;
@@ -31,7 +31,7 @@ export class I18n {
}
const res: string =
(LANGS[realLang] as typeof LANGS["en"])[key] || LANGS["en"][key] || key;
(LANGS[realLang] as (typeof LANGS)["en"])[key] || LANGS["en"][key] || key;
return res;
}
+4 -5
View File
@@ -5,7 +5,7 @@ import { requireApiVersion, TAbstractFile, TFile, TFolder } from "obsidian";
import { API_VER_STAT_FOLDER, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
import type { SyncPlanType } from "./sync";
import { toText, unixTimeToStr } from "./misc";
import { statFix, toText, unixTimeToStr } from "./misc";
import { log } from "./moreOnLog";
@@ -312,9 +312,8 @@ export const clearDeleteRenameHistoryOfKeyAndVault = async (
vaultRandomID: string
) => {
const fullKey = `${vaultRandomID}\t${key}`;
const item: FileFolderHistoryRecord | null = await db.fileHistoryTbl.getItem(
fullKey
);
const item: FileFolderHistoryRecord | null =
await db.fileHistoryTbl.getItem(fullKey);
if (
item !== null &&
(item.actionType === "delete" || item.actionType === "rename")
@@ -417,7 +416,7 @@ export const insertRenameRecordByVault = async (
if (requireApiVersion(API_VER_STAT_FOLDER)) {
// TAbstractFile does not contain these info
// but from API_VER_STAT_FOLDER we can manually stat them by path.
const s = await fileOrFolder.vault.adapter.stat(fileOrFolder.path);
const s = await statFix(fileOrFolder.vault, fileOrFolder.path);
ctime = s.ctime;
mtime = s.mtime;
}
+27 -9
View File
@@ -9,7 +9,11 @@ import {
} from "obsidian";
import cloneDeep from "lodash/cloneDeep";
import { createElement, RotateCcw, RefreshCcw, FileText } from "lucide";
import type { RemotelySavePluginSettings } from "./baseTypes";
import type {
FileOrFolderMixedState,
RemotelySavePluginSettings,
SyncTriggerSourceType,
} from "./baseTypes";
import {
COMMAND_CALLBACK,
COMMAND_CALLBACK_ONEDRIVE,
@@ -61,6 +65,7 @@ import {
exportVaultLoggerOutputToFiles,
exportVaultSyncPlansToFiles,
} from "./debugMode";
import { SizesConflictModal } from "./syncSizesConflictNotice";
const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
s3: DEFAULT_S3_CONFIG,
@@ -79,6 +84,8 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
syncUnderscoreItems: false,
lang: "auto",
logToDB: false,
skipSizeLargerThan: -1,
ignorePaths: [],
};
interface OAuth2Info {
@@ -89,8 +96,6 @@ interface OAuth2Info {
revokeAuthSetting?: Setting;
}
type SyncTriggerSourceType = "manual" | "auto" | "dry" | "autoOnceInit";
const iconNameSyncWait = `remotely-save-sync-wait`;
const iconNameSyncRunning = `remotely-save-sync-running`;
const iconNameLogs = `remotely-save-logs`;
@@ -279,23 +284,24 @@ export default class RemotelySavePlugin extends Plugin {
})
);
this.syncStatus = "generating_plan";
const { plan, sortedKeys, deletions } = await getSyncPlan(
const { plan, sortedKeys, deletions, sizesGoWrong } = await getSyncPlan(
remoteStates,
local,
localConfigDirContents,
origMetadataOnRemote.deletions,
localHistory,
client.serviceType,
triggerSource,
this.app.vault,
this.settings.syncConfigDir,
this.app.vault.configDir,
this.settings.syncUnderscoreItems,
this.settings.skipSizeLargerThan,
this.settings.ignorePaths,
this.settings.password
);
log.info(plan.mixedStates); // for debugging
if (triggerSource !== "dry") {
await insertSyncPlanRecordByVault(this.db, plan, this.vaultRandomID);
}
// The operations above are almost read only and kind of safe.
// The operations below begins to write or delete (!!!) something.
@@ -317,10 +323,20 @@ export default class RemotelySavePlugin extends Plugin {
sortedKeys,
metadataFile,
origMetadataOnRemote,
sizesGoWrong,
deletions,
(key: string) => self.trash(key),
this.settings.password,
this.settings.concurrency,
(ss: FileOrFolderMixedState[]) => {
new SizesConflictModal(
self.app,
self,
this.settings.skipSizeLargerThan,
ss,
this.settings.password !== ""
).open();
},
(i: number, totalCount: number, pathName: string, decision: string) =>
self.setCurrSyncMsg(i, totalCount, pathName, decision)
);
@@ -779,6 +795,9 @@ export default class RemotelySavePlugin extends Plugin {
if (this.settings.s3.forcePathStyle === undefined) {
this.settings.s3.forcePathStyle = false;
}
if (this.settings.ignorePaths === undefined) {
this.settings.ignorePaths = [];
}
}
async checkIfPresetRulesFollowed() {
@@ -962,9 +981,8 @@ export default class RemotelySavePlugin extends Plugin {
const pluginConfigDir =
this.manifest.dir ||
`${this.app.vault.configDir}/plugins/${this.manifest.dir}`;
const pluginConfigDirExists = await this.app.vault.adapter.exists(
pluginConfigDir
);
const pluginConfigDirExists =
await this.app.vault.adapter.exists(pluginConfigDir);
if (!pluginConfigDirExists) {
// what happened?
return;
+34 -8
View File
@@ -1,6 +1,7 @@
import isEqual from "lodash/isEqual";
import { base64url } from "rfc4648";
import { reverseString } from "./misc";
import { log } from "./moreOnLog";
const DEFAULT_README_FOR_METADATAONREMOTE =
"Do NOT edit or delete the file manually. This file is for the plugin remotely-save to store some necessary meta data on the remote services. Its content is slightly obfuscated.";
@@ -69,19 +70,44 @@ export const deserializeMetadataOnRemote = (x: string | ArrayBuffer) => {
} else {
y1 = new TextDecoder().decode(x);
}
const y2: any = JSON.parse(y1);
if (!("readme" in y2 && "d" in y2)) {
throw Error("invalid remote meta data file!");
let y2: any;
try {
y2 = JSON.parse(y1);
} catch (e) {
throw new Error(
`invalid remote meta data file with first few chars: ${y1.slice(0, 5)}`
);
}
const y3 = JSON.parse(
(
if (!("readme" in y2 && "d" in y2)) {
throw new Error(
'invalid remote meta data file (no "readme" or "d" fields)!'
);
}
let y3: string;
try {
y3 = (
base64url.parse(reverseString(y2["d"]), {
out: Buffer.allocUnsafe as any,
loose: true,
}) as Buffer
).toString("utf-8")
) as MetadataOnRemote;
return y3;
).toString("utf-8");
} catch (e) {
throw new Error('invalid remote meta data file (invalid "d" field)!');
}
let y4: MetadataOnRemote;
try {
y4 = JSON.parse(y3) as MetadataOnRemote;
} catch (e) {
throw new Error(
`invalid remote meta data file with \"d\" field with first few chars: ${y3.slice(
0,
5
)}`
);
}
return y4;
};
+23 -4
View File
@@ -339,12 +339,9 @@ export const checkHasSpecialCharForDir = (x: string) => {
};
export const unixTimeToStr = (x: number | undefined | null) => {
if (x === undefined) {
if (x === undefined || x === null || Number.isNaN(x)) {
return undefined;
}
if (x === null) {
return null;
}
return window.moment(x).format() as string;
};
@@ -408,3 +405,25 @@ export const toText = (x: any) => {
return `${x}`;
}
};
/**
* On Android the stat has bugs for folders. So we need a fixed version.
* @param vault
* @param path
*/
export const statFix = async (vault: Vault, path: string) => {
const s = await vault.adapter.stat(path);
if (s.ctime === undefined || s.ctime === null || Number.isNaN(s.ctime)) {
s.ctime = undefined;
}
if (s.mtime === undefined || s.mtime === null || Number.isNaN(s.mtime)) {
s.mtime = undefined;
}
if (
(s.size === undefined || s.size === null || Number.isNaN(s.size)) &&
s.type === "folder"
) {
s.size = 0;
}
return s;
};
+8 -2
View File
@@ -4,14 +4,20 @@
import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
import * as origLog from "loglevel";
import type { LogLevelNumbers, Logger, LogLevel, LogLevelDesc } from "loglevel";
import type {
LogLevelNumbers,
Logger,
LogLevel,
LogLevelDesc,
LogLevelNames,
} from "loglevel";
const log2 = origLog.getLogger("rs-default");
const originalFactory = log2.methodFactory;
export const applyLogWriterInplace = function (writer: (...msg: any[]) => any) {
log2.methodFactory = function (
methodName: string,
methodName: LogLevelNames,
logLevel: LogLevelNumbers,
loggerName: string | symbol
) {
+11 -2
View File
@@ -2,6 +2,7 @@ import { Vault, Stat, ListedFiles } from "obsidian";
import { Queue } from "@fyears/tsqueue";
import chunk from "lodash/chunk";
import flatten from "lodash/flatten";
import { statFix } from "./misc";
export interface ObsConfigDirFileType {
key: string;
@@ -12,7 +13,14 @@ export interface ObsConfigDirFileType {
}
const isFolderToSkip = (x: string) => {
let specialFolders = [".git", ".svn", "node_modules"];
let specialFolders = [
".git",
".github",
".gitlab",
".svn",
"node_modules",
".DS_Store",
];
for (const iterator of specialFolders) {
if (
x === iterator ||
@@ -75,7 +83,8 @@ export const listFilesInObsFolder = async (
const itemsToFetchChunks = chunk(itemsToFetch, CHUNK_SIZE);
for (const singleChunk of itemsToFetchChunks) {
const r = singleChunk.map(async (x) => {
const statRes = await vault.adapter.stat(x);
const statRes = await statFix(vault, x);
const isFolder = statRes.type === "folder";
let children: ListedFiles = undefined;
if (isFolder) {
+10 -8
View File
@@ -15,7 +15,6 @@ import { log } from "./moreOnLog";
export class RemoteClient {
readonly serviceType: SUPPORTED_SERVICES_TYPE;
readonly s3Client?: s3.S3Client;
readonly s3Config?: S3Config;
readonly webdavClient?: webdav.WrappedWebdavClient;
readonly webdavConfig?: WebdavConfig;
@@ -38,7 +37,6 @@ export class RemoteClient {
// so we use a ref not copy of config here
if (serviceType === "s3") {
this.s3Config = s3Config;
this.s3Client = s3.getS3Client(this.s3Config);
} else if (serviceType === "webdav") {
if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
throw Error(
@@ -86,7 +84,7 @@ export class RemoteClient {
getRemoteMeta = async (fileOrFolderPath: string) => {
if (this.serviceType === "s3") {
return await s3.getRemoteMeta(
this.s3Client,
s3.getS3Client(this.s3Config),
this.s3Config,
fileOrFolderPath
);
@@ -116,7 +114,7 @@ export class RemoteClient {
) => {
if (this.serviceType === "s3") {
return await s3.uploadToRemote(
this.s3Client,
s3.getS3Client(this.s3Config),
this.s3Config,
fileOrFolderPath,
vault,
@@ -168,7 +166,11 @@ export class RemoteClient {
listFromRemote = async (prefix?: string) => {
if (this.serviceType === "s3") {
return await s3.listFromRemote(this.s3Client, this.s3Config, prefix);
return await s3.listFromRemote(
s3.getS3Client(this.s3Config),
this.s3Config,
prefix
);
} else if (this.serviceType === "webdav") {
return await webdav.listFromRemote(this.webdavClient, prefix);
} else if (this.serviceType === "dropbox") {
@@ -190,7 +192,7 @@ export class RemoteClient {
) => {
if (this.serviceType === "s3") {
return await s3.downloadFromRemote(
this.s3Client,
s3.getS3Client(this.s3Config),
this.s3Config,
fileOrFolderPath,
vault,
@@ -241,7 +243,7 @@ export class RemoteClient {
) => {
if (this.serviceType === "s3") {
return await s3.deleteFromRemote(
this.s3Client,
s3.getS3Client(this.s3Config),
this.s3Config,
fileOrFolderPath,
password,
@@ -276,7 +278,7 @@ export class RemoteClient {
checkConnectivity = async (callbackFunc?: any) => {
if (this.serviceType === "s3") {
return await s3.checkConnectivity(
this.s3Client,
s3.getS3Client(this.s3Config),
this.s3Config,
callbackFunc
);
+7 -2
View File
@@ -1,4 +1,4 @@
import delay from "delay";
import { rangeDelay } from "delay";
import { Dropbox, DropboxAuth } from "dropbox";
import type { files, DropboxResponseError, DropboxResponse } from "dropbox";
import { Vault } from "obsidian";
@@ -340,7 +340,7 @@ async function retryReq<T>(
2
)}`
);
await delay.range(secMin * 1000, secMax * 1000);
await rangeDelay(secMin * 1000, secMax * 1000);
}
}
}
@@ -371,9 +371,13 @@ export class WrappedDropboxClient {
throw Error("The user has not manually auth yet.");
}
const currentTs = Date.now();
const customHeaders = {
"Cache-Control": "no-cache",
};
if (this.dropboxConfig.accessTokenExpiresAtTime > currentTs) {
this.dropbox = new Dropbox({
accessToken: this.dropboxConfig.accessToken,
customHeaders: customHeaders,
});
} else {
if (this.dropboxConfig.refreshToken === "") {
@@ -393,6 +397,7 @@ export class WrappedDropboxClient {
);
this.dropbox = new Dropbox({
accessToken: this.dropboxConfig.accessToken,
customHeaders: customHeaders,
});
}
+11 -2
View File
@@ -444,6 +444,7 @@ export class WrappedOnedriveClient {
contentType: "application/json",
headers: {
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
"Cache-Control": "no-cache",
},
})
);
@@ -565,6 +566,7 @@ export class WrappedOnedriveClient {
headers: {
// no "Content-Length" allowed here
"Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
/* "Cache-Control": "no-cache", not allowed here!!! */
},
});
return res.json as DriveItem | UploadSession;
@@ -576,6 +578,7 @@ export class WrappedOnedriveClient {
"Content-Length": `${rangeEnd - rangeStart}`,
"Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
"Content-Type": DEFAULT_CONTENT_TYPE,
/* "Cache-Control": "no-cache", not allowed here!!! */
},
});
return (await res.json()) as DriveItem | UploadSession;
@@ -809,10 +812,16 @@ const downloadFromRemoteRaw = async (
);
const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
if (VALID_REQURL) {
const content = (await requestUrl({ url: downloadUrl })).arrayBuffer;
const content = (
await requestUrl({
url: downloadUrl,
headers: { "Cache-Control": "no-cache" },
})
).arrayBuffer;
return content;
} else {
const content = await (await fetch(downloadUrl)).arrayBuffer();
const content = await // cannot set no-cache here, will have cors error
(await fetch(downloadUrl)).arrayBuffer();
return content;
}
};
+54 -16
View File
@@ -11,19 +11,20 @@ import {
S3Client,
} from "@aws-sdk/client-s3";
import { Upload } from "@aws-sdk/lib-storage";
import { HttpHandler, HttpRequest, HttpResponse } from "@aws-sdk/protocol-http";
import { HttpHandler, HttpRequest, HttpResponse } from "@smithy/protocol-http";
import {
FetchHttpHandler,
FetchHttpHandlerOptions,
} from "@aws-sdk/fetch-http-handler";
} from "@smithy/fetch-http-handler";
// @ts-ignore
import { requestTimeout } from "@aws-sdk/fetch-http-handler/dist-es/request-timeout";
import { buildQueryString } from "@aws-sdk/querystring-builder";
import { requestTimeout } from "@smithy/fetch-http-handler/dist-es/request-timeout";
import { buildQueryString } from "@smithy/querystring-builder";
import { HeaderBag, HttpHandlerOptions, Provider } from "@aws-sdk/types";
import { Buffer } from "buffer";
import * as mime from "mime-types";
import { Vault, requestUrl, RequestUrlParam } from "obsidian";
import { Readable } from "stream";
import AggregateError from "aggregate-error";
import {
DEFAULT_CONTENT_TYPE,
RemoteItem,
@@ -83,11 +84,14 @@ class ObsHttpHandler extends FetchHttpHandler {
const body =
method === "GET" || method === "HEAD" ? undefined : request.body;
const transformedHeaders = { ...request.headers };
delete transformedHeaders["host"];
delete transformedHeaders["Host"];
delete transformedHeaders["content-length"];
delete transformedHeaders["Content-Length"];
const transformedHeaders: Record<string, string> = {};
for (const key of Object.keys(request.headers)) {
const keyLower = key.toLowerCase();
if (keyLower === "host" || keyLower === "content-length") {
continue;
}
transformedHeaders[keyLower] = request.headers[key];
}
let contentType: string = undefined;
if (transformedHeaders["content-type"] !== undefined) {
@@ -192,8 +196,10 @@ export const getS3Client = (s3Config: S3Config) => {
endpoint = `https://${endpoint}`;
}
let s3Client: S3Client;
if (VALID_REQURL && s3Config.bypassCorsLocally) {
const s3Client = new S3Client({
s3Client = new S3Client({
region: s3Config.s3Region,
endpoint: endpoint,
forcePathStyle: s3Config.forcePathStyle,
@@ -203,9 +209,8 @@ export const getS3Client = (s3Config: S3Config) => {
},
requestHandler: new ObsHttpHandler(),
});
return s3Client;
} else {
const s3Client = new S3Client({
s3Client = new S3Client({
region: s3Config.s3Region,
endpoint: endpoint,
forcePathStyle: s3Config.forcePathStyle,
@@ -214,8 +219,19 @@ export const getS3Client = (s3Config: S3Config) => {
secretAccessKey: s3Config.s3SecretAccessKey,
},
});
return s3Client;
}
s3Client.middlewareStack.add(
(next, context) => (args) => {
(args.request as any).headers["cache-control"] = "no-cache";
return next(args);
},
{
step: "build",
}
);
return s3Client;
};
export const getRemoteMeta = async (
@@ -493,6 +509,11 @@ export const deleteFromRemote = async (
/**
* Check the config of S3 by heading bucket
* https://stackoverflow.com/questions/50842835
*
* Updated on 20240102:
* Users are not always have permission of heading bucket,
* so we need to use listing objects instead...
*
* @param s3Client
* @param s3Config
* @returns
@@ -503,9 +524,15 @@ export const checkConnectivity = async (
callbackFunc?: any
) => {
try {
const results = await s3Client.send(
new HeadBucketCommand({ Bucket: s3Config.s3BucketName })
);
// const results = await s3Client.send(
// new HeadBucketCommand({ Bucket: s3Config.s3BucketName })
// );
// very simplified version of listing objects
const confCmd = {
Bucket: s3Config.s3BucketName,
} as ListObjectsV2CommandInput;
const results = await s3Client.send(new ListObjectsV2Command(confCmd));
if (
results === undefined ||
results.$metadata === undefined ||
@@ -522,8 +549,19 @@ export const checkConnectivity = async (
} catch (err) {
log.debug(err);
if (callbackFunc !== undefined) {
if (s3Config.s3Endpoint.contains(s3Config.s3BucketName)) {
const err2 = new AggregateError([
err,
new Error(
"Maybe you've included the bucket name inside the endpoint setting. Please remove the bucket name and try again."
),
]);
callbackFunc(err2);
} else {
callbackFunc(err);
}
}
return false;
}
};
+114 -83
View File
@@ -15,21 +15,22 @@ import type {
FileStat,
WebDAVClient,
RequestOptionsWithState,
Response,
ResponseDataDetailed,
} from "webdav/web";
import { getPatcher } from "webdav/web";
// Response,
// ResponseDataDetailed,
} from "webdav";
// @ts-ignore
import { getPatcher } from "webdav/dist/web/index.js";
if (VALID_REQURL) {
getPatcher().patch(
"request",
async (
options: RequestOptionsWithState
): Promise<Response | ResponseDataDetailed<any>> => {
async (options: RequestOptionsWithState): Promise<Response> => {
const transformedHeaders = { ...options.headers };
delete transformedHeaders["host"];
delete transformedHeaders["Host"];
delete transformedHeaders["content-length"];
delete transformedHeaders["Content-Length"];
const r = await requestUrl({
url: options.url,
method: options.method,
@@ -37,79 +38,100 @@ if (VALID_REQURL) {
headers: transformedHeaders,
});
let r2: Response | ResponseDataDetailed<any> = undefined;
if (options.responseType === undefined) {
r2 = {
data: undefined,
status: r.status,
statusText: getReasonPhrase(r.status),
headers: r.headers,
};
} else if (options.responseType === "json") {
r2 = {
data: r.json,
status: r.status,
statusText: getReasonPhrase(r.status),
headers: r.headers,
};
} else if (options.responseType === "text") {
r2 = {
data: r.text,
status: r.status,
statusText: getReasonPhrase(r.status),
headers: r.headers,
};
} else if (options.responseType === "arraybuffer") {
r2 = {
data: r.arrayBuffer,
status: r.status,
statusText: getReasonPhrase(r.status),
headers: r.headers,
};
} else {
throw Error(
`do not know how to deal with responseType = ${options.responseType}`
);
let contentType: string | undefined =
r.headers["Content-Type"] ||
r.headers["content-type"] ||
options.headers["Content-Type"] ||
options.headers["content-type"] ||
options.headers["Accept"] ||
options.headers["accept"];
if (contentType !== undefined) {
contentType = contentType.toLowerCase();
}
const rspHeaders = { ...r.headers };
for (let key in rspHeaders) {
if (rspHeaders.hasOwnProperty(key)) {
if (key === "content-disposition" || key === "Content-Disposition") {
rspHeaders[key] = encodeURIComponent(rspHeaders[key]);
}
}
}
// console.log(`requesting url=${options.url}`);
// console.log(`contentType=${contentType}`);
// console.log(`rspHeaders=${JSON.stringify(rspHeaders)}`)
// let r2: Response = undefined;
// if (contentType.includes("xml")) {
// r2 = new Response(r.text, {
// status: r.status,
// statusText: getReasonPhrase(r.status),
// headers: rspHeaders,
// });
// } else if (
// contentType.includes("json") ||
// contentType.includes("javascript")
// ) {
// console.log('inside json branch');
// // const j = r.json;
// // console.log(j);
// r2 = new Response(
// r.text, // yea, here is the text because Response constructor expects a text
// {
// status: r.status,
// statusText: getReasonPhrase(r.status),
// headers: rspHeaders,
// });
// } else if (contentType.includes("text")) {
// // avoid text/json,
// // so we split this out from the above xml or json branch
// r2 = new Response(r.text, {
// status: r.status,
// statusText: getReasonPhrase(r.status),
// headers: rspHeaders,
// });
// } else if (
// contentType.includes("octet-stream") ||
// contentType.includes("binary") ||
// contentType.includes("buffer")
// ) {
// // application/octet-stream
// r2 = new Response(r.arrayBuffer, {
// status: r.status,
// statusText: getReasonPhrase(r.status),
// headers: rspHeaders,
// });
// } else {
// throw Error(
// `do not know how to deal with requested content type = ${contentType}`
// );
// }
let r2: Response = undefined;
if ([101, 103, 204, 205, 304].includes(r.status)) {
// A null body status is a status that is 101, 103, 204, 205, or 304.
// https://fetch.spec.whatwg.org/#statuses
// fix this: Failed to construct 'Response': Response with null body status cannot have body
r2 = new Response(null, {
status: r.status,
statusText: getReasonPhrase(r.status),
headers: rspHeaders,
});
} else {
r2 = new Response(r.arrayBuffer, {
status: r.status,
statusText: getReasonPhrase(r.status),
headers: rspHeaders,
});
}
return r2;
}
);
}
// getPatcher().patch("request", (options: any) => {
// // console.log("using fetch");
// const r = fetch(options.url, {
// method: options.method,
// body: options.data as any,
// headers: options.headers,
// signal: options.signal,
// })
// .then((rsp) => {
// if (options.responseType === undefined) {
// return Promise.all([undefined, rsp]);
// }
// if (options.responseType === "json") {
// return Promise.all([rsp.json(), rsp]);
// }
// if (options.responseType === "text") {
// return Promise.all([rsp.text(), rsp]);
// }
// if (options.responseType === "arraybuffer") {
// return Promise.all([rsp.arrayBuffer(), rsp]);
// }
// })
// .then(([d, r]) => {
// return {
// data: d,
// status: r.status,
// statusText: r.statusText,
// headers: r.headers,
// };
// });
// // console.log("using fetch");
// return r;
// });
import { AuthType, BufferLike, createClient } from "webdav/web";
export type { WebDAVClient } from "webdav/web";
// @ts-ignore
import { AuthType, BufferLike, createClient } from "webdav/dist/web/index.js";
export type { WebDAVClient } from "webdav";
export const DEFAULT_WEBDAV_CONFIG = {
address: "",
@@ -183,6 +205,9 @@ export class WrappedWebdavClient {
init = async () => {
// init client if not inited
const headers = {
"Cache-Control": "no-cache",
};
if (this.client === undefined) {
if (
this.webdavConfig.username !== "" &&
@@ -191,6 +216,7 @@ export class WrappedWebdavClient {
this.client = createClient(this.webdavConfig.address, {
username: this.webdavConfig.username,
password: this.webdavConfig.password,
headers: headers,
authType:
this.webdavConfig.authType === "digest"
? AuthType.Digest
@@ -198,7 +224,9 @@ export class WrappedWebdavClient {
});
} else {
log.info("no password");
this.client = createClient(this.webdavConfig.address);
this.client = createClient(this.webdavConfig.address, {
headers: headers,
});
}
}
@@ -226,9 +254,10 @@ export class WrappedWebdavClient {
method: "PROPFIND",
headers: {
Depth: "infinity",
Accept: "text/plain,application/xml",
},
responseType: "text",
});
// responseType: "text",
} as any);
if (res.status === 403) {
throw Error("not support Infinity, get 403");
} else {
@@ -247,9 +276,10 @@ export class WrappedWebdavClient {
method: "PROPFIND",
headers: {
Depth: "1",
Accept: "text/plain,application/xml",
},
responseType: "text",
}
// responseType: "text",
} as any
);
testPassed = true;
this.webdavConfig.depth = "auto_1";
@@ -449,9 +479,9 @@ const downloadFromRemoteRaw = async (
fileOrFolderPath: string
) => {
await client.init();
const buff = (await client.client.getFileContents(
getWebdavPath(fileOrFolderPath, client.remoteBaseDir)
)) as BufferLike;
const p = getWebdavPath(fileOrFolderPath, client.remoteBaseDir);
// console.log(`getWebdavPath=${p}`);
const buff = (await client.client.getFileContents(p)) as BufferLike;
if (buff instanceof ArrayBuffer) {
return buff;
} else if (buff instanceof Buffer) {
@@ -490,6 +520,7 @@ export const downloadFromRemote = async (
downloadFile = remoteEncryptedKey;
}
downloadFile = getWebdavPath(downloadFile, client.remoteBaseDir);
// console.log(`downloadFile=${downloadFile}`);
const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
let localContent = remoteContent;
if (password !== "") {
+175 -134
View File
@@ -645,8 +645,9 @@ const wrapTextWithPasswordHide = (text: TextComponent) => {
hider.innerHTML = eyeOff;
hider.addEventListener("click", (e) => {
const isText = text.inputEl.getAttribute("type") === "text";
text.inputEl.setAttribute("type", isText ? "password" : "text");
hider.innerHTML = isText ? eyeOff : eye;
text.inputEl.setAttribute("type", isText ? "password" : "text");
text.inputEl.focus();
});
// the init type of text el is password
@@ -674,100 +675,12 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
containerEl.createEl("h1", { text: "Remotely Save" });
//////////////////////////////////////////////////
// below for general
//////////////////////////////////////////////////
const generalDiv = containerEl.createEl("div");
generalDiv.createEl("h2", { text: t("settings_general") });
const passwordDiv = generalDiv.createEl("div");
let newPassword = `${this.plugin.settings.password}`;
new Setting(passwordDiv)
.setName(t("settings_password"))
.setDesc(t("settings_password_desc"))
.addText((text) => {
wrapTextWithPasswordHide(text);
text
.setPlaceholder("")
.setValue(`${this.plugin.settings.password}`)
.onChange(async (value) => {
newPassword = value.trim();
});
})
.addButton(async (button) => {
button.setButtonText(t("confirm"));
button.onClick(async () => {
new PasswordModal(this.app, this.plugin, newPassword).open();
});
});
const scheduleDiv = generalDiv.createEl("div");
new Setting(scheduleDiv)
.setName(t("settings_autorun"))
.setDesc(t("settings_autorun_desc"))
.addDropdown((dropdown) => {
dropdown.addOption("-1", t("settings_autorun_notset"));
dropdown.addOption(`${1000 * 60 * 1}`, t("settings_autorun_1min"));
dropdown.addOption(`${1000 * 60 * 5}`, t("settings_autorun_5min"));
dropdown.addOption(`${1000 * 60 * 10}`, t("settings_autorun_10min"));
dropdown.addOption(`${1000 * 60 * 30}`, t("settings_autorun_30min"));
dropdown
.setValue(`${this.plugin.settings.autoRunEveryMilliseconds}`)
.onChange(async (val: string) => {
const realVal = parseInt(val);
this.plugin.settings.autoRunEveryMilliseconds = realVal;
await this.plugin.saveSettings();
if (
(realVal === undefined || realVal === null || realVal <= 0) &&
this.plugin.autoRunIntervalID !== undefined
) {
// clear
window.clearInterval(this.plugin.autoRunIntervalID);
this.plugin.autoRunIntervalID = undefined;
} else if (
realVal !== undefined &&
realVal !== null &&
realVal > 0
) {
const intervalID = window.setInterval(() => {
this.plugin.syncRun("auto");
}, realVal);
this.plugin.autoRunIntervalID = intervalID;
this.plugin.registerInterval(intervalID);
}
});
});
const runOnceStartUpDiv = generalDiv.createEl("div");
new Setting(runOnceStartUpDiv)
.setName(t("settings_runoncestartup"))
.setDesc(t("settings_runoncestartup_desc"))
.addDropdown((dropdown) => {
dropdown.addOption("-1", t("settings_runoncestartup_notset"));
dropdown.addOption(
`${1000 * 10 * 1}`,
t("settings_runoncestartup_10sec")
);
dropdown.addOption(
`${1000 * 30 * 1}`,
t("settings_runoncestartup_30sec")
);
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 service chooser (part 1/2)
//////////////////////////////////////////////////
// we need to create the div in advance of any other service divs
const serviceChooserDiv = generalDiv.createEl("div");
const serviceChooserDiv = containerEl.createDiv();
serviceChooserDiv.createEl("h2", { text: t("settings_chooseservice") });
//////////////////////////////////////////////////
// below for s3
@@ -777,27 +690,29 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
s3Div.toggleClass("s3-hide", this.plugin.settings.serviceType !== "s3");
s3Div.createEl("h2", { text: t("settings_s3") });
const s3LongDescDiv = s3Div.createEl("div", { cls: "settings-long-desc" });
for (const c of [
t("settings_s3_disclaimer1"),
t("settings_s3_disclaimer2"),
]) {
s3Div.createEl("p", {
s3LongDescDiv.createEl("p", {
text: c,
cls: "s3-disclaimer",
});
}
if (!VALID_REQURL) {
s3Div.createEl("p", {
s3LongDescDiv.createEl("p", {
text: t("settings_s3_cors"),
});
}
s3Div.createEl("p", {
s3LongDescDiv.createEl("p", {
text: t("settings_s3_prod"),
});
const s3LinksUl = s3Div.createEl("div").createEl("ul");
const s3LinksUl = s3LongDescDiv.createEl("ul");
s3LinksUl.createEl("li").createEl("a", {
href: "https://docs.aws.amazon.com/general/latest/gr/s3.html",
@@ -930,8 +845,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
});
}
const partsConcurrencyDiv = s3Div.createEl("div");
new Setting(partsConcurrencyDiv)
new Setting(s3Div)
.setName(t("settings_s3_parts"))
.setDesc(t("settings_s3_parts_desc"))
.addDropdown((dropdown) => {
@@ -983,16 +897,20 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
this.plugin.settings.serviceType !== "dropbox"
);
dropboxDiv.createEl("h2", { text: t("settings_dropbox") });
const dropboxLongDescDiv = dropboxDiv.createEl("div", {
cls: "settings-long-desc",
});
for (const c of [
t("settings_dropbox_disclaimer1"),
t("settings_dropbox_disclaimer2"),
]) {
dropboxDiv.createEl("p", {
dropboxLongDescDiv.createEl("p", {
text: c,
cls: "dropbox-disclaimer",
});
}
dropboxDiv.createEl("p", {
dropboxLongDescDiv.createEl("p", {
text: t("settings_dropbox_folder", {
pluginID: this.plugin.manifest.id,
remoteBaseDir:
@@ -1003,10 +921,10 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
const dropboxSelectAuthDiv = dropboxDiv.createDiv();
const dropboxAuthDiv = dropboxSelectAuthDiv.createDiv({
cls: "dropbox-auth-button-hide",
cls: "dropbox-auth-button-hide settings-auth-related",
});
const dropboxRevokeAuthDiv = dropboxSelectAuthDiv.createDiv({
cls: "dropbox-revoke-auth-button-hide",
cls: "dropbox-revoke-auth-button-hide settings-auth-related",
});
const dropboxRevokeAuthSetting = new Setting(dropboxRevokeAuthDiv)
@@ -1169,17 +1087,20 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
this.plugin.settings.serviceType !== "onedrive"
);
onedriveDiv.createEl("h2", { text: t("settings_onedrive") });
const onedriveLongDescDiv = onedriveDiv.createEl("div", {
cls: "settings-long-desc",
});
for (const c of [
t("settings_onedrive_disclaimer1"),
t("settings_onedrive_disclaimer2"),
]) {
onedriveDiv.createEl("p", {
onedriveLongDescDiv.createEl("p", {
text: c,
cls: "onedrive-disclaimer",
});
}
onedriveDiv.createEl("p", {
onedriveLongDescDiv.createEl("p", {
text: t("settings_onedrive_folder", {
pluginID: this.plugin.manifest.id,
remoteBaseDir:
@@ -1188,16 +1109,16 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
}),
});
onedriveDiv.createEl("p", {
onedriveLongDescDiv.createEl("p", {
text: t("settings_onedrive_nobiz"),
});
const onedriveSelectAuthDiv = onedriveDiv.createDiv();
const onedriveAuthDiv = onedriveSelectAuthDiv.createDiv({
cls: "onedrive-auth-button-hide",
cls: "onedrive-auth-button-hide settings-auth-related",
});
const onedriveRevokeAuthDiv = onedriveSelectAuthDiv.createDiv({
cls: "onedrive-revoke-auth-button-hide",
cls: "onedrive-revoke-auth-button-hide settings-auth-related",
});
const onedriveRevokeAuthSetting = new Setting(onedriveRevokeAuthDiv)
@@ -1317,22 +1238,26 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
webdavDiv.createEl("h2", { text: t("settings_webdav") });
webdavDiv.createEl("p", {
const webdavLongDescDiv = webdavDiv.createEl("div", {
cls: "settings-long-desc",
});
webdavLongDescDiv.createEl("p", {
text: t("settings_webdav_disclaimer1"),
cls: "webdav-disclaimer",
});
if (!VALID_REQURL) {
webdavDiv.createEl("p", {
webdavLongDescDiv.createEl("p", {
text: t("settings_webdav_cors_os"),
});
webdavDiv.createEl("p", {
webdavLongDescDiv.createEl("p", {
text: t("settings_webdav_cors"),
});
}
webdavDiv.createEl("p", {
webdavLongDescDiv.createEl("p", {
text: t("settings_webdav_folder", {
remoteBaseDir:
this.plugin.settings.webdav.remoteBaseDir || this.app.vault.getName(),
@@ -1564,6 +1489,130 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
});
});
//////////////////////////////////////////////////
// below for basic settings
//////////////////////////////////////////////////
const basicDiv = containerEl.createEl("div");
basicDiv.createEl("h2", { text: t("settings_basic") });
let newPassword = `${this.plugin.settings.password}`;
new Setting(basicDiv)
.setName(t("settings_password"))
.setDesc(t("settings_password_desc"))
.addText((text) => {
wrapTextWithPasswordHide(text);
text
.setPlaceholder("")
.setValue(`${this.plugin.settings.password}`)
.onChange(async (value) => {
newPassword = value.trim();
});
})
.addButton(async (button) => {
button.setButtonText(t("confirm"));
button.onClick(async () => {
new PasswordModal(this.app, this.plugin, newPassword).open();
});
});
new Setting(basicDiv)
.setName(t("settings_autorun"))
.setDesc(t("settings_autorun_desc"))
.addDropdown((dropdown) => {
dropdown.addOption("-1", t("settings_autorun_notset"));
dropdown.addOption(`${1000 * 60 * 1}`, t("settings_autorun_1min"));
dropdown.addOption(`${1000 * 60 * 5}`, t("settings_autorun_5min"));
dropdown.addOption(`${1000 * 60 * 10}`, t("settings_autorun_10min"));
dropdown.addOption(`${1000 * 60 * 30}`, t("settings_autorun_30min"));
dropdown
.setValue(`${this.plugin.settings.autoRunEveryMilliseconds}`)
.onChange(async (val: string) => {
const realVal = parseInt(val);
this.plugin.settings.autoRunEveryMilliseconds = realVal;
await this.plugin.saveSettings();
if (
(realVal === undefined || realVal === null || realVal <= 0) &&
this.plugin.autoRunIntervalID !== undefined
) {
// clear
window.clearInterval(this.plugin.autoRunIntervalID);
this.plugin.autoRunIntervalID = undefined;
} else if (
realVal !== undefined &&
realVal !== null &&
realVal > 0
) {
const intervalID = window.setInterval(() => {
this.plugin.syncRun("auto");
}, realVal);
this.plugin.autoRunIntervalID = intervalID;
this.plugin.registerInterval(intervalID);
}
});
});
new Setting(basicDiv)
.setName(t("settings_runoncestartup"))
.setDesc(t("settings_runoncestartup_desc"))
.addDropdown((dropdown) => {
dropdown.addOption("-1", t("settings_runoncestartup_notset"));
dropdown.addOption(
`${1000 * 1 * 1}`,
t("settings_runoncestartup_1sec")
);
dropdown.addOption(
`${1000 * 10 * 1}`,
t("settings_runoncestartup_10sec")
);
dropdown.addOption(
`${1000 * 30 * 1}`,
t("settings_runoncestartup_30sec")
);
dropdown
.setValue(`${this.plugin.settings.initRunAfterMilliseconds}`)
.onChange(async (val: string) => {
const realVal = parseInt(val);
this.plugin.settings.initRunAfterMilliseconds = realVal;
await this.plugin.saveSettings();
});
});
new Setting(basicDiv)
.setName(t("settings_skiplargefiles"))
.setDesc(t("settings_skiplargefiles_desc"))
.addDropdown((dropdown) => {
dropdown.addOption("-1", t("settings_skiplargefiles_notset"));
const mbs = [1, 5, 10, 50, 100, 500, 1000];
for (const mb of mbs) {
dropdown.addOption(`${mb * 1000 * 1000}`, `${mb} MB`);
}
dropdown
.setValue(`${this.plugin.settings.skipSizeLargerThan}`)
.onChange(async (val) => {
this.plugin.settings.skipSizeLargerThan = parseInt(val);
await this.plugin.saveSettings();
});
});
new Setting(basicDiv)
.setName(t("settings_ignorepaths"))
.setDesc(t("settings_ignorepaths_desc"))
.setClass("ignorepaths-settings")
.addTextArea((textArea) => {
textArea
.setValue(`${this.plugin.settings.ignorePaths.join("\n")}`)
.onChange(async (value) => {
this.plugin.settings.ignorePaths = value.trim().split("\n");
await this.plugin.saveSettings();
});
textArea.inputEl.rows = 10;
textArea.inputEl.addClass("ignorepaths-textarea");
});
//////////////////////////////////////////////////
// below for advanced settings
//////////////////////////////////////////////////
@@ -1572,8 +1621,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
text: t("settings_adv"),
});
const concurrencyDiv = advDiv.createEl("div");
new Setting(concurrencyDiv)
new Setting(advDiv)
.setName(t("settings_concurrency"))
.setDesc(t("settings_concurrency_desc"))
.addDropdown((dropdown) => {
@@ -1594,8 +1642,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
});
});
const syncUnderscoreItemsDiv = advDiv.createEl("div");
new Setting(syncUnderscoreItemsDiv)
new Setting(advDiv)
.setName(t("settings_syncunderscore"))
.setDesc(t("settings_syncunderscore_desc"))
.addDropdown((dropdown) => {
@@ -1611,8 +1658,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
});
});
const syncConfigDirDiv = advDiv.createEl("div");
new Setting(syncConfigDirDiv)
new Setting(advDiv)
.setName(t("settings_configdir"))
.setDesc(
t("settings_configdir_desc", {
@@ -1676,8 +1722,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
const debugDiv = containerEl.createEl("div");
debugDiv.createEl("h2", { text: t("settings_debug") });
const setConsoleLogLevelDiv = debugDiv.createDiv("div");
new Setting(setConsoleLogLevelDiv)
new Setting(debugDiv)
.setName(t("settings_debuglevel"))
.setDesc(t("settings_debuglevel_desc"))
.addDropdown(async (dropdown) => {
@@ -1692,8 +1737,8 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
log.info(`the log level is changed to ${val}`);
});
});
const outputCurrSettingsDiv = debugDiv.createDiv("div");
new Setting(outputCurrSettingsDiv)
new Setting(debugDiv)
.setName(t("settings_outputsettingsconsole"))
.setDesc(t("settings_outputsettingsconsole_desc"))
.addButton(async (button) => {
@@ -1704,8 +1749,8 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
new Notice(t("settings_outputsettingsconsole_notice"));
});
});
const syncPlanDiv = debugDiv.createEl("div");
new Setting(syncPlanDiv)
new Setting(debugDiv)
.setName(t("settings_syncplans"))
.setDesc(t("settings_syncplans_desc"))
.addButton(async (button) => {
@@ -1732,7 +1777,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
new Notice(t("settings_syncplans_notice"));
});
});
new Setting(syncPlanDiv)
new Setting(debugDiv)
.setName(t("settings_delsyncplans"))
.setDesc(t("settings_delsyncplans_desc"))
.addButton(async (button) => {
@@ -1743,8 +1788,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
});
});
const logToDBDiv = debugDiv.createEl("div");
new Setting(logToDBDiv)
new Setting(debugDiv)
.setName(t("settings_logtodb"))
.setDesc(t("settings_logtodb_desc"))
.addDropdown(async (dropdown) => {
@@ -1771,7 +1815,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
});
});
new Setting(logToDBDiv)
new Setting(debugDiv)
.setName(t("settings_logtodbexport"))
.setDesc(
t("settings_logtodbexport_desc", {
@@ -1790,7 +1834,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
});
});
new Setting(logToDBDiv)
new Setting(debugDiv)
.setName(t("settings_logtodbclear"))
.setDesc(t("settings_logtodbclear_desc"))
.addButton(async (button) => {
@@ -1801,8 +1845,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
});
});
const syncMappingDiv = debugDiv.createEl("div");
new Setting(syncMappingDiv)
new Setting(debugDiv)
.setName(t("settings_delsyncmap"))
.setDesc(t("settings_delsyncmap_desc"))
.addButton(async (button) => {
@@ -1813,8 +1856,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
});
});
const outputCurrBasePathVaultIDDiv = debugDiv.createDiv("div");
new Setting(outputCurrBasePathVaultIDDiv)
new Setting(debugDiv)
.setName(t("settings_outputbasepathvaultid"))
.setDesc(t("settings_outputbasepathvaultid_desc"))
.addButton(async (button) => {
@@ -1825,8 +1867,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
});
});
const dbsResetDiv = debugDiv.createEl("div");
new Setting(dbsResetDiv)
new Setting(debugDiv)
.setName(t("settings_resetcache"))
.setDesc(t("settings_resetcache_desc"))
.addButton(async (button) => {
+333 -30
View File
@@ -7,17 +7,20 @@ import {
} from "obsidian";
import AggregateError from "aggregate-error";
import PQueue from "p-queue";
import {
import XRegExp from "xregexp";
import type {
RemoteItem,
SUPPORTED_SERVICES_TYPE,
SyncTriggerSourceType,
DecisionType,
FileOrFolderMixedState,
API_VER_STAT_FOLDER,
SUPPORTED_SERVICES_TYPE,
} from "./baseTypes";
import { API_VER_STAT_FOLDER } from "./baseTypes";
import {
decryptBase32ToString,
decryptBase64urlToString,
encryptStringToBase64url,
getSizeFromOrigToEnc,
MAGIC_ENCRYPTED_PREFIX_BASE32,
MAGIC_ENCRYPTED_PREFIX_BASE64URL,
} from "./encrypt";
@@ -35,6 +38,7 @@ import {
getParentFolder,
atWhichLevel,
unixTimeToStr,
statFix,
} from "./misc";
import { RemoteClient } from "./remote";
import {
@@ -65,6 +69,7 @@ export type SyncStatusType =
export interface SyncPlanType {
ts: number;
tsFmt?: string;
syncTriggerSource?: SyncTriggerSourceType;
remoteType: SUPPORTED_SERVICES_TYPE;
mixedStates: Record<string, FileOrFolderMixedState>;
}
@@ -215,22 +220,29 @@ export const parseRemoteItems = async (
if (backwardMapping !== undefined) {
key = backwardMapping.localKey;
const mtimeRemote = backwardMapping.localMtime || entry.lastModified;
// the backwardMapping.localSize is the file BEFORE encryption
// we want to split two sizes for comparation later
r = {
key: key,
existRemote: true,
mtimeRemote: mtimeRemote,
mtimeRemoteFmt: unixTimeToStr(mtimeRemote),
sizeRemote: backwardMapping.localSize || entry.size,
sizeRemote: backwardMapping.localSize,
sizeRemoteEnc: password === "" ? undefined : entry.size,
remoteEncryptedKey: remoteEncryptedKey,
changeRemoteMtimeUsingMapping: true,
};
} else {
// do not have backwardMapping
r = {
key: key,
existRemote: true,
mtimeRemote: entry.lastModified,
mtimeRemoteFmt: unixTimeToStr(entry.lastModified),
sizeRemote: entry.size,
sizeRemote: password === "" ? entry.size : undefined,
sizeRemoteEnc: password === "" ? undefined : entry.size,
remoteEncryptedKey: remoteEncryptedKey,
changeRemoteMtimeUsingMapping: false,
};
@@ -282,8 +294,16 @@ const isSkipItem = (
key: string,
syncConfigDir: boolean,
syncUnderscoreItems: boolean,
configDir: string
configDir: string,
ignorePaths: string[]
) => {
if (ignorePaths !== undefined && ignorePaths.length > 0) {
for (const r of ignorePaths) {
if (XRegExp(r, "A").test(key)) {
return true;
}
}
}
if (syncConfigDir && isInsideObsFolder(key, configDir)) {
return false;
}
@@ -303,14 +323,24 @@ const ensembleMixedStates = async (
localFileHistory: FileFolderHistoryRecord[],
syncConfigDir: boolean,
configDir: string,
syncUnderscoreItems: boolean
syncUnderscoreItems: boolean,
ignorePaths: string[],
password: string
) => {
const results = {} as Record<string, FileOrFolderMixedState>;
for (const r of remoteStates) {
const key = r.key;
if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
if (
isSkipItem(
key,
syncConfigDir,
syncUnderscoreItems,
configDir,
ignorePaths
)
) {
continue;
}
results[key] = r;
@@ -325,13 +355,15 @@ const ensembleMixedStates = async (
// ignore
continue;
} else if (entry instanceof TFile) {
const mtimeLocal = Math.max(entry.stat.mtime || 0, entry.stat.ctime || 0);
const mtimeLocal = Math.max(entry.stat.mtime ?? 0, entry.stat.ctime ?? 0);
r = {
key: entry.path,
existLocal: true,
mtimeLocal: mtimeLocal,
mtimeLocalFmt: unixTimeToStr(mtimeLocal),
sizeLocal: entry.stat.size,
sizeLocalEnc:
password === "" ? undefined : getSizeFromOrigToEnc(entry.stat.size),
};
} else if (entry instanceof TFolder) {
key = `${entry.path}/`;
@@ -341,12 +373,21 @@ const ensembleMixedStates = async (
mtimeLocal: undefined,
mtimeLocalFmt: undefined,
sizeLocal: 0,
sizeLocalEnc: password === "" ? undefined : getSizeFromOrigToEnc(0),
};
} else {
throw Error(`unexpected ${entry}`);
}
if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
if (
isSkipItem(
key,
syncConfigDir,
syncUnderscoreItems,
configDir,
ignorePaths
)
) {
continue;
}
@@ -356,6 +397,7 @@ const ensembleMixedStates = async (
results[key].mtimeLocal = r.mtimeLocal;
results[key].mtimeLocalFmt = r.mtimeLocalFmt;
results[key].sizeLocal = r.sizeLocal;
results[key].sizeLocalEnc = r.sizeLocalEnc;
} else {
results[key] = r;
results[key].existRemote = false;
@@ -365,21 +407,39 @@ const ensembleMixedStates = async (
if (syncConfigDir && localConfigDirContents !== undefined) {
for (const entry of localConfigDirContents) {
const key = entry.key;
const mtimeLocal = Math.max(entry.mtime, entry.ctime);
let mtimeLocal = Math.max(entry.mtime ?? 0, entry.ctime ?? 0);
if (Number.isNaN(mtimeLocal) || mtimeLocal === 0) {
mtimeLocal = undefined;
}
const r: FileOrFolderMixedState = {
key: key,
existLocal: true,
mtimeLocal: mtimeLocal,
mtimeLocalFmt: unixTimeToStr(mtimeLocal),
sizeLocal: entry.size,
sizeLocalEnc:
password === "" ? undefined : getSizeFromOrigToEnc(entry.size),
};
if (
isSkipItem(
key,
syncConfigDir,
syncUnderscoreItems,
configDir,
ignorePaths
)
) {
continue;
}
if (results.hasOwnProperty(key)) {
results[key].key = r.key;
results[key].existLocal = r.existLocal;
results[key].mtimeLocal = r.mtimeLocal;
results[key].mtimeLocalFmt = r.mtimeLocalFmt;
results[key].sizeLocal = r.sizeLocal;
results[key].sizeLocalEnc = r.sizeLocalEnc;
} else {
results[key] = r;
results[key].existRemote = false;
@@ -395,7 +455,15 @@ const ensembleMixedStates = async (
deltimeRemoteFmt: unixTimeToStr(entry.actionWhen),
} as FileOrFolderMixedState;
if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
if (
isSkipItem(
key,
syncConfigDir,
syncUnderscoreItems,
configDir,
ignorePaths
)
) {
continue;
}
@@ -423,7 +491,15 @@ const ensembleMixedStates = async (
throw Error(`unexpected ${entry}`);
}
if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
if (
isSkipItem(
key,
syncConfigDir,
syncUnderscoreItems,
configDir,
ignorePaths
)
) {
continue;
}
@@ -450,10 +526,13 @@ const ensembleMixedStates = async (
changeLocalMtimeUsingMapping: true,
};
if (results.hasOwnProperty(key)) {
const mtimeLocal = Math.max(
r.mtimeLocal || 0,
results[key].mtimeLocal || 0
let mtimeLocal = Math.max(
r.mtimeLocal ?? 0,
results[key].mtimeLocal ?? 0
);
if (Number.isNaN(mtimeLocal) || mtimeLocal === 0) {
mtimeLocal = undefined;
}
results[key].mtimeLocal = mtimeLocal;
results[key].mtimeLocalFmt = unixTimeToStr(mtimeLocal);
results[key].changeLocalMtimeUsingMapping =
@@ -482,6 +561,7 @@ const ensembleMixedStates = async (
const assignOperationToFileInplace = (
origRecord: FileOrFolderMixedState,
keptFolder: Set<string>,
skipSizeLargerThan: number,
password: string = ""
) => {
let r = origRecord;
@@ -524,6 +604,18 @@ const assignOperationToFileInplace = (
);
}
if (
(r.existLocal && password !== "" && r.sizeLocalEnc === undefined) ||
(r.existRemote && password !== "" && r.sizeRemoteEnc === undefined)
) {
throw new Error(
`Error: No encryption sizes: ${JSON.stringify(r, null, 2)}`
);
}
const sizeLocalComp = password === "" ? r.sizeLocal : r.sizeLocalEnc;
const sizeRemoteComp = password === "" ? r.sizeRemote : r.sizeRemoteEnc;
// 1. mtimeLocal
if (r.existLocal) {
const mtimeRemote = r.existRemote ? r.mtimeRemote : -1;
@@ -534,26 +626,79 @@ const assignOperationToFileInplace = (
r.mtimeLocal >= deltimeLocal &&
r.mtimeLocal >= deltimeRemote
) {
if (sizeLocalComp === undefined) {
throw new Error(
`Error: no local size but has local mtime: ${JSON.stringify(
r,
null,
2
)}`
);
}
if (r.mtimeLocal === r.mtimeRemote) {
// mtime the same
if (password === "") {
// no password, we can also compare the sizes!
if (r.sizeLocal === r.sizeRemote) {
// local and remote both exist and mtimes are the same
if (sizeLocalComp === sizeRemoteComp) {
// do not need to consider skipSizeLargerThan in this case
r.decision = "skipUploading";
r.decisionBranch = 1;
} else {
if (skipSizeLargerThan <= 0) {
r.decision = "uploadLocalToRemote";
r.decisionBranch = 2;
} else {
// limit the sizes
if (sizeLocalComp <= skipSizeLargerThan) {
if (sizeRemoteComp <= skipSizeLargerThan) {
r.decision = "uploadLocalToRemote";
r.decisionBranch = 18;
} else {
r.decision = "errorRemoteTooLargeConflictLocal";
r.decisionBranch = 19;
}
} else {
// we have password, then the sizes are always unequal
// we can only rely on mtime
r.decision = "skipUploading";
r.decisionBranch = 3;
if (sizeRemoteComp <= skipSizeLargerThan) {
r.decision = "errorLocalTooLargeConflictRemote";
r.decisionBranch = 20;
} else {
r.decision = "skipUploadingTooLarge";
r.decisionBranch = 21;
}
}
}
}
} else {
// we have local laregest mtime,
// and the remote not existing or smaller mtime
if (skipSizeLargerThan <= 0) {
// no need to consider sizes
r.decision = "uploadLocalToRemote";
r.decisionBranch = 4;
} else {
// need to consider sizes
if (sizeLocalComp <= skipSizeLargerThan) {
if (sizeRemoteComp === undefined) {
r.decision = "uploadLocalToRemote";
r.decisionBranch = 22;
} else if (sizeRemoteComp <= skipSizeLargerThan) {
r.decision = "uploadLocalToRemote";
r.decisionBranch = 23;
} else {
r.decision = "errorRemoteTooLargeConflictLocal";
r.decisionBranch = 24;
}
} else {
if (sizeRemoteComp === undefined) {
r.decision = "skipUploadingTooLarge";
r.decisionBranch = 25;
} else if (sizeRemoteComp <= skipSizeLargerThan) {
r.decision = "errorLocalTooLargeConflictRemote";
r.decisionBranch = 26;
} else {
r.decision = "skipUploadingTooLarge";
r.decisionBranch = 27;
}
}
}
}
keptFolder.add(getParentFolder(r.key));
return r;
@@ -570,8 +715,49 @@ const assignOperationToFileInplace = (
r.mtimeRemote >= deltimeLocal &&
r.mtimeRemote >= deltimeRemote
) {
// we have remote laregest mtime,
// and the local not existing or smaller mtime
if (sizeRemoteComp === undefined) {
throw new Error(
`Error: no remote size but has remote mtime: ${JSON.stringify(
r,
null,
2
)}`
);
}
if (skipSizeLargerThan <= 0) {
// no need to consider sizes
r.decision = "downloadRemoteToLocal";
r.decisionBranch = 5;
} else {
// need to consider sizes
if (sizeRemoteComp <= skipSizeLargerThan) {
if (sizeLocalComp === undefined) {
r.decision = "downloadRemoteToLocal";
r.decisionBranch = 28;
} else if (sizeLocalComp <= skipSizeLargerThan) {
r.decision = "downloadRemoteToLocal";
r.decisionBranch = 29;
} else {
r.decision = "errorLocalTooLargeConflictRemote";
r.decisionBranch = 30;
}
} else {
if (sizeLocalComp === undefined) {
r.decision = "skipDownloadingTooLarge";
r.decisionBranch = 31;
} else if (sizeLocalComp <= skipSizeLargerThan) {
r.decision = "errorRemoteTooLargeConflictLocal";
r.decisionBranch = 32;
} else {
r.decision = "skipDownloadingTooLarge";
r.decisionBranch = 33;
}
}
}
keptFolder.add(getParentFolder(r.key));
return r;
}
@@ -587,11 +773,45 @@ const assignOperationToFileInplace = (
r.deltimeLocal >= mtimeRemote &&
r.deltimeLocal >= deltimeRemote
) {
if (skipSizeLargerThan <= 0) {
r.decision = "uploadLocalDelHistToRemote";
r.decisionBranch = 6;
if (r.existLocal || r.existRemote) {
// actual deletion would happen
}
} else {
const localTooLargeToDelete =
r.existLocal && sizeLocalComp > skipSizeLargerThan;
const remoteTooLargeToDelete =
r.existRemote && sizeRemoteComp > skipSizeLargerThan;
if (localTooLargeToDelete) {
if (remoteTooLargeToDelete) {
r.decision = "skipUsingLocalDelTooLarge";
r.decisionBranch = 34;
} else {
if (r.existRemote) {
r.decision = "errorLocalTooLargeConflictRemote";
r.decisionBranch = 35;
} else {
r.decision = "skipUsingLocalDelTooLarge";
r.decisionBranch = 36;
}
}
} else {
if (remoteTooLargeToDelete) {
if (r.existLocal) {
r.decision = "errorLocalTooLargeConflictRemote";
r.decisionBranch = 37;
} else {
r.decision = "skipUsingLocalDelTooLarge";
r.decisionBranch = 38;
}
} else {
r.decision = "uploadLocalDelHistToRemote";
r.decisionBranch = 39;
}
}
}
return r;
}
}
@@ -606,11 +826,45 @@ const assignOperationToFileInplace = (
r.deltimeRemote >= mtimeRemote &&
r.deltimeRemote >= deltimeLocal
) {
if (skipSizeLargerThan <= 0) {
r.decision = "keepRemoteDelHist";
r.decisionBranch = 7;
if (r.existLocal || r.existRemote) {
// actual deletion would happen
}
} else {
const localTooLargeToDelete =
r.existLocal && sizeLocalComp > skipSizeLargerThan;
const remoteTooLargeToDelete =
r.existRemote && sizeRemoteComp > skipSizeLargerThan;
if (localTooLargeToDelete) {
if (remoteTooLargeToDelete) {
r.decision = "skipUsingRemoteDelTooLarge";
r.decisionBranch = 40;
} else {
if (r.existRemote) {
r.decision = "errorLocalTooLargeConflictRemote";
r.decisionBranch = 41;
} else {
r.decision = "skipUsingRemoteDelTooLarge";
r.decisionBranch = 42;
}
}
} else {
if (remoteTooLargeToDelete) {
if (r.existLocal) {
r.decision = "errorLocalTooLargeConflictRemote";
r.decisionBranch = 43;
} else {
r.decision = "skipUsingRemoteDelTooLarge";
r.decisionBranch = 44;
}
} else {
r.decision = "keepRemoteDelHist";
r.decisionBranch = 45;
}
}
}
return r;
}
}
@@ -645,9 +899,14 @@ const assignOperationToFolderInplace = async (
// if it was created after deletion, we should keep it as is
if (requireApiVersion(API_VER_STAT_FOLDER)) {
if (r.existLocal) {
const { ctime, mtime } = await vault.adapter.stat(r.key);
const cmtime = Math.max(ctime, mtime);
if (cmtime > 0 && cmtime >= deltimeLocal && cmtime >= deltimeRemote) {
const { ctime, mtime } = await statFix(vault, r.key);
const cmtime = Math.max(ctime ?? 0, mtime ?? 0);
if (
!Number.isNaN(cmtime) &&
cmtime > 0 &&
cmtime >= deltimeLocal &&
cmtime >= deltimeRemote
) {
keptFolder.add(getParentFolder(r.key));
if (r.existLocal && r.existRemote) {
r.decision = "skipFolder";
@@ -744,6 +1003,10 @@ const DELETION_DECISIONS: Set<DecisionType> = new Set([
"uploadLocalDelHistToRemoteFolder",
"keepRemoteDelHistFolder",
]);
const SIZES_GO_WRONG_DECISIONS: Set<DecisionType> = new Set([
"errorLocalTooLargeConflictRemote",
"errorRemoteTooLargeConflictLocal",
]);
export const getSyncPlan = async (
remoteStates: FileOrFolderMixedState[],
@@ -752,10 +1015,13 @@ export const getSyncPlan = async (
remoteDeleteHistory: DeletionOnRemote[],
localFileHistory: FileFolderHistoryRecord[],
remoteType: SUPPORTED_SERVICES_TYPE,
triggerSource: SyncTriggerSourceType,
vault: Vault,
syncConfigDir: boolean,
configDir: string,
syncUnderscoreItems: boolean,
skipSizeLargerThan: number,
ignorePaths: string[],
password: string = ""
) => {
const mixedStates = await ensembleMixedStates(
@@ -766,13 +1032,16 @@ export const getSyncPlan = async (
localFileHistory,
syncConfigDir,
configDir,
syncUnderscoreItems
syncUnderscoreItems,
ignorePaths,
password
);
const sortedKeys = Object.keys(mixedStates).sort(
(k1, k2) => k2.length - k1.length
);
const sizesGoWrong: FileOrFolderMixedState[] = [];
const deletions: DeletionOnRemote[] = [];
const keptFolder = new Set<string>();
@@ -788,7 +1057,16 @@ export const getSyncPlan = async (
} else {
// get all operations of files
// and at the same time get some helper info for folders
assignOperationToFileInplace(val, keptFolder, password);
assignOperationToFileInplace(
val,
keptFolder,
skipSizeLargerThan,
password
);
}
if (SIZES_GO_WRONG_DECISIONS.has(val.decision)) {
sizesGoWrong.push(val);
}
if (DELETION_DECISIONS.has(val.decision)) {
@@ -824,12 +1102,14 @@ export const getSyncPlan = async (
ts: currTs,
tsFmt: currTsFmt,
remoteType: remoteType,
syncTriggerSource: triggerSource,
mixedStates: mixedStates,
} as SyncPlanType;
return {
plan: plan,
sortedKeys: sortedKeys,
deletions: deletions,
sizesGoWrong: sizesGoWrong,
};
};
@@ -1011,6 +1291,14 @@ const dispatchOperationToActual = async (
await clearDeleteRenameHistoryOfKeyAndVault(db, r.key, vaultRandomID);
} else if (r.decision === "skipFolder") {
// do nothing!
} else if (r.decision === "skipUploadingTooLarge") {
// do nothing!
} else if (r.decision === "skipDownloadingTooLarge") {
// do nothing!
} else if (r.decision === "skipUsingLocalDelTooLarge") {
// do nothing!
} else if (r.decision === "skipUsingRemoteDelTooLarge") {
// do nothing!
} else {
throw Error(`unknown decision in ${JSON.stringify(r)}`);
}
@@ -1029,7 +1317,14 @@ const splitThreeSteps = (syncPlan: SyncPlanType, sortedKeys: string[]) => {
const key = sortedKeys[i];
const val: FileOrFolderMixedState = Object.assign({}, mixedStates[key]); // copy to avoid issue
if (val.decision === "skipFolder" || val.decision === "skipUploading") {
if (
val.decision === "skipFolder" ||
val.decision === "skipUploading" ||
val.decision === "skipDownloadingTooLarge" ||
val.decision === "skipUploadingTooLarge" ||
val.decision === "skipUsingLocalDelTooLarge" ||
val.decision === "skipUsingRemoteDelTooLarge"
) {
// pass
} else if (val.decision === "createFolder") {
const level = atWhichLevel(key);
@@ -1089,15 +1384,23 @@ export const doActualSync = async (
sortedKeys: string[],
metadataFile: FileOrFolderMixedState,
origMetadata: MetadataOnRemote,
sizesGoWrong: FileOrFolderMixedState[],
deletions: DeletionOnRemote[],
localDeleteFunc: any,
password: string = "",
concurrency: number = 1,
callbackSizesGoWrong?: any,
callbackSyncProcess?: any
) => {
const mixedStates = syncPlan.mixedStates;
const totalCount = sortedKeys.length || 0;
if (sizesGoWrong.length > 0) {
log.debug(`some sizes are larger than the threshold, abort and show hints`);
callbackSizesGoWrong(sizesGoWrong);
return;
}
log.debug(`start syncing extra data firstly`);
await uploadExtraMeta(
client,
+90
View File
@@ -0,0 +1,90 @@
import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
import type RemotelySavePlugin from "./main"; // unavoidable
import type { TransItemType } from "./i18n";
import type { FileOrFolderMixedState } from "./baseTypes";
import { log } from "./moreOnLog";
export class SizesConflictModal extends Modal {
readonly plugin: RemotelySavePlugin;
readonly skipSizeLargerThan: number;
readonly sizesGoWrong: FileOrFolderMixedState[];
readonly hasPassword: boolean;
constructor(
app: App,
plugin: RemotelySavePlugin,
skipSizeLargerThan: number,
sizesGoWrong: FileOrFolderMixedState[],
hasPassword: boolean
) {
super(app);
this.plugin = plugin;
this.skipSizeLargerThan = skipSizeLargerThan;
this.sizesGoWrong = sizesGoWrong;
this.hasPassword = hasPassword;
}
onOpen() {
let { contentEl } = this;
const t = (x: TransItemType, vars?: any) => {
return this.plugin.i18n.t(x, vars);
};
contentEl.createEl("h2", {
text: t("modal_sizesconflict_title"),
});
t("modal_sizesconflict_desc", {
thresholdMB: `${this.skipSizeLargerThan / 1000 / 1000}`,
thresholdBytes: `${this.skipSizeLargerThan}`,
})
.split("\n")
.forEach((val) => {
contentEl.createEl("p", { text: val });
});
const info = this.serialize();
contentEl.createDiv().createEl(
"button",
{
text: t("modal_sizesconflict_copybutton"),
},
(el) => {
el.onclick = async () => {
await navigator.clipboard.writeText(info);
new Notice(t("modal_sizesconflict_copynotice"));
};
}
);
contentEl.createEl("pre", {
text: info,
});
}
serialize() {
return this.sizesGoWrong
.map((x) => {
return [
x.key,
this.hasPassword
? `encrypted name: ${x.remoteEncryptedKey}`
: undefined,
`local ${this.hasPassword ? "encrypted " : ""}bytes: ${
this.hasPassword ? x.sizeLocalEnc : x.sizeLocal
}`,
`remote ${this.hasPassword ? "encrypted " : ""}bytes: ${
this.hasPassword ? x.sizeRemoteEnc : x.sizeRemote
}`,
]
.filter((tmp) => tmp !== undefined)
.join("\n");
})
.join("\n\n");
}
onClose() {
let { contentEl } = this;
contentEl.empty();
}
}
+9
View File
@@ -8,6 +8,11 @@
font-weight: bold;
}
.settings-auth-related {
border-top: 1px solid var(--background-modifier-border);
padding-top: 18px;
}
.s3-disclaimer {
font-weight: bold;
}
@@ -56,3 +61,7 @@
width: 350px;
height: 350px;
}
.ignorepaths-textarea {
font-family: monospace;
}
+23 -1
View File
@@ -29,6 +29,14 @@ describe("Encryption tests", () => {
expect(await encryptStringToBase32(k, password)).to.not.equal(k);
});
it("should encrypt string and return different results each time", async () => {
const k = "dkjdhkfhdkjgsdklxxd";
const password = "hey";
const res1 = await encryptStringToBase32(k, password);
const res2 = await encryptStringToBase32(k, password);
expect(res1).to.not.equal(res2);
});
it("should raise error using different password", async () => {
const k = "secret text";
const password = "hey";
@@ -97,7 +105,21 @@ describe("Encryption tests", () => {
expect(Buffer.from(enc).equals(Buffer.from(opensslArrBuf))).to.be.true;
});
it("should descypt binary file and get the same result as openssl", async () => {
it("should encrypt binary file not deterministically", async () => {
const testFolder = path.join(__dirname, "static_assets", "mona_lisa");
const testFileName =
"1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg";
const fileArrBuf = bufferToArrayBuffer(
await fs.readFileSync(path.join(testFolder, testFileName))
);
const password = "somepassword";
const res1 = await encryptArrayBuffer(fileArrBuf, password);
const res2 = await encryptArrayBuffer(fileArrBuf, password);
expect(Buffer.from(res1).equals(Buffer.from(res2))).to.be.false;
});
it("should decrypt binary file and get the same result as openssl", async () => {
const testFolder = path.join(__dirname, "static_assets", "mona_lisa");
const testFileName =
"1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg";
+1 -1
View File
@@ -1,4 +1,4 @@
{
"0.3.2": "0.12.15",
"0.3.19": "0.13.21"
"0.3.25": "0.13.21"
}
+8
View File
@@ -41,6 +41,12 @@ module.exports = {
test: /\.svg?$/,
type: "asset/source",
},
{
test: /\.m?js$/,
resolve: {
fullySpecified: false, // process/browser returns some errors before
},
},
],
},
resolve: {
@@ -55,7 +61,9 @@ module.exports = {
// crypto: false,
// domain: require.resolve("domain-browser"),
// events: require.resolve("events"),
http: false,
// http: require.resolve("stream-http"),
https: false,
// https: require.resolve("https-browserify"),
net: false,
// os: require.resolve("os-browserify/browser"),