Compare commits

...
22 Commits
Author SHA1 Message Date
fyears 272bc7a543 bump to 0.5.7
Release A New Version / build (16.x) (push) Failing after 52s
2024-06-17 00:15:59 +08:00
fyears 35f5355c8e optimize sync status bar 2024-06-17 00:15:33 +08:00
fyears 57493f57cf polish doc 2024-06-16 20:07:49 +08:00
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
47 changed files with 11997 additions and 256 deletions
+2
View File
@@ -11,3 +11,5 @@ PCLOUD_CLIENT_ID=
PCLOUD_CLIENT_SECRET=
YANDEXDISK_CLIENT_ID=
YANDEXDISK_CLIENT_SECRET=
KOOFR_CLIENT_ID=
KOOFR_CLIENT_SECRET=
+2
View File
@@ -29,6 +29,8 @@ jobs:
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:
matrix:
+2
View File
@@ -33,6 +33,8 @@ jobs:
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:
matrix:
+24 -3
View File
@@ -22,10 +22,11 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
- OneDrive for personal
- Webdav (NextCloud / InfiniCloud / Synology webdav server / ...)
- Webdis
- Google Drive (PRO feature)
- Google Drive (GDrive) (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.
- **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.
@@ -33,7 +34,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
- **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
- **Skip Large files** and **skip paths** by custom regex conditions!
- **[Sync Algorithm](./docs/sync_algorithm/v3/intro.md) is provided for discussion.**
- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** for free version. **[Advanced Conflict Handling](./pro/README.md)** for PRO version.
- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** for free version. **[Advanced Smart Conflict Handling](./pro/README.md)** for PRO version.
- Source Available. See [License](./LICENSE) for details.
## Limitations
@@ -111,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)
- [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)
- [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).
- 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**.
@@ -123,7 +127,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
- Mostly experimental.
- You have to setup and protect your web server by yourself.
### Google Drive (PRO feature)
### Google Drive (GDrive) (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).
@@ -139,12 +143,29 @@ PRO (paid) feature "sync with pCloud" allows users to to sync with pCloud (using
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).
### Koofr (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).
## Smart Conflict (PRO feature)
Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the files.
PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files.
See documents [here](./docs/pro/README.md)
## Scheduled Auto Sync
- You can configure auto syncing every N minutes in settings.
- In auto sync mode, if any error occurs, the plugin would **fail silently**.
- Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
## Sync On Save
- You can configure sync on save in settings.
- In sync on save mode, if any error occurs, the plugin would **fail silently**.
## How To Deal With Hidden Files Or Folders
**By default, all files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
+2 -2
View File
@@ -44,10 +44,10 @@ You need to connect your plugin to your online account. In Obsidian, in your Rem
## Why so complicated?
Because we doesn't have payment method inside the plugin, so we have to:
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 flexibe management of subscriptions.
Moreover, an online account allows flexible management of subscriptions.
+1 -1
View File
@@ -1,4 +1,4 @@
# Google Drive (PRO)
# Google Drive (GDrive) (PRO)
# Intro
+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.
@@ -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.
+20 -2
View File
@@ -52,7 +52,7 @@ Bidirectional:
| local deleted | (04) delete remote | (05) pull | (01) clean history | (03) pull |
| 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 |
| --------------- | ---------------------------- | ---------------------------- | ---------------------- | ---------------------------- |
@@ -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 created | (??) conflict | (??) conflict | (06) push | **(23) conflict push** |
Incremental pull only:
Incremental pull:
| 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 deleted | **(35) conflict pull** | (05) pull | (01) clean history | (03) 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** |
+4
View File
@@ -29,6 +29,8 @@ 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
.context({
@@ -74,6 +76,8 @@ esbuild
"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",
"process.env.NODE_DEBUG": `undefined`, // ugly fix
"process.env.DEBUG": `undefined`, // ugly fix
+1 -1
View File
@@ -1,7 +1,7 @@
{
"id": "remotely-save",
"name": "Remotely Save",
"version": "0.5.4",
"version": "0.5.7",
"minAppVersion": "0.13.21",
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
"author": "fyears",
+1 -1
View File
@@ -1,7 +1,7 @@
{
"id": "remotely-save",
"name": "Remotely Save",
"version": "0.5.4",
"version": "0.5.7",
"minAppVersion": "0.13.21",
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
"author": "fyears",
+3 -1
View File
@@ -1,6 +1,6 @@
{
"name": "remotely-save",
"version": "0.5.4",
"version": "0.5.7",
"description": "This is yet another sync plugin for Obsidian app.",
"scripts": {
"dev2": "node esbuild.config.mjs --watch",
@@ -45,6 +45,7 @@
"mocha": "^10.4.0",
"npm-check-updates": "^16.14.20",
"obsidian": "^1.5.7",
"openapi-typescript": "^7.0.0-rc.0",
"ts-loader": "^9.5.1",
"ts-node": "^10.9.2",
"tslib": "^2.6.2",
@@ -86,6 +87,7 @@
"mustache": "^4.2.0",
"nanoid": "^5.0.7",
"node-diff3": "^3.1.2",
"openapi-fetch": "^0.9.7",
"p-queue": "^8.0.1",
"path-browserify": "^1.0.1",
"pcloud-sdk-js": "^2.0.0",
+19 -3
View File
@@ -6,18 +6,34 @@ Remotely Save has some "pro features", which users have to pay for using them.
## Sign Up / Sign In And Connect
See the tutorial about your PRO account [here](../docs/pro/README.md).
See the tutorial about your PRO account [here](.../docs/pro/README.md).
## Smart Conflict
## Smart Conflict (PRO feature)
Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the 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
## Google Drive (GDrive) (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).
## Koofr (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).
## 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".
+5
View File
@@ -285,6 +285,11 @@ export const checkProRunnableAndFixInplace = async (
service: "yandexdisk",
name: "Yandex Disk",
},
{
feature: "feature-koofr",
service: "koofr",
name: "Koofr",
},
];
for (const { feature, service, name } of toChecked) {
+28 -2
View File
@@ -11,7 +11,8 @@ export type PRO_FEATURE_TYPE =
| "feature-google_drive"
| "feature-box"
| "feature-pcloud"
| "feature-yandex_disk";
| "feature-yandex_disk"
| "feature-koofr";
export interface FeatureInfo {
featureName: PRO_FEATURE_TYPE;
@@ -87,8 +88,12 @@ export interface PCloudConfig {
locationid: 1 | 2;
remoteBaseDir?: string;
credentialsShouldBeDeletedAtTimeMs?: number;
emptyFile: "skip" | "error";
kind: "pcloud";
/**
* @deprecated
*/
emptyFile: "skip" | "error";
}
///////////////////////////////////////////////////////////
@@ -110,3 +115,24 @@ export interface YandexDiskConfig {
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";
}
+2
View File
@@ -404,6 +404,8 @@ export class FakeFsBox extends FakeFs {
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;
+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;
}
}
+41 -20
View File
@@ -285,6 +285,10 @@ const fromNestedFolderToEntityListAndCache = (
};
};
const getPCloudPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
return `/${remoteBaseDir}/${fileOrFolderPath}`;
};
export class FakeFsPCloud extends FakeFs {
kind: string;
@@ -464,25 +468,6 @@ export class FakeFsPCloud extends FakeFs {
await this._init();
if (content.byteLength === 0) {
if (this.pCloudConfig.emptyFile === "error") {
throw Error(
`${key}: Empty file is not allowed in pCloud, and please write something in it.`
);
} else {
return {
key: key,
keyRaw: key,
mtimeSvr: mtime,
mtimeCli: mtime,
size: 0,
sizeRaw: 0,
synthesizedFile: true,
// hash: ?? // TODO
};
}
}
const prevCachedEntity: PCloudEntity | undefined =
this.keyToPCloudEntity[key];
const prevFileID: number | undefined = prevCachedEntity?.id;
@@ -522,6 +507,7 @@ export class FakeFsPCloud extends FakeFs {
});
const apiUrl = `https://${this.pCloudConfig.hostname}/uploadfile?${params}`;
if (content.byteLength > 0) {
const rsp = await fetch(apiUrl, {
method: "PUT",
body: content,
@@ -531,6 +517,41 @@ export class FakeFsPCloud extends FakeFs {
// 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> {
@@ -602,6 +623,6 @@ export class FakeFsPCloud extends FakeFs {
}
allowEmptyFile(): boolean {
return false;
return true;
}
}
+9953
View File
File diff suppressed because it is too large Load Diff
+35 -1
View File
@@ -22,6 +22,11 @@
"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!",
@@ -76,6 +81,17 @@
"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_clean": "Clean",
"modal_prorevokeauth_clean_desc": "Clean local auth record",
@@ -147,7 +163,6 @@
"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.",
@@ -166,10 +181,29 @@
"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_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.",
+40
View File
@@ -22,6 +22,11 @@
"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": "网址已复制!",
@@ -81,6 +86,22 @@
"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_clean": "清理",
"modal_prorevokeauth_clean_desc": "清理本地授权记录",
@@ -170,10 +191,29 @@
"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_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>第二部:点击“连接”按钮,从而连接本设备和在线账号。",
+40
View File
@@ -22,6 +22,11 @@
"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": "網址已複製!",
@@ -81,6 +86,22 @@
"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_clean": "清理",
"modal_prorevokeauth_clean_desc": "清理本地授權記錄",
@@ -170,10 +191,29 @@
"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_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>第二部:點選“連線”按鈕,從而連線本裝置和線上賬號。",
+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,
};
};
-14
View File
@@ -280,20 +280,6 @@ export const generatePCloudSettingsPart = (
});
});
new Setting(pCloudAllowedToUsedDiv)
.setName(t("settings_pcloud_emptyfile"))
.setDesc(t("settings_pcloud_emptyfile_desc"))
.addDropdown(async (dropdown) => {
dropdown
.addOption("skip", t("settings_pcloud_emptyfile_skip"))
.addOption("error", t("settings_pcloud_emptyfile_error"))
.setValue(plugin.settings.pcloud.emptyFile)
.onChange(async (val) => {
plugin.settings.pcloud.emptyFile = val as any;
await saveUpdatedConfigFunc();
});
});
new Setting(pCloudAllowedToUsedDiv)
.setName(t("settings_checkonnectivity"))
.setDesc(t("settings_checkonnectivity_desc"))
+18 -1
View File
@@ -255,7 +255,9 @@ export const generateProSettingsPart = (
pCloudAllowedToUsedDiv: HTMLDivElement,
pCloudNotShowUpHintSetting: Setting,
yandexDiskAllowedToUsedDiv: HTMLDivElement,
yandexDiskNotShowUpHintSetting: Setting
yandexDiskNotShowUpHintSetting: Setting,
koofrAllowedToUsedDiv: HTMLDivElement,
koofrNotShowUpHintSetting: Setting
) => {
proDiv
.createEl("h2", { text: t("settings_pro") })
@@ -372,6 +374,21 @@ export const generateProSettingsPart = (
);
}
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"));
});
});
+187 -64
View File
@@ -2,13 +2,6 @@
import AggregateError from "aggregate-error";
import PQueue from "p-queue";
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 {
ConflictActionType,
EmptyFolderCleanType,
@@ -18,21 +11,21 @@ import type {
SUPPORTED_SERVICES_TYPE,
SyncDirectionType,
SyncTriggerSourceType,
} from "./baseTypes";
import { copyFile, copyFileOrFolder, copyFolder } from "./copyLogic";
import type { FakeFs } from "./fsAll";
import type { FakeFsEncrypt } from "./fsEncrypt";
} from "../../src/baseTypes";
import { copyFile, copyFileOrFolder, copyFolder } from "../../src/copyLogic";
import type { FakeFs } from "../../src/fsAll";
import type { FakeFsEncrypt } from "../../src/fsEncrypt";
import {
type InternalDBs,
clearPrevSyncRecordByVaultAndProfile,
getAllPrevSyncRecordsByVaultAndProfile,
insertSyncPlanRecordByVault,
upsertPrevSyncRecordByVaultAndProfile,
} from "./localdb";
} from "../../src/localdb";
import {
DEFAULT_FILE_NAME_FOR_METADATAONREMOTE,
DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2,
} from "./metadataOnRemote";
} from "../../src/metadataOnRemote";
import {
atWhichLevel,
getParentFolder,
@@ -40,8 +33,15 @@ import {
isSpecialFolderNameToSkip,
roughSizeOfObject,
unixTimeToStr,
} from "./misc";
import type { Profiler } from "./profiler";
} from "../../src/misc";
import type { Profiler } from "../../src/profiler";
import { checkProRunnableAndFixInplace } from "./account";
import { duplicateFile, isMergable, mergeFile } from "./conflictLogic";
import {
clearFileContentHistoryByVaultAndProfile,
getFileContentHistoryByVaultAndProfile,
upsertFileContentHistoryByVaultAndProfile,
} from "./localdb";
const copyEntityAndFixTimeFormat = (
src: Entity,
@@ -291,7 +291,6 @@ const ensembleMixedEnties = async (
*/
const getSyncPlanInplace = async (
mixedEntityMappings: Record<string, MixedEntity>,
howToCleanEmptyFolder: EmptyFolderCleanType,
skipSizeLargerThan: number,
conflictAction: ConflictActionType,
syncDirection: SyncDirectionType,
@@ -336,7 +335,10 @@ const getSyncPlanInplace = async (
mixedEntry.decision = "folder_existed_both_then_do_nothing";
mixedEntry.change = false;
} 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.decision = "folder_to_skip";
mixedEntry.change = false;
@@ -347,7 +349,10 @@ const getSyncPlanInplace = async (
mixedEntry.change = true;
}
} 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.decision = "folder_to_skip";
mixedEntry.change = false;
@@ -365,57 +370,127 @@ const getSyncPlanInplace = async (
}
keptFolder.delete(key); // no need to save it in the Set later
} else {
if (howToCleanEmptyFolder === "skip") {
mixedEntry.decisionBranch = 105;
mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
} else if (howToCleanEmptyFolder === "clean_both") {
if (local !== undefined && remote !== undefined) {
if (syncDirection === "bidirectional") {
mixedEntry.decisionBranch = 106;
mixedEntry.decision = "folder_to_be_deleted_on_both";
mixedEntry.change = true;
} else {
// right now it does nothing because of "incremental"
// TODO: should we delete??
mixedEntry.decisionBranch = 109;
// both exist, do nothing
mixedEntry.decisionBranch = 121;
mixedEntry.decision = "folder_existed_both_then_do_nothing";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key));
} else if (local !== undefined && remote === undefined) {
if (prevSync !== undefined) {
// then the folder is deleted on remote
if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 122;
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.change = false;
}
} else if (local !== undefined && remote === undefined) {
if (syncDirection === "bidirectional") {
mixedEntry.decisionBranch = 110;
keptFolder.add(getParentFolder(key));
} else if (syncDirection === "incremental_pull_and_delete_only") {
mixedEntry.decisionBranch = 135;
mixedEntry.decision = "folder_to_be_deleted_on_local";
mixedEntry.change = true;
} else {
// right now it does nothing because of "incremental"
// TODO: should we delete??
mixedEntry.decisionBranch = 111;
// bidirectional
mixedEntry.decisionBranch = 124;
mixedEntry.decision = "folder_to_be_deleted_on_local";
mixedEntry.change = true;
}
} else {
// then the folder is created on local
if (
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 (syncDirection === "bidirectional") {
mixedEntry.decisionBranch = 112;
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 {
// right now it does nothing because of "incremental"
// TODO: should we delete??
mixedEntry.decisionBranch = 113;
} 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 {
// no folder to delete, do nothing
mixedEntry.decisionBranch = 114;
// 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 {
throw Error(
`do not know how to deal with empty folder ${mixedEntry.key}`
);
// local === undefined && remote === undefined
// no folder to delete or create, do nothing
mixedEntry.decisionBranch = 134;
mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
}
}
} else {
@@ -454,7 +529,10 @@ const getSyncPlanInplace = async (
skipSizeLargerThan <= 0 ||
remote.sizeEnc! <= skipSizeLargerThan
) {
if (syncDirection === "incremental_push_only") {
if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 26;
mixedEntry.decision = "conflict_modified_then_keep_local";
mixedEntry.change = true;
@@ -478,7 +556,10 @@ const getSyncPlanInplace = async (
skipSizeLargerThan <= 0 ||
local.sizeEnc! <= skipSizeLargerThan
) {
if (syncDirection === "incremental_pull_only") {
if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 27;
mixedEntry.decision = "conflict_modified_then_keep_remote";
mixedEntry.change = true;
@@ -535,12 +616,18 @@ const getSyncPlanInplace = async (
mixedEntry.change = true;
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.decision = "conflict_created_then_keep_remote";
mixedEntry.change = true;
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.decision = "conflict_created_then_keep_local";
mixedEntry.change = true;
@@ -587,12 +674,18 @@ const getSyncPlanInplace = async (
mixedEntry.change = true;
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.decision = "conflict_modified_then_keep_remote";
mixedEntry.change = true;
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.decision = "conflict_modified_then_keep_local";
mixedEntry.change = true;
@@ -621,7 +714,10 @@ const getSyncPlanInplace = async (
skipSizeLargerThan <= 0 ||
remote.sizeEnc! <= skipSizeLargerThan
) {
if (syncDirection === "incremental_push_only") {
if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 28;
mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false;
@@ -649,7 +745,14 @@ const getSyncPlanInplace = async (
mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false;
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.decision = "conflict_created_then_keep_remote";
mixedEntry.change = true;
@@ -665,7 +768,10 @@ const getSyncPlanInplace = async (
skipSizeLargerThan <= 0 ||
remote.sizeEnc! <= skipSizeLargerThan
) {
if (syncDirection === "incremental_push_only") {
if (
syncDirection === "incremental_push_only" ||
syncDirection === "incremental_push_and_delete_only"
) {
mixedEntry.decisionBranch = 30;
mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false;
@@ -690,7 +796,10 @@ const getSyncPlanInplace = async (
if (prevSync === undefined) {
// if A is not in the previous list, A is new
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.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false;
@@ -713,7 +822,10 @@ const getSyncPlanInplace = async (
prevSync.sizeEnc === local.sizeEnc
) {
// 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.decision = "conflict_created_then_keep_local";
mixedEntry.change = true;
@@ -721,6 +833,10 @@ const getSyncPlanInplace = async (
mixedEntry.decisionBranch = 33;
mixedEntry.decision = "conflict_created_then_do_nothing";
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 {
mixedEntry.decisionBranch = 7;
mixedEntry.decision = "remote_is_deleted_thus_also_delete_local";
@@ -729,7 +845,10 @@ const getSyncPlanInplace = async (
} else {
// 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 (syncDirection === "incremental_pull_only") {
if (
syncDirection === "incremental_pull_only" ||
syncDirection === "incremental_pull_and_delete_only"
) {
mixedEntry.decisionBranch = 34;
mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false;
@@ -783,7 +902,7 @@ const getSyncPlanInplace = async (
mixedEntityMappings["/$@meta"] = {
key: "/$@meta", // don't mess up with the types
sideNotes: {
version: "20240525 fs version",
version: "20240616 fs version",
generateTime: currTime,
generateTimeFmt: currTimeFmt,
service: settings.serviceType,
@@ -1172,7 +1291,7 @@ const dispatchOperationToActualV3 = async (
r.key
);
if (conflictAction === "smart_conflict") {
if (isMergable(r.remote!)) {
if (isMergable(r.local!)) {
await clearFileContentHistoryByVaultAndProfile(
db,
vaultRandomID,
@@ -1298,6 +1417,7 @@ export const doActualSync = async (
db: InternalDBs,
profiler: Profiler | undefined,
conflictAction: ConflictActionType,
triggerSource: SyncTriggerSourceType,
callbackSyncProcess?: any
) => {
profiler?.addIndent();
@@ -1405,13 +1525,16 @@ export const doActualSync = async (
// );
await callbackSyncProcess?.(
triggerSource,
realCounter,
realTotalCount,
key,
val.decision
);
if (val.change === undefined || val.change) {
realCounter += 1;
}
await dispatchOperationToActualV3(
key,
@@ -1584,7 +1707,6 @@ export async function syncer(
mixedEntityMappings = await getSyncPlanInplace(
mixedEntityMappings,
settings.howToCleanEmptyFolder ?? "clean_both",
settings.skipSizeLargerThan ?? -1,
settings.conflictAction ?? "keep_newer",
settings.syncDirection ?? "bidirectional",
@@ -1625,6 +1747,7 @@ export async function syncer(
db,
profiler,
settings.conflictAction ?? "keep_newer",
triggerSource,
callbackSyncProcess
);
profiler?.insert(`finish step${step} (actual sync)`);
+17 -5
View File
@@ -6,6 +6,7 @@
import type {
BoxConfig,
GoogleDriveConfig,
KoofrConfig,
PCloudConfig,
ProConfig,
YandexDiskConfig,
@@ -23,7 +24,8 @@ export type SUPPORTED_SERVICES_TYPE =
| "googledrive"
| "box"
| "pcloud"
| "yandexdisk";
| "yandexdisk"
| "koofr";
export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR =
| "webdav"
@@ -33,7 +35,8 @@ export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR =
| "googledrive"
| "box"
| "pcloud"
| "yandexdisk";
| "yandexdisk"
| "koofr";
export interface S3Config {
s3Endpoint: string;
@@ -117,7 +120,9 @@ export interface WebdisConfig {
export type SyncDirectionType =
| "bidirectional"
| "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";
@@ -131,7 +136,8 @@ export type QRExportType =
| "googledrive"
| "box"
| "pcloud"
| "yandexdisk";
| "yandexdisk"
| "koofr";
export interface ProfilerConfig {
enablePrinting?: boolean;
@@ -148,6 +154,8 @@ export interface RemotelySavePluginSettings {
box: BoxConfig;
pcloud: PCloudConfig;
yandexdisk: YandexDiskConfig;
koofr: KoofrConfig;
password: string;
serviceType: SUPPORTED_SERVICES_TYPE;
currLogLevel?: string;
@@ -165,7 +173,6 @@ export interface RemotelySavePluginSettings {
enableStatusBarInfo?: boolean;
deleteToWhere?: "system" | "obsidian";
conflictAction?: ConflictActionType;
howToCleanEmptyFolder?: EmptyFolderCleanType;
protectModifyPercentage?: number;
syncDirection?: SyncDirectionType;
@@ -194,6 +201,11 @@ export interface RemotelySavePluginSettings {
* @deprecated
*/
logToDB?: boolean;
/**
* @deprecated
*/
howToCleanEmptyFolder?: EmptyFolderCleanType;
}
export const COMMAND_URI = "remotely-save";
+1 -1
View File
@@ -1,5 +1,6 @@
import type { Vault } from "obsidian";
import type { SyncPlanType } from "../pro/src/sync";
import {
DEFAULT_DEBUG_FOLDER,
DEFAULT_PROFILER_RESULT_FILE_PREFIX,
@@ -11,7 +12,6 @@ import {
} from "./localdb";
import type { InternalDBs } from "./localdb";
import { mkdirpInVault } from "./misc";
import type { SyncPlanType } from "./sync";
const getSubsetOfSyncPlan = (x: string, onlyChange: boolean) => {
if (!onlyChange) {
+5 -1
View File
@@ -1,7 +1,7 @@
import type { CipherMethodType, Entity } from "./baseTypes";
import * as openssl from "./encryptOpenSSL";
import * as rclone from "./encryptRClone";
import { isVaildText } from "./misc";
import { isSpecialFolderNameToSkip, isVaildText } from "./misc";
import cloneDeep from "lodash/cloneDeep";
import { FakeFs } from "./fsAll";
@@ -189,6 +189,10 @@ export class FakeFsEncrypt extends FakeFs {
return res;
} else {
for (const innerEntity of innerWalkResult) {
if (isSpecialFolderNameToSkip(innerEntity.keyRaw, [])) {
continue;
}
const key = await this._decryptName(innerEntity.keyRaw);
const size = key.endsWith("/") ? 0 : undefined;
res.push({
+3
View File
@@ -1,5 +1,6 @@
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";
@@ -65,6 +66,8 @@ export function getClient(
vaultName,
saveUpdatedConfigFunc
);
case "koofr":
return new FakeFsKoofr(settings.koofr, vaultName, saveUpdatedConfigFunc);
default:
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) {
let r: Entity | undefined = undefined;
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
continue;
} else if (entry instanceof TFile) {
@@ -61,15 +66,15 @@ export class FakeFsLocal extends FakeFs {
);
}
r = {
key: entry.path, // local always unencrypted
keyRaw: entry.path,
key: key, // local always unencrypted
keyRaw: key,
mtimeCli: mtimeLocal,
mtimeSvr: mtimeLocal,
size: entry.stat.size, // local always unencrypted
sizeRaw: entry.stat.size,
};
} else if (entry instanceof TFolder) {
key = `${entry.path}/`;
key = `${key}/`;
r = {
key: key,
keyRaw: key,
+5 -2
View File
@@ -913,7 +913,8 @@ export class FakeFsOnedrive extends FakeFs {
`${key}?$select=@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 = (
await requestUrl({
url: downloadUrl,
@@ -923,7 +924,9 @@ export class FakeFsOnedrive extends FakeFs {
return content;
} else {
// 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;
}
}
+3
View File
@@ -28,6 +28,7 @@ export const exportQrCodeUri = async (
delete settings2.box;
delete settings2.pcloud;
delete settings2.yandexdisk;
delete settings2.koofr;
delete settings2.pro;
} else if (exportFields === "s3") {
settings2 = { s3: cloneDeep(settings.s3) };
@@ -47,6 +48,8 @@ export const exportQrCodeUri = async (
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;
+25 -15
View File
@@ -45,20 +45,26 @@
"command_exportlogsindb": "export logs saved in db",
"statusbar_time_years": "Synced {{time}} years ago",
"statusbar_time_months": "Synced {{time}} months ago",
"statusbar_time_weeks": "Synced {{time}} weeks ago",
"statusbar_time_days": "Synced {{time}} days ago",
"statusbar_time_hours": "Synced {{time}} hours ago",
"statusbar_time_minutes": "Synced {{time}} minutes ago",
"statusbar_time_lessminute": "Synced last minute ago",
"statusbar_lastsync": "Synced {{time}} ago",
"statusbar_sync_source_manual": "Manual: ",
"statusbar_sync_source_dry": "Dry: ",
"statusbar_sync_source_auto": "Auto: ",
"statusbar_sync_source_auto_once_init": "Auto (init): ",
"statusbar_sync_source_auto_sync_on_save": "Auto (save): ",
"statusbar_sync_status_prefix_success": "Successfully synced ",
"statusbar_sync_status_prefix_failed": "Failed to sync ",
"statusbar_time_years": "{{time}} years ago",
"statusbar_time_months": "{{time}} months ago",
"statusbar_time_weeks": "{{time}} weeks ago",
"statusbar_time_days": "{{time}} days ago",
"statusbar_time_hours": "{{time}} hours ago",
"statusbar_time_minutes": "{{time}} minutes ago",
"statusbar_time_lessminute": "last minute ago",
"statusbar_time_now": "just now",
"statusbar_syncing": "Syncing...",
"statusbar_failed": "Last sync failed",
"statusbar_now": "Synced just now",
"statusbar_lastsync_label": "Last successful Sync on {{date}}",
"statusbar_lastsync_label": "on {{date}}",
"statusbar_lastsync_never": "Never Synced",
"statusbar_lastsync_never_label": "Never Synced before",
"modal_password_title": "Hold on and PLEASE READ ON...",
"modal_password_shortdesc": "If the field is not empty, files would be encrypted locally before being uploaded.\nIf the field is empty, then files would be uploaded without encryption.",
"modal_password_attn1": "Attention 1/5: The vault name is NOT encrypted. The plugin creates a folder with the vault name on some remote services.",
@@ -292,11 +298,15 @@
"settings_protectmodifypercentage_custom_desc": "custom",
"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.",
"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_incremental_push_only_desc": "Incremental Push Only (aka backup mode)",
"setting_syncdirection_incremental_pull_only_desc": "Incremental Pull Only",
"setting_syncdirection_incremental_push_only_desc": "Incremental Push (aka backup mode)",
"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_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",
+25 -15
View File
@@ -45,20 +45,26 @@
"command_exportsyncplans_all": "导出同步计划(所有)(export sync plans (all)",
"command_exportlogsindb": "从数据库导出终端日志(export logs saved in db",
"statusbar_time_years": "{{time}} 年前同步",
"statusbar_time_months": "{{time}} 月前同步",
"statusbar_time_weeks": "{{time}} 周前同步",
"statusbar_time_days": "{{time}} 天前同步",
"statusbar_time_hours": "{{time}} 小时前同步",
"statusbar_time_minutes": "{{time}} 分钟前同步",
"statusbar_time_lessminute": "一分钟之内同步",
"statusbar_lastsync": "上一次同步于:{{time}}",
"statusbar_sync_source_manual": "手动:",
"statusbar_sync_source_dry": "空跑:",
"statusbar_sync_source_auto": "自动:",
"statusbar_sync_source_auto_once_init": "启动时自动:",
"statusbar_sync_source_auto_sync_on_save": "保存时自动:",
"statusbar_sync_status_prefix_success": "同步成功:",
"statusbar_sync_status_prefix_failed": "同步失败:",
"statusbar_time_years": "{{time}} 年前",
"statusbar_time_months": "{{time}} 月前",
"statusbar_time_weeks": "{{time}} 周前",
"statusbar_time_days": "{{time}} 天前",
"statusbar_time_hours": "{{time}} 小时前",
"statusbar_time_minutes": "{{time}} 分钟前",
"statusbar_time_lessminute": "一分钟之内",
"statusbar_time_now": "刚刚",
"statusbar_syncing": "正在同步",
"statusbar_failed": "上次同步失败了",
"statusbar_now": "刚同步完",
"statusbar_lastsync_label": "上一次同步于:{{date}}",
"statusbar_lastsync_label": "日期:{{date}}",
"statusbar_lastsync_never": "没触发过同步",
"statusbar_lastsync_never_label": "没触发过同步",
"modal_password_title": "稍等一下,请阅读下文:",
"modal_password_shortdesc": "如果密码不是空的,那么文件会在上传之前,在本地先用此密码加密。\n如果密码是空的,那么文件会被非加密地上传。",
"modal_password_attn1": "注意 1/5:库(Vault)名字是不会加密的!本插件会在一些远程存储里创建一个和库名字有着同名的文件夹。",
@@ -291,11 +297,15 @@
"settings_protectmodifypercentage_custom_desc": "自定义",
"settings_protectmodifypercentage_customfield": "如果修改超过自定义百分比则中止同步",
"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_incremental_push_only_desc": "增量推送(也即:备份模式)",
"setting_syncdirection_incremental_pull_only_desc": "增量拉取",
"setting_syncdirection_incremental_push_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_desc": "Obsidian 手机版默认隐藏了状态栏。有些用户希望展示它。这里提供了设置选项。",
"settings_importexport": "导入导出部分设置",
+25 -15
View File
@@ -44,20 +44,26 @@
"command_exportsyncplans_all": "匯出同步計劃(所有)(export sync plans (all)",
"command_exportlogsindb": "從資料庫匯出終端日誌(export logs saved in db",
"statusbar_time_years": "{{time}} 年前同步",
"statusbar_time_months": "{{time}} 月前同步",
"statusbar_time_weeks": "{{time}} 周前同步",
"statusbar_time_days": "{{time}} 天前同步",
"statusbar_time_hours": "{{time}} 小時前同步",
"statusbar_time_minutes": "{{time}} 分鐘前同步",
"statusbar_time_lessminute": "一分鐘之內同步",
"statusbar_lastsync": "上一次同步於:{{time}}",
"statusbar_sync_source_manual": "手動:",
"statusbar_sync_source_dry": "空跑:",
"statusbar_sync_source_auto": "自動:",
"statusbar_sync_source_auto_once_init": "啟動時自動:",
"statusbar_sync_source_auto_sync_on_save": "儲存時自動:",
"statusbar_sync_status_prefix_success": "同步成功:",
"statusbar_sync_status_prefix_failed": "同步失敗:",
"statusbar_time_years": "{{time}} 年前",
"statusbar_time_months": "{{time}} 月前",
"statusbar_time_weeks": "{{time}} 周前",
"statusbar_time_days": "{{time}} 天前",
"statusbar_time_hours": "{{time}} 小時前",
"statusbar_time_minutes": "{{time}} 分鐘前",
"statusbar_time_lessminute": "一分鐘之內",
"statusbar_time_now": "剛剛",
"statusbar_syncing": "正在同步",
"statusbar_failed": "上次同步失敗了",
"statusbar_now": "剛同步完",
"statusbar_lastsync_label": "上一次同步於:{{date}}",
"statusbar_lastsync_label": "日期:{{date}}",
"statusbar_lastsync_never": "沒觸發過同步",
"statusbar_lastsync_never_label": "沒觸發過同步",
"modal_password_title": "稍等一下,請閱讀下文:",
"modal_password_shortdesc": "如果密碼不是空的,那麼檔案會在上傳之前,在本地先用此密碼加密。\n如果密碼是空的,那麼檔案會被非加密地上傳。",
"modal_password_attn1": "注意 1/5:儲存庫(Vault)名字是不會加密的!本外掛會在一些遠端儲存裡建立一個和庫名字有著同名的資料夾。",
@@ -290,11 +296,15 @@
"settings_protectmodifypercentage_custom_desc": "自定義",
"settings_protectmodifypercentage_customfield": "如果修改超過自定義百分比則中止同步",
"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_incremental_push_only_desc": "增量推送(也即:備份模式)",
"setting_syncdirection_incremental_pull_only_desc": "增量拉取",
"setting_syncdirection_incremental_push_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_desc": "Obsidian 手機版預設隱藏了狀態列。有些使用者希望展示它。這裡提供了設定選項。",
"settings_importexport": "匯入匯出部分設定",
+22 -2
View File
@@ -6,9 +6,9 @@ ep2(localforage);
export type LocalForage = typeof localforage;
import { nanoid } from "nanoid";
import type { SyncPlanType } from "../pro/src/sync";
import type { Entity, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
import { unixTimeToStr } from "./misc";
import type { SyncPlanType } from "./sync";
const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108, 20220326, 20240220];
export const DEFAULT_DB_VERSION_NUMBER: number = 20240220;
@@ -519,7 +519,27 @@ export const getLastSuccessSyncTimeByVault = async (
) => {
return (await db.simpleKVForMiscTbl.getItem(
`${vaultRandomID}-lastSuccessSyncMillis`
)) as number;
)) as number | null | undefined;
};
export const upsertLastFailedSyncTimeByVault = async (
db: InternalDBs,
vaultRandomID: string,
millis: number
) => {
await db.simpleKVForMiscTbl.setItem(
`${vaultRandomID}-lastFailedSyncMillis`,
millis
);
};
export const getLastFailedSyncTimeByVault = async (
db: InternalDBs,
vaultRandomID: string
) => {
return (await db.simpleKVForMiscTbl.getItem(
`${vaultRandomID}-lastFailedSyncMillis`
)) as number | null | undefined;
};
export const upsertPluginVersionByVault = async (
+181 -35
View File
@@ -25,6 +25,7 @@ import {
} from "../pro/src/account";
import {
COMMAND_CALLBACK_BOX,
COMMAND_CALLBACK_KOOFR,
COMMAND_CALLBACK_PCLOUD,
COMMAND_CALLBACK_PRO,
COMMAND_CALLBACK_YANDEXDISK,
@@ -36,6 +37,11 @@ import {
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,
@@ -48,6 +54,7 @@ import {
sendAuthReq as sendAuthReqYandexDisk,
setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplaceYandexDisk,
} from "../pro/src/fsYandexDisk";
import { syncer } from "../pro/src/sync";
import type {
RemotelySavePluginSettings,
SyncTriggerSourceType,
@@ -85,15 +92,16 @@ import {
type InternalDBs,
clearAllLoggerOutputRecords,
clearExpiredSyncPlanRecords,
getLastFailedSyncTimeByVault,
getLastSuccessSyncTimeByVault,
prepareDBs,
upsertLastFailedSyncTimeByVault,
upsertLastSuccessSyncTimeByVault,
upsertPluginVersionByVault,
} from "./localdb";
import { changeMobileStatusBar } from "./misc";
import { DEFAULT_PROFILER_CONFIG, type Profiler } from "./profiler";
import { RemotelySaveSettingTab } from "./settings";
import { syncer } from "./sync";
import { SyncAlgoV3Modal } from "./syncAlgoV3Notice";
const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
@@ -106,6 +114,7 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
box: DEFAULT_BOX_CONFIG,
pcloud: DEFAULT_PCLOUD_CONFIG,
yandexdisk: DEFAULT_YANDEXDISK_CONFIG,
koofr: DEFAULT_KOOFR_CONFIG,
password: "",
serviceType: "s3",
currLogLevel: "info",
@@ -169,6 +178,29 @@ const getIconSvg = () => {
return res;
};
const getStatusBarShortMsgFromSyncSource = (
t: (x: TransItemType, vars?: any) => string,
s: SyncTriggerSourceType | undefined
) => {
if (s === undefined) {
return "";
}
switch (s) {
case "manual":
return t("statusbar_sync_source_manual");
case "dry":
return t("statusbar_sync_source_dry");
case "auto":
return t("statusbar_sync_source_auto");
case "auto_once_init":
return t("statusbar_sync_source_auto_once_init");
case "auto_sync_on_save":
return t("statusbar_sync_source_auto_sync_on_save");
default:
throw Error(`no translate for ${s}`);
}
};
export default class RemotelySavePlugin extends Plugin {
settings!: RemotelySavePluginSettings;
db!: InternalDBs;
@@ -386,17 +418,15 @@ export default class RemotelySavePlugin extends Plugin {
) => {
if (step === 1) {
// change status to "syncing..." on statusbar
this.updateLastSuccessSyncMsg(-1);
this.updateLastSyncMsg(s, -1, -1);
} else if (step === 8 && everythingOk) {
const lastSuccessSyncMillis = Date.now();
await upsertLastSuccessSyncTimeByVault(
this.db,
this.vaultRandomID,
lastSuccessSyncMillis
);
this.updateLastSuccessSyncMsg(lastSuccessSyncMillis);
const ts = Date.now();
await upsertLastSuccessSyncTimeByVault(this.db, this.vaultRandomID, ts);
this.updateLastSyncMsg(s, ts, null);
} else if (!everythingOk) {
this.updateLastSuccessSyncMsg(-2); // magic number
const ts = Date.now();
await upsertLastFailedSyncTimeByVault(this.db, this.vaultRandomID, ts);
this.updateLastSyncMsg(s, null, ts); // magic number
}
};
@@ -405,12 +435,15 @@ export default class RemotelySavePlugin extends Plugin {
};
const callbackSyncProcess = async (
s: SyncTriggerSourceType,
realCounter: number,
realTotalCount: number,
pathName: string,
decision: string
) => {
this.setCurrSyncMsg(
t,
s,
realCounter,
realTotalCount,
pathName,
@@ -977,6 +1010,64 @@ export default class RemotelySavePlugin extends Plugin {
}
);
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(
iconNameSyncWait,
`${this.manifest.name}`,
@@ -995,15 +1086,21 @@ export default class RemotelySavePlugin extends Plugin {
this.statusBarElement = statusBarItem.createEl("span");
this.statusBarElement.setAttribute("data-tooltip-position", "top");
this.updateLastSuccessSyncMsg(
await getLastSuccessSyncTimeByVault(this.db, this.vaultRandomID)
this.updateLastSyncMsg(
undefined,
await getLastSuccessSyncTimeByVault(this.db, this.vaultRandomID),
await getLastFailedSyncTimeByVault(this.db, this.vaultRandomID)
);
// update statusbar text every 30 seconds
this.registerInterval(
window.setInterval(async () => {
this.updateLastSuccessSyncMsg(
await getLastSuccessSyncTimeByVault(this.db, this.vaultRandomID)
if (!this.isSyncing) {
this.updateLastSyncMsg(
undefined,
await getLastSuccessSyncTimeByVault(this.db, this.vaultRandomID),
await getLastFailedSyncTimeByVault(this.db, this.vaultRandomID)
);
}
}, 1000 * 30)
);
}
@@ -1275,6 +1372,10 @@ export default class RemotelySavePlugin extends Plugin {
this.settings.yandexdisk = DEFAULT_YANDEXDISK_CONFIG;
}
if (this.settings.koofr === undefined) {
this.settings.koofr = DEFAULT_KOOFR_CONFIG;
}
await this.saveSettings();
}
@@ -1383,6 +1484,16 @@ export default class RemotelySavePlugin extends Plugin {
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) {
this.settings.pro = cloneDeep(DEFAULT_PRO_CONFIG);
}
@@ -1429,6 +1540,12 @@ export default class RemotelySavePlugin extends Plugin {
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
);
}
}
async getVaultRandomIDFromOldConfigFile() {
@@ -1533,7 +1650,8 @@ export default class RemotelySavePlugin extends Plugin {
if (
caller === "SYNC" ||
(caller === "FILE_CHANGES" && lastModified > lastSuccessSyncMillis)
(caller === "FILE_CHANGES" &&
lastModified > (lastSuccessSyncMillis ?? 1))
) {
console.debug(
`so lastModified > lastSuccessSyncMillis or it's called while syncing before`
@@ -1589,12 +1707,14 @@ export default class RemotelySavePlugin extends Plugin {
this.registerEvent(this.app.vault.on("modify", 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("rename", this._syncOnSaveEvent2));
});
} else {
this.syncEvent?.off("SYNC_DONE", this._syncOnSaveEvent1);
this.app.vault.off("modify", this._syncOnSaveEvent2);
this.app.vault.off("create", this._syncOnSaveEvent2);
this.app.vault.off("delete", this._syncOnSaveEvent2);
this.app.vault.off("rename", this._syncOnSaveEvent2);
}
}
@@ -1647,17 +1767,34 @@ export default class RemotelySavePlugin extends Plugin {
}
setCurrSyncMsg(
t: (x: TransItemType, vars?: any) => string,
s: SyncTriggerSourceType,
i: number,
totalCount: number,
pathName: string,
decision: string,
triggerSource: SyncTriggerSourceType
) {
const msg = `syncing progress=${i}/${totalCount},decision=${decision},path=${pathName},source=${triggerSource}`;
this.currSyncMsg = msg;
const L = `${totalCount}`.length;
const iStr = `${i}`.padStart(L, "0");
const prefix = getStatusBarShortMsgFromSyncSource(t, s);
const shortMsg = prefix + `Syncing ${iStr}/${totalCount}`;
const longMsg =
prefix +
`Syncing progress=${iStr}/${totalCount},decision=${decision},path=${pathName},source=${triggerSource}`;
this.currSyncMsg = longMsg;
if (this.statusBarElement !== undefined) {
this.statusBarElement.setText(shortMsg);
this.statusBarElement.setAttribute("aria-label", longMsg);
}
}
updateLastSuccessSyncMsg(lastSuccessSyncMillis?: number) {
updateLastSyncMsg(
s: SyncTriggerSourceType | undefined,
lastSuccessSyncMillis: number | null | undefined,
lastFailedSyncMillis: number | null | undefined
) {
if (this.statusBarElement === undefined) return;
const t = (x: TransItemType, vars?: any) => {
@@ -1667,18 +1804,27 @@ export default class RemotelySavePlugin extends Plugin {
let lastSyncMsg = t("statusbar_lastsync_never");
let lastSyncLabelMsg = t("statusbar_lastsync_never_label");
if (lastSuccessSyncMillis !== undefined && lastSuccessSyncMillis === -1) {
lastSyncMsg = t("statusbar_syncing");
const inputTs = Math.max(
lastSuccessSyncMillis ?? -999,
lastFailedSyncMillis ?? -999
);
const isSuccess =
(lastSuccessSyncMillis ?? -999) >= (lastFailedSyncMillis ?? -999);
if (lastSuccessSyncMillis === -1) {
// magic number
// otherwise how can we know we are syncing??
lastSyncMsg =
getStatusBarShortMsgFromSyncSource(t, s!) + t("statusbar_syncing");
} else if (inputTs > 0) {
let prefix = "";
if (isSuccess) {
prefix = t("statusbar_sync_status_prefix_success");
} else {
prefix = t("statusbar_sync_status_prefix_failed");
}
if (lastSuccessSyncMillis !== undefined && lastSuccessSyncMillis === -2) {
lastSyncMsg = t("statusbar_failed");
lastSyncLabelMsg = t("statusbar_failed");
}
if (lastSuccessSyncMillis !== undefined && lastSuccessSyncMillis > 0) {
const deltaTime = Date.now() - lastSuccessSyncMillis;
const deltaTime = Date.now() - inputTs;
// create human readable time
const years = Math.floor(deltaTime / 31556952000);
const months = Math.floor(deltaTime / 2629746000);
@@ -1687,9 +1833,7 @@ export default class RemotelySavePlugin extends Plugin {
const hours = Math.floor(deltaTime / 3600000);
const minutes = Math.floor(deltaTime / 60000);
const seconds = Math.floor(deltaTime / 1000);
let timeText = "";
if (years > 0) {
timeText = t("statusbar_time_years", { time: years });
} else if (months > 0) {
@@ -1705,10 +1849,9 @@ export default class RemotelySavePlugin extends Plugin {
} else if (seconds > 30) {
timeText = t("statusbar_time_lessminute");
} else {
timeText = t("statusbar_now");
timeText = t("statusbar_time_now");
}
const dateText = new Date(lastSuccessSyncMillis).toLocaleTimeString(
const dateText = new Date(inputTs).toLocaleTimeString(
navigator.language,
{
weekday: "long",
@@ -1718,8 +1861,11 @@ export default class RemotelySavePlugin extends Plugin {
}
);
lastSyncMsg = timeText;
lastSyncLabelMsg = t("statusbar_lastsync_label", { date: dateText });
lastSyncMsg = prefix + timeText;
lastSyncLabelMsg =
prefix + t("statusbar_lastsync_label", { date: dateText });
} else {
// TODO: no idea what happened.
}
this.statusBarElement.setText(lastSyncMsg);
+74 -25
View File
@@ -23,6 +23,7 @@ import type {
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 { generateYandexDiskSettingsPart } from "../pro/src/settingsYandexDisk";
@@ -54,6 +55,7 @@ import {
clearAllPrevSyncRecordByVault,
clearAllSyncPlanRecords,
destroyDBs,
upsertLastFailedSyncTimeByVault,
upsertLastSuccessSyncTimeByVault,
} from "./localdb";
import type RemotelySavePlugin from "./main"; // unavoidable
@@ -67,10 +69,17 @@ import { DEFAULT_PROFILER_CONFIG } from "./profiler";
class PasswordModal extends Modal {
plugin: RemotelySavePlugin;
newPassword: string;
constructor(app: App, plugin: RemotelySavePlugin, newPassword: string) {
encryptionMethodSetting: Setting;
constructor(
app: App,
plugin: RemotelySavePlugin,
newPassword: string,
encryptionMethodSetting: Setting
) {
super(app);
this.plugin = plugin;
this.newPassword = newPassword;
this.encryptionMethodSetting = encryptionMethodSetting;
}
onOpen() {
@@ -114,6 +123,16 @@ class PasswordModal extends Modal {
button.setButtonText(t("modal_password_secondconfirm"));
button.onClick(async () => {
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();
new Notice(t("modal_password_notice"));
this.close();
@@ -1845,6 +1864,15 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
() => 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)
//////////////////////////////////////////////////
@@ -1870,6 +1898,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
"yandexdisk",
t("settings_chooseservice_yandexdisk")
);
// dropdown.addOption("koofr", t("settings_chooseservice_koofr"));
dropdown
.setValue(this.plugin.settings.serviceType)
@@ -1911,6 +1940,10 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
"yandexdisk-hide",
this.plugin.settings.serviceType !== "yandexdisk"
);
koofrDiv.toggleClass(
"koofr-hide",
this.plugin.settings.serviceType !== "koofr"
);
await this.plugin.saveSettings();
});
});
@@ -1922,8 +1955,11 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
const basicDiv = containerEl.createEl("div");
basicDiv.createEl("h2", { text: t("settings_basic") });
const passwordSetting = new Setting(basicDiv);
const encryptionMethodSetting = new Setting(basicDiv);
let newPassword = `${this.plugin.settings.password}`;
new Setting(basicDiv)
passwordSetting
.setName(t("settings_password"))
.setDesc(t("settings_password_desc"))
.addText((text) => {
@@ -1938,11 +1974,21 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
.addButton(async (button) => {
button.setButtonText(t("confirm"));
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"))
.setDesc(stringToFragment(t("settings_encryptionmethod_desc")))
.addDropdown((dropdown) => {
@@ -2089,7 +2135,12 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
this.plugin.vaultRandomID,
-1
);
this.plugin.updateLastSuccessSyncMsg(-1);
await upsertLastFailedSyncTimeByVault(
this.plugin.db,
this.plugin.vaultRandomID,
-1
);
this.plugin.updateLastSyncMsg(undefined, null, null);
new Notice(t("settings_resetstatusbar_notice"));
});
});
@@ -2250,24 +2301,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)
.setName(t("settings_protectmodifypercentage"))
.setDesc(t("settings_protectmodifypercentage_desc"));
@@ -2342,7 +2375,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
new Setting(advDiv)
.setName(t("setting_syncdirection"))
.setDesc(t("setting_syncdirection_desc"))
.setDesc(stringToFragment(t("setting_syncdirection_desc")))
.addDropdown((dropdown) => {
dropdown.addOption(
"bidirectional",
@@ -2356,6 +2389,14 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
"incremental_pull_only",
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
.setValue(this.plugin.settings.syncDirection ?? "bidirectional")
@@ -2495,6 +2536,12 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
"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 = "";
@@ -2567,7 +2614,9 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
pCloudAllowedToUsedDiv,
pCloudNotShowUpHintSetting,
yandexDiskAllowedToUsedDiv,
yandexDiskNotShowUpHintSetting
yandexDiskNotShowUpHintSetting,
koofrAllowedToUsedDiv,
koofrNotShowUpHintSetting
);
//////////////////////////////////////////////////
+23
View File
@@ -21,6 +21,10 @@
display: none;
}
.settings-encryption-method-hide {
display: none;
}
.s3-disclaimer {
font-weight: bold;
}
@@ -148,6 +152,25 @@
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 {
width: 350px;
height: 350px;
+3
View File
@@ -31,6 +31,9 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
yandexdisk: {
refreshToken: "xxx",
} as any,
koofr: {
refreshToken: "xxx",
} as any,
password: "password",
serviceType: "s3",
currLogLevel: "info",
+4
View File
@@ -18,6 +18,8 @@ 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 = {
entry: "./src/main.ts",
@@ -42,6 +44,8 @@ module.exports = {
"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:
// https://github.com/webpack/changelog-v5/issues/10