Compare commits

...
28 Commits
Author SHA1 Message Date
fyears 7f446b810c bump to 0.5.6
Release A New Version / build (16.x) (push) Failing after 42s
2024-06-16 19:50:28 +08:00
fyears 9b1a8f6068 push and pull add delete 2024-06-16 19:48:40 +08:00
Hammy Havoc 94350873a9 Update README.md (#707)
Fixed typos
2024-06-16 18:19:12 +08:00
fyears 1e6f59eb79 hide koofr for the moment 2024-06-15 23:09:31 +08:00
fyears a64b859e46 add koofr 2024-06-15 23:06:41 +08:00
fyears 689376adfe show enc method only if password is set 2024-06-15 16:21:13 +08:00
fyears 52d46b58d8 listen to rename 2024-06-15 16:09:07 +08:00
fyears 157eff3a61 let onedrive download happy with native fetch and no cache 2024-06-14 23:56:15 +08:00
fyears 5ed6fec6e9 fix pcloud bug 2024-06-14 01:26:14 +08:00
fyears e3c53860f7 box refresh token refreshes itself 2024-06-14 00:41:50 +08:00
fyears ce48f072cb add apache and nginx webdav 2024-06-14 00:28:03 +08:00
fyears d067937138 ignore special system files 2024-06-13 03:32:27 +08:00
Rafael Fernandes 60ff7e41bf Document Open Media Vault WebDAV setup (#694)
* Create README.md

Create documentation on how to add WebDAV access to Open Media Vault and use it on Remotely Save

* Update README.md

Add link to Open Media Vault WebDAV documentation.
2024-06-12 23:04:44 +08:00
fyears 9f67d41786 fix folder sync 2024-06-12 23:02:26 +08:00
fyears adacda7ee5 finally we know how to skip leading slash 2024-06-12 01:01:30 +08:00
fyears 356c563e95 polish 2024-06-12 00:43:06 +08:00
fyears d3e134ce73 add draft of keeping folder 2024-06-12 00:42:36 +08:00
fyears df0a0e2daa 0.5.5
Release A New Version / build (16.x) (push) Failing after 35s
2024-06-11 00:44:47 +08:00
fyears c9080dae4e yeah a fix for the sync 2024-06-11 00:44:19 +08:00
fyears 08b68e224d bump to 0.5.4
Release A New Version / build (16.x) (push) Failing after 51s
2024-06-11 00:11:52 +08:00
fyears 2e09686675 add yandex disk pro 2024-06-11 00:01:36 +08:00
fyears 5186dcb967 add tutorials for box and pcloud 2024-06-09 23:05:08 +08:00
fyears 24b839227a pcloud 2024-06-09 22:37:55 +08:00
fyears 12e45a7f38 box sdk 2024-06-09 16:09:21 +08:00
fyears d5c2f726f9 box 2024-06-09 13:37:55 +08:00
fyears 1e4d729eb7 make the wording explict 2024-06-02 23:50:54 +08:00
fyears 64371b7d65 bump to 0.5.3
Release A New Version / build (16.x) (push) Failing after 44s
2024-06-02 23:38:44 +08:00
fyears e116bb1deb google drive is usable now 2024-06-02 23:37:53 +08:00
69 changed files with 18000 additions and 243 deletions
+10
View File
@@ -3,3 +3,13 @@ ONEDRIVE_CLIENT_ID=
ONEDRIVE_AUTHORITY=https:// ONEDRIVE_AUTHORITY=https://
REMOTELYSAVE_WEBSITE=http://127.0.0.1:46683 REMOTELYSAVE_WEBSITE=http://127.0.0.1:46683
REMOTELYSAVE_CLIENT_ID=cli-xxx REMOTELYSAVE_CLIENT_ID=cli-xxx
GOOGLEDRIVE_CLIENT_ID=xxx.apps.googleusercontent.com
GOOGLEDRIVE_CLIENT_SECRET=GOCSPX-sss
BOX_CLIENT_ID=
BOX_CLIENT_SECRET=
PCLOUD_CLIENT_ID=
PCLOUD_CLIENT_SECRET=
YANDEXDISK_CLIENT_ID=
YANDEXDISK_CLIENT_SECRET=
KOOFR_CLIENT_ID=
KOOFR_CLIENT_SECRET=
+10
View File
@@ -21,6 +21,16 @@ jobs:
ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}} ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}} REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}}
REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}} REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}}
GOOGLEDRIVE_CLIENT_ID: ${{secrets.GOOGLEDRIVE_CLIENT_ID}}
GOOGLEDRIVE_CLIENT_SECRET: ${{secrets.GOOGLEDRIVE_CLIENT_SECRET}}
BOX_CLIENT_ID: ${{secrets.BOX_CLIENT_ID}}
BOX_CLIENT_SECRET: ${{secrets.BOX_CLIENT_SECRET}}
PCLOUD_CLIENT_ID: ${{secrets.PCLOUD_CLIENT_ID}}
PCLOUD_CLIENT_SECRET: ${{secrets.PCLOUD_CLIENT_SECRET}}
YANDEXDISK_CLIENT_ID: ${{secrets.YANDEXDISK_CLIENT_ID}}
YANDEXDISK_CLIENT_SECRET: ${{secrets.YANDEXDISK_CLIENT_SECRET}}
KOOFR_CLIENT_ID: ${{secrets.KOOFR_CLIENT_ID}}
KOOFR_CLIENT_SECRET: ${{secrets.KOOFR_CLIENT_SECRET}}
strategy: strategy:
matrix: matrix:
+10
View File
@@ -25,6 +25,16 @@ jobs:
ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}} ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}} REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}}
REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}} REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}}
GOOGLEDRIVE_CLIENT_ID: ${{secrets.GOOGLEDRIVE_CLIENT_ID}}
GOOGLEDRIVE_CLIENT_SECRET: ${{secrets.GOOGLEDRIVE_CLIENT_SECRET}}
BOX_CLIENT_ID: ${{secrets.BOX_CLIENT_ID}}
BOX_CLIENT_SECRET: ${{secrets.BOX_CLIENT_SECRET}}
PCLOUD_CLIENT_ID: ${{secrets.PCLOUD_CLIENT_ID}}
PCLOUD_CLIENT_SECRET: ${{secrets.PCLOUD_CLIENT_SECRET}}
YANDEXDISK_CLIENT_ID: ${{secrets.YANDEXDISK_CLIENT_ID}}
YANDEXDISK_CLIENT_SECRET: ${{secrets.YANDEXDISK_CLIENT_SECRET}}
KOOFR_CLIENT_ID: ${{secrets.KOOFR_CLIENT_ID}}
KOOFR_CLIENT_SECRET: ${{secrets.KOOFR_CLIENT_SECRET}}
strategy: strategy:
matrix: matrix:
+30 -2
View File
@@ -20,8 +20,13 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
- Amazon S3 or S3-compatible (Cloudflare R2 / BackBlaze B2 / MinIO / ...) - Amazon S3 or S3-compatible (Cloudflare R2 / BackBlaze B2 / MinIO / ...)
- Dropbox - Dropbox
- OneDrive for personal - OneDrive for personal
- Webdav - Webdav (NextCloud / InfiniCloud / Synology webdav server / ...)
- Webdis - Webdis
- Google Drive (PRO feature)
- Box (PRO feature)
- pCloud (PRO feature)
- Yandex Disk (PRO feature)
- Koofr (PRO feature)
- [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details. - [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details.
- **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker". - **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
- **[End-to-end encryption](./docs/encryption/README.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password. - **[End-to-end encryption](./docs/encryption/README.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
@@ -107,6 +112,9 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
- [Synology webdav server](./docs/remote_services/webdav_synology_webdav_server/README.md) | [群晖 webdav server](./docs/remote_services/webdav_synology_webdav_server/README.zh-cn.md) - [Synology webdav server](./docs/remote_services/webdav_synology_webdav_server/README.md) | [群晖 webdav server](./docs/remote_services/webdav_synology_webdav_server/README.zh-cn.md)
- [AList(中文)](./docs/remote_services/webdav_alist/README.zh-cn.md) | [AList (English)](./docs/remote_services/webdav_alist/README.md) - [AList(中文)](./docs/remote_services/webdav_alist/README.zh-cn.md) | [AList (English)](./docs/remote_services/webdav_alist/README.md)
- [坚果云](./docs/remote_services/webdav_jianguoyun/README.zh-cn.md) | [JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md) - [坚果云](./docs/remote_services/webdav_jianguoyun/README.zh-cn.md) | [JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
- [Open Media Vault](./docs/remote_services/webdav_openmediavault/README.md)
- [Nginx (`ngx_http_dav_module`, `nginx-dav-ext-module`, with Docker)](./docs/remote_services/webdav_nginx/README.md)
- [Apache (with Docker)](./docs/remote_services/webdav_apache/README.md)
- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md). - Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md).
- Your data would be synced to a `${vaultName}` sub folder on your webdav server. - Your data would be synced to a `${vaultName}` sub folder on your webdav server.
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**. - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
@@ -119,6 +127,26 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
- Mostly experimental. - Mostly experimental.
- You have to setup and protect your web server by yourself. - You have to setup and protect your web server by yourself.
### Google Drive (PRO feature)
PRO (paid) feature "sync with Google Drive" allows users to to sync with Google Drive. Tutorials and limitations are documented [here](./docs/remote_services/googledrive/README.md).
### Box (PRO feature)
PRO (paid) feature "sync with Box" allows users to to sync with Box. Tutorials and limitations are documented [here](./docs/remote_services/box/README.md).
### pCloud (PRO feature)
PRO (paid) feature "sync with pCloud" allows users to to sync with pCloud (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/pcloud/README.md).
### Yandex Disk (PRO feature)
PRO (paid) feature "sync with Yandex Disk" allows users to to sync with Yandex Disk (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/yandexdisk/README.md).
### Yandex Disk (PRO feature)
PRO (paid) feature "sync with Koofr" allows users to to sync with Koofr (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/koofr/README.md).
## Scheduled Auto Sync ## Scheduled Auto Sync
- You can configure auto syncing every N minutes in settings. - You can configure auto syncing every N minutes in settings.
@@ -133,7 +161,7 @@ In the latest version, you can change the settings to allow syncing `_` files or
## PRO Features ## PRO Features
See [PRO](./pro/README.md) for more details. See [PRO](./docs/pro/README.md) for more details.
## How To Debug ## How To Debug
+53
View File
@@ -0,0 +1,53 @@
# PRO Features
From version 0.5.x, Remotely Save introduces PRO (paid) features. Users need to subscribe to (pay) them to use them.
**If you are using basic features only, you don't need an online account, and you don't need to pay for the plugin.**
# Links
* Remotely Save official website: <https://remotelysave.com>
* Sign up / Sign in: <https://remotelysave.com/user/signupin>
* User profile: <https://remotelysave.com/user/profile>
# Disclaimer
It's different from, and NOT affiliated with Obsidian account.
# Steps
## Steps of signing up and signing in
1. Go to the website, sign up and sign in. You can directly visit <https://remotelysave.com/user/signupin> or click the link in Remotely Save plugin setting page.
![pro setting](./pro_setting.png)
2. Use an email and your password as usual. Don't need to be GMail account.
## Steps of connecting
You need to connect your plugin to your online account. In Obsidian, in your Remotely Save plugin setting, you can click the button "Connect" to start the flow.
1. You will see a special address on website. Click it and visit the website
2. Click "allow" on the website.
3. In the end of the auth flow on the website, you will be shown up a code, please copy it...
4. And paste the code back to the plugin modal inside Obsidian, and confirm.
![connect flow](./connect_flow.png)
## Steps of subscribing to some features.
1. Firstly please visit your [profile page](https://remotelysave.com/user/profile) online.
2. You can subscribe to some features. Prices vary.
![PRO features online](./pro_features_enabled_on_website.png)
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled.
![check again PRO features](./check_pro_features_in_settings.png)
4. Sync and enjoy your PRO features!
## Why so complicated?
Because we don't have a payment method inside the plugin, so we have to:
* build a website,
* require users having online accounts
* and connect the plugin to the online account.
Moreover, an online account allows flexible management of subscriptions.
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:8c73da29a621d225387640b76ec0dcfb56b3ffad151dab374d3b7cc76067a1a0
size 94377
+3
View File
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:116c2a8ec1a277a3985f4056b390574fc57145ec5635d44accf2a7445666264a
size 626668
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:4c45c08e6fc487341032aac511c332e3f9978a44e9b93377a73648b56b684b62
size 155427
+3
View File
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:08d128125dba033f5dd18a6ea8d942b284ddca6c5c3b0362c47dcb4a7153a8f9
size 395800
+34
View File
@@ -0,0 +1,34 @@
# Box (PRO)
# Links
<https://www.box.com/>
# Intro
* It's a PRO feature of Remotely Save plugin.
* **This plugin is NOT an official Box product, and just uses Box's public api.**
# Steps
## Steps of Remotely Save subscription
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
2. Subscribe to "sync with Box" feature online.
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Box should be detected.
## Steps of Connecting to your Box
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Box account now.
1. In Remotely Save settings, change your sync service to Box.
2. Click Auth, visit the link, go to Box website to start.
3. Follow the instruction on Box, and allow Remotely Save to connect.
4. You will be redirected back to Remotely Save plugin.
5. A notice will tell you that you've connected or not.
6. Sync! The plugin will create a vault folder in the root of your Box and upload notes into that folder.
7. **Read the caveats below.**
# The caveats
* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
@@ -0,0 +1,59 @@
# Google Drive (PRO)
# Intro
* It's a PRO feature of Remotely Save plugin.
* **This plugin is NOT an official Google product, and just uses Google Drive's public api.**
# Steps
## Steps of Remotely Save subscription
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
2. Subscribe to "sync with Google Drive" feature online.
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Google Drive should be detected.
## Steps of Connecting to your Google Drive
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Google Drive account now.
1. In Remotely Save settings, change your sync service to Google Drive.
![change remote to google drive](./change_remote_to_google_drive.png)
2. Click Auth, visit the link, go to Remotely Save website to start.
![visit start link](./google_drive_auth_link.png)
3. On the website, click the link to go to Google Drive auth page.
4. Follow the instruction on Google website, and allow (continue) Remotely Save to connect.
![allow Remotely Save in Google website](./google_drive_auth_allow.png)
5. You will be redirected to Remotely Save website, and you will get a code. Copy it...
![redirected back and get the code](./google_drive_auth_code_show.png)
6. ... And paste the code back to the plugin inside Obsidian. Click submit.
![submit the code in setting](./google_drive_code_submit.png)
7. A notice will tell you that you've connected or not.
8. Sync! The plugin will create a vault folder in the root of your Google Drive and upload notes into that folder.
9. **Read the caveats below.**
# Why so complicated?
Because Google Drive's api doesn't fit into the special envorinment of Obsidian plugin. So we need a website.
# The credential
The website does **NOT** store or save the Google drive credential (the code you obtian in the end of the flow). The website is just a "bridge" to help you obtain that code, and just manage your subscription to PRO features.
But please be aware that the code is saved locally in your Obsidian. It works like a special password. So that the plugin can upload or download or modify the files for you.
# The caveats
* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
* The plugin can **only** sees, reads or writes the files and folders created by itself!
It means that, you CANNOT manually create the vault folder in your Google Drive account. And if you manually upload any files using Google's official website, the plugin does **NOT** see them. All operations must go through Obsidian and uploaded by the plugin.
You can, however, view, and download the files on Google Drive [official web page](https://drive.google.com/drive/u/0/my-drive).
Precisely speaking, the plugin applies for the `drive.file` scope recommended by Google. See [the doc](https://developers.google.com/drive/api/guides/api-specific-auth#benefits) by Google for the scope's benefits. Basically the plugin will never (is unable to) mess up your other files or folders.
Moreover, this scope is "not-sensitive", so that the plugin doesn't need to go through Google's complicated verification process while applying for it.
* Google Drive, unlike other cloud storage, allows files of same name co-existing in the same folder! (hmmmmm...) It may or may not make the plugin stop working. Users might need to remove the duplicated file manually on Google's official website.
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:eaa9aa8ba6b066dfefdce08a8d1da1d97089f5c2de0ba4c0c026d6df9eb9ece8
size 99896
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:6683a63718053603ae7dde44063a3807ba0def7e935da0b40fcc8e181afd24ae
size 342848
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:310bd4c7d5fe19521ec7184b2eee749f0eecf00397f2b8e68480c23b4fd7c943
size 153504
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:dcebb1f73829670883071447a8eee46c972b26fe8735c7422949cb6fe927b8ab
size 179369
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:7e5a85c28f5614e4de75eacc021c2876d36596bcb77f0744a6edcff7777b9530
size 155004
+38
View File
@@ -0,0 +1,38 @@
# Koofr (PRO)
# Links
<https://koofr.eu/>
# Intro
* It's a PRO feature of Remotely Save plugin.
* **This plugin is NOT an official Koofr product, and just uses Koofr's public api.**
# Steps
## Steps of Remotely Save subscription
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
2. Subscribe to "sync with Koofr" feature online.
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Koofr should be detected.
## Steps of Connecting to your Koofr
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Koofr account now.
1. In Remotely Save settings, change your sync service to Koofr.
2. Click Auth, visit the link, go to Koofr website to start.
3. Follow the instruction on Koofr, and allow Remotely Save to connect.
4. You will be redirected back to Remotely Save plugin.
5. A notice will tell you that you've connected or not.
6. Sync! The plugin will create a vault folder in the root of your Koofr and upload notes into that folder.
7. **Read the caveats below.**
# The caveats
* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
# Why not use webdav?
The Remotely Save PRO feture "sync with Koofr" is developed using Koofr's native API, instead of webdav interface. It brings benefits such that the last modified time can be preserved.
+40
View File
@@ -0,0 +1,40 @@
# pCloud (PRO)
# Links
<https://www.pcloud.com/>
# Intro
* It's a PRO feature of Remotely Save plugin.
* **This plugin is NOT an official pCloud product, and just uses pCloud's public api.**
# Steps
## Steps of Remotely Save subscription
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
2. Subscribe to "sync with pCloud" feature online.
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with pCloud should be detected.
## Steps of Connecting to your pCloud
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your pCloud account now.
1. In Remotely Save settings, change your sync service to pCloud.
2. Click Auth, visit the link, go to pCloud website to start.
3. Follow the instruction on pCloud, and allow Remotely Save to connect.
4. You will be redirected back to Remotely Save plugin.
5. A notice will tell you that you've connected or not.
6. Sync! The plugin will create a vault folder in the root of your pCloud and upload notes into that folder.
7. **Read the caveats below.**
# The caveats
* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
* pCloud's API seems to not allow uploading empty files. You can choose to skip them or raise errors in Remotely Save plugin's settings.
# Why not use webdav?
1. pCloud only provides webdav for Premium. If you are a Premium user, you can still use pCloud webdav with Remotely Save.
2. The Remotely Save PRO feture "sync with pCloud" is developed using pCloud's native API, instead of webdav interface. It brings benefits such that the last modified time can be preserved.
@@ -0,0 +1,62 @@
# Apache Webdav
The following tutorial uses Apache with Docker in Linux, using the image [`bytemark/webdav`](https://hub.docker.com/r/bytemark/webdav/).
You can also checkout the official doc from Bytemark [here](https://docs.bytemark.co.uk/article/run-your-own-webdav-server-with-docker/). The tutorial you are reading here is a little different from Bytemark's article.
Assuming you want a webdav server on Linux satisfying that:
1. Data is saved in your host machine's `./dav1` folder,
2. WebDAV is accessed by a user `user1` with password `password1`,
3. WebDAV is accessed on the host machine and port 8080: `127.0.0.1:8080`.
4. Use Basic auth type.
Install docker nd set its permission properly. Then run this in terminal:
```bash
mkdir ./dav1 # create the local folder
docker container run --rm \
-p 127.0.0.1:8080:80 \
-v ./dav1:/var/lib/dav \
-e USERNAME=user1 \
-e PASSWORD=password1 \
-e AUTH_TYPE=Basic \
bytemark/webdav
```
We do not have `--detach` prameter here, so the server will be closed as soon as you terminate the program or close terminal. You might want to adjust the settings further by yourself.
Then, in Remotely Save's setting, set these (auth type should always be `Basic`):
```
Server: http://127.0.0.1:8080
User: user1
Password: password1
Auth Type: Basic
Depth Header Sent To Servers: only supports depth='1'
```
![Apache RS Setting](./apache_rs_settings.png)
Then the server should be connected! You can sync now!
In you host machine's file system, you should find some files and folders were added into the folder `./dav1`.
```
ls ./dav1/
## data DavLock DavLock.dir DavLock.pag
ls ./dav1/data/
## <your vault name or your base dir>
```
# Auth type
You can change the auth type while calling Docker, between `Basic` and `Digest`. And please rememberto adjust the Remotely Save's settings. Both works.
# Notice
1. **Never expose your webdav server to public networks without protections or without strong passwords!**
2. I personally recommend using tailscale to build a LAN instead of expoing the service to public.
3. If you want to connect to the server from iOS (iPhone / iPad), the https is required. I personally recommend using caddy as the reverse proxy. Caddy can also be combined with tailscale.
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:264e50d3adaeb4fc4e76b00273459d7d021f1b44af7f07b00a5c40741e65194d
size 658482
@@ -0,0 +1,51 @@
# Nginx Webdav
The following tutorial uses Nginx with Docker in Linux, using the image [docker-nginx-webdav-nononsense](https://github.com/dgraziotin/docker-nginx-webdav-nononsense). It contains `ngx_http_dav_module` and `nginx-dav-ext-module`.
The description is adapted from the pull request [`dgraziotin/docker-nginx-webdav-nononsense#123`](https://github.com/dgraziotin/docker-nginx-webdav-nononsense/pull/123) by Remotely Save author.
Assuming you want a webdav server on Linux satisfying that:
1. Data is saved in your host machine's `./dav1` folder,
2. WebDAV is accessed by a user `user1` with password `password1`,
3. WebDAV is accessed on the host machine and port 8080: `127.0.0.1:8080`.
4. (Only Basic auth type is supported.)
Install docker nd set its permission properly. Then run this in terminal:
```bash
mkdir ./dav1 # create the local folder
docker container run --rm \
-p 127.0.0.1:8080:80 \
-v ./dav1:/data \
-e WEBDAV_USERNAME=user1 \
-e WEBDAV_PASSWORD=password1 \
-e PUID=1000 \
-e PGID=1000 \
dgraziotin/nginx-webdav-nononsense
```
We do not have `--detach` prameter here, so the server will be closed as soon as you terminate the program or close terminal. You might want to adjust the settings further by yourself.
Then, in Remotely Save's setting, set these (auth type should always be `Basic`):
```
Server: http://127.0.0.1:8080
User: user1
Password: password1
Auth Type: Basic
Depth Header Sent To Servers: only supports depth='1'
```
![Nginx RS Setting](./nginx_rs_setting.png)
Then the server should be connected! You can sync now!
In you host machine's file system, you should find some files and folders were added into the folder `./dav1`.
# Notice
1. **Never expose your webdav server to public networks without protections or without strong passwords!**
2. I personally recommend using tailscale to build a LAN instead of expoing the service to public.
3. If you want to connect to the server from iOS (iPhone / iPad), the https is required. I personally recommend using caddy as the reverse proxy. Caddy can also be combined with tailscale.
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:92059e0819d25640a02d2494ba9da0bfa7a69003cdba36ced985bed9e29b0354
size 254978
@@ -0,0 +1,21 @@
# Open Media Vault WebDAV
## Link
https://www.openmediavault.org
## Steps
1. In Open Media Vault's UI, install the WebDAV plugin:
* System → Plugins → openmediavault-webdav
2. Create a new Shared Folder
* Storage → Shared Folders → Create
3. Enable WebDAV server
* Services → WedDAV → Enable → Select previously created Shared Folder
4. Make sure Group is "webdav-users"
5. Add {your username} to "webdav-users" group
* Users → Groups → webdav-users → Edit → Members
6. Set folder permissions
* Storage → Shared Folders select the corresponding shared folder → Permissions → Set both {your username} and "webdav-users" group to "Read/Write" permissions
7. Back to Shared Folders, set specific Access Control List permissions
* Select the shared folder → Access Control List → set {your username}, "webdav-users" and "www-data" to "Read/Write" permissions
8. Install Remotely Save in Obsidian, select WebDAV, add the URL http://[your-server-ip]/webdav, use your user credentials and connect.
+44
View File
@@ -0,0 +1,44 @@
# Yandex Disk (PRO)
# Links
<https://disk.yandex.com/client/disk>
# Intro
* It's a PRO feature of Remotely Save plugin.
* **This plugin is NOT an official Yandex Disk or Yandex product, and just uses Yandex Disk's public api.**
# Steps
## Steps of Remotely Save subscription
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
2. Subscribe to "sync with Yandex Disk" feature online.
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Yandex Disk should be detected.
## Steps of Connecting to your Yandex Disk
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Yandex Disk account now.
1. In Remotely Save settings, change your sync service to Yandex Disk.
2. Click Auth, visit the link, go to Yandex Disk website to start.
3. Follow the instruction on Yandex Disk, and allow Remotely Save to connect.
4. You will be redirected back to Remotely Save plugin.
5. A notice will tell you that you've connected or not.
6. Sync! The plugin will create a vault folder in the root of your Yandex Disk and upload notes into that folder.
7. **Read the caveats below.**
# The caveats
* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
# Why not use webdav?
1. The Remotely Save PRO feture "sync with Yandex Disk" is developed using Yandex Disk's native API, instead of webdav interface. It brings benefits such that the last modified time can be preserved.
2. Some users prefer oauth2 method to authorize themselves.
# Bonus: where to register the app
* <https://oauth.yandex.com/client/new/> or <https://oauth.yandex.ru/client/new/>
* redirect uri can be set to <https://oauth.yandex.com/verification_code> or <https://oauth.yandex.ru/verification_code>.
+38 -34
View File
@@ -6,37 +6,41 @@ The plugin works under the browser environment in Obsidian, so CORS is an issue.
The list is for information purposes only. The list is for information purposes only.
| Service | Connectable | by S3 | by WebDAV | by other protocol | can bypass CORS issue in latest Obsidian | need CORS config in old Obsidian |
| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------ | | Service | Connectable | by S3 | by WebDAV | by other protocol |
| Amazon S3 | Yes | Yes | | | Yes | [CORS config needed.](./s3_cors_configure.md) | | ------ | ------ | ------ | ------ | ------ |
| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储 | Yes | Yes | | | Yes | CORS config needed. | | Amazon S3 | Yes | Yes | | |
| Alibaba Cloud - Object Storage Service 阿里云对象存储 | Yes | Yes | | | Yes | CORS config needed. | | Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储 | Yes | Yes | | |
| Backblaze B2 Cloud Storage | Yes | Yes | | | Yes | Its CORS rules doesn't allow no-http(s) origins. | | Alibaba Cloud - Object Storage Service 阿里云对象存储 | Yes | Yes | | |
| [Wasabi](https://wasabi.com) | ? | ? | | | | | | Backblaze B2 Cloud Storage | Yes | Yes | | |
| [filebase](https://filebase.com/) | Yes | Yes | | | Yes | CORS config needed. | | [Wasabi](https://wasabi.com) | ? | ? | | |
| QingStor 青云 | ? | ? | | | | | | [filebase](https://filebase.com/) | Yes | Yes | | |
| [MinIO](https://min.io/) | ? | ? | | | | | | QingStor 青云 | ? | ? | | |
| [WsgiDAV](https://github.com/mar10/wsgidav) | Yes | | Yes | | Yes | CORS rules can be set. | | [MinIO](https://min.io/) | Yes | Yes | | |
| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes? | | Yes? | | Yes? | ? | | [WsgiDAV](https://github.com/mar10/wsgidav) | Yes | | Yes | |
| NextCloud | Yes | | Yes | | Yes? | No CORS config by default. | | [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes | | Yes | |
| OwnCloud | Yes? | | Yes? | | Yes? | No CORS config by default. | | NextCloud | Yes | | Yes | |
| Seafile | Yes | | Yes | | Yes? | No CORS config by default. | | OwnCloud | Yes? | | Yes? | |
| `rclone serve webdav` | Yes | | Yes | | Yes | No CORS support. | | Seafile | Yes | | Yes | |
| [Nutstore 坚果云](https://www.jianguoyun.com/) | Yes | | Yes | | Yes | No CORS support. | | `rclone serve webdav` | Yes | | Yes | |
| [TeraCLOUD](https://teracloud.jp/en/) | Yes | | Yes | | Yes | No CORS support. | | [Nutstore 坚果云](https://www.jianguoyun.com/) | Yes (partially) | | Yes (partially) | |
| Dropbox | Yes | | | Yes | | | | [TeraCLOUD](https://teracloud.jp/en/) | Yes | | Yes | |
| OneDrive for personal | Yes | | | Yes | | | | Seafile | ? | | ? | ? |
| OneDrive for Business | Yes | | | ? | | | | Dropbox | Yes | | | Yes |
| Google Drive | In the plan | | | ? | | | | OneDrive for personal | Yes | | | Yes |
| [Box](https://www.box.com/) | ? | | | May be possible but needs further development. | | | | OneDrive for Business | Yes | | | ? |
| Google Cloud Storage | ? | | | May be possible but needs further development. | | | | Google Drive | Yes (with limitations) (PRO) | | | Yes (with limitations) (PRO) |
| Microsoft Azure Blob Storage | ? | | | May be possible but needs further development. | | | | [Box](https://www.box.com/) | Yes (PRO) | | | Yes (PRO) |
| [OpenStack Storage (Swift)](https://github.com/openstack/swift) | ? | | | May be possible but needs further development. | | | | [pCloud](https://www.pcloud.com/) | Yes (PRO) | | Yes | Yes (PRO) |
| https://put.io/ | ? | | | ? | | | | Google Cloud Storage | ? | | | May be possible but needs further development. |
| Yandex Disk | ? | | | ? | | | | Microsoft Azure Blob Storage | ? | | | May be possible but needs further development. |
| FTP / FTPS | Never | | | Technically never possible to be implemented. | | | | [OpenStack Storage (Swift)](https://github.com/openstack/swift) | ? | | | May be possible but needs further development. |
| SFTP | Never | | | Technically never possible to be implemented. | | | | <https://put.io/> | ? | | | ? |
| Jottacloud | No | | | No. It seems that no open api is available. | | | | Yandex Disk | Yes (PRO) | | Yes | Yes (PRO) |
| Mega | Never | | | No. No js api is available. | | | | FTP / FTPS | Never | | | Technically never possible to be implemented. |
| Git | Never | | | No. Technically very hard, if not impossible, to be implemented. | | | | SFTP | Never | | | Technically never possible to be implemented. |
| | | | | | | | | Jottacloud | No | | | No. It seems that no open api is available. |
| Mega | Never | | | No. No js api is available. |
| Git | Never | | | No. Technically very hard, if not impossible, to be implemented. |
| [Koofr](https://koofr.eu/) | ? | | ? | ? |
| [Blomp](https://www.blomp.com/) | ? | | | May be possible but needs further development. |
+20 -2
View File
@@ -52,7 +52,7 @@ Bidirectional:
| local deleted | (04) delete remote | (05) pull | (01) clean history | (03) pull | | local deleted | (04) delete remote | (05) pull | (01) clean history | (03) pull |
| local created | (??) conflict | (??) conflict | (06) push | (11/12/13/14/15) conflict | | local created | (??) conflict | (??) conflict | (06) push | (11/12/13/14/15) conflict |
Incremental push only: Incremental push:
| local\remote | remote unchanged | remote modified | remote deleted | remote created | | local\remote | remote unchanged | remote modified | remote deleted | remote created |
| --------------- | ---------------------------- | ---------------------------- | ---------------------- | ---------------------------- | | --------------- | ---------------------------- | ---------------------------- | ---------------------- | ---------------------------- |
@@ -61,7 +61,7 @@ Incremental push only:
| local deleted | **(29) conflict do nothing** | **(30) conflict do nothing** | (01) clean history | **(28) conflict do nothing** | | local deleted | **(29) conflict do nothing** | **(30) conflict do nothing** | (01) clean history | **(28) conflict do nothing** |
| local created | (??) conflict | (??) conflict | (06) push | **(23) conflict push** | | local created | (??) conflict | (??) conflict | (06) push | **(23) conflict push** |
Incremental pull only: Incremental pull:
| local\remote | remote unchanged | remote modified | remote deleted | remote created | | local\remote | remote unchanged | remote modified | remote deleted | remote created |
| --------------- | ---------------------- | ---------------------- | ---------------------------- | ---------------------- | | --------------- | ---------------------- | ---------------------- | ---------------------------- | ---------------------- |
@@ -69,3 +69,21 @@ Incremental pull only:
| local modified | **(27) conflict pull** | **(24) conflict pull** | **(34) conflict do nothing** | (??) conflict | | local modified | **(27) conflict pull** | **(24) conflict pull** | **(34) conflict do nothing** | (??) conflict |
| local deleted | **(35) conflict pull** | (05) pull | (01) clean history | (03) pull | | local deleted | **(35) conflict pull** | (05) pull | (01) clean history | (03) pull |
| local created | (??) conflict | (??) conflict | **(31) conflict do nothing** | **(22) conflict pull** | | local created | (??) conflict | (??) conflict | **(31) conflict do nothing** | **(22) conflict pull** |
Incremental push and delete (diff decisionBranch: 38):
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
| --------------- | ---------------------------- | ---------------------------- | ---------------------- | ---------------------------- |
| local unchanged | (02/21) do nothing | **(26) conflict push** | **(32) conflict push** | (??) conflict |
| local modified | (10) push | **(25) conflict push** | (08) push | (??) conflict |
| local deleted | **(38) delete remote** | **(30) conflict do nothing** | (01) clean history | **(28) conflict do nothing** |
| local created | (??) conflict | (??) conflict | (06) push | **(23) conflict push** |
Incremental pull and delete (diff decisionBranch: 39):
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
| --------------- | ---------------------- | ---------------------- | ---------------------------- | ---------------------- |
| local unchanged | (02/21) do nothing | (09) pull | **(39) delete local** | (??) conflict |
| local modified | **(27) conflict pull** | **(24) conflict pull** | **(34) conflict do nothing** | (??) conflict |
| local deleted | **(35) conflict pull** | (05) pull | (01) clean history | (03) pull |
| local created | (??) conflict | (??) conflict | **(31) conflict do nothing** | **(22) conflict pull** |
+22
View File
@@ -19,6 +19,18 @@ const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || ""; const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
const DEFAULT_REMOTELYSAVE_WEBSITE = process.env.REMOTELYSAVE_WEBSITE || ""; const DEFAULT_REMOTELYSAVE_WEBSITE = process.env.REMOTELYSAVE_WEBSITE || "";
const DEFAULT_REMOTELYSAVE_CLIENT_ID = process.env.REMOTELYSAVE_CLIENT_ID || ""; const DEFAULT_REMOTELYSAVE_CLIENT_ID = process.env.REMOTELYSAVE_CLIENT_ID || "";
const DEFAULT_GOOGLEDRIVE_CLIENT_ID = process.env.GOOGLEDRIVE_CLIENT_ID || "";
const DEFAULT_GOOGLEDRIVE_CLIENT_SECRET =
process.env.GOOGLEDRIVE_CLIENT_SECRET || "";
const DEFAULT_BOX_CLIENT_ID = process.env.BOX_CLIENT_ID || "";
const DEFAULT_BOX_CLIENT_SECRET = process.env.BOX_CLIENT_SECRET || "";
const DEFAULT_PCLOUD_CLIENT_ID = process.env.PCLOUD_CLIENT_ID || "";
const DEFAULT_PCLOUD_CLIENT_SECRET = process.env.PCLOUD_CLIENT_SECRET || "";
const DEFAULT_YANDEXDISK_CLIENT_ID = process.env.YANDEXDISK_CLIENT_ID || "";
const DEFAULT_YANDEXDISK_CLIENT_SECRET =
process.env.YANDEXDISK_CLIENT_SECRET || "";
const DEFAULT_KOOFR_CLIENT_ID = process.env.KOOFR_CLIENT_ID || "";
const DEFAULT_KOOFR_CLIENT_SECRET = process.env.KOOFR_CLIENT_SECRET || "";
esbuild esbuild
.context({ .context({
@@ -56,6 +68,16 @@ esbuild
"process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`, "process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`,
"process.env.DEFAULT_REMOTELYSAVE_WEBSITE": `"${DEFAULT_REMOTELYSAVE_WEBSITE}"`, "process.env.DEFAULT_REMOTELYSAVE_WEBSITE": `"${DEFAULT_REMOTELYSAVE_WEBSITE}"`,
"process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID": `"${DEFAULT_REMOTELYSAVE_CLIENT_ID}"`, "process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID": `"${DEFAULT_REMOTELYSAVE_CLIENT_ID}"`,
"process.env.DEFAULT_GOOGLEDRIVE_CLIENT_ID": `"${DEFAULT_GOOGLEDRIVE_CLIENT_ID}"`,
"process.env.DEFAULT_GOOGLEDRIVE_CLIENT_SECRET": `"${DEFAULT_GOOGLEDRIVE_CLIENT_SECRET}"`,
"process.env.DEFAULT_BOX_CLIENT_ID": `"${DEFAULT_BOX_CLIENT_ID}"`,
"process.env.DEFAULT_BOX_CLIENT_SECRET": `"${DEFAULT_BOX_CLIENT_SECRET}"`,
"process.env.DEFAULT_PCLOUD_CLIENT_ID": `"${DEFAULT_PCLOUD_CLIENT_ID}"`,
"process.env.DEFAULT_PCLOUD_CLIENT_SECRET": `"${DEFAULT_PCLOUD_CLIENT_SECRET}"`,
"process.env.DEFAULT_YANDEXDISK_CLIENT_ID": `"${DEFAULT_YANDEXDISK_CLIENT_ID}"`,
"process.env.DEFAULT_YANDEXDISK_CLIENT_SECRET": `"${DEFAULT_YANDEXDISK_CLIENT_SECRET}"`,
"process.env.DEFAULT_KOOFR_CLIENT_ID": `"${DEFAULT_KOOFR_CLIENT_ID}"`,
"process.env.DEFAULT_KOOFR_CLIENT_SECRET": `"${DEFAULT_KOOFR_CLIENT_SECRET}"`,
global: "window", global: "window",
"process.env.NODE_DEBUG": `undefined`, // ugly fix "process.env.NODE_DEBUG": `undefined`, // ugly fix
"process.env.DEBUG": `undefined`, // ugly fix "process.env.DEBUG": `undefined`, // ugly fix
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"id": "remotely-save", "id": "remotely-save",
"name": "Remotely Save", "name": "Remotely Save",
"version": "0.5.2", "version": "0.5.6",
"minAppVersion": "0.13.21", "minAppVersion": "0.13.21",
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.", "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
"author": "fyears", "author": "fyears",
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"id": "remotely-save", "id": "remotely-save",
"name": "Remotely Save", "name": "Remotely Save",
"version": "0.5.2", "version": "0.5.6",
"minAppVersion": "0.13.21", "minAppVersion": "0.13.21",
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.", "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
"author": "fyears", "author": "fyears",
+5 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "remotely-save", "name": "remotely-save",
"version": "0.5.2", "version": "0.5.6",
"description": "This is yet another sync plugin for Obsidian app.", "description": "This is yet another sync plugin for Obsidian app.",
"scripts": { "scripts": {
"dev2": "node esbuild.config.mjs --watch", "dev2": "node esbuild.config.mjs --watch",
@@ -45,6 +45,7 @@
"mocha": "^10.4.0", "mocha": "^10.4.0",
"npm-check-updates": "^16.14.20", "npm-check-updates": "^16.14.20",
"obsidian": "^1.5.7", "obsidian": "^1.5.7",
"openapi-typescript": "^7.0.0-rc.0",
"ts-loader": "^9.5.1", "ts-loader": "^9.5.1",
"ts-node": "^10.9.2", "ts-node": "^10.9.2",
"tslib": "^2.6.2", "tslib": "^2.6.2",
@@ -71,6 +72,7 @@
"aggregate-error": "^5.0.0", "aggregate-error": "^5.0.0",
"assert": "^2.1.0", "assert": "^2.1.0",
"aws-crt": "^1.21.2", "aws-crt": "^1.21.2",
"box-typescript-sdk-gen": "^1.0.0",
"buffer": "^6.0.3", "buffer": "^6.0.3",
"crypto-browserify": "^3.12.0", "crypto-browserify": "^3.12.0",
"dropbox": "^10.34.0", "dropbox": "^10.34.0",
@@ -85,8 +87,10 @@
"mustache": "^4.2.0", "mustache": "^4.2.0",
"nanoid": "^5.0.7", "nanoid": "^5.0.7",
"node-diff3": "^3.1.2", "node-diff3": "^3.1.2",
"openapi-fetch": "^0.9.7",
"p-queue": "^8.0.1", "p-queue": "^8.0.1",
"path-browserify": "^1.0.1", "path-browserify": "^1.0.1",
"pcloud-sdk-js": "^2.0.0",
"process": "^0.11.10", "process": "^0.11.10",
"qrcode": "^1.5.3", "qrcode": "^1.5.3",
"rfc4648": "^1.5.3", "rfc4648": "^1.5.3",
+6 -2
View File
@@ -4,9 +4,9 @@
Remotely Save has some "pro features", which users have to pay for using them. Remotely Save has some "pro features", which users have to pay for using them.
## Sign Up / Sign In ## Sign Up / Sign In And Connect
Please go to <https://remotelysave.com> to sign up and sign in an account firstly. See the tutorial about your PRO account [here](../docs/pro/README.md).
## Smart Conflict ## Smart Conflict
@@ -14,6 +14,10 @@ Basic (free) version can detect conflicts, but users have to choose to keep newe
PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files. PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files.
## Sync With Google Drive
PRO (paid) feature "sync with Google Drive" allows users to to sync with Google Drive. Tutorials and limitations are documented [here](../docs/remote_services/googledrive/README.md).
## License ## License
The codes or files or subfolders inside the current folder (`pro` in the repo), are released under "source available" license: "PolyForm Strict License 1.0.0". The codes or files or subfolders inside the current folder (`pro` in the repo), are released under "source available" license: "PolyForm Strict License 1.0.0".
+60 -44
View File
@@ -1,8 +1,8 @@
import { nanoid } from "nanoid"; import { nanoid } from "nanoid";
import { base64url } from "rfc4648";
import { import {
OAUTH2_FORCE_EXPIRE_MILLISECONDS, OAUTH2_FORCE_EXPIRE_MILLISECONDS,
type RemotelySavePluginSettings, type RemotelySavePluginSettings,
type SUPPORTED_SERVICES_TYPE,
} from "../../src/baseTypes"; } from "../../src/baseTypes";
import { import {
COMMAND_CALLBACK_PRO, COMMAND_CALLBACK_PRO,
@@ -12,6 +12,7 @@ import {
PRO_WEBSITE, PRO_WEBSITE,
type ProConfig, type ProConfig,
} from "./baseTypesPro"; } from "./baseTypesPro";
import { codeVerifier2CodeChallenge } from "./oauth2";
const site = PRO_WEBSITE; const site = PRO_WEBSITE;
console.debug(`remotelysave official website: ${site}`); console.debug(`remotelysave official website: ${site}`);
@@ -25,31 +26,6 @@ export const DEFAULT_PRO_CONFIG: ProConfig = {
email: "", email: "",
}; };
/**
* https://datatracker.ietf.org/doc/html/rfc7636
* dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
* => E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM
* @param x
* @returns BASE64URL-ENCODE(SHA256(ASCII(code_verifier)))
*/
async function codeVerifier2CodeChallenge(x: string) {
if (x === undefined || x === "") {
return "";
}
try {
return base64url.stringify(
new Uint8Array(
await crypto.subtle.digest("SHA-256", new TextEncoder().encode(x))
),
{
pad: false,
}
);
} catch (e) {
return "";
}
}
export const generateAuthUrlAndCodeVerifierChallenge = async ( export const generateAuthUrlAndCodeVerifierChallenge = async (
hasCallback: boolean hasCallback: boolean
) => { ) => {
@@ -241,18 +217,11 @@ export const getAndSaveProEmail = async (
* @returns * @returns
*/ */
export const checkProRunnableAndFixInplace = async ( export const checkProRunnableAndFixInplace = async (
featuresToCheck: PRO_FEATURE_TYPE[],
config: RemotelySavePluginSettings, config: RemotelySavePluginSettings,
pluginVersion: string, pluginVersion: string,
saveUpdatedConfigFunc: () => Promise<any> | undefined saveUpdatedConfigFunc: () => Promise<any> | undefined
): Promise<true> => { ): Promise<true> => {
// if no pro features are used, we are good to go, no checking console.debug(`checkProRunnableAndFixInplace`);
if (
featuresToCheck.contains("feature-smart_conflict") &&
config.conflictAction !== "smart_conflict"
) {
return true;
}
// many checks if status is valid // many checks if status is valid
@@ -280,23 +249,70 @@ export const checkProRunnableAndFixInplace = async (
} }
} }
// check for the features const errorMsgs = [];
if (featuresToCheck.contains("feature-smart_conflict")) {
if (config.conflictAction === "smart_conflict") { // check for smart_conflict
if (config.conflictAction === "smart_conflict") {
if (
config.pro.enabledProFeatures.filter(
(x) => x.featureName === "feature-smart_conflict"
).length === 1
) {
// good to go
} else {
errorMsgs.push(
`You're trying to use "smart conflict" PRO feature but you haven't subscribe to it.`
);
}
} else {
// good to go
}
const toChecked: {
feature: PRO_FEATURE_TYPE;
service: SUPPORTED_SERVICES_TYPE;
name: string;
}[] = [
{
feature: "feature-google_drive",
service: "googledrive",
name: "Google Drive",
},
{ feature: "feature-box", service: "box", name: "Box" },
{ feature: "feature-pcloud", service: "pcloud", name: "pCloud" },
{
feature: "feature-yandex_disk",
service: "yandexdisk",
name: "Yandex Disk",
},
{
feature: "feature-koofr",
service: "koofr",
name: "Koofr",
},
];
for (const { feature, service, name } of toChecked) {
console.debug(`checking "${feature}", serviceType=${config.serviceType}`);
if (config.serviceType === service) {
if ( if (
config.pro.enabledProFeatures.filter( config.pro.enabledProFeatures.filter((x) => x.featureName === feature)
(x) => x.featureName === "feature-smart_conflict" .length === 1
).length === 1
) { ) {
return true; // good to go
} else { } else {
throw Error( errorMsgs.push(
`You're trying to use "smart conflict" PRO feature but you haven't subscribe to it.` `You're trying to use "sync with ${name}" PRO feature but you haven't subscribe to it.`
); );
} }
} else { } else {
return true; // good to go
} }
} }
if (errorMsgs.length !== 0) {
throw Error(errorMsgs.join("\n\n"));
}
return true; return true;
}; };
+17
View File
@@ -0,0 +1,17 @@
# checklist for adding new service
1. `fsXxx.ts`
2. `settingsXxx.ts`
3. add callback and `xxxConfig` in `baseTypesPro.ts`
4. add `xxxConfig` to `DEFAULT_SETTINGS` and `RemotelySavePluginSettings` in `main.ts`
5. add `registerObsidianProtocolHandler`, if undefinded, `let xxxExpired`, expired notice in `main.ts`
6. add `langs/`
7. add css into `styles.css`
8. general `settings.ts` add: config part, chooser, import export
9. `generateProSettingsPart.ts`
10. `importExport.ts`
11. `fsGetter.ts`
12. `sync.ts` checking for PRO: `checkProRunnableAndFixInplace`
13. `configPersist.test.ts`
14. `README.md` add service at menu and detail
15. `docs/` add service
+115 -2
View File
@@ -1,4 +1,6 @@
export const MERGABLE_SIZE = 1000 * 1000; // 1 MB ///////////////////////////////////////////////////////////
// PRO
//////////////////////////////////////////////////////////
export const COMMAND_CALLBACK_PRO = "remotely-save-cb-pro"; export const COMMAND_CALLBACK_PRO = "remotely-save-cb-pro";
export const PRO_CLIENT_ID = process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID; export const PRO_CLIENT_ID = process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID;
@@ -6,7 +8,11 @@ export const PRO_WEBSITE = process.env.DEFAULT_REMOTELYSAVE_WEBSITE;
export type PRO_FEATURE_TYPE = export type PRO_FEATURE_TYPE =
| "feature-smart_conflict" | "feature-smart_conflict"
| "feature-google_drive"; | "feature-google_drive"
| "feature-box"
| "feature-pcloud"
| "feature-yandex_disk"
| "feature-koofr";
export interface FeatureInfo { export interface FeatureInfo {
featureName: PRO_FEATURE_TYPE; featureName: PRO_FEATURE_TYPE;
@@ -23,3 +29,110 @@ export interface ProConfig {
enabledProFeatures: FeatureInfo[]; enabledProFeatures: FeatureInfo[];
credentialsShouldBeDeletedAtTimeMs?: number; credentialsShouldBeDeletedAtTimeMs?: number;
} }
///////////////////////////////////////////////////////////
// smart conflict
//////////////////////////////////////////////////////////
export const MERGABLE_SIZE = 1000 * 1000; // 1 MB
///////////////////////////////////////////////////////////
// Google Drive
//////////////////////////////////////////////////////////
export interface GoogleDriveConfig {
accessToken: string;
accessTokenExpiresInMs: number;
accessTokenExpiresAtTimeMs: number;
refreshToken: string;
remoteBaseDir?: string;
credentialsShouldBeDeletedAtTimeMs?: number;
scope: "https://www.googleapis.com/auth/drive.file";
kind: "googledrive";
}
export const DEFAULT_GOOGLEDRIVE_CLIENT_ID =
process.env.DEFAULT_GOOGLEDRIVE_CLIENT_ID;
export const DEFAULT_GOOGLEDRIVE_CLIENT_SECRET =
process.env.DEFAULT_GOOGLEDRIVE_CLIENT_SECRET;
///////////////////////////////////////////////////////////
// box
//////////////////////////////////////////////////////////
export const COMMAND_CALLBACK_BOX = "remotely-save-cb-box";
export const BOX_CLIENT_ID = process.env.DEFAULT_BOX_CLIENT_ID;
export const BOX_CLIENT_SECRET = process.env.DEFAULT_BOX_CLIENT_SECRET;
export interface BoxConfig {
accessToken: string;
accessTokenExpiresInMs: number;
accessTokenExpiresAtTimeMs: number;
refreshToken: string;
remoteBaseDir?: string;
credentialsShouldBeDeletedAtTimeMs?: number;
kind: "box";
}
///////////////////////////////////////////////////////////
// pCloud
//////////////////////////////////////////////////////////
export const COMMAND_CALLBACK_PCLOUD = "remotely-save-cb-pcloud";
export const PCLOUD_CLIENT_ID = process.env.DEFAULT_PCLOUD_CLIENT_ID;
export const PCLOUD_CLIENT_SECRET = process.env.DEFAULT_PCLOUD_CLIENT_SECRET;
export interface PCloudConfig {
accessToken: string;
hostname: "eapi.pcloud.com" | "api.pcloud.com";
locationid: 1 | 2;
remoteBaseDir?: string;
credentialsShouldBeDeletedAtTimeMs?: number;
kind: "pcloud";
/**
* @deprecated
*/
emptyFile: "skip" | "error";
}
///////////////////////////////////////////////////////////
// Yandex Disk
//////////////////////////////////////////////////////////
export const COMMAND_CALLBACK_YANDEXDISK = "remotely-save-cb-yandexdisk";
export const YANDEXDISK_CLIENT_ID = process.env.DEFAULT_YANDEXDISK_CLIENT_ID;
export const YANDEXDISK_CLIENT_SECRET =
process.env.DEFAULT_YANDEXDISK_CLIENT_SECRET;
export interface YandexDiskConfig {
accessToken: string;
accessTokenExpiresInMs: number;
accessTokenExpiresAtTimeMs: number;
refreshToken: string;
remoteBaseDir?: string;
credentialsShouldBeDeletedAtTimeMs?: number;
scope: string;
kind: "yandexdisk";
}
///////////////////////////////////////////////////////////
// Koofr
//////////////////////////////////////////////////////////
export const COMMAND_CALLBACK_KOOFR = "remotely-save-cb-koofr";
export const KOOFR_CLIENT_ID = process.env.DEFAULT_KOOFR_CLIENT_ID;
export const KOOFR_CLIENT_SECRET = process.env.DEFAULT_KOOFR_CLIENT_SECRET;
export interface KoofrConfig {
accessToken: string;
accessTokenExpiresInMs: number;
accessTokenExpiresAtTimeMs: number;
refreshToken: string;
remoteBaseDir?: string;
credentialsShouldBeDeletedAtTimeMs?: number;
scope: string;
api: string;
mountID: string;
kind: "koofr";
}
+926
View File
@@ -0,0 +1,926 @@
import {
BoxOAuth,
OAuthConfig,
} from "box-typescript-sdk-gen/lib/box/oauth.generated";
import * as mime from "mime-types";
import { DEFAULT_CONTENT_TYPE, type Entity } from "../../src/baseTypes";
import { FakeFs } from "../../src/fsAll";
import {
BOX_CLIENT_ID,
BOX_CLIENT_SECRET,
type BoxConfig,
COMMAND_CALLBACK_BOX,
} from "./baseTypesPro";
import { BoxDeveloperTokenAuth } from "box-typescript-sdk-gen/lib/box/developerTokenAuth.generated";
import { BoxClient } from "box-typescript-sdk-gen/lib/client.generated";
import type { FileFull } from "box-typescript-sdk-gen/lib/schemas/fileFull.generated";
import type { FileFullOrFolderMiniOrWebLink } from "box-typescript-sdk-gen/lib/schemas/fileFullOrFolderMiniOrWebLink.generated";
import type { FolderFull } from "box-typescript-sdk-gen/lib/schemas/folderFull.generated";
import type { Items } from "box-typescript-sdk-gen/lib/schemas/items.generated";
import PQueue from "p-queue";
import {
delay,
getFolderLevels,
getSha1,
splitFileSizeToChunkRanges,
unixTimeToStr,
} from "../../src/misc";
export const DEFAULT_BOX_CONFIG: BoxConfig = {
accessToken: "",
refreshToken: "",
accessTokenExpiresInMs: 0,
accessTokenExpiresAtTimeMs: 0,
credentialsShouldBeDeletedAtTimeMs: 0, // 60 days https://developer.box.com/guides/authentication/tokens/refresh/
kind: "box",
};
export const generateAuthUrl = () => {
const config = new OAuthConfig({
clientId: BOX_CLIENT_ID ?? "",
clientSecret: BOX_CLIENT_SECRET ?? "",
});
const oauth = new BoxOAuth({ config: config });
// the URL to redirect the user to
const authorize_url = oauth.getAuthorizeUrl({
redirectUri: `obsidian://${COMMAND_CALLBACK_BOX}`,
});
// console.debug(authorize_url)
return authorize_url;
};
/**
* https://developer.box.com/guides/authentication/oauth2/without-sdk/
*/
export const sendAuthReq = async (authCode: string, errorCallBack: any) => {
try {
const k = {
code: authCode,
grant_type: "authorization_code",
client_id: BOX_CLIENT_ID ?? "",
client_secret: BOX_CLIENT_SECRET ?? "",
// redirect_uri: `obsidian://${COMMAND_CALLBACK_BOX}`,
};
// console.debug(k);
const resp1 = await fetch(`https://api.box.com/oauth2/token`, {
method: "POST",
body: new URLSearchParams(k),
});
const resp2 = await resp1.json();
return resp2;
} catch (e) {
console.error(e);
if (errorCallBack !== undefined) {
await errorCallBack(e);
}
}
};
/**
* https://developer.box.com/guides/authentication/tokens/refresh/
*/
export const sendRefreshTokenReq = async (refreshToken: string) => {
console.debug(`refreshing token`);
const x = await fetch("https://api.box.com/oauth2/token", {
method: "POST",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
},
body: new URLSearchParams({
client_id: BOX_CLIENT_ID ?? "",
client_secret: BOX_CLIENT_SECRET ?? "",
grant_type: "refresh_token",
refresh_token: refreshToken,
}).toString(),
});
if (x.status === 200) {
const y = await x.json();
console.debug(`new token obtained`);
return y;
} else {
throw Error(`cannot refresh an access token`);
}
};
export const setConfigBySuccessfullAuthInplace = async (
config: BoxConfig,
authRes: any,
saveUpdatedConfigFunc: () => Promise<any> | undefined
) => {
if (authRes.access_token === undefined || authRes.access_token === "") {
throw Error(
`you should not save the setting for ${JSON.stringify(authRes)}`
);
}
config.accessToken = authRes.access_token;
config.accessTokenExpiresAtTimeMs =
Date.now() + authRes.expires_in * 1000 - 5 * 60 * 1000;
config.accessTokenExpiresInMs = authRes.expires_in * 1000;
config.refreshToken = authRes.refresh_token || config.refreshToken;
// manually set it expired after 60 days;
config.credentialsShouldBeDeletedAtTimeMs =
Date.now() + 1000 * 60 * 60 * 24 * 59;
await saveUpdatedConfigFunc?.();
console.info("finish updating local info of Box token");
};
interface CreateUploadSessionRawResponse {
id: string;
type: "upload_session";
num_parts_processed: number;
part_size: number;
session_endpoints: {
abort: string;
commit: string;
list_parts: string;
log_event: string;
status: string;
upload_part: string;
};
session_expires_at: string;
total_parts: number;
}
interface UploadChunkRawResponse {
part: {
offset: number;
part_id: string;
sha1: string;
size: number;
};
}
interface BoxEntity extends Entity {
id: string;
parentID: string | undefined;
parentIDPath: string | undefined;
isFolder: boolean;
hashSha1: string | undefined;
}
const fromBoxItemToEntity = (
boxItem: FileFullOrFolderMiniOrWebLink | FolderFull,
parentID: string,
parentFolderPath: string | undefined /* for bfs */
): BoxEntity => {
if (parentID === undefined || parentID === "" || parentID === "0") {
throw Error(`parentID=${parentID} should not be in fromBoxItemToEntity`);
}
let keyRaw = boxItem.name!;
if (
parentFolderPath !== undefined &&
parentFolderPath !== "" &&
parentFolderPath !== "/"
) {
if (!parentFolderPath.endsWith("/")) {
throw Error(
`parentFolderPath=${parentFolderPath} should not be in fromFileToBoxEntity`
);
}
keyRaw = `${parentFolderPath}${boxItem.name!}`;
}
if (boxItem.type === "folder") {
keyRaw = `${keyRaw}/`;
const mtime =
(boxItem as FolderFull).contentModifiedAt?.value.valueOf() ??
(boxItem as FolderFull).modifiedAt?.value.valueOf() ??
Date.now();
return {
key: keyRaw,
keyRaw: keyRaw,
mtimeCli: mtime,
mtimeSvr: mtime,
id: boxItem.id,
parentID: parentID,
isFolder: true,
size: 0,
sizeRaw: 0,
hash: undefined,
hashSha1: undefined,
parentIDPath: parentFolderPath,
};
} else if (boxItem.type === "file") {
const mtime =
boxItem.contentModifiedAt?.value.valueOf() ??
boxItem.modifiedAt?.value.valueOf() ??
Date.now();
return {
key: keyRaw,
keyRaw: keyRaw,
mtimeCli: mtime,
mtimeSvr: mtime,
id: boxItem.id,
parentID: parentID,
isFolder: false,
size: boxItem.size!,
sizeRaw: boxItem.size!,
hash: boxItem.sha1,
hashSha1: boxItem.sha1,
parentIDPath: parentFolderPath,
};
} else {
throw Error(`we do not support web link Box item`);
}
};
const fromRawResponseToEntity = (
boxItem: any,
parentID: string,
parentFolderPath: string | undefined /* for bfs */
): BoxEntity => {
if (parentID === undefined || parentID === "" || parentID === "0") {
throw Error(
`parentID=${parentID} should not be in fromRawResponseToEntity`
);
}
let keyRaw = boxItem.name!;
if (
parentFolderPath !== undefined &&
parentFolderPath !== "" &&
parentFolderPath !== "/"
) {
if (!parentFolderPath.endsWith("/")) {
throw Error(
`parentFolderPath=${parentFolderPath} should not be in fromFileToBoxEntity`
);
}
keyRaw = `${parentFolderPath}${boxItem.name!}`;
}
if (boxItem.type === "folder") {
keyRaw = `${keyRaw}/`;
} else if (boxItem.type === "file") {
// pass
} else {
throw Error(`we do not support web link Box item`);
}
const mtimeStr = boxItem.content_modified_at ?? boxItem.modified_at;
let mtime = Date.now();
if (mtimeStr !== undefined) {
mtime = new Date(mtimeStr).valueOf();
}
return {
key: keyRaw,
keyRaw: keyRaw,
mtimeCli: mtime,
mtimeSvr: mtime,
id: boxItem.id,
parentID: parentID,
isFolder: false,
size: boxItem.size ?? 0,
sizeRaw: boxItem.size ?? 0,
hash: boxItem.sha1 ?? undefined,
hashSha1: boxItem.sha1 ?? undefined,
parentIDPath: parentFolderPath,
};
};
export class FakeFsBox extends FakeFs {
kind: string;
boxConfig: BoxConfig;
remoteBaseDir: string;
vaultFolderExists: boolean;
saveUpdatedConfigFunc: () => Promise<any>;
keyToBoxEntity: Record<string, BoxEntity>;
baseDirID: string;
constructor(
boxConfig: BoxConfig,
vaultName: string,
saveUpdatedConfigFunc: () => Promise<any>
) {
super();
this.kind = "box";
this.boxConfig = boxConfig;
this.remoteBaseDir = this.boxConfig.remoteBaseDir || vaultName || "";
this.vaultFolderExists = false;
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
this.keyToBoxEntity = {};
this.baseDirID = "";
}
async _init() {
const access = await this._getAccessToken();
if (this.vaultFolderExists) {
// pass
} else {
const auth = new BoxDeveloperTokenAuth({ token: access });
const client = new BoxClient({ auth });
// find
let itemsInRoot: Items | undefined = undefined;
let offset = 0;
const limitPerPage = 1000; // max 1000
while (!this.vaultFolderExists) {
itemsInRoot = await client.folders.getFolderItems("0", {
queryParams: {
fields: [
"id",
"type",
"name",
"sha1",
"size",
"created_at",
"modified_at",
"expires_at",
"parent",
"content_created_at",
"content_modified_at",
"etag",
],
offset: offset,
limit: limitPerPage,
},
});
// console.debug(`this.remoteBaseDir=${this.remoteBaseDir}`);
// console.debug(`itemsInRoot:`);
// console.debug(itemsInRoot);
if (
(itemsInRoot.entries?.filter((x) => x.name === this.remoteBaseDir)
.length ?? 0) > 0
) {
// we find it!
const f = itemsInRoot.entries?.filter(
(x) => x.name === this.remoteBaseDir
)[0]!;
this.baseDirID = f.id;
this.vaultFolderExists = true;
break;
}
if ((itemsInRoot.offset ?? 0) >= (itemsInRoot.totalCount ?? 0)) {
break;
}
offset += limitPerPage;
}
if (!this.vaultFolderExists) {
// create
const f = await client.folders.createFolder({
name: this.remoteBaseDir,
parent: { id: "0" },
});
this.baseDirID = f.id;
this.vaultFolderExists = true;
}
}
}
async _getAccessToken() {
if (this.boxConfig.refreshToken === "") {
throw Error("The user has not manually auth yet.");
}
const ts = Date.now();
const comp = this.boxConfig.accessTokenExpiresAtTimeMs > ts;
// console.debug(`this.boxConfig.accessTokenExpiresAtTimeMs=${this.boxConfig.accessTokenExpiresAtTimeMs},ts=${ts},comp=${comp}`)
if (comp) {
return this.boxConfig.accessToken;
}
// refresh
const k = await sendRefreshTokenReq(this.boxConfig.refreshToken);
this.boxConfig.accessToken = k.access_token;
this.boxConfig.accessTokenExpiresInMs = k.expires_in * 1000;
this.boxConfig.accessTokenExpiresAtTimeMs =
ts + k.expires_in * 1000 - 60 * 2 * 1000;
this.boxConfig.refreshToken =
k.refresh_token || this.boxConfig.refreshToken;
await this.saveUpdatedConfigFunc();
console.info("Box accessToken updated");
return this.boxConfig.accessToken;
}
async walk(): Promise<Entity[]> {
await this._init();
const allFiles: BoxEntity[] = [];
// bfs
const queue = new PQueue({
concurrency: 5, // TODO: make it configurable?
autoStart: true,
});
queue.on("error", (error) => {
queue.pause();
queue.clear();
throw error;
});
let parents = [
{
id: this.baseDirID, // special init, from already created root folder ID
folderPath: "",
},
];
while (parents.length !== 0) {
// console.debug('enter while loop 1 of parents array');
const children: typeof parents = [];
for (const { id, folderPath } of parents) {
queue.add(async () => {
const filesUnderFolder = await this._walkFolder(id, folderPath);
for (const f of filesUnderFolder) {
allFiles.push(f);
if (f.isFolder) {
// keyRaw itself already has a tailing slash, no more slash here
// keyRaw itself also already has full path
const child = {
id: f.id,
folderPath: f.keyRaw,
};
// console.debug(
// `looping result of _walkFolder(${id},${folderPath}), adding child=${JSON.stringify(
// child
// )}`
// );
children.push(child);
}
}
});
}
await queue.onIdle();
parents = children;
}
// console.debug(`in the end of walk:`);
// console.debug(allFiles);
// console.debug(this.keyToBoxEntity);
return allFiles;
}
async _walkFolder(
parentID: string,
parentFolderPath: string
): Promise<BoxEntity[]> {
// console.debug(
// `input of single level: parentID=${parentID}, parentFolderPath=${parentFolderPath}`
// );
const filesOneLevel: BoxEntity[] = [];
const access = await this._getAccessToken();
const auth = new BoxDeveloperTokenAuth({ token: access });
const client = new BoxClient({ auth });
if (parentID === undefined || parentID === "" || parentID === "root") {
// we should never start from root
// because we encapsulate the vault inside a folder
throw Error(`something goes wrong walking folder`);
}
let items: Items | undefined = undefined;
let offset = 0;
const limitPerPage = 1000; // max 1000
do {
// console.debug(`entering paging of parentID=${parentID}, offset=${offset}`);
items = await client.folders.getFolderItems(parentID, {
queryParams: {
fields: [
"id",
"type",
"name",
"sha1",
"size",
"created_at",
"modified_at",
"expires_at",
"parent",
"content_created_at",
"content_modified_at",
"etag",
],
offset: offset,
limit: limitPerPage,
},
});
// console.debug(`items of parentID=${parentID},offset=${offset}:`);
// console.debug(items);
for (const item of items.entries ?? []) {
const entity = fromBoxItemToEntity(item, parentID, parentFolderPath);
this.keyToBoxEntity[entity.keyRaw] = entity; // build cache
filesOneLevel.push(entity);
}
offset += limitPerPage;
// console.debug(`end of current loop parentID=${parentID}, and offset=${offset}`);
} while (offset < (items?.totalCount ?? 0));
return filesOneLevel;
}
async walkPartial(): Promise<Entity[]> {
await this._init();
const filesInLevel = await this._walkFolder(this.baseDirID, "");
return filesInLevel;
}
async stat(key: string): Promise<Entity> {
await this._init();
// TODO: we already have a cache, should we call again?
const cachedEntity = this.keyToBoxEntity[key];
const fileID = cachedEntity?.id;
if (cachedEntity === undefined || fileID === undefined) {
throw Error(`no fileID found for key=${key}`);
}
const access = await this._getAccessToken();
const auth = new BoxDeveloperTokenAuth({ token: access });
const client = new BoxClient({ auth });
let f: FileFull | FolderFull | undefined;
if (cachedEntity.isFolder) {
f = await client.folders.getFolderById(fileID);
} else {
f = await client.files.getFileById(fileID);
}
const entity = fromBoxItemToEntity(
f,
cachedEntity.parentID!,
cachedEntity.parentIDPath!
);
// insert back to cache?? to update it??
this.keyToBoxEntity[key] = entity;
return entity;
}
async mkdir(
key: string,
mtime?: number | undefined,
ctime?: number | undefined
): Promise<Entity> {
if (!key.endsWith("/")) {
throw Error(`you should not mkdir on key=${key}`);
}
await this._init();
const cachedEntity = this.keyToBoxEntity[key];
const fileID = cachedEntity?.id;
if (cachedEntity !== undefined && fileID !== undefined) {
return cachedEntity;
}
// xxx/ => ["xxx"]
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"]
const folderLevels = getFolderLevels(key);
let parentFolderPath: string | undefined = undefined;
let parentID: string | undefined = undefined;
if (folderLevels.length === 0) {
throw Error(`cannot getFolderLevels of ${key}`);
} else if (folderLevels.length === 1) {
parentID = this.baseDirID;
parentFolderPath = ""; // ignore base dir
} else {
// length > 1
parentFolderPath = `${folderLevels[folderLevels.length - 2]}/`;
if (!(parentFolderPath in this.keyToBoxEntity)) {
throw Error(
`parent of ${key}: ${parentFolderPath} is not created before??`
);
}
parentID = this.keyToBoxEntity[parentFolderPath].id;
}
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"] => "xxx/yyy/zzz" => "zzz"
let folderItselfWithoutSlash = folderLevels[folderLevels.length - 1];
folderItselfWithoutSlash = folderItselfWithoutSlash.split("/").pop()!;
const access = await this._getAccessToken();
const auth = new BoxDeveloperTokenAuth({ token: access });
const client = new BoxClient({ auth });
const f = await client.folders.createFolder({
name: folderItselfWithoutSlash,
parent: { id: parentID },
});
const entity = fromBoxItemToEntity(f, parentID, parentFolderPath);
// insert into cache
this.keyToBoxEntity[key] = entity;
return entity;
}
async writeFile(
key: string,
content: ArrayBuffer,
mtime: number,
ctime: number
): Promise<Entity> {
if (key.endsWith("/")) {
throw Error(`should not call writeFile on ${key}`);
}
await this._init();
const prevCachedEntity: BoxEntity | undefined = this.keyToBoxEntity[key];
const prevFileID: string | undefined = prevCachedEntity?.id;
const contentType =
mime.contentType(mime.lookup(key) || DEFAULT_CONTENT_TYPE) ||
DEFAULT_CONTENT_TYPE;
let parentID: string | undefined = undefined;
let parentFolderPath: string | undefined = undefined;
// "xxx" => []
// "xxx/yyy/zzz.md" => ["xxx", "xxx/yyy"]
const folderLevels = getFolderLevels(key);
if (folderLevels.length === 0) {
// root
parentID = this.baseDirID;
parentFolderPath = "";
} else {
parentFolderPath = `${folderLevels[folderLevels.length - 1]}/`;
if (!(parentFolderPath in this.keyToBoxEntity)) {
throw Error(
`parent of ${key}: ${parentFolderPath} is not created before??`
);
}
parentID = this.keyToBoxEntity[parentFolderPath].id;
}
const fileItself = key.split("/").pop()!;
const BIG_FILE_THRESHOLD = 20000000; // box api hard coded...
if (content.byteLength <= BIG_FILE_THRESHOLD) {
const formData = new FormData();
const attributes = {
name: fileItself,
parent: { id: parentID },
content_created_at: unixTimeToStr(ctime),
content_modified_at: unixTimeToStr(mtime),
};
formData.append("attributes", JSON.stringify(attributes));
formData.append("file", new Blob([content], { type: contentType }));
let url = "";
if (prevFileID === undefined) {
// create new file
// https://developer.box.com/reference/post-files-content/
url = `https://upload.box.com/api/2.0/files/content`;
} else {
// update new file
// https://developer.box.com/reference/post-files-id-content/
url = `https://upload.box.com/api/2.0/files/${prevFileID}/content`;
}
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
},
body: formData,
});
if (res.status !== 200 && res.status !== 201) {
throw Error(
`create file ${key} failed! attributes=${JSON.stringify(attributes)}`
);
}
const res2 = await res.json();
if (res2.entries === undefined) {
throw Error(`upload small file ${key} failed!`);
}
const entity = fromRawResponseToEntity(
res2.entries[0],
parentID,
parentFolderPath
);
this.keyToBoxEntity[key] = entity;
// console.debug(`entity after upload=${JSON.stringify(entity, null, 2)}`);
return entity;
} else {
// create session
let url = "";
if (prevFileID === undefined) {
// https://developer.box.com/reference/post-files-upload-sessions/
url = "https://upload.box.com/api/2.0/files/upload_sessions";
} else {
// https://developer.box.com/reference/post-files-id-upload-sessions/
url = `https://upload.box.com/api/2.0/files/${prevFileID}/upload_sessions`;
}
const sessionRes1 = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
file_name: fileItself,
file_size: content.byteLength,
folder_id: parentID,
}),
});
if (sessionRes1.status !== 200 && sessionRes1.status !== 201) {
throw Error(
`Create upload session for ${key} failed! Response header=${JSON.stringify(
sessionRes1.headers
)}`
);
}
const sessionRes2: CreateUploadSessionRawResponse =
await sessionRes1.json();
// console.debug(sessionRes2);
// upload by chunks
const sizePerChunk = sessionRes2.part_size;
const chunkRanges = splitFileSizeToChunkRanges(
content.byteLength,
sizePerChunk
);
// TODO: parallel
const partsResult: UploadChunkRawResponse[] = [];
for (const { start, end } of chunkRanges) {
const subContent = content.slice(start, end + 1);
const sha1 = await getSha1(subContent, "base64");
const res = await fetch(sessionRes2.session_endpoints.upload_part, {
method: "PUT",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
// "Content-Length": `${end - start + 1}`, // the number of bytes in the current chunk
"Content-Range": `bytes ${start}-${end}/${content.byteLength}`,
"Content-Type": "application/octet-stream",
digest: `sha=${sha1}`,
},
body: subContent,
});
if (res.status !== 200 && res.status !== 201) {
throw Error(
`Upload chunk for ${key}, ${start}-${end} failed! Response header=${JSON.stringify(
res.headers
)}`
);
}
partsResult.push((await res.json()) as UploadChunkRawResponse);
}
// commit?
const sha1 = await getSha1(content, "base64");
let status = 202;
let tries = 0;
do {
// console.debug(`begin commit key=${key} for tries=${tries}`)
const commitRes1 = await fetch(sessionRes2.session_endpoints.commit, {
method: "POST",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
"Content-Type": "application/json",
digest: `sha=${sha1}`,
},
body: JSON.stringify({
parts: partsResult.map((p) => p.part),
attributes: {
content_modified_at: unixTimeToStr(mtime, false),
content_created_at: unixTimeToStr(ctime, false),
},
}),
});
status = commitRes1.status;
// console.debug(`status===${status} for tries=${tries},key=${key}`)
if (status === 200 || status === 201) {
const commitRes2 = await commitRes1.json();
if (commitRes2.entries === undefined) {
throw Error(`Upload big file ${key} failed!`);
}
const entity = fromRawResponseToEntity(
commitRes2.entries[0],
parentID,
parentFolderPath
);
this.keyToBoxEntity[key] = entity;
// console.debug(
// `entity after upload=${JSON.stringify(entity, null, 2)}`
// );
return entity;
} else if (status === 202) {
await delay(500);
tries += 1;
} else {
throw Error(
`Commit all chunks for ${key} failed! Response header=${JSON.stringify(
commitRes1.headers
)}`
);
}
// console.debug(`end commit key=${key}, currently status===${status}, tries===${tries} for next loop`)
} while (status === 202 && tries < 4);
throw Error(`Commit all chunks for ${key} failed! No idea what happened`);
}
}
async readFile(key: string): Promise<ArrayBuffer> {
await this._init();
const cachedEntity = this.keyToBoxEntity[key];
const fileID = cachedEntity?.id;
if (cachedEntity === undefined || fileID === undefined) {
throw Error(`no fileID found for key=${key}`);
}
const res1 = await fetch(
`https://api.box.com/2.0/files/${fileID}/content`,
{
method: "GET",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
},
}
);
if (res1.status !== 200) {
throw Error(
`Cannot download file ${key} with id ${fileID}. Response header=${JSON.stringify(
res1.headers
)}`
);
}
const res2 = await res1.arrayBuffer();
return res2;
}
async rename(key1: string, key2: string): Promise<void> {
throw new Error("Method not implemented.");
}
async rm(key: string): Promise<void> {
await this._init();
const cachedEntity = this.keyToBoxEntity[key];
const fileID = cachedEntity?.id;
if (cachedEntity === undefined || fileID === undefined) {
throw Error(`no fileID found for key=${key}`);
}
const access = await this._getAccessToken();
const auth = new BoxDeveloperTokenAuth({ token: access });
const client = new BoxClient({ auth });
if (cachedEntity.isFolder) {
await client.folders.deleteFolderById(fileID, {
queryParams: { recursive: true },
});
} else {
await client.files.deleteFileById(fileID);
}
}
async checkConnect(callbackFunc?: any): Promise<boolean> {
// if we can init, we can connect
try {
await this._init();
return true;
} catch (err) {
console.debug(err);
callbackFunc?.(err);
return false;
}
}
async getUserDisplayName(): Promise<string> {
throw new Error("Method not implemented.");
}
/**
* https://developer.box.com/guides/authentication/tokens/revoke/
*/
async revokeAuth(): Promise<any> {
await fetch(`https://api.box.com/oauth2/revoke`, {
method: "POST",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
},
body: new URLSearchParams({
client_id: BOX_CLIENT_ID ?? "",
client_secret: BOX_CLIENT_SECRET ?? "",
token: this.boxConfig.refreshToken,
}).toString(),
});
}
allowEmptyFile(): boolean {
return true;
}
}
+766
View File
@@ -0,0 +1,766 @@
// https://developers.google.com/identity/protocols/oauth2/native-app
// https://developers.google.com/identity/protocols/oauth2/javascript-implicit-flow
// https://developers.google.com/identity/protocols/oauth2/web-server
import { entries } from "lodash";
import * as mime from "mime-types";
import { requestUrl } from "obsidian";
import PQueue from "p-queue";
import { DEFAULT_CONTENT_TYPE, type Entity } from "../../src/baseTypes";
import { FakeFs } from "../../src/fsAll";
import {
getFolderLevels,
splitFileSizeToChunkRanges,
unixTimeToStr,
} from "../../src/misc";
import {
DEFAULT_GOOGLEDRIVE_CLIENT_ID,
DEFAULT_GOOGLEDRIVE_CLIENT_SECRET,
type GoogleDriveConfig,
} from "./baseTypesPro";
export const DEFAULT_GOOGLEDRIVE_CONFIG: GoogleDriveConfig = {
accessToken: "",
refreshToken: "",
accessTokenExpiresInMs: 0,
accessTokenExpiresAtTimeMs: 0,
credentialsShouldBeDeletedAtTimeMs: 0,
scope: "https://www.googleapis.com/auth/drive.file",
kind: "googledrive",
};
const FOLDER_MIME_TYPE = "application/vnd.google-apps.folder";
/**
* A simplified version of the type
*
*/
interface File {
kind?: string;
driveId?: string;
fileExtension?: string;
copyRequiresWriterPermission?: boolean;
md5Checksum?: string;
writersCanShare?: boolean;
viewedByMe?: boolean;
mimeType?: string;
parents?: string[];
thumbnailLink?: string;
iconLink?: string;
shared?: boolean;
headRevisionId?: string;
webViewLink?: string;
webContentLink?: string;
size?: string;
viewersCanCopyContent?: boolean;
hasThumbnail?: boolean;
spaces?: string[];
folderColorRgb?: string;
id?: string;
name?: string;
description?: string;
starred?: boolean;
trashed?: boolean;
explicitlyTrashed?: boolean;
createdTime?: string;
modifiedTime?: string;
modifiedByMeTime?: string;
viewedByMeTime?: string;
sharedWithMeTime?: string;
quotaBytesUsed?: string;
version?: string;
originalFilename?: string;
ownedByMe?: boolean;
fullFileExtension?: string;
isAppAuthorized?: boolean;
teamDriveId?: string;
hasAugmentedPermissions?: boolean;
thumbnailVersion?: string;
trashedTime?: string;
modifiedByMe?: boolean;
permissionIds?: string[];
resourceKey?: string;
sha1Checksum?: string;
sha256Checksum?: string;
}
interface GDEntity extends Entity {
id: string;
parentID: string | undefined;
parentIDPath: string | undefined;
isFolder: boolean;
}
/**
* https://developers.google.com/identity/protocols/oauth2/web-server#httprest_7
* @param refreshToken
*/
export const sendRefreshTokenReq = async (refreshToken: string) => {
console.debug(`refreshing token`);
const x = await fetch("https://oauth2.googleapis.com/token", {
method: "POST",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
},
body: new URLSearchParams({
client_id: DEFAULT_GOOGLEDRIVE_CLIENT_ID ?? "",
client_secret: DEFAULT_GOOGLEDRIVE_CLIENT_SECRET ?? "",
grant_type: "refresh_token",
refresh_token: refreshToken,
}).toString(),
});
if (x.status === 200) {
const y = await x.json();
console.debug(`new token obtained`);
return y;
} else {
throw Error(`cannot refresh an access token`);
}
// {
// "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
// "expires_in": 3920,
// "scope": "https://www.googleapis.com/auth/drive.file",
// "token_type": "Bearer"
// }
};
const fromFileToGDEntity = (
file: File,
parentID: string,
parentFolderPath: string | undefined /* for bfs */
) => {
if (parentID === undefined || parentID === "" || parentID === "root") {
throw Error(`parentID=${parentID} should not be in fromFileToGDEntity`);
}
let keyRaw = file.name!;
if (
parentFolderPath !== undefined &&
parentFolderPath !== "" &&
parentFolderPath !== "/"
) {
if (!parentFolderPath.endsWith("/")) {
throw Error(
`parentFolderPath=${parentFolderPath} should not be in fromFileToGDEntity`
);
}
keyRaw = `${parentFolderPath}${file.name}`;
}
const isFolder = file.mimeType === FOLDER_MIME_TYPE;
if (isFolder) {
keyRaw = `${keyRaw}/`;
}
return {
key: keyRaw,
keyRaw: keyRaw,
mtimeCli: Date.parse(file.modifiedTime!),
mtimeSvr: Date.parse(file.modifiedTime!),
size: isFolder ? 0 : Number.parseInt(file.size!),
sizeRaw: isFolder ? 0 : Number.parseInt(file.size!),
hash: isFolder ? undefined : file.md5Checksum!,
id: file.id!,
parentID: parentID,
isFolder: isFolder,
} as GDEntity;
};
export class FakeFsGoogleDrive extends FakeFs {
kind: string;
googleDriveConfig: GoogleDriveConfig;
remoteBaseDir: string;
vaultFolderExists: boolean;
saveUpdatedConfigFunc: () => Promise<any>;
keyToGDEntity: Record<string, GDEntity>;
baseDirID: string;
constructor(
googleDriveConfig: GoogleDriveConfig,
vaultName: string,
saveUpdatedConfigFunc: () => Promise<any>
) {
super();
this.kind = "googledrive";
this.googleDriveConfig = googleDriveConfig;
this.remoteBaseDir =
this.googleDriveConfig.remoteBaseDir || vaultName || "";
this.vaultFolderExists = false;
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
this.keyToGDEntity = {};
this.baseDirID = "";
}
async _init() {
// get accessToken
await this._getAccessToken();
// check vault folder exists
if (this.vaultFolderExists) {
// pass
} else {
const q = encodeURIComponent(
`name='${this.remoteBaseDir}' and mimeType='application/vnd.google-apps.folder' and trashed=false`
);
const url: string = `https://www.googleapis.com/drive/v3/files?q=${q}&pageSize=1000&fields=kind,nextPageToken,files(kind,fileExtension,md5Checksum,mimeType,parents,size,spaces,id,name,trashed,createdTime,modifiedTime,quotaBytesUsed,originalFilename,fullFileExtension,sha1Checksum,sha256Checksum)`;
const k = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
},
});
const k1: { files: File[] } = await k.json();
// console.debug(k1);
if (k1.files.length > 0) {
// yeah we find it
this.baseDirID = k1.files[0].id!;
this.vaultFolderExists = true;
} else {
// wait, we need to create the folder!
console.debug(`we need to create the base dir ${this.remoteBaseDir}`);
const meta: any = {
mimeType: FOLDER_MIME_TYPE,
name: this.remoteBaseDir,
};
const res = await fetch("https://www.googleapis.com/drive/v3/files", {
method: "POST",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
"Content-Type": "application/json",
},
body: JSON.stringify(meta),
});
const res2: File = await res.json();
if (res.status === 200) {
console.debug(`succeed to create the base dir ${this.remoteBaseDir}`);
this.baseDirID = res2.id!;
this.vaultFolderExists = true;
} else {
throw Error(
`cannot create base dir ${this.remoteBaseDir} in init func.`
);
}
}
}
}
async _getAccessToken() {
if (
this.googleDriveConfig.accessToken === "" ||
this.googleDriveConfig.refreshToken === ""
) {
throw Error("The user has not manually auth yet.");
}
const ts = Date.now();
if (this.googleDriveConfig.accessTokenExpiresAtTimeMs > ts) {
return this.googleDriveConfig.accessToken;
}
// refresh
const k = await sendRefreshTokenReq(this.googleDriveConfig.refreshToken);
this.googleDriveConfig.accessToken = k.access_token;
this.googleDriveConfig.accessTokenExpiresInMs = k.expires_in * 1000;
this.googleDriveConfig.accessTokenExpiresAtTimeMs =
ts + k.expires_in * 1000 - 60 * 2 * 1000;
await this.saveUpdatedConfigFunc();
console.info("Google Drive accessToken updated");
return this.googleDriveConfig.accessToken;
}
/**
* https://developers.google.com/drive/api/reference/rest/v3/files/list
*/
async walk(): Promise<Entity[]> {
await this._init();
const allFiles: GDEntity[] = [];
// bfs
const queue = new PQueue({
concurrency: 5, // TODO: make it configurable?
autoStart: true,
});
queue.on("error", (error) => {
queue.pause();
queue.clear();
throw error;
});
let parents = [
{
id: this.baseDirID, // special init, from already created root folder ID
folderPath: "",
},
];
while (parents.length !== 0) {
const children: typeof parents = [];
for (const { id, folderPath } of parents) {
queue.add(async () => {
const filesUnderFolder = await this._walkFolder(id, folderPath);
for (const f of filesUnderFolder) {
allFiles.push(f);
if (f.isFolder) {
// keyRaw itself already has a tailing slash, no more slash here
// keyRaw itself also already has full path
const child = {
id: f.id,
folderPath: f.keyRaw,
};
// console.debug(
// `looping result of _walkFolder(${id},${folderPath}), adding child=${JSON.stringify(
// child
// )}`
// );
children.push(child);
}
}
});
}
await queue.onIdle();
parents = children;
}
// console.debug(`in the end of walk:`);
// console.debug(allFiles);
// console.debug(this.keyToGDEntity);
return allFiles;
}
async _walkFolder(parentID: string, parentFolderPath: string) {
// console.debug(
// `input of single level: parentID=${parentID}, parentFolderPath=${parentFolderPath}`
// );
const filesOneLevel: GDEntity[] = [];
let nextPageToken: string | undefined = undefined;
if (parentID === undefined || parentID === "" || parentID === "root") {
// we should never start from root
// because we encapsulate the vault inside a folder
throw Error(`something goes wrong walking folder`);
}
do {
const q = encodeURIComponent(
`'${parentID}' in parents and trashed=false`
);
const pageToken =
nextPageToken !== undefined ? `&pageToken=${nextPageToken}` : "";
const url: string = `https://www.googleapis.com/drive/v3/files?q=${q}&pageSize=1000&fields=kind,nextPageToken,files(kind,fileExtension,md5Checksum,mimeType,parents,size,spaces,id,name,trashed,createdTime,modifiedTime,quotaBytesUsed,originalFilename,fullFileExtension,sha1Checksum,sha256Checksum)${pageToken}`;
const k = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
},
});
if (k.status !== 200) {
throw Error(`cannot walk for parentID=${parentID}`);
}
const k1 = await k.json();
// console.debug(k1);
for (const file of k1.files as File[]) {
const entity = fromFileToGDEntity(file, parentID, parentFolderPath);
this.keyToGDEntity[entity.keyRaw] = entity; // build cache
filesOneLevel.push(entity);
}
nextPageToken = k1.nextPageToken;
} while (nextPageToken !== undefined);
// console.debug(filesOneLevel);
return filesOneLevel;
}
async walkPartial(): Promise<Entity[]> {
await this._init();
const filesInLevel = await this._walkFolder(this.baseDirID, "");
return filesInLevel;
}
/**
* https://developers.google.com/drive/api/reference/rest/v3/files/get
* https://developers.google.com/drive/api/guides/fields-parameter
*/
async stat(key: string): Promise<Entity> {
await this._init();
// TODO: we already have a cache, should we call again?
const cachedEntity = this.keyToGDEntity[key];
const fileID = cachedEntity?.id;
if (cachedEntity === undefined || fileID === undefined) {
throw Error(`no fileID found for key=${key}`);
}
const url: string = `https://www.googleapis.com/drive/v3/files/${fileID}?fields=kind,fileExtension,md5Checksum,mimeType,parents,size,spaces,id,name,trashed,createdTime,modifiedTime,quotaBytesUsed,originalFilename,fullFileExtension,sha1Checksum,sha256Checksum`;
const k = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
},
});
if (k.status !== 200) {
throw Error(`cannot get file meta fileID=${fileID}, key=${key}`);
}
const k1: File = await k.json();
const entity = fromFileToGDEntity(
k1,
cachedEntity.parentID!,
cachedEntity.parentIDPath!
);
// insert back to cache?? to update it??
this.keyToGDEntity[key] = entity;
return entity;
}
/**
* https://developers.google.com/drive/api/guides/folder
*/
async mkdir(
key: string,
mtime: number | undefined,
ctime: number | undefined
): Promise<Entity> {
if (!key.endsWith("/")) {
throw Error(`you should not mkdir on key=${key}`);
}
await this._init();
// xxx/ => ["xxx"]
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"]
const folderLevels = getFolderLevels(key);
let parentFolderPath: string | undefined = undefined;
let parentID: string | undefined = undefined;
if (folderLevels.length === 0) {
throw Error(`cannot getFolderLevels of ${key}`);
} else if (folderLevels.length === 1) {
parentID = this.baseDirID;
parentFolderPath = ""; // ignore base dir
} else {
// length > 1
parentFolderPath = `${folderLevels[folderLevels.length - 2]}/`;
if (!(parentFolderPath in this.keyToGDEntity)) {
throw Error(
`parent of ${key}: ${parentFolderPath} is not created before??`
);
}
parentID = this.keyToGDEntity[parentFolderPath].id;
}
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"] => "xxx/yyy/zzz" => "zzz"
let folderItselfWithoutSlash = folderLevels[folderLevels.length - 1];
folderItselfWithoutSlash = folderItselfWithoutSlash.split("/").pop()!;
const meta: any = {
mimeType: FOLDER_MIME_TYPE,
modifiedTime: unixTimeToStr(mtime, true),
createdTime: unixTimeToStr(ctime, true),
name: folderItselfWithoutSlash,
parents: [parentID],
};
const res = await fetch("https://www.googleapis.com/drive/v3/files", {
method: "POST",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
"Content-Type": "application/json",
},
body: JSON.stringify(meta),
});
if (res.status !== 200 && res.status !== 201) {
throw Error(`create folder ${key} failed! meta=${JSON.stringify(meta)}`);
}
const res2: File = await res.json();
// console.debug(res2);
const entity = fromFileToGDEntity(res2, parentID, parentFolderPath);
// insert into cache
this.keyToGDEntity[key] = entity;
return entity;
}
/**
* https://developers.google.com/drive/api/guides/manage-uploads
* https://stackoverflow.com/questions/65181932/how-i-can-upload-file-to-google-drive-with-google-drive-api
*/
async writeFile(
key: string,
content: ArrayBuffer,
mtime: number,
ctime: number
): Promise<Entity> {
if (key.endsWith("/")) {
throw Error(`should not call writeFile on ${key}`);
}
await this._init();
const contentType =
mime.contentType(mime.lookup(key) || DEFAULT_CONTENT_TYPE) ||
DEFAULT_CONTENT_TYPE;
let parentID: string | undefined = undefined;
let parentFolderPath: string | undefined = undefined;
// "xxx" => []
// "xxx/yyy/zzz.md" => ["xxx", "xxx/yyy"]
const folderLevels = getFolderLevels(key);
if (folderLevels.length === 0) {
// root
parentID = this.baseDirID;
parentFolderPath = "";
} else {
parentFolderPath = `${folderLevels[folderLevels.length - 1]}/`;
if (!(parentFolderPath in this.keyToGDEntity)) {
throw Error(
`parent of ${key}: ${parentFolderPath} is not created before??`
);
}
parentID = this.keyToGDEntity[parentFolderPath].id;
}
const fileItself = key.split("/").pop()!;
if (content.byteLength <= 5 * 1024 * 1024) {
const formData = new FormData();
const meta: any = {
name: fileItself,
modifiedTime: unixTimeToStr(mtime, true),
createdTime: unixTimeToStr(ctime, true),
parents: [parentID],
};
formData.append(
"metadata",
new Blob([JSON.stringify(meta)], {
type: "application/json; charset=UTF-8",
})
);
formData.append("media", new Blob([content], { type: contentType }));
const res = await fetch(
"https://www.googleapis.com/upload/drive/v3/files?uploadType=multipart&fields=kind,fileExtension,md5Checksum,mimeType,parents,size,spaces,id,name,trashed,createdTime,modifiedTime,quotaBytesUsed,originalFilename,fullFileExtension,sha1Checksum,sha256Checksum",
{
method: "POST",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
},
body: formData,
}
);
if (res.status !== 200 && res.status !== 201) {
throw Error(`create file ${key} failed! meta=${JSON.stringify(meta)}`);
}
const res2: File = await res.json();
console.debug(
`upload ${key} with ${JSON.stringify(meta)}, res2=${JSON.stringify(
res2
)}`
);
const entity = fromFileToGDEntity(res2, parentID, parentFolderPath);
// insert into cache
this.keyToGDEntity[key] = entity;
return entity;
} else {
const meta: any = {
name: fileItself,
modifiedTime: unixTimeToStr(mtime, true),
createdTime: unixTimeToStr(ctime, true),
parents: [parentID],
};
const bodyStr = JSON.stringify(meta);
const headers: HeadersInit = {
Authorization: `Bearer ${await this._getAccessToken()}`,
"Content-Type": "application/json",
"Content-Length": `${bodyStr.length}`,
"X-Upload-Content-Type": contentType,
"X-Upload-Content-Length": `${content.byteLength}`,
};
const res = await fetch(
"https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable&fields=kind,fileExtension,md5Checksum,mimeType,parents,size,spaces,id,name,trashed,createdTime,modifiedTime,quotaBytesUsed,originalFilename,fullFileExtension,sha1Checksum,sha256Checksum",
{
method: "POST",
headers: headers,
body: bodyStr,
}
);
if (res.status !== 200) {
throw Error(
`create resumable file ${key} failed! meta=${JSON.stringify(
meta
)}, header=${JSON.stringify(headers)}`
);
}
const uploadLocation = res.headers.get("Location");
if (uploadLocation === null || !uploadLocation.startsWith("http")) {
throw Error(
`create resumable file ${key} failed! meta=${JSON.stringify(
meta
)}, header=${JSON.stringify(headers)}`
);
}
console.debug(`key=${key}, uploadLocaltion=${uploadLocation}`);
// multiples of 256 KB (256 x 1024 bytes) in size
const sizePerChunk = 5 * 4 * 256 * 1024; // 5.24 mb
const chunkRanges = splitFileSizeToChunkRanges(
content.byteLength,
sizePerChunk
);
let entity: GDEntity | undefined = undefined;
// TODO: deal with "Resume an interrupted upload"
// currently (202405) only assume everything goes well...
// TODO: parallel
for (const { start, end } of chunkRanges) {
console.debug(
`key=${key}, start upload chunk ${start}-${end}/${content.byteLength}`
);
const res = await fetch(uploadLocation, {
method: "PUT",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
"Content-Length": `${end - start + 1}`, // the number of bytes in the current chunk
"Content-Range": `bytes ${start}-${end}/${content.byteLength}`,
},
body: content.slice(start, end + 1), // TODO: slice() is a copy, may be we can optimize it
});
if (res.status >= 400 && res.status <= 599) {
throw Error(
`create resumable file ${key} failed! meta=${JSON.stringify(
meta
)}, header=${JSON.stringify(headers)}`
);
}
if (res.status === 200 || res.status === 201) {
const res2: File = await res.json();
console.debug(
`upload ${key} with ${JSON.stringify(meta)}, res2=${JSON.stringify(
res2
)}`
);
if (res2.id === undefined || res2.id === null || res2.id === "") {
// TODO: what's this??
} else {
entity = fromFileToGDEntity(res2, parentID, parentFolderPath);
// insert into cache
this.keyToGDEntity[key] = entity;
}
}
}
if (entity === undefined) {
throw Error(`something goes wrong while uploading large file ${key}`);
}
return entity;
}
}
/**
* https://developers.google.com/drive/api/reference/rest/v3/files/get
*/
async readFile(key: string): Promise<ArrayBuffer> {
if (key.endsWith("/")) {
throw Error(`you should not call readFile on ${key}`);
}
await this._init();
const fileID = this.keyToGDEntity[key]?.id;
if (fileID === undefined) {
throw Error(`no fileID found for key=${key}`);
}
const res1 = await fetch(
`https://www.googleapis.com/drive/v3/files/${fileID}?alt=media`,
{
method: "GET",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
},
}
);
if (res1.status !== 200) {
throw Error(`cannot download ${key} using fileID=${fileID}`);
}
const res2 = await res1.arrayBuffer();
return res2;
}
async rename(key1: string, key2: string): Promise<void> {
throw new Error("Method not implemented.");
}
/**
* https://developers.google.com/drive/api/guides/delete
* https://developers.google.com/drive/api/reference/rest/v3/files/update
*/
async rm(key: string): Promise<void> {
await this._init();
const fileID = this.keyToGDEntity[key]?.id;
if (fileID === undefined) {
throw Error(`no fileID found for key=${key}`);
}
const res1 = await fetch(
`https://www.googleapis.com/drive/v3/files/${fileID}`,
{
method: "PATCH",
headers: {
Authorization: `Bearer ${await this._getAccessToken()}`,
},
body: JSON.stringify({
trashed: true,
}),
}
);
if (res1.status !== 200) {
throw Error(`cannot rm ${key} using fileID=${fileID}`);
}
}
async checkConnect(callbackFunc?: any): Promise<boolean> {
// if we can init, we can connect
try {
await this._init();
return true;
} catch (err) {
console.debug(err);
callbackFunc?.(err);
return false;
}
}
async getUserDisplayName(): Promise<string> {
throw new Error("Method not implemented.");
}
/**
* https://developers.google.com/identity/protocols/oauth2/web-server#tokenrevoke
*/
async revokeAuth(): Promise<any> {
const x = await fetch(
`https://oauth2.googleapis.com/revoke?token=${this._getAccessToken()}`,
{
method: "POST",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
},
}
);
if (x.status === 200) {
return true;
} else {
throw Error(`cannot revoke`);
}
}
allowEmptyFile(): boolean {
return true;
}
}
+577
View File
@@ -0,0 +1,577 @@
import { nanoid } from "nanoid";
import createClient, { type Middleware } from "openapi-fetch";
import { base64 } from "rfc4648";
import type { Entity } from "../../src/baseTypes";
import { FakeFs } from "../../src/fsAll";
import { getParentFolder } from "../../src/misc";
import {
COMMAND_CALLBACK_KOOFR,
KOOFR_CLIENT_ID,
KOOFR_CLIENT_SECRET,
type KoofrConfig,
} from "./baseTypesPro";
import type { paths } from "./koofrApi";
import type { components } from "./koofrApi";
type FilesListRecursiveItem = components["schemas"]["FilesListRecursiveItem"];
type FilesFile = components["schemas"]["FilesFile"];
export const DEFAULT_KOOFR_CONFIG: KoofrConfig = {
accessToken: "",
accessTokenExpiresInMs: 0,
accessTokenExpiresAtTimeMs: 0,
refreshToken: "",
remoteBaseDir: "",
credentialsShouldBeDeletedAtTimeMs: 0,
scope: "",
api: "https://app.koofr.net",
mountID: "",
kind: "koofr",
};
/**
* https://app.koofr.net/developers
*/
export const generateAuthUrl = (apiAddr: string, hasCallback: boolean) => {
let callback = `urn:ietf:wg:oauth:2.0:oob`;
if (hasCallback) {
callback = `obsidian://${COMMAND_CALLBACK_KOOFR}`;
}
const params = new URLSearchParams({
response_type: "code",
client_id: KOOFR_CLIENT_ID ?? "",
redirect_uri: callback,
scope: "public",
state: nanoid(),
});
const url = `${apiAddr}/oauth2/auth?${params}`;
return url;
};
interface AuthResSucc {
token_type: "Bearer";
access_token: string;
expires_in: number;
refresh_token: string;
scope: string | undefined;
}
interface AuthResFail {
error: string;
error_description: string;
}
/**
* https://app.koofr.net/developers
*/
export const sendAuthReq = async (
apiAddr: string,
authCode: string,
errorCallBack: any,
hasCallback: boolean
) => {
let callback = `urn:ietf:wg:oauth:2.0:oob`;
if (hasCallback) {
callback = `obsidian://${COMMAND_CALLBACK_KOOFR}`;
}
try {
const k = {
code: authCode,
grant_type: "authorization_code",
client_id: KOOFR_CLIENT_ID ?? "",
client_secret: KOOFR_CLIENT_SECRET ?? "",
redirect_uri: callback,
};
// console.debug(k);
const resp1 = await fetch(`${apiAddr}/oauth2/token`, {
method: "POST",
body: new URLSearchParams(k),
});
if (resp1.status !== 200) {
const resp2: AuthResFail = await resp1.json();
throw Error(JSON.stringify(resp2));
}
const resp2: AuthResSucc = await resp1.json();
return resp2;
} catch (e) {
console.error(e);
if (errorCallBack !== undefined) {
await errorCallBack(e);
}
}
};
export const sendRefreshTokenReq = async (
apiAddr: string,
refreshToken: string
) => {
console.debug(`refreshing token`);
const x = await fetch(`${apiAddr}/oauth2/token`, {
method: "POST",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
},
body: new URLSearchParams({
client_id: KOOFR_CLIENT_ID ?? "",
client_secret: KOOFR_CLIENT_SECRET ?? "",
grant_type: "refresh_token",
refresh_token: refreshToken,
}).toString(),
});
if (x.status === 200) {
const y: AuthResSucc = await x.json();
console.debug(`new token obtained`);
return y;
} else {
const y: AuthResFail = await x.json();
throw Error(`cannot refresh an access token: ${JSON.stringify(y)}`);
}
};
export const setConfigBySuccessfullAuthInplace = async (
config: KoofrConfig,
authRes: AuthResSucc,
saveUpdatedConfigFunc: () => Promise<any> | undefined
) => {
if (authRes.access_token === undefined || authRes.access_token === "") {
throw Error(
`you should not save the setting for ${JSON.stringify(authRes)}`
);
}
config.accessToken = authRes.access_token;
config.accessTokenExpiresAtTimeMs =
Date.now() + authRes.expires_in * 1000 - 5 * 60 * 1000;
config.accessTokenExpiresInMs = authRes.expires_in * 1000;
config.refreshToken = authRes.refresh_token || config.refreshToken;
config.scope = authRes.scope || config.scope;
// manually set it expired after 60 days;
config.credentialsShouldBeDeletedAtTimeMs =
Date.now() + 1000 * 60 * 60 * 24 * 59;
await saveUpdatedConfigFunc?.();
console.info("finish updating local info of Koofr token");
};
const getNormPathFromBasedir = (x: string, type: "dir" | "file") => {
if (x === "/" || x === "") {
throw Error(`do not know how to deal with path: ${x}`);
}
if (!x.startsWith("/")) {
throw Error(`path returned by koofr should starts with slash: ${x}`);
}
if (type === "file") {
return x.slice(1);
} else if (type === "dir") {
return `${x.slice(1)}/`;
} else {
throw Error(`do not know how to deal with path and type: ${x}, ${type}`);
}
};
const getKoofrPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
let key = fileOrFolderPath;
if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
// special
key = `/${remoteBaseDir}`;
} else if (fileOrFolderPath.startsWith("/")) {
console.warn(
`why the path ${fileOrFolderPath} starts with '/'? but we just go on.`
);
key = `/${remoteBaseDir}${fileOrFolderPath}`;
} else {
key = `/${remoteBaseDir}/${fileOrFolderPath}`;
}
if (key.endsWith("/")) {
key = key.slice(0, key.length - 1);
}
return key;
};
const fromItemToEntity = (x: FilesListRecursiveItem): Entity => {
if (x.type === "error") {
throw Error(`cannot understand ${JSON.stringify(x)}`);
}
const key = getNormPathFromBasedir(x.path ?? "/", x.file?.type as any);
if (x.file?.type === "dir" || x.file?.type === "file") {
return {
key: key,
keyRaw: key,
mtimeCli: x.file.modified,
mtimeSvr: x.file.modified,
size: x.file.size,
sizeRaw: x.file.size,
hash: x.file.hash,
} as Entity;
} else {
throw Error(`cannot understand ${JSON.stringify(x)}`);
}
};
const fromFileToEntity = (x: FilesFile, parentPath: string): Entity => {
const key = getNormPathFromBasedir(`${parentPath}/${x.name}`, x.type as any);
if (x.type === "dir" || x.type === "file") {
return {
key: key,
keyRaw: key,
mtimeCli: x.modified,
mtimeSvr: x.modified,
size: x.size,
sizeRaw: x.size,
hash: x.hash,
} as Entity;
} else {
throw Error(`cannot understand ${JSON.stringify(x)}`);
}
};
/**
* https://app.koofr.net/developers
*
*/
// const getAuthHeader = (email: string, password: string) => {
// const x = `${email}:${password}`;
// const y = base64.stringify(new TextEncoder().encode(x));
// const z = `Basic ${y}`;
// return z;
// };
// const getAuthMiddleware = (email: string, password: string) => {
// const authMiddleware: Middleware = {
// async onRequest(req) {
// req.headers.set("Authorization", getAuthHeader(email, password));
// return req;
// },
// };
// return authMiddleware;
// };
const getAuthMiddleware = (
koofrConfig: KoofrConfig,
saveUpdatedConfigFunc: any
) => {
const authMiddleware: Middleware = {
async onRequest(req) {
const getAccessToken = async () => {
if (koofrConfig.refreshToken === "") {
throw Error("The user has not manually auth yet.");
}
const ts = Date.now();
const comp = koofrConfig.accessTokenExpiresAtTimeMs > ts;
// console.debug(`koofrConfig.accessTokenExpiresAtTimeMs=${koofrConfig.accessTokenExpiresAtTimeMs},ts=${ts},comp=${comp}`)
if (comp) {
return koofrConfig.accessToken;
}
// refresh
const k = await sendRefreshTokenReq(
koofrConfig.api,
koofrConfig.refreshToken
);
koofrConfig.accessToken = k.access_token;
koofrConfig.accessTokenExpiresInMs = k.expires_in * 1000;
koofrConfig.accessTokenExpiresAtTimeMs =
ts + k.expires_in * 1000 - 60 * 2 * 1000;
await saveUpdatedConfigFunc();
console.info("Koofr accessToken updated");
return koofrConfig.accessToken;
};
const access = await getAccessToken();
req.headers.set("Authorization", `Bearer ${access}`);
return req;
},
};
return authMiddleware;
};
export class FakeFsKoofr extends FakeFs {
kind: string;
koofrConfig: KoofrConfig;
remoteBaseDir: string;
vaultFolderExists: boolean;
saveUpdatedConfigFunc: () => Promise<any>;
client: ReturnType<typeof createClient<paths>>;
placeID: string;
constructor(
koofrConfig: KoofrConfig,
vaultName: string,
saveUpdatedConfigFunc: () => Promise<any>
) {
super();
this.kind = "koofr";
this.koofrConfig = koofrConfig;
this.remoteBaseDir = this.koofrConfig.remoteBaseDir || vaultName || "";
this.vaultFolderExists = false;
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
this.placeID = this.koofrConfig.mountID;
const client = createClient<paths>({ baseUrl: this.koofrConfig.api });
client.use(getAuthMiddleware(this.koofrConfig, saveUpdatedConfigFunc));
this.client = client;
}
async _init() {
if (this.koofrConfig.refreshToken === "") {
throw Error(`You have not auth yet!`);
}
if (this.placeID === undefined || this.placeID === "") {
const { data, error } = await this.client.GET("/api/v2.1/places");
const primaryPlaceID = data?.places.filter((x) => x.isPrimary)[0].id;
this.placeID = primaryPlaceID ?? "";
if (this.placeID === "") {
throw Error(`cannot find primary placeID`);
}
}
if (this.vaultFolderExists) {
// pass
} else {
const { data, error } = await this.client.GET(
"/api/v2.1/mounts/{mountId}/files/list",
{
params: {
query: {
path: "/",
},
path: {
mountId: this.placeID,
},
},
}
);
const x = data?.files.filter((x) => x.name === this.remoteBaseDir);
if ((x?.length ?? 0) > 0) {
this.vaultFolderExists = true;
} else {
const { data, error } = await this.client.POST(
"/api/v2.1/mounts/{mountId}/files/folder",
{
params: {
query: { path: "/" },
path: { mountId: this.placeID },
},
body: {
name: this.remoteBaseDir,
},
}
);
if (data !== undefined) {
this.vaultFolderExists = true;
} else {
throw Error(JSON.stringify(error));
}
}
}
}
async walk(): Promise<Entity[]> {
await this._init();
const { data, error } = await this.client.GET(
"/content/api/v2.1/mounts/{mountId}/files/listrecursive",
{
params: {
query: { path: this.remoteBaseDir },
path: { mountId: this.placeID },
},
parseAs: "text",
}
);
if (error !== undefined) {
throw Error(JSON.stringify(error));
}
const items = JSON.parse(
`[${data.trim().split("\n").join(",")}]`
) as FilesListRecursiveItem[];
const entities = items.filter((x) => x.path !== "/").map(fromItemToEntity);
return entities;
}
async walkPartial(): Promise<Entity[]> {
await this._init();
const { data, error } = await this.client.GET(
"/api/v2.1/mounts/{mountId}/files/list",
{
params: {
query: { path: this.remoteBaseDir },
path: { mountId: this.placeID },
},
}
);
if (error !== undefined) {
throw Error(JSON.stringify(error));
}
const entities = data.files.map((x) => fromFileToEntity(x, ""));
// console.debug(entities);
return entities;
}
async stat(key: string): Promise<Entity> {
await this._init();
const { data, error } = await this.client.GET(
"/api/v2.1/mounts/{mountId}/files/info",
{
params: {
query: { path: getKoofrPath(key, this.remoteBaseDir) },
path: { mountId: this.placeID },
},
}
);
if (error !== undefined) {
throw Error(JSON.stringify(error));
}
const entity = fromFileToEntity(
data,
getKoofrPath(getParentFolder(key), this.remoteBaseDir)
);
// console.debug(entity);
return entity;
}
async mkdir(
key: string,
mtime?: number | undefined,
ctime?: number | undefined
): Promise<Entity> {
await this._init();
// "abc/efg" -> "abc/"
const parent = getParentFolder(key);
const itself = key.slice(0, -1).split("/").pop()!;
const { data, error } = await this.client.POST(
"/api/v2.1/mounts/{mountId}/files/folder",
{
params: {
query: { path: getKoofrPath(parent, this.remoteBaseDir) },
path: { mountId: this.placeID },
},
body: {
name: itself,
},
}
);
if (error !== undefined) {
throw Error(JSON.stringify(error));
}
return this.stat(key);
}
async writeFile(
key: string,
content: ArrayBuffer,
mtime: number,
ctime: number
): Promise<Entity> {
await this._init();
const itself = key.split("/").pop()!;
const { data, error } = await this.client.POST(
"/content/api/v2.1/mounts/{mountId}/files/put",
{
params: {
query: {
path: getKoofrPath(getParentFolder(key), this.remoteBaseDir),
filename: itself,
info: true,
overwrite: true,
autorename: false,
modified: mtime,
},
path: { mountId: this.placeID },
},
body: content as any,
bodySerializer(body) {
return body;
},
}
);
if (error !== undefined) {
throw Error(JSON.stringify(error));
}
const entity = fromFileToEntity(
data,
getKoofrPath(getParentFolder(key), this.remoteBaseDir)
);
// console.debug(entity);
return entity;
}
async readFile(key: string): Promise<ArrayBuffer> {
await this._init();
const { data, error } = await this.client.GET(
"/content/api/v2.1/mounts/{mountId}/files/get",
{
params: {
query: { path: getKoofrPath(key, this.remoteBaseDir), force: true },
path: { mountId: this.placeID },
},
parseAs: "arrayBuffer",
}
);
if (error !== undefined) {
throw Error(JSON.stringify(error));
}
return data;
}
async rename(key1: string, key2: string): Promise<void> {
await this._init();
throw new Error("Method not implemented.");
}
async rm(key: string): Promise<void> {
await this._init();
const { data, error } = await this.client.DELETE(
"/api/v2.1/mounts/{mountId}/files/remove",
{
params: {
query: { path: getKoofrPath(key, this.remoteBaseDir), force: true },
path: { mountId: this.placeID },
},
}
);
if (error !== undefined) {
throw Error(JSON.stringify(error));
}
}
async checkConnect(callbackFunc?: any): Promise<boolean> {
// if we can init, we can connect
try {
await this._init();
return true;
} catch (err) {
console.debug(err);
callbackFunc?.(err);
return false;
}
}
async getUserDisplayName(): Promise<string> {
throw new Error("Method not implemented.");
}
async revokeAuth(): Promise<any> {
throw new Error("Method not implemented.");
}
allowEmptyFile(): boolean {
return true;
}
}
+628
View File
@@ -0,0 +1,628 @@
import { nanoid } from "nanoid";
import { requestUrl } from "obsidian";
import pcloudSdk from "pcloud-sdk-js";
import {
type Entity,
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
} from "../../src/baseTypes";
import { FakeFs } from "../../src/fsAll";
import { getFolderLevels } from "../../src/misc";
import {
COMMAND_CALLBACK_PCLOUD,
PCLOUD_CLIENT_ID,
PCLOUD_CLIENT_SECRET,
type PCloudConfig,
} from "./baseTypesPro";
export const DEFAULT_PCLOUD_CONFIG: PCloudConfig = {
accessToken: "",
hostname: "eapi.pcloud.com",
locationid: 2,
credentialsShouldBeDeletedAtTimeMs: 0,
emptyFile: "skip",
kind: "pcloud",
};
export interface AuthAllowFirstRes {
code: string;
state?: string;
locationid: 1 | 2;
hostname: "api.pcloud.com" | "eapi.pcloud.com";
}
/**
* https://docs.pcloud.com/methods/oauth_2.0/authorize.html
*/
export const generateAuthUrl = async (hasCallback: boolean) => {
const clientID = PCLOUD_CLIENT_ID;
const state = nanoid();
let authUrl = `https://my.pcloud.com/oauth2/authorize?response_type=code&client_id=${clientID}&state=${state}`;
if (hasCallback) {
authUrl += `&redirect_uri=obsidian://${COMMAND_CALLBACK_PCLOUD}`;
}
return {
authUrl,
state,
};
};
interface AuthResSucc {
result: number;
access_token: string;
token_type: "bearer";
uid: number;
locationid: number;
}
/**
* https://docs.pcloud.com/methods/oauth_2.0/oauth2_token.html
*/
export const sendAuthReq = async (
hostname: string,
authCode: string,
errorCallBack: any
) => {
const clientID = PCLOUD_CLIENT_ID ?? "";
const clientSecret = PCLOUD_CLIENT_SECRET ?? "";
try {
const k = {
code: authCode,
client_id: clientID,
client_secret: clientSecret,
};
// console.debug(k);
const resp1 = await fetch(`https://${hostname}/oauth2_token`, {
method: "POST",
body: new URLSearchParams(k),
});
const resp2: AuthResSucc = await resp1.json();
// console.debug(resp2);
if (resp2?.result !== 0) {
throw Error(`result is not 0 (success) in the end`);
}
if (!("access_token" in resp2)) {
throw Error(`no access_token in the end`);
}
return resp2;
} catch (e) {
console.error(e);
if (errorCallBack !== undefined) {
await errorCallBack(e);
}
}
};
export const setConfigBySuccessfullAuthInplace = async (
config: PCloudConfig,
authAllowFirstRes: AuthAllowFirstRes,
authRes: AuthResSucc | undefined,
saveUpdatedConfigFunc: () => Promise<any> | undefined
) => {
if (authRes === undefined) {
throw Error(`you should not save the setting for undefined result`);
}
config.accessToken = authRes.access_token;
config.hostname = authAllowFirstRes.hostname;
config.locationid = authAllowFirstRes.locationid;
// manually set it expired after 80 days;
config.credentialsShouldBeDeletedAtTimeMs =
Date.now() + OAUTH2_FORCE_EXPIRE_MILLISECONDS;
await saveUpdatedConfigFunc?.();
console.info("finish updating local info of pCloud token");
};
interface PCloudEntity extends Entity {
id: number;
parentID: number | undefined;
parentIDPath: string | undefined;
isFolder: boolean;
hashPCloud: number | undefined;
}
interface File {
contenttype: string;
created: string;
fileid: number;
hash: number;
id: string; // "f" + fileid
isfolder: false;
modified: string;
name: string;
parentfolderid: number;
size: number;
}
interface Folder {
contents: (Folder | File)[] | undefined;
id: string; // "d"+folderid
folderid: number;
isfolder: true;
created: string;
modified: string;
name: string;
parentfolderid: number;
}
interface StatRawResponse {
result: number;
fileids: number[];
metadata: (File | Folder)[];
checksums: { sha1: string; sha256?: string; md5?: string }[] | undefined;
}
const fromRawResponseToEntity = (
item: Folder | File,
parentFolderPath: string | undefined /* for bfs */
): PCloudEntity => {
if (item.parentfolderid === undefined || item.parentfolderid === 0) {
throw Error(
`parentfolderid=${item.parentfolderid} should not be in fromRawResponseToEntity`
);
}
let keyRaw = item.name;
let size = 0;
let hashPCloud: number | undefined = undefined;
let hash: string | undefined = undefined;
let id: number | undefined = undefined;
if (
parentFolderPath !== undefined &&
parentFolderPath !== "" &&
parentFolderPath !== "/"
) {
if (!parentFolderPath.endsWith("/")) {
throw Error(
`parentFolderPath=${parentFolderPath} should not be in fromRawResponseToEntity`
);
}
keyRaw = `${parentFolderPath}${item.name}`;
}
if (item.isfolder) {
keyRaw = `${keyRaw}/`;
id = item.folderid;
} else {
size = item.size;
hashPCloud = item.hash;
hash = `${item.hash}`;
id = item.fileid;
}
const mtime = new Date(item.modified).valueOf();
return {
key: keyRaw,
keyRaw: keyRaw,
mtimeCli: mtime,
mtimeSvr: mtime,
id: id,
parentID: item.parentfolderid,
isFolder: item.isfolder,
size: size,
sizeRaw: size,
hash: hash,
hashPCloud: hashPCloud,
parentIDPath: parentFolderPath,
};
};
const fromNestedFolderToEntityListAndCache = (
root: Folder
): { entities: PCloudEntity[]; key2Entity: Record<string, PCloudEntity> } => {
// console.debug("root:");
// console.debug(root);
const entities: PCloudEntity[] = [];
const key2Entity: Record<string, PCloudEntity> = {};
if (root.contents === undefined || root.contents.length === 0) {
// console.debug(`early return`);
return {
entities,
key2Entity,
};
}
let parents: {
folderPath: string;
itself: Folder | File;
}[] = [];
for (const f of root.contents ?? []) {
parents.push({
folderPath: "",
itself: f,
});
}
while (parents.length !== 0) {
const children: typeof parents = [];
for (const { folderPath, itself } of parents) {
if (itself.isfolder && itself.folderid === root.folderid) {
// special, ignore root folder itself
} else {
const entity = fromRawResponseToEntity(itself, folderPath);
entities.push(entity);
key2Entity[entity.keyRaw] = entity;
}
if (
itself.isfolder &&
itself.contents !== undefined &&
itself.contents.length > 0
) {
for (const f of itself.contents) {
if (folderPath === "" || folderPath === "/") {
const child = {
itself: f,
folderPath: `${itself.name}/`,
};
children.push(child);
} else {
const child = {
itself: f,
folderPath: `${folderPath}${itself.name}/`,
};
children.push(child);
}
}
}
}
parents = children;
}
// console.debug("entities:");
// console.debug(entities);
// console.debug("key2Entity:");
// console.debug(key2Entity);
return {
entities,
key2Entity,
};
};
const getPCloudPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
return `/${remoteBaseDir}/${fileOrFolderPath}`;
};
export class FakeFsPCloud extends FakeFs {
kind: string;
pCloudConfig: PCloudConfig;
remoteBaseDir: string;
vaultFolderExists: boolean;
saveUpdatedConfigFunc: () => Promise<any>;
keyToPCloudEntity: Record<string, PCloudEntity>;
baseDirID: number;
client: pcloudSdk.Client;
constructor(
pCloudConfig: PCloudConfig,
vaultName: string,
saveUpdatedConfigFunc: () => Promise<any>
) {
super();
this.kind = "pcloud";
this.pCloudConfig = pCloudConfig;
this.remoteBaseDir = this.pCloudConfig.remoteBaseDir || vaultName || "";
this.vaultFolderExists = false;
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
this.keyToPCloudEntity = {};
this.baseDirID = 0;
(global as any).locationid = pCloudConfig.locationid; // why?? pcloud, why??
this.client = pcloudSdk.createClient(pCloudConfig.accessToken);
}
async _init() {
if (this.vaultFolderExists) {
// pass
} else {
const root = (await this.client.listfolder(0, {
recursive: false,
})) as Folder;
// find?
if (root.contents === undefined) {
throw Error(`cannot listfolder of root!`);
}
const found = root.contents.filter(
(x) => x.isfolder && x.name === this.remoteBaseDir
);
if (found.length > 0) {
// we find it!
const f = found[0] as Folder;
this.baseDirID = f.folderid;
this.vaultFolderExists = true;
} else {
// not found, let's create it!
const f: Folder = await this.client.createfolder(this.remoteBaseDir, 0);
// console.debug(f);
this.baseDirID = f.folderid;
this.vaultFolderExists = true;
}
}
}
async _getAccessToken() {
if (this.pCloudConfig.accessToken === "") {
throw Error("The user has not manually auth yet.");
}
return this.pCloudConfig.accessToken;
// TODO: no expire date?
// https://docs.pcloud.com/methods/intro/authentication.html
}
async walk(): Promise<Entity[]> {
await this._init();
const rsp = (await this.client.listfolder(this.baseDirID, {
recursive: true,
})) as Folder;
const { entities, key2Entity } = fromNestedFolderToEntityListAndCache(rsp);
this.keyToPCloudEntity = Object.assign(this.keyToPCloudEntity, key2Entity);
return entities;
}
async walkPartial(): Promise<Entity[]> {
await this._init();
const rsp = (await this.client.listfolder(this.baseDirID, {
recursive: false,
})) as Folder;
const { entities, key2Entity } = fromNestedFolderToEntityListAndCache(rsp);
this.keyToPCloudEntity = Object.assign(this.keyToPCloudEntity, key2Entity);
return entities;
}
async stat(key: string): Promise<Entity> {
await this._init();
// TODO: we already have a cache, should we call again?
const cachedEntity = this.keyToPCloudEntity[key];
const fileID = cachedEntity?.id;
if (cachedEntity === undefined || fileID === undefined) {
throw Error(`no fileID found for key=${key}`);
}
// why? pcloud doesn't have stat api??
return cachedEntity;
}
async mkdir(
key: string,
mtime?: number | undefined,
ctime?: number | undefined
): Promise<Entity> {
if (!key.endsWith("/")) {
throw Error(`you should not mkdir on key=${key}`);
}
await this._init();
const cachedEntity = this.keyToPCloudEntity[key];
const fileID = cachedEntity?.id;
if (cachedEntity !== undefined && fileID !== undefined) {
return cachedEntity;
}
// xxx/ => ["xxx"]
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"]
const folderLevels = getFolderLevels(key);
let parentFolderPath: string | undefined = undefined;
let parentID: number | undefined = undefined;
if (folderLevels.length === 0) {
throw Error(`cannot getFolderLevels of ${key}`);
} else if (folderLevels.length === 1) {
parentID = this.baseDirID;
parentFolderPath = ""; // ignore base dir
} else {
// length > 1
parentFolderPath = `${folderLevels[folderLevels.length - 2]}/`;
if (!(parentFolderPath in this.keyToPCloudEntity)) {
throw Error(
`parent of ${key}: ${parentFolderPath} is not created before??`
);
}
parentID = this.keyToPCloudEntity[parentFolderPath].id;
}
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"] => "xxx/yyy/zzz" => "zzz"
let folderItselfWithoutSlash = folderLevels[folderLevels.length - 1];
folderItselfWithoutSlash = folderItselfWithoutSlash.split("/").pop()!;
const f = await this.client.createfolder(
folderItselfWithoutSlash,
parentID
);
const entity = fromRawResponseToEntity(f, parentFolderPath);
// insert into cache
this.keyToPCloudEntity[key] = entity;
return entity;
}
/**
* https://docs.pcloud.com/methods/file/uploadfile.html
*/
async writeFile(
key: string,
content: ArrayBuffer,
mtime: number,
ctime: number
): Promise<Entity> {
if (key.endsWith("/")) {
throw Error(`should not call writeFile on ${key}`);
}
await this._init();
const prevCachedEntity: PCloudEntity | undefined =
this.keyToPCloudEntity[key];
const prevFileID: number | undefined = prevCachedEntity?.id;
let parentID: number | undefined = undefined;
let parentFolderPath: string | undefined = undefined;
// "xxx" => []
// "xxx/yyy/zzz.md" => ["xxx", "xxx/yyy"]
const folderLevels = getFolderLevels(key);
if (folderLevels.length === 0) {
// root
parentID = this.baseDirID;
parentFolderPath = "";
} else {
parentFolderPath = `${folderLevels[folderLevels.length - 1]}/`;
if (!(parentFolderPath in this.keyToPCloudEntity)) {
throw Error(
`parent of ${key}: ${parentFolderPath} is not created before??`
);
}
parentID = this.keyToPCloudEntity[parentFolderPath].id;
}
const fileItself = key.split("/").pop()!;
// no idea how to use the sdk, let's use https here
// https://docs.pcloud.com/methods/file/uploadfile.html
const params = new URLSearchParams({
access_token: await this._getAccessToken(),
folderid: `${parentID}`,
filename: fileItself,
nopartial: `1`,
renameifexists: `0`,
mtime: `${Math.floor(mtime / 1000.0)}`,
ctime: `${Math.floor(ctime / 1000.0)}`,
});
const apiUrl = `https://${this.pCloudConfig.hostname}/uploadfile?${params}`;
if (content.byteLength > 0) {
const rsp = await fetch(apiUrl, {
method: "PUT",
body: content,
});
const f: StatRawResponse = await rsp.json();
const entity = fromRawResponseToEntity(f.metadata[0], parentFolderPath);
// console.debug(entity);
this.keyToPCloudEntity[key] = entity;
return entity;
} else {
// no idea why pcloud doesn't work for empty files
// it can be uploaded successfully but the call doesn't end
// we abort it and stat it manually.
// console.warn(`uploading empty file ${key}`);
const controller = new AbortController();
const timeoutMs = 300; // just a random reasonable number
const id = setTimeout(() => controller.abort(), timeoutMs);
try {
const rsp = await fetch(apiUrl, {
method: "PUT",
body: content,
signal: controller.signal,
});
} catch (e) {
// console.warn(`we abort the request of uploading empty file ${key}:`);
// console.warn(e);
} finally {
clearTimeout(id);
}
// raw stat here
// https://docs.pcloud.com/methods/file/stat.html
const params = new URLSearchParams({
access_token: await this._getAccessToken(),
path: getPCloudPath(key, this.remoteBaseDir),
});
const apiUrlStat = `https://${this.pCloudConfig.hostname}/stat?${params}`;
const rsp2 = await fetch(apiUrlStat);
const f = await rsp2.json();
const entity = fromRawResponseToEntity(f.metadata, parentFolderPath);
// console.warn(entity);
this.keyToPCloudEntity[key] = entity;
return entity;
}
}
async readFile(key: string): Promise<ArrayBuffer> {
await this._init();
const cachedEntity = this.keyToPCloudEntity[key];
const fileID = cachedEntity?.id;
if (cachedEntity === undefined || fileID === undefined) {
throw Error(`no fileID found for key=${key}`);
}
const params = new URLSearchParams({
access_token: await this._getAccessToken(),
forcedownload: `1`,
fileid: `${fileID}`,
});
const urlMeta = `https://${this.pCloudConfig.hostname}/getfilelink?${params}`;
// Referrer is restricted to pcloud.com.
// we need to bypass it
const meta = (await requestUrl(urlMeta)).json;
// console.debug(meta);
const link: string = `https://${meta.hosts[0]}${meta.path}`;
const rsp = await requestUrl(link);
const content = rsp.arrayBuffer;
return content;
}
async rename(key1: string, key2: string): Promise<void> {
await this._init();
throw new Error("Method not implemented.");
}
async rm(key: string): Promise<void> {
await this._init();
const cachedEntity = this.keyToPCloudEntity[key];
const fileID = cachedEntity?.id;
if (cachedEntity === undefined || fileID === undefined) {
throw Error(`no fileID found for key=${key}`);
}
if (key.endsWith("/")) {
await this.client.deletefolder(fileID);
} else {
await this.client.deletefile(fileID);
}
}
async checkConnect(callbackFunc?: any): Promise<boolean> {
// if we can init, we can connect
try {
await this._init();
return true;
} catch (err) {
console.debug(err);
callbackFunc?.(err);
return false;
}
}
async getUserDisplayName(): Promise<string> {
await this._init();
throw new Error("Method not implemented.");
}
async revokeAuth(): Promise<any> {
await this._init();
throw new Error("Method not implemented.");
}
allowEmptyFile(): boolean {
return true;
}
}
+516
View File
@@ -0,0 +1,516 @@
import { nanoid } from "nanoid";
import PQueue from "p-queue";
import type { Entity } from "../../src/baseTypes";
import { FakeFs } from "../../src/fsAll";
import { unixTimeToStr } from "../../src/misc";
import {
COMMAND_CALLBACK_YANDEXDISK,
YANDEXDISK_CLIENT_ID,
YANDEXDISK_CLIENT_SECRET,
type YandexDiskConfig,
} from "./baseTypesPro";
import {
type FilesResourceList,
type Resource,
type ResourceList,
YandexApi,
} from "./yandexApi";
export const DEFAULT_YANDEXDISK_CONFIG: YandexDiskConfig = {
accessToken: "",
accessTokenExpiresInMs: 0,
accessTokenExpiresAtTimeMs: 0,
refreshToken: "",
scope: "",
kind: "yandexdisk",
};
/**
* https://yandex.com/dev/id/doc/en/codes/code-url#code
*/
export const generateAuthUrl = (hasCallback: boolean) => {
let callback = `https://oauth.yandex.com/verification_code`;
if (hasCallback) {
callback = `obsidian://${COMMAND_CALLBACK_YANDEXDISK}`;
}
const params = new URLSearchParams({
response_type: "code",
client_id: YANDEXDISK_CLIENT_ID ?? "",
redirect_uri: callback,
force_confirm: "yes",
state: nanoid(),
});
const url = `https://oauth.yandex.com/authorize?${params}`;
return url;
};
interface AuthResSucc {
token_type: "bearer";
access_token: string;
expires_in: number;
refresh_token: string;
scope: string | undefined;
}
interface AuthResFail {
error: string;
error_description: string;
}
/**
* https://yandex.com/dev/id/doc/en/codes/code-url#token
*/
export const sendAuthReq = async (authCode: string, errorCallBack: any) => {
try {
const k = {
code: authCode,
grant_type: "authorization_code",
client_id: YANDEXDISK_CLIENT_ID ?? "",
client_secret: YANDEXDISK_CLIENT_SECRET ?? "",
// redirect_uri: `obsidian://${COMMAND_CALLBACK_BOX}`,
};
// console.debug(k);
const resp1 = await fetch(`https://oauth.yandex.com/token`, {
method: "POST",
body: new URLSearchParams(k),
});
if (resp1.status !== 200) {
const resp2: AuthResFail = await resp1.json();
throw Error(JSON.stringify(resp2));
}
const resp2: AuthResSucc = await resp1.json();
return resp2;
} catch (e) {
console.error(e);
if (errorCallBack !== undefined) {
await errorCallBack(e);
}
}
};
/**
* https://yandex.com/dev/id/doc/en/tokens/refresh-client
*/
export const sendRefreshTokenReq = async (refreshToken: string) => {
console.debug(`refreshing token`);
const x = await fetch("https://oauth.yandex.com/token", {
method: "POST",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
},
body: new URLSearchParams({
client_id: YANDEXDISK_CLIENT_ID ?? "",
client_secret: YANDEXDISK_CLIENT_SECRET ?? "",
grant_type: "refresh_token",
refresh_token: refreshToken,
}).toString(),
});
if (x.status === 200) {
const y: AuthResSucc = await x.json();
console.debug(`new token obtained`);
return y;
} else {
const y: AuthResFail = await x.json();
throw Error(`cannot refresh an access token: ${JSON.stringify(y)}`);
}
};
export const setConfigBySuccessfullAuthInplace = async (
config: YandexDiskConfig,
authRes: any,
saveUpdatedConfigFunc: () => Promise<any> | undefined
) => {
if (authRes.access_token === undefined || authRes.access_token === "") {
throw Error(
`you should not save the setting for ${JSON.stringify(authRes)}`
);
}
config.accessToken = authRes.access_token;
config.accessTokenExpiresAtTimeMs =
Date.now() + authRes.expires_in * 1000 - 5 * 60 * 1000;
config.accessTokenExpiresInMs = authRes.expires_in * 1000;
config.refreshToken = authRes.refresh_token || config.refreshToken;
// manually set it expired after 60 days;
config.credentialsShouldBeDeletedAtTimeMs =
Date.now() + 1000 * 60 * 60 * 24 * 59;
await saveUpdatedConfigFunc?.();
console.info("finish updating local info of Yandex Disk token");
};
const getYandexDiskPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
let key = fileOrFolderPath;
if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
// special
key = `disk:/${remoteBaseDir}`;
} else if (fileOrFolderPath.startsWith("/")) {
console.warn(
`why the path ${fileOrFolderPath} starts with '/'? but we just go on.`
);
key = `disk:/${remoteBaseDir}${fileOrFolderPath}`;
} else {
key = `disk:/${remoteBaseDir}/${fileOrFolderPath}`;
}
if (key.endsWith("/")) {
key = key.slice(0, key.length - 1);
}
return key;
};
const getNormPath = (
fileOrFolderPath: string,
remoteBaseDir: string,
type: "dir" | "file"
) => {
if (
!(
fileOrFolderPath === `disk:/${remoteBaseDir}` ||
fileOrFolderPath.startsWith(`disk:/${remoteBaseDir}/`)
)
) {
throw Error(
`"${fileOrFolderPath}" doesn't starts with "disk:/${remoteBaseDir}/"`
);
}
let key = fileOrFolderPath.slice(`disk:/${remoteBaseDir}/`.length);
if (type === "dir") {
key = `${key}/`;
}
return key;
};
const fromResourceToEntity = (x: Resource, remoteBaseDir: string): Entity => {
const key = getNormPath(x.path!, remoteBaseDir, x.type!);
if (x.type === "dir") {
return {
key: key,
keyRaw: key,
size: 0,
sizeRaw: 0,
} as Entity;
} else {
// file
const mtimeCli = Date.parse(
x?.custom_properties?.rclone_modified ?? x.modified!
).valueOf();
const mtimeSvr = Date.parse(x.modified!).valueOf();
return {
key: key,
keyRaw: key,
mtimeCli: mtimeCli,
mtimeSvr: mtimeSvr,
size: x.size!,
sizeRaw: x.size!,
hash: x.sha256,
} as Entity;
}
};
const FIELDS_FOR_RESOURCE = [
"name",
"created",
"modified",
"path",
"type",
"size",
"sha256",
"md5",
"_embedded.limit",
"_embedded.offset",
"_embedded.total",
"_embedded.items.created",
"_embedded.items.modified",
"_embedded.items.path",
"_embedded.items.name",
"_embedded.items.type",
"_embedded.items.size",
"_embedded.items.sha256",
"_embedded.items.md5",
"_embedded.items.mime_type",
"_embedded.items.file",
"_embedded.items.custom_properties",
];
export class FakeFsYandexDisk extends FakeFs {
kind: string;
yandexDiskConfig: YandexDiskConfig;
remoteBaseDir: string;
vaultFolderExists: boolean;
saveUpdatedConfigFunc: () => Promise<any>;
constructor(
yandexDiskConfig: YandexDiskConfig,
vaultName: string,
saveUpdatedConfigFunc: () => Promise<any>
) {
super();
this.kind = "yandexdisk";
this.yandexDiskConfig = yandexDiskConfig;
this.remoteBaseDir = this.yandexDiskConfig.remoteBaseDir || vaultName || "";
this.vaultFolderExists = false;
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
}
async _init() {
const access = await this._getAccessToken();
const client = new YandexApi(access);
if (this.vaultFolderExists) {
// pass
} else {
const res: Resource[] = [];
let offset = 0;
const limit = 100;
let total = 100;
do {
const k = await client.diskResources(
"disk:/",
FIELDS_FOR_RESOURCE,
limit,
offset
);
res.push(...(k._embedded?.items ?? []));
total = k._embedded?.total ?? 0;
offset += limit;
} while (offset < total);
if (res.filter((x) => x.name === this.remoteBaseDir).length > 0) {
// found
this.vaultFolderExists = true;
} else {
// need to create
await client.diskResourcesPut(`disk:/${this.remoteBaseDir}`);
this.vaultFolderExists = true;
}
}
}
async _getAccessToken() {
if (this.yandexDiskConfig.refreshToken === "") {
throw Error("The user has not manually auth yet.");
}
const ts = Date.now();
const comp = this.yandexDiskConfig.accessTokenExpiresAtTimeMs > ts;
// console.debug(`this.yandexDiskConfig.accessTokenExpiresAtTimeMs=${this.yandexDiskConfig.accessTokenExpiresAtTimeMs},ts=${ts},comp=${comp}`)
if (comp) {
return this.yandexDiskConfig.accessToken;
}
// refresh
const k = await sendRefreshTokenReq(this.yandexDiskConfig.refreshToken);
this.yandexDiskConfig.accessToken = k.access_token;
this.yandexDiskConfig.accessTokenExpiresInMs = k.expires_in * 1000;
this.yandexDiskConfig.accessTokenExpiresAtTimeMs =
ts + k.expires_in * 1000 - 60 * 2 * 1000;
await this.saveUpdatedConfigFunc();
console.info("Yandex Disk accessToken updated");
return this.yandexDiskConfig.accessToken;
}
async walk(): Promise<Entity[]> {
await this._init();
// bfs
const queue = new PQueue({
concurrency: 5, // TODO: make it configurable?
autoStart: true,
});
queue.on("error", (error) => {
queue.pause();
queue.clear();
throw error;
});
const entities: Entity[] = [];
let parents = ["/"];
while (parents.length !== 0) {
const children: typeof parents = [];
for (const p of parents) {
queue.add(async () => {
const entitiesOfALevel = await this._walkFolder(p);
for (const entity of entitiesOfALevel) {
entities.push(entity);
if (entity.keyRaw.endsWith("/")) {
children.push(entity.keyRaw);
}
}
});
}
await queue.onIdle();
parents = children;
}
// console.debug(entities);
return entities;
}
async walkPartial(): Promise<Entity[]> {
await this._init();
const entities = await this._walkFolder("/");
return entities;
}
async _walkFolder(key: string) {
if (!key.endsWith("/")) {
throw Error(`should not call _walkFolder on ${key}`);
}
const client = new YandexApi(await this._getAccessToken());
const p = getYandexDiskPath(key, this.remoteBaseDir);
const entities: Entity[] = [];
let offset = 0;
const limit = 100;
let total = 100;
// TODO: once we know the total in the first loop, we can run the list in parallel
do {
const k = await client.diskResources(
p,
FIELDS_FOR_RESOURCE,
limit,
offset
);
entities.push(
...(k._embedded?.items ?? []).map((x) =>
fromResourceToEntity(x, this.remoteBaseDir)
)
);
total = k._embedded?.total ?? 0;
offset += limit;
} while (offset < total);
return entities;
}
async stat(key: string): Promise<Entity> {
await this._init();
const client = new YandexApi(await this._getAccessToken());
const p = getYandexDiskPath(key, this.remoteBaseDir);
const r = await client.diskResources(p, FIELDS_FOR_RESOURCE);
const entity = fromResourceToEntity(r, this.remoteBaseDir);
return entity;
}
async mkdir(
key: string,
mtime?: number | undefined,
ctime?: number | undefined
): Promise<Entity> {
// console.debug(`mkdir ${key} begin`)
await this._init();
const client = new YandexApi(await this._getAccessToken());
const p = getYandexDiskPath(key, this.remoteBaseDir);
// create
await client.diskResourcesPut(p, FIELDS_FOR_RESOURCE);
// patch?
const custom: Record<string, string> = {};
if (mtime !== undefined) {
custom["rclone_modified"] = unixTimeToStr(mtime, true);
}
if (ctime !== undefined) {
custom["rclone_created"] = unixTimeToStr(ctime, true);
}
if (Object.keys(custom).length > 0) {
await client.diskResourcesPatch(p, custom);
}
const entity = await this.stat(key);
// console.debug(`mkdir ${key} finish, ${JSON.stringify(entity)}`)
return entity;
}
async writeFile(
key: string,
content: ArrayBuffer,
mtime: number,
ctime: number
): Promise<Entity> {
// console.debug(`writeFile ${key} begin`)
await this._init();
const client = new YandexApi(await this._getAccessToken());
const p = getYandexDiskPath(key, this.remoteBaseDir);
await client.diskResoucesUpload(p, content, true);
// console.debug(`writeFile ${key} upload succ`)
// patch?
const custom: Record<string, string> = {};
if (mtime !== undefined) {
custom["rclone_modified"] = unixTimeToStr(mtime, true);
}
if (ctime !== undefined) {
custom["rclone_created"] = unixTimeToStr(ctime, true);
}
if (Object.keys(custom).length > 0) {
await client.diskResourcesPatch(p, custom);
}
// console.debug(`writeFile ${key} patch succ`)
const entity = await this.stat(key);
// console.debug(`writeFile ${key} finish, ${JSON.stringify(entity)}`)
return entity;
}
async readFile(key: string): Promise<ArrayBuffer> {
// console.debug(`readFile ${key} begin`)
await this._init();
const client = new YandexApi(await this._getAccessToken());
const p = getYandexDiskPath(key, this.remoteBaseDir);
const content = await client.diskResoucesDownload(p);
// console.debug(`readFile ${key} finish, length=${content.byteLength}`)
return content;
}
async rename(key1: string, key2: string): Promise<void> {
await this._init();
throw new Error("Method not implemented.");
}
async rm(key: string): Promise<void> {
await this._init();
const client = new YandexApi(await this._getAccessToken());
const p = getYandexDiskPath(key, this.remoteBaseDir);
await client.diskResourcesDelete(p, false);
}
async checkConnect(callbackFunc?: any): Promise<boolean> {
// if we can init, we can connect
try {
await this._init();
return true;
} catch (err) {
console.debug(err);
callbackFunc?.(err);
return false;
}
}
async getUserDisplayName(): Promise<string> {
await this._init();
throw new Error("Method not implemented.");
}
/**
* https://yandex.com/dev/id/doc/en/tokens/token-invalidate
*/
async revokeAuth(): Promise<any> {
await fetch(`https://oauth.yandex.com/revoke_token`, {
method: "POST",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
},
body: new URLSearchParams({
client_id: YANDEXDISK_CLIENT_ID ?? "",
client_secret: YANDEXDISK_CLIENT_SECRET ?? "",
access_token: this.yandexDiskConfig.refreshToken, // TODO: which token?
}).toString(),
});
}
allowEmptyFile(): boolean {
return true;
}
}
+9953
View File
File diff suppressed because it is too large Load Diff
+185
View File
@@ -7,6 +7,91 @@
"protocol_pro_connect_fail": "Something went wrong from response from Remotely Save official website. Maybe the network connection is not good. Maybe you rejected the auth?", "protocol_pro_connect_fail": "Something went wrong from response from Remotely Save official website. Maybe the network connection is not good. Maybe you rejected the auth?",
"protocol_pro_connect_succ_revoke": "You've connected as user {{email}}. If you want to disconnect, click this button.", "protocol_pro_connect_succ_revoke": "You've connected as user {{email}}. If you want to disconnect, click this button.",
"protocol_box_connecting": "Connectting",
"protocol_box_connect_manualinput_succ": "You've connected",
"protocol_box_connect_fail": "Something went wrong from response from Box official website. Maybe the network connection is not good. Maybe you rejected the auth?",
"protocol_box_connect_succ_revoke": "You've connected. If you want to disconnect, click this button.",
"protocol_pcloud_connecting": "Connectting",
"protocol_pcloud_connect_manualinput_succ": "You've connected",
"protocol_pcloud_connect_fail": "Something went wrong from response from pCloud website. Maybe the network connection is not good. Maybe you rejected the auth?",
"protocol_pcloud_connect_succ_revoke": "You've connected. If you want to disconnect, click this button.",
"protocol_yandexdisk_connecting": "Connectting",
"protocol_yandexdisk_connect_manualinput_succ": "You've connected",
"protocol_yandexdisk_connect_fail": "Something went wrong from response from Yandex Disk website. Maybe the network connection is not good. Maybe you rejected the auth?",
"protocol_yandexdisk_connect_succ_revoke": "You've connected. If you want to disconnect, click this button.",
"protocol_koofr_connecting": "Connectting",
"protocol_koofr_connect_manualinput_succ": "You've connected",
"protocol_koofr_connect_fail": "Something went wrong from response from Koofr website. Maybe the network connection is not good. Maybe you rejected the auth?",
"protocol_koofr_connect_succ_revoke": "You've connected. If you want to disconnect, click this button.",
"modal_googledriveauth_tutorial": "<p>Please firstly go to the address, then go on the auth flow. In the end, you will see a code, please paste that code here and submit.</p>",
"modal_googledriveauth_copybutton": "Click to copy the auth url",
"modal_googledriveauth_copynotice": "The auth url is copied to the clipboard!",
"modal_googledrivce_maualinput": "The Code from the website",
"modal_googledrivce_maualinput_desc": "Please input the code here from the end of auth flow, and press confirm.",
"modal_googledrive_maualinput_notice": "We are trying to connect to Google and update the credentials...",
"modal_googledrive_maualinput_succ_notice": "Great! The credentials are updated!",
"modal_googledrive_maualinput_fail_notice": "Oops! Failed to update the credentials. Please try again later.",
"modal_googledriverevokeauth_step1": "Step 1: Go to the following address, you can remove the connection there.",
"modal_googledriverevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
"modal_googledriverevokeauth_clean": "Clean Locally-Saved Login Credentials",
"modal_googledriverevokeauth_clean_desc": "You need to click the button.",
"modal_googledriverevokeauth_clean_button": "Clean",
"modal_googledriverevokeauth_clean_notice": "Cleaned!",
"modal_googledriverevokeauth_clean_fail": "Something goes wrong while revoking.",
"modal_boxauth_tutorial": "<p>Please firstly go to the address, then go on the auth flow. In the end, you will be redirected to here.</p>",
"modal_boxauth_copybutton": "Click to copy the auth url",
"modal_boxauth_copynotice": "The auth url is copied to the clipboard!",
"modal_box_maualinput": "The Code from the website",
"modal_box_maualinput_desc": "Please input the code here from the end of auth flow, and press confirm.",
"modal_box_maualinput_notice": "We are trying to connect to Box and update the credentials...",
"modal_box_maualinput_succ_notice": "Great! The credentials are updated!",
"modal_box_maualinput_fail_notice": "Oops! Failed to update the credentials. Please try again later.",
"modal_boxrevokeauth_step1": "Step 1: Go to the following address, you can remove the connection there.",
"modal_boxrevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
"modal_boxrevokeauth_clean": "Clean Locally-Saved Login Credentials",
"modal_boxrevokeauth_clean_desc": "You need to click the button.",
"modal_boxrevokeauth_clean_button": "Clean",
"modal_boxrevokeauth_clean_notice": "Cleaned!",
"modal_boxrevokeauth_clean_fail": "Something goes wrong while revoking.",
"modal_pcloudauth_tutorial": "<p>Please firstly go to the address, then go on the auth flow. In the end, you will be redirected to here.</p>",
"modal_pcloudauth_copybutton": "Click to copy the auth url",
"modal_pcloudauth_copynotice": "The auth url is copied to the clipboard!",
"modal_pcloudrevokeauth_step1": "Step 1: Go to the following address, you can remove the connection there.",
"modal_pcloudrevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
"modal_pcloudrevokeauth_clean": "Clean Locally-Saved Login Credentials",
"modal_pcloudrevokeauth_clean_desc": "You need to click the button.",
"modal_pcloudrevokeauth_clean_button": "Clean",
"modal_pcloudrevokeauth_clean_notice": "Cleaned!",
"modal_pcloudrevokeauth_clean_fail": "Something goes wrong while revoking.",
"modal_yandexdiskauth_tutorial": "<p>Please firstly go to the address, then go on the auth flow. In the end, you will be redirected to here.</p>",
"modal_yandexdiskauth_copybutton": "Click to copy the auth url",
"modal_yandexdiskauth_copynotice": "The auth url is copied to the clipboard!",
"modal_yandexdiskrevokeauth_step1": "Step 1: Go to the following address, you can remove the connection there.",
"modal_yandexdiskrevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
"modal_yandexdiskrevokeauth_clean": "Clean Locally-Saved Login Credentials",
"modal_yandexdiskrevokeauth_clean_desc": "You need to click the button.",
"modal_yandexdiskrevokeauth_clean_button": "Clean",
"modal_yandexdiskrevokeauth_clean_notice": "Cleaned!",
"modal_yandexdiskrevokeauth_clean_fail": "Something goes wrong while revoking.",
"modal_koofrauth_tutorial": "<p>Please firstly go to the address, then go on the auth flow. In the end, you will be redirected to here.</p>",
"modal_koofrauth_copybutton": "Click to copy the auth url",
"modal_koofrauth_copynotice": "The auth url is copied to the clipboard!",
"modal_koofrrevokeauth_step1": "Step 1: Go to the following address, you can remove the connection there.",
"modal_koofrrevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
"modal_koofrrevokeauth_clean": "Clean Locally-Saved Login Credentials",
"modal_koofrrevokeauth_clean_desc": "You need to click the button.",
"modal_koofrrevokeauth_clean_button": "Clean",
"modal_koofrrevokeauth_clean_notice": "Cleaned!",
"modal_koofrrevokeauth_clean_fail": "Something goes wrong while revoking.",
"modal_prorevokeauth": "Revoke auth by clicking here and follow the steps.", "modal_prorevokeauth": "Revoke auth by clicking here and follow the steps.",
"modal_prorevokeauth_clean": "Clean", "modal_prorevokeauth_clean": "Clean",
"modal_prorevokeauth_clean_desc": "Clean local auth record", "modal_prorevokeauth_clean_desc": "Clean local auth record",
@@ -20,6 +105,106 @@
"modal_proauth_maualinput_notice": "Trying to connect, wait...", "modal_proauth_maualinput_notice": "Trying to connect, wait...",
"modal_proauth_maualinput_conn_fail": "Failed to connect", "modal_proauth_maualinput_conn_fail": "Failed to connect",
"settings_googledrive": "Google Drive (PRO) (beta)",
"settings_chooseservice_googledrive": "Google Drive (PRO) (beta)",
"settings_googledrive_disclaimer1": "Disclaimer: This app is NOT an official Google product. The app just uses Google Drive's public api.",
"settings_googledrive_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Google Drive, please immediately disconnect this app on https://myaccount.google.com/permissions .",
"settings_googledrive_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
"settings_googledrive_notshowuphint": "Google Drive Settings Not Available",
"settings_googledrive_notshowuphint_desc": "Google Drive settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
"settings_googledrive_notshowuphint_view_pro": "View PRO Settings",
"settings_googledrive_folder": "We will create and sync inside the folder {{remoteBaseDir}} on your Google Drive. DO NOT create this folder by yourself manually.",
"settings_googledrive_revoke": "Revoke Auth",
"settings_googledrive_revoke_desc": "You've connected. If you want to disconnect, click this button.",
"settings_googledrive_revoke_button": "Revoke Auth",
"settings_googledrive_auth": "Auth",
"settings_googledrive_auth_desc": "Auth.",
"settings_googledrive_auth_button": "Auth",
"settings_googledrive_connect_succ": "Great! We can connect to Google Drive!",
"settings_googledrive_connect_fail": "We cannot connect to Google Drive.",
"settings_box": "Box (PRO) (beta)",
"settings_chooseservice_box": "Box (PRO) (beta)",
"settings_box_disclaimer1": "Disclaimer: This app is NOT an official Box product. The app just uses Box's public api.",
"settings_box_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Box, please immediately disconnect this app on https://app.box.com/account/security .",
"settings_box_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
"settings_box_notshowuphint": "Box Settings Not Available",
"settings_box_notshowuphint_desc": "Box settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
"settings_box_notshowuphint_view_pro": "View PRO Settings",
"settings_box_folder": "We will create and sync inside the folder {{remoteBaseDir}} on your Box. DO NOT create this folder by yourself manually.",
"settings_box_revoke": "Revoke Auth",
"settings_box_revoke_desc": "You've connected. If you want to disconnect, click this button.",
"settings_box_revoke_button": "Revoke Auth",
"settings_box_auth": "Auth",
"settings_box_auth_desc": "Auth.",
"settings_box_auth_button": "Auth",
"settings_box_connect_succ": "Great! We can connect to Box!",
"settings_box_connect_fail": "We cannot connect to Box.",
"settings_pcloud": "pCloud (PRO) (beta)",
"settings_chooseservice_pcloud": "pCloud (PRO) (beta)",
"settings_pcloud_disclaimer1": "Disclaimer: This app is NOT an official pCloud product. The app just uses pCloud's public api.",
"settings_pcloud_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your pCloud, please immediately disconnect this app on https://my.pcloud.com/#page=settings&settings=tab-apps .",
"settings_pcloud_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
"settings_pcloud_notshowuphint": "pCloud Settings Not Available",
"settings_pcloud_notshowuphint_desc": "pCloud settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
"settings_pcloud_notshowuphint_view_pro": "View PRO Settings",
"settings_pcloud_folder": "We will create and sync inside the folder {{remoteBaseDir}} on your pCloud. DO NOT create this folder by yourself manually.",
"settings_pcloud_revoke": "Revoke Auth",
"settings_pcloud_revoke_desc": "You've connected. If you want to disconnect, click this button.",
"settings_pcloud_revoke_button": "Revoke Auth",
"settings_pcloud_auth": "Auth",
"settings_pcloud_auth_desc": "Auth.",
"settings_pcloud_auth_button": "Auth",
"settings_pcloud_emptyfile": "Empty File",
"settings_pcloud_emptyfile_desc": "pCloud API doesn't work with empty file. How to deal with it?",
"settings_pcloud_emptyfile_skip": "Skip",
"settings_pcloud_emptyfile_error": "Error",
"settings_pcloud_connect_succ": "Great! We can connect to pCloud!",
"settings_pcloud_connect_fail": "We cannot connect to pCloud.",
"settings_yandexdisk": "Yandex Disk (PRO) (beta)",
"settings_chooseservice_yandexdisk": "Yandex Disk (PRO) (beta)",
"settings_yandexdisk_disclaimer1": "Disclaimer: This app is NOT an official Yandex Disk product. The app just uses Yandex Disk's public api.",
"settings_yandexdisk_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Yandex Disk, please immediately disconnect this app on https://app.yandexdisk.com/account/security .",
"settings_yandexdisk_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
"settings_yandexdisk_notshowuphint": "Yandex Disk Settings Not Available",
"settings_yandexdisk_notshowuphint_desc": "Yandex Disk settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
"settings_yandexdisk_notshowuphint_view_pro": "View PRO Settings",
"settings_yandexdisk_folder": "We will create and sync inside the folder {{remoteBaseDir}} on your Yandex Disk. DO NOT create this folder by yourself manually.",
"settings_yandexdisk_revoke": "Revoke Auth",
"settings_yandexdisk_revoke_desc": "You've connected. If you want to disconnect, click this button.",
"settings_yandexdisk_revoke_button": "Revoke Auth",
"settings_yandexdisk_auth": "Auth",
"settings_yandexdisk_auth_desc": "Auth.",
"settings_yandexdisk_auth_button": "Auth",
"settings_yandexdisk_connect_succ": "Great! We can connect to Yandex Disk!",
"settings_yandexdisk_connect_fail": "We cannot connect to Yandex Disk.",
"settings_koofr": "Koofr (PRO) (beta)",
"settings_chooseservice_koofr": "Koofr (PRO) (beta)",
"settings_koofr_disclaimer1": "Disclaimer: This app is NOT an official Koofr product. The app just uses Koofr's public api.",
"settings_koofr_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Koofr, please immediately disconnect this app on https://app.koofr.net/app/admin/preferences/security .",
"settings_koofr_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
"settings_koofr_notshowuphint": "Koofr Settings Not Available",
"settings_koofr_notshowuphint_desc": "Koofr settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
"settings_koofr_notshowuphint_view_pro": "View PRO Settings",
"settings_koofr_folder": "We will create and sync inside the folder {{remoteBaseDir}} on your Koofr. DO NOT create this folder by yourself manually.",
"settings_koofr_revoke": "Revoke Auth",
"settings_koofr_revoke_desc": "You've connected. If you want to disconnect, click this button.",
"settings_koofr_revoke_button": "Revoke Auth",
"settings_koofr_auth": "Auth",
"settings_koofr_auth_desc": "Auth.",
"settings_koofr_auth_button": "Auth",
"settings_koofr_connect_succ": "Great! We can connect to Koofr!",
"settings_koofr_connect_fail": "We cannot connect to Koofr.",
"settings_export_googledrive_button": "Export Google Drive Part",
"settings_export_box_button": "Export Box Part",
"settings_export_pcloud_button": "Export pCloud Part",
"settings_export_yandexdisk_button": "Export Yandex Disk Part",
"settings_export_koofr_button": "Export Koofr Part",
"settings_pro": "Account (for PRO features)", "settings_pro": "Account (for PRO features)",
"settings_pro_tutorial": "<p>Using <stong>basic</strong> features of Remotely Save is <strong>FREE</strong> and do <strong>NOT</strong> need an account.</p><p>However, you will <strong>need</strong> an online account and <strong>PAY</strong> for the <strong>PRO</strong> features such as smart conflict.</p><p>Firstly please click the button to sign up and sign in to the website: <a href=\"https://remotelysave.com\">https://remotelysave.com</a>. Notice: It's different from, and NOT affiliated with Obsidian account.</p><p>Secondly please \"connect\" your local device to your online account.", "settings_pro_tutorial": "<p>Using <stong>basic</strong> features of Remotely Save is <strong>FREE</strong> and do <strong>NOT</strong> need an account.</p><p>However, you will <strong>need</strong> an online account and <strong>PAY</strong> for the <strong>PRO</strong> features such as smart conflict.</p><p>Firstly please click the button to sign up and sign in to the website: <a href=\"https://remotelysave.com\">https://remotelysave.com</a>. Notice: It's different from, and NOT affiliated with Obsidian account.</p><p>Secondly please \"connect\" your local device to your online account.",
"settings_pro_features": "Features", "settings_pro_features": "Features",
+195
View File
@@ -7,6 +7,101 @@
"protocol_pro_connect_fail": "Remotely Save 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权?", "protocol_pro_connect_fail": "Remotely Save 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权?",
"protocol_pro_connect_succ_revoke": "您已连接上账号 {{email}}。如果要取消连接,请点击此按钮。", "protocol_pro_connect_succ_revoke": "您已连接上账号 {{email}}。如果要取消连接,请点击此按钮。",
"protocol_box_connecting": "正在连接",
"protocol_box_connect_manualinput_succ": "连接成功",
"protocol_box_connect_fail": "Box 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权?",
"protocol_box_connect_succ_revoke": "您已连接上账号。如果要取消连接,请点击此按钮。",
"protocol_pcloud_connecting": "正在连接",
"protocol_pcloud_connect_manualinput_succ": "连接成功",
"protocol_pcloud_connect_fail": "pCloud 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权?",
"protocol_pcloud_connect_succ_revoke": "您已连接上账号。如果要取消连接,请点击此按钮。",
"protocol_yandexdisk_connecting": "正在连接",
"protocol_yandexdisk_connect_manualinput_succ": "连接成功",
"protocol_yandexdisk_connect_fail": "Yandex Disk 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权?",
"protocol_yandexdisk_connect_succ_revoke": "您已连接上账号。如果要取消连接,请点击此按钮。",
"protocol_koofr_connecting": "正在连接",
"protocol_koofr_connect_manualinput_succ": "连接成功",
"protocol_koofr_connect_fail": "Yandex Disk 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权?",
"protocol_koofr_connect_succ_revoke": "您已连接上账号。如果要取消连接,请点击此按钮。",
"modal_googledriveauth_tutorial": "<p>请访问此网址,然后会进入授权流程。最后,您会看到一个码,请复制粘贴到这里然后提交。</p>",
"modal_googledriveauth_copybutton": "点击以复制网址",
"modal_googledriveauth_copynotice": "网址已复制!",
"modal_googledrivce_maualinput": "网站上的码",
"modal_googledrivce_maualinput_desc": "请粘贴授权流程最后的那个码,然后点击确认。",
"modal_googledrive_maualinput_notice": "正在尝试连接 Google 并更新授权信息......",
"modal_googledrive_maualinput_succ_notice": "很好!授权信息已更新!",
"modal_googledrive_maualinput_fail_notice": "更新授权信息失败。请稍后重试。",
"modal_googledriverevokeauth_step1": "第 1 步:访问以下网址,可以删除连接。",
"modal_googledriverevokeauth_step2": "第 2 步:点击以下按钮,从而清理本地的登录信息。",
"modal_googledriverevokeauth_clean": "清理本地登录信息",
"modal_googledriverevokeauth_clean_desc": "您需要点击此按钮。",
"modal_googledriverevokeauth_clean_button": "清理",
"modal_googledriverevokeauth_clean_notice": "已清理!",
"modal_googledriverevokeauth_clean_fail": "清理授权时候发生了错误。",
"modal_boxauth_tutorial": "<p>请访问此网址,然后会进入授权流程。最后,您会被重定向回来。</p>",
"modal_boxauth_copybutton": "点击以复制网址",
"modal_boxauth_copynotice": "网址已复制!",
"modal_box_maualinput": "网站上的码",
"modal_box_maualinput_desc": "请粘贴授权流程最后的那个码,然后点击确认。",
"modal_box_maualinput_notice": "正在尝试连接 Box 并更新授权信息......",
"modal_box_maualinput_succ_notice": "很好!授权信息已更新!",
"modal_box_maualinput_fail_notice": "更新授权信息失败。请稍后重试。",
"modal_boxrevokeauth_step1": "第 1 步:访问以下网址,可以删除连接。",
"modal_boxrevokeauth_step2": "第 2 步:点击以下按钮,从而清理本地的登录信息。",
"modal_boxrevokeauth_clean": "清理本地登录信息",
"modal_boxrevokeauth_clean_desc": "您需要点击此按钮。",
"modal_boxrevokeauth_clean_button": "清理",
"modal_boxrevokeauth_clean_notice": "已清理!",
"modal_boxrevokeauth_clean_fail": "清理授权时候发生了错误。",
"modal_pcloudauth_tutorial": "<p>请访问此网址,然后会进入授权流程。最后,您会被重定向回来。</p>",
"modal_pcloudauth_copybutton": "点击以复制网址",
"modal_pcloudauth_copynotice": "网址已复制!",
"modal_pcloudrevokeauth_step1": "第 1 步:访问以下网址,可以删除连接。",
"modal_pcloudrevokeauth_step2": "第 2 步:点击以下按钮,从而清理本地的登录信息。",
"modal_pcloudrevokeauth_clean": "清理本地登录信息",
"modal_pcloudrevokeauth_clean_desc": "您需要点击此按钮。",
"modal_pcloudrevokeauth_clean_button": "清理",
"modal_pcloudrevokeauth_clean_notice": "已清理!",
"modal_pcloudrevokeauth_clean_fail": "清理授权时候发生了错误。",
"modal_yandexdiskauth_tutorial": "<p>请访问此网址,然后会进入授权流程。最后,您会被重定向回来。</p>",
"modal_yandexdiskauth_copybutton": "点击以复制网址",
"modal_yandexdiskauth_copynotice": "网址已复制!",
"modal_yandexdisk_maualinput": "网站上的码",
"modal_yandexdisk_maualinput_desc": "请粘贴授权流程最后的那个码,然后点击确认。",
"modal_yandexdisk_maualinput_notice": "正在尝试连接 Yandex Disk 并更新授权信息......",
"modal_yandexdisk_maualinput_succ_notice": "很好!授权信息已更新!",
"modal_yandexdisk_maualinput_fail_notice": "更新授权信息失败。请稍后重试。",
"modal_yandexdiskrevokeauth_step1": "第 1 步:访问以下网址,可以删除连接。",
"modal_yandexdiskrevokeauth_step2": "第 2 步:点击以下按钮,从而清理本地的登录信息。",
"modal_yandexdiskrevokeauth_clean": "清理本地登录信息",
"modal_yandexdiskrevokeauth_clean_desc": "您需要点击此按钮。",
"modal_yandexdiskrevokeauth_clean_button": "清理",
"modal_yandexdiskrevokeauth_clean_notice": "已清理!",
"modal_yandexdiskrevokeauth_clean_fail": "清理授权时候发生了错误。",
"modal_koofrauth_tutorial": "<p>请访问此网址,然后会进入授权流程。最后,您会被重定向回来。</p>",
"modal_koofrauth_copybutton": "点击以复制网址",
"modal_koofrauth_copynotice": "网址已复制!",
"modal_koofr_maualinput": "网站上的码",
"modal_koofr_maualinput_desc": "请粘贴授权流程最后的那个码,然后点击确认。",
"modal_koofr_maualinput_notice": "正在尝试连接 Yandex Disk 并更新授权信息......",
"modal_koofr_maualinput_succ_notice": "很好!授权信息已更新!",
"modal_koofr_maualinput_fail_notice": "更新授权信息失败。请稍后重试。",
"modal_koofrrevokeauth_step1": "第 1 步:访问以下网址,可以删除连接。",
"modal_koofrrevokeauth_step2": "第 2 步:点击以下按钮,从而清理本地的登录信息。",
"modal_koofrrevokeauth_clean": "清理本地登录信息",
"modal_koofrrevokeauth_clean_desc": "您需要点击此按钮。",
"modal_koofrrevokeauth_clean_button": "清理",
"modal_koofrrevokeauth_clean_notice": "已清理!",
"modal_koofrrevokeauth_clean_fail": "清理授权时候发生了错误。",
"modal_prorevokeauth": "点击这里和按照步骤取消授权。", "modal_prorevokeauth": "点击这里和按照步骤取消授权。",
"modal_prorevokeauth_clean": "清理", "modal_prorevokeauth_clean": "清理",
"modal_prorevokeauth_clean_desc": "清理本地授权记录", "modal_prorevokeauth_clean_desc": "清理本地授权记录",
@@ -20,6 +115,106 @@
"modal_proauth_maualinput_notice": "正在连接,请稍候......", "modal_proauth_maualinput_notice": "正在连接,请稍候......",
"modal_proauth_maualinput_conn_fail": "连接失败", "modal_proauth_maualinput_conn_fail": "连接失败",
"settings_googledrive": "Google Drive (PRO) (beta)",
"settings_chooseservice_googledrive": "Google Drive (PRO) (beta)",
"settings_googledrive_disclaimer1": "声明:本插件不是 Google 的官方产品。只是用到了它的公开 API。",
"settings_googledrive_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现任何不符合预期的 Google Drive 访问,请立刻在以下网站操作断开连接: https://myaccount.google.com/permissions 。",
"settings_googledrive_pro_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong><a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p>",
"settings_googledrive_notshowuphint": "Google Drive 设置不可用",
"settings_googledrive_notshowuphint_desc": "Google Drive 设置不可用,因为您没有在 Remotely Save 账号里开启这个 PRO 功能。",
"settings_googledrive_notshowuphint_view_pro": "查看 PRO 相关设置",
"settings_googledrive_folder": "我们会在 Google Drive 创建此文件夹并同步内容进去: {{remoteBaseDir}} 。请不要手动在网站上创建。",
"settings_googledrive_revoke": "撤回鉴权",
"settings_googledrive_revoke_desc": "您现在已连接。如果想取消连接,请点击此按钮。",
"settings_googledrive_revoke_button": "撤回鉴权",
"settings_googledrive_auth": "鉴权",
"settings_googledrive_auth_desc": "鉴权.",
"settings_googledrive_auth_button": "鉴权",
"settings_googledrive_connect_succ": "很好!我们可连接上 Google Drive",
"settings_googledrive_connect_fail": "我们未能连接上 Google Drive。",
"settings_box": "Box (PRO) (beta)",
"settings_chooseservice_box": "Box (PRO) (beta)",
"settings_box_disclaimer1": "声明:本插件不是 Box 的官方产品。只是用到了它的公开 API。",
"settings_box_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现任何不符合预期的 Box 访问,请立刻在以下网站操作断开连接: https://app.box.com/account/security 。",
"settings_box_pro_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong><a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p>",
"settings_box_notshowuphint": "Box 设置不可用",
"settings_box_notshowuphint_desc": "Box 设置不可用,因为您没有在 Remotely Save 账号里开启这个 PRO 功能。",
"settings_box_notshowuphint_view_pro": "查看 PRO 相关设置",
"settings_box_folder": "我们会在 Box 创建此文件夹并同步内容进去: {{remoteBaseDir}} 。请不要手动在网站上创建。",
"settings_box_revoke": "撤回鉴权",
"settings_box_revoke_desc": "您现在已连接。如果想取消连接,请点击此按钮。",
"settings_box_revoke_button": "撤回鉴权",
"settings_box_auth": "鉴权",
"settings_box_auth_desc": "鉴权.",
"settings_box_auth_button": "鉴权",
"settings_box_connect_succ": "很好!我们可连接上 Box",
"settings_box_connect_fail": "我们未能连接上 Box。",
"settings_pcloud": "pCloud (PRO) (beta)",
"settings_chooseservice_pcloud": "pCloud (PRO) (beta)",
"settings_pcloud_disclaimer1": "声明:本插件不是 pCloud 的官方产品。只是用到了它的公开 API。",
"settings_pcloud_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现任何不符合预期的 pCloud 访问,请立刻在以下网站操作断开连接: https://my.pcloud.com/#page=settings&settings=tab-apps 。",
"settings_pcloud_pro_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong><a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p>",
"settings_pcloud_notshowuphint": "pCloud 设置不可用",
"settings_pcloud_notshowuphint_desc": "pCloud 设置不可用,因为您没有在 Remotely Save 账号里开启这个 PRO 功能。",
"settings_pcloud_notshowuphint_view_pro": "查看 PRO 相关设置",
"settings_pcloud_folder": "我们会在 pCloud 创建此文件夹并同步内容进去: {{remoteBaseDir}} 。请不要手动在网站上创建。",
"settings_pcloud_revoke": "撤回鉴权",
"settings_pcloud_revoke_desc": "您现在已连接。如果想取消连接,请点击此按钮。",
"settings_pcloud_revoke_button": "撤回鉴权",
"settings_pcloud_auth": "鉴权",
"settings_pcloud_auth_desc": "鉴权.",
"settings_pcloud_auth_button": "鉴权",
"settings_pcloud_emptyfile": "空文件",
"settings_pcloud_emptyfile_desc": "pCloud API 不支持上传空文件,怎么处理?",
"settings_pcloud_emptyfile_skip": "跳过",
"settings_pcloud_emptyfile_error": "提示错误",
"settings_pcloud_connect_succ": "很好!我们可连接上 pCloud",
"settings_pcloud_connect_fail": "我们未能连接上 pCloud。",
"settings_yandexdisk": "Yandex Disk (PRO) (beta)",
"settings_chooseservice_yandexdisk": "Yandex Disk (PRO) (beta)",
"settings_yandexdisk_disclaimer1": "声明:本插件不是 Yandex Disk 的官方产品。只是用到了它的公开 API。",
"settings_yandexdisk_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现任何不符合预期的 Yandex Disk 访问,请立刻在以下网站操作断开连接: https://id.yandex.com/profile/devices 。",
"settings_yandexdisk_pro_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong><a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p>",
"settings_yandexdisk_notshowuphint": "Yandex Disk 设置不可用",
"settings_yandexdisk_notshowuphint_desc": "Yandex Disk 设置不可用,因为您没有在 Remotely Save 账号里开启这个 PRO 功能。",
"settings_yandexdisk_notshowuphint_view_pro": "查看 PRO 相关设置",
"settings_yandexdisk_folder": "我们会在 Yandex Disk 创建此文件夹并同步内容进去: {{remoteBaseDir}} 。请不要手动在网站上创建。",
"settings_yandexdisk_revoke": "撤回鉴权",
"settings_yandexdisk_revoke_desc": "您现在已连接。如果想取消连接,请点击此按钮。",
"settings_yandexdisk_revoke_button": "撤回鉴权",
"settings_yandexdisk_auth": "鉴权",
"settings_yandexdisk_auth_desc": "鉴权.",
"settings_yandexdisk_auth_button": "鉴权",
"settings_yandexdisk_connect_succ": "很好!我们可连接上 Yandex Disk",
"settings_yandexdisk_connect_fail": "我们未能连接上 Yandex Disk。",
"settings_koofr": "Koofr (PRO) (beta)",
"settings_chooseservice_koofr": "Koofr (PRO) (beta)",
"settings_koofr_disclaimer1": "声明:本插件不是 Koofr 的官方产品。只是用到了它的公开 API。",
"settings_koofr_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现任何不符合预期的 Koofr 访问,请立刻在以下网站操作断开连接: https://app.koofr.net/app/admin/preferences/security 。",
"settings_koofr_pro_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong><a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p>",
"settings_koofr_notshowuphint": "Koofr 设置不可用",
"settings_koofr_notshowuphint_desc": "Koofr 设置不可用,因为您没有在 Remotely Save 账号里开启这个 PRO 功能。",
"settings_koofr_notshowuphint_view_pro": "查看 PRO 相关设置",
"settings_koofr_folder": "我们会在 Koofr 创建此文件夹并同步内容进去: {{remoteBaseDir}} 。请不要手动在网站上创建。",
"settings_koofr_revoke": "撤回鉴权",
"settings_koofr_revoke_desc": "您现在已连接。如果想取消连接,请点击此按钮。",
"settings_koofr_revoke_button": "撤回鉴权",
"settings_koofr_auth": "鉴权",
"settings_koofr_auth_desc": "鉴权.",
"settings_koofr_auth_button": "鉴权",
"settings_koofr_connect_succ": "很好!我们可连接上 Koofr",
"settings_koofr_connect_fail": "我们未能连接上 Koofr。",
"settings_export_googledrive_button": "导出 Google Drive 部分",
"settings_export_box_button": "导出 Box 部分",
"settings_export_pcloud_button": "导出 pCloud 部分",
"settings_export_yandexdisk_button": "导出 Yandex Disk 部分",
"settings_export_koofr_button": "导出 Koofr 部分",
"settings_pro": "账号(PRO 付费功能)", "settings_pro": "账号(PRO 付费功能)",
"settings_pro_tutorial": "<p>使用 Remotely Save 的<stong>基本</strong>功能是<strong>免费的</strong>,而且<strong>不</strong>需要注册对应账号。</p><p>但是,您<strong>需要</strong>注册账号和对<strong>PRO</strong>功能<strong>付费</strong>使用,如智能处理冲突功能。</p><p>第一步:点击按钮从而注册和登录网站:<a href=\"https://remotelysave.com\">https://remotelysave.com</a>。注意:这和 Obsidian 官方账号无关,是不同的账号。</p><p>第二部:点击“连接”按钮,从而连接本设备和在线账号。", "settings_pro_tutorial": "<p>使用 Remotely Save 的<stong>基本</strong>功能是<strong>免费的</strong>,而且<strong>不</strong>需要注册对应账号。</p><p>但是,您<strong>需要</strong>注册账号和对<strong>PRO</strong>功能<strong>付费</strong>使用,如智能处理冲突功能。</p><p>第一步:点击按钮从而注册和登录网站:<a href=\"https://remotelysave.com\">https://remotelysave.com</a>。注意:这和 Obsidian 官方账号无关,是不同的账号。</p><p>第二部:点击“连接”按钮,从而连接本设备和在线账号。",
"settings_pro_features": "功能", "settings_pro_features": "功能",
+195
View File
@@ -7,6 +7,101 @@
"protocol_pro_connect_fail": "Remotely Save 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權?", "protocol_pro_connect_fail": "Remotely Save 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權?",
"protocol_pro_connect_succ_revoke": "您已連線上賬號 {{email}}。如果要取消連線,請點選此按鈕。", "protocol_pro_connect_succ_revoke": "您已連線上賬號 {{email}}。如果要取消連線,請點選此按鈕。",
"protocol_box_connecting": "正在連線",
"protocol_box_connect_manualinput_succ": "連線成功",
"protocol_box_connect_fail": "Box 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權?",
"protocol_box_connect_succ_revoke": "您已連線上賬號。如果要取消連線,請點選此按鈕。",
"protocol_pcloud_connecting": "正在連線",
"protocol_pcloud_connect_manualinput_succ": "連線成功",
"protocol_pcloud_connect_fail": "pCloud 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權?",
"protocol_pcloud_connect_succ_revoke": "您已連線上賬號。如果要取消連線,請點選此按鈕。",
"protocol_yandexdisk_connecting": "正在連線",
"protocol_yandexdisk_connect_manualinput_succ": "連線成功",
"protocol_yandexdisk_connect_fail": "Yandex Disk 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權?",
"protocol_yandexdisk_connect_succ_revoke": "您已連線上賬號。如果要取消連線,請點選此按鈕。",
"protocol_koofr_connecting": "正在連線",
"protocol_koofr_connect_manualinput_succ": "連線成功",
"protocol_koofr_connect_fail": "Yandex Disk 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權?",
"protocol_koofr_connect_succ_revoke": "您已連線上賬號。如果要取消連線,請點選此按鈕。",
"modal_googledriveauth_tutorial": "<p>請訪問此網址,然後會進入授權流程。最後,您會看到一個碼,請複製貼上到這裡然後提交。</p>",
"modal_googledriveauth_copybutton": "點選以複製網址",
"modal_googledriveauth_copynotice": "網址已複製!",
"modal_googledrivce_maualinput": "網站上的碼",
"modal_googledrivce_maualinput_desc": "請貼上授權流程最後的那個碼,然後點選確認。",
"modal_googledrive_maualinput_notice": "正在嘗試連線 Google 並更新授權資訊......",
"modal_googledrive_maualinput_succ_notice": "很好!授權資訊已更新!",
"modal_googledrive_maualinput_fail_notice": "更新授權資訊失敗。請稍後重試。",
"modal_googledriverevokeauth_step1": "第 1 步:訪問以下網址,可以刪除連線。",
"modal_googledriverevokeauth_step2": "第 2 步:點選以下按鈕,從而清理本地的登入資訊。",
"modal_googledriverevokeauth_clean": "清理本地登入資訊",
"modal_googledriverevokeauth_clean_desc": "您需要點選此按鈕。",
"modal_googledriverevokeauth_clean_button": "清理",
"modal_googledriverevokeauth_clean_notice": "已清理!",
"modal_googledriverevokeauth_clean_fail": "清理授權時候發生了錯誤。",
"modal_boxauth_tutorial": "<p>請訪問此網址,然後會進入授權流程。最後,您會被重定向回來。</p>",
"modal_boxauth_copybutton": "點選以複製網址",
"modal_boxauth_copynotice": "網址已複製!",
"modal_box_maualinput": "網站上的碼",
"modal_box_maualinput_desc": "請貼上授權流程最後的那個碼,然後點選確認。",
"modal_box_maualinput_notice": "正在嘗試連線 Box 並更新授權資訊......",
"modal_box_maualinput_succ_notice": "很好!授權資訊已更新!",
"modal_box_maualinput_fail_notice": "更新授權資訊失敗。請稍後重試。",
"modal_boxrevokeauth_step1": "第 1 步:訪問以下網址,可以刪除連線。",
"modal_boxrevokeauth_step2": "第 2 步:點選以下按鈕,從而清理本地的登入資訊。",
"modal_boxrevokeauth_clean": "清理本地登入資訊",
"modal_boxrevokeauth_clean_desc": "您需要點選此按鈕。",
"modal_boxrevokeauth_clean_button": "清理",
"modal_boxrevokeauth_clean_notice": "已清理!",
"modal_boxrevokeauth_clean_fail": "清理授權時候發生了錯誤。",
"modal_pcloudauth_tutorial": "<p>請訪問此網址,然後會進入授權流程。最後,您會被重定向回來。</p>",
"modal_pcloudauth_copybutton": "點選以複製網址",
"modal_pcloudauth_copynotice": "網址已複製!",
"modal_pcloudrevokeauth_step1": "第 1 步:訪問以下網址,可以刪除連線。",
"modal_pcloudrevokeauth_step2": "第 2 步:點選以下按鈕,從而清理本地的登入資訊。",
"modal_pcloudrevokeauth_clean": "清理本地登入資訊",
"modal_pcloudrevokeauth_clean_desc": "您需要點選此按鈕。",
"modal_pcloudrevokeauth_clean_button": "清理",
"modal_pcloudrevokeauth_clean_notice": "已清理!",
"modal_pcloudrevokeauth_clean_fail": "清理授權時候發生了錯誤。",
"modal_yandexdiskauth_tutorial": "<p>請訪問此網址,然後會進入授權流程。最後,您會被重定向回來。</p>",
"modal_yandexdiskauth_copybutton": "點選以複製網址",
"modal_yandexdiskauth_copynotice": "網址已複製!",
"modal_yandexdisk_maualinput": "網站上的碼",
"modal_yandexdisk_maualinput_desc": "請貼上授權流程最後的那個碼,然後點選確認。",
"modal_yandexdisk_maualinput_notice": "正在嘗試連線 Yandex Disk 並更新授權資訊......",
"modal_yandexdisk_maualinput_succ_notice": "很好!授權資訊已更新!",
"modal_yandexdisk_maualinput_fail_notice": "更新授權資訊失敗。請稍後重試。",
"modal_yandexdiskrevokeauth_step1": "第 1 步:訪問以下網址,可以刪除連線。",
"modal_yandexdiskrevokeauth_step2": "第 2 步:點選以下按鈕,從而清理本地的登入資訊。",
"modal_yandexdiskrevokeauth_clean": "清理本地登入資訊",
"modal_yandexdiskrevokeauth_clean_desc": "您需要點選此按鈕。",
"modal_yandexdiskrevokeauth_clean_button": "清理",
"modal_yandexdiskrevokeauth_clean_notice": "已清理!",
"modal_yandexdiskrevokeauth_clean_fail": "清理授權時候發生了錯誤。",
"modal_koofrauth_tutorial": "<p>請訪問此網址,然後會進入授權流程。最後,您會被重定向回來。</p>",
"modal_koofrauth_copybutton": "點選以複製網址",
"modal_koofrauth_copynotice": "網址已複製!",
"modal_koofr_maualinput": "網站上的碼",
"modal_koofr_maualinput_desc": "請貼上授權流程最後的那個碼,然後點選確認。",
"modal_koofr_maualinput_notice": "正在嘗試連線 Yandex Disk 並更新授權資訊......",
"modal_koofr_maualinput_succ_notice": "很好!授權資訊已更新!",
"modal_koofr_maualinput_fail_notice": "更新授權資訊失敗。請稍後重試。",
"modal_koofrrevokeauth_step1": "第 1 步:訪問以下網址,可以刪除連線。",
"modal_koofrrevokeauth_step2": "第 2 步:點選以下按鈕,從而清理本地的登入資訊。",
"modal_koofrrevokeauth_clean": "清理本地登入資訊",
"modal_koofrrevokeauth_clean_desc": "您需要點選此按鈕。",
"modal_koofrrevokeauth_clean_button": "清理",
"modal_koofrrevokeauth_clean_notice": "已清理!",
"modal_koofrrevokeauth_clean_fail": "清理授權時候發生了錯誤。",
"modal_prorevokeauth": "點選這裡和按照步驟取消授權。", "modal_prorevokeauth": "點選這裡和按照步驟取消授權。",
"modal_prorevokeauth_clean": "清理", "modal_prorevokeauth_clean": "清理",
"modal_prorevokeauth_clean_desc": "清理本地授權記錄", "modal_prorevokeauth_clean_desc": "清理本地授權記錄",
@@ -20,6 +115,106 @@
"modal_proauth_maualinput_notice": "正在連線,請稍候......", "modal_proauth_maualinput_notice": "正在連線,請稍候......",
"modal_proauth_maualinput_conn_fail": "連線失敗", "modal_proauth_maualinput_conn_fail": "連線失敗",
"settings_googledrive": "Google Drive (PRO) (beta)",
"settings_chooseservice_googledrive": "Google Drive (PRO) (beta)",
"settings_googledrive_disclaimer1": "宣告:本外掛不是 Google 的官方產品。只是用到了它的公開 API。",
"settings_googledrive_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現任何不符合預期的 Google Drive 訪問,請立刻在以下網站操作斷開連線: https://myaccount.google.com/permissions 。",
"settings_googledrive_pro_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong><a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p>",
"settings_googledrive_notshowuphint": "Google Drive 設定不可用",
"settings_googledrive_notshowuphint_desc": "Google Drive 設定不可用,因為您沒有在 Remotely Save 賬號裡開啟這個 PRO 功能。",
"settings_googledrive_notshowuphint_view_pro": "檢視 PRO 相關設定",
"settings_googledrive_folder": "我們會在 Google Drive 建立此資料夾並同步內容進去: {{remoteBaseDir}} 。請不要手動在網站上建立。",
"settings_googledrive_revoke": "撤回鑑權",
"settings_googledrive_revoke_desc": "您現在已連線。如果想取消連線,請點選此按鈕。",
"settings_googledrive_revoke_button": "撤回鑑權",
"settings_googledrive_auth": "鑑權",
"settings_googledrive_auth_desc": "鑑權.",
"settings_googledrive_auth_button": "鑑權",
"settings_googledrive_connect_succ": "很好!我們可連線上 Google Drive",
"settings_googledrive_connect_fail": "我們未能連線上 Google Drive。",
"settings_box": "Box (PRO) (beta)",
"settings_chooseservice_box": "Box (PRO) (beta)",
"settings_box_disclaimer1": "宣告:本外掛不是 Box 的官方產品。只是用到了它的公開 API。",
"settings_box_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現任何不符合預期的 Box 訪問,請立刻在以下網站操作斷開連線: https://app.box.com/account/security 。",
"settings_box_pro_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong><a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p>",
"settings_box_notshowuphint": "Box 設定不可用",
"settings_box_notshowuphint_desc": "Box 設定不可用,因為您沒有在 Remotely Save 賬號裡開啟這個 PRO 功能。",
"settings_box_notshowuphint_view_pro": "檢視 PRO 相關設定",
"settings_box_folder": "我們會在 Box 建立此資料夾並同步內容進去: {{remoteBaseDir}} 。請不要手動在網站上建立。",
"settings_box_revoke": "撤回鑑權",
"settings_box_revoke_desc": "您現在已連線。如果想取消連線,請點選此按鈕。",
"settings_box_revoke_button": "撤回鑑權",
"settings_box_auth": "鑑權",
"settings_box_auth_desc": "鑑權.",
"settings_box_auth_button": "鑑權",
"settings_box_connect_succ": "很好!我們可連線上 Box",
"settings_box_connect_fail": "我們未能連線上 Box。",
"settings_pcloud": "pCloud (PRO) (beta)",
"settings_chooseservice_pcloud": "pCloud (PRO) (beta)",
"settings_pcloud_disclaimer1": "宣告:本外掛不是 pCloud 的官方產品。只是用到了它的公開 API。",
"settings_pcloud_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現任何不符合預期的 pCloud 訪問,請立刻在以下網站操作斷開連線: https://my.pcloud.com/#page=settings&settings=tab-apps 。",
"settings_pcloud_pro_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong><a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p>",
"settings_pcloud_notshowuphint": "pCloud 設定不可用",
"settings_pcloud_notshowuphint_desc": "pCloud 設定不可用,因為您沒有在 Remotely Save 賬號裡開啟這個 PRO 功能。",
"settings_pcloud_notshowuphint_view_pro": "檢視 PRO 相關設定",
"settings_pcloud_folder": "我們會在 pCloud 建立此資料夾並同步內容進去: {{remoteBaseDir}} 。請不要手動在網站上建立。",
"settings_pcloud_revoke": "撤回鑑權",
"settings_pcloud_revoke_desc": "您現在已連線。如果想取消連線,請點選此按鈕。",
"settings_pcloud_revoke_button": "撤回鑑權",
"settings_pcloud_auth": "鑑權",
"settings_pcloud_auth_desc": "鑑權.",
"settings_pcloud_auth_button": "鑑權",
"settings_pcloud_emptyfile": "空檔案",
"settings_pcloud_emptyfile_desc": "pCloud API 不支援上傳空檔案,怎麼處理?",
"settings_pcloud_emptyfile_skip": "跳過",
"settings_pcloud_emptyfile_error": "提示錯誤",
"settings_pcloud_connect_succ": "很好!我們可連線上 pCloud",
"settings_pcloud_connect_fail": "我們未能連線上 pCloud。",
"settings_yandexdisk": "Yandex Disk (PRO) (beta)",
"settings_chooseservice_yandexdisk": "Yandex Disk (PRO) (beta)",
"settings_yandexdisk_disclaimer1": "宣告:本外掛不是 Yandex Disk 的官方產品。只是用到了它的公開 API。",
"settings_yandexdisk_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現任何不符合預期的 Yandex Disk 訪問,請立刻在以下網站操作斷開連線: https://id.yandex.com/profile/devices 。",
"settings_yandexdisk_pro_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong><a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p>",
"settings_yandexdisk_notshowuphint": "Yandex Disk 設定不可用",
"settings_yandexdisk_notshowuphint_desc": "Yandex Disk 設定不可用,因為您沒有在 Remotely Save 賬號裡開啟這個 PRO 功能。",
"settings_yandexdisk_notshowuphint_view_pro": "檢視 PRO 相關設定",
"settings_yandexdisk_folder": "我們會在 Yandex Disk 建立此資料夾並同步內容進去: {{remoteBaseDir}} 。請不要手動在網站上建立。",
"settings_yandexdisk_revoke": "撤回鑑權",
"settings_yandexdisk_revoke_desc": "您現在已連線。如果想取消連線,請點選此按鈕。",
"settings_yandexdisk_revoke_button": "撤回鑑權",
"settings_yandexdisk_auth": "鑑權",
"settings_yandexdisk_auth_desc": "鑑權.",
"settings_yandexdisk_auth_button": "鑑權",
"settings_yandexdisk_connect_succ": "很好!我們可連線上 Yandex Disk",
"settings_yandexdisk_connect_fail": "我們未能連線上 Yandex Disk。",
"settings_koofr": "Koofr (PRO) (beta)",
"settings_chooseservice_koofr": "Koofr (PRO) (beta)",
"settings_koofr_disclaimer1": "宣告:本外掛不是 Koofr 的官方產品。只是用到了它的公開 API。",
"settings_koofr_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現任何不符合預期的 Koofr 訪問,請立刻在以下網站操作斷開連線: https://app.koofr.net/app/admin/preferences/security 。",
"settings_koofr_pro_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong><a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p>",
"settings_koofr_notshowuphint": "Koofr 設定不可用",
"settings_koofr_notshowuphint_desc": "Koofr 設定不可用,因為您沒有在 Remotely Save 賬號裡開啟這個 PRO 功能。",
"settings_koofr_notshowuphint_view_pro": "檢視 PRO 相關設定",
"settings_koofr_folder": "我們會在 Koofr 建立此資料夾並同步內容進去: {{remoteBaseDir}} 。請不要手動在網站上建立。",
"settings_koofr_revoke": "撤回鑑權",
"settings_koofr_revoke_desc": "您現在已連線。如果想取消連線,請點選此按鈕。",
"settings_koofr_revoke_button": "撤回鑑權",
"settings_koofr_auth": "鑑權",
"settings_koofr_auth_desc": "鑑權.",
"settings_koofr_auth_button": "鑑權",
"settings_koofr_connect_succ": "很好!我們可連線上 Koofr",
"settings_koofr_connect_fail": "我們未能連線上 Koofr。",
"settings_export_googledrive_button": "匯出 Google Drive 部分",
"settings_export_box_button": "匯出 Box 部分",
"settings_export_pcloud_button": "匯出 pCloud 部分",
"settings_export_yandexdisk_button": "匯出 Yandex Disk 部分",
"settings_export_koofr_button": "匯出 Koofr 部分",
"settings_pro": "賬號(PRO 付費功能)", "settings_pro": "賬號(PRO 付費功能)",
"settings_pro_tutorial": "<p>使用 Remotely Save 的<stong>基本</strong>功能是<strong>免費的</strong>,而且<strong>不</strong>需要註冊對應賬號。</p><p>但是,您<strong>需要</strong>註冊賬號和對<strong>PRO</strong>功能<strong>付費</strong>使用,如智慧處理衝突功能。</p><p>第一步:點選按鈕從而註冊和登入網站:<a href=\"https://remotelysave.com\">https://remotelysave.com</a>。注意:這和 Obsidian 官方賬號無關,是不同的賬號。</p><p>第二部:點選“連線”按鈕,從而連線本裝置和線上賬號。", "settings_pro_tutorial": "<p>使用 Remotely Save 的<stong>基本</strong>功能是<strong>免費的</strong>,而且<strong>不</strong>需要註冊對應賬號。</p><p>但是,您<strong>需要</strong>註冊賬號和對<strong>PRO</strong>功能<strong>付費</strong>使用,如智慧處理衝突功能。</p><p>第一步:點選按鈕從而註冊和登入網站:<a href=\"https://remotelysave.com\">https://remotelysave.com</a>。注意:這和 Obsidian 官方賬號無關,是不同的賬號。</p><p>第二部:點選“連線”按鈕,從而連線本裝置和線上賬號。",
"settings_pro_features": "功能", "settings_pro_features": "功能",
+26
View File
@@ -0,0 +1,26 @@
import { base64url } from "rfc4648";
/**
* https://datatracker.ietf.org/doc/html/rfc7636
* dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
* => E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM
* @param x
* @returns BASE64URL-ENCODE(SHA256(ASCII(code_verifier)))
*/
export async function codeVerifier2CodeChallenge(x: string) {
if (x === undefined || x === "") {
return "";
}
try {
return base64url.stringify(
new Uint8Array(
await crypto.subtle.digest("SHA-256", new TextEncoder().encode(x))
),
{
pad: false,
}
);
} catch (e) {
return "";
}
}
+367
View File
@@ -0,0 +1,367 @@
import cloneDeep from "lodash/cloneDeep";
import { type App, Modal, Notice, Setting } from "obsidian";
import { getClient } from "../../src/fsGetter";
import type { TransItemType } from "../../src/i18n";
import type RemotelySavePlugin from "../../src/main";
import { stringToFragment } from "../../src/misc";
import { ChangeRemoteBaseDirModal } from "../../src/settings";
import {
DEFAULT_BOX_CONFIG,
generateAuthUrl,
sendRefreshTokenReq,
} from "./fsBox";
class BoxAuthModal extends Modal {
readonly plugin: RemotelySavePlugin;
readonly authDiv: HTMLDivElement;
readonly revokeAuthDiv: HTMLDivElement;
readonly revokeAuthSetting: Setting;
readonly t: (x: TransItemType, vars?: any) => string;
constructor(
app: App,
plugin: RemotelySavePlugin,
authDiv: HTMLDivElement,
revokeAuthDiv: HTMLDivElement,
revokeAuthSetting: Setting,
t: (x: TransItemType, vars?: any) => string
) {
super(app);
this.plugin = plugin;
this.authDiv = authDiv;
this.revokeAuthDiv = revokeAuthDiv;
this.revokeAuthSetting = revokeAuthSetting;
this.t = t;
}
async onOpen() {
const { contentEl } = this;
const t = this.t;
const authUrl = generateAuthUrl();
const div2 = contentEl.createDiv();
div2.createDiv({
text: stringToFragment(t("modal_boxauth_tutorial")),
});
div2.createEl(
"button",
{
text: t("modal_boxauth_copybutton"),
},
(el) => {
el.onclick = async () => {
await navigator.clipboard.writeText(authUrl);
new Notice(t("modal_boxauth_copynotice"));
};
}
);
contentEl.createEl("p").createEl("a", {
href: authUrl,
text: authUrl,
});
// let refreshToken = "";
// new Setting(contentEl)
// .setName(t("modal_box_maualinput"))
// .setDesc(t("modal_box_maualinput_desc"))
// .addText((text) =>
// text
// .setPlaceholder("")
// .setValue("")
// .onChange((val) => {
// refreshToken = val.trim();
// })
// )
// .addButton(async (button) => {
// button.setButtonText(t("submit"));
// button.onClick(async () => {
// new Notice(t("modal_box_maualinput_notice"));
// try {
// if (this.plugin.settings.box === undefined) {
// this.plugin.settings.box = cloneDeep(
// DEFAULT_BOX_CONFIG
// );
// }
// this.plugin.settings.box.refreshToken = refreshToken;
// this.plugin.settings.box.accessToken = "access";
// this.plugin.settings.box.accessTokenExpiresAtTimeMs = 1;
// this.plugin.settings.box.accessTokenExpiresInMs = 1;
// // TODO: abstraction leaking now, how to fix?
// const k = await sendRefreshTokenReq(refreshToken);
// const ts = Date.now();
// this.plugin.settings.box.accessToken = k.access_token;
// this.plugin.settings.box.accessTokenExpiresInMs =
// k.expires_in * 1000;
// this.plugin.settings.box.accessTokenExpiresAtTimeMs =
// ts + k.expires_in * 1000 - 60 * 2 * 1000;
// await this.plugin.saveSettings();
// // try to remove data in clipboard
// await navigator.clipboard.writeText("");
// new Notice(t("modal_box_maualinput_succ_notice"));
// } catch (e) {
// console.error(e);
// new Notice(t("modal_box_maualinput_fail_notice"));
// } finally {
// this.authDiv.toggleClass(
// "box-auth-button-hide",
// this.plugin.settings.box.refreshToken !== ""
// );
// this.revokeAuthDiv.toggleClass(
// "box-revoke-auth-button-hide",
// this.plugin.settings.box.refreshToken === ""
// );
// this.close();
// }
// });
// });
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
class BoxRevokeAuthModal extends Modal {
readonly plugin: RemotelySavePlugin;
readonly authDiv: HTMLDivElement;
readonly revokeAuthDiv: HTMLDivElement;
readonly t: (x: TransItemType, vars?: any) => string;
constructor(
app: App,
plugin: RemotelySavePlugin,
authDiv: HTMLDivElement,
revokeAuthDiv: HTMLDivElement,
t: (x: TransItemType, vars?: any) => string
) {
super(app);
this.plugin = plugin;
this.authDiv = authDiv;
this.revokeAuthDiv = revokeAuthDiv;
this.t = t;
}
async onOpen() {
const t = this.t;
const { contentEl } = this;
contentEl.createEl("p", {
text: t("modal_boxrevokeauth_step1"),
});
const consentUrl = "https://app.box.com/account/security";
contentEl.createEl("p").createEl("a", {
href: consentUrl,
text: consentUrl,
});
contentEl.createEl("p", {
text: t("modal_boxrevokeauth_step2"),
});
new Setting(contentEl)
.setName(t("modal_boxrevokeauth_clean"))
.setDesc(t("modal_boxrevokeauth_clean_desc"))
.addButton(async (button) => {
button.setButtonText(t("modal_boxrevokeauth_clean_button"));
button.onClick(async () => {
try {
this.plugin.settings.box = cloneDeep(DEFAULT_BOX_CONFIG);
await this.plugin.saveSettings();
this.authDiv.toggleClass(
"box-auth-button-hide",
this.plugin.settings.box.refreshToken !== ""
);
this.revokeAuthDiv.toggleClass(
"box-revoke-auth-button-hide",
this.plugin.settings.box.refreshToken === ""
);
new Notice(t("modal_boxrevokeauth_clean_notice"));
this.close();
} catch (err) {
console.error(err);
new Notice(t("modal_boxrevokeauth_clean_fail"));
}
});
});
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
export const generateBoxSettingsPart = (
containerEl: HTMLElement,
t: (x: TransItemType, vars?: any) => string,
app: App,
plugin: RemotelySavePlugin,
saveUpdatedConfigFunc: () => Promise<any> | undefined
) => {
const boxDiv = containerEl.createEl("div", {
cls: "box-hide",
});
boxDiv.toggleClass("box-hide", plugin.settings.serviceType !== "box");
boxDiv.createEl("h2", { text: t("settings_box") });
const boxLongDescDiv = boxDiv.createEl("div", {
cls: "settings-long-desc",
});
for (const c of [
t("settings_box_disclaimer1"),
t("settings_box_disclaimer2"),
]) {
boxLongDescDiv.createEl("p", {
text: c,
cls: "box-disclaimer",
});
}
boxLongDescDiv.createEl("p", {
text: t("settings_box_folder", {
remoteBaseDir: plugin.settings.box.remoteBaseDir || app.vault.getName(),
}),
});
boxLongDescDiv.createDiv({
text: stringToFragment(t("settings_box_pro_desc")),
cls: "box-disclaimer",
});
const boxNotShowUpHintSetting = new Setting(boxDiv)
.setName(t("settings_box_notshowuphint"))
.setDesc(t("settings_box_notshowuphint_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_box_notshowuphint_view_pro"));
button.onClick(async () => {
window.location.href = "#settings-pro";
});
});
const boxAllowedToUsedDiv = boxDiv.createDiv();
// if pro enabled, show up; otherwise hide.
const allowBox =
plugin.settings.pro?.enabledProFeatures.filter(
(x) => x.featureName === "feature-box"
).length === 1;
console.debug(`allow to show up box settings? ${allowBox}`);
if (allowBox) {
boxAllowedToUsedDiv.removeClass("box-allow-to-use-hide");
boxNotShowUpHintSetting.settingEl.addClass("box-allow-to-use-hide");
} else {
boxAllowedToUsedDiv.addClass("box-allow-to-use-hide");
boxNotShowUpHintSetting.settingEl.removeClass("box-allow-to-use-hide");
}
const boxSelectAuthDiv = boxAllowedToUsedDiv.createDiv();
const boxAuthDiv = boxSelectAuthDiv.createDiv({
cls: "box-auth-button-hide settings-auth-related",
});
const boxRevokeAuthDiv = boxSelectAuthDiv.createDiv({
cls: "box-revoke-auth-button-hide settings-auth-related",
});
const boxRevokeAuthSetting = new Setting(boxRevokeAuthDiv)
.setName(t("settings_box_revoke"))
.setDesc(t("settings_box_revoke_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_box_revoke_button"));
button.onClick(async () => {
new BoxRevokeAuthModal(
app,
plugin,
boxAuthDiv,
boxRevokeAuthDiv,
t
).open();
});
});
new Setting(boxAuthDiv)
.setName(t("settings_box_auth"))
.setDesc(t("settings_box_auth_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_box_auth_button"));
button.onClick(async () => {
const modal = new BoxAuthModal(
app,
plugin,
boxAuthDiv,
boxRevokeAuthDiv,
boxRevokeAuthSetting,
t
);
plugin.oauth2Info.helperModal = modal;
plugin.oauth2Info.authDiv = boxAuthDiv;
plugin.oauth2Info.revokeDiv = boxRevokeAuthDiv;
plugin.oauth2Info.revokeAuthSetting = boxRevokeAuthSetting;
modal.open();
});
});
boxAuthDiv.toggleClass(
"box-auth-button-hide",
plugin.settings.box.refreshToken !== ""
);
boxRevokeAuthDiv.toggleClass(
"box-revoke-auth-button-hide",
plugin.settings.box.refreshToken === ""
);
let newboxRemoteBaseDir = plugin.settings.box.remoteBaseDir || "";
new Setting(boxAllowedToUsedDiv)
.setName(t("settings_remotebasedir"))
.setDesc(t("settings_remotebasedir_desc"))
.addText((text) =>
text
.setPlaceholder(app.vault.getName())
.setValue(newboxRemoteBaseDir)
.onChange((value) => {
newboxRemoteBaseDir = value.trim();
})
)
.addButton((button) => {
button.setButtonText(t("confirm"));
button.onClick(() => {
new ChangeRemoteBaseDirModal(
app,
plugin,
newboxRemoteBaseDir,
"box"
).open();
});
});
new Setting(boxAllowedToUsedDiv)
.setName(t("settings_checkonnectivity"))
.setDesc(t("settings_checkonnectivity_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_checkonnectivity_button"));
button.onClick(async () => {
new Notice(t("settings_checkonnectivity_checking"));
const client = getClient(plugin.settings, app.vault.getName(), () =>
plugin.saveSettings()
);
const errors = { msg: "" };
const res = await client.checkConnect((err: any) => {
errors.msg = `${err}`;
});
if (res) {
new Notice(t("settings_box_connect_succ"));
} else {
new Notice(t("settings_box_connect_fail"));
new Notice(errors.msg);
}
});
});
return {
boxDiv: boxDiv,
boxAllowedToUsedDiv: boxAllowedToUsedDiv,
boxNotShowUpHintSetting: boxNotShowUpHintSetting,
};
};
+377
View File
@@ -0,0 +1,377 @@
import cloneDeep from "lodash/cloneDeep";
import { type App, Modal, Notice, Setting } from "obsidian";
import { getClient } from "../../src/fsGetter";
import type { TransItemType } from "../../src/i18n";
import type RemotelySavePlugin from "../../src/main";
import { stringToFragment } from "../../src/misc";
import { ChangeRemoteBaseDirModal } from "../../src/settings";
import {
DEFAULT_GOOGLEDRIVE_CONFIG,
sendRefreshTokenReq,
} from "./fsGoogleDrive";
class GoogleDriveAuthModal extends Modal {
readonly plugin: RemotelySavePlugin;
readonly authDiv: HTMLDivElement;
readonly revokeAuthDiv: HTMLDivElement;
readonly revokeAuthSetting: Setting;
readonly t: (x: TransItemType, vars?: any) => string;
constructor(
app: App,
plugin: RemotelySavePlugin,
authDiv: HTMLDivElement,
revokeAuthDiv: HTMLDivElement,
revokeAuthSetting: Setting,
t: (x: TransItemType, vars?: any) => string
) {
super(app);
this.plugin = plugin;
this.authDiv = authDiv;
this.revokeAuthDiv = revokeAuthDiv;
this.revokeAuthSetting = revokeAuthSetting;
this.t = t;
}
async onOpen() {
const { contentEl } = this;
const t = this.t;
const authUrl = "https://remotelysave.com/auth/googledrive/start";
const div2 = contentEl.createDiv();
div2.createDiv({
text: stringToFragment(t("modal_googledriveauth_tutorial")),
});
div2.createEl(
"button",
{
text: t("modal_googledriveauth_copybutton"),
},
(el) => {
el.onclick = async () => {
await navigator.clipboard.writeText(authUrl);
new Notice(t("modal_googledriveauth_copynotice"));
};
}
);
contentEl.createEl("p").createEl("a", {
href: authUrl,
text: authUrl,
});
let refreshToken = "";
new Setting(contentEl)
.setName(t("modal_googledrivce_maualinput"))
.setDesc(t("modal_googledrivce_maualinput_desc"))
.addText((text) =>
text
.setPlaceholder("")
.setValue("")
.onChange((val) => {
refreshToken = val.trim();
})
)
.addButton(async (button) => {
button.setButtonText(t("submit"));
button.onClick(async () => {
new Notice(t("modal_googledrive_maualinput_notice"));
try {
if (this.plugin.settings.googledrive === undefined) {
this.plugin.settings.googledrive = cloneDeep(
DEFAULT_GOOGLEDRIVE_CONFIG
);
}
this.plugin.settings.googledrive.refreshToken = refreshToken;
this.plugin.settings.googledrive.accessToken = "access";
this.plugin.settings.googledrive.accessTokenExpiresAtTimeMs = 1;
this.plugin.settings.googledrive.accessTokenExpiresInMs = 1;
// TODO: abstraction leaking now, how to fix?
const k = await sendRefreshTokenReq(refreshToken);
const ts = Date.now();
this.plugin.settings.googledrive.accessToken = k.access_token;
this.plugin.settings.googledrive.accessTokenExpiresInMs =
k.expires_in * 1000;
this.plugin.settings.googledrive.accessTokenExpiresAtTimeMs =
ts + k.expires_in * 1000 - 60 * 2 * 1000;
await this.plugin.saveSettings();
// try to remove data in clipboard
await navigator.clipboard.writeText("");
new Notice(t("modal_googledrive_maualinput_succ_notice"));
} catch (e) {
console.error(e);
new Notice(t("modal_googledrive_maualinput_fail_notice"));
} finally {
this.authDiv.toggleClass(
"googledrive-auth-button-hide",
this.plugin.settings.googledrive.refreshToken !== ""
);
this.revokeAuthDiv.toggleClass(
"googledrive-revoke-auth-button-hide",
this.plugin.settings.googledrive.refreshToken === ""
);
this.close();
}
});
});
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
class GoogleDriveRevokeAuthModal extends Modal {
readonly plugin: RemotelySavePlugin;
readonly authDiv: HTMLDivElement;
readonly revokeAuthDiv: HTMLDivElement;
readonly t: (x: TransItemType, vars?: any) => string;
constructor(
app: App,
plugin: RemotelySavePlugin,
authDiv: HTMLDivElement,
revokeAuthDiv: HTMLDivElement,
t: (x: TransItemType, vars?: any) => string
) {
super(app);
this.plugin = plugin;
this.authDiv = authDiv;
this.revokeAuthDiv = revokeAuthDiv;
this.t = t;
}
async onOpen() {
const t = this.t;
const { contentEl } = this;
contentEl.createEl("p", {
text: t("modal_googledriverevokeauth_step1"),
});
const consentUrl = "https://myaccount.google.com/permissions";
contentEl.createEl("p").createEl("a", {
href: consentUrl,
text: consentUrl,
});
contentEl.createEl("p", {
text: t("modal_googledriverevokeauth_step2"),
});
new Setting(contentEl)
.setName(t("modal_googledriverevokeauth_clean"))
.setDesc(t("modal_googledriverevokeauth_clean_desc"))
.addButton(async (button) => {
button.setButtonText(t("modal_googledriverevokeauth_clean_button"));
button.onClick(async () => {
try {
this.plugin.settings.googledrive = cloneDeep(
DEFAULT_GOOGLEDRIVE_CONFIG
);
await this.plugin.saveSettings();
this.authDiv.toggleClass(
"googledrive-auth-button-hide",
this.plugin.settings.googledrive.refreshToken !== ""
);
this.revokeAuthDiv.toggleClass(
"googledrive-revoke-auth-button-hide",
this.plugin.settings.googledrive.refreshToken === ""
);
new Notice(t("modal_googledriverevokeauth_clean_notice"));
this.close();
} catch (err) {
console.error(err);
new Notice(t("modal_googledriverevokeauth_clean_fail"));
}
});
});
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
export const generateGoogleDriveSettingsPart = (
containerEl: HTMLElement,
t: (x: TransItemType, vars?: any) => string,
app: App,
plugin: RemotelySavePlugin,
saveUpdatedConfigFunc: () => Promise<any> | undefined
) => {
const googleDriveDiv = containerEl.createEl("div", {
cls: "googledrive-hide",
});
googleDriveDiv.toggleClass(
"googledrive-hide",
plugin.settings.serviceType !== "googledrive"
);
googleDriveDiv.createEl("h2", { text: t("settings_googledrive") });
const googleDriveLongDescDiv = googleDriveDiv.createEl("div", {
cls: "settings-long-desc",
});
for (const c of [
t("settings_googledrive_disclaimer1"),
t("settings_googledrive_disclaimer2"),
]) {
googleDriveLongDescDiv.createEl("p", {
text: c,
cls: "googledrive-disclaimer",
});
}
googleDriveLongDescDiv.createEl("p", {
text: t("settings_googledrive_folder", {
remoteBaseDir:
plugin.settings.googledrive.remoteBaseDir || app.vault.getName(),
}),
});
googleDriveLongDescDiv.createDiv({
text: stringToFragment(t("settings_googledrive_pro_desc")),
cls: "googledrive-disclaimer",
});
const googleDriveNotShowUpHintSetting = new Setting(googleDriveDiv)
.setName(t("settings_googledrive_notshowuphint"))
.setDesc(t("settings_googledrive_notshowuphint_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_googledrive_notshowuphint_view_pro"));
button.onClick(async () => {
window.location.href = "#settings-pro";
});
});
const googleDriveAllowedToUsedDiv = googleDriveDiv.createDiv();
// if pro enabled, show up; otherwise hide.
const allowGoogleDrive =
plugin.settings.pro?.enabledProFeatures.filter(
(x) => x.featureName === "feature-google_drive"
).length === 1;
console.debug(`allow to show up google drive settings? ${allowGoogleDrive}`);
if (allowGoogleDrive) {
googleDriveAllowedToUsedDiv.removeClass("googledrive-allow-to-use-hide");
googleDriveNotShowUpHintSetting.settingEl.addClass(
"googledrive-allow-to-use-hide"
);
} else {
googleDriveAllowedToUsedDiv.addClass("googledrive-allow-to-use-hide");
googleDriveNotShowUpHintSetting.settingEl.removeClass(
"googledrive-allow-to-use-hide"
);
}
const googleDriveSelectAuthDiv = googleDriveAllowedToUsedDiv.createDiv();
const googleDriveAuthDiv = googleDriveSelectAuthDiv.createDiv({
cls: "googledrive-auth-button-hide settings-auth-related",
});
const googleDriveRevokeAuthDiv = googleDriveSelectAuthDiv.createDiv({
cls: "googledrive-revoke-auth-button-hide settings-auth-related",
});
const googleDriveRevokeAuthSetting = new Setting(googleDriveRevokeAuthDiv)
.setName(t("settings_googledrive_revoke"))
.setDesc(t("settings_googledrive_revoke_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_googledrive_revoke_button"));
button.onClick(async () => {
new GoogleDriveRevokeAuthModal(
app,
plugin,
googleDriveAuthDiv,
googleDriveRevokeAuthDiv,
t
).open();
});
});
new Setting(googleDriveAuthDiv)
.setName(t("settings_googledrive_auth"))
.setDesc(t("settings_googledrive_auth_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_googledrive_auth_button"));
button.onClick(async () => {
const modal = new GoogleDriveAuthModal(
app,
plugin,
googleDriveAuthDiv,
googleDriveRevokeAuthDiv,
googleDriveRevokeAuthSetting,
t
);
plugin.oauth2Info.helperModal = modal;
plugin.oauth2Info.authDiv = googleDriveAuthDiv;
plugin.oauth2Info.revokeDiv = googleDriveRevokeAuthDiv;
plugin.oauth2Info.revokeAuthSetting = googleDriveRevokeAuthSetting;
modal.open();
});
});
googleDriveAuthDiv.toggleClass(
"googledrive-auth-button-hide",
plugin.settings.googledrive.refreshToken !== ""
);
googleDriveRevokeAuthDiv.toggleClass(
"googledrive-revoke-auth-button-hide",
plugin.settings.googledrive.refreshToken === ""
);
let newgoogleDriveRemoteBaseDir =
plugin.settings.googledrive.remoteBaseDir || "";
new Setting(googleDriveAllowedToUsedDiv)
.setName(t("settings_remotebasedir"))
.setDesc(t("settings_remotebasedir_desc"))
.addText((text) =>
text
.setPlaceholder(app.vault.getName())
.setValue(newgoogleDriveRemoteBaseDir)
.onChange((value) => {
newgoogleDriveRemoteBaseDir = value.trim();
})
)
.addButton((button) => {
button.setButtonText(t("confirm"));
button.onClick(() => {
new ChangeRemoteBaseDirModal(
app,
plugin,
newgoogleDriveRemoteBaseDir,
"googledrive"
).open();
});
});
new Setting(googleDriveAllowedToUsedDiv)
.setName(t("settings_checkonnectivity"))
.setDesc(t("settings_checkonnectivity_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_checkonnectivity_button"));
button.onClick(async () => {
new Notice(t("settings_checkonnectivity_checking"));
const client = getClient(plugin.settings, app.vault.getName(), () =>
plugin.saveSettings()
);
const errors = { msg: "" };
const res = await client.checkConnect((err: any) => {
errors.msg = `${err}`;
});
if (res) {
new Notice(t("settings_googledrive_connect_succ"));
} else {
new Notice(t("settings_googledrive_connect_fail"));
new Notice(errors.msg);
}
});
});
return {
googleDriveDiv: googleDriveDiv,
googleDriveAllowedToUsedDiv: googleDriveAllowedToUsedDiv,
googleDriveNotShowUpHintSetting: googleDriveNotShowUpHintSetting,
};
};
+367
View File
@@ -0,0 +1,367 @@
import cloneDeep from "lodash/cloneDeep";
import { type App, Modal, Notice, Setting } from "obsidian";
import { getClient } from "../../src/fsGetter";
import type { TransItemType } from "../../src/i18n";
import type RemotelySavePlugin from "../../src/main";
import { stringToFragment } from "../../src/misc";
import { ChangeRemoteBaseDirModal } from "../../src/settings";
import {
DEFAULT_KOOFR_CONFIG,
generateAuthUrl,
sendRefreshTokenReq,
} from "./fsKoofr";
class KoofrAuthModal extends Modal {
readonly plugin: RemotelySavePlugin;
readonly authDiv: HTMLDivElement;
readonly revokeAuthDiv: HTMLDivElement;
readonly revokeAuthSetting: Setting;
readonly t: (x: TransItemType, vars?: any) => string;
constructor(
app: App,
plugin: RemotelySavePlugin,
authDiv: HTMLDivElement,
revokeAuthDiv: HTMLDivElement,
revokeAuthSetting: Setting,
t: (x: TransItemType, vars?: any) => string
) {
super(app);
this.plugin = plugin;
this.authDiv = authDiv;
this.revokeAuthDiv = revokeAuthDiv;
this.revokeAuthSetting = revokeAuthSetting;
this.t = t;
}
async onOpen() {
const { contentEl } = this;
const t = this.t;
const authUrl = generateAuthUrl(this.plugin.settings.koofr.api, true);
const div2 = contentEl.createDiv();
div2.createDiv({
text: stringToFragment(t("modal_koofrauth_tutorial")),
});
div2.createEl(
"button",
{
text: t("modal_koofrauth_copybutton"),
},
(el) => {
el.onclick = async () => {
await navigator.clipboard.writeText(authUrl);
new Notice(t("modal_koofrauth_copynotice"));
};
}
);
contentEl.createEl("p").createEl("a", {
href: authUrl,
text: authUrl,
});
// let refreshToken = "";
// new Setting(contentEl)
// .setName(t("modal_koofr_maualinput"))
// .setDesc(t("modal_koofr_maualinput_desc"))
// .addText((text) =>
// text
// .setPlaceholder("")
// .setValue("")
// .onChange((val) => {
// refreshToken = val.trim();
// })
// )
// .addButton(async (button) => {
// button.setButtonText(t("submit"));
// button.onClick(async () => {
// new Notice(t("modal_koofr_maualinput_notice"));
// try {
// if (this.plugin.settings.koofr === undefined) {
// this.plugin.settings.koofr = cloneDeep(
// DEFAULT_KOOFR_CONFIG
// );
// }
// this.plugin.settings.koofr.refreshToken = refreshToken;
// this.plugin.settings.koofr.accessToken = "access";
// this.plugin.settings.koofr.accessTokenExpiresAtTimeMs = 1;
// this.plugin.settings.koofr.accessTokenExpiresInMs = 1;
// // TODO: abstraction leaking now, how to fix?
// const k = await sendRefreshTokenReq(refreshToken);
// const ts = Date.now();
// this.plugin.settings.koofr.accessToken = k.access_token;
// this.plugin.settings.koofr.accessTokenExpiresInMs =
// k.expires_in * 1000;
// this.plugin.settings.koofr.accessTokenExpiresAtTimeMs =
// ts + k.expires_in * 1000 - 60 * 2 * 1000;
// await this.plugin.saveSettings();
// // try to remove data in clipboard
// await navigator.clipboard.writeText("");
// new Notice(t("modal_koofr_maualinput_succ_notice"));
// } catch (e) {
// console.error(e);
// new Notice(t("modal_koofr_maualinput_fail_notice"));
// } finally {
// this.authDiv.toggleClass(
// "koofr-auth-button-hide",
// this.plugin.settings.koofr.refreshToken !== ""
// );
// this.revokeAuthDiv.toggleClass(
// "koofr-revoke-auth-button-hide",
// this.plugin.settings.koofr.refreshToken === ""
// );
// this.close();
// }
// });
// });
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
class KoofrRevokeAuthModal extends Modal {
readonly plugin: RemotelySavePlugin;
readonly authDiv: HTMLDivElement;
readonly revokeAuthDiv: HTMLDivElement;
readonly t: (x: TransItemType, vars?: any) => string;
constructor(
app: App,
plugin: RemotelySavePlugin,
authDiv: HTMLDivElement,
revokeAuthDiv: HTMLDivElement,
t: (x: TransItemType, vars?: any) => string
) {
super(app);
this.plugin = plugin;
this.authDiv = authDiv;
this.revokeAuthDiv = revokeAuthDiv;
this.t = t;
}
async onOpen() {
const t = this.t;
const { contentEl } = this;
contentEl.createEl("p", {
text: t("modal_koofrrevokeauth_step1"),
});
const consentUrl = "https://app.koofr.net/app/admin/preferences/security";
contentEl.createEl("p").createEl("a", {
href: consentUrl,
text: consentUrl,
});
contentEl.createEl("p", {
text: t("modal_koofrrevokeauth_step2"),
});
new Setting(contentEl)
.setName(t("modal_koofrrevokeauth_clean"))
.setDesc(t("modal_koofrrevokeauth_clean_desc"))
.addButton(async (button) => {
button.setButtonText(t("modal_koofrrevokeauth_clean_button"));
button.onClick(async () => {
try {
this.plugin.settings.koofr = cloneDeep(DEFAULT_KOOFR_CONFIG);
await this.plugin.saveSettings();
this.authDiv.toggleClass(
"koofr-auth-button-hide",
this.plugin.settings.koofr.refreshToken !== ""
);
this.revokeAuthDiv.toggleClass(
"koofr-revoke-auth-button-hide",
this.plugin.settings.koofr.refreshToken === ""
);
new Notice(t("modal_koofrrevokeauth_clean_notice"));
this.close();
} catch (err) {
console.error(err);
new Notice(t("modal_koofrrevokeauth_clean_fail"));
}
});
});
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
export const generateKoofrSettingsPart = (
containerEl: HTMLElement,
t: (x: TransItemType, vars?: any) => string,
app: App,
plugin: RemotelySavePlugin,
saveUpdatedConfigFunc: () => Promise<any> | undefined
) => {
const koofrDiv = containerEl.createEl("div", {
cls: "koofr-hide",
});
koofrDiv.toggleClass("koofr-hide", plugin.settings.serviceType !== "koofr");
koofrDiv.createEl("h2", { text: t("settings_koofr") });
const koofrLongDescDiv = koofrDiv.createEl("div", {
cls: "settings-long-desc",
});
for (const c of [
t("settings_koofr_disclaimer1"),
t("settings_koofr_disclaimer2"),
]) {
koofrLongDescDiv.createEl("p", {
text: c,
cls: "koofr-disclaimer",
});
}
koofrLongDescDiv.createEl("p", {
text: t("settings_koofr_folder", {
remoteBaseDir: plugin.settings.koofr.remoteBaseDir || app.vault.getName(),
}),
});
koofrLongDescDiv.createDiv({
text: stringToFragment(t("settings_koofr_pro_desc")),
cls: "koofr-disclaimer",
});
const koofrNotShowUpHintSetting = new Setting(koofrDiv)
.setName(t("settings_koofr_notshowuphint"))
.setDesc(t("settings_koofr_notshowuphint_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_koofr_notshowuphint_view_pro"));
button.onClick(async () => {
window.location.href = "#settings-pro";
});
});
const koofrAllowedToUsedDiv = koofrDiv.createDiv();
// if pro enabled, show up; otherwise hide.
const allowKoofr =
plugin.settings.pro?.enabledProFeatures.filter(
(x) => x.featureName === "feature-koofr"
).length === 1;
console.debug(`allow to show up koofr settings? ${allowKoofr}`);
if (allowKoofr) {
koofrAllowedToUsedDiv.removeClass("koofr-allow-to-use-hide");
koofrNotShowUpHintSetting.settingEl.addClass("koofr-allow-to-use-hide");
} else {
koofrAllowedToUsedDiv.addClass("koofr-allow-to-use-hide");
koofrNotShowUpHintSetting.settingEl.removeClass("koofr-allow-to-use-hide");
}
const koofrSelectAuthDiv = koofrAllowedToUsedDiv.createDiv();
const koofrAuthDiv = koofrSelectAuthDiv.createDiv({
cls: "koofr-auth-button-hide settings-auth-related",
});
const koofrRevokeAuthDiv = koofrSelectAuthDiv.createDiv({
cls: "koofr-revoke-auth-button-hide settings-auth-related",
});
const koofrRevokeAuthSetting = new Setting(koofrRevokeAuthDiv)
.setName(t("settings_koofr_revoke"))
.setDesc(t("settings_koofr_revoke_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_koofr_revoke_button"));
button.onClick(async () => {
new KoofrRevokeAuthModal(
app,
plugin,
koofrAuthDiv,
koofrRevokeAuthDiv,
t
).open();
});
});
new Setting(koofrAuthDiv)
.setName(t("settings_koofr_auth"))
.setDesc(t("settings_koofr_auth_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_koofr_auth_button"));
button.onClick(async () => {
const modal = new KoofrAuthModal(
app,
plugin,
koofrAuthDiv,
koofrRevokeAuthDiv,
koofrRevokeAuthSetting,
t
);
plugin.oauth2Info.helperModal = modal;
plugin.oauth2Info.authDiv = koofrAuthDiv;
plugin.oauth2Info.revokeDiv = koofrRevokeAuthDiv;
plugin.oauth2Info.revokeAuthSetting = koofrRevokeAuthSetting;
modal.open();
});
});
koofrAuthDiv.toggleClass(
"koofr-auth-button-hide",
plugin.settings.koofr.refreshToken !== ""
);
koofrRevokeAuthDiv.toggleClass(
"koofr-revoke-auth-button-hide",
plugin.settings.koofr.refreshToken === ""
);
let newkoofrRemoteBaseDir = plugin.settings.koofr.remoteBaseDir || "";
new Setting(koofrAllowedToUsedDiv)
.setName(t("settings_remotebasedir"))
.setDesc(t("settings_remotebasedir_desc"))
.addText((text) =>
text
.setPlaceholder(app.vault.getName())
.setValue(newkoofrRemoteBaseDir)
.onChange((value) => {
newkoofrRemoteBaseDir = value.trim();
})
)
.addButton((button) => {
button.setButtonText(t("confirm"));
button.onClick(() => {
new ChangeRemoteBaseDirModal(
app,
plugin,
newkoofrRemoteBaseDir,
"koofr"
).open();
});
});
new Setting(koofrAllowedToUsedDiv)
.setName(t("settings_checkonnectivity"))
.setDesc(t("settings_checkonnectivity_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_checkonnectivity_button"));
button.onClick(async () => {
new Notice(t("settings_checkonnectivity_checking"));
const client = getClient(plugin.settings, app.vault.getName(), () =>
plugin.saveSettings()
);
const errors = { msg: "" };
const res = await client.checkConnect((err: any) => {
errors.msg = `${err}`;
});
if (res) {
new Notice(t("settings_koofr_connect_succ"));
} else {
new Notice(t("settings_koofr_connect_fail"));
new Notice(errors.msg);
}
});
});
return {
koofrDiv: koofrDiv,
koofrAllowedToUsedDiv: koofrAllowedToUsedDiv,
koofrNotShowUpHintSetting: koofrNotShowUpHintSetting,
};
};
+311
View File
@@ -0,0 +1,311 @@
import cloneDeep from "lodash/cloneDeep";
import { type App, Modal, Notice, Setting } from "obsidian";
import { getClient } from "../../src/fsGetter";
import type { TransItemType } from "../../src/i18n";
import type RemotelySavePlugin from "../../src/main";
import { stringToFragment } from "../../src/misc";
import { ChangeRemoteBaseDirModal } from "../../src/settings";
import { DEFAULT_PCLOUD_CONFIG, generateAuthUrl } from "./fsPCloud";
class PCloudAuthModal extends Modal {
readonly plugin: RemotelySavePlugin;
readonly authDiv: HTMLDivElement;
readonly revokeAuthDiv: HTMLDivElement;
readonly revokeAuthSetting: Setting;
readonly t: (x: TransItemType, vars?: any) => string;
constructor(
app: App,
plugin: RemotelySavePlugin,
authDiv: HTMLDivElement,
revokeAuthDiv: HTMLDivElement,
revokeAuthSetting: Setting,
t: (x: TransItemType, vars?: any) => string
) {
super(app);
this.plugin = plugin;
this.authDiv = authDiv;
this.revokeAuthDiv = revokeAuthDiv;
this.revokeAuthSetting = revokeAuthSetting;
this.t = t;
}
async onOpen() {
const { contentEl } = this;
const t = this.t;
const { authUrl } = await generateAuthUrl(true);
const div2 = contentEl.createDiv();
div2.createDiv({
text: stringToFragment(t("modal_pcloudauth_tutorial")),
});
div2.createEl(
"button",
{
text: t("modal_pcloudauth_copybutton"),
},
(el) => {
el.onclick = async () => {
await navigator.clipboard.writeText(authUrl);
new Notice(t("modal_pcloudauth_copynotice"));
};
}
);
contentEl.createEl("p").createEl("a", {
href: authUrl,
text: authUrl,
});
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
class PCloudRevokeAuthModal extends Modal {
readonly plugin: RemotelySavePlugin;
readonly authDiv: HTMLDivElement;
readonly revokeAuthDiv: HTMLDivElement;
readonly t: (x: TransItemType, vars?: any) => string;
constructor(
app: App,
plugin: RemotelySavePlugin,
authDiv: HTMLDivElement,
revokeAuthDiv: HTMLDivElement,
t: (x: TransItemType, vars?: any) => string
) {
super(app);
this.plugin = plugin;
this.authDiv = authDiv;
this.revokeAuthDiv = revokeAuthDiv;
this.t = t;
}
async onOpen() {
const t = this.t;
const { contentEl } = this;
contentEl.createEl("p", {
text: t("modal_pcloudrevokeauth_step1"),
});
const consentUrl = "https://my.pcloud.com/#page=settings&settings=tab-apps";
contentEl.createEl("p").createEl("a", {
href: consentUrl,
text: consentUrl,
});
contentEl.createEl("p", {
text: t("modal_pcloudrevokeauth_step2"),
});
new Setting(contentEl)
.setName(t("modal_pcloudrevokeauth_clean"))
.setDesc(t("modal_pcloudrevokeauth_clean_desc"))
.addButton(async (button) => {
button.setButtonText(t("modal_pcloudrevokeauth_clean_button"));
button.onClick(async () => {
try {
this.plugin.settings.pcloud = cloneDeep(DEFAULT_PCLOUD_CONFIG);
await this.plugin.saveSettings();
this.authDiv.toggleClass(
"pcloud-auth-button-hide",
this.plugin.settings.pcloud.accessToken !== ""
);
this.revokeAuthDiv.toggleClass(
"pcloud-revoke-auth-button-hide",
this.plugin.settings.pcloud.accessToken === ""
);
new Notice(t("modal_pcloudrevokeauth_clean_notice"));
this.close();
} catch (err) {
console.error(err);
new Notice(t("modal_pcloudrevokeauth_clean_fail"));
}
});
});
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
export const generatePCloudSettingsPart = (
containerEl: HTMLElement,
t: (x: TransItemType, vars?: any) => string,
app: App,
plugin: RemotelySavePlugin,
saveUpdatedConfigFunc: () => Promise<any> | undefined
) => {
const pCloudDiv = containerEl.createEl("div", {
cls: "pcloud-hide",
});
pCloudDiv.toggleClass(
"pcloud-hide",
plugin.settings.serviceType !== "pcloud"
);
pCloudDiv.createEl("h2", { text: t("settings_pcloud") });
const pcloudLongDescDiv = pCloudDiv.createEl("div", {
cls: "settings-long-desc",
});
for (const c of [
t("settings_pcloud_disclaimer1"),
t("settings_pcloud_disclaimer2"),
]) {
pcloudLongDescDiv.createEl("p", {
text: c,
cls: "pcloud-disclaimer",
});
}
pcloudLongDescDiv.createEl("p", {
text: t("settings_pcloud_folder", {
remoteBaseDir:
plugin.settings.pcloud.remoteBaseDir || app.vault.getName(),
}),
});
pcloudLongDescDiv.createDiv({
text: stringToFragment(t("settings_pcloud_pro_desc")),
cls: "pcloud-disclaimer",
});
const pCloudNotShowUpHintSetting = new Setting(pCloudDiv)
.setName(t("settings_pcloud_notshowuphint"))
.setDesc(t("settings_pcloud_notshowuphint_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_pcloud_notshowuphint_view_pro"));
button.onClick(async () => {
window.location.href = "#settings-pro";
});
});
const pCloudAllowedToUsedDiv = pCloudDiv.createDiv();
// if pro enabled, show up; otherwise hide.
const allowPCloud =
plugin.settings.pro?.enabledProFeatures.filter(
(x) => x.featureName === "feature-pcloud"
).length === 1;
console.debug(`allow to show up pcloud settings? ${allowPCloud}`);
if (allowPCloud) {
pCloudAllowedToUsedDiv.removeClass("pcloud-allow-to-use-hide");
pCloudNotShowUpHintSetting.settingEl.addClass("pcloud-allow-to-use-hide");
} else {
pCloudAllowedToUsedDiv.addClass("pcloud-allow-to-use-hide");
pCloudNotShowUpHintSetting.settingEl.removeClass(
"pcloud-allow-to-use-hide"
);
}
const pcloudSelectAuthDiv = pCloudAllowedToUsedDiv.createDiv();
const pcloudAuthDiv = pcloudSelectAuthDiv.createDiv({
cls: "pcloud-auth-button-hide settings-auth-related",
});
const pcloudRevokeAuthDiv = pcloudSelectAuthDiv.createDiv({
cls: "pcloud-revoke-auth-button-hide settings-auth-related",
});
const pcloudRevokeAuthSetting = new Setting(pcloudRevokeAuthDiv)
.setName(t("settings_pcloud_revoke"))
.setDesc(t("settings_pcloud_revoke_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_pcloud_revoke_button"));
button.onClick(async () => {
new PCloudRevokeAuthModal(
app,
plugin,
pcloudAuthDiv,
pcloudRevokeAuthDiv,
t
).open();
});
});
new Setting(pcloudAuthDiv)
.setName(t("settings_pcloud_auth"))
.setDesc(t("settings_pcloud_auth_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_pcloud_auth_button"));
button.onClick(async () => {
const modal = new PCloudAuthModal(
app,
plugin,
pcloudAuthDiv,
pcloudRevokeAuthDiv,
pcloudRevokeAuthSetting,
t
);
plugin.oauth2Info.helperModal = modal;
plugin.oauth2Info.authDiv = pcloudAuthDiv;
plugin.oauth2Info.revokeDiv = pcloudRevokeAuthDiv;
plugin.oauth2Info.revokeAuthSetting = pcloudRevokeAuthSetting;
modal.open();
});
});
pcloudAuthDiv.toggleClass(
"pcloud-auth-button-hide",
plugin.settings.pcloud.accessToken !== ""
);
pcloudRevokeAuthDiv.toggleClass(
"pcloud-revoke-auth-button-hide",
plugin.settings.pcloud.accessToken === ""
);
let newpcloudRemoteBaseDir = plugin.settings.pcloud.remoteBaseDir || "";
new Setting(pCloudAllowedToUsedDiv)
.setName(t("settings_remotebasedir"))
.setDesc(t("settings_remotebasedir_desc"))
.addText((text) =>
text
.setPlaceholder(app.vault.getName())
.setValue(newpcloudRemoteBaseDir)
.onChange((value) => {
newpcloudRemoteBaseDir = value.trim();
})
)
.addButton((button) => {
button.setButtonText(t("confirm"));
button.onClick(() => {
new ChangeRemoteBaseDirModal(
app,
plugin,
newpcloudRemoteBaseDir,
"pcloud"
).open();
});
});
new Setting(pCloudAllowedToUsedDiv)
.setName(t("settings_checkonnectivity"))
.setDesc(t("settings_checkonnectivity_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_checkonnectivity_button"));
button.onClick(async () => {
new Notice(t("settings_checkonnectivity_checking"));
const client = getClient(plugin.settings, app.vault.getName(), () =>
plugin.saveSettings()
);
const errors = { msg: "" };
const res = await client.checkConnect((err: any) => {
errors.msg = `${err}`;
});
if (res) {
new Notice(t("settings_pcloud_connect_succ"));
} else {
new Notice(t("settings_pcloud_connect_fail"));
new Notice(errors.msg);
}
});
});
return {
pCloudDiv: pCloudDiv,
pCloudAllowedToUsedDiv: pCloudAllowedToUsedDiv,
pCloudNotShowUpHintSetting: pCloudNotShowUpHintSetting,
};
};
+100 -1
View File
@@ -150,6 +150,9 @@ export class ProAuthModal extends Modal {
); );
this.plugin.oauth2Info.revokeDiv = undefined; this.plugin.oauth2Info.revokeDiv = undefined;
// try to remove data in clipboard
await navigator.clipboard.writeText("");
this.close(); this.close();
} catch (err) { } catch (err) {
console.error(err); console.error(err);
@@ -244,7 +247,17 @@ export const generateProSettingsPart = (
t: (x: TransItemType, vars?: any) => string, t: (x: TransItemType, vars?: any) => string,
app: App, app: App,
plugin: RemotelySavePlugin, plugin: RemotelySavePlugin,
saveUpdatedConfigFunc: () => Promise<any> | undefined saveUpdatedConfigFunc: () => Promise<any> | undefined,
googleDriveAllowedToUsedDiv: HTMLDivElement,
googleDriveNotShowUpHintSetting: Setting,
boxAllowedToUsedDiv: HTMLDivElement,
boxNotShowUpHintSetting: Setting,
pCloudAllowedToUsedDiv: HTMLDivElement,
pCloudNotShowUpHintSetting: Setting,
yandexDiskAllowedToUsedDiv: HTMLDivElement,
yandexDiskNotShowUpHintSetting: Setting,
koofrAllowedToUsedDiv: HTMLDivElement,
koofrNotShowUpHintSetting: Setting
) => { ) => {
proDiv proDiv
.createEl("h2", { text: t("settings_pro") }) .createEl("h2", { text: t("settings_pro") })
@@ -290,6 +303,92 @@ export const generateProSettingsPart = (
}) })
) )
); );
const allowGoogleDrive =
plugin.settings.pro?.enabledProFeatures.filter(
(x) => x.featureName === "feature-google_drive"
).length === 1;
console.debug(
`allow to show up google drive settings? ${allowGoogleDrive}`
);
if (allowGoogleDrive) {
googleDriveAllowedToUsedDiv.removeClass(
"googledrive-allow-to-use-hide"
);
googleDriveNotShowUpHintSetting.settingEl.addClass(
"googledrive-allow-to-use-hide"
);
} else {
googleDriveAllowedToUsedDiv.addClass("googledrive-allow-to-use-hide");
googleDriveNotShowUpHintSetting.settingEl.removeClass(
"googledrive-allow-to-use-hide"
);
}
const allowBox =
plugin.settings.pro?.enabledProFeatures.filter(
(x) => x.featureName === "feature-box"
).length === 1;
console.debug(`allow to show up Box settings? ${allowBox}`);
if (allowBox) {
boxAllowedToUsedDiv.removeClass("box-allow-to-use-hide");
boxNotShowUpHintSetting.settingEl.addClass("box-allow-to-use-hide");
} else {
boxAllowedToUsedDiv.addClass("box-allow-to-use-hide");
boxNotShowUpHintSetting.settingEl.removeClass("box-allow-to-use-hide");
}
const allowPCloud =
plugin.settings.pro?.enabledProFeatures.filter(
(x) => x.featureName === "feature-pcloud"
).length === 1;
console.debug(`allow to show up pCloud settings? ${allowPCloud}`);
if (allowPCloud) {
pCloudAllowedToUsedDiv.removeClass("pcloud-allow-to-use-hide");
pCloudNotShowUpHintSetting.settingEl.addClass(
"pcloud-allow-to-use-hide"
);
} else {
pCloudAllowedToUsedDiv.addClass("pcloud-allow-to-use-hide");
pCloudNotShowUpHintSetting.settingEl.removeClass(
"pcloud-allow-to-use-hide"
);
}
const allowYandexDisk =
plugin.settings.pro?.enabledProFeatures.filter(
(x) => x.featureName === "feature-yandex_disk"
).length === 1;
console.debug(
`allow to show up Yandex Disk settings? ${allowYandexDisk}`
);
if (allowYandexDisk) {
yandexDiskAllowedToUsedDiv.removeClass("yandexdisk-allow-to-use-hide");
yandexDiskNotShowUpHintSetting.settingEl.addClass(
"yandexdisk-allow-to-use-hide"
);
} else {
yandexDiskAllowedToUsedDiv.addClass("yandexdisk-allow-to-use-hide");
yandexDiskNotShowUpHintSetting.settingEl.removeClass(
"yandexdisk-allow-to-use-hide"
);
}
const allowKoofr =
plugin.settings.pro?.enabledProFeatures.filter(
(x) => x.featureName === "feature-koofr"
).length === 1;
console.debug(`allow to show up Koofr settings? ${allowKoofr}`);
if (allowKoofr) {
koofrAllowedToUsedDiv.removeClass("koofr-allow-to-use-hide");
koofrNotShowUpHintSetting.settingEl.addClass("koofr-allow-to-use-hide");
} else {
koofrAllowedToUsedDiv.addClass("koofr-allow-to-use-hide");
koofrNotShowUpHintSetting.settingEl.removeClass(
"koofr-allow-to-use-hide"
);
}
new Notice(t("settings_pro_features_refresh_succ")); new Notice(t("settings_pro_features_refresh_succ"));
}); });
}); });
+378
View File
@@ -0,0 +1,378 @@
import cloneDeep from "lodash/cloneDeep";
import { type App, Modal, Notice, Setting } from "obsidian";
import { getClient } from "../../src/fsGetter";
import type { TransItemType } from "../../src/i18n";
import type RemotelySavePlugin from "../../src/main";
import { stringToFragment } from "../../src/misc";
import { ChangeRemoteBaseDirModal } from "../../src/settings";
import {
DEFAULT_YANDEXDISK_CONFIG,
generateAuthUrl,
sendRefreshTokenReq,
} from "./fsYandexDisk";
class YandexDiskAuthModal extends Modal {
readonly plugin: RemotelySavePlugin;
readonly authDiv: HTMLDivElement;
readonly revokeAuthDiv: HTMLDivElement;
readonly revokeAuthSetting: Setting;
readonly t: (x: TransItemType, vars?: any) => string;
constructor(
app: App,
plugin: RemotelySavePlugin,
authDiv: HTMLDivElement,
revokeAuthDiv: HTMLDivElement,
revokeAuthSetting: Setting,
t: (x: TransItemType, vars?: any) => string
) {
super(app);
this.plugin = plugin;
this.authDiv = authDiv;
this.revokeAuthDiv = revokeAuthDiv;
this.revokeAuthSetting = revokeAuthSetting;
this.t = t;
}
async onOpen() {
const { contentEl } = this;
const t = this.t;
const authUrl = generateAuthUrl(true);
const div2 = contentEl.createDiv();
div2.createDiv({
text: stringToFragment(t("modal_yandexdiskauth_tutorial")),
});
div2.createEl(
"button",
{
text: t("modal_yandexdiskauth_copybutton"),
},
(el) => {
el.onclick = async () => {
await navigator.clipboard.writeText(authUrl);
new Notice(t("modal_yandexdiskauth_copynotice"));
};
}
);
contentEl.createEl("p").createEl("a", {
href: authUrl,
text: authUrl,
});
// let refreshToken = "";
// new Setting(contentEl)
// .setName(t("modal_yandexdisk_maualinput"))
// .setDesc(t("modal_yandexdisk_maualinput_desc"))
// .addText((text) =>
// text
// .setPlaceholder("")
// .setValue("")
// .onChange((val) => {
// refreshToken = val.trim();
// })
// )
// .addButton(async (button) => {
// button.setButtonText(t("submit"));
// button.onClick(async () => {
// new Notice(t("modal_yandexdisk_maualinput_notice"));
// try {
// if (this.plugin.settings.yandexdisk === undefined) {
// this.plugin.settings.yandexdisk = cloneDeep(
// DEFAULT_YANDEXDISK_CONFIG
// );
// }
// this.plugin.settings.yandexdisk.refreshToken = refreshToken;
// this.plugin.settings.yandexdisk.accessToken = "access";
// this.plugin.settings.yandexdisk.accessTokenExpiresAtTimeMs = 1;
// this.plugin.settings.yandexdisk.accessTokenExpiresInMs = 1;
// // TODO: abstraction leaking now, how to fix?
// const k = await sendRefreshTokenReq(refreshToken);
// const ts = Date.now();
// this.plugin.settings.yandexdisk.accessToken = k.access_token;
// this.plugin.settings.yandexdisk.accessTokenExpiresInMs =
// k.expires_in * 1000;
// this.plugin.settings.yandexdisk.accessTokenExpiresAtTimeMs =
// ts + k.expires_in * 1000 - 60 * 2 * 1000;
// await this.plugin.saveSettings();
// // try to remove data in clipboard
// await navigator.clipboard.writeText("");
// new Notice(t("modal_yandexdisk_maualinput_succ_notice"));
// } catch (e) {
// console.error(e);
// new Notice(t("modal_yandexdisk_maualinput_fail_notice"));
// } finally {
// this.authDiv.toggleClass(
// "yandexdisk-auth-button-hide",
// this.plugin.settings.yandexdisk.refreshToken !== ""
// );
// this.revokeAuthDiv.toggleClass(
// "yandexdisk-revoke-auth-button-hide",
// this.plugin.settings.yandexdisk.refreshToken === ""
// );
// this.close();
// }
// });
// });
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
class YandexDiskRevokeAuthModal extends Modal {
readonly plugin: RemotelySavePlugin;
readonly authDiv: HTMLDivElement;
readonly revokeAuthDiv: HTMLDivElement;
readonly t: (x: TransItemType, vars?: any) => string;
constructor(
app: App,
plugin: RemotelySavePlugin,
authDiv: HTMLDivElement,
revokeAuthDiv: HTMLDivElement,
t: (x: TransItemType, vars?: any) => string
) {
super(app);
this.plugin = plugin;
this.authDiv = authDiv;
this.revokeAuthDiv = revokeAuthDiv;
this.t = t;
}
async onOpen() {
const t = this.t;
const { contentEl } = this;
contentEl.createEl("p", {
text: t("modal_yandexdiskrevokeauth_step1"),
});
const consentUrl = "https://app.yandexDisk.com/account/security";
contentEl.createEl("p").createEl("a", {
href: consentUrl,
text: consentUrl,
});
contentEl.createEl("p", {
text: t("modal_yandexdiskrevokeauth_step2"),
});
new Setting(contentEl)
.setName(t("modal_yandexdiskrevokeauth_clean"))
.setDesc(t("modal_yandexdiskrevokeauth_clean_desc"))
.addButton(async (button) => {
button.setButtonText(t("modal_yandexdiskrevokeauth_clean_button"));
button.onClick(async () => {
try {
this.plugin.settings.yandexdisk = cloneDeep(
DEFAULT_YANDEXDISK_CONFIG
);
await this.plugin.saveSettings();
this.authDiv.toggleClass(
"yandexdisk-auth-button-hide",
this.plugin.settings.yandexdisk.refreshToken !== ""
);
this.revokeAuthDiv.toggleClass(
"yandexdisk-revoke-auth-button-hide",
this.plugin.settings.yandexdisk.refreshToken === ""
);
new Notice(t("modal_yandexdiskrevokeauth_clean_notice"));
this.close();
} catch (err) {
console.error(err);
new Notice(t("modal_yandexdiskrevokeauth_clean_fail"));
}
});
});
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
export const generateYandexDiskSettingsPart = (
containerEl: HTMLElement,
t: (x: TransItemType, vars?: any) => string,
app: App,
plugin: RemotelySavePlugin,
saveUpdatedConfigFunc: () => Promise<any> | undefined
) => {
const yandexDiskDiv = containerEl.createEl("div", {
cls: "yandexdisk-hide",
});
yandexDiskDiv.toggleClass(
"yandexdisk-hide",
plugin.settings.serviceType !== "yandexdisk"
);
yandexDiskDiv.createEl("h2", { text: t("settings_yandexdisk") });
const yandexDiskLongDescDiv = yandexDiskDiv.createEl("div", {
cls: "settings-long-desc",
});
for (const c of [
t("settings_yandexdisk_disclaimer1"),
t("settings_yandexdisk_disclaimer2"),
]) {
yandexDiskLongDescDiv.createEl("p", {
text: c,
cls: "yandexdisk-disclaimer",
});
}
yandexDiskLongDescDiv.createEl("p", {
text: t("settings_yandexdisk_folder", {
remoteBaseDir:
plugin.settings.yandexdisk.remoteBaseDir || app.vault.getName(),
}),
});
yandexDiskLongDescDiv.createDiv({
text: stringToFragment(t("settings_yandexdisk_pro_desc")),
cls: "yandexdisk-disclaimer",
});
const yandexDiskNotShowUpHintSetting = new Setting(yandexDiskDiv)
.setName(t("settings_yandexdisk_notshowuphint"))
.setDesc(t("settings_yandexdisk_notshowuphint_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_yandexdisk_notshowuphint_view_pro"));
button.onClick(async () => {
window.location.href = "#settings-pro";
});
});
const yandexDiskAllowedToUsedDiv = yandexDiskDiv.createDiv();
// if pro enabled, show up; otherwise hide.
const allowYandexDisk =
plugin.settings.pro?.enabledProFeatures.filter(
(x) => x.featureName === "feature-yandex_disk"
).length === 1;
console.debug(`allow to show up yandexDisk settings? ${allowYandexDisk}`);
if (allowYandexDisk) {
yandexDiskAllowedToUsedDiv.removeClass("yandexdisk-allow-to-use-hide");
yandexDiskNotShowUpHintSetting.settingEl.addClass(
"yandexdisk-allow-to-use-hide"
);
} else {
yandexDiskAllowedToUsedDiv.addClass("yandexdisk-allow-to-use-hide");
yandexDiskNotShowUpHintSetting.settingEl.removeClass(
"yandexdisk-allow-to-use-hide"
);
}
const yandexDiskSelectAuthDiv = yandexDiskAllowedToUsedDiv.createDiv();
const yandexDiskAuthDiv = yandexDiskSelectAuthDiv.createDiv({
cls: "yandexdisk-auth-button-hide settings-auth-related",
});
const yandexDiskRevokeAuthDiv = yandexDiskSelectAuthDiv.createDiv({
cls: "yandexdisk-revoke-auth-button-hide settings-auth-related",
});
const yandexDiskRevokeAuthSetting = new Setting(yandexDiskRevokeAuthDiv)
.setName(t("settings_yandexdisk_revoke"))
.setDesc(t("settings_yandexdisk_revoke_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_yandexdisk_revoke_button"));
button.onClick(async () => {
new YandexDiskRevokeAuthModal(
app,
plugin,
yandexDiskAuthDiv,
yandexDiskRevokeAuthDiv,
t
).open();
});
});
new Setting(yandexDiskAuthDiv)
.setName(t("settings_yandexdisk_auth"))
.setDesc(t("settings_yandexdisk_auth_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_yandexdisk_auth_button"));
button.onClick(async () => {
const modal = new YandexDiskAuthModal(
app,
plugin,
yandexDiskAuthDiv,
yandexDiskRevokeAuthDiv,
yandexDiskRevokeAuthSetting,
t
);
plugin.oauth2Info.helperModal = modal;
plugin.oauth2Info.authDiv = yandexDiskAuthDiv;
plugin.oauth2Info.revokeDiv = yandexDiskRevokeAuthDiv;
plugin.oauth2Info.revokeAuthSetting = yandexDiskRevokeAuthSetting;
modal.open();
});
});
yandexDiskAuthDiv.toggleClass(
"yandexdisk-auth-button-hide",
plugin.settings.yandexdisk.refreshToken !== ""
);
yandexDiskRevokeAuthDiv.toggleClass(
"yandexdisk-revoke-auth-button-hide",
plugin.settings.yandexdisk.refreshToken === ""
);
let newyandexDiskRemoteBaseDir =
plugin.settings.yandexdisk.remoteBaseDir || "";
new Setting(yandexDiskAllowedToUsedDiv)
.setName(t("settings_remotebasedir"))
.setDesc(t("settings_remotebasedir_desc"))
.addText((text) =>
text
.setPlaceholder(app.vault.getName())
.setValue(newyandexDiskRemoteBaseDir)
.onChange((value) => {
newyandexDiskRemoteBaseDir = value.trim();
})
)
.addButton((button) => {
button.setButtonText(t("confirm"));
button.onClick(() => {
new ChangeRemoteBaseDirModal(
app,
plugin,
newyandexDiskRemoteBaseDir,
"yandexdisk"
).open();
});
});
new Setting(yandexDiskAllowedToUsedDiv)
.setName(t("settings_checkonnectivity"))
.setDesc(t("settings_checkonnectivity_desc"))
.addButton(async (button) => {
button.setButtonText(t("settings_checkonnectivity_button"));
button.onClick(async () => {
new Notice(t("settings_checkonnectivity_checking"));
const client = getClient(plugin.settings, app.vault.getName(), () =>
plugin.saveSettings()
);
const errors = { msg: "" };
const res = await client.checkConnect((err: any) => {
errors.msg = `${err}`;
});
if (res) {
new Notice(t("settings_yandexdisk_connect_succ"));
} else {
new Notice(t("settings_yandexdisk_connect_fail"));
new Notice(errors.msg);
}
});
});
return {
yandexDiskDiv: yandexDiskDiv,
yandexDiskAllowedToUsedDiv: yandexDiskAllowedToUsedDiv,
yandexDiskNotShowUpHintSetting: yandexDiskNotShowUpHintSetting,
};
};
+192 -79
View File
@@ -2,13 +2,6 @@
import AggregateError from "aggregate-error"; import AggregateError from "aggregate-error";
import PQueue from "p-queue"; import PQueue from "p-queue";
import XRegExp from "xregexp"; import XRegExp from "xregexp";
import { checkProRunnableAndFixInplace } from "../pro/src/account";
import { duplicateFile, isMergable, mergeFile } from "../pro/src/conflictLogic";
import {
clearFileContentHistoryByVaultAndProfile,
getFileContentHistoryByVaultAndProfile,
upsertFileContentHistoryByVaultAndProfile,
} from "../pro/src/localdb";
import type { import type {
ConflictActionType, ConflictActionType,
EmptyFolderCleanType, EmptyFolderCleanType,
@@ -18,21 +11,21 @@ import type {
SUPPORTED_SERVICES_TYPE, SUPPORTED_SERVICES_TYPE,
SyncDirectionType, SyncDirectionType,
SyncTriggerSourceType, SyncTriggerSourceType,
} from "./baseTypes"; } from "../../src/baseTypes";
import { copyFile, copyFileOrFolder, copyFolder } from "./copyLogic"; import { copyFile, copyFileOrFolder, copyFolder } from "../../src/copyLogic";
import type { FakeFs } from "./fsAll"; import type { FakeFs } from "../../src/fsAll";
import type { FakeFsEncrypt } from "./fsEncrypt"; import type { FakeFsEncrypt } from "../../src/fsEncrypt";
import { import {
type InternalDBs, type InternalDBs,
clearPrevSyncRecordByVaultAndProfile, clearPrevSyncRecordByVaultAndProfile,
getAllPrevSyncRecordsByVaultAndProfile, getAllPrevSyncRecordsByVaultAndProfile,
insertSyncPlanRecordByVault, insertSyncPlanRecordByVault,
upsertPrevSyncRecordByVaultAndProfile, upsertPrevSyncRecordByVaultAndProfile,
} from "./localdb"; } from "../../src/localdb";
import { import {
DEFAULT_FILE_NAME_FOR_METADATAONREMOTE, DEFAULT_FILE_NAME_FOR_METADATAONREMOTE,
DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2, DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2,
} from "./metadataOnRemote"; } from "../../src/metadataOnRemote";
import { import {
atWhichLevel, atWhichLevel,
getParentFolder, getParentFolder,
@@ -40,8 +33,15 @@ import {
isSpecialFolderNameToSkip, isSpecialFolderNameToSkip,
roughSizeOfObject, roughSizeOfObject,
unixTimeToStr, unixTimeToStr,
} from "./misc"; } from "../../src/misc";
import type { Profiler } from "./profiler"; import type { Profiler } from "../../src/profiler";
import { checkProRunnableAndFixInplace } from "./account";
import { duplicateFile, isMergable, mergeFile } from "./conflictLogic";
import {
clearFileContentHistoryByVaultAndProfile,
getFileContentHistoryByVaultAndProfile,
upsertFileContentHistoryByVaultAndProfile,
} from "./localdb";
const copyEntityAndFixTimeFormat = ( const copyEntityAndFixTimeFormat = (
src: Entity, src: Entity,
@@ -291,7 +291,6 @@ const ensembleMixedEnties = async (
*/ */
const getSyncPlanInplace = async ( const getSyncPlanInplace = async (
mixedEntityMappings: Record<string, MixedEntity>, mixedEntityMappings: Record<string, MixedEntity>,
howToCleanEmptyFolder: EmptyFolderCleanType,
skipSizeLargerThan: number, skipSizeLargerThan: number,
conflictAction: ConflictActionType, conflictAction: ConflictActionType,
syncDirection: SyncDirectionType, syncDirection: SyncDirectionType,
@@ -336,7 +335,10 @@ const getSyncPlanInplace = async (
mixedEntry.decision = "folder_existed_both_then_do_nothing"; mixedEntry.decision = "folder_existed_both_then_do_nothing";
mixedEntry.change = false; mixedEntry.change = false;
} else if (local !== undefined && remote === undefined) { } else if (local !== undefined && remote === undefined) {
if (syncDirection === "incremental_pull_only") { if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 107; mixedEntry.decisionBranch = 107;
mixedEntry.decision = "folder_to_skip"; mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false; mixedEntry.change = false;
@@ -347,7 +349,10 @@ const getSyncPlanInplace = async (
mixedEntry.change = true; mixedEntry.change = true;
} }
} else if (local === undefined && remote !== undefined) { } else if (local === undefined && remote !== undefined) {
if (syncDirection === "incremental_push_only") { if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 108; mixedEntry.decisionBranch = 108;
mixedEntry.decision = "folder_to_skip"; mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false; mixedEntry.change = false;
@@ -365,57 +370,127 @@ const getSyncPlanInplace = async (
} }
keptFolder.delete(key); // no need to save it in the Set later keptFolder.delete(key); // no need to save it in the Set later
} else { } else {
if (howToCleanEmptyFolder === "skip") { if (local !== undefined && remote !== undefined) {
mixedEntry.decisionBranch = 105; // both exist, do nothing
mixedEntry.decision = "folder_to_skip"; mixedEntry.decisionBranch = 121;
mixedEntry.decision = "folder_existed_both_then_do_nothing";
mixedEntry.change = false; mixedEntry.change = false;
} else if (howToCleanEmptyFolder === "clean_both") { keptFolder.add(getParentFolder(key));
if (local !== undefined && remote !== undefined) { } else if (local !== undefined && remote === undefined) {
if (syncDirection === "bidirectional") { if (prevSync !== undefined) {
mixedEntry.decisionBranch = 106; // then the folder is deleted on remote
mixedEntry.decision = "folder_to_be_deleted_on_both"; if (
mixedEntry.change = true; syncDirection === "incremental_push_only" ||
} else { syncDirection === "incremental_push_and_delete_only"
// right now it does nothing because of "incremental" ) {
// TODO: should we delete?? mixedEntry.decisionBranch = 122;
mixedEntry.decisionBranch = 109; mixedEntry.decision = "folder_to_skip";
keptFolder.add(getParentFolder(key));
mixedEntry.change = false;
} else if (syncDirection === "incremental_pull_only") {
mixedEntry.decisionBranch = 123;
mixedEntry.decision = "folder_to_skip"; mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false; mixedEntry.change = false;
} keptFolder.add(getParentFolder(key));
} else if (local !== undefined && remote === undefined) { } else if (syncDirection === "incremental_pull_and_delete_only") {
if (syncDirection === "bidirectional") { mixedEntry.decisionBranch = 135;
mixedEntry.decisionBranch = 110;
mixedEntry.decision = "folder_to_be_deleted_on_local"; mixedEntry.decision = "folder_to_be_deleted_on_local";
mixedEntry.change = true; mixedEntry.change = true;
} else { } else {
// right now it does nothing because of "incremental" // bidirectional
// TODO: should we delete?? mixedEntry.decisionBranch = 124;
mixedEntry.decisionBranch = 111; mixedEntry.decision = "folder_to_be_deleted_on_local";
mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
}
} else if (local === undefined && remote !== undefined) {
if (syncDirection === "bidirectional") {
mixedEntry.decisionBranch = 112;
mixedEntry.decision = "folder_to_be_deleted_on_remote";
mixedEntry.change = true; mixedEntry.change = true;
} else {
// right now it does nothing because of "incremental"
// TODO: should we delete??
mixedEntry.decisionBranch = 113;
mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
} }
} else { } else {
// no folder to delete, do nothing // then the folder is created on local
mixedEntry.decisionBranch = 114;
mixedEntry.decision = "folder_to_skip"; if (
mixedEntry.change = false; syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 125;
mixedEntry.decision =
"folder_existed_local_then_also_create_remote";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key));
} else if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 126;
mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key));
} else {
// bidirectional
mixedEntry.decisionBranch = 127;
mixedEntry.decision =
"folder_existed_local_then_also_create_remote";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key));
}
}
} else if (local === undefined && remote !== undefined) {
if (prevSync !== undefined) {
// then the folder is deleted on local
if (syncDirection === "incremental_push_only") {
mixedEntry.decisionBranch = 128;
mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key));
} else if (syncDirection === "incremental_push_and_delete_only") {
mixedEntry.decisionBranch = 136;
mixedEntry.decision = "folder_to_be_deleted_on_remote";
mixedEntry.change = true;
} else if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 129;
mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key));
} else {
// bidirectional
mixedEntry.decisionBranch = 130;
mixedEntry.decision = "folder_to_be_deleted_on_remote";
mixedEntry.change = true;
}
} else {
// then the folder is created on remote
if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 131;
mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key));
} else if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 132;
mixedEntry.decision =
"folder_existed_remote_then_also_create_local";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key));
} else {
// bidirectional
mixedEntry.decisionBranch = 133;
mixedEntry.decision =
"folder_existed_remote_then_also_create_local";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key));
}
} }
} else { } else {
throw Error( // local === undefined && remote === undefined
`do not know how to deal with empty folder ${mixedEntry.key}` // no folder to delete or create, do nothing
); mixedEntry.decisionBranch = 134;
mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
} }
} }
} else { } else {
@@ -454,7 +529,10 @@ const getSyncPlanInplace = async (
skipSizeLargerThan <= 0 || skipSizeLargerThan <= 0 ||
remote.sizeEnc! <= skipSizeLargerThan remote.sizeEnc! <= skipSizeLargerThan
) { ) {
if (syncDirection === "incremental_push_only") { if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 26; mixedEntry.decisionBranch = 26;
mixedEntry.decision = "conflict_modified_then_keep_local"; mixedEntry.decision = "conflict_modified_then_keep_local";
mixedEntry.change = true; mixedEntry.change = true;
@@ -478,7 +556,10 @@ const getSyncPlanInplace = async (
skipSizeLargerThan <= 0 || skipSizeLargerThan <= 0 ||
local.sizeEnc! <= skipSizeLargerThan local.sizeEnc! <= skipSizeLargerThan
) { ) {
if (syncDirection === "incremental_pull_only") { if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 27; mixedEntry.decisionBranch = 27;
mixedEntry.decision = "conflict_modified_then_keep_remote"; mixedEntry.decision = "conflict_modified_then_keep_remote";
mixedEntry.change = true; mixedEntry.change = true;
@@ -535,12 +616,18 @@ const getSyncPlanInplace = async (
mixedEntry.change = true; mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else if (syncDirection === "incremental_pull_only") { } else if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 22; mixedEntry.decisionBranch = 22;
mixedEntry.decision = "conflict_created_then_keep_remote"; mixedEntry.decision = "conflict_created_then_keep_remote";
mixedEntry.change = true; mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else if (syncDirection === "incremental_push_only") { } else if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 23; mixedEntry.decisionBranch = 23;
mixedEntry.decision = "conflict_created_then_keep_local"; mixedEntry.decision = "conflict_created_then_keep_local";
mixedEntry.change = true; mixedEntry.change = true;
@@ -587,12 +674,18 @@ const getSyncPlanInplace = async (
mixedEntry.change = true; mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else if (syncDirection === "incremental_pull_only") { } else if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 24; mixedEntry.decisionBranch = 24;
mixedEntry.decision = "conflict_modified_then_keep_remote"; mixedEntry.decision = "conflict_modified_then_keep_remote";
mixedEntry.change = true; mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else if (syncDirection === "incremental_push_only") { } else if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 25; mixedEntry.decisionBranch = 25;
mixedEntry.decision = "conflict_modified_then_keep_local"; mixedEntry.decision = "conflict_modified_then_keep_local";
mixedEntry.change = true; mixedEntry.change = true;
@@ -621,7 +714,10 @@ const getSyncPlanInplace = async (
skipSizeLargerThan <= 0 || skipSizeLargerThan <= 0 ||
remote.sizeEnc! <= skipSizeLargerThan remote.sizeEnc! <= skipSizeLargerThan
) { ) {
if (syncDirection === "incremental_push_only") { if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 28; mixedEntry.decisionBranch = 28;
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false; mixedEntry.change = false;
@@ -649,7 +745,14 @@ const getSyncPlanInplace = async (
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false; mixedEntry.change = false;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else if (syncDirection === "incremental_pull_only") { } else if (syncDirection === "incremental_push_and_delete_only") {
mixedEntry.decisionBranch = 38;
mixedEntry.decision = "local_is_deleted_thus_also_delete_remote";
mixedEntry.change = true;
} else if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 35; mixedEntry.decisionBranch = 35;
mixedEntry.decision = "conflict_created_then_keep_remote"; mixedEntry.decision = "conflict_created_then_keep_remote";
mixedEntry.change = true; mixedEntry.change = true;
@@ -665,7 +768,10 @@ const getSyncPlanInplace = async (
skipSizeLargerThan <= 0 || skipSizeLargerThan <= 0 ||
remote.sizeEnc! <= skipSizeLargerThan remote.sizeEnc! <= skipSizeLargerThan
) { ) {
if (syncDirection === "incremental_push_only") { if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 30; mixedEntry.decisionBranch = 30;
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false; mixedEntry.change = false;
@@ -690,7 +796,10 @@ const getSyncPlanInplace = async (
if (prevSync === undefined) { if (prevSync === undefined) {
// if A is not in the previous list, A is new // if A is not in the previous list, A is new
if (skipSizeLargerThan <= 0 || local.sizeEnc! <= skipSizeLargerThan) { if (skipSizeLargerThan <= 0 || local.sizeEnc! <= skipSizeLargerThan) {
if (syncDirection === "incremental_pull_only") { if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 31; mixedEntry.decisionBranch = 31;
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false; mixedEntry.change = false;
@@ -713,7 +822,10 @@ const getSyncPlanInplace = async (
prevSync.sizeEnc === local.sizeEnc prevSync.sizeEnc === local.sizeEnc
) { ) {
// if A is in the previous list and UNMODIFIED, A has been deleted by B // if A is in the previous list and UNMODIFIED, A has been deleted by B
if (syncDirection === "incremental_push_only") { if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 32; mixedEntry.decisionBranch = 32;
mixedEntry.decision = "conflict_created_then_keep_local"; mixedEntry.decision = "conflict_created_then_keep_local";
mixedEntry.change = true; mixedEntry.change = true;
@@ -721,6 +833,10 @@ const getSyncPlanInplace = async (
mixedEntry.decisionBranch = 33; mixedEntry.decisionBranch = 33;
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false; mixedEntry.change = false;
} else if (syncDirection === "incremental_pull_and_delete_only") {
mixedEntry.decisionBranch = 39;
mixedEntry.decision = "remote_is_deleted_thus_also_delete_local";
mixedEntry.change = true;
} else { } else {
mixedEntry.decisionBranch = 7; mixedEntry.decisionBranch = 7;
mixedEntry.decision = "remote_is_deleted_thus_also_delete_local"; mixedEntry.decision = "remote_is_deleted_thus_also_delete_local";
@@ -729,7 +845,10 @@ const getSyncPlanInplace = async (
} else { } else {
// if A is in the previous list and MODIFIED, A has been deleted by B but modified by A // if A is in the previous list and MODIFIED, A has been deleted by B but modified by A
if (skipSizeLargerThan <= 0 || local.sizeEnc! <= skipSizeLargerThan) { if (skipSizeLargerThan <= 0 || local.sizeEnc! <= skipSizeLargerThan) {
if (syncDirection === "incremental_pull_only") { if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 34; mixedEntry.decisionBranch = 34;
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false; mixedEntry.change = false;
@@ -783,7 +902,7 @@ const getSyncPlanInplace = async (
mixedEntityMappings["/$@meta"] = { mixedEntityMappings["/$@meta"] = {
key: "/$@meta", // don't mess up with the types key: "/$@meta", // don't mess up with the types
sideNotes: { sideNotes: {
version: "20240525 fs version", version: "20240616 fs version",
generateTime: currTime, generateTime: currTime,
generateTimeFmt: currTimeFmt, generateTimeFmt: currTimeFmt,
service: settings.serviceType, service: settings.serviceType,
@@ -1172,7 +1291,7 @@ const dispatchOperationToActualV3 = async (
r.key r.key
); );
if (conflictAction === "smart_conflict") { if (conflictAction === "smart_conflict") {
if (isMergable(r.remote!)) { if (isMergable(r.local!)) {
await clearFileContentHistoryByVaultAndProfile( await clearFileContentHistoryByVaultAndProfile(
db, db,
vaultRandomID, vaultRandomID,
@@ -1507,12 +1626,7 @@ export async function syncer(
try { try {
// check pro feature // check pro feature
// if anything goes wrong, it will throw // if anything goes wrong, it will throw
await checkProRunnableAndFixInplace( await checkProRunnableAndFixInplace(settings, pluginVersion, configSaver);
["feature-smart_conflict"],
settings,
pluginVersion,
configSaver
);
// try mode? // try mode?
await notifyFunc?.(triggerSource, step); await notifyFunc?.(triggerSource, step);
@@ -1589,7 +1703,6 @@ export async function syncer(
mixedEntityMappings = await getSyncPlanInplace( mixedEntityMappings = await getSyncPlanInplace(
mixedEntityMappings, mixedEntityMappings,
settings.howToCleanEmptyFolder ?? "clean_both",
settings.skipSizeLargerThan ?? -1, settings.skipSizeLargerThan ?? -1,
settings.conflictAction ?? "keep_newer", settings.conflictAction ?? "keep_newer",
settings.syncDirection ?? "bidirectional", settings.syncDirection ?? "bidirectional",
+307
View File
@@ -0,0 +1,307 @@
//////////////////////////////////////////////
// all types
// https://yandex.com/dev/disk-api/doc/en/reference/response-objects
//////////////////////////////////////////////
export interface Link {
href: string;
method: string;
templated: boolean;
}
export interface Resource {
antivirus_status?: string;
public_key?: string;
_embedded?: ResourceList;
name?: string;
created?: string;
custom_properties?: Record<string, string>;
public_url?: string;
origin_path?: string;
modified?: string;
path?: string;
md5?: string;
sha256?: string;
file?: string;
type?: "dir" | "file";
mime_type?: string;
size?: number;
exif?: Record<any, any>;
}
type SortType = string;
export interface ResourceList {
sort?: SortType;
public_key?: string;
items?: Resource[];
path?: string;
limit?: number;
offset?: number;
total?: number;
}
export interface FilesResourceList {
items: Resource[];
limit: number;
offset: number;
}
export interface LastUploadedResourceList {
items: Resource[];
limit: number;
}
export interface PublicResourcesList {
items: Resource[];
type: "dir" | "file";
limit: number;
offset: number;
}
export interface Disk {
trash_size: number;
total_space: number;
used_space: number;
system_folders: {
applications: string;
downloads: string;
};
}
export interface Operation {
status: "success" | "failed" | "in-progress";
}
export interface ErrorResponse {
error: string;
description: string;
message?: string;
}
//////////////////////////////////////////////
// api
// https://yandex.com/dev/disk-api/doc/en/
//////////////////////////////////////////////
export class YandexApi {
accessToken: string;
apiVersion: number;
host: string;
constructor(accessToken: string) {
this.accessToken = accessToken;
this.apiVersion = 1;
this.host = `https://cloud-api.yandex.net`;
}
async _api(
method: string,
endPoint: string,
returnType: "json" | "arrayBuffer" | "raw",
queryParams?: Record<string, string>,
body?: any,
requestContentType?: string
) {
let p = "";
if (queryParams !== undefined) {
p = `?${new URLSearchParams(queryParams)}`;
}
const fullUrl = `${this.host}/v${this.apiVersion}/${endPoint}${p}`;
// console.debug(`method: ${method}, fullUrl: ${fullUrl}`)
const headers: HeadersInit = {
Authorization: `OAuth ${this.accessToken}`,
};
if (requestContentType !== undefined) {
headers["Content-Type"] = requestContentType;
}
const r = await fetch(fullUrl, {
method: method,
headers: headers,
body: body,
});
// console.debug(r)
if (r.status >= 200 && r.status < 300) {
if (returnType === "json") {
return await r.json();
}
if (returnType === "arrayBuffer") {
return await r.arrayBuffer();
}
if (returnType === "raw") {
return r;
}
} else {
throw Error(JSON.stringify((await r.json()) as ErrorResponse));
}
}
async disk() {
return (await this._api("GET", "disk/", "json")) as Disk;
}
async diskResources(
path: string,
fields?: string[],
limit?: number,
offset?: number
) {
const params: Record<string, string> = {
path: path,
};
if (fields !== undefined) {
params["fields"] = fields.join(",");
}
if (limit !== undefined) {
params["limit"] = `${limit}`;
}
if (offset !== undefined) {
params["offset"] = `${offset}`;
}
return (await this._api(
"GET",
"disk/resources",
"json",
params
)) as Resource;
}
async diskResourcesFiles(fields?: string[], limit?: number, offset?: number) {
const params: Record<string, string> = {};
if (fields !== undefined) {
params["fields"] = fields.join(",");
}
if (limit !== undefined) {
params["limit"] = `${limit}`;
}
if (offset !== undefined) {
params["offset"] = `${offset}`;
}
return (await this._api(
"GET",
"disk/resources/files",
"json",
params
)) as FilesResourceList;
}
async diskResourcesPatch(
path: string,
custom_properties: Record<string, string | null>,
fields?: string[]
) {
const params: Record<string, string> = {
path: path,
};
if (fields !== undefined) {
params["fields"] = fields.join(",");
}
return (await this._api(
"PATCH",
"disk/resources",
"json",
params,
JSON.stringify({
custom_properties: custom_properties,
}),
"application/json"
)) as Resource;
}
async diskResoucesUpload(
path: string,
content: ArrayBuffer,
overwrite?: boolean
) {
const params: Record<string, string> = {
path: path,
overwrite: `${overwrite ?? false}`,
};
const link = (await this._api(
"GET",
"disk/resources/upload",
"json",
params
)) as Link;
if (link.templated) {
throw Error(
`do not know how to deal with upload link with templated: ${JSON.stringify(
link
)}`
);
}
const rsp = await fetch(link.href, {
method: link.method,
body: content,
});
if (rsp.status === 200 || rsp.status === 201 || rsp.status === 202) {
return true;
} else {
throw Error(`upload failed. status=${rsp.status}, link=${link.href}`);
}
}
async diskResoucesDownload(path: string) {
const params: Record<string, string> = {
path: path,
};
const link = (await this._api(
"GET",
"disk/resources/download",
"json",
params
)) as Link;
if (link.templated) {
throw Error(
`do not know how to deal with download link with templated: ${JSON.stringify(
link
)}`
);
}
const rsp = await fetch(link.href, {
method: link.method,
});
if (rsp.status === 200 || rsp.status === 201 || rsp.status === 202) {
return await rsp.arrayBuffer();
} else {
throw Error(`download failed. status=${rsp.status}, link=${link.href}`);
}
}
async diskResourcesDelete(path: string, permanently?: boolean) {
const params: Record<string, string> = {
path: path,
permanently: `${permanently ?? false}`,
};
const rsp = (await this._api(
"DELETE",
"disk/resources",
"raw",
params
)) as Response;
if (rsp.status === 204) {
return;
}
if (rsp.status === 202) {
return (await rsp.json()) as Link;
}
throw Error(`do not know how to deal with delete response ${rsp}`);
}
async diskResourcesPut(path: string, fields?: string[]) {
const params: Record<string, string> = {
path: path,
};
if (fields !== undefined) {
params["fields"] = fields.join(",");
}
return (await this._api("PUT", "disk/resources", "json", params)) as Link;
}
}
+40 -6
View File
@@ -3,7 +3,14 @@
* To avoid circular dependency. * To avoid circular dependency.
*/ */
import type { ProConfig } from "../pro/src/baseTypesPro"; import type {
BoxConfig,
GoogleDriveConfig,
KoofrConfig,
PCloudConfig,
ProConfig,
YandexDiskConfig,
} from "../pro/src/baseTypesPro";
import type { LangTypeAndAuto } from "./i18n"; import type { LangTypeAndAuto } from "./i18n";
export const DEFAULT_CONTENT_TYPE = "application/octet-stream"; export const DEFAULT_CONTENT_TYPE = "application/octet-stream";
@@ -13,13 +20,23 @@ export type SUPPORTED_SERVICES_TYPE =
| "webdav" | "webdav"
| "dropbox" | "dropbox"
| "onedrive" | "onedrive"
| "webdis"; | "webdis"
| "googledrive"
| "box"
| "pcloud"
| "yandexdisk"
| "koofr";
export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR = export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR =
| "webdav" | "webdav"
| "dropbox" | "dropbox"
| "onedrive" | "onedrive"
| "webdis"; | "webdis"
| "googledrive"
| "box"
| "pcloud"
| "yandexdisk"
| "koofr";
export interface S3Config { export interface S3Config {
s3Endpoint: string; s3Endpoint: string;
@@ -103,7 +120,9 @@ export interface WebdisConfig {
export type SyncDirectionType = export type SyncDirectionType =
| "bidirectional" | "bidirectional"
| "incremental_pull_only" | "incremental_pull_only"
| "incremental_push_only"; | "incremental_push_only"
| "incremental_pull_and_delete_only"
| "incremental_push_and_delete_only";
export type CipherMethodType = "rclone-base64" | "openssl-base64" | "unknown"; export type CipherMethodType = "rclone-base64" | "openssl-base64" | "unknown";
@@ -113,7 +132,12 @@ export type QRExportType =
| "dropbox" | "dropbox"
| "onedrive" | "onedrive"
| "webdav" | "webdav"
| "webdis"; | "webdis"
| "googledrive"
| "box"
| "pcloud"
| "yandexdisk"
| "koofr";
export interface ProfilerConfig { export interface ProfilerConfig {
enablePrinting?: boolean; enablePrinting?: boolean;
@@ -126,6 +150,12 @@ export interface RemotelySavePluginSettings {
dropbox: DropboxConfig; dropbox: DropboxConfig;
onedrive: OnedriveConfig; onedrive: OnedriveConfig;
webdis: WebdisConfig; webdis: WebdisConfig;
googledrive: GoogleDriveConfig;
box: BoxConfig;
pcloud: PCloudConfig;
yandexdisk: YandexDiskConfig;
koofr: KoofrConfig;
password: string; password: string;
serviceType: SUPPORTED_SERVICES_TYPE; serviceType: SUPPORTED_SERVICES_TYPE;
currLogLevel?: string; currLogLevel?: string;
@@ -143,7 +173,6 @@ export interface RemotelySavePluginSettings {
enableStatusBarInfo?: boolean; enableStatusBarInfo?: boolean;
deleteToWhere?: "system" | "obsidian"; deleteToWhere?: "system" | "obsidian";
conflictAction?: ConflictActionType; conflictAction?: ConflictActionType;
howToCleanEmptyFolder?: EmptyFolderCleanType;
protectModifyPercentage?: number; protectModifyPercentage?: number;
syncDirection?: SyncDirectionType; syncDirection?: SyncDirectionType;
@@ -172,6 +201,11 @@ export interface RemotelySavePluginSettings {
* @deprecated * @deprecated
*/ */
logToDB?: boolean; logToDB?: boolean;
/**
* @deprecated
*/
howToCleanEmptyFolder?: EmptyFolderCleanType;
} }
export const COMMAND_URI = "remotely-save"; export const COMMAND_URI = "remotely-save";
+1 -1
View File
@@ -1,5 +1,6 @@
import type { Vault } from "obsidian"; import type { Vault } from "obsidian";
import type { SyncPlanType } from "../pro/src/sync";
import { import {
DEFAULT_DEBUG_FOLDER, DEFAULT_DEBUG_FOLDER,
DEFAULT_PROFILER_RESULT_FILE_PREFIX, DEFAULT_PROFILER_RESULT_FILE_PREFIX,
@@ -11,7 +12,6 @@ import {
} from "./localdb"; } from "./localdb";
import type { InternalDBs } from "./localdb"; import type { InternalDBs } from "./localdb";
import { mkdirpInVault } from "./misc"; import { mkdirpInVault } from "./misc";
import type { SyncPlanType } from "./sync";
const getSubsetOfSyncPlan = (x: string, onlyChange: boolean) => { const getSubsetOfSyncPlan = (x: string, onlyChange: boolean) => {
if (!onlyChange) { if (!onlyChange) {
+5 -1
View File
@@ -1,7 +1,7 @@
import type { CipherMethodType, Entity } from "./baseTypes"; import type { CipherMethodType, Entity } from "./baseTypes";
import * as openssl from "./encryptOpenSSL"; import * as openssl from "./encryptOpenSSL";
import * as rclone from "./encryptRClone"; import * as rclone from "./encryptRClone";
import { isVaildText } from "./misc"; import { isSpecialFolderNameToSkip, isVaildText } from "./misc";
import cloneDeep from "lodash/cloneDeep"; import cloneDeep from "lodash/cloneDeep";
import { FakeFs } from "./fsAll"; import { FakeFs } from "./fsAll";
@@ -189,6 +189,10 @@ export class FakeFsEncrypt extends FakeFs {
return res; return res;
} else { } else {
for (const innerEntity of innerWalkResult) { for (const innerEntity of innerWalkResult) {
if (isSpecialFolderNameToSkip(innerEntity.keyRaw, [])) {
continue;
}
const key = await this._decryptName(innerEntity.keyRaw); const key = await this._decryptName(innerEntity.keyRaw);
const size = key.endsWith("/") ? 0 : undefined; const size = key.endsWith("/") ? 0 : undefined;
res.push({ res.push({
+27
View File
@@ -1,3 +1,8 @@
import { FakeFsBox } from "../pro/src/fsBox";
import { FakeFsGoogleDrive } from "../pro/src/fsGoogleDrive";
import { FakeFsKoofr } from "../pro/src/fsKoofr";
import { FakeFsPCloud } from "../pro/src/fsPCloud";
import { FakeFsYandexDisk } from "../pro/src/fsYandexDisk";
import type { RemotelySavePluginSettings } from "./baseTypes"; import type { RemotelySavePluginSettings } from "./baseTypes";
import type { FakeFs } from "./fsAll"; import type { FakeFs } from "./fsAll";
import { FakeFsDropbox } from "./fsDropbox"; import { FakeFsDropbox } from "./fsDropbox";
@@ -41,6 +46,28 @@ export function getClient(
vaultName, vaultName,
saveUpdatedConfigFunc saveUpdatedConfigFunc
); );
case "googledrive":
return new FakeFsGoogleDrive(
settings.googledrive,
vaultName,
saveUpdatedConfigFunc
);
case "box":
return new FakeFsBox(settings.box, vaultName, saveUpdatedConfigFunc);
case "pcloud":
return new FakeFsPCloud(
settings.pcloud,
vaultName,
saveUpdatedConfigFunc
);
case "yandexdisk":
return new FakeFsYandexDisk(
settings.yandexdisk,
vaultName,
saveUpdatedConfigFunc
);
case "koofr":
return new FakeFsKoofr(settings.koofr, vaultName, saveUpdatedConfigFunc);
default: default:
throw Error(`cannot init client for serviceType=${settings.serviceType}`); throw Error(`cannot init client for serviceType=${settings.serviceType}`);
} }
+9 -4
View File
@@ -43,8 +43,13 @@ export class FakeFsLocal extends FakeFs {
for (const entry of localTAbstractFiles) { for (const entry of localTAbstractFiles) {
let r: Entity | undefined = undefined; let r: Entity | undefined = undefined;
let key = entry.path; let key = entry.path;
if (key.startsWith("/")) {
// why?
// just remove leading slash /
key = key.slice(1);
}
if (entry.path === "/") { if (entry.path === "/" || entry.path === "") {
// ignore // ignore
continue; continue;
} else if (entry instanceof TFile) { } else if (entry instanceof TFile) {
@@ -61,15 +66,15 @@ export class FakeFsLocal extends FakeFs {
); );
} }
r = { r = {
key: entry.path, // local always unencrypted key: key, // local always unencrypted
keyRaw: entry.path, keyRaw: key,
mtimeCli: mtimeLocal, mtimeCli: mtimeLocal,
mtimeSvr: mtimeLocal, mtimeSvr: mtimeLocal,
size: entry.stat.size, // local always unencrypted size: entry.stat.size, // local always unencrypted
sizeRaw: entry.stat.size, sizeRaw: entry.stat.size,
}; };
} else if (entry instanceof TFolder) { } else if (entry instanceof TFolder) {
key = `${entry.path}/`; key = `${key}/`;
r = { r = {
key: key, key: key,
keyRaw: key, keyRaw: key,
+5 -2
View File
@@ -913,7 +913,8 @@ export class FakeFsOnedrive extends FakeFs {
`${key}?$select=@microsoft.graph.downloadUrl` `${key}?$select=@microsoft.graph.downloadUrl`
); );
const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"]; const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
if (VALID_REQURL) { // biome-ignore lint/correctness/noConstantCondition: <explanation>
if (false /*VALID_REQURL*/) {
const content = ( const content = (
await requestUrl({ await requestUrl({
url: downloadUrl, url: downloadUrl,
@@ -923,7 +924,9 @@ export class FakeFsOnedrive extends FakeFs {
return content; return content;
} else { } else {
// cannot set no-cache here, will have cors error // cannot set no-cache here, will have cors error
const content = await (await fetch(downloadUrl)).arrayBuffer(); const content = await (
await fetch(downloadUrl, { cache: "no-store" })
).arrayBuffer();
return content; return content;
} }
} }
+15
View File
@@ -24,6 +24,11 @@ export const exportQrCodeUri = async (
delete settings2.onedrive; delete settings2.onedrive;
delete settings2.webdav; delete settings2.webdav;
delete settings2.webdis; delete settings2.webdis;
delete settings2.googledrive;
delete settings2.box;
delete settings2.pcloud;
delete settings2.yandexdisk;
delete settings2.koofr;
delete settings2.pro; delete settings2.pro;
} else if (exportFields === "s3") { } else if (exportFields === "s3") {
settings2 = { s3: cloneDeep(settings.s3) }; settings2 = { s3: cloneDeep(settings.s3) };
@@ -35,6 +40,16 @@ export const exportQrCodeUri = async (
settings2 = { webdav: cloneDeep(settings.webdav) }; settings2 = { webdav: cloneDeep(settings.webdav) };
} else if (exportFields === "webdis") { } else if (exportFields === "webdis") {
settings2 = { webdis: cloneDeep(settings.webdis) }; settings2 = { webdis: cloneDeep(settings.webdis) };
} else if (exportFields === "googledrive") {
settings2 = { googledrive: cloneDeep(settings.googledrive) };
} else if (exportFields === "box") {
settings2 = { box: cloneDeep(settings.box) };
} else if (exportFields === "pcloud") {
settings2 = { pcloud: cloneDeep(settings.pcloud) };
} else if (exportFields === "yandexdisk") {
settings2 = { yandexdisk: cloneDeep(settings.yandexdisk) };
} else if (exportFields === "koofr") {
settings2 = { koofr: cloneDeep(settings.koofr) };
} }
delete settings2.vaultRandomID; delete settings2.vaultRandomID;
+8 -4
View File
@@ -292,11 +292,15 @@
"settings_protectmodifypercentage_custom_desc": "custom", "settings_protectmodifypercentage_custom_desc": "custom",
"settings_protectmodifypercentage_customfield": "Custom Abort Sync If Modification Above Percentage", "settings_protectmodifypercentage_customfield": "Custom Abort Sync If Modification Above Percentage",
"settings_protectmodifypercentage_customfield_desc": "You need to enter a number between 0 (inclusive) and 100 (inclusive). Float number is also allowed.", "settings_protectmodifypercentage_customfield_desc": "You need to enter a number between 0 (inclusive) and 100 (inclusive). Float number is also allowed.",
"setting_syncdirection": "Sync Direction",
"setting_syncdirection_desc": "Which direction should the plugin sync to? Please be aware that only CHANGED files (based on time and size) are synced regardless any option.", "setting_syncdirection": "Sync Direction (experimental)",
"setting_syncdirection_desc": "<p>Which direction should the plugin sync to? Please be aware that only CHANGED files (based on time and size) are synced regardless any option.</p><ol><li>Bidirectional: Changes on both side are synced to the other side.</li><li>Incremental Push: Locally created or modifed files are copied to remote.</li><li>Incremental Pull: Remotely created or modifed files are copied to local.</li><li>Incremental Push And Delete: Locally created or modifed files are copied to remote, <strong>and local deletion operations are run on remote too.</strong></li><li>Incremental Pull And Delete: Remotely created or modifed files are copied to local, <strong>and remote deletion operations are run on local too.</strong></li></ol>",
"setting_syncdirection_bidirectional_desc": "Bidirectional (default)", "setting_syncdirection_bidirectional_desc": "Bidirectional (default)",
"setting_syncdirection_incremental_push_only_desc": "Incremental Push Only (aka backup mode)", "setting_syncdirection_incremental_push_only_desc": "Incremental Push (aka backup mode)",
"setting_syncdirection_incremental_pull_only_desc": "Incremental Pull Only", "setting_syncdirection_incremental_pull_only_desc": "Incremental Pull",
"setting_syncdirection_incremental_push_and_delete_only_desc": "Incremental Push And Delete",
"setting_syncdirection_incremental_pull_and_delete_only_desc": "Incremental Pull And Delete",
"settings_enablemobilestatusbar": "Mobile Status Bar (experimental)", "settings_enablemobilestatusbar": "Mobile Status Bar (experimental)",
"settings_enablemobilestatusbar_desc": "By default Obsidian mobile hides status bar. But some users want to show it up. So here is a hack.", "settings_enablemobilestatusbar_desc": "By default Obsidian mobile hides status bar. But some users want to show it up. So here is a hack.",
"settings_importexport": "Import and Export Partial Settings", "settings_importexport": "Import and Export Partial Settings",
+8 -4
View File
@@ -291,11 +291,15 @@
"settings_protectmodifypercentage_custom_desc": "自定义", "settings_protectmodifypercentage_custom_desc": "自定义",
"settings_protectmodifypercentage_customfield": "如果修改超过自定义百分比则中止同步", "settings_protectmodifypercentage_customfield": "如果修改超过自定义百分比则中止同步",
"settings_protectmodifypercentage_customfield_desc": "您需要输入 0(含)~ 100(含)的数字。小数也是可以的。", "settings_protectmodifypercentage_customfield_desc": "您需要输入 0(含)~ 100(含)的数字。小数也是可以的。",
"setting_syncdirection": "同步方向",
"setting_syncdirection_desc": "插件应该向哪里同步?注意每个选项都是只有修改了的文件(基于修改时间和大小判断)才会触发同步动作。", "setting_syncdirection": "同步方向(实验性质)",
"setting_syncdirection_desc": "<p>W插件应该向哪里同步?注意每个选项都是只有修改了的文件(基于修改时间和大小判断)才会触发同步动作。</p><ol><li>双向同步:一边的变动会同步到另一边。</li><li>增量推送:本地创建或修改的文件会复制到远端。</li><li>增量拉取:远端创建或修改的文件会复制到本地。</li><li>增量推送带删除:本地创建或修改的文件会复制到远端,<strong>本地的删除也会在远端运行。</strong></li><li>增量拉取带删除:远端创建或修改的文件会复制到本地,<strong>远端的删除也会在本地运行。</strong></li></ol>",
"setting_syncdirection_bidirectional_desc": "双向同步(默认)", "setting_syncdirection_bidirectional_desc": "双向同步(默认)",
"setting_syncdirection_incremental_push_only_desc": "增量推送(也即:备份模式)", "setting_syncdirection_incremental_push_only_desc": "增量推送(也即:备份模式)",
"setting_syncdirection_incremental_pull_only_desc": "增量拉取", "setting_syncdirection_incremental_pull_only_desc": "增量拉取",
"setting_syncdirection_incremental_push_and_delete_only_desc": "增量推送带删除",
"setting_syncdirection_incremental_pull_and_delete_only_desc": "增量拉取带删除",
"settings_enablemobilestatusbar": "手机的状态栏(实验性质)", "settings_enablemobilestatusbar": "手机的状态栏(实验性质)",
"settings_enablemobilestatusbar_desc": "Obsidian 手机版默认隐藏了状态栏。有些用户希望展示它。这里提供了设置选项。", "settings_enablemobilestatusbar_desc": "Obsidian 手机版默认隐藏了状态栏。有些用户希望展示它。这里提供了设置选项。",
"settings_importexport": "导入导出部分设置", "settings_importexport": "导入导出部分设置",
+8 -4
View File
@@ -290,11 +290,15 @@
"settings_protectmodifypercentage_custom_desc": "自定義", "settings_protectmodifypercentage_custom_desc": "自定義",
"settings_protectmodifypercentage_customfield": "如果修改超過自定義百分比則中止同步", "settings_protectmodifypercentage_customfield": "如果修改超過自定義百分比則中止同步",
"settings_protectmodifypercentage_customfield_desc": "您需要輸入 0(含)~ 100(含)的數字。小數也是可以的。", "settings_protectmodifypercentage_customfield_desc": "您需要輸入 0(含)~ 100(含)的數字。小數也是可以的。",
"setting_syncdirection": "同步方向",
"setting_syncdirection_desc": "外掛應該向哪裡同步?注意每個選項都是隻有修改了的檔案(基於修改時間和大小判斷)才會觸發同步動作。", "setting_syncdirection": "同步方向(實驗性質)",
"setting_syncdirection_desc": "<p>W外掛應該向哪裡同步?注意每個選項都是隻有修改了的檔案(基於修改時間和大小判斷)才會觸發同步動作。</p><ol><li>雙向同步:一邊的變動會同步到另一邊。</li><li>增量推送:本地建立或修改的檔案會複製到遠端。</li><li>增量拉取:遠端建立或修改的檔案會複製到本地。</li><li>增量推送帶刪除:本地建立或修改的檔案會複製到遠端,<strong>本地的刪除也會在遠端執行。</strong></li><li>增量拉取帶刪除:遠端建立或修改的檔案會複製到本地,<strong>遠端的刪除也會在本地執行。</strong></li></ol>",
"setting_syncdirection_bidirectional_desc": "雙向同步(預設)", "setting_syncdirection_bidirectional_desc": "雙向同步(預設)",
"setting_syncdirection_incremental_push_only_desc": "增量推送(也即:備份模式)", "setting_syncdirection_incremental_push_only_desc": "增量推送(也即:備份模式)",
"setting_syncdirection_incremental_pull_only_desc": "增量拉取", "setting_syncdirection_incremental_pull_only_desc": "增量拉取",
"setting_syncdirection_incremental_push_and_delete_only_desc": "增量推送帶刪除",
"setting_syncdirection_incremental_pull_and_delete_only_desc": "增量拉取帶刪除",
"settings_enablemobilestatusbar": "手機的狀態列(實驗性質)", "settings_enablemobilestatusbar": "手機的狀態列(實驗性質)",
"settings_enablemobilestatusbar_desc": "Obsidian 手機版預設隱藏了狀態列。有些使用者希望展示它。這裡提供了設定選項。", "settings_enablemobilestatusbar_desc": "Obsidian 手機版預設隱藏了狀態列。有些使用者希望展示它。這裡提供了設定選項。",
"settings_importexport": "匯入匯出部分設定", "settings_importexport": "匯入匯出部分設定",
+1 -1
View File
@@ -6,9 +6,9 @@ ep2(localforage);
export type LocalForage = typeof localforage; export type LocalForage = typeof localforage;
import { nanoid } from "nanoid"; import { nanoid } from "nanoid";
import type { SyncPlanType } from "../pro/src/sync";
import type { Entity, SUPPORTED_SERVICES_TYPE } from "./baseTypes"; import type { Entity, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
import { unixTimeToStr } from "./misc"; import { unixTimeToStr } from "./misc";
import type { SyncPlanType } from "./sync";
const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108, 20220326, 20240220]; const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108, 20220326, 20240220];
export const DEFAULT_DB_VERSION_NUMBER: number = 20240220; export const DEFAULT_DB_VERSION_NUMBER: number = 20240220;
+379 -19
View File
@@ -1,4 +1,7 @@
// biome-ignore lint/suspicious/noShadowRestrictedNames: <explanation>
import AggregateError from "aggregate-error";
import cloneDeep from "lodash/cloneDeep"; import cloneDeep from "lodash/cloneDeep";
import throttle from "lodash/throttle";
import { FileText, RefreshCcw, RotateCcw, createElement } from "lucide"; import { FileText, RefreshCcw, RotateCcw, createElement } from "lucide";
import { import {
Events, Events,
@@ -20,6 +23,38 @@ import {
sendAuthReq as sendAuthReqPro, sendAuthReq as sendAuthReqPro,
setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplacePro, setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplacePro,
} from "../pro/src/account"; } from "../pro/src/account";
import {
COMMAND_CALLBACK_BOX,
COMMAND_CALLBACK_KOOFR,
COMMAND_CALLBACK_PCLOUD,
COMMAND_CALLBACK_PRO,
COMMAND_CALLBACK_YANDEXDISK,
} from "../pro/src/baseTypesPro";
import {
DEFAULT_BOX_CONFIG,
FakeFsBox,
sendAuthReq as sendAuthReqBox,
setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplaceBox,
} from "../pro/src/fsBox";
import { DEFAULT_GOOGLEDRIVE_CONFIG } from "../pro/src/fsGoogleDrive";
import {
DEFAULT_KOOFR_CONFIG,
sendAuthReq as sendAuthReqKoofr,
setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplaceKoofr,
} from "../pro/src/fsKoofr";
import {
type AuthAllowFirstRes as AuthAllowFirstResPCloud,
DEFAULT_PCLOUD_CONFIG,
generateAuthUrl as generateAuthUrlPCloud,
sendAuthReq as sendAuthReqPCloud,
setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplacePCloud,
} from "../pro/src/fsPCloud";
import {
DEFAULT_YANDEXDISK_CONFIG,
sendAuthReq as sendAuthReqYandexDisk,
setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplaceYandexDisk,
} from "../pro/src/fsYandexDisk";
import { syncer } from "../pro/src/sync";
import type { import type {
RemotelySavePluginSettings, RemotelySavePluginSettings,
SyncTriggerSourceType, SyncTriggerSourceType,
@@ -32,11 +67,15 @@ import {
} from "./baseTypes"; } from "./baseTypes";
import { API_VER_ENSURE_REQURL_OK } from "./baseTypesObs"; import { API_VER_ENSURE_REQURL_OK } from "./baseTypesObs";
import { messyConfigToNormal, normalConfigToMessy } from "./configPersist"; import { messyConfigToNormal, normalConfigToMessy } from "./configPersist";
import { exportVaultSyncPlansToFiles } from "./debugMode";
import { import {
DEFAULT_DROPBOX_CONFIG, DEFAULT_DROPBOX_CONFIG,
sendAuthReq as sendAuthReqDropbox, sendAuthReq as sendAuthReqDropbox,
setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplaceDropbox, setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplaceDropbox,
} from "./fsDropbox"; } from "./fsDropbox";
import { FakeFsEncrypt } from "./fsEncrypt";
import { getClient } from "./fsGetter";
import { FakeFsLocal } from "./fsLocal";
import { import {
type AccessCodeResponseSuccessfulType, type AccessCodeResponseSuccessfulType,
DEFAULT_ONEDRIVE_CONFIG, DEFAULT_ONEDRIVE_CONFIG,
@@ -45,6 +84,7 @@ import {
} from "./fsOnedrive"; } from "./fsOnedrive";
import { DEFAULT_S3_CONFIG } from "./fsS3"; import { DEFAULT_S3_CONFIG } from "./fsS3";
import { DEFAULT_WEBDAV_CONFIG } from "./fsWebdav"; import { DEFAULT_WEBDAV_CONFIG } from "./fsWebdav";
import { DEFAULT_WEBDIS_CONFIG } from "./fsWebdis";
import { I18n } from "./i18n"; import { I18n } from "./i18n";
import type { LangTypeAndAuto, TransItemType } from "./i18n"; import type { LangTypeAndAuto, TransItemType } from "./i18n";
import { importQrCodeUri } from "./importExport"; import { importQrCodeUri } from "./importExport";
@@ -57,21 +97,10 @@ import {
upsertLastSuccessSyncTimeByVault, upsertLastSuccessSyncTimeByVault,
upsertPluginVersionByVault, upsertPluginVersionByVault,
} from "./localdb"; } from "./localdb";
import { RemotelySaveSettingTab } from "./settings";
import { SyncAlgoV3Modal } from "./syncAlgoV3Notice";
// biome-ignore lint/suspicious/noShadowRestrictedNames: <explanation>
import AggregateError from "aggregate-error";
import throttle from "lodash/throttle";
import { COMMAND_CALLBACK_PRO } from "../pro/src/baseTypesPro";
import { exportVaultSyncPlansToFiles } from "./debugMode";
import { FakeFsEncrypt } from "./fsEncrypt";
import { getClient } from "./fsGetter";
import { FakeFsLocal } from "./fsLocal";
import { DEFAULT_WEBDIS_CONFIG } from "./fsWebdis";
import { changeMobileStatusBar } from "./misc"; import { changeMobileStatusBar } from "./misc";
import { DEFAULT_PROFILER_CONFIG, type Profiler } from "./profiler"; import { DEFAULT_PROFILER_CONFIG, type Profiler } from "./profiler";
import { syncer } from "./sync"; import { RemotelySaveSettingTab } from "./settings";
import { SyncAlgoV3Modal } from "./syncAlgoV3Notice";
const DEFAULT_SETTINGS: RemotelySavePluginSettings = { const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
s3: DEFAULT_S3_CONFIG, s3: DEFAULT_S3_CONFIG,
@@ -79,6 +108,11 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
dropbox: DEFAULT_DROPBOX_CONFIG, dropbox: DEFAULT_DROPBOX_CONFIG,
onedrive: DEFAULT_ONEDRIVE_CONFIG, onedrive: DEFAULT_ONEDRIVE_CONFIG,
webdis: DEFAULT_WEBDIS_CONFIG, webdis: DEFAULT_WEBDIS_CONFIG,
googledrive: DEFAULT_GOOGLEDRIVE_CONFIG,
box: DEFAULT_BOX_CONFIG,
pcloud: DEFAULT_PCLOUD_CONFIG,
yandexdisk: DEFAULT_YANDEXDISK_CONFIG,
koofr: DEFAULT_KOOFR_CONFIG,
password: "", password: "",
serviceType: "s3", serviceType: "s3",
currLogLevel: "info", currLogLevel: "info",
@@ -780,6 +814,234 @@ export default class RemotelySavePlugin extends Plugin {
} }
); );
this.registerObsidianProtocolHandler(
COMMAND_CALLBACK_BOX,
async (inputParams) => {
if (this.oauth2Info.helperModal !== undefined) {
const k = this.oauth2Info.helperModal.contentEl;
k.empty();
t("protocol_box_connecting")
.split("\n")
.forEach((val) => {
k.createEl("p", {
text: val,
});
});
}
console.debug(inputParams);
const authRes = await sendAuthReqBox(
inputParams.code,
async (e: any) => {
new Notice(t("protocol_box_connect_fail"));
new Notice(`${e}`);
throw e;
}
);
console.debug(authRes);
const self = this;
await setConfigBySuccessfullAuthInplaceBox(
this.settings.box!,
authRes,
() => self.saveSettings()
);
this.oauth2Info.verifier = ""; // reset it
this.oauth2Info.helperModal?.close(); // close it
this.oauth2Info.helperModal = undefined;
this.oauth2Info.authDiv?.toggleClass(
"box-auth-button-hide",
this.settings.box?.refreshToken !== ""
);
this.oauth2Info.authDiv = undefined;
this.oauth2Info.revokeAuthSetting?.setDesc(
t("protocol_box_connect_succ_revoke")
);
this.oauth2Info.revokeAuthSetting = undefined;
this.oauth2Info.revokeDiv?.toggleClass(
"box-revoke-auth-button-hide",
this.settings.box?.refreshToken === ""
);
this.oauth2Info.revokeDiv = undefined;
}
);
this.registerObsidianProtocolHandler(
COMMAND_CALLBACK_PCLOUD,
async (inputParams) => {
if (this.oauth2Info.helperModal !== undefined) {
const k = this.oauth2Info.helperModal.contentEl;
k.empty();
t("protocol_pcloud_connecting")
.split("\n")
.forEach((val) => {
k.createEl("p", {
text: val,
});
});
}
console.debug(inputParams);
const authRes = await sendAuthReqPCloud(
inputParams.hostname,
inputParams.code,
async (e: any) => {
new Notice(t("protocol_pcloud_connect_fail"));
new Notice(`${e}`);
throw e;
}
);
console.debug(authRes);
const self = this;
await setConfigBySuccessfullAuthInplacePCloud(
this.settings.pcloud!,
inputParams as unknown as AuthAllowFirstResPCloud,
authRes,
() => self.saveSettings()
);
this.oauth2Info.verifier = ""; // reset it
this.oauth2Info.helperModal?.close(); // close it
this.oauth2Info.helperModal = undefined;
this.oauth2Info.authDiv?.toggleClass(
"pcloud-auth-button-hide",
this.settings.pcloud?.accessToken !== ""
);
this.oauth2Info.authDiv = undefined;
this.oauth2Info.revokeAuthSetting?.setDesc(
t("protocol_pcloud_connect_succ_revoke")
);
this.oauth2Info.revokeAuthSetting = undefined;
this.oauth2Info.revokeDiv?.toggleClass(
"pcloud-revoke-auth-button-hide",
this.settings.pcloud?.accessToken === ""
);
this.oauth2Info.revokeDiv = undefined;
}
);
this.registerObsidianProtocolHandler(
COMMAND_CALLBACK_YANDEXDISK,
async (inputParams) => {
if (this.oauth2Info.helperModal !== undefined) {
const k = this.oauth2Info.helperModal.contentEl;
k.empty();
t("protocol_yandexdisk_connecting")
.split("\n")
.forEach((val) => {
k.createEl("p", {
text: val,
});
});
}
console.debug(inputParams);
const authRes = await sendAuthReqYandexDisk(
inputParams.code,
async (e: any) => {
new Notice(t("protocol_yandexdisk_connect_fail"));
new Notice(`${e}`);
throw e;
}
);
console.debug(authRes);
const self = this;
await setConfigBySuccessfullAuthInplaceYandexDisk(
this.settings.yandexdisk!,
authRes,
() => self.saveSettings()
);
this.oauth2Info.verifier = ""; // reset it
this.oauth2Info.helperModal?.close(); // close it
this.oauth2Info.helperModal = undefined;
this.oauth2Info.authDiv?.toggleClass(
"yandexdisk-auth-button-hide",
this.settings.yandexdisk?.refreshToken !== ""
);
this.oauth2Info.authDiv = undefined;
this.oauth2Info.revokeAuthSetting?.setDesc(
t("protocol_yandexdisk_connect_succ_revoke")
);
this.oauth2Info.revokeAuthSetting = undefined;
this.oauth2Info.revokeDiv?.toggleClass(
"yandexdisk-revoke-auth-button-hide",
this.settings.yandexdisk?.refreshToken === ""
);
this.oauth2Info.revokeDiv = undefined;
}
);
this.registerObsidianProtocolHandler(
COMMAND_CALLBACK_KOOFR,
async (inputParams) => {
if (this.oauth2Info.helperModal !== undefined) {
const k = this.oauth2Info.helperModal.contentEl;
k.empty();
t("protocol_koofr_connecting")
.split("\n")
.forEach((val) => {
k.createEl("p", {
text: val,
});
});
}
console.debug(inputParams);
const authRes = await sendAuthReqKoofr(
this.settings.koofr.api,
inputParams.code,
async (e: any) => {
new Notice(t("protocol_koofr_connect_fail"));
new Notice(`${e}`);
throw e;
},
true
);
console.debug(authRes);
const self = this;
await setConfigBySuccessfullAuthInplaceKoofr(
this.settings.koofr!,
authRes!,
() => self.saveSettings()
);
this.oauth2Info.verifier = ""; // reset it
this.oauth2Info.helperModal?.close(); // close it
this.oauth2Info.helperModal = undefined;
this.oauth2Info.authDiv?.toggleClass(
"koofr-auth-button-hide",
this.settings.koofr?.refreshToken !== ""
);
this.oauth2Info.authDiv = undefined;
this.oauth2Info.revokeAuthSetting?.setDesc(
t("protocol_koofr_connect_succ_revoke")
);
this.oauth2Info.revokeAuthSetting = undefined;
this.oauth2Info.revokeDiv?.toggleClass(
"koofr-revoke-auth-button-hide",
this.settings.koofr?.refreshToken === ""
);
this.oauth2Info.revokeDiv = undefined;
}
);
this.syncRibbon = this.addRibbonIcon( this.syncRibbon = this.addRibbonIcon(
iconNameSyncWait, iconNameSyncWait,
`${this.manifest.name}`, `${this.manifest.name}`,
@@ -1062,6 +1324,26 @@ export default class RemotelySavePlugin extends Plugin {
this.settings.profiler.recordSize = false; this.settings.profiler.recordSize = false;
} }
if (this.settings.googledrive === undefined) {
this.settings.googledrive = DEFAULT_GOOGLEDRIVE_CONFIG;
}
if (this.settings.box === undefined) {
this.settings.box = DEFAULT_BOX_CONFIG;
}
if (this.settings.pcloud === undefined) {
this.settings.pcloud = DEFAULT_PCLOUD_CONFIG;
}
if (this.settings.yandexdisk === undefined) {
this.settings.yandexdisk = DEFAULT_YANDEXDISK_CONFIG;
}
if (this.settings.koofr === undefined) {
this.settings.koofr = DEFAULT_KOOFR_CONFIG;
}
await this.saveSettings(); await this.saveSettings();
} }
@@ -1130,6 +1412,56 @@ export default class RemotelySavePlugin extends Plugin {
needSave = true; needSave = true;
} }
let googleDriveExpired = false;
if (
this.settings.googledrive.refreshToken !== "" &&
current >= this.settings!.googledrive!.credentialsShouldBeDeletedAtTimeMs!
) {
googleDriveExpired = true;
this.settings.googledrive = cloneDeep(DEFAULT_GOOGLEDRIVE_CONFIG);
needSave = true;
}
let boxExpired = false;
if (
this.settings.box.refreshToken !== "" &&
current >= this.settings!.box!.credentialsShouldBeDeletedAtTimeMs!
) {
boxExpired = true;
this.settings.box = cloneDeep(DEFAULT_BOX_CONFIG);
needSave = true;
}
let pCloudExpired = false;
if (
this.settings.pcloud.accessToken !== "" &&
current >= this.settings!.pcloud!.credentialsShouldBeDeletedAtTimeMs!
) {
pCloudExpired = true;
this.settings.pcloud = cloneDeep(DEFAULT_PCLOUD_CONFIG);
needSave = true;
}
let yandexDiskExpired = false;
if (
this.settings.yandexdisk.refreshToken !== "" &&
current >= this.settings!.yandexdisk!.credentialsShouldBeDeletedAtTimeMs!
) {
yandexDiskExpired = true;
this.settings.yandexdisk = cloneDeep(DEFAULT_YANDEXDISK_CONFIG);
needSave = true;
}
let koofrExpired = false;
if (
this.settings.koofr.refreshToken !== "" &&
current >= this.settings!.koofr!.credentialsShouldBeDeletedAtTimeMs!
) {
koofrExpired = true;
this.settings.koofr = cloneDeep(DEFAULT_KOOFR_CONFIG);
needSave = true;
}
if (this.settings.pro === undefined) { if (this.settings.pro === undefined) {
this.settings.pro = cloneDeep(DEFAULT_PRO_CONFIG); this.settings.pro = cloneDeep(DEFAULT_PRO_CONFIG);
} }
@@ -1140,19 +1472,45 @@ export default class RemotelySavePlugin extends Plugin {
} }
// send notice // send notice
if (dropboxExpired && onedriveExpired) { if (dropboxExpired) {
new Notice( new Notice(
`${this.manifest.name}: You haven't manually auth Dropbox and OneDrive for a while, you need to re-auth them again.`, `${this.manifest.name}: You haven't manually auth Dropbox for many days, you need to re-auth it again.`,
6000 6000
); );
} else if (dropboxExpired) { }
if (onedriveExpired) {
new Notice( new Notice(
`${this.manifest.name}: You haven't manually auth Dropbox for a while, you need to re-auth it again.`, `${this.manifest.name}: You haven't manually auth OneDrive for many days, you need to re-auth it again.`,
6000 6000
); );
} else if (onedriveExpired) { }
if (googleDriveExpired) {
new Notice( new Notice(
`${this.manifest.name}: You haven't manually auth OneDrive for a while, you need to re-auth it again.`, `${this.manifest.name}: You haven't manually auth Google Drive for many days, you need to re-auth it again.`,
6000
);
}
if (boxExpired) {
new Notice(
`${this.manifest.name}: You haven't manually auth Box for many days, you need to re-auth it again.`,
6000
);
}
if (pCloudExpired) {
new Notice(
`${this.manifest.name}: You haven't manually auth pCloud for many days, you need to re-auth it again.`,
6000
);
}
if (yandexDiskExpired) {
new Notice(
`${this.manifest.name}: You haven't manually auth Yandex Disk for many days, you need to re-auth it again.`,
6000
);
}
if (koofrExpired) {
new Notice(
`${this.manifest.name}: You haven't manually auth koofr for many days, you need to re-auth it again.`,
6000 6000
); );
} }
@@ -1316,12 +1674,14 @@ export default class RemotelySavePlugin extends Plugin {
this.registerEvent(this.app.vault.on("modify", this._syncOnSaveEvent2)); this.registerEvent(this.app.vault.on("modify", this._syncOnSaveEvent2));
this.registerEvent(this.app.vault.on("create", this._syncOnSaveEvent2)); this.registerEvent(this.app.vault.on("create", this._syncOnSaveEvent2));
this.registerEvent(this.app.vault.on("delete", this._syncOnSaveEvent2)); this.registerEvent(this.app.vault.on("delete", this._syncOnSaveEvent2));
this.registerEvent(this.app.vault.on("rename", this._syncOnSaveEvent2));
}); });
} else { } else {
this.syncEvent?.off("SYNC_DONE", this._syncOnSaveEvent1); this.syncEvent?.off("SYNC_DONE", this._syncOnSaveEvent1);
this.app.vault.off("modify", this._syncOnSaveEvent2); this.app.vault.off("modify", this._syncOnSaveEvent2);
this.app.vault.off("create", this._syncOnSaveEvent2); this.app.vault.off("create", this._syncOnSaveEvent2);
this.app.vault.off("delete", this._syncOnSaveEvent2); this.app.vault.off("delete", this._syncOnSaveEvent2);
this.app.vault.off("rename", this._syncOnSaveEvent2);
} }
} }
+19 -2
View File
@@ -341,11 +341,17 @@ export const checkHasSpecialCharForDir = (x: string) => {
return /[?/\\]/.test(x); return /[?/\\]/.test(x);
}; };
export const unixTimeToStr = (x: number | undefined | null) => { export const unixTimeToStr = (x: number | undefined | null, hasMs = false) => {
if (x === undefined || x === null || Number.isNaN(x)) { if (x === undefined || x === null || Number.isNaN(x)) {
return undefined; return undefined;
} }
return window.moment(x).format() as string; if (hasMs) {
// 1716712162574 => '2024-05-26T16:29:22.574+08:00'
return window.moment(x).toISOString(true);
} else {
// 1716712162574 => '2024-05-26T16:29:22+08:00'
return window.moment(x).format() as string;
}
}; };
/** /**
@@ -710,3 +716,14 @@ export const splitFileSizeToChunkRanges = (
} }
return res; return res;
}; };
export const getSha1 = async (x: ArrayBuffer, stringify: "base64" | "hex") => {
const y = await window.crypto.subtle.digest("SHA-1", x);
if (stringify === "base64") {
return arrayBufferToBase64(y);
} else if (stringify === "hex") {
return arrayBufferToHex(y);
}
throw Error(`not supported stringify option = ${stringify}`);
};
+193 -26
View File
@@ -21,7 +21,12 @@ import type {
} from "./baseTypes"; } from "./baseTypes";
import cloneDeep from "lodash/cloneDeep"; import cloneDeep from "lodash/cloneDeep";
import { generateBoxSettingsPart } from "../pro/src/settingsBox";
import { generateGoogleDriveSettingsPart } from "../pro/src/settingsGoogleDrive";
import { generateKoofrSettingsPart } from "../pro/src/settingsKoofr";
import { generatePCloudSettingsPart } from "../pro/src/settingsPCloud";
import { generateProSettingsPart } from "../pro/src/settingsPro"; import { generateProSettingsPart } from "../pro/src/settingsPro";
import { generateYandexDiskSettingsPart } from "../pro/src/settingsYandexDisk";
import { API_VER_ENSURE_REQURL_OK, VALID_REQURL } from "./baseTypesObs"; import { API_VER_ENSURE_REQURL_OK, VALID_REQURL } from "./baseTypesObs";
import { messyConfigToNormal } from "./configPersist"; import { messyConfigToNormal } from "./configPersist";
import { import {
@@ -63,10 +68,17 @@ import { DEFAULT_PROFILER_CONFIG } from "./profiler";
class PasswordModal extends Modal { class PasswordModal extends Modal {
plugin: RemotelySavePlugin; plugin: RemotelySavePlugin;
newPassword: string; newPassword: string;
constructor(app: App, plugin: RemotelySavePlugin, newPassword: string) { encryptionMethodSetting: Setting;
constructor(
app: App,
plugin: RemotelySavePlugin,
newPassword: string,
encryptionMethodSetting: Setting
) {
super(app); super(app);
this.plugin = plugin; this.plugin = plugin;
this.newPassword = newPassword; this.newPassword = newPassword;
this.encryptionMethodSetting = encryptionMethodSetting;
} }
onOpen() { onOpen() {
@@ -110,6 +122,16 @@ class PasswordModal extends Modal {
button.setButtonText(t("modal_password_secondconfirm")); button.setButtonText(t("modal_password_secondconfirm"));
button.onClick(async () => { button.onClick(async () => {
this.plugin.settings.password = this.newPassword; this.plugin.settings.password = this.newPassword;
if (this.newPassword !== "") {
this.encryptionMethodSetting.settingEl.removeClass(
"settings-encryption-method-hide"
);
} else {
this.encryptionMethodSetting.settingEl.addClass(
"settings-encryption-method-hide"
);
}
await this.plugin.saveSettings(); await this.plugin.saveSettings();
new Notice(t("modal_password_notice")); new Notice(t("modal_password_notice"));
this.close(); this.close();
@@ -169,7 +191,7 @@ class EncryptionMethodModal extends Modal {
} }
} }
class ChangeRemoteBaseDirModal extends Modal { export class ChangeRemoteBaseDirModal extends Modal {
readonly plugin: RemotelySavePlugin; readonly plugin: RemotelySavePlugin;
readonly newRemoteBaseDir: string; readonly newRemoteBaseDir: string;
readonly service: SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR; readonly service: SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR;
@@ -1791,6 +1813,65 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
}); });
}); });
//////////////////////////////////////////////////
// below for googledrive
//////////////////////////////////////////////////
const {
googleDriveDiv,
googleDriveAllowedToUsedDiv,
googleDriveNotShowUpHintSetting,
} = generateGoogleDriveSettingsPart(
containerEl,
t,
this.app,
this.plugin,
() => this.plugin.saveSettings()
);
//////////////////////////////////////////////////
// below for box
//////////////////////////////////////////////////
const { boxDiv, boxAllowedToUsedDiv, boxNotShowUpHintSetting } =
generateBoxSettingsPart(containerEl, t, this.app, this.plugin, () =>
this.plugin.saveSettings()
);
//////////////////////////////////////////////////
// below for pcloud
//////////////////////////////////////////////////
const { pCloudDiv, pCloudAllowedToUsedDiv, pCloudNotShowUpHintSetting } =
generatePCloudSettingsPart(containerEl, t, this.app, this.plugin, () =>
this.plugin.saveSettings()
);
//////////////////////////////////////////////////
// below for yandexdisk
//////////////////////////////////////////////////
const {
yandexDiskDiv,
yandexDiskAllowedToUsedDiv,
yandexDiskNotShowUpHintSetting,
} = generateYandexDiskSettingsPart(
containerEl,
t,
this.app,
this.plugin,
() => this.plugin.saveSettings()
);
//////////////////////////////////////////////////
// below for koofr
//////////////////////////////////////////////////
const { koofrDiv, koofrAllowedToUsedDiv, koofrNotShowUpHintSetting } =
generateKoofrSettingsPart(containerEl, t, this.app, this.plugin, () =>
this.plugin.saveSettings()
);
////////////////////////////////////////////////// //////////////////////////////////////////////////
// below for general chooser (part 2/2) // below for general chooser (part 2/2)
////////////////////////////////////////////////// //////////////////////////////////////////////////
@@ -1806,6 +1887,17 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
dropdown.addOption("webdav", t("settings_chooseservice_webdav")); dropdown.addOption("webdav", t("settings_chooseservice_webdav"));
dropdown.addOption("onedrive", t("settings_chooseservice_onedrive")); dropdown.addOption("onedrive", t("settings_chooseservice_onedrive"));
dropdown.addOption("webdis", t("settings_chooseservice_webdis")); dropdown.addOption("webdis", t("settings_chooseservice_webdis"));
dropdown.addOption(
"googledrive",
t("settings_chooseservice_googledrive")
);
dropdown.addOption("box", t("settings_chooseservice_box"));
dropdown.addOption("pcloud", t("settings_chooseservice_pcloud"));
dropdown.addOption(
"yandexdisk",
t("settings_chooseservice_yandexdisk")
);
// dropdown.addOption("koofr", t("settings_chooseservice_koofr"));
dropdown dropdown
.setValue(this.plugin.settings.serviceType) .setValue(this.plugin.settings.serviceType)
@@ -1831,6 +1923,26 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
"webdis-hide", "webdis-hide",
this.plugin.settings.serviceType !== "webdis" this.plugin.settings.serviceType !== "webdis"
); );
googleDriveDiv.toggleClass(
"googledrive-hide",
this.plugin.settings.serviceType !== "googledrive"
);
boxDiv.toggleClass(
"box-hide",
this.plugin.settings.serviceType !== "box"
);
pCloudDiv.toggleClass(
"pcloud-hide",
this.plugin.settings.serviceType !== "pcloud"
);
yandexDiskDiv.toggleClass(
"yandexdisk-hide",
this.plugin.settings.serviceType !== "yandexdisk"
);
koofrDiv.toggleClass(
"koofr-hide",
this.plugin.settings.serviceType !== "koofr"
);
await this.plugin.saveSettings(); await this.plugin.saveSettings();
}); });
}); });
@@ -1842,8 +1954,11 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
const basicDiv = containerEl.createEl("div"); const basicDiv = containerEl.createEl("div");
basicDiv.createEl("h2", { text: t("settings_basic") }); basicDiv.createEl("h2", { text: t("settings_basic") });
const passwordSetting = new Setting(basicDiv);
const encryptionMethodSetting = new Setting(basicDiv);
let newPassword = `${this.plugin.settings.password}`; let newPassword = `${this.plugin.settings.password}`;
new Setting(basicDiv) passwordSetting
.setName(t("settings_password")) .setName(t("settings_password"))
.setDesc(t("settings_password_desc")) .setDesc(t("settings_password_desc"))
.addText((text) => { .addText((text) => {
@@ -1858,11 +1973,21 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
.addButton(async (button) => { .addButton(async (button) => {
button.setButtonText(t("confirm")); button.setButtonText(t("confirm"));
button.onClick(async () => { button.onClick(async () => {
new PasswordModal(this.app, this.plugin, newPassword).open(); new PasswordModal(
this.app,
this.plugin,
newPassword,
encryptionMethodSetting
).open();
}); });
}); });
new Setting(basicDiv) if (this.plugin.settings.password === "") {
encryptionMethodSetting.settingEl.addClass(
"settings-encryption-method-hide"
);
}
encryptionMethodSetting
.setName(t("settings_encryptionmethod")) .setName(t("settings_encryptionmethod"))
.setDesc(stringToFragment(t("settings_encryptionmethod_desc"))) .setDesc(stringToFragment(t("settings_encryptionmethod_desc")))
.addDropdown((dropdown) => { .addDropdown((dropdown) => {
@@ -2170,24 +2295,6 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
}); });
}); });
new Setting(advDiv)
.setName(t("settings_cleanemptyfolder"))
.setDesc(t("settings_cleanemptyfolder_desc"))
.addDropdown((dropdown) => {
dropdown.addOption("skip", t("settings_cleanemptyfolder_skip"));
dropdown.addOption(
"clean_both",
t("settings_cleanemptyfolder_clean_both")
);
dropdown
.setValue(this.plugin.settings.howToCleanEmptyFolder ?? "clean_both")
.onChange(async (val) => {
this.plugin.settings.howToCleanEmptyFolder =
val as EmptyFolderCleanType;
await this.plugin.saveSettings();
});
});
const percentage1 = new Setting(advDiv) const percentage1 = new Setting(advDiv)
.setName(t("settings_protectmodifypercentage")) .setName(t("settings_protectmodifypercentage"))
.setDesc(t("settings_protectmodifypercentage_desc")); .setDesc(t("settings_protectmodifypercentage_desc"));
@@ -2262,7 +2369,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
new Setting(advDiv) new Setting(advDiv)
.setName(t("setting_syncdirection")) .setName(t("setting_syncdirection"))
.setDesc(t("setting_syncdirection_desc")) .setDesc(stringToFragment(t("setting_syncdirection_desc")))
.addDropdown((dropdown) => { .addDropdown((dropdown) => {
dropdown.addOption( dropdown.addOption(
"bidirectional", "bidirectional",
@@ -2276,6 +2383,14 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
"incremental_pull_only", "incremental_pull_only",
t("setting_syncdirection_incremental_pull_only_desc") t("setting_syncdirection_incremental_pull_only_desc")
); );
dropdown.addOption(
"incremental_push_and_delete_only",
t("setting_syncdirection_incremental_push_and_delete_only_desc")
);
dropdown.addOption(
"incremental_pull_and_delete_only",
t("setting_syncdirection_incremental_pull_and_delete_only_desc")
);
dropdown dropdown
.setValue(this.plugin.settings.syncDirection ?? "bidirectional") .setValue(this.plugin.settings.syncDirection ?? "bidirectional")
@@ -2383,6 +2498,44 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
button.onClick(async () => { button.onClick(async () => {
new ExportSettingsQrCodeModal(this.app, this.plugin, "webdis").open(); new ExportSettingsQrCodeModal(this.app, this.plugin, "webdis").open();
}); });
})
.addButton(async (button) => {
button.setButtonText(t("settings_export_googledrive_button"));
button.onClick(async () => {
new ExportSettingsQrCodeModal(
this.app,
this.plugin,
"googledrive"
).open();
});
})
.addButton(async (button) => {
button.setButtonText(t("settings_export_box_button"));
button.onClick(async () => {
new ExportSettingsQrCodeModal(this.app, this.plugin, "box").open();
});
})
.addButton(async (button) => {
button.setButtonText(t("settings_export_pcloud_button"));
button.onClick(async () => {
new ExportSettingsQrCodeModal(this.app, this.plugin, "pcloud").open();
});
})
.addButton(async (button) => {
button.setButtonText(t("settings_export_yandexdisk_button"));
button.onClick(async () => {
new ExportSettingsQrCodeModal(
this.app,
this.plugin,
"yandexdisk"
).open();
});
})
.addButton(async (button) => {
button.setButtonText(t("settings_export_koofr_button"));
button.onClick(async () => {
new ExportSettingsQrCodeModal(this.app, this.plugin, "koofr").open();
});
}); });
let importSettingVal = ""; let importSettingVal = "";
@@ -2442,8 +2595,22 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
////////////////////////////////////////////////// //////////////////////////////////////////////////
const proDiv = containerEl.createEl("div"); const proDiv = containerEl.createEl("div");
generateProSettingsPart(proDiv, t, this.app, this.plugin, () => generateProSettingsPart(
this.plugin.saveSettings() proDiv,
t,
this.app,
this.plugin,
() => this.plugin.saveSettings(),
googleDriveAllowedToUsedDiv,
googleDriveNotShowUpHintSetting,
boxAllowedToUsedDiv,
boxNotShowUpHintSetting,
pCloudAllowedToUsedDiv,
pCloudNotShowUpHintSetting,
yandexDiskAllowedToUsedDiv,
yandexDiskNotShowUpHintSetting,
koofrAllowedToUsedDiv,
koofrNotShowUpHintSetting
); );
////////////////////////////////////////////////// //////////////////////////////////////////////////
+99
View File
@@ -21,6 +21,10 @@
display: none; display: none;
} }
.settings-encryption-method-hide {
display: none;
}
.s3-disclaimer { .s3-disclaimer {
font-weight: bold; font-weight: bold;
} }
@@ -72,6 +76,101 @@
display: none; display: none;
} }
.googledrive-disclaimer {
font-weight: bold;
}
.googledrive-hide {
display: none;
}
.googledrive-allow-to-use-hide {
display: none;
}
.googledrive-auth-button-hide {
display: none;
}
.googledrive-revoke-auth-button-hide {
display: none;
}
.box-disclaimer {
font-weight: bold;
}
.box-hide {
display: none;
}
.box-allow-to-use-hide {
display: none;
}
.box-auth-button-hide {
display: none;
}
.box-revoke-auth-button-hide {
display: none;
}
.pcloud-disclaimer {
font-weight: bold;
}
.pcloud-hide {
display: none;
}
.pcloud-allow-to-use-hide {
display: none;
}
.pcloud-auth-button-hide {
display: none;
}
.pcloud-revoke-auth-button-hide {
display: none;
}
.yandexdisk-disclaimer {
font-weight: bold;
}
.yandexdisk-hide {
display: none;
}
.yandexdisk-allow-to-use-hide {
display: none;
}
.yandexdisk-auth-button-hide {
display: none;
}
.yandexdisk-revoke-auth-button-hide {
display: none;
}
.koofr-disclaimer {
font-weight: bold;
}
.koofr-hide {
display: none;
}
.koofr-allow-to-use-hide {
display: none;
}
.koofr-auth-button-hide {
display: none;
}
.koofr-revoke-auth-button-hide {
display: none;
}
.qrcode-img { .qrcode-img {
width: 350px; width: 350px;
height: 350px; height: 350px;
+15
View File
@@ -19,6 +19,21 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
webdis: { webdis: {
address: "addr", address: "addr",
} as any, } as any,
googledrive: {
refreshToken: "xxx",
} as any,
box: {
refreshToken: "xxx",
} as any,
pcloud: {
accessToken: "xxx",
} as any,
yandexdisk: {
refreshToken: "xxx",
} as any,
koofr: {
refreshToken: "xxx",
} as any,
password: "password", password: "password",
serviceType: "s3", serviceType: "s3",
currLogLevel: "info", currLogLevel: "info",
+22
View File
@@ -8,6 +8,18 @@ const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || ""; const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
const DEFAULT_REMOTELYSAVE_WEBSITE = process.env.REMOTELYSAVE_WEBSITE || ""; const DEFAULT_REMOTELYSAVE_WEBSITE = process.env.REMOTELYSAVE_WEBSITE || "";
const DEFAULT_REMOTELYSAVE_CLIENT_ID = process.env.REMOTELYSAVE_CLIENT_ID || ""; const DEFAULT_REMOTELYSAVE_CLIENT_ID = process.env.REMOTELYSAVE_CLIENT_ID || "";
const DEFAULT_GOOGLEDRIVE_CLIENT_ID = process.env.GOOGLEDRIVE_CLIENT_ID || "";
const DEFAULT_GOOGLEDRIVE_CLIENT_SECRET =
process.env.GOOGLEDRIVE_CLIENT_SECRET || "";
const DEFAULT_BOX_CLIENT_ID = process.env.BOX_CLIENT_ID || "";
const DEFAULT_BOX_CLIENT_SECRET = process.env.BOX_CLIENT_SECRET || "";
const DEFAULT_PCLOUD_CLIENT_ID = process.env.PCLOUD_CLIENT_ID || "";
const DEFAULT_PCLOUD_CLIENT_SECRET = process.env.PCLOUD_CLIENT_SECRET || "";
const DEFAULT_YANDEXDISK_CLIENT_ID = process.env.YANDEXDISK_CLIENT_ID || "";
const DEFAULT_YANDEXDISK_CLIENT_SECRET =
process.env.YANDEXDISK_CLIENT_SECRET || "";
const DEFAULT_KOOFR_CLIENT_ID = process.env.KOOFR_CLIENT_ID || "";
const DEFAULT_KOOFR_CLIENT_SECRET = process.env.KOOFR_CLIENT_SECRET || "";
module.exports = { module.exports = {
entry: "./src/main.ts", entry: "./src/main.ts",
@@ -24,6 +36,16 @@ module.exports = {
"process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`, "process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`,
"process.env.DEFAULT_REMOTELYSAVE_WEBSITE": `"${DEFAULT_REMOTELYSAVE_WEBSITE}"`, "process.env.DEFAULT_REMOTELYSAVE_WEBSITE": `"${DEFAULT_REMOTELYSAVE_WEBSITE}"`,
"process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID": `"${DEFAULT_REMOTELYSAVE_CLIENT_ID}"`, "process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID": `"${DEFAULT_REMOTELYSAVE_CLIENT_ID}"`,
"process.env.DEFAULT_GOOGLEDRIVE_CLIENT_ID": `"${DEFAULT_GOOGLEDRIVE_CLIENT_ID}"`,
"process.env.DEFAULT_GOOGLEDRIVE_CLIENT_SECRET": `"${DEFAULT_GOOGLEDRIVE_CLIENT_SECRET}"`,
"process.env.DEFAULT_BOX_CLIENT_ID": `"${DEFAULT_BOX_CLIENT_ID}"`,
"process.env.DEFAULT_BOX_CLIENT_SECRET": `"${DEFAULT_BOX_CLIENT_SECRET}"`,
"process.env.DEFAULT_PCLOUD_CLIENT_ID": `"${DEFAULT_PCLOUD_CLIENT_ID}"`,
"process.env.DEFAULT_PCLOUD_CLIENT_SECRET": `"${DEFAULT_PCLOUD_CLIENT_SECRET}"`,
"process.env.DEFAULT_YANDEXDISK_CLIENT_ID": `"${DEFAULT_YANDEXDISK_CLIENT_ID}"`,
"process.env.DEFAULT_YANDEXDISK_CLIENT_SECRET": `"${DEFAULT_YANDEXDISK_CLIENT_SECRET}"`,
"process.env.DEFAULT_KOOFR_CLIENT_ID": `"${DEFAULT_KOOFR_CLIENT_ID}"`,
"process.env.DEFAULT_KOOFR_CLIENT_SECRET": `"${DEFAULT_KOOFR_CLIENT_SECRET}"`,
}), }),
// Work around for Buffer is undefined: // Work around for Buffer is undefined:
// https://github.com/webpack/changelog-v5/issues/10 // https://github.com/webpack/changelog-v5/issues/10