Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
48e5601a52 | ||
|
|
054a9a3c01 | ||
|
|
66dcaf4e4c | ||
|
|
6d29554033 | ||
|
|
4ed0d735a2 | ||
|
|
26dff02daa | ||
|
|
1b1083d746 | ||
|
|
6db005018d | ||
|
|
8d25ddb636 | ||
|
|
b0d41478a3 | ||
|
|
f69adf273a | ||
|
|
4b4a9b0989 | ||
|
|
bfe11f44dc | ||
|
|
d25303cfac | ||
|
|
ebd62b1581 | ||
|
|
13537d1481 | ||
|
|
6fce079481 | ||
|
|
baf4e6b369 | ||
|
|
dd39e229d8 | ||
|
|
ba6e8be304 | ||
|
|
cb7a372b69 | ||
|
|
9a4dd0186d | ||
|
|
f9cdf323b8 | ||
|
|
474216b9ab | ||
|
|
99f143115b | ||
|
|
39940deb3f | ||
|
|
df53ea957f | ||
|
|
0cf8023278 | ||
|
|
be1386b345 | ||
|
|
9a189d63c9 | ||
|
|
00d0c557df | ||
|
|
a70a53eeec | ||
|
|
8cec2b00eb | ||
|
|
6efe52b26e | ||
|
|
d4ee07306d | ||
|
|
303f47f7c1 | ||
|
|
8270a02246 | ||
|
|
4686d911f4 | ||
|
|
e704199da0 | ||
|
|
5a4e8e51a1 | ||
|
|
6f339583c1 | ||
|
|
f042e31643 | ||
|
|
bb21714b45 | ||
|
|
b3c107ce58 | ||
|
|
b39544b43b | ||
|
|
b8c4a2bd9a | ||
|
|
c1c50cd479 | ||
|
|
41073d1576 | ||
|
|
429063ebd1 | ||
|
|
e06b52d2f5 | ||
|
|
89f2ac035c | ||
|
|
bd3e4e91e6 | ||
|
|
e03522efe4 | ||
|
|
39a33243e8 | ||
|
|
79d00f28cc | ||
|
|
72c92018d5 | ||
|
|
510f0c2081 | ||
|
|
953507ec43 | ||
|
|
714ea43613 | ||
|
|
1013daa9fd | ||
|
|
b13bd8708b | ||
|
|
83c3aac317 | ||
|
|
712979fb0d | ||
|
|
e460c563af | ||
|
|
580397fbf9 | ||
|
|
537fae1a2b | ||
|
|
dbc9e02ff3 | ||
|
|
6474faad51 | ||
|
|
a5e415aeaf | ||
|
|
3e75e31696 | ||
|
|
9c8cc1c8b8 | ||
|
|
cccc4969cd | ||
|
|
1ba1591c75 | ||
|
|
1581cb3822 | ||
|
|
99926adbbd | ||
|
|
4edd8caaea | ||
|
|
005b698862 | ||
|
|
e76a5e4c12 | ||
|
|
ea3dcc6533 | ||
|
|
c8bd10a855 | ||
|
|
996074e431 | ||
|
|
275224cf73 | ||
|
|
575a27db26 | ||
|
|
76127dd131 | ||
|
|
e2e6f6a12c | ||
|
|
4f3e8803da | ||
|
|
63a66d69f9 | ||
|
|
79fb1d90d0 | ||
|
|
ac4eff376d | ||
|
|
5512978dee | ||
|
|
2bac0c32dc | ||
|
|
1cd02913bb | ||
|
|
51f6d600a6 | ||
|
|
a4905445c7 | ||
|
|
12d78444b3 | ||
|
|
dffada894f | ||
|
|
50ae224769 | ||
|
|
15b14ac488 | ||
|
|
f73e6b7796 | ||
|
|
6a820ddfdd | ||
|
|
81d7e120f5 | ||
|
|
57f538fa9e | ||
|
|
07402a09b5 | ||
|
|
ac3123f63f | ||
|
|
a2fb515b74 | ||
|
|
1699d39f62 | ||
|
|
70ad37d6d6 | ||
|
|
dc082016d8 | ||
|
|
af93af9047 | ||
|
|
0b5b9cf51a | ||
|
|
915d027b12 | ||
|
|
479d2a4fac | ||
|
|
2d9610cd92 | ||
|
|
832b7e92f9 | ||
|
|
5481316b83 | ||
|
|
6586c2a43e | ||
|
|
e1d9fc1e9c | ||
|
|
ecc46f2ea1 | ||
|
|
c04876e0c5 | ||
|
|
5402baed0a | ||
|
|
5aa96a4ddb | ||
|
|
2e6848f901 | ||
|
|
9c830c2c14 | ||
|
|
3574b56acb | ||
|
|
18cb8ba413 | ||
|
|
76e61b6ebf | ||
|
|
3dfe215103 | ||
|
|
94c7a4a874 | ||
|
|
b573b2859c | ||
|
|
e2c4d158b1 | ||
|
|
55890611e2 | ||
|
|
5add7ad645 | ||
|
|
5acd1551c9 | ||
|
|
ef2c45a11d | ||
|
|
c1771bb117 | ||
|
|
ddb86745dd | ||
|
|
971719b710 | ||
|
|
b6e943a244 | ||
|
|
82742cb53b | ||
|
|
df2d98272c | ||
|
|
6045155fbb | ||
|
|
2eda5618df | ||
|
|
be7d111f70 | ||
|
|
3e12e05e26 | ||
|
|
ba1e07d768 | ||
|
|
29d059aed5 | ||
|
|
6541923d3d | ||
|
|
daa341843d | ||
|
|
05c40f17e5 | ||
|
|
15e9161d53 | ||
|
|
44170602f6 | ||
|
|
84df2d683f | ||
|
|
eafab8c5cc | ||
|
|
53cb38059a |
+1
-1
@@ -23,6 +23,6 @@ indent_size = 4
|
|||||||
indent_style = tab
|
indent_style = tab
|
||||||
|
|
||||||
# Indentation override for all JS under lib directory
|
# Indentation override for all JS under lib directory
|
||||||
[*.{js,jsx,mjs,cjs,ts,tsx,json,py}]
|
[*.{js,jsx,mjs,cjs,ts,tsx,json}]
|
||||||
indent_style = space
|
indent_style = space
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
|
|||||||
@@ -0,0 +1,73 @@
|
|||||||
|
name: Bug Report
|
||||||
|
description: Fire a bug report
|
||||||
|
title: "[Bug]: "
|
||||||
|
labels: ["bug"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to fill out this bug report!
|
||||||
|
- type: textarea
|
||||||
|
id: what-happened
|
||||||
|
attributes:
|
||||||
|
label: What happened?
|
||||||
|
description: What did you expect to happen?
|
||||||
|
placeholder: Tell us what you see!
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: os
|
||||||
|
attributes:
|
||||||
|
label: What OS are you using?
|
||||||
|
multiple: true
|
||||||
|
options:
|
||||||
|
- Windows
|
||||||
|
- Linux
|
||||||
|
- macOS
|
||||||
|
- iOS (iPhone, iPad)
|
||||||
|
- Android
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: service
|
||||||
|
attributes:
|
||||||
|
label: What remote cloud services are you using?
|
||||||
|
multiple: true
|
||||||
|
options:
|
||||||
|
- S3
|
||||||
|
- OneDrive for personal
|
||||||
|
- Dropbox
|
||||||
|
- webdav
|
||||||
|
- others
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: version-plugin
|
||||||
|
attributes:
|
||||||
|
label: Version of the plugin
|
||||||
|
description: What version of the plugin are you running?
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: version-obsidian
|
||||||
|
attributes:
|
||||||
|
label: Version of Obsidian
|
||||||
|
description: What version of Obsidian are you running?
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: checkboxes
|
||||||
|
id: using-password
|
||||||
|
attributes:
|
||||||
|
label: Using password or not
|
||||||
|
description: Are you using password (end-to-end encryption) or not?
|
||||||
|
options:
|
||||||
|
- label: Yes.
|
||||||
|
required: false
|
||||||
|
- type: checkboxes
|
||||||
|
id: ensure-no-sensitive-information
|
||||||
|
attributes:
|
||||||
|
label: Ensure no sensitive information
|
||||||
|
description: By submitting this issue, you ensure that no sensitive information is submitted in the issue.
|
||||||
|
options:
|
||||||
|
- label: I ensure that no sensitive information is submitted in the issue.
|
||||||
|
required: true
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
name: Feature Request
|
||||||
|
description: Some idea about new features
|
||||||
|
title: "[Feature Request]: "
|
||||||
|
labels: ["enhancement"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to fill out this bug report!
|
||||||
|
- type: textarea
|
||||||
|
id: what-are-you-expecting
|
||||||
|
attributes:
|
||||||
|
label: What feature are you suggesting?
|
||||||
|
description: What feature are you suggesting?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: service
|
||||||
|
attributes:
|
||||||
|
label: What remote cloud services are you using, or suggesting adding the feature to?
|
||||||
|
multiple: true
|
||||||
|
options:
|
||||||
|
- S3
|
||||||
|
- OneDrive for personal
|
||||||
|
- Dropbox
|
||||||
|
- webdav
|
||||||
|
- others
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: checkboxes
|
||||||
|
id: ensure-no-sensitive-information
|
||||||
|
attributes:
|
||||||
|
label: Ensure no sensitive information
|
||||||
|
description: By submitting this issue, you ensure that no sensitive information is submitted in the issue.
|
||||||
|
options:
|
||||||
|
- label: I ensure that no sensitive information is submitted in the issue.
|
||||||
|
required: true
|
||||||
@@ -5,7 +5,7 @@ name: BuildCI
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [master]
|
branches: ["**"]
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [master]
|
branches: [master]
|
||||||
|
|
||||||
@@ -30,6 +30,7 @@ jobs:
|
|||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
lfs: true
|
lfs: true
|
||||||
|
submodules: recursive
|
||||||
- name: Checkout LFS
|
- name: Checkout LFS
|
||||||
run: git lfs checkout
|
run: git lfs checkout
|
||||||
- name: Use Node.js ${{ matrix.node-version }}
|
- name: Use Node.js ${{ matrix.node-version }}
|
||||||
|
|||||||
@@ -0,0 +1,86 @@
|
|||||||
|
# modified from https://github.com/argenos/nldates-obsidian/blob/master/.github/workflows/release.yml
|
||||||
|
# which is released under MIT License
|
||||||
|
|
||||||
|
# trigger:
|
||||||
|
# modify manifest.json, package.json, versions.json
|
||||||
|
# git tag <version number>
|
||||||
|
# git push origin --tags
|
||||||
|
|
||||||
|
name: Release A New Version
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "*" # Push events to matching any tag format, i.e. 1.0, 20.15.10
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
environment: env-for-buildci
|
||||||
|
|
||||||
|
env:
|
||||||
|
DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
|
||||||
|
ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
|
||||||
|
ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
node-version: [16.x]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout codes
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
lfs: true
|
||||||
|
submodules: recursive
|
||||||
|
- name: Checkout LFS
|
||||||
|
run: git lfs checkout
|
||||||
|
- name: Use Node.js ${{ matrix.node-version }}
|
||||||
|
uses: actions/setup-node@v2
|
||||||
|
with:
|
||||||
|
node-version: ${{ matrix.node-version }}
|
||||||
|
- run: npm install
|
||||||
|
- run: npm test
|
||||||
|
- run: npm run build
|
||||||
|
- name: Create Release
|
||||||
|
id: create_release
|
||||||
|
uses: actions/create-release@v1
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
VERSION: ${{ github.ref }}
|
||||||
|
with:
|
||||||
|
tag_name: ${{ github.ref }}
|
||||||
|
release_name: ${{ github.ref }}
|
||||||
|
draft: false
|
||||||
|
prerelease: true
|
||||||
|
- name: Upload main.js
|
||||||
|
id: upload-main
|
||||||
|
uses: actions/upload-release-asset@v1
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
with:
|
||||||
|
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||||
|
asset_path: ./main.js
|
||||||
|
asset_name: main.js
|
||||||
|
asset_content_type: text/javascript
|
||||||
|
- name: Upload manifest.json
|
||||||
|
id: upload-manifest
|
||||||
|
uses: actions/upload-release-asset@v1
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
with:
|
||||||
|
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||||
|
asset_path: ./manifest.json
|
||||||
|
asset_name: manifest.json
|
||||||
|
asset_content_type: application/json
|
||||||
|
- name: Upload styles.css
|
||||||
|
id: upload-styles
|
||||||
|
uses: actions/upload-release-asset@v1
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
with:
|
||||||
|
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||||
|
asset_path: ./styles.css
|
||||||
|
asset_name: styles.css
|
||||||
|
asset_content_type: text/css
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
[submodule "src/langs"]
|
||||||
|
path = src/langs
|
||||||
|
url = https://github.com/remotely-save/langs.git
|
||||||
@@ -4,9 +4,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
|
|||||||
|
|
||||||
[](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml)
|
[](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml)
|
||||||
|
|
||||||
[](https://github.com/fyears/remotely-save/releases)
|
[](https://github.com/fyears/remotely-save/releases)
|
||||||
|
|
||||||
[](https://github.com/fyears/remotely-save/releases)
|
|
||||||
|
|
||||||
## Disclaimer
|
## Disclaimer
|
||||||
|
|
||||||
@@ -14,7 +12,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
|
|||||||
|
|
||||||
## !!!Caution!!!
|
## !!!Caution!!!
|
||||||
|
|
||||||
As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any serious vaults.** **ALWAYS, ALWAYS, backup your vault before using this plugin.**
|
**ALWAYS, ALWAYS, backup your vault before using this plugin.**
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
@@ -23,19 +21,23 @@ As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any
|
|||||||
- Dropbox
|
- Dropbox
|
||||||
- OneDrive for personal
|
- OneDrive for personal
|
||||||
- Webdav
|
- Webdav
|
||||||
- **Obsidiain Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
|
- [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.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
|
- **[End-to-end encryption](./docs/encryption.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
|
||||||
- **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
|
- **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
|
||||||
- **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
|
- **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
|
||||||
- **Fully open source under [Apache-2.0 License](./LICENSE).**
|
- **Fully open source under [Apache-2.0 License](./LICENSE).**
|
||||||
- **[Sync Algorithm open](./docs/sync_algorithm.md) for discussion.**
|
- **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.**
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
||||||
- **"deletion" operation can only be triggered from local device.** It's because of the "[minimal intrusive design](./docs/minimal_intrusive_design.md)". May be changed in the future.
|
- **To support deltions sync, extra metadata will also be uploaded.** See [Minimal Intrusive](./docs/minimal_intrusive_design.md).
|
||||||
- **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
|
- **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
|
||||||
- **Cloud services cost you money.** Always be aware of the costs and pricing.
|
- **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
|
||||||
- **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.
|
- **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
|
||||||
|
- **You should protect your `data.json` file.** The file contains sensitive information.
|
||||||
|
- It's strongly advised **NOT** to share your `data.json` file to anyone.
|
||||||
|
- It's usually **NOT** a good idea to check the file into version control. By default, the plugin tries to create a `.gitignore` file inside the plugin directory if it doesn't exist, for ignoring `data.json` in the `git` version control. If you know exactly what it means and want to remove the setting, please modify the `.gitignore` file or set it to be empty.
|
||||||
|
|
||||||
## Questions, Suggestions, Or Bugs
|
## Questions, Suggestions, Or Bugs
|
||||||
|
|
||||||
@@ -49,7 +51,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
|||||||
|
|
||||||
## Download and Install
|
## Download and Install
|
||||||
|
|
||||||
- Option #1: Search in the official "community plugin list", or click [obsidian://show-plugin?id=remotely-save](obsidian://show-plugin?id=remotely-save), then install the plugin.
|
- Option #1: Search in the official "community plugin list", or visit this: [https://obsidian.md/plugins?id=remotely-save](https://obsidian.md/plugins?id=remotely-save) (which should redirect you into Obsidian app), then install the plugin.
|
||||||
- Option #2: You can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin. Input `fyears/remotely-save` in the configuration of BRAT.
|
- Option #2: You can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin. Input `fyears/remotely-save` in the configuration of BRAT.
|
||||||
- Option #3: [](https://github.com/fyears/remotely-save/releases) Manually download assets (`main.js`, `manifest.json`, `styles.css`) from the latest release.
|
- Option #3: [](https://github.com/fyears/remotely-save/releases) Manually download assets (`main.js`, `manifest.json`, `styles.css`) from the latest release.
|
||||||
- Option #4: [](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml) Every artifacts are placed in the "Summary" under every successful builds. It's automatically generated by every commit, may break something.
|
- Option #4: [](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml) Every artifacts are placed in the "Summary" under every successful builds. It's automatically generated by every commit, may break something.
|
||||||
@@ -59,7 +61,9 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
|||||||
### S3
|
### S3
|
||||||
|
|
||||||
- Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
|
- Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
|
||||||
- Configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
|
- About CORS:
|
||||||
|
- If you are using Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, you can skip this CORS part.
|
||||||
|
- If you are using Obsidian desktop < 0.13.25 or mobile < 1.1.1, you need to configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, and add at least `ETag` into exposed headers. Full example is [here](./docs/s3_cors_configure.md). It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
|
||||||
- Download and enable this plugin.
|
- Download and enable this plugin.
|
||||||
- Enter your information to the settings of this plugin.
|
- Enter your information to the settings of this plugin.
|
||||||
- If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
|
- If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
|
||||||
@@ -68,15 +72,13 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
|||||||
|
|
||||||
### Dropbox
|
### Dropbox
|
||||||
|
|
||||||
- **This plugin's function for Dropbox is not as mature as functions for S3.**
|
|
||||||
- **This plugin is NOT an official Dropbox product.** The plugin just uses Dropbox's public API.
|
- **This plugin is NOT an official Dropbox product.** The plugin just uses Dropbox's public API.
|
||||||
- After the authorization, the plugin can read your name and email (which cannot be unselected on Dropbox api), and read and write files in your Dropbox's `/Apps/remotely-save` folder.
|
- After the authorization, the plugin can read your name and email (which cannot be unselected on Dropbox api), and read and write files in your Dropbox's `/Apps/remotely-save` folder.
|
||||||
- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions.
|
- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions. [More with screenshot is here](./docs/dropbox_review_material/README.md).
|
||||||
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
||||||
|
|
||||||
### OneDrive for personal
|
### OneDrive for personal
|
||||||
|
|
||||||
- **This plugin's function for OneDrive is not as mature as functions for S3.**
|
|
||||||
- **This plugin is NOT an official Microsoft / OneDrive product.** The plugin just uses Microsoft's [OneDrive's public API](https://docs.microsoft.com/en-us/onedrive/developer/rest-api).
|
- **This plugin is NOT an official Microsoft / OneDrive product.** The plugin just uses Microsoft's [OneDrive's public API](https://docs.microsoft.com/en-us/onedrive/developer/rest-api).
|
||||||
- This plugin only works for "OneDrive for personal", and not works for "OneDrive for Business" (yet). See [#11](https://github.com/fyears/remotely-save/issues/11) to further details.
|
- This plugin only works for "OneDrive for personal", and not works for "OneDrive for Business" (yet). See [#11](https://github.com/fyears/remotely-save/issues/11) to further details.
|
||||||
- After the authorization, the plugin can read your name and email, and read and write files in your OneDrive's `/Apps/remotely-save` folder.
|
- After the authorization, the plugin can read your name and email, and read and write files in your OneDrive's `/Apps/remotely-save` folder.
|
||||||
@@ -85,11 +87,14 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
|||||||
|
|
||||||
### webdav
|
### webdav
|
||||||
|
|
||||||
- **webdav support is considered experimental.**
|
- About CORS:
|
||||||
- Currently only supports BASIC authorization method.
|
- If you are using Obsidian desktop >= 0.13.25 or iOS >= 1.1.1, you can skip this CORS part.
|
||||||
- Currently webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies.
|
- If you are using Obsidian desktop < 0.13.25 or iOS < 1.1.1 or any Android version:
|
||||||
- Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin.
|
- The webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies unless under a upgraded Obsidian version.
|
||||||
- The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
|
- Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin, or use a upgraded Obsidian version.
|
||||||
|
- **Unofficial** workaround: NextCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can install [WebAppPassword](https://apps.nextcloud.com/apps/webapppassword) app, and add `app://obsidian.md`, `capacitor://localhost`, `http://localhost` to `Allowed origins`
|
||||||
|
- **Unofficial** workaround: OwnCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can download `.tar.gz` of `WebAppPassword` above and manually install and configure it on their instances.
|
||||||
|
- The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
|
||||||
- Your data would be synced to a `${vaultName}` sub folder on your webdav server.
|
- Your data would be synced to a `${vaultName}` sub folder on your webdav server.
|
||||||
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
||||||
|
|
||||||
@@ -99,6 +104,16 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
|||||||
- In auto sync mode, if any error occurs, the plugin would **fail silently**.
|
- In auto sync mode, if any error occurs, the plugin would **fail silently**.
|
||||||
- Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
|
- Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
|
||||||
|
|
||||||
|
## How To 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.
|
||||||
|
|
||||||
|
In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder (but not any other `.` files or folders).
|
||||||
|
|
||||||
|
## How To Debug
|
||||||
|
|
||||||
|
See [here](./docs/how_to_debug/README.md) for more details.
|
||||||
|
|
||||||
## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
|
## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
|
||||||
|
|
||||||
See [here](./docs/import_export_some_settings.md) for more details.
|
See [here](./docs/import_export_some_settings.md) for more details.
|
||||||
|
|||||||
@@ -0,0 +1,25 @@
|
|||||||
|
# How To Configure Apache CORS Rules for Webdav
|
||||||
|
|
||||||
|
This method is [contributed by community](https://github.com/remotely-save/remotely-save/pull/31).
|
||||||
|
|
||||||
|
You should evaluate the risk by yourself before trying this method.
|
||||||
|
|
||||||
|
**You are strongly advised to backup your original Apache configuration files before making any changes.**
|
||||||
|
|
||||||
|
```apacheconf
|
||||||
|
<IfModule mod_headers.c>
|
||||||
|
# Obsidian webdav
|
||||||
|
SetEnvIf Origin "^app://obsidian.md$" IS_OBSIDIAN
|
||||||
|
SetEnvIf Origin "^capacitor://localhost$" IS_OBSIDIAN
|
||||||
|
SetEnvIf Origin "^http://localhost$" IS_OBSIDIAN
|
||||||
|
Header always set Access-Control-Allow-Origin "*" env=IS_OBSIDIAN
|
||||||
|
Header always set Access-Control-Allow-Methods "GET, HEAD, POST, PUT, OPTIONS, MOVE, DELETE, COPY, LOCK, UNLOCK, PROPFIND" env=IS_OBSIDIAN
|
||||||
|
Header always set Access-Control-Allow-Headers "Authorization, Depth, DNT, User-Agent, Keep-Alive, Content-Type, accept, origin, X-Requested-With" env=IS_OBSIDIAN
|
||||||
|
Header always set Access-Control-Expose-Headers "etag, dav" env=IS_OBSIDIAN
|
||||||
|
|
||||||
|
# Allow OPTION request without authentication and respond with status 200
|
||||||
|
RewriteCond %{ENV:IS_OBSIDIAN} 1
|
||||||
|
RewriteCond %{REQUEST_METHOD} OPTIONS
|
||||||
|
RewriteRule ^(.*)$ $1 [R=200,L]
|
||||||
|
</IfModule>
|
||||||
|
```
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# Limitations From The Browser Environment
|
||||||
|
|
||||||
|
Obsidian desktop is developed by using [Electron](https://www.electronjs.org/). And Obsidian mobile is developed by using [Capacitor](https://capacitorjs.com/)
|
||||||
|
|
||||||
|
Technically, the plugin (or any plugin?) runs in the js environment provided by Obsidian. And to support the mobile Obsidian, the plugin is limited to be developed for the browser environment, instead of the Node.js environment.
|
||||||
|
|
||||||
|
Then some limitations are applied:
|
||||||
|
|
||||||
|
1. [The CORS issue (solved in the new Obsidian version on some platforms).](./browser_env_cors.md)
|
||||||
|
2. [No Node.js environment.](./browser_env_no_nodejs.md)
|
||||||
|
3. If the cloud service uses OAuth flow, it needs to support PKCE. More details are [here](./browser_env_oauth2_pkce.md).
|
||||||
|
4. [No background running after Obsidian is closes.](./browser_env_no_background_after_closing.md)
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
# Limitations From The Browser Environment: CORS Issue
|
||||||
|
|
||||||
|
The plugin is developed for the browser environment. The "fake" browser behind the scenes also follows the CORS policy.
|
||||||
|
|
||||||
|
[MDN has a doc about CORS.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
|
||||||
|
|
||||||
|
1. From Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
|
||||||
|
|
||||||
|
2. For using this plugin in Obsidian desktop < 0.13.25 or mobile < 1.1.1, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`.
|
||||||
|
|
||||||
|
Example configurations:
|
||||||
|
|
||||||
|
- [Amazon S3](./s3_cors_configure.md)
|
||||||
|
- [Apache](./apache_cors_configure.md) ([contributed by community](https://github.com/remotely-save/remotely-save/pull/31))
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Limitations From The Browser Environment: No Background Running After Obsidian Is Closed
|
||||||
|
|
||||||
|
The plugin treats Obsidian as a special browser, and is in fact some js codes. So if Obsidian is closed, then the browser environment stops, then the plugin will be stopped.
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# Limitations From The Browser Environment: No Node.js
|
||||||
|
|
||||||
|
To support the mobile Obsidian, the plugin is limited to be developed for the browser environment, instead of the Node.js environment.
|
||||||
|
|
||||||
|
Many js libraries are designed to work in both the browser and the Node.js environments. But some are not, because the browser doesn't provide the corresponding abilities.
|
||||||
|
|
||||||
|
For example, there is a popular npm package [`ssh2-sftp-client`](https://www.npmjs.com/package/ssh2-sftp-client) for SFTP. But it relies on the modules (e.g. `http`) from Node.js which cannot be "translated" to the browser environment. So it's impossible to make this plugin support SFTP. The same status applies to FTP / FTPS.
|
||||||
|
|
||||||
|
Likewise, [MEGA](https://mega.nz/) provides a SDK, but the SDK is [for C++ only](https://mega.nz/doc), so it's also impossible to make this plugin support MEGA.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# Limitations From The Browser Environment: OAuth2 PKCE
|
||||||
|
|
||||||
|
If the cloud service uses OAuth flow, it needs to support PKCE, because the plugin is released to the public, and no real secrets can be statically kept in the client.
|
||||||
|
|
||||||
|
Luckily, Dropbox and OneDrive supports PKCE, making it possible for this plugin to connect to them easily.
|
||||||
|
|
||||||
|
Dropbox has an excellent [article](https://dropbox.tech/developers/pkce--what-and-why-) explaining what is and how to use PKCE.
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
## Material Source
|
||||||
|
|
||||||
|
To apply for the production use of Dropbox API, some descriptions are needed to be submitted to Dropbox. Coincidently, this can also be served as a "readme" to use this plugin with Dropbox.
|
||||||
|
|
||||||
|
## Some Backgrounds
|
||||||
|
|
||||||
|
1. Obsidian allows users to take notes using markdown files.
|
||||||
|
2. The "app", remotely-save. is an unofficial Obsidian plugin, helping users download and upload ("sync") their notes from and to Dropbox.
|
||||||
|
3. Technically, remotely-save is developed using web technologies.
|
||||||
|
|
||||||
|
## Api Usages
|
||||||
|
|
||||||
|
1. remotely-save uses "App folder", to avoid unnecessary accessing users' other files.
|
||||||
|
2. remotely-save uses "account_info.read", to get the displayed username, so that users know which of their accounts has been logged in after OAuth steps.
|
||||||
|
3. remotely-save uses "files.content.read", so that it can read the "last modified time", and the content of files on Dropbox. Under some conditions, the plugin would download the files. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp on Dropbox is larger, the plugin would download the "newer" file from Dropbox to local.
|
||||||
|
4. remotely-save uses "files.content.write", so that it can upload or overwrite the content of files on Dropbox. Under some conditions, the plugin would do that. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp in the local device is larger, the plugin would upload the "newer" file from local to Dropbox, and overwrite that file on Dropbox.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
Here are the steps to see the functionality of remotely-save.
|
||||||
|
|
||||||
|
Most steps have screenshots.
|
||||||
|
|
||||||
|
1. Download the note-taking app Obsidian (Windows or Mac versions are both ok) from its official website: https://obsidian.md/ . It's free to download and use. Then install it.
|
||||||
|
2. Open Obsidian, click the "Create" button under "Create new vault".
|
||||||
|
3. Pick a vault name, "example-vault", and choose a location, then click "Create".
|
||||||
|

|
||||||
|
4. Close any update new if prompted.
|
||||||
|
5. Create a new note by clicking a button on the left. And write something on the note.
|
||||||
|

|
||||||
|
6. Click "setting" (a gear icon) on the button left of the sidebar.
|
||||||
|

|
||||||
|
7. In the settings panel, go to the "Community plugins" page, turn off the safe mode, and confirm to turn off the safe mode. Then click the "Browse" button for community plugins.
|
||||||
|

|
||||||
|
8. Search "Remotely Save" and install on the result.
|
||||||
|

|
||||||
|
9. After successful installing the plugin, go back to the "Community plugins" page, and enable the plugin.
|
||||||
|

|
||||||
|
10. Go to newly added "Remotely Save" settings, select "Dropbox" in "Choose service", and click the "Auth" button.
|
||||||
|

|
||||||
|
11. The standard auth flow address is shown, users should click the address, and finish the auth steps on the website. Finally, the Dropbox website should automatically redirect users back to the Obsidian app.
|
||||||
|

|
||||||
|
12. The "Auth" button disappears. A new "Revoke Auth" appears.
|
||||||
|

|
||||||
|
13. Go back to the main interface of Obsidian, a new "switch icon" should appear on the left sidebar. Click this, then the plugin would trigger the sync progress. It would compare meta info of local files and remote files (on Dropbox), and decide to download some files and/or upload some files.
|
||||||
|

|
||||||
|
14. Create, edit, remove some notes, and repeat step 13, the files on Dropbox should also change to reflect the changes locally.
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:655f6f487cc24af0ab86b8592622a7701c30f3369e7847a1fbb783d0962829c3
|
||||||
|
size 52910
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:fe971af94f1f7b042b7313268e4d2d8432d926ce2392e50ca2a4abc21c8a4aab
|
||||||
|
size 57033
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:025303053f2b2cedd2bdd61cd71e1f1c0fb12e45bfbc0e81f2c0d70747133505
|
||||||
|
size 63458
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:061707977c8046a6f924881f86aac962e2f05618e201080768246270de792040
|
||||||
|
size 100162
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:8add61e6ef34b2470e5a5bea3e10955a86eed5ed1fc4dd398f30835485a6c455
|
||||||
|
size 158422
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:021ae1ce29d3932f088f0954787c475be826915b794320bf212d3ba7d58656da
|
||||||
|
size 110529
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:b225d21de5778ddc032893e0f52150ab4260b0dfbe0e9141da4aa8b03131a9da
|
||||||
|
size 147821
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:fda4f6e8cf68833f239bdc85c46802fe2131d149011074f747b1829822a38939
|
||||||
|
size 59041
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:576801d5ebd8cf7fcd3c9c0c6df325654338854f7d762a5680e9aab3c9e6508a
|
||||||
|
size 142155
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:1c93f681f0f7ce74cee0f2ed193f574ef915554f1a9ef96ba54afdede302f13a
|
||||||
|
size 112057
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# How To Debug
|
||||||
|
|
||||||
|
Ideally, users do not need to debug anything. But if something bad happened, we have to dig into details.
|
||||||
|
|
||||||
|
## Easy: Export Sync Plans
|
||||||
|
|
||||||
|
See [here](./export_sync_plans.md).
|
||||||
|
|
||||||
|
## Advanced: Check Console Output Directly
|
||||||
|
|
||||||
|
...of desktop and Android.
|
||||||
|
|
||||||
|
See [here](./check_console_output.md).
|
||||||
|
|
||||||
|
## Advanced: Save Console Output Then Read Them Later
|
||||||
|
|
||||||
|
This method works for desktop and mobile devices (iOS, Android).
|
||||||
|
|
||||||
|
See [here](./save_console_output_and_export.md).
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# Check Console Output
|
||||||
|
|
||||||
|
If you are using Obsidian on desktop or Android, you can check the Obsidian console.
|
||||||
|
|
||||||
|
## Disable Auto Sync Firstly
|
||||||
|
|
||||||
|
You should disable auto sync to avoid any unexpected running.
|
||||||
|
|
||||||
|
## Set The Output Level To Debug
|
||||||
|
|
||||||
|
Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
|
||||||
|
|
||||||
|
## Check The Output
|
||||||
|
|
||||||
|
- If you are on desktop
|
||||||
|
|
||||||
|
Press the keyboard shortcut "ctrl+shift+i" if you are on Windows or Linux, or press "cmd+shift+i" if you are on macOS. You should be able to see the console of Obsidian.
|
||||||
|
|
||||||
|
- If you are using Android
|
||||||
|
|
||||||
|
You need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on your Android, then connect your Android to a computer using USB, then open the **desktop** Chrome browser and go to the special web page <chrome://inspect>. You shall be able to see the "inspect" link inside the special page, then click the link to open the console. After debugging, remember to turn off USB debugging.
|
||||||
|
|
||||||
|
Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. You could understand what happened and what goes wrong more explictly by checking the output.
|
||||||
@@ -0,0 +1,95 @@
|
|||||||
|
# Export Sync Plans
|
||||||
|
|
||||||
|
## What's this?
|
||||||
|
|
||||||
|
Everytime the plugin starts a sync, it gathers all required information together, generates a "sync plan" of every operations to every files and folders, and assign the corresponding actual operations.
|
||||||
|
|
||||||
|
Thus, if something goes wrong, we should check the sync plan firstly.
|
||||||
|
|
||||||
|
## How To Export The Plans?
|
||||||
|
|
||||||
|
Please read through the following instructions.
|
||||||
|
|
||||||
|
### Disable Auto Sync Firstly
|
||||||
|
|
||||||
|
You should disable auto sync to avoid any unexpected running.
|
||||||
|
|
||||||
|
### Manual Sync If Not Yet
|
||||||
|
|
||||||
|
You should at least sync once, so that at least one sync plan is generated and saved. If you have synced the vualt before, there should be some sync plans already saved.
|
||||||
|
|
||||||
|
### Export To The File
|
||||||
|
|
||||||
|
Go to the plugin settings, scroll down to the section "Debug" -> "export sync plans", and click the button "Export". \*\*It would generate a new folder `_debug_remotely_save/` in your vault, and generate a file `sync_plans_hist_exported_on_{a_timestamp},md.` inside that folder.
|
||||||
|
|
||||||
|
## How To Read The Plans
|
||||||
|
|
||||||
|
Open the genrated `sync_plans_hist_exported_on_{a_timestamp},md.`. You should see a json, or multiple jsons. Every json represents a sync plan.
|
||||||
|
|
||||||
|
A sync plan looks like this:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"ts": 1646960867560,
|
||||||
|
"remoteType": "onedrive",
|
||||||
|
"mixedStates": {
|
||||||
|
"abc.md": {
|
||||||
|
"key": "abc.md",
|
||||||
|
"existRemote": true,
|
||||||
|
"mtimeRemote": 1646566632000,
|
||||||
|
"sizeRemote": 56797,
|
||||||
|
"remoteEncryptedKey": "abc.md",
|
||||||
|
"changeMtimeUsingMapping": true,
|
||||||
|
"existLocal": true,
|
||||||
|
"mtimeLocal": 1646566632000,
|
||||||
|
"sizeLocal": 56797,
|
||||||
|
"decision": "skipUploading",
|
||||||
|
"decisionBranch": 1
|
||||||
|
},
|
||||||
|
"New folder/": {
|
||||||
|
"key": "New folder/",
|
||||||
|
"deltimeRemote": 1646925354372,
|
||||||
|
"existLocal": false,
|
||||||
|
"existRemote": false,
|
||||||
|
"decision": "keepRemoteDelHistFolder",
|
||||||
|
"decisionBranch": 9
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
We usually care about the `mixedStates` property. As you may guess, every item in `mixedStates` represent a file or a folder.
|
||||||
|
|
||||||
|
We should find out the file/folder we are interested in (or we believe something goes wrong), then checkout the following properties:
|
||||||
|
|
||||||
|
```
|
||||||
|
decision
|
||||||
|
What decision is made.
|
||||||
|
|
||||||
|
decisionBranch
|
||||||
|
It's a mark of the actual logic in the sync code. Useful to debug.
|
||||||
|
|
||||||
|
existRemote
|
||||||
|
Does the file/folder exist on the remote service?
|
||||||
|
|
||||||
|
mtimeRemote
|
||||||
|
The "last modeified time" on the remote service.
|
||||||
|
|
||||||
|
deltimeRemote
|
||||||
|
The "deletion time" on the remote record.
|
||||||
|
|
||||||
|
existLocal
|
||||||
|
Does the file/folder exist locally?
|
||||||
|
|
||||||
|
mtimeLocal
|
||||||
|
The max of "last modeified time" and "creation time" locally.
|
||||||
|
|
||||||
|
deltimeLocal
|
||||||
|
The "deletion time" locally.
|
||||||
|
```
|
||||||
|
|
||||||
|
The `decision` SHOULD be determined by the modified times and deletion times, by the logic described in [the doc of sync alogorithm](../sync_algorithm_v2.md). In short, we collect four timestamps (`mtimeRemote`, `deltimeRemote`, `mtimeLocal`, `deltimeLocal`), and respect the max timestamp and its corresponding operation.
|
||||||
|
|
||||||
|
## Common Issues
|
||||||
|
|
||||||
|
Some users report that their "last modeified time"s or "creation time"s are not set correctly by the operating system. In this case, the plugin cannot do anything because it determines the sync plan by comparing the timestamps. It's suggested to check the settings of the operating system or check whether other programs are doing something to the files.
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
# Save Console Output And Read Them Later
|
||||||
|
|
||||||
|
## Disable Auto Sync Firstly
|
||||||
|
|
||||||
|
You should disable auto sync to avoid any unexpected running.
|
||||||
|
|
||||||
|
## Set The Output Level To Debug
|
||||||
|
|
||||||
|
Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
|
||||||
|
|
||||||
|
## Enable Saving The Output To DB
|
||||||
|
|
||||||
|
Go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "disable" to "enable". **This setting has some performance cost, so do NOT always turn this on when not necessary!**
|
||||||
|
|
||||||
|
## Run The Sync
|
||||||
|
|
||||||
|
Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. The the console logs are also saved into DB now.
|
||||||
|
|
||||||
|
## Export The Output And Read The Logs
|
||||||
|
|
||||||
|
Go to the plugin settings, scroll down to the section "Debug" -> "Export Console Logs From DB", and click the button. A new file `log_hist_exported_on_....md` should be created inside the special folder `_debug_remotely_save/`. You could read it and hopefully find something useful.
|
||||||
|
|
||||||
|
## Disable Saving The Output To DB
|
||||||
|
|
||||||
|
After debugging, go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "enable" to "disable".
|
||||||
@@ -1,36 +1,21 @@
|
|||||||
# Minimal Intrusive Design
|
# Minimal Intrusive Design
|
||||||
|
|
||||||
The plugin tries to avoid saving additional meta data remotely.
|
Before version 0.3.0, the plugin did not upload additional meta data to the remote.
|
||||||
|
|
||||||
|
From and after version 0.3.0, the plugin just upload minimal extra necessary meta data to the remote.
|
||||||
|
|
||||||
## Benefits
|
## Benefits
|
||||||
|
|
||||||
Then the plugin doesn't make any assumptions about information on the remote endpoint.
|
Then the plugin doesn't make more-than-necessary assumptions about information on the remote endpoint.
|
||||||
|
|
||||||
For example, it's possbile for a uses to manually upload a file to s3, and next time the plugin can download that file to the local device.
|
For example, it's possbile for a uses to manually upload a file to s3, and next time the plugin can download that file to the local device.
|
||||||
|
|
||||||
And it's also possible to combine another "sync-to-s3" solution (like, another software) on desktops, and this plugin on mobile devices, together.
|
And it's also possible to combine another "sync-to-s3" solution (like, another software) on desktops, and this plugin on mobile devices, together.
|
||||||
|
|
||||||
## Flaws
|
## Necessarity Of Uploading Extra Metadata
|
||||||
|
|
||||||
The main issue comes from deletions (and renamings which is actually interpreted as "deletion-then-creation").
|
The main issue comes from deletions (and renamings which is actually interpreted as "deletion-then-creation").
|
||||||
|
|
||||||
Consider this:
|
If we don't upload any extra info to the remote, there's usually no way for the second device to know what files / folders have been deleted on the first device.
|
||||||
|
|
||||||
1. The user create and sync a file to the cloud on the 1st device.
|
To overcome this issue, from and after version 0.3.0, the plugin uploads extra metadata files `_remotely-save-metadata-on-remote.{json,bin}` to users' configured cloud services. Those files contain some info about what has been deleted on the first device, so that the second device can read the list to apply the deletions to itself. Some other necessary meta info would also be written into the extra files.
|
||||||
2. Then download this file to the 2nd device.
|
|
||||||
3. And then delete this file on the 1st device.
|
|
||||||
4. And sync on the 1st device. The file on the cloud is also deleted.
|
|
||||||
5. And sync on the 2nd device. **The 2nd device would upload the file again to the cloud.**
|
|
||||||
|
|
||||||
In step 4, the file is marked "deleted" on the 1st device, and the 1st device send the command "delete this file on the cloud" to the cloud sevice (e.g. s3). Then the file on the cloud is also deleted. So far so good.
|
|
||||||
|
|
||||||
But, in step 5, because no meta data are saved on the cloud, the 2nd device doesn't know that the file are deleted. Instead, it thinks "the file was not synced to the cloud last time, so it's uploaded this time". So an unintentional upload occurs.
|
|
||||||
|
|
||||||
Currently no way to fix this if no meta data are saved remotely. The only workarounds are:
|
|
||||||
|
|
||||||
1. Delete the file on the 1st device, **before** syncing it to the cloud. Then the file never show up on the cloud or on the 2nd device.
|
|
||||||
2. Or, manually delete the file on 2nd device **before** step 5 in above situation.
|
|
||||||
|
|
||||||
## Future
|
|
||||||
|
|
||||||
This design may be changed in the feature, considering the flaws described above.
|
|
||||||
|
|||||||
@@ -0,0 +1,33 @@
|
|||||||
|
# How To Configure S3 CORS Rules
|
||||||
|
|
||||||
|
If you are using the latest version of this plugin AND Obsidian desktop >= 0.13.25, mobile >= 1.1.1, you do not need to configure it any more. If you are using Obsidian desktop < 0.13.25, moble < 1.1.1, you are required to configure the rules as following.
|
||||||
|
|
||||||
|
Thanks to [@NAL100 in the Discussion](https://github.com/fyears/remotely-save/discussions/28).
|
||||||
|
|
||||||
|
Please try this config:
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"AllowedHeaders": ["*"],
|
||||||
|
"AllowedMethods": ["GET", "PUT", "POST", "DELETE", "HEAD"],
|
||||||
|
"AllowedOrigins": [
|
||||||
|
"app://obsidian.md",
|
||||||
|
"capacitor://localhost",
|
||||||
|
"http://localhost"
|
||||||
|
],
|
||||||
|
"ExposeHeaders": [
|
||||||
|
"Content-Length",
|
||||||
|
"Content-Type",
|
||||||
|
"Connection",
|
||||||
|
"Date",
|
||||||
|
"ETag",
|
||||||
|
"Server",
|
||||||
|
"x-amz-delete-marker",
|
||||||
|
"x-amz-id-2",
|
||||||
|
"x-amz-request-id",
|
||||||
|
"x-amz-version-id"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
# services connectability
|
||||||
|
|
||||||
|
Here is an overview of the connectability ("connectable" or "not connectable" or "in the plan" or "never") to some services by this plugin.
|
||||||
|
|
||||||
|
The plugin works under the browser environment in Obsidian, so CORS is an issue. Obsidian starts to provide a rich API `requestUrl` for desktop version >= 0.13.25, mobile >= 1.1.1 to bypass the CORS issue. But if the users are still using an older version of Obsidian, they need to configure CORS on server.
|
||||||
|
|
||||||
|
The list is for information purposes only.
|
||||||
|
|
||||||
|
| Service | Connectable | by S3 | by WebDAV | by other protocol | can bypass CORS issue in latest Obsidian | need CORS config in old Obsidian |
|
||||||
|
| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------ |
|
||||||
|
| Amazon S3 | Yes | Yes | | | Yes | [CORS config needed.](./s3_cors_configure.md) |
|
||||||
|
| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储 | Yes | Yes | | | Yes | CORS config needed. |
|
||||||
|
| Alibaba Cloud - Object Storage Service 阿里云对象存储 | Yes | Yes | | | Yes | CORS config needed. |
|
||||||
|
| Backblaze B2 Cloud Storage | Yes | Yes | | | Yes | Its CORS rules doesn't allow no-http(s) origins. |
|
||||||
|
| [Wasabi](https://wasabi.com) | ? | ? | | | | |
|
||||||
|
| [filebase](https://filebase.com/) | Yes | Yes | | | Yes | CORS config needed. |
|
||||||
|
| QingStor 青云 | ? | ? | | | | |
|
||||||
|
| [MinIO](https://min.io/) | ? | ? | | | | |
|
||||||
|
| [WsgiDAV](https://github.com/mar10/wsgidav) | Yes | | Yes | | Yes | CORS rules can be set. |
|
||||||
|
| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes? | | Yes? | | Yes? | ? |
|
||||||
|
| NextCloud | Yes? | | Yes? | | Yes? | No CORS config by default. |
|
||||||
|
| OwnCloud | Yes? | | Yes? | | Yes? | No CORS config by default. |
|
||||||
|
| Seafile | Yes | | Yes | | Yes? | No CORS config by default. |
|
||||||
|
| `rclone serve webdav` | Yes | | Yes | | Yes | No CORS support. |
|
||||||
|
| [Nutstore 坚果云](https://www.jianguoyun.com/) | Yes | | Yes | | Yes | No CORS support. |
|
||||||
|
| [TeraCLOUD](https://teracloud.jp/en/) | Yes | | Yes | | Yes | No CORS support. |
|
||||||
|
| Dropbox | Yes | | | Yes | | |
|
||||||
|
| OneDrive for personal | Yes | | | Yes | | |
|
||||||
|
| OneDrive for Business | In the plan | | | ? | | |
|
||||||
|
| Google Drive | In the plan | | | ? | | |
|
||||||
|
| [Box](https://www.box.com/) | ? | | | May be possible but needs further development. | | |
|
||||||
|
| Google Cloud Storage | ? | | | May be possible but needs further development. | | |
|
||||||
|
| Microsoft Azure Blob Storage | ? | | | May be possible but needs further development. | | |
|
||||||
|
| [OpenStack Storage (Swift)](https://github.com/openstack/swift) | ? | | | May be possible but needs further development. | | |
|
||||||
|
| https://put.io/ | ? | | | ? | | |
|
||||||
|
| Yandex Disk | ? | | | ? | | |
|
||||||
|
| FTP / FTPS | Never | | | Technically never possible to be implemented. | | |
|
||||||
|
| SFTP | Never | | | Technically never possible to be implemented. | | |
|
||||||
|
| Jottacloud | No | | | No. It seems that no open api is available. | | |
|
||||||
|
| Mega | Never | | | No. No js api is available. | | |
|
||||||
|
| Git | Never | | | No. Technically very hard, if not impossible, to be implemented. | | |
|
||||||
|
| | | | | | | |
|
||||||
@@ -4,9 +4,9 @@
|
|||||||
|
|
||||||
We have three record sources:
|
We have three record sources:
|
||||||
|
|
||||||
1. Local files
|
1. Local files. By scanning all files in the vault locally. Actually Obsidian provides an api directly returning this.
|
||||||
2. Remote files
|
2. Remote files. By scanning all files on the remote service. Some services provide an api directly returning this, and some other services require the plugin scanning the folders recursively.
|
||||||
3. Local "delete-or-rename" history.
|
3. Local "delete-or-rename" history. It's recorded by using Obsidian's tracking api. So if users delete or rename files/folders outside Obsidian, we could do nothing.
|
||||||
|
|
||||||
Assuming all sources are reliable.
|
Assuming all sources are reliable.
|
||||||
|
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
# Sync Algorithm V2
|
||||||
|
|
||||||
|
## Sources
|
||||||
|
|
||||||
|
We have 4 record sources:
|
||||||
|
|
||||||
|
1. Local files. By scanning all files in the vault locally. Actually Obsidian provides an api directly returning this.
|
||||||
|
2. Remote files. By scanning all files on the remote service. Some services provide an api directly returning this, and some other services require the plugin scanning the folders recursively.
|
||||||
|
3. Local "delete-or-rename" history. It's recorded by using Obsidian's tracking api. So if users delete or rename files/folders outside Obsidian, we could do nothing.
|
||||||
|
4. Remote "delete" history. It's uploaded by the plugin in each sync.
|
||||||
|
|
||||||
|
Assuming all sources are reliable.
|
||||||
|
|
||||||
|
## Deal with them
|
||||||
|
|
||||||
|
We list all combinations mutually exclusive and collectively exhaustive.
|
||||||
|
|
||||||
|
### Files
|
||||||
|
|
||||||
|
In short, we collect four timestamps, and respect the max timestamp and its corresponding operation.
|
||||||
|
|
||||||
|
| t1 | t2 | t3 | t4 | local file to do | remote file to do | local del history to do | remote del history to do | equal to sync v2 branch |
|
||||||
|
| -------------- | -------------- | -------------- | -------------- | ---------------- | ----------------- | ----------------------- | ------------------------ | ----------------------- |
|
||||||
|
| mtime_remote | mtime_local | deltime_remote | deltime_local | del_if_exists | del_if_exists | clean | upload_local_del_history | |
|
||||||
|
| mtime_local | mtime_remote | deltime_remote | deltime_local | del_if_exists | del_if_exists | clean | upload_local_del_history | |
|
||||||
|
| mtime_remote | deltime_remote | mtime_local | deltime_local | del_if_exists | del_if_exists | clean | upload_local_del_history | |
|
||||||
|
| deltime_remote | mtime_remote | mtime_local | deltime_local | del_if_exists | del_if_exists | clean | upload_local_del_history | |
|
||||||
|
| mtime_local | deltime_remote | mtime_remote | deltime_local | del_if_exists | del_if_exists | clean | upload_local_del_history | |
|
||||||
|
| deltime_remote | mtime_local | mtime_remote | deltime_local | del_if_exists | del_if_exists | clean | upload_local_del_history | 8 |
|
||||||
|
| mtime_remote | mtime_local | deltime_local | deltime_remote | del_if_exists | del_if_exists | clean | keep | |
|
||||||
|
| mtime_local | mtime_remote | deltime_local | deltime_remote | del_if_exists | del_if_exists | clean | keep | |
|
||||||
|
| mtime_remote | deltime_local | mtime_local | deltime_remote | del_if_exists | del_if_exists | clean | keep | |
|
||||||
|
| deltime_local | mtime_remote | mtime_local | deltime_remote | del_if_exists | del_if_exists | clean | keep | |
|
||||||
|
| mtime_local | deltime_local | mtime_remote | deltime_remote | del_if_exists | del_if_exists | clean | keep | |
|
||||||
|
| deltime_local | mtime_local | mtime_remote | deltime_remote | del_if_exists | del_if_exists | clean | keep | |
|
||||||
|
| mtime_remote | deltime_remote | deltime_local | mtime_local | skip | upload_local | clean | clean | |
|
||||||
|
| deltime_remote | mtime_remote | deltime_local | mtime_local | skip | upload_local | clean | clean | 10 |
|
||||||
|
| mtime_remote | deltime_local | deltime_remote | mtime_local | skip | upload_local | clean | clean | |
|
||||||
|
| deltime_local | mtime_remote | deltime_remote | mtime_local | skip | upload_local | clean | clean | |
|
||||||
|
| deltime_remote | deltime_local | mtime_remote | mtime_local | skip | upload_local | clean | clean | 2;3;4;5;6 |
|
||||||
|
| deltime_local | deltime_remote | mtime_remote | mtime_local | skip | upload_local | clean | clean | |
|
||||||
|
| mtime_local | deltime_remote | deltime_local | mtime_remote | download_remote | skip | clean | clean | |
|
||||||
|
| deltime_remote | mtime_local | deltime_local | mtime_remote | download_remote | skip | clean | clean | 7;9 |
|
||||||
|
| mtime_local | deltime_local | deltime_remote | mtime_remote | download_remote | skip | clean | clean | |
|
||||||
|
| deltime_local | mtime_local | deltime_remote | mtime_remote | download_remote | skip | clean | clean | |
|
||||||
|
| deltime_remote | deltime_local | mtime_local | mtime_remote | download_remote | skip | clean | clean | 1;9 |
|
||||||
|
| deltime_local | deltime_remote | mtime_local | mtime_remote | download_remote | skip | clean | clean | |
|
||||||
|
|
||||||
|
### Folders
|
||||||
|
|
||||||
|
We actually do not use any folders' metadata. Thus the only relevent info is their names, while the mtime is actually ignorable.
|
||||||
|
|
||||||
|
1. Firstly generate all the files' plan. If any files exist, then it's parent folders all should exist. If the should-exist folder doesn't exist locally, the local should create it recursively. If the should-exist folder doesn't exist remotely, the remote should create it recursively.
|
||||||
|
2. Then, a folder is deletable, if and only if all the following conditions meet:
|
||||||
|
|
||||||
|
- it shows up in the remote deletion history
|
||||||
|
- it's empty, or all its sub-folders are deletable
|
||||||
|
|
||||||
|
Some examples:
|
||||||
|
|
||||||
|
- A user deletes the folder in device 1, then syncs from the device 1, then creates the same-name folder in device 2, then syncs from the device 2. The folder is deleted (again), on device 2.
|
||||||
|
- A user deletes the folder in device 1, then syncs from the device 1, then creates the same-name folder in device 2, **then create a new file inside it,** then syncs from the device 2. The folder is **kept** instead of deleted because of the new file, on device 2.
|
||||||
|
- A user deletes the folder in device 1, then syncs from the device 1, then do not touch the same-name folder in device 2, then syncs from the device 2. The folder and its untouched sub-files should be deleted on device 2.
|
||||||
+6
-1
@@ -31,9 +31,11 @@ esbuild
|
|||||||
"obsidian",
|
"obsidian",
|
||||||
"electron",
|
"electron",
|
||||||
"fs",
|
"fs",
|
||||||
"crypto",
|
"tls",
|
||||||
|
"net",
|
||||||
// ...builtins
|
// ...builtins
|
||||||
],
|
],
|
||||||
|
inject: ["./esbuild.injecthelper.mjs"],
|
||||||
format: "cjs",
|
format: "cjs",
|
||||||
watch: !prod,
|
watch: !prod,
|
||||||
target: "es2016",
|
target: "es2016",
|
||||||
@@ -46,6 +48,9 @@ esbuild
|
|||||||
"process.env.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`,
|
"process.env.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`,
|
||||||
"process.env.DEFAULT_ONEDRIVE_CLIENT_ID": `"${DEFAULT_ONEDRIVE_CLIENT_ID}"`,
|
"process.env.DEFAULT_ONEDRIVE_CLIENT_ID": `"${DEFAULT_ONEDRIVE_CLIENT_ID}"`,
|
||||||
"process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`,
|
"process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`,
|
||||||
|
global: "window",
|
||||||
|
"process.env.NODE_DEBUG": `undefined`, // ugly fix
|
||||||
|
"process.env.DEBUG": `undefined`, // ugly fix
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
.catch(() => process.exit(1));
|
.catch(() => process.exit(1));
|
||||||
|
|||||||
@@ -0,0 +1,2 @@
|
|||||||
|
export let Buffer = require("buffer").Buffer;
|
||||||
|
export let process = require("process/browser");
|
||||||
+2
-2
@@ -1,8 +1,8 @@
|
|||||||
{
|
{
|
||||||
"id": "remotely-save",
|
"id": "remotely-save",
|
||||||
"name": "Remotely Save",
|
"name": "Remotely Save",
|
||||||
"version": "0.2.14",
|
"version": "0.3.20",
|
||||||
"minAppVersion": "0.12.15",
|
"minAppVersion": "0.13.21",
|
||||||
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
||||||
"author": "fyears",
|
"author": "fyears",
|
||||||
"authorUrl": "https://github.com/fyears",
|
"authorUrl": "https://github.com/fyears",
|
||||||
|
|||||||
+49
-38
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "remotely-save",
|
"name": "remotely-save",
|
||||||
"version": "0.2.14",
|
"version": "0.3.20",
|
||||||
"description": "This is yet another sync plugin for Obsidian app.",
|
"description": "This is yet another sync plugin for Obsidian app.",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev2": "node esbuild.config.mjs",
|
"dev2": "node esbuild.config.mjs",
|
||||||
@@ -15,70 +15,81 @@
|
|||||||
"path": "path-browserify",
|
"path": "path-browserify",
|
||||||
"process": "process/browser",
|
"process": "process/browser",
|
||||||
"stream": "stream-browserify",
|
"stream": "stream-browserify",
|
||||||
"crypto": "crypto-browserify"
|
"crypto": "crypto-browserify",
|
||||||
|
"url": "url/"
|
||||||
},
|
},
|
||||||
"source": "main.ts",
|
"source": "main.ts",
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "",
|
"author": "",
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@microsoft/microsoft-graph-types": "^2.11.0",
|
"@microsoft/microsoft-graph-types": "^2.19.0",
|
||||||
"@types/chai": "^4.2.22",
|
"@types/chai": "^4.3.1",
|
||||||
"@types/chai-as-promised": "^7.1.4",
|
"@types/chai-as-promised": "^7.1.5",
|
||||||
"@types/feather-icons": "^4.7.0",
|
"@types/jsdom": "^16.2.14",
|
||||||
"@types/jsdom": "^16.2.13",
|
"@types/lodash": "^4.14.182",
|
||||||
"@types/lodash": "^4.14.178",
|
|
||||||
"@types/mime-types": "^2.1.1",
|
"@types/mime-types": "^2.1.1",
|
||||||
"@types/mocha": "^9.0.0",
|
"@types/mocha": "^9.1.1",
|
||||||
"@types/node": "^14.14.37",
|
"@types/mustache": "^4.1.2",
|
||||||
"@types/qrcode": "^1.4.1",
|
"@types/node": "^17.0.30",
|
||||||
|
"@types/qrcode": "^1.4.2",
|
||||||
"builtin-modules": "^3.2.0",
|
"builtin-modules": "^3.2.0",
|
||||||
"chai": "^4.3.4",
|
"chai": "^4.3.6",
|
||||||
"chai-as-promised": "^7.1.1",
|
"chai-as-promised": "^7.1.1",
|
||||||
"cross-env": "^7.0.3",
|
"cross-env": "^7.0.3",
|
||||||
"dotenv": "^10.0.0",
|
"dotenv": "^16.0.0",
|
||||||
"esbuild": "^0.14.3",
|
"esbuild": "^0.14.38",
|
||||||
"jsdom": "^19.0.0",
|
"jsdom": "^19.0.0",
|
||||||
"mocha": "^9.1.3",
|
"mocha": "^9.2.2",
|
||||||
"prettier": "^2.4.1",
|
"prettier": "^2.6.2",
|
||||||
"ts-loader": "^9.2.6",
|
"ts-loader": "^9.2.9",
|
||||||
"ts-node": "^10.4.0",
|
"ts-node": "^10.7.0",
|
||||||
"tslib": "^2.2.0",
|
"tslib": "^2.4.0",
|
||||||
"typescript": "^4.4.4",
|
"typescript": "^4.6.4",
|
||||||
"webdav-server": "^2.6.2",
|
"webdav-server": "^2.6.2",
|
||||||
"webpack": "^5.64.4",
|
"webpack": "^5.72.0",
|
||||||
"webpack-cli": "^4.9.1"
|
"webpack-cli": "^4.9.2"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@aws-sdk/client-s3": "^3.37.0",
|
"@aws-sdk/client-s3": "^3.81.0",
|
||||||
"@aws-sdk/lib-storage": "^3.40.1",
|
"@aws-sdk/fetch-http-handler": "^3.78.0",
|
||||||
"@aws-sdk/signature-v4-crt": "^3.37.0",
|
"@aws-sdk/lib-storage": "^3.81.0",
|
||||||
"@azure/msal-node": "^1.4.0",
|
"@aws-sdk/protocol-http": "^3.78.0",
|
||||||
|
"@aws-sdk/querystring-builder": "^3.78.0",
|
||||||
|
"@aws-sdk/signature-v4-crt": "^3.78.0",
|
||||||
|
"@aws-sdk/types": "^3.78.0",
|
||||||
|
"@azure/msal-node": "^1.8.0",
|
||||||
"@fyears/tsqueue": "^1.0.1",
|
"@fyears/tsqueue": "^1.0.1",
|
||||||
"@microsoft/microsoft-graph-client": "^3.0.1",
|
"@microsoft/microsoft-graph-client": "^3.0.2",
|
||||||
"acorn": "^8.5.0",
|
"acorn": "^8.7.1",
|
||||||
|
"aggregate-error": "^4.0.0",
|
||||||
"assert": "^2.0.0",
|
"assert": "^2.0.0",
|
||||||
"aws-crt": "^1.10.1",
|
"aws-crt": "^1.12.1",
|
||||||
"buffer": "^6.0.3",
|
"buffer": "^6.0.3",
|
||||||
"codemirror": "^5.63.1",
|
|
||||||
"crypto-browserify": "^3.12.0",
|
"crypto-browserify": "^3.12.0",
|
||||||
"dropbox": "^10.22.0",
|
"delay": "^5.0.0",
|
||||||
"feather-icons": "^4.28.0",
|
"dropbox": "^10.28.0",
|
||||||
|
"emoji-regex": "^10.1.0",
|
||||||
|
"http-status-codes": "^2.2.0",
|
||||||
"localforage": "^1.10.0",
|
"localforage": "^1.10.0",
|
||||||
"lodash": "^4.17.21",
|
"lodash": "^4.17.21",
|
||||||
"loglevel": "^1.8.0",
|
"loglevel": "^1.8.0",
|
||||||
"mime-types": "^2.1.33",
|
"lucide": "^0.35.0",
|
||||||
"nanoid": "^3.1.30",
|
"mime-types": "^2.1.35",
|
||||||
"obsidian": "^0.12.0",
|
"mustache": "^4.2.0",
|
||||||
|
"nanoid": "^3.3.3",
|
||||||
|
"obsidian": "^0.14.6",
|
||||||
|
"p-queue": "^7.2.0",
|
||||||
"path-browserify": "^1.0.1",
|
"path-browserify": "^1.0.1",
|
||||||
"process": "^0.11.10",
|
"process": "^0.11.10",
|
||||||
"qrcode": "^1.5.0",
|
"qrcode": "^1.5.0",
|
||||||
"rfc4648": "^1.5.0",
|
"rfc4648": "^1.5.1",
|
||||||
"rimraf": "^3.0.2",
|
"rimraf": "^3.0.2",
|
||||||
"stream-browserify": "^3.0.0",
|
"stream-browserify": "^3.0.0",
|
||||||
|
"url": "^0.11.0",
|
||||||
"util": "^0.12.4",
|
"util": "^0.12.4",
|
||||||
"webdav": "^4.7.0",
|
"webdav": "^4.9.0",
|
||||||
"webdav-fs": "^4.0.0",
|
"webdav-fs": "^4.0.1",
|
||||||
"xregexp": "^5.1.0"
|
"xregexp": "^5.1.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+89
-2
@@ -3,14 +3,27 @@
|
|||||||
* To avoid circular dependency.
|
* To avoid circular dependency.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
import { Platform, requireApiVersion } from "obsidian";
|
||||||
|
import type { LangType, LangTypeAndAuto } from "./i18n";
|
||||||
|
|
||||||
|
export const DEFAULT_CONTENT_TYPE = "application/octet-stream";
|
||||||
|
|
||||||
export type SUPPORTED_SERVICES_TYPE = "s3" | "webdav" | "dropbox" | "onedrive";
|
export type SUPPORTED_SERVICES_TYPE = "s3" | "webdav" | "dropbox" | "onedrive";
|
||||||
|
|
||||||
|
export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR =
|
||||||
|
| "webdav"
|
||||||
|
| "dropbox"
|
||||||
|
| "onedrive";
|
||||||
|
|
||||||
export interface S3Config {
|
export interface S3Config {
|
||||||
s3Endpoint: string;
|
s3Endpoint: string;
|
||||||
s3Region: string;
|
s3Region: string;
|
||||||
s3AccessKeyID: string;
|
s3AccessKeyID: string;
|
||||||
s3SecretAccessKey: string;
|
s3SecretAccessKey: string;
|
||||||
s3BucketName: string;
|
s3BucketName: string;
|
||||||
|
bypassCorsLocally?: boolean;
|
||||||
|
partsConcurrency?: number;
|
||||||
|
forcePathStyle?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface DropboxConfig {
|
export interface DropboxConfig {
|
||||||
@@ -22,16 +35,25 @@ export interface DropboxConfig {
|
|||||||
accountID: string;
|
accountID: string;
|
||||||
username: string;
|
username: string;
|
||||||
credentialsShouldBeDeletedAtTime?: number;
|
credentialsShouldBeDeletedAtTime?: number;
|
||||||
|
remoteBaseDir?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type WebdavAuthType = "digest" | "basic";
|
export type WebdavAuthType = "digest" | "basic";
|
||||||
|
export type WebdavDepthType =
|
||||||
|
| "auto_unknown"
|
||||||
|
| "auto_1"
|
||||||
|
| "auto_infinity"
|
||||||
|
| "manual_1"
|
||||||
|
| "manual_infinity";
|
||||||
|
|
||||||
export interface WebdavConfig {
|
export interface WebdavConfig {
|
||||||
address: string;
|
address: string;
|
||||||
username: string;
|
username: string;
|
||||||
password: string;
|
password: string;
|
||||||
authType: WebdavAuthType;
|
authType: WebdavAuthType;
|
||||||
manualRecursive: boolean;
|
manualRecursive: boolean; // deprecated in 0.3.6, use depth
|
||||||
|
depth?: WebdavDepthType;
|
||||||
|
remoteBaseDir?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface OnedriveConfig {
|
export interface OnedriveConfig {
|
||||||
@@ -44,6 +66,7 @@ export interface OnedriveConfig {
|
|||||||
deltaLink: string;
|
deltaLink: string;
|
||||||
username: string;
|
username: string;
|
||||||
credentialsShouldBeDeletedAtTime?: number;
|
credentialsShouldBeDeletedAtTime?: number;
|
||||||
|
remoteBaseDir?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface RemotelySavePluginSettings {
|
export interface RemotelySavePluginSettings {
|
||||||
@@ -54,8 +77,19 @@ export interface RemotelySavePluginSettings {
|
|||||||
password: string;
|
password: string;
|
||||||
serviceType: SUPPORTED_SERVICES_TYPE;
|
serviceType: SUPPORTED_SERVICES_TYPE;
|
||||||
currLogLevel?: string;
|
currLogLevel?: string;
|
||||||
vaultRandomID?: string;
|
|
||||||
autoRunEveryMilliseconds?: number;
|
autoRunEveryMilliseconds?: number;
|
||||||
|
initRunAfterMilliseconds?: number;
|
||||||
|
agreeToUploadExtraMetadata?: boolean;
|
||||||
|
concurrency?: number;
|
||||||
|
syncConfigDir?: boolean;
|
||||||
|
syncUnderscoreItems?: boolean;
|
||||||
|
lang?: LangTypeAndAuto;
|
||||||
|
logToDB?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
|
vaultRandomID?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface RemoteItem {
|
export interface RemoteItem {
|
||||||
@@ -80,3 +114,56 @@ export interface UriParams {
|
|||||||
|
|
||||||
// 80 days
|
// 80 days
|
||||||
export const OAUTH2_FORCE_EXPIRE_MILLISECONDS = 1000 * 60 * 60 * 24 * 80;
|
export const OAUTH2_FORCE_EXPIRE_MILLISECONDS = 1000 * 60 * 60 * 24 * 80;
|
||||||
|
|
||||||
|
type DecisionTypeForFile =
|
||||||
|
| "skipUploading" // special, mtimeLocal === mtimeRemote
|
||||||
|
| "uploadLocalDelHistToRemote" // "delLocalIfExists && delRemoteIfExists && cleanLocalDelHist && uploadLocalDelHistToRemote"
|
||||||
|
| "keepRemoteDelHist" // "delLocalIfExists && delRemoteIfExists && cleanLocalDelHist && keepRemoteDelHist"
|
||||||
|
| "uploadLocalToRemote" // "skipLocal && uploadLocalToRemote && cleanLocalDelHist && cleanRemoteDelHist"
|
||||||
|
| "downloadRemoteToLocal"; // "downloadRemoteToLocal && skipRemote && cleanLocalDelHist && cleanRemoteDelHist"
|
||||||
|
|
||||||
|
type DecisionTypeForFolder =
|
||||||
|
| "createFolder"
|
||||||
|
| "uploadLocalDelHistToRemoteFolder"
|
||||||
|
| "keepRemoteDelHistFolder"
|
||||||
|
| "skipFolder";
|
||||||
|
|
||||||
|
export type DecisionType = DecisionTypeForFile | DecisionTypeForFolder;
|
||||||
|
|
||||||
|
export interface FileOrFolderMixedState {
|
||||||
|
key: string;
|
||||||
|
existLocal?: boolean;
|
||||||
|
existRemote?: boolean;
|
||||||
|
mtimeLocal?: number;
|
||||||
|
mtimeRemote?: number;
|
||||||
|
deltimeLocal?: number;
|
||||||
|
deltimeRemote?: number;
|
||||||
|
sizeLocal?: number;
|
||||||
|
sizeRemote?: number;
|
||||||
|
changeRemoteMtimeUsingMapping?: boolean;
|
||||||
|
changeLocalMtimeUsingMapping?: boolean;
|
||||||
|
decision?: DecisionType;
|
||||||
|
decisionBranch?: number;
|
||||||
|
syncDone?: "done";
|
||||||
|
remoteEncryptedKey?: string;
|
||||||
|
|
||||||
|
mtimeLocalFmt?: string;
|
||||||
|
mtimeRemoteFmt?: string;
|
||||||
|
deltimeLocalFmt?: string;
|
||||||
|
deltimeRemoteFmt?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const API_VER_STAT_FOLDER = "0.13.27";
|
||||||
|
export const API_VER_REQURL = "0.13.26"; // desktop ver 0.13.26, iOS ver 1.1.1
|
||||||
|
export const API_VER_REQURL_ANDROID = "0.14.6"; // Android ver 1.2.1
|
||||||
|
|
||||||
|
export const VALID_REQURL =
|
||||||
|
(!Platform.isAndroidApp && requireApiVersion(API_VER_REQURL)) ||
|
||||||
|
(Platform.isAndroidApp && requireApiVersion(API_VER_REQURL_ANDROID));
|
||||||
|
|
||||||
|
export const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
|
||||||
|
export const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX =
|
||||||
|
"sync_plans_hist_exported_on_";
|
||||||
|
export const DEFAULT_LOG_HISTORY_FILE_PREFIX = "log_hist_exported_on_";
|
||||||
|
|
||||||
|
export type SyncTriggerSourceType = "manual" | "auto" | "dry" | "autoOnceInit";
|
||||||
|
|||||||
+9
-10
@@ -3,11 +3,10 @@ import { reverseString } from "./misc";
|
|||||||
|
|
||||||
import type { RemotelySavePluginSettings } from "./baseTypes";
|
import type { RemotelySavePluginSettings } from "./baseTypes";
|
||||||
|
|
||||||
import * as origLog from "loglevel";
|
import { log } from "./moreOnLog";
|
||||||
const log = origLog.getLogger("rs-default");
|
|
||||||
|
|
||||||
const DEFAULT_README: string =
|
const DEFAULT_README: string =
|
||||||
"Do NOT modify this manually. It's generated automatically.";
|
"The file contains sensitive info, so DO NOT take screenshot of, copy, or share it to anyone! It's also generated automatically, so do not edit it manually.";
|
||||||
|
|
||||||
interface MessyConfigType {
|
interface MessyConfigType {
|
||||||
readme: string;
|
readme: string;
|
||||||
@@ -20,8 +19,8 @@ interface MessyConfigType {
|
|||||||
export const messyConfigToNormal = (
|
export const messyConfigToNormal = (
|
||||||
x: MessyConfigType | RemotelySavePluginSettings | null | undefined
|
x: MessyConfigType | RemotelySavePluginSettings | null | undefined
|
||||||
): RemotelySavePluginSettings | null | undefined => {
|
): RemotelySavePluginSettings | null | undefined => {
|
||||||
log.debug("loading, original config on disk:");
|
// log.debug("loading, original config on disk:");
|
||||||
log.debug(x);
|
// log.debug(x);
|
||||||
if (x === null || x === undefined) {
|
if (x === null || x === undefined) {
|
||||||
log.debug("the messy config is null or undefined, skip");
|
log.debug("the messy config is null or undefined, skip");
|
||||||
return x as any;
|
return x as any;
|
||||||
@@ -36,12 +35,12 @@ export const messyConfigToNormal = (
|
|||||||
}) as Buffer
|
}) as Buffer
|
||||||
).toString("utf-8")
|
).toString("utf-8")
|
||||||
);
|
);
|
||||||
log.debug("loading, parsed config is:");
|
// log.debug("loading, parsed config is:");
|
||||||
log.debug(y);
|
// log.debug(y);
|
||||||
return y;
|
return y;
|
||||||
} else {
|
} else {
|
||||||
// return as is
|
// return as is
|
||||||
log.debug("loading, parsed config is the same");
|
// log.debug("loading, parsed config is the same");
|
||||||
return x;
|
return x;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
@@ -64,7 +63,7 @@ export const normalConfigToMessy = (
|
|||||||
})
|
})
|
||||||
),
|
),
|
||||||
};
|
};
|
||||||
log.debug("encoding, encoded config is:");
|
// log.debug("encoding, encoded config is:");
|
||||||
log.debug(y);
|
// log.debug(y);
|
||||||
return y;
|
return y;
|
||||||
};
|
};
|
||||||
|
|||||||
+103
-9
@@ -1,20 +1,83 @@
|
|||||||
import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
|
import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
|
||||||
|
|
||||||
import type { SyncPlanType } from "./sync";
|
import type { SyncPlanType } from "./sync";
|
||||||
import { readAllSyncPlanRecordTextsByVault } from "./localdb";
|
import {
|
||||||
|
readAllSyncPlanRecordTextsByVault,
|
||||||
|
readAllLogRecordTextsByVault,
|
||||||
|
} from "./localdb";
|
||||||
import type { InternalDBs } from "./localdb";
|
import type { InternalDBs } from "./localdb";
|
||||||
import { mkdirpInVault } from "./misc";
|
import { mkdirpInVault } from "./misc";
|
||||||
|
import {
|
||||||
|
DEFAULT_DEBUG_FOLDER,
|
||||||
|
DEFAULT_LOG_HISTORY_FILE_PREFIX,
|
||||||
|
DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX,
|
||||||
|
FileOrFolderMixedState,
|
||||||
|
} from "./baseTypes";
|
||||||
|
|
||||||
import * as origLog from "loglevel";
|
import { log } from "./moreOnLog";
|
||||||
const log = origLog.getLogger("rs-default");
|
|
||||||
|
|
||||||
const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
|
const turnSyncPlanToTable = (record: string) => {
|
||||||
const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX = "sync_plans_hist_exported_on_";
|
const syncPlan: SyncPlanType = JSON.parse(record);
|
||||||
|
const { ts, tsFmt, remoteType, mixedStates } = syncPlan;
|
||||||
|
|
||||||
|
type allowedHeadersType = keyof FileOrFolderMixedState;
|
||||||
|
const headers: allowedHeadersType[] = [
|
||||||
|
"key",
|
||||||
|
"remoteEncryptedKey",
|
||||||
|
"existLocal",
|
||||||
|
"sizeLocal",
|
||||||
|
"mtimeLocal",
|
||||||
|
"deltimeLocal",
|
||||||
|
"changeLocalMtimeUsingMapping",
|
||||||
|
"existRemote",
|
||||||
|
"sizeRemote",
|
||||||
|
"mtimeRemote",
|
||||||
|
"deltimeRemote",
|
||||||
|
"changeRemoteMtimeUsingMapping",
|
||||||
|
"decision",
|
||||||
|
"decisionBranch",
|
||||||
|
];
|
||||||
|
|
||||||
|
const lines = [
|
||||||
|
`ts: ${ts}${tsFmt !== undefined ? " / " + tsFmt : ""}`,
|
||||||
|
`remoteType: ${remoteType}`,
|
||||||
|
`| ${headers.join(" | ")} |`,
|
||||||
|
`| ${headers.map((x) => "---").join(" | ")} |`,
|
||||||
|
];
|
||||||
|
for (const [k1, v1] of Object.entries(syncPlan.mixedStates)) {
|
||||||
|
const k = k1 as string;
|
||||||
|
const v = v1 as FileOrFolderMixedState;
|
||||||
|
const singleLine = [];
|
||||||
|
for (const h of headers) {
|
||||||
|
const field = v[h];
|
||||||
|
if (field === undefined) {
|
||||||
|
singleLine.push("");
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
h === "mtimeLocal" ||
|
||||||
|
h === "deltimeLocal" ||
|
||||||
|
h === "mtimeRemote" ||
|
||||||
|
h === "deltimeRemote"
|
||||||
|
) {
|
||||||
|
const fmt = v[(h + "Fmt") as allowedHeadersType] as string;
|
||||||
|
const s = `${field}${fmt !== undefined ? " / " + fmt : ""}`;
|
||||||
|
singleLine.push(s);
|
||||||
|
} else {
|
||||||
|
singleLine.push(field);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
lines.push(`| ${singleLine.join(" | ")} |`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return lines.join("\n");
|
||||||
|
};
|
||||||
|
|
||||||
export const exportVaultSyncPlansToFiles = async (
|
export const exportVaultSyncPlansToFiles = async (
|
||||||
db: InternalDBs,
|
db: InternalDBs,
|
||||||
vault: Vault,
|
vault: Vault,
|
||||||
vaultRandomID: string
|
vaultRandomID: string,
|
||||||
|
toFormat: "table" | "json" = "json"
|
||||||
) => {
|
) => {
|
||||||
log.info("exporting");
|
log.info("exporting");
|
||||||
await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
|
await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
|
||||||
@@ -23,9 +86,16 @@ export const exportVaultSyncPlansToFiles = async (
|
|||||||
if (records.length === 0) {
|
if (records.length === 0) {
|
||||||
md = "No sync plans history found";
|
md = "No sync plans history found";
|
||||||
} else {
|
} else {
|
||||||
md =
|
if (toFormat === "json") {
|
||||||
"Sync plans found:\n\n" +
|
md =
|
||||||
records.map((x) => "```json\n" + x + "\n```\n").join("\n");
|
"Sync plans found:\n\n" +
|
||||||
|
records.map((x) => "```json\n" + x + "\n```\n").join("\n");
|
||||||
|
} else if (toFormat === "table") {
|
||||||
|
md =
|
||||||
|
"Sync plans found:\n\n" + records.map(turnSyncPlanToTable).join("\n\n");
|
||||||
|
} else {
|
||||||
|
const _: never = toFormat;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
const ts = Date.now();
|
const ts = Date.now();
|
||||||
const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX}${ts}.md`;
|
const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX}${ts}.md`;
|
||||||
@@ -34,3 +104,27 @@ export const exportVaultSyncPlansToFiles = async (
|
|||||||
});
|
});
|
||||||
log.info("finish exporting");
|
log.info("finish exporting");
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const exportVaultLoggerOutputToFiles = async (
|
||||||
|
db: InternalDBs,
|
||||||
|
vault: Vault,
|
||||||
|
vaultRandomID: string
|
||||||
|
) => {
|
||||||
|
await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
|
||||||
|
const records = await readAllLogRecordTextsByVault(db, vaultRandomID);
|
||||||
|
let md = "";
|
||||||
|
if (records.length === 0) {
|
||||||
|
md = "No logger history found.";
|
||||||
|
} else {
|
||||||
|
md =
|
||||||
|
"Logger history found:\n\n" +
|
||||||
|
"```text\n" +
|
||||||
|
records.join("\n") +
|
||||||
|
"\n```\n";
|
||||||
|
}
|
||||||
|
const ts = Date.now();
|
||||||
|
const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_LOG_HISTORY_FILE_PREFIX}${ts}.md`;
|
||||||
|
await vault.create(filePath, md, {
|
||||||
|
mtime: ts,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|||||||
+21
-2
@@ -1,8 +1,7 @@
|
|||||||
import { base32, base64url } from "rfc4648";
|
import { base32, base64url } from "rfc4648";
|
||||||
import { bufferToArrayBuffer, hexStringToTypedArray } from "./misc";
|
import { bufferToArrayBuffer, hexStringToTypedArray } from "./misc";
|
||||||
|
|
||||||
import * as origLog from "loglevel";
|
import { log } from "./moreOnLog";
|
||||||
const log = origLog.getLogger("rs-default");
|
|
||||||
|
|
||||||
const DEFAULT_ITER = 20000;
|
const DEFAULT_ITER = 20000;
|
||||||
|
|
||||||
@@ -165,3 +164,23 @@ export const decryptBase64urlToString = async (
|
|||||||
)
|
)
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const getSizeFromOrigToEnc = (x: number) => {
|
||||||
|
if (x < 0 || !Number.isInteger(x)) {
|
||||||
|
throw Error(`x=${x} is not a valid size`);
|
||||||
|
}
|
||||||
|
return (Math.floor(x / 16) + 1) * 16 + 16;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getSizeFromEncToOrig = (x: number) => {
|
||||||
|
if (x < 32 || !Number.isInteger(x)) {
|
||||||
|
throw Error(`${x} is not a valid size`);
|
||||||
|
}
|
||||||
|
if (x % 16 !== 0) {
|
||||||
|
throw Error(`${x} is not a valid encrypted file size`);
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
minSize: ((x - 16) / 16 - 1) * 16,
|
||||||
|
maxSize: ((x - 16) / 16 - 1) * 16 + 15,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|||||||
+44
@@ -0,0 +1,44 @@
|
|||||||
|
import Mustache from "mustache";
|
||||||
|
import { moment } from "obsidian";
|
||||||
|
|
||||||
|
import { LANGS } from "./langs";
|
||||||
|
|
||||||
|
export type LangType = keyof typeof LANGS;
|
||||||
|
export type LangTypeAndAuto = LangType | "auto";
|
||||||
|
export type TransItemType = keyof typeof LANGS["en"];
|
||||||
|
|
||||||
|
export class I18n {
|
||||||
|
lang: LangTypeAndAuto;
|
||||||
|
readonly saveSettingFunc: (tolang: LangTypeAndAuto) => Promise<void>;
|
||||||
|
constructor(
|
||||||
|
lang: LangTypeAndAuto,
|
||||||
|
saveSettingFunc: (tolang: LangTypeAndAuto) => Promise<void>
|
||||||
|
) {
|
||||||
|
this.lang = lang;
|
||||||
|
this.saveSettingFunc = saveSettingFunc;
|
||||||
|
}
|
||||||
|
async changeTo(anotherLang: LangTypeAndAuto) {
|
||||||
|
this.lang = anotherLang;
|
||||||
|
await this.saveSettingFunc(anotherLang);
|
||||||
|
}
|
||||||
|
|
||||||
|
_get(key: TransItemType) {
|
||||||
|
let realLang = this.lang;
|
||||||
|
if (this.lang === "auto" && moment.locale().replace("-", "_") in LANGS) {
|
||||||
|
realLang = moment.locale().replace("-", "_") as LangType;
|
||||||
|
} else {
|
||||||
|
realLang = "en";
|
||||||
|
}
|
||||||
|
|
||||||
|
const res: string =
|
||||||
|
(LANGS[realLang] as typeof LANGS["en"])[key] || LANGS["en"][key] || key;
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
t(key: TransItemType, vars?: Record<string, string>) {
|
||||||
|
if (vars === undefined) {
|
||||||
|
return this._get(key);
|
||||||
|
}
|
||||||
|
return Mustache.render(this._get(key), vars);
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
-2
@@ -7,8 +7,7 @@ import {
|
|||||||
RemotelySavePluginSettings,
|
RemotelySavePluginSettings,
|
||||||
} from "./baseTypes";
|
} from "./baseTypes";
|
||||||
|
|
||||||
import * as origLog from "loglevel";
|
import { log } from "./moreOnLog";
|
||||||
const log = origLog.getLogger("rs-default");
|
|
||||||
|
|
||||||
export const exportQrCodeUri = async (
|
export const exportQrCodeUri = async (
|
||||||
settings: RemotelySavePluginSettings,
|
settings: RemotelySavePluginSettings,
|
||||||
|
|||||||
Submodule
+1
Submodule src/langs added at 82d0619761
+304
-38
@@ -1,21 +1,23 @@
|
|||||||
import localforage from "localforage";
|
import localforage from "localforage";
|
||||||
import { TAbstractFile, TFile, TFolder } from "obsidian";
|
|
||||||
|
|
||||||
import type { SUPPORTED_SERVICES_TYPE } from "./baseTypes";
|
|
||||||
import type { SyncPlanType } from "./sync";
|
|
||||||
|
|
||||||
export type LocalForage = typeof localforage;
|
export type LocalForage = typeof localforage;
|
||||||
|
import { nanoid } from "nanoid";
|
||||||
|
import { requireApiVersion, TAbstractFile, TFile, TFolder } from "obsidian";
|
||||||
|
|
||||||
import * as origLog from "loglevel";
|
import { API_VER_STAT_FOLDER, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
|
||||||
const log = origLog.getLogger("rs-default");
|
import type { SyncPlanType } from "./sync";
|
||||||
|
import { toText, unixTimeToStr } from "./misc";
|
||||||
|
|
||||||
const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108];
|
import { log } from "./moreOnLog";
|
||||||
export const DEFAULT_DB_VERSION_NUMBER: number = 20220108;
|
|
||||||
|
const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108, 20220326];
|
||||||
|
export const DEFAULT_DB_VERSION_NUMBER: number = 20220326;
|
||||||
export const DEFAULT_DB_NAME = "remotelysavedb";
|
export const DEFAULT_DB_NAME = "remotelysavedb";
|
||||||
export const DEFAULT_TBL_VERSION = "schemaversion";
|
export const DEFAULT_TBL_VERSION = "schemaversion";
|
||||||
export const DEFAULT_TBL_DELETE_HISTORY = "filefolderoperationhistory";
|
export const DEFAULT_TBL_FILE_HISTORY = "filefolderoperationhistory";
|
||||||
export const DEFAULT_TBL_SYNC_MAPPING = "syncmetadatahistory";
|
export const DEFAULT_TBL_SYNC_MAPPING = "syncmetadatahistory";
|
||||||
export const DEFAULT_SYNC_PLANS_HISTORY = "syncplanshistory";
|
export const DEFAULT_SYNC_PLANS_HISTORY = "syncplanshistory";
|
||||||
|
export const DEFAULT_TBL_VAULT_RANDOM_ID_MAPPING = "vaultrandomidmapping";
|
||||||
|
export const DEFAULT_TBL_LOGGER_OUTPUT = "loggeroutput";
|
||||||
|
|
||||||
export interface FileFolderHistoryRecord {
|
export interface FileFolderHistoryRecord {
|
||||||
key: string;
|
key: string;
|
||||||
@@ -23,7 +25,7 @@ export interface FileFolderHistoryRecord {
|
|||||||
mtime: number;
|
mtime: number;
|
||||||
size: number;
|
size: number;
|
||||||
actionWhen: number;
|
actionWhen: number;
|
||||||
actionType: "delete" | "rename";
|
actionType: "delete" | "rename" | "renameDestination";
|
||||||
keyType: "folder" | "file";
|
keyType: "folder" | "file";
|
||||||
renameTo: string;
|
renameTo: string;
|
||||||
vaultRandomID: string;
|
vaultRandomID: string;
|
||||||
@@ -51,9 +53,11 @@ interface SyncPlanRecord {
|
|||||||
|
|
||||||
export interface InternalDBs {
|
export interface InternalDBs {
|
||||||
versionTbl: LocalForage;
|
versionTbl: LocalForage;
|
||||||
deleteHistoryTbl: LocalForage;
|
fileHistoryTbl: LocalForage;
|
||||||
syncMappingTbl: LocalForage;
|
syncMappingTbl: LocalForage;
|
||||||
syncPlansTbl: LocalForage;
|
syncPlansTbl: LocalForage;
|
||||||
|
vaultRandomIDMappingTbl: LocalForage;
|
||||||
|
loggerOutputTbl: LocalForage;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -72,12 +76,12 @@ const migrateDBsFrom20211114To20220108 = async (
|
|||||||
const allPromisesToWait: Promise<any>[] = [];
|
const allPromisesToWait: Promise<any>[] = [];
|
||||||
|
|
||||||
log.debug("assign vault id to any delete history");
|
log.debug("assign vault id to any delete history");
|
||||||
const keysInDeleteHistoryTbl = await db.deleteHistoryTbl.keys();
|
const keysInDeleteHistoryTbl = await db.fileHistoryTbl.keys();
|
||||||
for (const key of keysInDeleteHistoryTbl) {
|
for (const key of keysInDeleteHistoryTbl) {
|
||||||
if (key.startsWith(vaultRandomID)) {
|
if (key.startsWith(vaultRandomID)) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
const value = (await db.deleteHistoryTbl.getItem(
|
const value = (await db.fileHistoryTbl.getItem(
|
||||||
key
|
key
|
||||||
)) as FileFolderHistoryRecord;
|
)) as FileFolderHistoryRecord;
|
||||||
if (value === null || value === undefined) {
|
if (value === null || value === undefined) {
|
||||||
@@ -87,8 +91,8 @@ const migrateDBsFrom20211114To20220108 = async (
|
|||||||
value.vaultRandomID = vaultRandomID;
|
value.vaultRandomID = vaultRandomID;
|
||||||
}
|
}
|
||||||
const newKey = `${vaultRandomID}\t${key}`;
|
const newKey = `${vaultRandomID}\t${key}`;
|
||||||
allPromisesToWait.push(db.deleteHistoryTbl.setItem(newKey, value));
|
allPromisesToWait.push(db.fileHistoryTbl.setItem(newKey, value));
|
||||||
allPromisesToWait.push(db.deleteHistoryTbl.removeItem(key));
|
allPromisesToWait.push(db.fileHistoryTbl.removeItem(key));
|
||||||
}
|
}
|
||||||
|
|
||||||
log.debug("assign vault id to any sync mapping");
|
log.debug("assign vault id to any sync mapping");
|
||||||
@@ -136,6 +140,23 @@ const migrateDBsFrom20211114To20220108 = async (
|
|||||||
log.debug(`finish upgrading internal db from ${oldVer} to ${newVer}`);
|
log.debug(`finish upgrading internal db from ${oldVer} to ${newVer}`);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* no need to do anything except changing version
|
||||||
|
* we just add more file operations in db, and no schema is changed.
|
||||||
|
* @param db
|
||||||
|
* @param vaultRandomID
|
||||||
|
*/
|
||||||
|
const migrateDBsFrom20220108To20220326 = async (
|
||||||
|
db: InternalDBs,
|
||||||
|
vaultRandomID: string
|
||||||
|
) => {
|
||||||
|
const oldVer = 20220108;
|
||||||
|
const newVer = 20220326;
|
||||||
|
log.debug(`start upgrading internal db from ${oldVer} to ${newVer}`);
|
||||||
|
await db.versionTbl.setItem("version", newVer);
|
||||||
|
log.debug(`finish upgrading internal db from ${oldVer} to ${newVer}`);
|
||||||
|
};
|
||||||
|
|
||||||
const migrateDBs = async (
|
const migrateDBs = async (
|
||||||
db: InternalDBs,
|
db: InternalDBs,
|
||||||
oldVer: number,
|
oldVer: number,
|
||||||
@@ -148,19 +169,36 @@ const migrateDBs = async (
|
|||||||
if (oldVer === 20211114 && newVer === 20220108) {
|
if (oldVer === 20211114 && newVer === 20220108) {
|
||||||
return await migrateDBsFrom20211114To20220108(db, vaultRandomID);
|
return await migrateDBsFrom20211114To20220108(db, vaultRandomID);
|
||||||
}
|
}
|
||||||
|
if (oldVer === 20220108 && newVer === 20220326) {
|
||||||
|
return await migrateDBsFrom20220108To20220326(db, vaultRandomID);
|
||||||
|
}
|
||||||
|
if (oldVer === 20211114 && newVer === 20220326) {
|
||||||
|
// TODO: more steps with more versions in the future
|
||||||
|
await migrateDBsFrom20211114To20220108(db, vaultRandomID);
|
||||||
|
await migrateDBsFrom20220108To20220326(db, vaultRandomID);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (newVer < oldVer) {
|
||||||
|
throw Error(
|
||||||
|
"You've installed a new version, but then downgrade to an old version. Stop working!"
|
||||||
|
);
|
||||||
|
}
|
||||||
// not implemented
|
// not implemented
|
||||||
throw Error(`not supported internal db changes from ${oldVer} to ${newVer}`);
|
throw Error(`not supported internal db changes from ${oldVer} to ${newVer}`);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const prepareDBs = async (vaultRandomID: string) => {
|
export const prepareDBs = async (
|
||||||
|
vaultBasePath: string,
|
||||||
|
vaultRandomIDFromOldConfigFile: string
|
||||||
|
) => {
|
||||||
const db = {
|
const db = {
|
||||||
versionTbl: localforage.createInstance({
|
versionTbl: localforage.createInstance({
|
||||||
name: DEFAULT_DB_NAME,
|
name: DEFAULT_DB_NAME,
|
||||||
storeName: DEFAULT_TBL_VERSION,
|
storeName: DEFAULT_TBL_VERSION,
|
||||||
}),
|
}),
|
||||||
deleteHistoryTbl: localforage.createInstance({
|
fileHistoryTbl: localforage.createInstance({
|
||||||
name: DEFAULT_DB_NAME,
|
name: DEFAULT_DB_NAME,
|
||||||
storeName: DEFAULT_TBL_DELETE_HISTORY,
|
storeName: DEFAULT_TBL_FILE_HISTORY,
|
||||||
}),
|
}),
|
||||||
syncMappingTbl: localforage.createInstance({
|
syncMappingTbl: localforage.createInstance({
|
||||||
name: DEFAULT_DB_NAME,
|
name: DEFAULT_DB_NAME,
|
||||||
@@ -170,9 +208,46 @@ export const prepareDBs = async (vaultRandomID: string) => {
|
|||||||
name: DEFAULT_DB_NAME,
|
name: DEFAULT_DB_NAME,
|
||||||
storeName: DEFAULT_SYNC_PLANS_HISTORY,
|
storeName: DEFAULT_SYNC_PLANS_HISTORY,
|
||||||
}),
|
}),
|
||||||
|
vaultRandomIDMappingTbl: localforage.createInstance({
|
||||||
|
name: DEFAULT_DB_NAME,
|
||||||
|
storeName: DEFAULT_TBL_VAULT_RANDOM_ID_MAPPING,
|
||||||
|
}),
|
||||||
|
loggerOutputTbl: localforage.createInstance({
|
||||||
|
name: DEFAULT_DB_NAME,
|
||||||
|
storeName: DEFAULT_TBL_LOGGER_OUTPUT,
|
||||||
|
}),
|
||||||
} as InternalDBs;
|
} as InternalDBs;
|
||||||
|
|
||||||
const originalVersion = (await db.versionTbl.getItem("version")) as number;
|
// try to get vaultRandomID firstly
|
||||||
|
let vaultRandomID = "";
|
||||||
|
const vaultRandomIDInDB: string | null =
|
||||||
|
await db.vaultRandomIDMappingTbl.getItem(`path2id\t${vaultBasePath}`);
|
||||||
|
if (vaultRandomIDInDB === null) {
|
||||||
|
if (vaultRandomIDFromOldConfigFile !== "") {
|
||||||
|
// reuse the old config id
|
||||||
|
vaultRandomID = vaultRandomIDFromOldConfigFile;
|
||||||
|
} else {
|
||||||
|
// no old config id, we create a random one
|
||||||
|
vaultRandomID = nanoid();
|
||||||
|
}
|
||||||
|
// save the id back
|
||||||
|
await db.vaultRandomIDMappingTbl.setItem(
|
||||||
|
`path2id\t${vaultBasePath}`,
|
||||||
|
vaultRandomID
|
||||||
|
);
|
||||||
|
await db.vaultRandomIDMappingTbl.setItem(
|
||||||
|
`id2path\t${vaultRandomID}`,
|
||||||
|
vaultBasePath
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
vaultRandomID = vaultRandomIDInDB;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (vaultRandomID === "") {
|
||||||
|
throw Error("no vaultRandomID found or generated");
|
||||||
|
}
|
||||||
|
|
||||||
|
const originalVersion: number | null = await db.versionTbl.getItem("version");
|
||||||
if (originalVersion === null) {
|
if (originalVersion === null) {
|
||||||
log.debug(
|
log.debug(
|
||||||
`no internal db version, setting it to ${DEFAULT_DB_VERSION_NUMBER}`
|
`no internal db version, setting it to ${DEFAULT_DB_VERSION_NUMBER}`
|
||||||
@@ -193,7 +268,10 @@ export const prepareDBs = async (vaultRandomID: string) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
log.info("db connected");
|
log.info("db connected");
|
||||||
return db;
|
return {
|
||||||
|
db: db,
|
||||||
|
vaultRandomID: vaultRandomID,
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
export const destroyDBs = async () => {
|
export const destroyDBs = async () => {
|
||||||
@@ -206,20 +284,20 @@ export const destroyDBs = async () => {
|
|||||||
log.info("db deleted");
|
log.info("db deleted");
|
||||||
};
|
};
|
||||||
req.onblocked = (event) => {
|
req.onblocked = (event) => {
|
||||||
console.warn("trying to delete db but it was blocked");
|
log.warn("trying to delete db but it was blocked");
|
||||||
};
|
};
|
||||||
req.onerror = (event) => {
|
req.onerror = (event) => {
|
||||||
console.error("tried to delete db but something bad!");
|
log.error("tried to delete db but something goes wrong!");
|
||||||
console.error(event);
|
log.error(event);
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
export const loadDeleteRenameHistoryTableByVault = async (
|
export const loadFileHistoryTableByVault = async (
|
||||||
db: InternalDBs,
|
db: InternalDBs,
|
||||||
vaultRandomID: string
|
vaultRandomID: string
|
||||||
) => {
|
) => {
|
||||||
const records = [] as FileFolderHistoryRecord[];
|
const records = [] as FileFolderHistoryRecord[];
|
||||||
await db.deleteHistoryTbl.iterate((value, key, iterationNumber) => {
|
await db.fileHistoryTbl.iterate((value, key, iterationNumber) => {
|
||||||
if (key.startsWith(`${vaultRandomID}\t`)) {
|
if (key.startsWith(`${vaultRandomID}\t`)) {
|
||||||
records.push(value as FileFolderHistoryRecord);
|
records.push(value as FileFolderHistoryRecord);
|
||||||
}
|
}
|
||||||
@@ -233,7 +311,16 @@ export const clearDeleteRenameHistoryOfKeyAndVault = async (
|
|||||||
key: string,
|
key: string,
|
||||||
vaultRandomID: string
|
vaultRandomID: string
|
||||||
) => {
|
) => {
|
||||||
await db.deleteHistoryTbl.removeItem(`${vaultRandomID}\t${key}`);
|
const fullKey = `${vaultRandomID}\t${key}`;
|
||||||
|
const item: FileFolderHistoryRecord | null = await db.fileHistoryTbl.getItem(
|
||||||
|
fullKey
|
||||||
|
);
|
||||||
|
if (
|
||||||
|
item !== null &&
|
||||||
|
(item.actionType === "delete" || item.actionType === "rename")
|
||||||
|
) {
|
||||||
|
await db.fileHistoryTbl.removeItem(fullKey);
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
export const insertDeleteRecordByVault = async (
|
export const insertDeleteRecordByVault = async (
|
||||||
@@ -260,10 +347,12 @@ export const insertDeleteRecordByVault = async (
|
|||||||
const key = fileOrFolder.path.endsWith("/")
|
const key = fileOrFolder.path.endsWith("/")
|
||||||
? fileOrFolder.path
|
? fileOrFolder.path
|
||||||
: `${fileOrFolder.path}/`;
|
: `${fileOrFolder.path}/`;
|
||||||
|
const ctime = 0; // they are deleted, so no way to get ctime, mtime
|
||||||
|
const mtime = 0; // they are deleted, so no way to get ctime, mtime
|
||||||
k = {
|
k = {
|
||||||
key: key,
|
key: key,
|
||||||
ctime: 0,
|
ctime: ctime,
|
||||||
mtime: 0,
|
mtime: mtime,
|
||||||
size: 0,
|
size: 0,
|
||||||
actionWhen: Date.now(),
|
actionWhen: Date.now(),
|
||||||
actionType: "delete",
|
actionType: "delete",
|
||||||
@@ -272,9 +361,19 @@ export const insertDeleteRecordByVault = async (
|
|||||||
vaultRandomID: vaultRandomID,
|
vaultRandomID: vaultRandomID,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
await db.deleteHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
|
await db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A file/folder is renamed from A to B
|
||||||
|
* We insert two records:
|
||||||
|
* A with actionType="rename"
|
||||||
|
* B with actionType="renameDestination"
|
||||||
|
* @param db
|
||||||
|
* @param fileOrFolder
|
||||||
|
* @param oldPath
|
||||||
|
* @param vaultRandomID
|
||||||
|
*/
|
||||||
export const insertRenameRecordByVault = async (
|
export const insertRenameRecordByVault = async (
|
||||||
db: InternalDBs,
|
db: InternalDBs,
|
||||||
fileOrFolder: TAbstractFile,
|
fileOrFolder: TAbstractFile,
|
||||||
@@ -282,37 +381,73 @@ export const insertRenameRecordByVault = async (
|
|||||||
vaultRandomID: string
|
vaultRandomID: string
|
||||||
) => {
|
) => {
|
||||||
// log.info(fileOrFolder);
|
// log.info(fileOrFolder);
|
||||||
let k: FileFolderHistoryRecord;
|
let k1: FileFolderHistoryRecord;
|
||||||
|
let k2: FileFolderHistoryRecord;
|
||||||
|
const actionWhen = Date.now();
|
||||||
if (fileOrFolder instanceof TFile) {
|
if (fileOrFolder instanceof TFile) {
|
||||||
k = {
|
k1 = {
|
||||||
key: oldPath,
|
key: oldPath,
|
||||||
ctime: fileOrFolder.stat.ctime,
|
ctime: fileOrFolder.stat.ctime,
|
||||||
mtime: fileOrFolder.stat.mtime,
|
mtime: fileOrFolder.stat.mtime,
|
||||||
size: fileOrFolder.stat.size,
|
size: fileOrFolder.stat.size,
|
||||||
actionWhen: Date.now(),
|
actionWhen: actionWhen,
|
||||||
actionType: "rename",
|
actionType: "rename",
|
||||||
keyType: "file",
|
keyType: "file",
|
||||||
renameTo: fileOrFolder.path,
|
renameTo: fileOrFolder.path,
|
||||||
vaultRandomID: vaultRandomID,
|
vaultRandomID: vaultRandomID,
|
||||||
};
|
};
|
||||||
|
k2 = {
|
||||||
|
key: fileOrFolder.path,
|
||||||
|
ctime: fileOrFolder.stat.ctime,
|
||||||
|
mtime: fileOrFolder.stat.mtime,
|
||||||
|
size: fileOrFolder.stat.size,
|
||||||
|
actionWhen: actionWhen,
|
||||||
|
actionType: "renameDestination",
|
||||||
|
keyType: "file",
|
||||||
|
renameTo: "", // itself is the destination, so no need to set this field
|
||||||
|
vaultRandomID: vaultRandomID,
|
||||||
|
};
|
||||||
} else if (fileOrFolder instanceof TFolder) {
|
} else if (fileOrFolder instanceof TFolder) {
|
||||||
const key = oldPath.endsWith("/") ? oldPath : `${oldPath}/`;
|
const key = oldPath.endsWith("/") ? oldPath : `${oldPath}/`;
|
||||||
const renameTo = fileOrFolder.path.endsWith("/")
|
const renameTo = fileOrFolder.path.endsWith("/")
|
||||||
? fileOrFolder.path
|
? fileOrFolder.path
|
||||||
: `${fileOrFolder.path}/`;
|
: `${fileOrFolder.path}/`;
|
||||||
k = {
|
let ctime = 0;
|
||||||
|
let mtime = 0;
|
||||||
|
if (requireApiVersion(API_VER_STAT_FOLDER)) {
|
||||||
|
// TAbstractFile does not contain these info
|
||||||
|
// but from API_VER_STAT_FOLDER we can manually stat them by path.
|
||||||
|
const s = await fileOrFolder.vault.adapter.stat(fileOrFolder.path);
|
||||||
|
ctime = s.ctime;
|
||||||
|
mtime = s.mtime;
|
||||||
|
}
|
||||||
|
k1 = {
|
||||||
key: key,
|
key: key,
|
||||||
ctime: 0,
|
ctime: ctime,
|
||||||
mtime: 0,
|
mtime: mtime,
|
||||||
size: 0,
|
size: 0,
|
||||||
actionWhen: Date.now(),
|
actionWhen: actionWhen,
|
||||||
actionType: "rename",
|
actionType: "rename",
|
||||||
keyType: "folder",
|
keyType: "folder",
|
||||||
renameTo: renameTo,
|
renameTo: renameTo,
|
||||||
vaultRandomID: vaultRandomID,
|
vaultRandomID: vaultRandomID,
|
||||||
};
|
};
|
||||||
|
k2 = {
|
||||||
|
key: renameTo,
|
||||||
|
ctime: ctime,
|
||||||
|
mtime: mtime,
|
||||||
|
size: 0,
|
||||||
|
actionWhen: actionWhen,
|
||||||
|
actionType: "renameDestination",
|
||||||
|
keyType: "folder",
|
||||||
|
renameTo: "", // itself is the destination, so no need to set this field
|
||||||
|
vaultRandomID: vaultRandomID,
|
||||||
|
};
|
||||||
}
|
}
|
||||||
await db.deleteHistoryTbl.setItem(`${vaultRandomID}\t${k.key}`, k);
|
await Promise.all([
|
||||||
|
db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k1.key}`, k1),
|
||||||
|
db.fileHistoryTbl.setItem(`${vaultRandomID}\t${k2.key}`, k2),
|
||||||
|
]);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const upsertSyncMetaMappingDataByVault = async (
|
export const upsertSyncMetaMappingDataByVault = async (
|
||||||
@@ -386,6 +521,7 @@ export const insertSyncPlanRecordByVault = async (
|
|||||||
) => {
|
) => {
|
||||||
const record = {
|
const record = {
|
||||||
ts: syncPlan.ts,
|
ts: syncPlan.ts,
|
||||||
|
tsFmt: syncPlan.tsFmt,
|
||||||
vaultRandomID: vaultRandomID,
|
vaultRandomID: vaultRandomID,
|
||||||
remoteType: syncPlan.remoteType,
|
remoteType: syncPlan.remoteType,
|
||||||
syncPlan: JSON.stringify(syncPlan /* directly stringify */, null, 2),
|
syncPlan: JSON.stringify(syncPlan /* directly stringify */, null, 2),
|
||||||
@@ -415,3 +551,133 @@ export const readAllSyncPlanRecordTextsByVault = async (
|
|||||||
return records.map((x) => x.syncPlan);
|
return records.map((x) => x.syncPlan);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* We remove records that are older than 7 days or 10000 records.
|
||||||
|
* It's a heavy operation, so we shall not place it in the start up.
|
||||||
|
* @param db
|
||||||
|
*/
|
||||||
|
export const clearExpiredSyncPlanRecords = async (db: InternalDBs) => {
|
||||||
|
const MILLISECONDS_OLD = 1000 * 60 * 60 * 24 * 7; // 7 days
|
||||||
|
const COUNT_TO_MANY = 10000;
|
||||||
|
|
||||||
|
const currTs = Date.now();
|
||||||
|
const expiredTs = currTs - MILLISECONDS_OLD;
|
||||||
|
|
||||||
|
let records = (await db.syncPlansTbl.keys()).map((key) => {
|
||||||
|
const ts = parseInt(key.split("\t")[1]);
|
||||||
|
const expired = ts <= expiredTs;
|
||||||
|
return {
|
||||||
|
ts: ts,
|
||||||
|
key: key,
|
||||||
|
expired: expired,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
const keysToRemove = new Set(
|
||||||
|
records.filter((x) => x.expired).map((x) => x.key)
|
||||||
|
);
|
||||||
|
|
||||||
|
if (records.length - keysToRemove.size > COUNT_TO_MANY) {
|
||||||
|
// we need to find out records beyond 10000 records
|
||||||
|
records = records.filter((x) => !x.expired); // shrink the array
|
||||||
|
records.sort((a, b) => -(a.ts - b.ts)); // descending
|
||||||
|
records.slice(COUNT_TO_MANY).forEach((element) => {
|
||||||
|
keysToRemove.add(element.key);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const ps = [] as Promise<void>[];
|
||||||
|
keysToRemove.forEach((element) => {
|
||||||
|
ps.push(db.syncPlansTbl.removeItem(element));
|
||||||
|
});
|
||||||
|
await Promise.all(ps);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const readAllLogRecordTextsByVault = async (
|
||||||
|
db: InternalDBs,
|
||||||
|
vaultRandomID: string
|
||||||
|
) => {
|
||||||
|
const records = [] as { ts: number; r: string }[];
|
||||||
|
await db.loggerOutputTbl.iterate((value, key, iterationNumber) => {
|
||||||
|
if (key.startsWith(`${vaultRandomID}\t`)) {
|
||||||
|
const item = {
|
||||||
|
ts: parseInt(key.split("\t")[1]),
|
||||||
|
r: value as string,
|
||||||
|
};
|
||||||
|
records.push(item);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// while reading the logs, we want it to be ascending
|
||||||
|
records.sort((a, b) => a.ts - b.ts);
|
||||||
|
|
||||||
|
if (records === undefined) {
|
||||||
|
return [] as string[];
|
||||||
|
} else {
|
||||||
|
return records.map((x) => x.r);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export const insertLoggerOutputByVault = async (
|
||||||
|
db: InternalDBs,
|
||||||
|
vaultRandomID: string,
|
||||||
|
...msg: any[]
|
||||||
|
) => {
|
||||||
|
const ts = Date.now();
|
||||||
|
const tsFmt = unixTimeToStr(ts);
|
||||||
|
const key = `${vaultRandomID}\t${ts}`;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const val = [`[${tsFmt}]`, ...msg.map((x) => toText(x))].join(" ");
|
||||||
|
db.loggerOutputTbl.setItem(key, val);
|
||||||
|
} catch (err) {
|
||||||
|
// give up, and let it pass
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export const clearAllLoggerOutputRecords = async (db: InternalDBs) => {
|
||||||
|
await db.loggerOutputTbl.clear();
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* We remove records that are older than 7 days or 10000 records.
|
||||||
|
* It's a heavy operation, so we shall not place it in the start up.
|
||||||
|
* @param db
|
||||||
|
*/
|
||||||
|
export const clearExpiredLoggerOutputRecords = async (db: InternalDBs) => {
|
||||||
|
const MILLISECONDS_OLD = 1000 * 60 * 60 * 24 * 7; // 7 days
|
||||||
|
const COUNT_TO_MANY = 10000;
|
||||||
|
|
||||||
|
const currTs = Date.now();
|
||||||
|
const expiredTs = currTs - MILLISECONDS_OLD;
|
||||||
|
|
||||||
|
let records = (await db.loggerOutputTbl.keys()).map((key) => {
|
||||||
|
const ts = parseInt(key.split("\t")[1]);
|
||||||
|
const expired = ts <= expiredTs;
|
||||||
|
return {
|
||||||
|
ts: ts,
|
||||||
|
key: key,
|
||||||
|
expired: expired,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
const keysToRemove = new Set(
|
||||||
|
records.filter((x) => x.expired).map((x) => x.key)
|
||||||
|
);
|
||||||
|
|
||||||
|
if (records.length - keysToRemove.size > COUNT_TO_MANY) {
|
||||||
|
// we need to find out records beyond 10000 records
|
||||||
|
records = records.filter((x) => !x.expired); // shrink the array
|
||||||
|
records.sort((a, b) => -(a.ts - b.ts)); // descending
|
||||||
|
records.slice(COUNT_TO_MANY).forEach((element) => {
|
||||||
|
keysToRemove.add(element.key);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const ps = [] as Promise<void>[];
|
||||||
|
keysToRemove.forEach((element) => {
|
||||||
|
ps.push(db.loggerOutputTbl.removeItem(element));
|
||||||
|
});
|
||||||
|
await Promise.all(ps);
|
||||||
|
};
|
||||||
|
|||||||
+547
-134
@@ -1,8 +1,18 @@
|
|||||||
import { Modal, Notice, Plugin, Setting, addIcon, setIcon } from "obsidian";
|
import {
|
||||||
|
Modal,
|
||||||
|
Notice,
|
||||||
|
Plugin,
|
||||||
|
Setting,
|
||||||
|
addIcon,
|
||||||
|
setIcon,
|
||||||
|
FileSystemAdapter,
|
||||||
|
} from "obsidian";
|
||||||
import cloneDeep from "lodash/cloneDeep";
|
import cloneDeep from "lodash/cloneDeep";
|
||||||
import { nanoid } from "nanoid";
|
import { createElement, RotateCcw, RefreshCcw, FileText } from "lucide";
|
||||||
import feather from "feather-icons";
|
import type {
|
||||||
import type { RemotelySavePluginSettings } from "./baseTypes";
|
RemotelySavePluginSettings,
|
||||||
|
SyncTriggerSourceType,
|
||||||
|
} from "./baseTypes";
|
||||||
import {
|
import {
|
||||||
COMMAND_CALLBACK,
|
COMMAND_CALLBACK,
|
||||||
COMMAND_CALLBACK_ONEDRIVE,
|
COMMAND_CALLBACK_ONEDRIVE,
|
||||||
@@ -10,13 +20,16 @@ import {
|
|||||||
COMMAND_URI,
|
COMMAND_URI,
|
||||||
} from "./baseTypes";
|
} from "./baseTypes";
|
||||||
import { importQrCodeUri } from "./importExport";
|
import { importQrCodeUri } from "./importExport";
|
||||||
import type { InternalDBs } from "./localdb";
|
|
||||||
import {
|
import {
|
||||||
insertDeleteRecordByVault,
|
insertDeleteRecordByVault,
|
||||||
insertRenameRecordByVault,
|
insertRenameRecordByVault,
|
||||||
insertSyncPlanRecordByVault,
|
insertSyncPlanRecordByVault,
|
||||||
loadDeleteRenameHistoryTableByVault,
|
loadFileHistoryTableByVault,
|
||||||
prepareDBs,
|
prepareDBs,
|
||||||
|
InternalDBs,
|
||||||
|
insertLoggerOutputByVault,
|
||||||
|
clearExpiredLoggerOutputRecords,
|
||||||
|
clearExpiredSyncPlanRecords,
|
||||||
} from "./localdb";
|
} from "./localdb";
|
||||||
import { RemoteClient } from "./remote";
|
import { RemoteClient } from "./remote";
|
||||||
import {
|
import {
|
||||||
@@ -34,12 +47,23 @@ import {
|
|||||||
import { DEFAULT_S3_CONFIG } from "./remoteForS3";
|
import { DEFAULT_S3_CONFIG } from "./remoteForS3";
|
||||||
import { DEFAULT_WEBDAV_CONFIG } from "./remoteForWebdav";
|
import { DEFAULT_WEBDAV_CONFIG } from "./remoteForWebdav";
|
||||||
import { RemotelySaveSettingTab } from "./settings";
|
import { RemotelySaveSettingTab } from "./settings";
|
||||||
import type { SyncStatusType } from "./sync";
|
import { fetchMetadataFile, parseRemoteItems, SyncStatusType } from "./sync";
|
||||||
import { doActualSync, getSyncPlan, isPasswordOk } from "./sync";
|
import { doActualSync, getSyncPlan, isPasswordOk } from "./sync";
|
||||||
import { messyConfigToNormal, normalConfigToMessy } from "./configPersist";
|
import { messyConfigToNormal, normalConfigToMessy } from "./configPersist";
|
||||||
|
import { ObsConfigDirFileType, listFilesInObsFolder } from "./obsFolderLister";
|
||||||
|
import { I18n } from "./i18n";
|
||||||
|
import type { LangType, LangTypeAndAuto, TransItemType } from "./i18n";
|
||||||
|
|
||||||
import * as origLog from "loglevel";
|
import { DeletionOnRemote, MetadataOnRemote } from "./metadataOnRemote";
|
||||||
const log = origLog.getLogger("rs-default");
|
import { SyncAlgoV2Modal } from "./syncAlgoV2Notice";
|
||||||
|
import { applyPresetRulesInplace } from "./presetRules";
|
||||||
|
|
||||||
|
import { applyLogWriterInplace, log } from "./moreOnLog";
|
||||||
|
import AggregateError from "aggregate-error";
|
||||||
|
import {
|
||||||
|
exportVaultLoggerOutputToFiles,
|
||||||
|
exportVaultSyncPlansToFiles,
|
||||||
|
} from "./debugMode";
|
||||||
|
|
||||||
const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
|
const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
|
||||||
s3: DEFAULT_S3_CONFIG,
|
s3: DEFAULT_S3_CONFIG,
|
||||||
@@ -49,8 +73,15 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
|
|||||||
password: "",
|
password: "",
|
||||||
serviceType: "s3",
|
serviceType: "s3",
|
||||||
currLogLevel: "info",
|
currLogLevel: "info",
|
||||||
vaultRandomID: "",
|
// vaultRandomID: "", // deprecated
|
||||||
autoRunEveryMilliseconds: -1,
|
autoRunEveryMilliseconds: -1,
|
||||||
|
initRunAfterMilliseconds: -1,
|
||||||
|
agreeToUploadExtraMetadata: false,
|
||||||
|
concurrency: 5,
|
||||||
|
syncConfigDir: false,
|
||||||
|
syncUnderscoreItems: false,
|
||||||
|
lang: "auto",
|
||||||
|
logToDB: false,
|
||||||
};
|
};
|
||||||
|
|
||||||
interface OAuth2Info {
|
interface OAuth2Info {
|
||||||
@@ -61,22 +92,34 @@ interface OAuth2Info {
|
|||||||
revokeAuthSetting?: Setting;
|
revokeAuthSetting?: Setting;
|
||||||
}
|
}
|
||||||
|
|
||||||
type SyncTriggerSourceType = "manual" | "auto";
|
|
||||||
|
|
||||||
const iconNameSyncWait = `remotely-save-sync-wait`;
|
const iconNameSyncWait = `remotely-save-sync-wait`;
|
||||||
const iconNameSyncRunning = `remotely-save-sync-running`;
|
const iconNameSyncRunning = `remotely-save-sync-running`;
|
||||||
const iconSvgSyncWait = feather.icons["rotate-ccw"].toSvg({
|
const iconNameLogs = `remotely-save-logs`;
|
||||||
width: 100,
|
|
||||||
height: 100,
|
const getIconSvg = () => {
|
||||||
});
|
const iconSvgSyncWait = createElement(RotateCcw);
|
||||||
const iconSvgSyncRunning = feather.icons["refresh-ccw"].toSvg({
|
iconSvgSyncWait.setAttribute("width", "100");
|
||||||
width: 100,
|
iconSvgSyncWait.setAttribute("height", "100");
|
||||||
height: 100,
|
const iconSvgSyncRunning = createElement(RefreshCcw);
|
||||||
});
|
iconSvgSyncRunning.setAttribute("width", "100");
|
||||||
|
iconSvgSyncRunning.setAttribute("height", "100");
|
||||||
|
const iconSvgLogs = createElement(FileText);
|
||||||
|
iconSvgLogs.setAttribute("width", "100");
|
||||||
|
iconSvgLogs.setAttribute("height", "100");
|
||||||
|
const res = {
|
||||||
|
iconSvgSyncWait: iconSvgSyncWait.outerHTML,
|
||||||
|
iconSvgSyncRunning: iconSvgSyncRunning.outerHTML,
|
||||||
|
iconSvgLogs: iconSvgLogs.outerHTML,
|
||||||
|
};
|
||||||
|
|
||||||
|
iconSvgSyncWait.empty();
|
||||||
|
iconSvgSyncRunning.empty();
|
||||||
|
iconSvgLogs.empty();
|
||||||
|
return res;
|
||||||
|
};
|
||||||
|
|
||||||
export default class RemotelySavePlugin extends Plugin {
|
export default class RemotelySavePlugin extends Plugin {
|
||||||
settings: RemotelySavePluginSettings;
|
settings: RemotelySavePluginSettings;
|
||||||
// cm: CodeMirror.Editor;
|
|
||||||
db: InternalDBs;
|
db: InternalDBs;
|
||||||
syncStatus: SyncStatusType;
|
syncStatus: SyncStatusType;
|
||||||
oauth2Info: OAuth2Info;
|
oauth2Info: OAuth2Info;
|
||||||
@@ -84,18 +127,29 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
currSyncMsg?: string;
|
currSyncMsg?: string;
|
||||||
syncRibbon?: HTMLElement;
|
syncRibbon?: HTMLElement;
|
||||||
autoRunIntervalID?: number;
|
autoRunIntervalID?: number;
|
||||||
|
i18n: I18n;
|
||||||
|
vaultRandomID: string;
|
||||||
|
|
||||||
async syncRun(triggerSource: SyncTriggerSourceType = "manual") {
|
async syncRun(triggerSource: SyncTriggerSourceType = "manual") {
|
||||||
const getNotice = (x: string) => {
|
const t = (x: TransItemType, vars?: any) => {
|
||||||
|
return this.i18n.t(x, vars);
|
||||||
|
};
|
||||||
|
|
||||||
|
const getNotice = (x: string, timeout?: number) => {
|
||||||
// only show notices in manual mode
|
// only show notices in manual mode
|
||||||
// no notice in auto mode
|
// no notice in auto mode
|
||||||
if (triggerSource === "manual") {
|
if (triggerSource === "manual" || triggerSource === "dry") {
|
||||||
new Notice(x);
|
new Notice(x, timeout);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
if (this.syncStatus !== "idle") {
|
if (this.syncStatus !== "idle") {
|
||||||
// here the notice is shown regardless of triggerSource
|
// here the notice is shown regardless of triggerSource
|
||||||
new Notice(`Remotely Save already running in stage ${this.syncStatus}!`);
|
new Notice(
|
||||||
|
t("syncrun_alreadyrunning", {
|
||||||
|
pluginName: this.manifest.name,
|
||||||
|
syncStatus: this.syncStatus,
|
||||||
|
})
|
||||||
|
);
|
||||||
if (this.currSyncMsg !== undefined && this.currSyncMsg !== "") {
|
if (this.currSyncMsg !== undefined && this.currSyncMsg !== "") {
|
||||||
new Notice(this.currSyncMsg);
|
new Notice(this.currSyncMsg);
|
||||||
}
|
}
|
||||||
@@ -118,18 +172,38 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
setIcon(this.syncRibbon, iconNameSyncRunning);
|
setIcon(this.syncRibbon, iconNameSyncRunning);
|
||||||
this.syncRibbon.setAttribute(
|
this.syncRibbon.setAttribute(
|
||||||
"aria-label",
|
"aria-label",
|
||||||
`${this.manifest.name}: ${triggerSource} syncing`
|
t("syncrun_syncingribbon", {
|
||||||
|
pluginName: this.manifest.name,
|
||||||
|
triggerSource: triggerSource,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const MAX_STEPS = 8;
|
||||||
|
|
||||||
|
if (triggerSource === "dry") {
|
||||||
|
getNotice(
|
||||||
|
t("syncrun_step0", {
|
||||||
|
maxSteps: `${MAX_STEPS}`,
|
||||||
|
})
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
//log.info(`huh ${this.settings.password}`)
|
//log.info(`huh ${this.settings.password}`)
|
||||||
getNotice(
|
getNotice(
|
||||||
`1/7 Remotely Save Sync Preparing (${this.settings.serviceType})`
|
t("syncrun_step1", {
|
||||||
|
maxSteps: `${MAX_STEPS}`,
|
||||||
|
serviceType: this.settings.serviceType,
|
||||||
|
})
|
||||||
);
|
);
|
||||||
this.syncStatus = "preparing";
|
this.syncStatus = "preparing";
|
||||||
|
|
||||||
getNotice("2/7 Starting to fetch remote meta data.");
|
getNotice(
|
||||||
this.syncStatus = "getting_remote_meta";
|
t("syncrun_step2", {
|
||||||
|
maxSteps: `${MAX_STEPS}`,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
this.syncStatus = "getting_remote_files_list";
|
||||||
const self = this;
|
const self = this;
|
||||||
const client = new RemoteClient(
|
const client = new RemoteClient(
|
||||||
this.settings.serviceType,
|
this.settings.serviceType,
|
||||||
@@ -141,66 +215,129 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
() => self.saveSettings()
|
() => self.saveSettings()
|
||||||
);
|
);
|
||||||
const remoteRsp = await client.listFromRemote();
|
const remoteRsp = await client.listFromRemote();
|
||||||
log.info(remoteRsp);
|
// log.debug(remoteRsp);
|
||||||
|
|
||||||
getNotice("3/7 Starting to fetch local meta data.");
|
getNotice(
|
||||||
this.syncStatus = "getting_local_meta";
|
t("syncrun_step3", {
|
||||||
const local = this.app.vault.getAllLoadedFiles();
|
maxSteps: `${MAX_STEPS}`,
|
||||||
const localHistory = await loadDeleteRenameHistoryTableByVault(
|
})
|
||||||
this.db,
|
|
||||||
this.settings.vaultRandomID
|
|
||||||
);
|
);
|
||||||
// log.info(local);
|
|
||||||
// log.info(localHistory);
|
|
||||||
|
|
||||||
getNotice("4/7 Checking password correct or not.");
|
|
||||||
this.syncStatus = "checking_password";
|
this.syncStatus = "checking_password";
|
||||||
const passwordCheckResult = await isPasswordOk(
|
const passwordCheckResult = await isPasswordOk(
|
||||||
remoteRsp.Contents,
|
remoteRsp.Contents,
|
||||||
this.settings.password
|
this.settings.password
|
||||||
);
|
);
|
||||||
if (!passwordCheckResult.ok) {
|
if (!passwordCheckResult.ok) {
|
||||||
getNotice("something goes wrong while checking password");
|
getNotice(t("syncrun_passworderr"));
|
||||||
throw Error(passwordCheckResult.reason);
|
throw Error(passwordCheckResult.reason);
|
||||||
}
|
}
|
||||||
|
|
||||||
getNotice("5/7 Starting to generate sync plan.");
|
getNotice(
|
||||||
this.syncStatus = "generating_plan";
|
t("syncrun_step4", {
|
||||||
const syncPlan = await getSyncPlan(
|
maxSteps: `${MAX_STEPS}`,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
this.syncStatus = "getting_remote_extra_meta";
|
||||||
|
const { remoteStates, metadataFile } = await parseRemoteItems(
|
||||||
remoteRsp.Contents,
|
remoteRsp.Contents,
|
||||||
local,
|
|
||||||
localHistory,
|
|
||||||
this.db,
|
this.db,
|
||||||
this.settings.vaultRandomID,
|
this.vaultRandomID,
|
||||||
client.serviceType,
|
client.serviceType,
|
||||||
this.settings.password
|
this.settings.password
|
||||||
);
|
);
|
||||||
log.info(syncPlan.mixedStates); // for debugging
|
const origMetadataOnRemote = await fetchMetadataFile(
|
||||||
await insertSyncPlanRecordByVault(
|
metadataFile,
|
||||||
this.db,
|
client,
|
||||||
syncPlan,
|
this.app.vault,
|
||||||
this.settings.vaultRandomID
|
this.settings.password
|
||||||
);
|
);
|
||||||
|
|
||||||
// The operations above are read only and kind of safe.
|
getNotice(
|
||||||
|
t("syncrun_step5", {
|
||||||
|
maxSteps: `${MAX_STEPS}`,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
this.syncStatus = "getting_local_meta";
|
||||||
|
const local = this.app.vault.getAllLoadedFiles();
|
||||||
|
const localHistory = await loadFileHistoryTableByVault(
|
||||||
|
this.db,
|
||||||
|
this.vaultRandomID
|
||||||
|
);
|
||||||
|
let localConfigDirContents: ObsConfigDirFileType[] = undefined;
|
||||||
|
if (this.settings.syncConfigDir) {
|
||||||
|
localConfigDirContents = await listFilesInObsFolder(
|
||||||
|
this.app.vault.configDir,
|
||||||
|
this.app.vault,
|
||||||
|
this.manifest.id
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// log.info(local);
|
||||||
|
// log.info(localHistory);
|
||||||
|
|
||||||
|
getNotice(
|
||||||
|
t("syncrun_step6", {
|
||||||
|
maxSteps: `${MAX_STEPS}`,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
this.syncStatus = "generating_plan";
|
||||||
|
const { plan, sortedKeys, deletions } = await getSyncPlan(
|
||||||
|
remoteStates,
|
||||||
|
local,
|
||||||
|
localConfigDirContents,
|
||||||
|
origMetadataOnRemote.deletions,
|
||||||
|
localHistory,
|
||||||
|
client.serviceType,
|
||||||
|
triggerSource,
|
||||||
|
this.app.vault,
|
||||||
|
this.settings.syncConfigDir,
|
||||||
|
this.app.vault.configDir,
|
||||||
|
this.settings.syncUnderscoreItems,
|
||||||
|
this.settings.password
|
||||||
|
);
|
||||||
|
log.info(plan.mixedStates); // for debugging
|
||||||
|
await insertSyncPlanRecordByVault(this.db, plan, this.vaultRandomID);
|
||||||
|
|
||||||
|
// The operations above are almost read only and kind of safe.
|
||||||
// The operations below begins to write or delete (!!!) something.
|
// The operations below begins to write or delete (!!!) something.
|
||||||
|
|
||||||
getNotice("6/7 Remotely Save Sync data exchanging!");
|
if (triggerSource !== "dry") {
|
||||||
|
getNotice(
|
||||||
|
t("syncrun_step7", {
|
||||||
|
maxSteps: `${MAX_STEPS}`,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
this.syncStatus = "syncing";
|
this.syncStatus = "syncing";
|
||||||
await doActualSync(
|
await doActualSync(
|
||||||
client,
|
client,
|
||||||
this.db,
|
this.db,
|
||||||
this.settings.vaultRandomID,
|
this.vaultRandomID,
|
||||||
this.app.vault,
|
this.app.vault,
|
||||||
syncPlan,
|
plan,
|
||||||
this.settings.password,
|
sortedKeys,
|
||||||
(i: number, totalCount: number, pathName: string, decision: string) =>
|
metadataFile,
|
||||||
self.setCurrSyncMsg(i, totalCount, pathName, decision)
|
origMetadataOnRemote,
|
||||||
|
deletions,
|
||||||
|
(key: string) => self.trash(key),
|
||||||
|
this.settings.password,
|
||||||
|
this.settings.concurrency,
|
||||||
|
(i: number, totalCount: number, pathName: string, decision: string) =>
|
||||||
|
self.setCurrSyncMsg(i, totalCount, pathName, decision)
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
this.syncStatus = "syncing";
|
||||||
|
getNotice(
|
||||||
|
t("syncrun_step7skip", {
|
||||||
|
maxSteps: `${MAX_STEPS}`,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
getNotice(
|
||||||
|
t("syncrun_step8", {
|
||||||
|
maxSteps: `${MAX_STEPS}`,
|
||||||
|
})
|
||||||
);
|
);
|
||||||
|
|
||||||
getNotice("7/7 Remotely Save finish!");
|
|
||||||
this.currSyncMsg = "";
|
|
||||||
this.syncStatus = "finish";
|
this.syncStatus = "finish";
|
||||||
this.syncStatus = "idle";
|
this.syncStatus = "idle";
|
||||||
|
|
||||||
@@ -215,15 +352,22 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
}-${Date.now()}: finish sync, triggerSource=${triggerSource}`
|
}-${Date.now()}: finish sync, triggerSource=${triggerSource}`
|
||||||
);
|
);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
const msg = `${
|
const msg = t("syncrun_abort", {
|
||||||
this.manifest.id
|
manifestID: this.manifest.id,
|
||||||
}-${Date.now()}: abort sync, triggerSource=${triggerSource}, error while ${
|
theDate: `${Date.now()}`,
|
||||||
this.syncStatus
|
triggerSource: triggerSource,
|
||||||
}`;
|
syncStatus: this.syncStatus,
|
||||||
log.info(msg);
|
});
|
||||||
log.info(error);
|
log.error(msg);
|
||||||
getNotice(msg);
|
log.error(error);
|
||||||
getNotice(error.message);
|
getNotice(msg, 10 * 1000);
|
||||||
|
if (error instanceof AggregateError) {
|
||||||
|
for (const e of error.errors) {
|
||||||
|
getNotice(e.message, 10 * 1000);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
getNotice(error.message, 10 * 1000);
|
||||||
|
}
|
||||||
this.syncStatus = "idle";
|
this.syncStatus = "idle";
|
||||||
if (this.syncRibbon !== undefined) {
|
if (this.syncRibbon !== undefined) {
|
||||||
setIcon(this.syncRibbon, iconNameSyncWait);
|
setIcon(this.syncRibbon, iconNameSyncWait);
|
||||||
@@ -235,8 +379,11 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
async onload() {
|
async onload() {
|
||||||
log.info(`loading plugin ${this.manifest.id}`);
|
log.info(`loading plugin ${this.manifest.id}`);
|
||||||
|
|
||||||
|
const { iconSvgSyncWait, iconSvgSyncRunning, iconSvgLogs } = getIconSvg();
|
||||||
|
|
||||||
addIcon(iconNameSyncWait, iconSvgSyncWait);
|
addIcon(iconNameSyncWait, iconSvgSyncWait);
|
||||||
addIcon(iconNameSyncRunning, iconSvgSyncRunning);
|
addIcon(iconNameSyncRunning, iconSvgSyncRunning);
|
||||||
|
addIcon(iconNameLogs, iconSvgLogs);
|
||||||
|
|
||||||
this.oauth2Info = {
|
this.oauth2Info = {
|
||||||
verifier: "",
|
verifier: "",
|
||||||
@@ -249,15 +396,50 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
this.currSyncMsg = "";
|
this.currSyncMsg = "";
|
||||||
|
|
||||||
await this.loadSettings();
|
await this.loadSettings();
|
||||||
|
await this.checkIfPresetRulesFollowed();
|
||||||
|
|
||||||
|
// lang should be load early, but after settings
|
||||||
|
this.i18n = new I18n(this.settings.lang, async (lang: LangTypeAndAuto) => {
|
||||||
|
this.settings.lang = lang;
|
||||||
|
await this.saveSettings();
|
||||||
|
});
|
||||||
|
const t = (x: TransItemType, vars?: any) => {
|
||||||
|
return this.i18n.t(x, vars);
|
||||||
|
};
|
||||||
|
|
||||||
if (this.settings.currLogLevel !== undefined) {
|
if (this.settings.currLogLevel !== undefined) {
|
||||||
log.setLevel(this.settings.currLogLevel as any);
|
log.setLevel(this.settings.currLogLevel as any);
|
||||||
}
|
}
|
||||||
|
|
||||||
await this.checkIfOauthExpires();
|
await this.checkIfOauthExpires();
|
||||||
await this.checkIfVaultIDAssigned(); // MUST before prepareDB()
|
|
||||||
|
|
||||||
await this.prepareDB();
|
// MUST before prepareDB()
|
||||||
|
// And, it's also possible to be an empty string,
|
||||||
|
// which means the vaultRandomID is read from db later!
|
||||||
|
const vaultRandomIDFromOldConfigFile =
|
||||||
|
await this.getVaultRandomIDFromOldConfigFile();
|
||||||
|
|
||||||
|
// no need to await this
|
||||||
|
this.tryToAddIgnoreFile();
|
||||||
|
|
||||||
|
const vaultBasePath = this.getVaultBasePath();
|
||||||
|
|
||||||
|
try {
|
||||||
|
await this.prepareDBAndVaultRandomID(
|
||||||
|
vaultBasePath,
|
||||||
|
vaultRandomIDFromOldConfigFile
|
||||||
|
);
|
||||||
|
} catch (err) {
|
||||||
|
new Notice(err.message, 10 * 1000);
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
|
|
||||||
|
// must AFTER preparing DB
|
||||||
|
this.addOutputToDBIfSet();
|
||||||
|
this.enableAutoClearOutputToDBHistIfSet();
|
||||||
|
|
||||||
|
// must AFTER preparing DB
|
||||||
|
this.enableAutoClearSyncPlanHist();
|
||||||
|
|
||||||
this.syncStatus = "idle";
|
this.syncStatus = "idle";
|
||||||
|
|
||||||
@@ -266,7 +448,7 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
await insertDeleteRecordByVault(
|
await insertDeleteRecordByVault(
|
||||||
this.db,
|
this.db,
|
||||||
fileOrFolder,
|
fileOrFolder,
|
||||||
this.settings.vaultRandomID
|
this.vaultRandomID
|
||||||
);
|
);
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
@@ -277,7 +459,7 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
this.db,
|
this.db,
|
||||||
fileOrFolder,
|
fileOrFolder,
|
||||||
oldPath,
|
oldPath,
|
||||||
this.settings.vaultRandomID
|
this.vaultRandomID
|
||||||
);
|
);
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
@@ -292,7 +474,9 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
this.settings = Object.assign({}, this.settings, copied);
|
this.settings = Object.assign({}, this.settings, copied);
|
||||||
this.saveSettings();
|
this.saveSettings();
|
||||||
new Notice(
|
new Notice(
|
||||||
`New not-oauth2 settings for ${this.manifest.name} saved. Reopen the plugin Settings to the effect.`
|
t("protocol_saveqr", {
|
||||||
|
manifestName: this.manifest.name,
|
||||||
|
})
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -301,9 +485,9 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
COMMAND_CALLBACK,
|
COMMAND_CALLBACK,
|
||||||
async (inputParams) => {
|
async (inputParams) => {
|
||||||
new Notice(
|
new Notice(
|
||||||
`Your uri call a callback that's not supported yet: ${JSON.stringify(
|
t("protocol_callbacknotsupported", {
|
||||||
inputParams
|
params: JSON.stringify(inputParams),
|
||||||
)}`
|
})
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
@@ -314,12 +498,14 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
if (inputParams.code !== undefined) {
|
if (inputParams.code !== undefined) {
|
||||||
if (this.oauth2Info.helperModal !== undefined) {
|
if (this.oauth2Info.helperModal !== undefined) {
|
||||||
this.oauth2Info.helperModal.contentEl.empty();
|
this.oauth2Info.helperModal.contentEl.empty();
|
||||||
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
|
||||||
text: "Connecting to Dropbox...",
|
t("protocol_dropbox_connecting")
|
||||||
});
|
.split("\n")
|
||||||
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
.forEach((val) => {
|
||||||
text: "Please DO NOT close this modal.",
|
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
||||||
});
|
text: val,
|
||||||
|
});
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
let authRes = await sendAuthReqDropbox(
|
let authRes = await sendAuthReqDropbox(
|
||||||
@@ -349,7 +535,11 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
this.settings.dropbox.username = username;
|
this.settings.dropbox.username = username;
|
||||||
await this.saveSettings();
|
await this.saveSettings();
|
||||||
|
|
||||||
new Notice(`Good! We've connected to Dropbox as user ${username}!`);
|
new Notice(
|
||||||
|
t("protocol_dropbox_connect_succ", {
|
||||||
|
username: username,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
this.oauth2Info.verifier = ""; // reset it
|
this.oauth2Info.verifier = ""; // reset it
|
||||||
this.oauth2Info.helperModal?.close(); // close it
|
this.oauth2Info.helperModal?.close(); // close it
|
||||||
@@ -362,7 +552,9 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
this.oauth2Info.authDiv = undefined;
|
this.oauth2Info.authDiv = undefined;
|
||||||
|
|
||||||
this.oauth2Info.revokeAuthSetting?.setDesc(
|
this.oauth2Info.revokeAuthSetting?.setDesc(
|
||||||
`You've connected as user ${this.settings.dropbox.username}. If you want to disconnect, click this button.`
|
t("protocol_dropbox_connect_succ_revoke", {
|
||||||
|
username: this.settings.dropbox.username,
|
||||||
|
})
|
||||||
);
|
);
|
||||||
this.oauth2Info.revokeAuthSetting = undefined;
|
this.oauth2Info.revokeAuthSetting = undefined;
|
||||||
this.oauth2Info.revokeDiv?.toggleClass(
|
this.oauth2Info.revokeDiv?.toggleClass(
|
||||||
@@ -371,13 +563,11 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
);
|
);
|
||||||
this.oauth2Info.revokeDiv = undefined;
|
this.oauth2Info.revokeDiv = undefined;
|
||||||
} else {
|
} else {
|
||||||
new Notice(
|
new Notice(t("protocol_dropbox_connect_fail"));
|
||||||
"Something went wrong from response from Dropbox. Maybe you rejected the auth?"
|
|
||||||
);
|
|
||||||
throw Error(
|
throw Error(
|
||||||
`do not know how to deal with the callback: ${JSON.stringify(
|
t("protocol_dropbox_connect_unknown", {
|
||||||
inputParams
|
params: JSON.stringify(inputParams),
|
||||||
)}`
|
})
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -389,12 +579,14 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
if (inputParams.code !== undefined) {
|
if (inputParams.code !== undefined) {
|
||||||
if (this.oauth2Info.helperModal !== undefined) {
|
if (this.oauth2Info.helperModal !== undefined) {
|
||||||
this.oauth2Info.helperModal.contentEl.empty();
|
this.oauth2Info.helperModal.contentEl.empty();
|
||||||
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
|
||||||
text: "Connecting to Onedrive...",
|
t("protocol_onedrive_connecting")
|
||||||
});
|
.split("\n")
|
||||||
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
.forEach((val) => {
|
||||||
text: "Please DO NOT close this modal.",
|
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
||||||
});
|
text: val,
|
||||||
|
});
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
let rsp = await sendAuthReqOnedrive(
|
let rsp = await sendAuthReqOnedrive(
|
||||||
@@ -438,7 +630,9 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
this.oauth2Info.authDiv = undefined;
|
this.oauth2Info.authDiv = undefined;
|
||||||
|
|
||||||
this.oauth2Info.revokeAuthSetting?.setDesc(
|
this.oauth2Info.revokeAuthSetting?.setDesc(
|
||||||
`You've connected as user ${this.settings.onedrive.username}. If you want to disconnect, click this button.`
|
t("protocol_onedrive_connect_succ_revoke", {
|
||||||
|
username: this.settings.onedrive.username,
|
||||||
|
})
|
||||||
);
|
);
|
||||||
this.oauth2Info.revokeAuthSetting = undefined;
|
this.oauth2Info.revokeAuthSetting = undefined;
|
||||||
this.oauth2Info.revokeDiv?.toggleClass(
|
this.oauth2Info.revokeDiv?.toggleClass(
|
||||||
@@ -447,13 +641,11 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
);
|
);
|
||||||
this.oauth2Info.revokeDiv = undefined;
|
this.oauth2Info.revokeDiv = undefined;
|
||||||
} else {
|
} else {
|
||||||
new Notice(
|
new Notice(t("protocol_onedrive_connect_fail"));
|
||||||
"Something went wrong from response from OneDrive. Maybe you rejected the auth?"
|
|
||||||
);
|
|
||||||
throw Error(
|
throw Error(
|
||||||
`do not know how to deal with the callback: ${JSON.stringify(
|
t("protocol_onedrive_connect_unknown", {
|
||||||
inputParams
|
params: JSON.stringify(inputParams),
|
||||||
)}`
|
})
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -467,35 +659,88 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
|
|
||||||
this.addCommand({
|
this.addCommand({
|
||||||
id: "start-sync",
|
id: "start-sync",
|
||||||
name: "start sync",
|
name: t("command_startsync"),
|
||||||
icon: iconNameSyncWait,
|
icon: iconNameSyncWait,
|
||||||
callback: async () => {
|
callback: async () => {
|
||||||
this.syncRun("manual");
|
this.syncRun("manual");
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: "start-sync-dry-run",
|
||||||
|
name: t("command_drynrun"),
|
||||||
|
icon: iconNameSyncWait,
|
||||||
|
callback: async () => {
|
||||||
|
this.syncRun("dry");
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: "export-sync-plans-json",
|
||||||
|
name: t("command_exportsyncplans_json"),
|
||||||
|
icon: iconNameLogs,
|
||||||
|
callback: async () => {
|
||||||
|
await exportVaultSyncPlansToFiles(
|
||||||
|
this.db,
|
||||||
|
this.app.vault,
|
||||||
|
this.vaultRandomID,
|
||||||
|
"json"
|
||||||
|
);
|
||||||
|
new Notice(t("settings_syncplans_notice"));
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: "export-sync-plans-table",
|
||||||
|
name: t("command_exportsyncplans_table"),
|
||||||
|
icon: iconNameLogs,
|
||||||
|
callback: async () => {
|
||||||
|
await exportVaultSyncPlansToFiles(
|
||||||
|
this.db,
|
||||||
|
this.app.vault,
|
||||||
|
this.vaultRandomID,
|
||||||
|
"table"
|
||||||
|
);
|
||||||
|
new Notice(t("settings_syncplans_notice"));
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: "export-logs-in-db",
|
||||||
|
name: t("command_exportlogsindb"),
|
||||||
|
icon: iconNameLogs,
|
||||||
|
callback: async () => {
|
||||||
|
await exportVaultLoggerOutputToFiles(
|
||||||
|
this.db,
|
||||||
|
this.app.vault,
|
||||||
|
this.vaultRandomID
|
||||||
|
);
|
||||||
|
new Notice(t("settings_logtodbexport_notice"));
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
this.addSettingTab(new RemotelySaveSettingTab(this.app, this));
|
this.addSettingTab(new RemotelySaveSettingTab(this.app, this));
|
||||||
|
|
||||||
// this.registerDomEvent(document, "click", (evt: MouseEvent) => {
|
// this.registerDomEvent(document, "click", (evt: MouseEvent) => {
|
||||||
// log.info("click", evt);
|
// log.info("click", evt);
|
||||||
// });
|
// });
|
||||||
|
|
||||||
if (
|
if (!this.settings.agreeToUploadExtraMetadata) {
|
||||||
this.settings.autoRunEveryMilliseconds !== undefined &&
|
const syncAlgoV2Modal = new SyncAlgoV2Modal(this.app, this);
|
||||||
this.settings.autoRunEveryMilliseconds !== null &&
|
syncAlgoV2Modal.open();
|
||||||
this.settings.autoRunEveryMilliseconds > 0
|
} else {
|
||||||
) {
|
this.enableAutoSyncIfSet();
|
||||||
const intervalID = window.setInterval(() => {
|
this.enableInitSyncIfSet();
|
||||||
this.syncRun("auto");
|
|
||||||
}, this.settings.autoRunEveryMilliseconds);
|
|
||||||
this.autoRunIntervalID = intervalID;
|
|
||||||
this.registerInterval(intervalID);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
onunload() {
|
async onunload() {
|
||||||
log.info(`unloading plugin ${this.manifest.id}`);
|
log.info(`unloading plugin ${this.manifest.id}`);
|
||||||
this.destroyDBs();
|
this.syncRibbon = undefined;
|
||||||
|
if (this.oauth2Info !== undefined) {
|
||||||
|
this.oauth2Info.helperModal = undefined;
|
||||||
|
this.oauth2Info = undefined;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async loadSettings() {
|
async loadSettings() {
|
||||||
@@ -507,15 +752,40 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
if (this.settings.dropbox.clientID === "") {
|
if (this.settings.dropbox.clientID === "") {
|
||||||
this.settings.dropbox.clientID = DEFAULT_SETTINGS.dropbox.clientID;
|
this.settings.dropbox.clientID = DEFAULT_SETTINGS.dropbox.clientID;
|
||||||
}
|
}
|
||||||
|
if (this.settings.dropbox.remoteBaseDir === undefined) {
|
||||||
|
this.settings.dropbox.remoteBaseDir = "";
|
||||||
|
}
|
||||||
if (this.settings.onedrive.clientID === "") {
|
if (this.settings.onedrive.clientID === "") {
|
||||||
this.settings.onedrive.clientID = DEFAULT_SETTINGS.onedrive.clientID;
|
this.settings.onedrive.clientID = DEFAULT_SETTINGS.onedrive.clientID;
|
||||||
}
|
}
|
||||||
if (this.settings.onedrive.authority === "") {
|
if (this.settings.onedrive.authority === "") {
|
||||||
this.settings.onedrive.authority = DEFAULT_SETTINGS.onedrive.authority;
|
this.settings.onedrive.authority = DEFAULT_SETTINGS.onedrive.authority;
|
||||||
}
|
}
|
||||||
|
if (this.settings.onedrive.remoteBaseDir === undefined) {
|
||||||
|
this.settings.onedrive.remoteBaseDir = "";
|
||||||
|
}
|
||||||
if (this.settings.webdav.manualRecursive === undefined) {
|
if (this.settings.webdav.manualRecursive === undefined) {
|
||||||
this.settings.webdav.manualRecursive = false;
|
this.settings.webdav.manualRecursive = false;
|
||||||
}
|
}
|
||||||
|
if (this.settings.webdav.depth === undefined) {
|
||||||
|
this.settings.webdav.depth = "auto_unknown";
|
||||||
|
}
|
||||||
|
if (this.settings.webdav.remoteBaseDir === undefined) {
|
||||||
|
this.settings.webdav.remoteBaseDir = "";
|
||||||
|
}
|
||||||
|
if (this.settings.s3.partsConcurrency === undefined) {
|
||||||
|
this.settings.s3.partsConcurrency = 20;
|
||||||
|
}
|
||||||
|
if (this.settings.s3.forcePathStyle === undefined) {
|
||||||
|
this.settings.s3.forcePathStyle = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async checkIfPresetRulesFollowed() {
|
||||||
|
const res = applyPresetRulesInplace(this.settings);
|
||||||
|
if (res.changed) {
|
||||||
|
await this.saveSettings();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async saveSettings() {
|
async saveSettings() {
|
||||||
@@ -592,22 +862,83 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async checkIfVaultIDAssigned() {
|
async getVaultRandomIDFromOldConfigFile() {
|
||||||
if (
|
let vaultRandomID = "";
|
||||||
this.settings.vaultRandomID === undefined ||
|
if (this.settings.vaultRandomID !== undefined) {
|
||||||
this.settings.vaultRandomID === ""
|
// In old version, the vault id is saved in data.json
|
||||||
) {
|
// But we want to store it in localForage later
|
||||||
this.settings.vaultRandomID = nanoid();
|
if (this.settings.vaultRandomID !== "") {
|
||||||
|
// a real string was assigned before
|
||||||
|
vaultRandomID = this.settings.vaultRandomID;
|
||||||
|
}
|
||||||
|
log.debug("vaultRandomID is no longer saved in data.json");
|
||||||
|
delete this.settings.vaultRandomID;
|
||||||
await this.saveSettings();
|
await this.saveSettings();
|
||||||
}
|
}
|
||||||
|
return vaultRandomID;
|
||||||
|
}
|
||||||
|
|
||||||
|
async trash(x: string) {
|
||||||
|
if (!(await this.app.vault.adapter.trashSystem(x))) {
|
||||||
|
await this.app.vault.adapter.trashLocal(x);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async prepareDB() {
|
getVaultBasePath() {
|
||||||
this.db = await prepareDBs(this.settings.vaultRandomID);
|
if (this.app.vault.adapter instanceof FileSystemAdapter) {
|
||||||
|
// in desktop
|
||||||
|
return this.app.vault.adapter.getBasePath().split("?")[0];
|
||||||
|
} else {
|
||||||
|
// in mobile
|
||||||
|
return this.app.vault.adapter.getResourcePath("").split("?")[0];
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
destroyDBs() {
|
async prepareDBAndVaultRandomID(
|
||||||
/* destroyDBs(this.db); */
|
vaultBasePath: string,
|
||||||
|
vaultRandomIDFromOldConfigFile: string
|
||||||
|
) {
|
||||||
|
const { db, vaultRandomID } = await prepareDBs(
|
||||||
|
vaultBasePath,
|
||||||
|
vaultRandomIDFromOldConfigFile
|
||||||
|
);
|
||||||
|
this.db = db;
|
||||||
|
this.vaultRandomID = vaultRandomID;
|
||||||
|
}
|
||||||
|
|
||||||
|
enableAutoSyncIfSet() {
|
||||||
|
if (
|
||||||
|
this.settings.autoRunEveryMilliseconds !== undefined &&
|
||||||
|
this.settings.autoRunEveryMilliseconds !== null &&
|
||||||
|
this.settings.autoRunEveryMilliseconds > 0
|
||||||
|
) {
|
||||||
|
this.app.workspace.onLayoutReady(() => {
|
||||||
|
const intervalID = window.setInterval(() => {
|
||||||
|
this.syncRun("auto");
|
||||||
|
}, this.settings.autoRunEveryMilliseconds);
|
||||||
|
this.autoRunIntervalID = intervalID;
|
||||||
|
this.registerInterval(intervalID);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
enableInitSyncIfSet() {
|
||||||
|
if (
|
||||||
|
this.settings.initRunAfterMilliseconds !== undefined &&
|
||||||
|
this.settings.initRunAfterMilliseconds !== null &&
|
||||||
|
this.settings.initRunAfterMilliseconds > 0
|
||||||
|
) {
|
||||||
|
this.app.workspace.onLayoutReady(() => {
|
||||||
|
window.setTimeout(() => {
|
||||||
|
this.syncRun("autoOnceInit");
|
||||||
|
}, this.settings.initRunAfterMilliseconds);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async saveAgreeToUseNewSyncAlgorithm() {
|
||||||
|
this.settings.agreeToUploadExtraMetadata = true;
|
||||||
|
await this.saveSettings();
|
||||||
}
|
}
|
||||||
|
|
||||||
async setCurrSyncMsg(
|
async setCurrSyncMsg(
|
||||||
@@ -619,4 +950,86 @@ export default class RemotelySavePlugin extends Plugin {
|
|||||||
const msg = `syncing progress=${i}/${totalCount},decision=${decision},path=${pathName}`;
|
const msg = `syncing progress=${i}/${totalCount},decision=${decision},path=${pathName}`;
|
||||||
this.currSyncMsg = msg;
|
this.currSyncMsg = msg;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Because data.json contains sensitive information,
|
||||||
|
* We usually want to ignore it in the version control.
|
||||||
|
* However, if there's already a an ignore file (even empty),
|
||||||
|
* we respect the existing configure and not add any modifications.
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
async tryToAddIgnoreFile() {
|
||||||
|
const pluginConfigDir =
|
||||||
|
this.manifest.dir ||
|
||||||
|
`${this.app.vault.configDir}/plugins/${this.manifest.dir}`;
|
||||||
|
const pluginConfigDirExists = await this.app.vault.adapter.exists(
|
||||||
|
pluginConfigDir
|
||||||
|
);
|
||||||
|
if (!pluginConfigDirExists) {
|
||||||
|
// what happened?
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const ignoreFile = `${pluginConfigDir}/.gitignore`;
|
||||||
|
const ignoreFileExists = await this.app.vault.adapter.exists(ignoreFile);
|
||||||
|
|
||||||
|
const contentText = "data.json\n";
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (!ignoreFileExists) {
|
||||||
|
// not exists, directly create
|
||||||
|
// no need to await
|
||||||
|
this.app.vault.adapter.write(ignoreFile, contentText);
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
// just skip
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
addOutputToDBIfSet() {
|
||||||
|
if (this.settings.logToDB) {
|
||||||
|
applyLogWriterInplace((...msg: any[]) => {
|
||||||
|
insertLoggerOutputByVault(this.db, this.vaultRandomID, ...msg);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
enableAutoClearOutputToDBHistIfSet() {
|
||||||
|
const initClearOutputToDBHistAfterMilliseconds = 1000 * 45;
|
||||||
|
const autoClearOutputToDBHistAfterMilliseconds = 1000 * 60 * 5;
|
||||||
|
|
||||||
|
this.app.workspace.onLayoutReady(() => {
|
||||||
|
// init run
|
||||||
|
window.setTimeout(() => {
|
||||||
|
if (this.settings.logToDB) {
|
||||||
|
clearExpiredLoggerOutputRecords(this.db);
|
||||||
|
}
|
||||||
|
}, initClearOutputToDBHistAfterMilliseconds);
|
||||||
|
|
||||||
|
// scheduled run
|
||||||
|
const intervalID = window.setInterval(() => {
|
||||||
|
if (this.settings.logToDB) {
|
||||||
|
clearExpiredLoggerOutputRecords(this.db);
|
||||||
|
}
|
||||||
|
}, autoClearOutputToDBHistAfterMilliseconds);
|
||||||
|
this.registerInterval(intervalID);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
enableAutoClearSyncPlanHist() {
|
||||||
|
const initClearSyncPlanHistAfterMilliseconds = 1000 * 45;
|
||||||
|
const autoClearSyncPlanHistAfterMilliseconds = 1000 * 60 * 5;
|
||||||
|
|
||||||
|
this.app.workspace.onLayoutReady(() => {
|
||||||
|
// init run
|
||||||
|
window.setTimeout(() => {
|
||||||
|
clearExpiredSyncPlanRecords(this.db);
|
||||||
|
}, initClearSyncPlanHistAfterMilliseconds);
|
||||||
|
|
||||||
|
// scheduled run
|
||||||
|
const intervalID = window.setInterval(() => {
|
||||||
|
clearExpiredSyncPlanRecords(this.db);
|
||||||
|
}, autoClearSyncPlanHistAfterMilliseconds);
|
||||||
|
this.registerInterval(intervalID);
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,113 @@
|
|||||||
|
import isEqual from "lodash/isEqual";
|
||||||
|
import { base64url } from "rfc4648";
|
||||||
|
import { reverseString } from "./misc";
|
||||||
|
import { log } from "./moreOnLog";
|
||||||
|
|
||||||
|
const DEFAULT_README_FOR_METADATAONREMOTE =
|
||||||
|
"Do NOT edit or delete the file manually. This file is for the plugin remotely-save to store some necessary meta data on the remote services. Its content is slightly obfuscated.";
|
||||||
|
|
||||||
|
const DEFAULT_VERSION_FOR_METADATAONREMOTE = "20220220";
|
||||||
|
|
||||||
|
export const DEFAULT_FILE_NAME_FOR_METADATAONREMOTE =
|
||||||
|
"_remotely-save-metadata-on-remote.json";
|
||||||
|
|
||||||
|
export const DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2 =
|
||||||
|
"_remotely-save-metadata-on-remote.bin";
|
||||||
|
|
||||||
|
export interface DeletionOnRemote {
|
||||||
|
key: string;
|
||||||
|
actionWhen: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface MetadataOnRemote {
|
||||||
|
version?: string;
|
||||||
|
generatedWhen?: number;
|
||||||
|
deletions?: DeletionOnRemote[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export const isEqualMetadataOnRemote = (
|
||||||
|
a: MetadataOnRemote,
|
||||||
|
b: MetadataOnRemote
|
||||||
|
) => {
|
||||||
|
const m1 = a === undefined ? { deletions: [] } : a;
|
||||||
|
const m2 = b === undefined ? { deletions: [] } : b;
|
||||||
|
|
||||||
|
// we only need to compare deletions
|
||||||
|
const d1 = m1.deletions === undefined ? [] : m1.deletions;
|
||||||
|
const d2 = m2.deletions === undefined ? [] : m2.deletions;
|
||||||
|
return isEqual(d1, d2);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const serializeMetadataOnRemote = (x: MetadataOnRemote) => {
|
||||||
|
const y = x;
|
||||||
|
|
||||||
|
if (y["version"] === undefined) {
|
||||||
|
y["version"] === DEFAULT_VERSION_FOR_METADATAONREMOTE;
|
||||||
|
}
|
||||||
|
if (y["generatedWhen"] === undefined) {
|
||||||
|
y["generatedWhen"] = Date.now();
|
||||||
|
}
|
||||||
|
if (y["deletions"] === undefined) {
|
||||||
|
y["deletions"] = [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const z = {
|
||||||
|
readme: DEFAULT_README_FOR_METADATAONREMOTE,
|
||||||
|
d: reverseString(
|
||||||
|
base64url.stringify(Buffer.from(JSON.stringify(x), "utf-8"), {
|
||||||
|
pad: false,
|
||||||
|
})
|
||||||
|
),
|
||||||
|
};
|
||||||
|
|
||||||
|
return JSON.stringify(z, null, 2);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const deserializeMetadataOnRemote = (x: string | ArrayBuffer) => {
|
||||||
|
let y1 = "";
|
||||||
|
if (typeof x === "string") {
|
||||||
|
y1 = x;
|
||||||
|
} else {
|
||||||
|
y1 = new TextDecoder().decode(x);
|
||||||
|
}
|
||||||
|
|
||||||
|
let y2: any;
|
||||||
|
try {
|
||||||
|
y2 = JSON.parse(y1);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error(
|
||||||
|
`invalid remote meta data file with first few chars: ${y1.slice(0, 5)}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!("readme" in y2 && "d" in y2)) {
|
||||||
|
throw new Error(
|
||||||
|
'invalid remote meta data file (no "readme" or "d" fields)!'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
let y3: string;
|
||||||
|
try {
|
||||||
|
y3 = (
|
||||||
|
base64url.parse(reverseString(y2["d"]), {
|
||||||
|
out: Buffer.allocUnsafe as any,
|
||||||
|
loose: true,
|
||||||
|
}) as Buffer
|
||||||
|
).toString("utf-8");
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error('invalid remote meta data file (invalid "d" field)!');
|
||||||
|
}
|
||||||
|
|
||||||
|
let y4: MetadataOnRemote;
|
||||||
|
try {
|
||||||
|
y4 = JSON.parse(y3) as MetadataOnRemote;
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error(
|
||||||
|
`invalid remote meta data file with \"d\" field with first few chars: ${y3.slice(
|
||||||
|
0,
|
||||||
|
5
|
||||||
|
)}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return y4;
|
||||||
|
};
|
||||||
+211
-11
@@ -3,17 +3,31 @@ import * as path from "path";
|
|||||||
|
|
||||||
import { base32, base64url } from "rfc4648";
|
import { base32, base64url } from "rfc4648";
|
||||||
import XRegExp from "xregexp";
|
import XRegExp from "xregexp";
|
||||||
|
import emojiRegex from "emoji-regex";
|
||||||
|
|
||||||
import * as origLog from "loglevel";
|
import { log } from "./moreOnLog";
|
||||||
const log = origLog.getLogger("rs-default");
|
|
||||||
|
declare global {
|
||||||
|
interface Window {
|
||||||
|
moment: (...data: any) => any;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* If any part of the file starts with '.' or '_' then it's a hidden file.
|
* If any part of the file starts with '.' or '_' then it's a hidden file.
|
||||||
* @param item
|
* @param item
|
||||||
* @param loose
|
* @param dot
|
||||||
|
* @param underscore
|
||||||
* @returns
|
* @returns
|
||||||
*/
|
*/
|
||||||
export const isHiddenPath = (item: string, loose: boolean = true) => {
|
export const isHiddenPath = (
|
||||||
|
item: string,
|
||||||
|
dot: boolean = true,
|
||||||
|
underscore: boolean = true
|
||||||
|
) => {
|
||||||
|
if (!(dot || underscore)) {
|
||||||
|
throw Error("parameter error for isHiddenPath");
|
||||||
|
}
|
||||||
const k = path.posix.normalize(item); // TODO: only unix path now
|
const k = path.posix.normalize(item); // TODO: only unix path now
|
||||||
const k2 = k.split("/"); // TODO: only unix path now
|
const k2 = k.split("/"); // TODO: only unix path now
|
||||||
// log.info(k2)
|
// log.info(k2)
|
||||||
@@ -21,10 +35,10 @@ export const isHiddenPath = (item: string, loose: boolean = true) => {
|
|||||||
if (singlePart === "." || singlePart === ".." || singlePart === "") {
|
if (singlePart === "." || singlePart === ".." || singlePart === "") {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
if (singlePart[0] === ".") {
|
if (dot && singlePart[0] === ".") {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
if (loose && singlePart[0] === "_") {
|
if (underscore && singlePart[0] === "_") {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -38,7 +52,7 @@ export const isHiddenPath = (item: string, loose: boolean = true) => {
|
|||||||
* @param x string
|
* @param x string
|
||||||
* @returns string[] might be empty
|
* @returns string[] might be empty
|
||||||
*/
|
*/
|
||||||
export const getFolderLevels = (x: string) => {
|
export const getFolderLevels = (x: string, addEndingSlash: boolean = false) => {
|
||||||
const res: string[] = [];
|
const res: string[] = [];
|
||||||
|
|
||||||
if (x === "" || x === "/") {
|
if (x === "" || x === "/") {
|
||||||
@@ -48,10 +62,14 @@ export const getFolderLevels = (x: string) => {
|
|||||||
const y1 = x.split("/");
|
const y1 = x.split("/");
|
||||||
let i = 0;
|
let i = 0;
|
||||||
for (let index = 0; index + 1 < y1.length; index++) {
|
for (let index = 0; index + 1 < y1.length; index++) {
|
||||||
const k = y1.slice(0, index + 1).join("/");
|
let k = y1.slice(0, index + 1).join("/");
|
||||||
if (k !== "" && k !== "/") {
|
if (k === "" || k === "/") {
|
||||||
res.push(k);
|
continue;
|
||||||
}
|
}
|
||||||
|
if (addEndingSlash) {
|
||||||
|
k = `${k}/`;
|
||||||
|
}
|
||||||
|
res.push(k);
|
||||||
}
|
}
|
||||||
return res;
|
return res;
|
||||||
};
|
};
|
||||||
@@ -75,7 +93,9 @@ export const mkdirpInVault = async (thePath: string, vault: Vault) => {
|
|||||||
* @param b Buffer
|
* @param b Buffer
|
||||||
* @returns ArrayBuffer
|
* @returns ArrayBuffer
|
||||||
*/
|
*/
|
||||||
export const bufferToArrayBuffer = (b: Buffer | Uint8Array) => {
|
export const bufferToArrayBuffer = (
|
||||||
|
b: Buffer | Uint8Array | ArrayBufferView
|
||||||
|
) => {
|
||||||
return b.buffer.slice(b.byteOffset, b.byteOffset + b.byteLength);
|
return b.buffer.slice(b.byteOffset, b.byteOffset + b.byteLength);
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -143,6 +163,34 @@ export const isVaildText = (a: string) => {
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Use regex to detect a text contains emoji or not.
|
||||||
|
* @param a
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
export const hasEmojiInText = (a: string) => {
|
||||||
|
const regex = emojiRegex();
|
||||||
|
return regex.test(a);
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert the headers to a normal object.
|
||||||
|
* @param h
|
||||||
|
* @param toLower
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
export const headersToRecord = (h: Headers, toLower: boolean = true) => {
|
||||||
|
const res: Record<string, string> = {};
|
||||||
|
h.forEach((v, k) => {
|
||||||
|
if (toLower) {
|
||||||
|
res[k.toLowerCase()] = v;
|
||||||
|
} else {
|
||||||
|
res[k] = v;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return res;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* If input is already a folder, returns it as is;
|
* If input is already a folder, returns it as is;
|
||||||
* And if input is a file, returns its direname.
|
* And if input is a file, returns its direname.
|
||||||
@@ -157,6 +205,24 @@ export const getPathFolder = (a: string) => {
|
|||||||
return b.endsWith("/") ? b : `${b}/`;
|
return b.endsWith("/") ? b : `${b}/`;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If input is already a folder, returns its folder;
|
||||||
|
* And if input is a file, returns its direname.
|
||||||
|
* @param a
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
export const getParentFolder = (a: string) => {
|
||||||
|
const b = path.posix.dirname(a);
|
||||||
|
if (b === "." || b === "/") {
|
||||||
|
// the root
|
||||||
|
return "/";
|
||||||
|
}
|
||||||
|
if (b.endsWith("/")) {
|
||||||
|
return b;
|
||||||
|
}
|
||||||
|
return `${b}/`;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* https://stackoverflow.com/questions/54511144
|
* https://stackoverflow.com/questions/54511144
|
||||||
* @param a
|
* @param a
|
||||||
@@ -208,3 +274,137 @@ export const getRandomArrayBuffer = (byteLength: number) => {
|
|||||||
export const reverseString = (x: string) => {
|
export const reverseString = (x: string) => {
|
||||||
return [...x].reverse().join("");
|
return [...x].reverse().join("");
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export interface SplitRange {
|
||||||
|
partNum: number; // startting from 1
|
||||||
|
start: number;
|
||||||
|
end: number; // exclusive
|
||||||
|
}
|
||||||
|
export const getSplitRanges = (bytesTotal: number, bytesEachPart: number) => {
|
||||||
|
const res: SplitRange[] = [];
|
||||||
|
if (bytesEachPart >= bytesTotal) {
|
||||||
|
res.push({
|
||||||
|
partNum: 1,
|
||||||
|
start: 0,
|
||||||
|
end: bytesTotal,
|
||||||
|
});
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
const remainder = bytesTotal % bytesEachPart;
|
||||||
|
const howMany =
|
||||||
|
Math.floor(bytesTotal / bytesEachPart) + (remainder === 0 ? 0 : 1);
|
||||||
|
for (let i = 0; i < howMany; ++i) {
|
||||||
|
res.push({
|
||||||
|
partNum: i + 1,
|
||||||
|
start: bytesEachPart * i,
|
||||||
|
end: Math.min(bytesEachPart * (i + 1), bytesTotal),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* https://stackoverflow.com/questions/332422
|
||||||
|
* @param obj anything
|
||||||
|
* @returns string of the name of the object
|
||||||
|
*/
|
||||||
|
export const getTypeName = (obj: any) => {
|
||||||
|
return Object.prototype.toString.call(obj).slice(8, -1);
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Startting from 1
|
||||||
|
* @param x
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
export const atWhichLevel = (x: string) => {
|
||||||
|
if (
|
||||||
|
x === undefined ||
|
||||||
|
x === "" ||
|
||||||
|
x === "." ||
|
||||||
|
x === ".." ||
|
||||||
|
x.startsWith("/")
|
||||||
|
) {
|
||||||
|
throw Error(`do not know which level for ${x}`);
|
||||||
|
}
|
||||||
|
let y = x;
|
||||||
|
if (x.endsWith("/")) {
|
||||||
|
y = x.slice(0, -1);
|
||||||
|
}
|
||||||
|
return y.split("/").length;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const checkHasSpecialCharForDir = (x: string) => {
|
||||||
|
return /[?/\\]/.test(x);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const unixTimeToStr = (x: number | undefined | null) => {
|
||||||
|
if (x === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
if (x === null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return window.moment(x).format() as string;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value#examples
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
const getCircularReplacer = () => {
|
||||||
|
const seen = new WeakSet();
|
||||||
|
return (key: any, value: any) => {
|
||||||
|
if (typeof value === "object" && value !== null) {
|
||||||
|
if (seen.has(value)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
seen.add(value);
|
||||||
|
}
|
||||||
|
return value;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert "any" value to string.
|
||||||
|
* @param x
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
export const toText = (x: any) => {
|
||||||
|
if (x === undefined || x === null) {
|
||||||
|
return `${x}`;
|
||||||
|
}
|
||||||
|
if (typeof x === "string") {
|
||||||
|
return x;
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
x instanceof String ||
|
||||||
|
x instanceof Date ||
|
||||||
|
typeof x === "number" ||
|
||||||
|
typeof x === "bigint" ||
|
||||||
|
typeof x === "boolean"
|
||||||
|
) {
|
||||||
|
return `${x}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
x instanceof Error ||
|
||||||
|
(x &&
|
||||||
|
x.stack &&
|
||||||
|
x.message &&
|
||||||
|
typeof x.stack === "string" &&
|
||||||
|
typeof x.message === "string")
|
||||||
|
) {
|
||||||
|
return `ERROR! MESSAGE: ${x.message}, STACK: ${x.stack}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const y = JSON.stringify(x, getCircularReplacer(), 2);
|
||||||
|
if (y !== undefined) {
|
||||||
|
return y;
|
||||||
|
}
|
||||||
|
throw new Error("not jsonable");
|
||||||
|
} catch {
|
||||||
|
return `${x}`;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|||||||
@@ -0,0 +1,34 @@
|
|||||||
|
// It's very dangerous for this file to depend on other files in the same project.
|
||||||
|
// We should avoid this situation as much as possible.
|
||||||
|
|
||||||
|
import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
|
||||||
|
|
||||||
|
import * as origLog from "loglevel";
|
||||||
|
import type { LogLevelNumbers, Logger, LogLevel, LogLevelDesc } from "loglevel";
|
||||||
|
const log2 = origLog.getLogger("rs-default");
|
||||||
|
|
||||||
|
const originalFactory = log2.methodFactory;
|
||||||
|
|
||||||
|
export const applyLogWriterInplace = function (writer: (...msg: any[]) => any) {
|
||||||
|
log2.methodFactory = function (
|
||||||
|
methodName: string,
|
||||||
|
logLevel: LogLevelNumbers,
|
||||||
|
loggerName: string | symbol
|
||||||
|
) {
|
||||||
|
const rawMethod = originalFactory(methodName, logLevel, loggerName);
|
||||||
|
|
||||||
|
return function (...msg: any[]) {
|
||||||
|
rawMethod.apply(undefined, msg);
|
||||||
|
writer(...msg);
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
log2.setLevel(log2.getLevel());
|
||||||
|
};
|
||||||
|
|
||||||
|
export const restoreLogWritterInplace = () => {
|
||||||
|
log2.methodFactory = originalFactory;
|
||||||
|
log2.setLevel(log2.getLevel());
|
||||||
|
};
|
||||||
|
|
||||||
|
export const log = log2;
|
||||||
@@ -0,0 +1,124 @@
|
|||||||
|
import { Vault, Stat, ListedFiles } from "obsidian";
|
||||||
|
import { Queue } from "@fyears/tsqueue";
|
||||||
|
import chunk from "lodash/chunk";
|
||||||
|
import flatten from "lodash/flatten";
|
||||||
|
|
||||||
|
export interface ObsConfigDirFileType {
|
||||||
|
key: string;
|
||||||
|
ctime: number;
|
||||||
|
mtime: number;
|
||||||
|
size: number;
|
||||||
|
type: "folder" | "file";
|
||||||
|
}
|
||||||
|
|
||||||
|
const isFolderToSkip = (x: string) => {
|
||||||
|
let specialFolders = [".git", ".svn", "node_modules"];
|
||||||
|
for (const iterator of specialFolders) {
|
||||||
|
if (
|
||||||
|
x === iterator ||
|
||||||
|
x === `${iterator}/` ||
|
||||||
|
x.endsWith(`/${iterator}`) ||
|
||||||
|
x.endsWith(`/${iterator}/`)
|
||||||
|
) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
|
||||||
|
const isPluginDirItself = (x: string, pluginId: string) => {
|
||||||
|
return (
|
||||||
|
x === pluginId ||
|
||||||
|
x === `${pluginId}/` ||
|
||||||
|
x.endsWith(`/${pluginId}`) ||
|
||||||
|
x.endsWith(`/${pluginId}/`)
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
const isLikelyPluginSubFiles = (x: string) => {
|
||||||
|
const reqFiles = [
|
||||||
|
"data.json",
|
||||||
|
"main.js",
|
||||||
|
"manifest.json",
|
||||||
|
".gitignore",
|
||||||
|
"styles.css",
|
||||||
|
];
|
||||||
|
for (const iterator of reqFiles) {
|
||||||
|
if (x === iterator || x.endsWith(`/${iterator}`)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const isInsideObsFolder = (x: string, configDir: string) => {
|
||||||
|
if (!configDir.startsWith(".")) {
|
||||||
|
throw Error(`configDir should starts with . but we get ${configDir}`);
|
||||||
|
}
|
||||||
|
return x === configDir || x.startsWith(`${configDir}/`);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const listFilesInObsFolder = async (
|
||||||
|
configDir: string,
|
||||||
|
vault: Vault,
|
||||||
|
pluginId: string
|
||||||
|
) => {
|
||||||
|
const q = new Queue([configDir]);
|
||||||
|
const CHUNK_SIZE = 10;
|
||||||
|
const contents: ObsConfigDirFileType[] = [];
|
||||||
|
while (q.length > 0) {
|
||||||
|
const itemsToFetch = [];
|
||||||
|
while (q.length > 0) {
|
||||||
|
itemsToFetch.push(q.pop());
|
||||||
|
}
|
||||||
|
|
||||||
|
const itemsToFetchChunks = chunk(itemsToFetch, CHUNK_SIZE);
|
||||||
|
for (const singleChunk of itemsToFetchChunks) {
|
||||||
|
const r = singleChunk.map(async (x) => {
|
||||||
|
const statRes = await vault.adapter.stat(x);
|
||||||
|
const isFolder = statRes.type === "folder";
|
||||||
|
let children: ListedFiles = undefined;
|
||||||
|
if (isFolder) {
|
||||||
|
children = await vault.adapter.list(x);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
itself: {
|
||||||
|
key: isFolder ? `${x}/` : x,
|
||||||
|
...statRes,
|
||||||
|
} as ObsConfigDirFileType,
|
||||||
|
children: children,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
const r2 = flatten(await Promise.all(r));
|
||||||
|
|
||||||
|
for (const iter of r2) {
|
||||||
|
contents.push(iter.itself);
|
||||||
|
const isInsideSelfPlugin = isPluginDirItself(iter.itself.key, pluginId);
|
||||||
|
if (iter.children !== undefined) {
|
||||||
|
for (const iter2 of iter.children.folders) {
|
||||||
|
if (isFolderToSkip(iter2)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (isInsideSelfPlugin && !isLikelyPluginSubFiles(iter2)) {
|
||||||
|
// special treatment for remotely-save folder
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
q.push(iter2);
|
||||||
|
}
|
||||||
|
for (const iter2 of iter.children.files) {
|
||||||
|
if (isFolderToSkip(iter2)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (isInsideSelfPlugin && !isLikelyPluginSubFiles(iter2)) {
|
||||||
|
// special treatment for remotely-save folder
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
q.push(iter2);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return contents;
|
||||||
|
};
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
import type {
|
||||||
|
RemotelySavePluginSettings,
|
||||||
|
WebdavConfig,
|
||||||
|
WebdavDepthType,
|
||||||
|
} from "./baseTypes";
|
||||||
|
|
||||||
|
const RULES = {
|
||||||
|
webdav: {
|
||||||
|
depth: [
|
||||||
|
{
|
||||||
|
url: "^https://(.+).teracloud.jp/.+",
|
||||||
|
depth: "auto_1",
|
||||||
|
manualRecursive: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: "^https://dav.jianguoyun.com/dav/",
|
||||||
|
depth: "auto_1",
|
||||||
|
manualRecursive: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const applyWebdavPresetRulesInplace = (
|
||||||
|
webdav: Partial<WebdavConfig> | undefined
|
||||||
|
) => {
|
||||||
|
if (webdav === undefined) {
|
||||||
|
return {
|
||||||
|
changed: false,
|
||||||
|
webdav: webdav,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
for (const { url, depth, manualRecursive } of RULES.webdav.depth) {
|
||||||
|
if (
|
||||||
|
webdav.address !== undefined &&
|
||||||
|
new RegExp(url).test(webdav.address) &&
|
||||||
|
webdav.depth !== undefined &&
|
||||||
|
webdav.depth.startsWith("auto_") &&
|
||||||
|
webdav.depth !== depth
|
||||||
|
) {
|
||||||
|
webdav.depth = depth as WebdavDepthType;
|
||||||
|
webdav.manualRecursive = manualRecursive;
|
||||||
|
return {
|
||||||
|
changed: true,
|
||||||
|
webdav: webdav,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
changed: false,
|
||||||
|
webdav: webdav,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export const applyPresetRulesInplace = (
|
||||||
|
settings: RemotelySavePluginSettings | undefined
|
||||||
|
) => {
|
||||||
|
if (settings === undefined) {
|
||||||
|
return {
|
||||||
|
changed: false,
|
||||||
|
settings: settings,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
const webdavRes = applyWebdavPresetRulesInplace(settings.webdav);
|
||||||
|
return {
|
||||||
|
changed: webdavRes.changed,
|
||||||
|
settings: settings,
|
||||||
|
};
|
||||||
|
};
|
||||||
+61
-29
@@ -11,12 +11,10 @@ import * as onedrive from "./remoteForOnedrive";
|
|||||||
import * as s3 from "./remoteForS3";
|
import * as s3 from "./remoteForS3";
|
||||||
import * as webdav from "./remoteForWebdav";
|
import * as webdav from "./remoteForWebdav";
|
||||||
|
|
||||||
import * as origLog from "loglevel";
|
import { log } from "./moreOnLog";
|
||||||
const log = origLog.getLogger("rs-default");
|
|
||||||
|
|
||||||
export class RemoteClient {
|
export class RemoteClient {
|
||||||
readonly serviceType: SUPPORTED_SERVICES_TYPE;
|
readonly serviceType: SUPPORTED_SERVICES_TYPE;
|
||||||
readonly s3Client?: s3.S3Client;
|
|
||||||
readonly s3Config?: S3Config;
|
readonly s3Config?: S3Config;
|
||||||
readonly webdavClient?: webdav.WrappedWebdavClient;
|
readonly webdavClient?: webdav.WrappedWebdavClient;
|
||||||
readonly webdavConfig?: WebdavConfig;
|
readonly webdavConfig?: WebdavConfig;
|
||||||
@@ -39,23 +37,30 @@ export class RemoteClient {
|
|||||||
// so we use a ref not copy of config here
|
// so we use a ref not copy of config here
|
||||||
if (serviceType === "s3") {
|
if (serviceType === "s3") {
|
||||||
this.s3Config = s3Config;
|
this.s3Config = s3Config;
|
||||||
this.s3Client = s3.getS3Client(this.s3Config);
|
|
||||||
} else if (serviceType === "webdav") {
|
} else if (serviceType === "webdav") {
|
||||||
if (vaultName === undefined) {
|
if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
|
||||||
throw Error("remember to provide vault name while init webdav client");
|
throw Error(
|
||||||
|
"remember to provide vault name and callback while init webdav client"
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
const remoteBaseDir = webdavConfig.remoteBaseDir || vaultName;
|
||||||
this.webdavConfig = webdavConfig;
|
this.webdavConfig = webdavConfig;
|
||||||
this.webdavClient = webdav.getWebdavClient(this.webdavConfig, vaultName);
|
this.webdavClient = webdav.getWebdavClient(
|
||||||
|
this.webdavConfig,
|
||||||
|
remoteBaseDir,
|
||||||
|
saveUpdatedConfigFunc
|
||||||
|
);
|
||||||
} else if (serviceType === "dropbox") {
|
} else if (serviceType === "dropbox") {
|
||||||
if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
|
if (vaultName === undefined || saveUpdatedConfigFunc === undefined) {
|
||||||
throw Error(
|
throw Error(
|
||||||
"remember to provide vault name and callback while init dropbox client"
|
"remember to provide vault name and callback while init dropbox client"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
const remoteBaseDir = dropboxConfig.remoteBaseDir || vaultName;
|
||||||
this.dropboxConfig = dropboxConfig;
|
this.dropboxConfig = dropboxConfig;
|
||||||
this.dropboxClient = dropbox.getDropboxClient(
|
this.dropboxClient = dropbox.getDropboxClient(
|
||||||
this.dropboxConfig,
|
this.dropboxConfig,
|
||||||
vaultName,
|
remoteBaseDir,
|
||||||
saveUpdatedConfigFunc
|
saveUpdatedConfigFunc
|
||||||
);
|
);
|
||||||
} else if (serviceType === "onedrive") {
|
} else if (serviceType === "onedrive") {
|
||||||
@@ -64,10 +69,11 @@ export class RemoteClient {
|
|||||||
"remember to provide vault name and callback while init onedrive client"
|
"remember to provide vault name and callback while init onedrive client"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
const remoteBaseDir = onedriveConfig.remoteBaseDir || vaultName;
|
||||||
this.onedriveConfig = onedriveConfig;
|
this.onedriveConfig = onedriveConfig;
|
||||||
this.onedriveClient = onedrive.getOnedriveClient(
|
this.onedriveClient = onedrive.getOnedriveClient(
|
||||||
this.onedriveConfig,
|
this.onedriveConfig,
|
||||||
vaultName,
|
remoteBaseDir,
|
||||||
saveUpdatedConfigFunc
|
saveUpdatedConfigFunc
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
@@ -78,7 +84,7 @@ export class RemoteClient {
|
|||||||
getRemoteMeta = async (fileOrFolderPath: string) => {
|
getRemoteMeta = async (fileOrFolderPath: string) => {
|
||||||
if (this.serviceType === "s3") {
|
if (this.serviceType === "s3") {
|
||||||
return await s3.getRemoteMeta(
|
return await s3.getRemoteMeta(
|
||||||
this.s3Client,
|
s3.getS3Client(this.s3Config),
|
||||||
this.s3Config,
|
this.s3Config,
|
||||||
fileOrFolderPath
|
fileOrFolderPath
|
||||||
);
|
);
|
||||||
@@ -102,17 +108,21 @@ export class RemoteClient {
|
|||||||
isRecursively: boolean = false,
|
isRecursively: boolean = false,
|
||||||
password: string = "",
|
password: string = "",
|
||||||
remoteEncryptedKey: string = "",
|
remoteEncryptedKey: string = "",
|
||||||
foldersCreatedBefore: Set<string> | undefined = undefined
|
foldersCreatedBefore: Set<string> | undefined = undefined,
|
||||||
|
uploadRaw: boolean = false,
|
||||||
|
rawContent: string | ArrayBuffer = ""
|
||||||
) => {
|
) => {
|
||||||
if (this.serviceType === "s3") {
|
if (this.serviceType === "s3") {
|
||||||
return await s3.uploadToRemote(
|
return await s3.uploadToRemote(
|
||||||
this.s3Client,
|
s3.getS3Client(this.s3Config),
|
||||||
this.s3Config,
|
this.s3Config,
|
||||||
fileOrFolderPath,
|
fileOrFolderPath,
|
||||||
vault,
|
vault,
|
||||||
isRecursively,
|
isRecursively,
|
||||||
password,
|
password,
|
||||||
remoteEncryptedKey
|
remoteEncryptedKey,
|
||||||
|
uploadRaw,
|
||||||
|
rawContent
|
||||||
);
|
);
|
||||||
} else if (this.serviceType === "webdav") {
|
} else if (this.serviceType === "webdav") {
|
||||||
return await webdav.uploadToRemote(
|
return await webdav.uploadToRemote(
|
||||||
@@ -121,7 +131,9 @@ export class RemoteClient {
|
|||||||
vault,
|
vault,
|
||||||
isRecursively,
|
isRecursively,
|
||||||
password,
|
password,
|
||||||
remoteEncryptedKey
|
remoteEncryptedKey,
|
||||||
|
uploadRaw,
|
||||||
|
rawContent
|
||||||
);
|
);
|
||||||
} else if (this.serviceType === "dropbox") {
|
} else if (this.serviceType === "dropbox") {
|
||||||
return await dropbox.uploadToRemote(
|
return await dropbox.uploadToRemote(
|
||||||
@@ -131,7 +143,9 @@ export class RemoteClient {
|
|||||||
isRecursively,
|
isRecursively,
|
||||||
password,
|
password,
|
||||||
remoteEncryptedKey,
|
remoteEncryptedKey,
|
||||||
foldersCreatedBefore
|
foldersCreatedBefore,
|
||||||
|
uploadRaw,
|
||||||
|
rawContent
|
||||||
);
|
);
|
||||||
} else if (this.serviceType === "onedrive") {
|
} else if (this.serviceType === "onedrive") {
|
||||||
return await onedrive.uploadToRemote(
|
return await onedrive.uploadToRemote(
|
||||||
@@ -141,7 +155,9 @@ export class RemoteClient {
|
|||||||
isRecursively,
|
isRecursively,
|
||||||
password,
|
password,
|
||||||
remoteEncryptedKey,
|
remoteEncryptedKey,
|
||||||
foldersCreatedBefore
|
foldersCreatedBefore,
|
||||||
|
uploadRaw,
|
||||||
|
rawContent
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
throw Error(`not supported service type ${this.serviceType}`);
|
throw Error(`not supported service type ${this.serviceType}`);
|
||||||
@@ -150,7 +166,11 @@ export class RemoteClient {
|
|||||||
|
|
||||||
listFromRemote = async (prefix?: string) => {
|
listFromRemote = async (prefix?: string) => {
|
||||||
if (this.serviceType === "s3") {
|
if (this.serviceType === "s3") {
|
||||||
return await s3.listFromRemote(this.s3Client, this.s3Config, prefix);
|
return await s3.listFromRemote(
|
||||||
|
s3.getS3Client(this.s3Config),
|
||||||
|
this.s3Config,
|
||||||
|
prefix
|
||||||
|
);
|
||||||
} else if (this.serviceType === "webdav") {
|
} else if (this.serviceType === "webdav") {
|
||||||
return await webdav.listFromRemote(this.webdavClient, prefix);
|
return await webdav.listFromRemote(this.webdavClient, prefix);
|
||||||
} else if (this.serviceType === "dropbox") {
|
} else if (this.serviceType === "dropbox") {
|
||||||
@@ -167,17 +187,19 @@ export class RemoteClient {
|
|||||||
vault: Vault,
|
vault: Vault,
|
||||||
mtime: number,
|
mtime: number,
|
||||||
password: string = "",
|
password: string = "",
|
||||||
remoteEncryptedKey: string = ""
|
remoteEncryptedKey: string = "",
|
||||||
|
skipSaving: boolean = false
|
||||||
) => {
|
) => {
|
||||||
if (this.serviceType === "s3") {
|
if (this.serviceType === "s3") {
|
||||||
return await s3.downloadFromRemote(
|
return await s3.downloadFromRemote(
|
||||||
this.s3Client,
|
s3.getS3Client(this.s3Config),
|
||||||
this.s3Config,
|
this.s3Config,
|
||||||
fileOrFolderPath,
|
fileOrFolderPath,
|
||||||
vault,
|
vault,
|
||||||
mtime,
|
mtime,
|
||||||
password,
|
password,
|
||||||
remoteEncryptedKey
|
remoteEncryptedKey,
|
||||||
|
skipSaving
|
||||||
);
|
);
|
||||||
} else if (this.serviceType === "webdav") {
|
} else if (this.serviceType === "webdav") {
|
||||||
return await webdav.downloadFromRemote(
|
return await webdav.downloadFromRemote(
|
||||||
@@ -186,7 +208,8 @@ export class RemoteClient {
|
|||||||
vault,
|
vault,
|
||||||
mtime,
|
mtime,
|
||||||
password,
|
password,
|
||||||
remoteEncryptedKey
|
remoteEncryptedKey,
|
||||||
|
skipSaving
|
||||||
);
|
);
|
||||||
} else if (this.serviceType === "dropbox") {
|
} else if (this.serviceType === "dropbox") {
|
||||||
return await dropbox.downloadFromRemote(
|
return await dropbox.downloadFromRemote(
|
||||||
@@ -195,7 +218,8 @@ export class RemoteClient {
|
|||||||
vault,
|
vault,
|
||||||
mtime,
|
mtime,
|
||||||
password,
|
password,
|
||||||
remoteEncryptedKey
|
remoteEncryptedKey,
|
||||||
|
skipSaving
|
||||||
);
|
);
|
||||||
} else if (this.serviceType === "onedrive") {
|
} else if (this.serviceType === "onedrive") {
|
||||||
return await onedrive.downloadFromRemote(
|
return await onedrive.downloadFromRemote(
|
||||||
@@ -204,7 +228,8 @@ export class RemoteClient {
|
|||||||
vault,
|
vault,
|
||||||
mtime,
|
mtime,
|
||||||
password,
|
password,
|
||||||
remoteEncryptedKey
|
remoteEncryptedKey,
|
||||||
|
skipSaving
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
throw Error(`not supported service type ${this.serviceType}`);
|
throw Error(`not supported service type ${this.serviceType}`);
|
||||||
@@ -218,7 +243,7 @@ export class RemoteClient {
|
|||||||
) => {
|
) => {
|
||||||
if (this.serviceType === "s3") {
|
if (this.serviceType === "s3") {
|
||||||
return await s3.deleteFromRemote(
|
return await s3.deleteFromRemote(
|
||||||
this.s3Client,
|
s3.getS3Client(this.s3Config),
|
||||||
this.s3Config,
|
this.s3Config,
|
||||||
fileOrFolderPath,
|
fileOrFolderPath,
|
||||||
password,
|
password,
|
||||||
@@ -250,15 +275,22 @@ export class RemoteClient {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
checkConnectivity = async () => {
|
checkConnectivity = async (callbackFunc?: any) => {
|
||||||
if (this.serviceType === "s3") {
|
if (this.serviceType === "s3") {
|
||||||
return await s3.checkConnectivity(this.s3Client, this.s3Config);
|
return await s3.checkConnectivity(
|
||||||
|
s3.getS3Client(this.s3Config),
|
||||||
|
this.s3Config,
|
||||||
|
callbackFunc
|
||||||
|
);
|
||||||
} else if (this.serviceType === "webdav") {
|
} else if (this.serviceType === "webdav") {
|
||||||
return await webdav.checkConnectivity(this.webdavClient);
|
return await webdav.checkConnectivity(this.webdavClient, callbackFunc);
|
||||||
} else if (this.serviceType === "dropbox") {
|
} else if (this.serviceType === "dropbox") {
|
||||||
return await dropbox.checkConnectivity(this.dropboxClient);
|
return await dropbox.checkConnectivity(this.dropboxClient, callbackFunc);
|
||||||
} else if (this.serviceType === "onedrive") {
|
} else if (this.serviceType === "onedrive") {
|
||||||
return await onedrive.checkConnectivity(this.onedriveClient);
|
return await onedrive.checkConnectivity(
|
||||||
|
this.onedriveClient,
|
||||||
|
callbackFunc
|
||||||
|
);
|
||||||
} else {
|
} else {
|
||||||
throw Error(`not supported service type ${this.serviceType}`);
|
throw Error(`not supported service type ${this.serviceType}`);
|
||||||
}
|
}
|
||||||
|
|||||||
+233
-78
@@ -1,4 +1,6 @@
|
|||||||
import { Dropbox, DropboxAuth, files } from "dropbox";
|
import delay from "delay";
|
||||||
|
import { Dropbox, DropboxAuth } from "dropbox";
|
||||||
|
import type { files, DropboxResponseError, DropboxResponse } from "dropbox";
|
||||||
import { Vault } from "obsidian";
|
import { Vault } from "obsidian";
|
||||||
import * as path from "path";
|
import * as path from "path";
|
||||||
import {
|
import {
|
||||||
@@ -8,12 +10,17 @@ import {
|
|||||||
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
||||||
} from "./baseTypes";
|
} from "./baseTypes";
|
||||||
import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
|
import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
|
||||||
import { bufferToArrayBuffer, getFolderLevels, mkdirpInVault } from "./misc";
|
import {
|
||||||
|
bufferToArrayBuffer,
|
||||||
|
getFolderLevels,
|
||||||
|
hasEmojiInText,
|
||||||
|
headersToRecord,
|
||||||
|
mkdirpInVault,
|
||||||
|
} from "./misc";
|
||||||
|
|
||||||
export { Dropbox } from "dropbox";
|
export { Dropbox } from "dropbox";
|
||||||
|
|
||||||
import * as origLog from "loglevel";
|
import { log } from "./moreOnLog";
|
||||||
const log = origLog.getLogger("rs-default");
|
|
||||||
|
|
||||||
export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
|
export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
|
||||||
accessToken: "",
|
accessToken: "",
|
||||||
@@ -26,15 +33,18 @@ export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
|
|||||||
credentialsShouldBeDeletedAtTime: 0,
|
credentialsShouldBeDeletedAtTime: 0,
|
||||||
};
|
};
|
||||||
|
|
||||||
export const getDropboxPath = (fileOrFolderPath: string, vaultName: string) => {
|
export const getDropboxPath = (
|
||||||
|
fileOrFolderPath: string,
|
||||||
|
remoteBaseDir: string
|
||||||
|
) => {
|
||||||
let key = fileOrFolderPath;
|
let key = fileOrFolderPath;
|
||||||
if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
|
if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
|
||||||
// special
|
// special
|
||||||
key = `/${vaultName}`;
|
key = `/${remoteBaseDir}`;
|
||||||
}
|
}
|
||||||
if (!fileOrFolderPath.startsWith("/")) {
|
if (!fileOrFolderPath.startsWith("/")) {
|
||||||
// then this is original path in Obsidian
|
// then this is original path in Obsidian
|
||||||
key = `/${vaultName}/${fileOrFolderPath}`;
|
key = `/${remoteBaseDir}/${fileOrFolderPath}`;
|
||||||
}
|
}
|
||||||
if (key.endsWith("/")) {
|
if (key.endsWith("/")) {
|
||||||
key = key.slice(0, key.length - 1);
|
key = key.slice(0, key.length - 1);
|
||||||
@@ -42,16 +52,18 @@ export const getDropboxPath = (fileOrFolderPath: string, vaultName: string) => {
|
|||||||
return key;
|
return key;
|
||||||
};
|
};
|
||||||
|
|
||||||
const getNormPath = (fileOrFolderPath: string, vaultName: string) => {
|
const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||||
if (
|
if (
|
||||||
!(
|
!(
|
||||||
fileOrFolderPath === `/${vaultName}` ||
|
fileOrFolderPath === `/${remoteBaseDir}` ||
|
||||||
fileOrFolderPath.startsWith(`/${vaultName}/`)
|
fileOrFolderPath.startsWith(`/${remoteBaseDir}/`)
|
||||||
)
|
)
|
||||||
) {
|
) {
|
||||||
throw Error(`"${fileOrFolderPath}" doesn't starts with "/${vaultName}/"`);
|
throw Error(
|
||||||
|
`"${fileOrFolderPath}" doesn't starts with "/${remoteBaseDir}/"`
|
||||||
|
);
|
||||||
}
|
}
|
||||||
return fileOrFolderPath.slice(`/${vaultName}/`.length);
|
return fileOrFolderPath.slice(`/${remoteBaseDir}/`.length);
|
||||||
};
|
};
|
||||||
|
|
||||||
const fromDropboxItemToRemoteItem = (
|
const fromDropboxItemToRemoteItem = (
|
||||||
@@ -59,9 +71,9 @@ const fromDropboxItemToRemoteItem = (
|
|||||||
| files.FileMetadataReference
|
| files.FileMetadataReference
|
||||||
| files.FolderMetadataReference
|
| files.FolderMetadataReference
|
||||||
| files.DeletedMetadataReference,
|
| files.DeletedMetadataReference,
|
||||||
vaultName: string
|
remoteBaseDir: string
|
||||||
): RemoteItem => {
|
): RemoteItem => {
|
||||||
let key = getNormPath(x.path_display, vaultName);
|
let key = getNormPath(x.path_display, remoteBaseDir);
|
||||||
if (x[".tag"] === "folder" && !key.endsWith("/")) {
|
if (x[".tag"] === "folder" && !key.endsWith("/")) {
|
||||||
key = `${key}/`;
|
key = `${key}/`;
|
||||||
}
|
}
|
||||||
@@ -156,13 +168,20 @@ const fixLastModifiedTimeInplace = (allFilesFolders: RemoteItem[]) => {
|
|||||||
// see https://dropbox.tech/developers/pkce--what-and-why-
|
// see https://dropbox.tech/developers/pkce--what-and-why-
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
export const getAuthUrlAndVerifier = async (appKey: string) => {
|
export const getAuthUrlAndVerifier = async (
|
||||||
|
appKey: string,
|
||||||
|
needManualPatse: boolean = false
|
||||||
|
) => {
|
||||||
const auth = new DropboxAuth({
|
const auth = new DropboxAuth({
|
||||||
clientId: appKey,
|
clientId: appKey,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const callback = needManualPatse
|
||||||
|
? undefined
|
||||||
|
: `obsidian://${COMMAND_CALLBACK_DROPBOX}`;
|
||||||
const authUrl = (
|
const authUrl = (
|
||||||
await auth.getAuthenticationUrl(
|
await auth.getAuthenticationUrl(
|
||||||
`obsidian://${COMMAND_CALLBACK_DROPBOX}`,
|
callback,
|
||||||
undefined,
|
undefined,
|
||||||
"code",
|
"code",
|
||||||
"offline",
|
"offline",
|
||||||
@@ -259,19 +278,86 @@ export const setConfigBySuccessfullAuthInplace = async (
|
|||||||
// Other usual common methods
|
// Other usual common methods
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
|
interface ErrSubType {
|
||||||
|
error: {
|
||||||
|
retry_after: number;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function retryReq<T>(
|
||||||
|
reqFunc: () => Promise<DropboxResponse<T>>,
|
||||||
|
extraHint: string = ""
|
||||||
|
): Promise<DropboxResponse<T>> {
|
||||||
|
const waitSeconds = [1, 2, 4, 8]; // hard code exponential backoff
|
||||||
|
for (let idx = 0; idx < waitSeconds.length; ++idx) {
|
||||||
|
try {
|
||||||
|
if (idx !== 0) {
|
||||||
|
log.warn(
|
||||||
|
`${extraHint === "" ? "" : extraHint + ": "}The ${
|
||||||
|
idx + 1
|
||||||
|
}-th try starts at time ${Date.now()}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return await reqFunc();
|
||||||
|
} catch (e: unknown) {
|
||||||
|
const err = e as DropboxResponseError<ErrSubType>;
|
||||||
|
if (err.status === undefined) {
|
||||||
|
// then the err is not DropboxResponseError
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
|
if (err.status !== 429) {
|
||||||
|
// then the err is not "too many requests", give up
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (idx === waitSeconds.length - 1) {
|
||||||
|
// the last retry also failed, give up
|
||||||
|
throw new Error(
|
||||||
|
`${
|
||||||
|
extraHint === "" ? "" : extraHint + ": "
|
||||||
|
}"429 too many requests", after retrying for ${
|
||||||
|
idx + 1
|
||||||
|
} times still failed.`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const headers = headersToRecord(err.headers);
|
||||||
|
const svrSec =
|
||||||
|
err.error.error.retry_after ||
|
||||||
|
parseInt(headers["retry-after"] || "1") ||
|
||||||
|
1;
|
||||||
|
const fallbackSec = waitSeconds[idx];
|
||||||
|
const secMin = Math.max(svrSec, fallbackSec);
|
||||||
|
const secMax = Math.max(secMin * 1.8, 2);
|
||||||
|
log.warn(
|
||||||
|
`${
|
||||||
|
extraHint === "" ? "" : extraHint + ": "
|
||||||
|
}We have "429 too many requests" error of ${
|
||||||
|
idx + 1
|
||||||
|
}-th try, at time ${Date.now()}, and wait for ${secMin} ~ ${secMax} seconds to retry. Original info: ${JSON.stringify(
|
||||||
|
err.error,
|
||||||
|
null,
|
||||||
|
2
|
||||||
|
)}`
|
||||||
|
);
|
||||||
|
await delay.range(secMin * 1000, secMax * 1000);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
export class WrappedDropboxClient {
|
export class WrappedDropboxClient {
|
||||||
dropboxConfig: DropboxConfig;
|
dropboxConfig: DropboxConfig;
|
||||||
vaultName: string;
|
remoteBaseDir: string;
|
||||||
saveUpdatedConfigFunc: () => Promise<any>;
|
saveUpdatedConfigFunc: () => Promise<any>;
|
||||||
dropbox: Dropbox;
|
dropbox: Dropbox;
|
||||||
vaultFolderExists: boolean;
|
vaultFolderExists: boolean;
|
||||||
constructor(
|
constructor(
|
||||||
dropboxConfig: DropboxConfig,
|
dropboxConfig: DropboxConfig,
|
||||||
vaultName: string,
|
remoteBaseDir: string,
|
||||||
saveUpdatedConfigFunc: () => Promise<any>
|
saveUpdatedConfigFunc: () => Promise<any>
|
||||||
) {
|
) {
|
||||||
this.dropboxConfig = dropboxConfig;
|
this.dropboxConfig = dropboxConfig;
|
||||||
this.vaultName = vaultName;
|
this.remoteBaseDir = remoteBaseDir;
|
||||||
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||||
this.vaultFolderExists = false;
|
this.vaultFolderExists = false;
|
||||||
}
|
}
|
||||||
@@ -311,29 +397,36 @@ export class WrappedDropboxClient {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// check vault folder
|
// check vault folder
|
||||||
// log.info(`checking remote has folder /${this.vaultName}`);
|
// log.info(`checking remote has folder /${this.remoteBaseDir}`);
|
||||||
if (this.vaultFolderExists) {
|
if (this.vaultFolderExists) {
|
||||||
// log.info(`already checked, /${this.vaultName} exist before`)
|
// log.info(`already checked, /${this.remoteBaseDir} exist before`)
|
||||||
} else {
|
} else {
|
||||||
const res = await this.dropbox.filesListFolder({
|
const res = await this.dropbox.filesListFolder({
|
||||||
path: "",
|
path: "",
|
||||||
recursive: false,
|
recursive: false,
|
||||||
});
|
});
|
||||||
for (const item of res.result.entries) {
|
for (const item of res.result.entries) {
|
||||||
if (item.path_display === `/${this.vaultName}`) {
|
if (item.path_display === `/${this.remoteBaseDir}`) {
|
||||||
this.vaultFolderExists = true;
|
this.vaultFolderExists = true;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (!this.vaultFolderExists) {
|
if (!this.vaultFolderExists) {
|
||||||
log.info(`remote does not have folder /${this.vaultName}`);
|
log.info(`remote does not have folder /${this.remoteBaseDir}`);
|
||||||
|
|
||||||
|
if (hasEmojiInText(`/${this.remoteBaseDir}`)) {
|
||||||
|
throw new Error(
|
||||||
|
`/${this.remoteBaseDir}: Error: Dropbox does not support emoji in folder names.`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
await this.dropbox.filesCreateFolderV2({
|
await this.dropbox.filesCreateFolderV2({
|
||||||
path: `/${this.vaultName}`,
|
path: `/${this.remoteBaseDir}`,
|
||||||
});
|
});
|
||||||
log.info(`remote folder /${this.vaultName} created`);
|
log.info(`remote folder /${this.remoteBaseDir} created`);
|
||||||
this.vaultFolderExists = true;
|
this.vaultFolderExists = true;
|
||||||
} else {
|
} else {
|
||||||
// log.info(`remote folder /${this.vaultName} exists`);
|
// log.info(`remote folder /${this.remoteBaseDir} exists`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -347,12 +440,12 @@ export class WrappedDropboxClient {
|
|||||||
*/
|
*/
|
||||||
export const getDropboxClient = (
|
export const getDropboxClient = (
|
||||||
dropboxConfig: DropboxConfig,
|
dropboxConfig: DropboxConfig,
|
||||||
vaultName: string,
|
remoteBaseDir: string,
|
||||||
saveUpdatedConfigFunc: () => Promise<any>
|
saveUpdatedConfigFunc: () => Promise<any>
|
||||||
) => {
|
) => {
|
||||||
return new WrappedDropboxClient(
|
return new WrappedDropboxClient(
|
||||||
dropboxConfig,
|
dropboxConfig,
|
||||||
vaultName,
|
remoteBaseDir,
|
||||||
saveUpdatedConfigFunc
|
saveUpdatedConfigFunc
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -366,10 +459,12 @@ export const getRemoteMeta = async (
|
|||||||
// filesGetMetadata doesn't support root folder
|
// filesGetMetadata doesn't support root folder
|
||||||
// we instead try to list files
|
// we instead try to list files
|
||||||
// if no error occurs, we ensemble a fake result.
|
// if no error occurs, we ensemble a fake result.
|
||||||
const rsp = await client.dropbox.filesListFolder({
|
const rsp = await retryReq(() =>
|
||||||
path: `/${client.vaultName}`,
|
client.dropbox.filesListFolder({
|
||||||
recursive: false, // don't need to recursive here
|
path: `/${client.remoteBaseDir}`,
|
||||||
});
|
recursive: false, // don't need to recursive here
|
||||||
|
})
|
||||||
|
);
|
||||||
if (rsp.status !== 200) {
|
if (rsp.status !== 200) {
|
||||||
throw Error(JSON.stringify(rsp));
|
throw Error(JSON.stringify(rsp));
|
||||||
}
|
}
|
||||||
@@ -382,15 +477,17 @@ export const getRemoteMeta = async (
|
|||||||
} as RemoteItem;
|
} as RemoteItem;
|
||||||
}
|
}
|
||||||
|
|
||||||
const key = getDropboxPath(fileOrFolderPath, client.vaultName);
|
const key = getDropboxPath(fileOrFolderPath, client.remoteBaseDir);
|
||||||
|
|
||||||
const rsp = await client.dropbox.filesGetMetadata({
|
const rsp = await retryReq(() =>
|
||||||
path: key,
|
client.dropbox.filesGetMetadata({
|
||||||
});
|
path: key,
|
||||||
|
})
|
||||||
|
);
|
||||||
if (rsp.status !== 200) {
|
if (rsp.status !== 200) {
|
||||||
throw Error(JSON.stringify(rsp));
|
throw Error(JSON.stringify(rsp));
|
||||||
}
|
}
|
||||||
return fromDropboxItemToRemoteItem(rsp.result, client.vaultName);
|
return fromDropboxItemToRemoteItem(rsp.result, client.remoteBaseDir);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const uploadToRemote = async (
|
export const uploadToRemote = async (
|
||||||
@@ -400,7 +497,9 @@ export const uploadToRemote = async (
|
|||||||
isRecursively: boolean = false,
|
isRecursively: boolean = false,
|
||||||
password: string = "",
|
password: string = "",
|
||||||
remoteEncryptedKey: string = "",
|
remoteEncryptedKey: string = "",
|
||||||
foldersCreatedBefore: Set<string> | undefined = undefined
|
foldersCreatedBefore: Set<string> | undefined = undefined,
|
||||||
|
uploadRaw: boolean = false,
|
||||||
|
rawContent: string | ArrayBuffer = ""
|
||||||
) => {
|
) => {
|
||||||
await client.init();
|
await client.init();
|
||||||
|
|
||||||
@@ -408,13 +507,22 @@ export const uploadToRemote = async (
|
|||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
uploadFile = remoteEncryptedKey;
|
uploadFile = remoteEncryptedKey;
|
||||||
}
|
}
|
||||||
uploadFile = getDropboxPath(uploadFile, client.vaultName);
|
uploadFile = getDropboxPath(uploadFile, client.remoteBaseDir);
|
||||||
|
|
||||||
|
if (hasEmojiInText(uploadFile)) {
|
||||||
|
throw new Error(
|
||||||
|
`${uploadFile}: Error: Dropbox does not support emoji in file / folder names.`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
const isFolder = fileOrFolderPath.endsWith("/");
|
const isFolder = fileOrFolderPath.endsWith("/");
|
||||||
|
|
||||||
if (isFolder && isRecursively) {
|
if (isFolder && isRecursively) {
|
||||||
throw Error("upload function doesn't implement recursive function yet!");
|
throw Error("upload function doesn't implement recursive function yet!");
|
||||||
} else if (isFolder && !isRecursively) {
|
} else if (isFolder && !isRecursively) {
|
||||||
|
if (uploadRaw) {
|
||||||
|
throw Error(`you specify uploadRaw, but you also provide a folder key!`);
|
||||||
|
}
|
||||||
// folder
|
// folder
|
||||||
if (password === "") {
|
if (password === "") {
|
||||||
// if not encrypted, mkdir a remote folder
|
// if not encrypted, mkdir a remote folder
|
||||||
@@ -422,11 +530,19 @@ export const uploadToRemote = async (
|
|||||||
// created, pass
|
// created, pass
|
||||||
} else {
|
} else {
|
||||||
try {
|
try {
|
||||||
await client.dropbox.filesCreateFolderV2({
|
await retryReq(
|
||||||
path: uploadFile,
|
() =>
|
||||||
});
|
client.dropbox.filesCreateFolderV2({
|
||||||
|
path: uploadFile,
|
||||||
|
}),
|
||||||
|
fileOrFolderPath
|
||||||
|
);
|
||||||
foldersCreatedBefore?.add(uploadFile);
|
foldersCreatedBefore?.add(uploadFile);
|
||||||
} catch (err) {
|
} catch (e: unknown) {
|
||||||
|
const err = e as DropboxResponseError<files.CreateFolderError>;
|
||||||
|
if (err.status === undefined) {
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
if (err.status === 409) {
|
if (err.status === 409) {
|
||||||
// pass
|
// pass
|
||||||
foldersCreatedBefore?.add(uploadFile);
|
foldersCreatedBefore?.add(uploadFile);
|
||||||
@@ -439,33 +555,52 @@ export const uploadToRemote = async (
|
|||||||
return res;
|
return res;
|
||||||
} else {
|
} else {
|
||||||
// if encrypted, upload a fake file with the encrypted file name
|
// if encrypted, upload a fake file with the encrypted file name
|
||||||
await client.dropbox.filesUpload({
|
await retryReq(
|
||||||
path: uploadFile,
|
() =>
|
||||||
contents: "",
|
client.dropbox.filesUpload({
|
||||||
});
|
path: uploadFile,
|
||||||
|
contents: "",
|
||||||
|
}),
|
||||||
|
fileOrFolderPath
|
||||||
|
);
|
||||||
return await getRemoteMeta(client, uploadFile);
|
return await getRemoteMeta(client, uploadFile);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
// file
|
// file
|
||||||
// we ignore isRecursively parameter here
|
// we ignore isRecursively parameter here
|
||||||
const localContent = await vault.adapter.readBinary(fileOrFolderPath);
|
let localContent = undefined;
|
||||||
|
if (uploadRaw) {
|
||||||
|
if (typeof rawContent === "string") {
|
||||||
|
localContent = new TextEncoder().encode(rawContent).buffer;
|
||||||
|
} else {
|
||||||
|
localContent = rawContent;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
localContent = await vault.adapter.readBinary(fileOrFolderPath);
|
||||||
|
}
|
||||||
let remoteContent = localContent;
|
let remoteContent = localContent;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
remoteContent = await encryptArrayBuffer(localContent, password);
|
remoteContent = await encryptArrayBuffer(localContent, password);
|
||||||
}
|
}
|
||||||
// in dropbox, we don't need to create folders before uploading! cool!
|
// in dropbox, we don't need to create folders before uploading! cool!
|
||||||
// TODO: filesUploadSession for larger files (>=150 MB)
|
// TODO: filesUploadSession for larger files (>=150 MB)
|
||||||
await client.dropbox.filesUpload({
|
|
||||||
path: uploadFile,
|
await retryReq(
|
||||||
contents: remoteContent,
|
() =>
|
||||||
mode: {
|
client.dropbox.filesUpload({
|
||||||
".tag": "overwrite",
|
path: uploadFile,
|
||||||
},
|
contents: remoteContent,
|
||||||
});
|
mode: {
|
||||||
|
".tag": "overwrite",
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
fileOrFolderPath
|
||||||
|
);
|
||||||
|
|
||||||
// we want to mark that parent folders are created
|
// we want to mark that parent folders are created
|
||||||
if (foldersCreatedBefore !== undefined) {
|
if (foldersCreatedBefore !== undefined) {
|
||||||
const dirs = getFolderLevels(uploadFile).map((x) =>
|
const dirs = getFolderLevels(uploadFile).map((x) =>
|
||||||
getDropboxPath(x, client.vaultName)
|
getDropboxPath(x, client.remoteBaseDir)
|
||||||
);
|
);
|
||||||
for (const dir of dirs) {
|
for (const dir of dirs) {
|
||||||
foldersCreatedBefore?.add(dir);
|
foldersCreatedBefore?.add(dir);
|
||||||
@@ -484,7 +619,7 @@ export const listFromRemote = async (
|
|||||||
}
|
}
|
||||||
await client.init();
|
await client.init();
|
||||||
let res = await client.dropbox.filesListFolder({
|
let res = await client.dropbox.filesListFolder({
|
||||||
path: `/${client.vaultName}`,
|
path: `/${client.remoteBaseDir}`,
|
||||||
recursive: true,
|
recursive: true,
|
||||||
include_deleted: false,
|
include_deleted: false,
|
||||||
limit: 1000,
|
limit: 1000,
|
||||||
@@ -497,8 +632,8 @@ export const listFromRemote = async (
|
|||||||
const contents = res.result.entries;
|
const contents = res.result.entries;
|
||||||
const unifiedContents = contents
|
const unifiedContents = contents
|
||||||
.filter((x) => x[".tag"] !== "deleted")
|
.filter((x) => x[".tag"] !== "deleted")
|
||||||
.filter((x) => x.path_display !== `/${client.vaultName}`)
|
.filter((x) => x.path_display !== `/${client.remoteBaseDir}`)
|
||||||
.map((x) => fromDropboxItemToRemoteItem(x, client.vaultName));
|
.map((x) => fromDropboxItemToRemoteItem(x, client.remoteBaseDir));
|
||||||
|
|
||||||
while (res.result.has_more) {
|
while (res.result.has_more) {
|
||||||
res = await client.dropbox.filesListFolderContinue({
|
res = await client.dropbox.filesListFolderContinue({
|
||||||
@@ -511,8 +646,8 @@ export const listFromRemote = async (
|
|||||||
const contents2 = res.result.entries;
|
const contents2 = res.result.entries;
|
||||||
const unifiedContents2 = contents2
|
const unifiedContents2 = contents2
|
||||||
.filter((x) => x[".tag"] !== "deleted")
|
.filter((x) => x[".tag"] !== "deleted")
|
||||||
.filter((x) => x.path_display !== `/${client.vaultName}`)
|
.filter((x) => x.path_display !== `/${client.remoteBaseDir}`)
|
||||||
.map((x) => fromDropboxItemToRemoteItem(x, client.vaultName));
|
.map((x) => fromDropboxItemToRemoteItem(x, client.remoteBaseDir));
|
||||||
unifiedContents.push(...unifiedContents2);
|
unifiedContents.push(...unifiedContents2);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -528,10 +663,14 @@ const downloadFromRemoteRaw = async (
|
|||||||
fileOrFolderPath: string
|
fileOrFolderPath: string
|
||||||
) => {
|
) => {
|
||||||
await client.init();
|
await client.init();
|
||||||
const key = getDropboxPath(fileOrFolderPath, client.vaultName);
|
const key = getDropboxPath(fileOrFolderPath, client.remoteBaseDir);
|
||||||
const rsp = await client.dropbox.filesDownload({
|
const rsp = await retryReq(
|
||||||
path: key,
|
() =>
|
||||||
});
|
client.dropbox.filesDownload({
|
||||||
|
path: key,
|
||||||
|
}),
|
||||||
|
fileOrFolderPath
|
||||||
|
);
|
||||||
if ((rsp.result as any).fileBlob !== undefined) {
|
if ((rsp.result as any).fileBlob !== undefined) {
|
||||||
// we get a Blob
|
// we get a Blob
|
||||||
const content = (rsp.result as any).fileBlob as Blob;
|
const content = (rsp.result as any).fileBlob as Blob;
|
||||||
@@ -551,13 +690,16 @@ export const downloadFromRemote = async (
|
|||||||
vault: Vault,
|
vault: Vault,
|
||||||
mtime: number,
|
mtime: number,
|
||||||
password: string = "",
|
password: string = "",
|
||||||
remoteEncryptedKey: string = ""
|
remoteEncryptedKey: string = "",
|
||||||
|
skipSaving: boolean = false
|
||||||
) => {
|
) => {
|
||||||
await client.init();
|
await client.init();
|
||||||
|
|
||||||
const isFolder = fileOrFolderPath.endsWith("/");
|
const isFolder = fileOrFolderPath.endsWith("/");
|
||||||
|
|
||||||
await mkdirpInVault(fileOrFolderPath, vault);
|
if (!skipSaving) {
|
||||||
|
await mkdirpInVault(fileOrFolderPath, vault);
|
||||||
|
}
|
||||||
|
|
||||||
// the file is always local file
|
// the file is always local file
|
||||||
// we need to encrypt it
|
// we need to encrypt it
|
||||||
@@ -565,20 +707,24 @@ export const downloadFromRemote = async (
|
|||||||
if (isFolder) {
|
if (isFolder) {
|
||||||
// mkdirp locally is enough
|
// mkdirp locally is enough
|
||||||
// do nothing here
|
// do nothing here
|
||||||
|
return new ArrayBuffer(0);
|
||||||
} else {
|
} else {
|
||||||
let downloadFile = fileOrFolderPath;
|
let downloadFile = fileOrFolderPath;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
downloadFile = remoteEncryptedKey;
|
downloadFile = remoteEncryptedKey;
|
||||||
}
|
}
|
||||||
downloadFile = getDropboxPath(downloadFile, client.vaultName);
|
downloadFile = getDropboxPath(downloadFile, client.remoteBaseDir);
|
||||||
const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
|
const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
|
||||||
let localContent = remoteContent;
|
let localContent = remoteContent;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
localContent = await decryptArrayBuffer(remoteContent, password);
|
localContent = await decryptArrayBuffer(remoteContent, password);
|
||||||
}
|
}
|
||||||
await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
|
if (!skipSaving) {
|
||||||
mtime: mtime,
|
await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
|
||||||
});
|
mtime: mtime,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return localContent;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -595,20 +741,27 @@ export const deleteFromRemote = async (
|
|||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
remoteFileName = remoteEncryptedKey;
|
remoteFileName = remoteEncryptedKey;
|
||||||
}
|
}
|
||||||
remoteFileName = getDropboxPath(remoteFileName, client.vaultName);
|
remoteFileName = getDropboxPath(remoteFileName, client.remoteBaseDir);
|
||||||
|
|
||||||
await client.init();
|
await client.init();
|
||||||
try {
|
try {
|
||||||
await client.dropbox.filesDeleteV2({
|
await retryReq(
|
||||||
path: remoteFileName,
|
() =>
|
||||||
});
|
client.dropbox.filesDeleteV2({
|
||||||
|
path: remoteFileName,
|
||||||
|
}),
|
||||||
|
fileOrFolderPath
|
||||||
|
);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error("some error while deleting");
|
console.error("some error while deleting");
|
||||||
console.error(err);
|
console.error(err);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
export const checkConnectivity = async (client: WrappedDropboxClient) => {
|
export const checkConnectivity = async (
|
||||||
|
client: WrappedDropboxClient,
|
||||||
|
callbackFunc?: any
|
||||||
|
) => {
|
||||||
try {
|
try {
|
||||||
const results = await getRemoteMeta(client, "/");
|
const results = await getRemoteMeta(client, "/");
|
||||||
if (results === undefined) {
|
if (results === undefined) {
|
||||||
@@ -616,8 +769,10 @@ export const checkConnectivity = async (client: WrappedDropboxClient) => {
|
|||||||
}
|
}
|
||||||
return true;
|
return true;
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error("dropbox connectivity error:");
|
log.debug(err);
|
||||||
console.error(err);
|
if (callbackFunc !== undefined) {
|
||||||
|
callbackFunc(err);
|
||||||
|
}
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|||||||
+197
-111
@@ -6,22 +6,24 @@ import type {
|
|||||||
User,
|
User,
|
||||||
} from "@microsoft/microsoft-graph-types";
|
} from "@microsoft/microsoft-graph-types";
|
||||||
import cloneDeep from "lodash/cloneDeep";
|
import cloneDeep from "lodash/cloneDeep";
|
||||||
import * as origLog from "loglevel";
|
import { request, requestUrl, requireApiVersion, Vault } from "obsidian";
|
||||||
import { request, Vault } from "obsidian";
|
|
||||||
import {
|
import {
|
||||||
|
VALID_REQURL,
|
||||||
COMMAND_CALLBACK_ONEDRIVE,
|
COMMAND_CALLBACK_ONEDRIVE,
|
||||||
|
DEFAULT_CONTENT_TYPE,
|
||||||
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
||||||
OnedriveConfig,
|
OnedriveConfig,
|
||||||
RemoteItem,
|
RemoteItem,
|
||||||
} from "./baseTypes";
|
} from "./baseTypes";
|
||||||
import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
|
import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
|
||||||
import {
|
import {
|
||||||
|
bufferToArrayBuffer,
|
||||||
getRandomArrayBuffer,
|
getRandomArrayBuffer,
|
||||||
getRandomIntInclusive,
|
getRandomIntInclusive,
|
||||||
mkdirpInVault,
|
mkdirpInVault,
|
||||||
} from "./misc";
|
} from "./misc";
|
||||||
|
|
||||||
const log = origLog.getLogger("rs-default");
|
import { log } from "./moreOnLog";
|
||||||
|
|
||||||
const SCOPES = ["User.Read", "Files.ReadWrite.AppFolder", "offline_access"];
|
const SCOPES = ["User.Read", "Files.ReadWrite.AppFolder", "offline_access"];
|
||||||
const REDIRECT_URI = `obsidian://${COMMAND_CALLBACK_ONEDRIVE}`;
|
const REDIRECT_URI = `obsidian://${COMMAND_CALLBACK_ONEDRIVE}`;
|
||||||
@@ -202,9 +204,9 @@ export const setConfigBySuccessfullAuthInplace = async (
|
|||||||
// Other usual common methods
|
// Other usual common methods
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
const getOnedrivePath = (fileOrFolderPath: string, vaultName: string) => {
|
const getOnedrivePath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||||
// https://docs.microsoft.com/en-us/onedrive/developer/rest-api/concepts/special-folders-appfolder?view=odsp-graph-online
|
// https://docs.microsoft.com/en-us/onedrive/developer/rest-api/concepts/special-folders-appfolder?view=odsp-graph-online
|
||||||
const prefix = `/drive/special/approot:/${vaultName}`;
|
const prefix = `/drive/special/approot:/${remoteBaseDir}`;
|
||||||
if (fileOrFolderPath.startsWith(prefix)) {
|
if (fileOrFolderPath.startsWith(prefix)) {
|
||||||
// already transformed, return as is
|
// already transformed, return as is
|
||||||
return fileOrFolderPath;
|
return fileOrFolderPath;
|
||||||
@@ -223,8 +225,8 @@ const getOnedrivePath = (fileOrFolderPath: string, vaultName: string) => {
|
|||||||
return key;
|
return key;
|
||||||
};
|
};
|
||||||
|
|
||||||
const getNormPath = (fileOrFolderPath: string, vaultName: string) => {
|
const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||||
const prefix = `/drive/special/approot:/${vaultName}`;
|
const prefix = `/drive/special/approot:/${remoteBaseDir}`;
|
||||||
|
|
||||||
if (
|
if (
|
||||||
!(fileOrFolderPath === prefix || fileOrFolderPath.startsWith(`${prefix}/`))
|
!(fileOrFolderPath === prefix || fileOrFolderPath.startsWith(`${prefix}/`))
|
||||||
@@ -246,16 +248,16 @@ const constructFromDriveItemToRemoteItemError = (x: DriveItem) => {
|
|||||||
|
|
||||||
const fromDriveItemToRemoteItem = (
|
const fromDriveItemToRemoteItem = (
|
||||||
x: DriveItem,
|
x: DriveItem,
|
||||||
vaultName: string
|
remoteBaseDir: string
|
||||||
): RemoteItem => {
|
): RemoteItem => {
|
||||||
let key = "";
|
let key = "";
|
||||||
|
|
||||||
// possible prefix:
|
// possible prefix:
|
||||||
// pure english: /drive/root:/Apps/remotely-save/${vaultName}
|
// pure english: /drive/root:/Apps/remotely-save/${remoteBaseDir}
|
||||||
// or localized, e.g.: /drive/root:/应用/remotely-save/${vaultName}
|
// or localized, e.g.: /drive/root:/应用/remotely-save/${remoteBaseDir}
|
||||||
const FIRST_COMMON_PREFIX_REGEX = /^\/drive\/root:\/[^\/]+\/remotely-save\//g;
|
const FIRST_COMMON_PREFIX_REGEX = /^\/drive\/root:\/[^\/]+\/remotely-save\//g;
|
||||||
// or the root is absolute path /Livefolders,
|
// or the root is absolute path /Livefolders,
|
||||||
// e.g.: /Livefolders/应用/remotely-save/${vaultName}
|
// e.g.: /Livefolders/应用/remotely-save/${remoteBaseDir}
|
||||||
const SECOND_COMMON_PREFIX_REGEX = /^\/Livefolders\/[^\/]+\/remotely-save\//g;
|
const SECOND_COMMON_PREFIX_REGEX = /^\/Livefolders\/[^\/]+\/remotely-save\//g;
|
||||||
|
|
||||||
// another possibile prefix
|
// another possibile prefix
|
||||||
@@ -268,26 +270,26 @@ const fromDriveItemToRemoteItem = (
|
|||||||
);
|
);
|
||||||
if (
|
if (
|
||||||
matchFirstPrefixRes !== null &&
|
matchFirstPrefixRes !== null &&
|
||||||
fullPathOriginal.startsWith(`${matchFirstPrefixRes[0]}${vaultName}`)
|
fullPathOriginal.startsWith(`${matchFirstPrefixRes[0]}${remoteBaseDir}`)
|
||||||
) {
|
) {
|
||||||
const foundPrefix = `${matchFirstPrefixRes[0]}${vaultName}`;
|
const foundPrefix = `${matchFirstPrefixRes[0]}${remoteBaseDir}`;
|
||||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||||
} else if (
|
} else if (
|
||||||
matchSecondPrefixRes !== null &&
|
matchSecondPrefixRes !== null &&
|
||||||
fullPathOriginal.startsWith(`${matchSecondPrefixRes[0]}${vaultName}`)
|
fullPathOriginal.startsWith(`${matchSecondPrefixRes[0]}${remoteBaseDir}`)
|
||||||
) {
|
) {
|
||||||
const foundPrefix = `${matchSecondPrefixRes[0]}${vaultName}`;
|
const foundPrefix = `${matchSecondPrefixRes[0]}${remoteBaseDir}`;
|
||||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||||
} else if (x.parentReference.path.startsWith(THIRD_COMMON_PREFIX_RAW)) {
|
} else if (x.parentReference.path.startsWith(THIRD_COMMON_PREFIX_RAW)) {
|
||||||
// it's something like
|
// it's something like
|
||||||
// /drive/items/<some_id>!<another_id>:/${vaultName}/<subfolder>
|
// /drive/items/<some_id>!<another_id>:/${remoteBaseDir}/<subfolder>
|
||||||
// with uri encoded!
|
// with uri encoded!
|
||||||
const parPath = decodeURIComponent(x.parentReference.path);
|
const parPath = decodeURIComponent(x.parentReference.path);
|
||||||
key = parPath.substring(parPath.indexOf(":") + 1);
|
key = parPath.substring(parPath.indexOf(":") + 1);
|
||||||
if (key.startsWith(`/${vaultName}/`)) {
|
if (key.startsWith(`/${remoteBaseDir}/`)) {
|
||||||
key = key.substring(`/${vaultName}/`.length);
|
key = key.substring(`/${remoteBaseDir}/`.length);
|
||||||
key = `${key}/${x.name}`;
|
key = `${key}/${x.name}`;
|
||||||
} else if (key === `/${vaultName}`) {
|
} else if (key === `/${remoteBaseDir}`) {
|
||||||
key = x.name;
|
key = x.name;
|
||||||
} else {
|
} else {
|
||||||
throw Error(
|
throw Error(
|
||||||
@@ -367,17 +369,17 @@ class MyAuthProvider implements AuthenticationProvider {
|
|||||||
|
|
||||||
export class WrappedOnedriveClient {
|
export class WrappedOnedriveClient {
|
||||||
onedriveConfig: OnedriveConfig;
|
onedriveConfig: OnedriveConfig;
|
||||||
vaultName: string;
|
remoteBaseDir: string;
|
||||||
vaultFolderExists: boolean;
|
vaultFolderExists: boolean;
|
||||||
authGetter: MyAuthProvider;
|
authGetter: MyAuthProvider;
|
||||||
saveUpdatedConfigFunc: () => Promise<any>;
|
saveUpdatedConfigFunc: () => Promise<any>;
|
||||||
constructor(
|
constructor(
|
||||||
onedriveConfig: OnedriveConfig,
|
onedriveConfig: OnedriveConfig,
|
||||||
vaultName: string,
|
remoteBaseDir: string,
|
||||||
saveUpdatedConfigFunc: () => Promise<any>
|
saveUpdatedConfigFunc: () => Promise<any>
|
||||||
) {
|
) {
|
||||||
this.onedriveConfig = onedriveConfig;
|
this.onedriveConfig = onedriveConfig;
|
||||||
this.vaultName = vaultName;
|
this.remoteBaseDir = remoteBaseDir;
|
||||||
this.vaultFolderExists = false;
|
this.vaultFolderExists = false;
|
||||||
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||||
this.authGetter = new MyAuthProvider(onedriveConfig, saveUpdatedConfigFunc);
|
this.authGetter = new MyAuthProvider(onedriveConfig, saveUpdatedConfigFunc);
|
||||||
@@ -393,26 +395,26 @@ export class WrappedOnedriveClient {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// check vault folder
|
// check vault folder
|
||||||
// log.info(`checking remote has folder /${this.vaultName}`);
|
// log.info(`checking remote has folder /${this.remoteBaseDir}`);
|
||||||
if (this.vaultFolderExists) {
|
if (this.vaultFolderExists) {
|
||||||
// log.info(`already checked, /${this.vaultName} exist before`)
|
// log.info(`already checked, /${this.remoteBaseDir} exist before`)
|
||||||
} else {
|
} else {
|
||||||
const k = await this.getJson("/drive/special/approot/children");
|
const k = await this.getJson("/drive/special/approot/children");
|
||||||
log.debug(k);
|
// log.debug(k);
|
||||||
this.vaultFolderExists =
|
this.vaultFolderExists =
|
||||||
(k.value as DriveItem[]).filter((x) => x.name === this.vaultName)
|
(k.value as DriveItem[]).filter((x) => x.name === this.remoteBaseDir)
|
||||||
.length > 0;
|
.length > 0;
|
||||||
if (!this.vaultFolderExists) {
|
if (!this.vaultFolderExists) {
|
||||||
log.info(`remote does not have folder /${this.vaultName}`);
|
log.info(`remote does not have folder /${this.remoteBaseDir}`);
|
||||||
await this.postJson("/drive/special/approot/children", {
|
await this.postJson("/drive/special/approot/children", {
|
||||||
name: `${this.vaultName}`,
|
name: `${this.remoteBaseDir}`,
|
||||||
folder: {},
|
folder: {},
|
||||||
"@microsoft.graph.conflictBehavior": "replace",
|
"@microsoft.graph.conflictBehavior": "replace",
|
||||||
});
|
});
|
||||||
log.info(`remote folder /${this.vaultName} created`);
|
log.info(`remote folder /${this.remoteBaseDir} created`);
|
||||||
this.vaultFolderExists = true;
|
this.vaultFolderExists = true;
|
||||||
} else {
|
} else {
|
||||||
// log.info(`remote folder /${this.vaultName} exists`);
|
// log.info(`remote folder /${this.remoteBaseDir} exists`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
@@ -482,28 +484,51 @@ export class WrappedOnedriveClient {
|
|||||||
deleteJson = async (pathFragOrig: string) => {
|
deleteJson = async (pathFragOrig: string) => {
|
||||||
const theUrl = this.buildUrl(pathFragOrig);
|
const theUrl = this.buildUrl(pathFragOrig);
|
||||||
log.debug(`deleteJson, theUrl=${theUrl}`);
|
log.debug(`deleteJson, theUrl=${theUrl}`);
|
||||||
// TODO: delete does not have response, so Obsidian request may have error
|
if (VALID_REQURL) {
|
||||||
// currently downgraded to fetch()!
|
await requestUrl({
|
||||||
await fetch(theUrl, {
|
url: theUrl,
|
||||||
method: "DELETE",
|
method: "DELETE",
|
||||||
headers: {
|
headers: {
|
||||||
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
} else {
|
||||||
|
await fetch(theUrl, {
|
||||||
|
method: "DELETE",
|
||||||
|
headers: {
|
||||||
|
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
putArrayBuffer = async (pathFragOrig: string, payload: ArrayBuffer) => {
|
putArrayBuffer = async (pathFragOrig: string, payload: ArrayBuffer) => {
|
||||||
const theUrl = this.buildUrl(pathFragOrig);
|
const theUrl = this.buildUrl(pathFragOrig);
|
||||||
log.debug(`putArrayBuffer, theUrl=${theUrl}`);
|
log.debug(`putArrayBuffer, theUrl=${theUrl}`);
|
||||||
// TODO: Obsidian doesn't support ArrayBuffer
|
// TODO:
|
||||||
// currently downgraded to fetch()!
|
// 20220401: On Android, requestUrl has issue that text becomes base64.
|
||||||
await fetch(theUrl, {
|
// Use fetch everywhere instead!
|
||||||
method: "PUT",
|
if (false /*VALID_REQURL*/) {
|
||||||
body: payload,
|
await requestUrl({
|
||||||
headers: {
|
url: theUrl,
|
||||||
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
method: "PUT",
|
||||||
},
|
body: payload,
|
||||||
});
|
contentType: DEFAULT_CONTENT_TYPE,
|
||||||
|
headers: {
|
||||||
|
"Content-Type": DEFAULT_CONTENT_TYPE,
|
||||||
|
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
await fetch(theUrl, {
|
||||||
|
method: "PUT",
|
||||||
|
body: payload,
|
||||||
|
headers: {
|
||||||
|
"Content-Type": DEFAULT_CONTENT_TYPE,
|
||||||
|
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -527,31 +552,45 @@ export class WrappedOnedriveClient {
|
|||||||
rangeEnd - 1
|
rangeEnd - 1
|
||||||
}, len=${rangeEnd - rangeStart}, size=${size}`
|
}, len=${rangeEnd - rangeStart}, size=${size}`
|
||||||
);
|
);
|
||||||
// TODO: Obsidian doesn't support ArrayBuffer
|
// NO AUTH HEADER here!
|
||||||
// currently downgraded to fetch()!
|
// TODO:
|
||||||
// AND, NO AUTH HEADER here!
|
// 20220401: On Android, requestUrl has issue that text becomes base64.
|
||||||
const res = await fetch(theUrl, {
|
// Use fetch everywhere instead!
|
||||||
method: "PUT",
|
if (false /*VALID_REQURL*/) {
|
||||||
body: payload.subarray(rangeStart, rangeEnd),
|
const res = await requestUrl({
|
||||||
headers: {
|
url: theUrl,
|
||||||
"Content-Length": `${rangeEnd - rangeStart}`,
|
method: "PUT",
|
||||||
"Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
|
body: bufferToArrayBuffer(payload.subarray(rangeStart, rangeEnd)),
|
||||||
"Content-Type": "application/octet-stream",
|
contentType: DEFAULT_CONTENT_TYPE,
|
||||||
},
|
headers: {
|
||||||
});
|
// no "Content-Length" allowed here
|
||||||
|
"Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
|
||||||
return res.json() as DriveItem | UploadSession;
|
},
|
||||||
|
});
|
||||||
|
return res.json as DriveItem | UploadSession;
|
||||||
|
} else {
|
||||||
|
const res = await fetch(theUrl, {
|
||||||
|
method: "PUT",
|
||||||
|
body: payload.subarray(rangeStart, rangeEnd),
|
||||||
|
headers: {
|
||||||
|
"Content-Length": `${rangeEnd - rangeStart}`,
|
||||||
|
"Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
|
||||||
|
"Content-Type": DEFAULT_CONTENT_TYPE,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
return (await res.json()) as DriveItem | UploadSession;
|
||||||
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export const getOnedriveClient = (
|
export const getOnedriveClient = (
|
||||||
onedriveConfig: OnedriveConfig,
|
onedriveConfig: OnedriveConfig,
|
||||||
vaultName: string,
|
remoteBaseDir: string,
|
||||||
saveUpdatedConfigFunc: () => Promise<any>
|
saveUpdatedConfigFunc: () => Promise<any>
|
||||||
) => {
|
) => {
|
||||||
return new WrappedOnedriveClient(
|
return new WrappedOnedriveClient(
|
||||||
onedriveConfig,
|
onedriveConfig,
|
||||||
vaultName,
|
remoteBaseDir,
|
||||||
saveUpdatedConfigFunc
|
saveUpdatedConfigFunc
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -575,9 +614,10 @@ export const listFromRemote = async (
|
|||||||
const DELTA_LINK_KEY = "@odata.deltaLink";
|
const DELTA_LINK_KEY = "@odata.deltaLink";
|
||||||
|
|
||||||
let res = await client.getJson(
|
let res = await client.getJson(
|
||||||
`/drive/special/approot:/${client.vaultName}:/delta`
|
`/drive/special/approot:/${client.remoteBaseDir}:/delta`
|
||||||
);
|
);
|
||||||
let driveItems = res.value as DriveItem[];
|
let driveItems = res.value as DriveItem[];
|
||||||
|
// log.debug(driveItems);
|
||||||
|
|
||||||
while (NEXT_LINK_KEY in res) {
|
while (NEXT_LINK_KEY in res) {
|
||||||
res = await client.getJson(res[NEXT_LINK_KEY]);
|
res = await client.getJson(res[NEXT_LINK_KEY]);
|
||||||
@@ -592,7 +632,7 @@ export const listFromRemote = async (
|
|||||||
|
|
||||||
// unify everything to RemoteItem
|
// unify everything to RemoteItem
|
||||||
const unifiedContents = driveItems
|
const unifiedContents = driveItems
|
||||||
.map((x) => fromDriveItemToRemoteItem(x, client.vaultName))
|
.map((x) => fromDriveItemToRemoteItem(x, client.remoteBaseDir))
|
||||||
.filter((x) => x.key !== "/");
|
.filter((x) => x.key !== "/");
|
||||||
|
|
||||||
return {
|
return {
|
||||||
@@ -605,14 +645,14 @@ export const getRemoteMeta = async (
|
|||||||
fileOrFolderPath: string
|
fileOrFolderPath: string
|
||||||
) => {
|
) => {
|
||||||
await client.init();
|
await client.init();
|
||||||
const remotePath = getOnedrivePath(fileOrFolderPath, client.vaultName);
|
const remotePath = getOnedrivePath(fileOrFolderPath, client.remoteBaseDir);
|
||||||
// log.info(`remotePath=${remotePath}`);
|
// log.info(`remotePath=${remotePath}`);
|
||||||
const rsp = await client.getJson(
|
const rsp = await client.getJson(
|
||||||
`${remotePath}?$select=cTag,eTag,fileSystemInfo,folder,file,name,parentReference,size`
|
`${remotePath}?$select=cTag,eTag,fileSystemInfo,folder,file,name,parentReference,size`
|
||||||
);
|
);
|
||||||
// log.info(rsp);
|
// log.info(rsp);
|
||||||
const driveItem = rsp as DriveItem;
|
const driveItem = rsp as DriveItem;
|
||||||
const res = fromDriveItemToRemoteItem(driveItem, client.vaultName);
|
const res = fromDriveItemToRemoteItem(driveItem, client.remoteBaseDir);
|
||||||
// log.info(res);
|
// log.info(res);
|
||||||
return res;
|
return res;
|
||||||
};
|
};
|
||||||
@@ -624,7 +664,9 @@ export const uploadToRemote = async (
|
|||||||
isRecursively: boolean = false,
|
isRecursively: boolean = false,
|
||||||
password: string = "",
|
password: string = "",
|
||||||
remoteEncryptedKey: string = "",
|
remoteEncryptedKey: string = "",
|
||||||
foldersCreatedBefore: Set<string> | undefined = undefined
|
foldersCreatedBefore: Set<string> | undefined = undefined,
|
||||||
|
uploadRaw: boolean = false,
|
||||||
|
rawContent: string | ArrayBuffer = ""
|
||||||
) => {
|
) => {
|
||||||
await client.init();
|
await client.init();
|
||||||
|
|
||||||
@@ -632,7 +674,7 @@ export const uploadToRemote = async (
|
|||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
uploadFile = remoteEncryptedKey;
|
uploadFile = remoteEncryptedKey;
|
||||||
}
|
}
|
||||||
uploadFile = getOnedrivePath(uploadFile, client.vaultName);
|
uploadFile = getOnedrivePath(uploadFile, client.remoteBaseDir);
|
||||||
log.debug(`uploadFile=${uploadFile}`);
|
log.debug(`uploadFile=${uploadFile}`);
|
||||||
|
|
||||||
const isFolder = fileOrFolderPath.endsWith("/");
|
const isFolder = fileOrFolderPath.endsWith("/");
|
||||||
@@ -640,6 +682,9 @@ export const uploadToRemote = async (
|
|||||||
if (isFolder && isRecursively) {
|
if (isFolder && isRecursively) {
|
||||||
throw Error("upload function doesn't implement recursive function yet!");
|
throw Error("upload function doesn't implement recursive function yet!");
|
||||||
} else if (isFolder && !isRecursively) {
|
} else if (isFolder && !isRecursively) {
|
||||||
|
if (uploadRaw) {
|
||||||
|
throw Error(`you specify uploadRaw, but you also provide a folder key!`);
|
||||||
|
}
|
||||||
// folder
|
// folder
|
||||||
if (password === "") {
|
if (password === "") {
|
||||||
// if not encrypted, mkdir a remote folder
|
// if not encrypted, mkdir a remote folder
|
||||||
@@ -682,7 +727,16 @@ export const uploadToRemote = async (
|
|||||||
} else {
|
} else {
|
||||||
// file
|
// file
|
||||||
// we ignore isRecursively parameter here
|
// we ignore isRecursively parameter here
|
||||||
const localContent = await vault.adapter.readBinary(fileOrFolderPath);
|
let localContent = undefined;
|
||||||
|
if (uploadRaw) {
|
||||||
|
if (typeof rawContent === "string") {
|
||||||
|
localContent = new TextEncoder().encode(rawContent).buffer;
|
||||||
|
} else {
|
||||||
|
localContent = rawContent;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
localContent = await vault.adapter.readBinary(fileOrFolderPath);
|
||||||
|
}
|
||||||
let remoteContent = localContent;
|
let remoteContent = localContent;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
remoteContent = await encryptArrayBuffer(localContent, password);
|
remoteContent = await encryptArrayBuffer(localContent, password);
|
||||||
@@ -690,40 +744,53 @@ export const uploadToRemote = async (
|
|||||||
|
|
||||||
// no need to create parent folders firstly, cool!
|
// no need to create parent folders firstly, cool!
|
||||||
|
|
||||||
// upload large files!
|
|
||||||
// ref: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createuploadsession?view=odsp-graph-online
|
|
||||||
|
|
||||||
// 1. create uploadSession
|
|
||||||
// uploadFile already starts with /drive/special/approot:/${vaultName}
|
|
||||||
const s: UploadSession = await client.postJson(
|
|
||||||
`${uploadFile}:/createUploadSession`,
|
|
||||||
{
|
|
||||||
item: {
|
|
||||||
"@microsoft.graph.conflictBehavior": "replace",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
);
|
|
||||||
const uploadUrl = s.uploadUrl;
|
|
||||||
log.debug("uploadSession = ");
|
|
||||||
log.debug(s);
|
|
||||||
|
|
||||||
// 2. upload by ranges
|
|
||||||
// convert to uint8
|
|
||||||
const uint8 = new Uint8Array(remoteContent);
|
|
||||||
// hard code range size
|
// hard code range size
|
||||||
const MIN_UNIT = 327680; // bytes in msft doc, about 0.32768 MB
|
const MIN_UNIT = 327680; // bytes in msft doc, about 0.32768 MB
|
||||||
const RANGE_SIZE = MIN_UNIT * 20; // about 6.5536 MB
|
const RANGE_SIZE = MIN_UNIT * 20; // about 6.5536 MB
|
||||||
// upload the ranges one by one
|
const DIRECT_UPLOAD_MAX_SIZE = 1000 * 1000 * 4; // 4 Megabyte
|
||||||
let rangeStart = 0;
|
|
||||||
while (rangeStart < uint8.byteLength) {
|
if (remoteContent.byteLength < DIRECT_UPLOAD_MAX_SIZE) {
|
||||||
await client.putUint8ArrayByRange(
|
// directly using put!
|
||||||
uploadUrl,
|
await client.putArrayBuffer(
|
||||||
uint8,
|
`${uploadFile}:/content?${new URLSearchParams({
|
||||||
rangeStart,
|
"@microsoft.graph.conflictBehavior": "replace",
|
||||||
Math.min(rangeStart + RANGE_SIZE, uint8.byteLength),
|
})}`,
|
||||||
uint8.byteLength
|
remoteContent
|
||||||
);
|
);
|
||||||
rangeStart += RANGE_SIZE;
|
} else {
|
||||||
|
// upload large files!
|
||||||
|
// ref: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createuploadsession?view=odsp-graph-online
|
||||||
|
|
||||||
|
// 1. create uploadSession
|
||||||
|
// uploadFile already starts with /drive/special/approot:/${remoteBaseDir}
|
||||||
|
const s: UploadSession = await client.postJson(
|
||||||
|
`${uploadFile}:/createUploadSession`,
|
||||||
|
{
|
||||||
|
item: {
|
||||||
|
"@microsoft.graph.conflictBehavior": "replace",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
const uploadUrl = s.uploadUrl;
|
||||||
|
log.debug("uploadSession = ");
|
||||||
|
log.debug(s);
|
||||||
|
|
||||||
|
// 2. upload by ranges
|
||||||
|
// convert to uint8
|
||||||
|
const uint8 = new Uint8Array(remoteContent);
|
||||||
|
|
||||||
|
// upload the ranges one by one
|
||||||
|
let rangeStart = 0;
|
||||||
|
while (rangeStart < uint8.byteLength) {
|
||||||
|
await client.putUint8ArrayByRange(
|
||||||
|
uploadUrl,
|
||||||
|
uint8,
|
||||||
|
rangeStart,
|
||||||
|
Math.min(rangeStart + RANGE_SIZE, uint8.byteLength),
|
||||||
|
uint8.byteLength
|
||||||
|
);
|
||||||
|
rangeStart += RANGE_SIZE;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const res = await getRemoteMeta(client, uploadFile);
|
const res = await getRemoteMeta(client, uploadFile);
|
||||||
@@ -736,13 +803,18 @@ const downloadFromRemoteRaw = async (
|
|||||||
fileOrFolderPath: string
|
fileOrFolderPath: string
|
||||||
): Promise<ArrayBuffer> => {
|
): Promise<ArrayBuffer> => {
|
||||||
await client.init();
|
await client.init();
|
||||||
const key = getOnedrivePath(fileOrFolderPath, client.vaultName);
|
const key = getOnedrivePath(fileOrFolderPath, client.remoteBaseDir);
|
||||||
const rsp = await client.getJson(
|
const rsp = await client.getJson(
|
||||||
`${key}?$select=@microsoft.graph.downloadUrl`
|
`${key}?$select=@microsoft.graph.downloadUrl`
|
||||||
);
|
);
|
||||||
const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
|
const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
|
||||||
const content = await (await fetch(downloadUrl)).arrayBuffer();
|
if (VALID_REQURL) {
|
||||||
return content;
|
const content = (await requestUrl({ url: downloadUrl })).arrayBuffer;
|
||||||
|
return content;
|
||||||
|
} else {
|
||||||
|
const content = await (await fetch(downloadUrl)).arrayBuffer();
|
||||||
|
return content;
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
export const downloadFromRemote = async (
|
export const downloadFromRemote = async (
|
||||||
@@ -751,31 +823,38 @@ export const downloadFromRemote = async (
|
|||||||
vault: Vault,
|
vault: Vault,
|
||||||
mtime: number,
|
mtime: number,
|
||||||
password: string = "",
|
password: string = "",
|
||||||
remoteEncryptedKey: string = ""
|
remoteEncryptedKey: string = "",
|
||||||
|
skipSaving: boolean = false
|
||||||
) => {
|
) => {
|
||||||
await client.init();
|
await client.init();
|
||||||
|
|
||||||
const isFolder = fileOrFolderPath.endsWith("/");
|
const isFolder = fileOrFolderPath.endsWith("/");
|
||||||
|
|
||||||
await mkdirpInVault(fileOrFolderPath, vault);
|
if (!skipSaving) {
|
||||||
|
await mkdirpInVault(fileOrFolderPath, vault);
|
||||||
|
}
|
||||||
|
|
||||||
if (isFolder) {
|
if (isFolder) {
|
||||||
// mkdirp locally is enough
|
// mkdirp locally is enough
|
||||||
// do nothing here
|
// do nothing here
|
||||||
|
return new ArrayBuffer(0);
|
||||||
} else {
|
} else {
|
||||||
let downloadFile = fileOrFolderPath;
|
let downloadFile = fileOrFolderPath;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
downloadFile = remoteEncryptedKey;
|
downloadFile = remoteEncryptedKey;
|
||||||
}
|
}
|
||||||
downloadFile = getOnedrivePath(downloadFile, client.vaultName);
|
downloadFile = getOnedrivePath(downloadFile, client.remoteBaseDir);
|
||||||
const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
|
const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
|
||||||
let localContent = remoteContent;
|
let localContent = remoteContent;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
localContent = await decryptArrayBuffer(remoteContent, password);
|
localContent = await decryptArrayBuffer(remoteContent, password);
|
||||||
}
|
}
|
||||||
await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
|
if (!skipSaving) {
|
||||||
mtime: mtime,
|
await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
|
||||||
});
|
mtime: mtime,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return localContent;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -792,17 +871,24 @@ export const deleteFromRemote = async (
|
|||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
remoteFileName = remoteEncryptedKey;
|
remoteFileName = remoteEncryptedKey;
|
||||||
}
|
}
|
||||||
remoteFileName = getOnedrivePath(remoteFileName, client.vaultName);
|
remoteFileName = getOnedrivePath(remoteFileName, client.remoteBaseDir);
|
||||||
|
|
||||||
await client.init();
|
await client.init();
|
||||||
await client.deleteJson(remoteFileName);
|
await client.deleteJson(remoteFileName);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const checkConnectivity = async (client: WrappedOnedriveClient) => {
|
export const checkConnectivity = async (
|
||||||
|
client: WrappedOnedriveClient,
|
||||||
|
callbackFunc?: any
|
||||||
|
) => {
|
||||||
try {
|
try {
|
||||||
const k = await getUserDisplayName(client);
|
const k = await getUserDisplayName(client);
|
||||||
return k !== "<unknown display name>";
|
return k !== "<unknown display name>";
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
log.debug(err);
|
||||||
|
if (callbackFunc !== undefined) {
|
||||||
|
callbackFunc(err);
|
||||||
|
}
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|||||||
+207
-28
@@ -11,11 +11,25 @@ import {
|
|||||||
S3Client,
|
S3Client,
|
||||||
} from "@aws-sdk/client-s3";
|
} from "@aws-sdk/client-s3";
|
||||||
import { Upload } from "@aws-sdk/lib-storage";
|
import { Upload } from "@aws-sdk/lib-storage";
|
||||||
|
import { HttpHandler, HttpRequest, HttpResponse } from "@aws-sdk/protocol-http";
|
||||||
|
import {
|
||||||
|
FetchHttpHandler,
|
||||||
|
FetchHttpHandlerOptions,
|
||||||
|
} from "@aws-sdk/fetch-http-handler";
|
||||||
|
// @ts-ignore
|
||||||
|
import { requestTimeout } from "@aws-sdk/fetch-http-handler/dist-es/request-timeout";
|
||||||
|
import { buildQueryString } from "@aws-sdk/querystring-builder";
|
||||||
|
import { HeaderBag, HttpHandlerOptions, Provider } from "@aws-sdk/types";
|
||||||
import { Buffer } from "buffer";
|
import { Buffer } from "buffer";
|
||||||
import * as mime from "mime-types";
|
import * as mime from "mime-types";
|
||||||
import { Vault } from "obsidian";
|
import { Vault, requestUrl, RequestUrlParam } from "obsidian";
|
||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import { RemoteItem, S3Config } from "./baseTypes";
|
import {
|
||||||
|
DEFAULT_CONTENT_TYPE,
|
||||||
|
RemoteItem,
|
||||||
|
S3Config,
|
||||||
|
VALID_REQURL,
|
||||||
|
} from "./baseTypes";
|
||||||
import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
|
import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
|
||||||
import {
|
import {
|
||||||
arrayBufferToBuffer,
|
arrayBufferToBuffer,
|
||||||
@@ -25,8 +39,124 @@ import {
|
|||||||
|
|
||||||
export { S3Client } from "@aws-sdk/client-s3";
|
export { S3Client } from "@aws-sdk/client-s3";
|
||||||
|
|
||||||
import * as origLog from "loglevel";
|
import { log } from "./moreOnLog";
|
||||||
const log = origLog.getLogger("rs-default");
|
|
||||||
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
// special handler using Obsidian requestUrl
|
||||||
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is close to origin implementation of FetchHttpHandler
|
||||||
|
* https://github.com/aws/aws-sdk-js-v3/blob/main/packages/fetch-http-handler/src/fetch-http-handler.ts
|
||||||
|
* that is released under Apache 2 License.
|
||||||
|
* But this uses Obsidian requestUrl instead.
|
||||||
|
*/
|
||||||
|
class ObsHttpHandler extends FetchHttpHandler {
|
||||||
|
requestTimeoutInMs: number;
|
||||||
|
constructor(options?: FetchHttpHandlerOptions) {
|
||||||
|
super(options);
|
||||||
|
this.requestTimeoutInMs =
|
||||||
|
options === undefined ? undefined : options.requestTimeout;
|
||||||
|
}
|
||||||
|
async handle(
|
||||||
|
request: HttpRequest,
|
||||||
|
{ abortSignal }: HttpHandlerOptions = {}
|
||||||
|
): Promise<{ response: HttpResponse }> {
|
||||||
|
if (abortSignal?.aborted) {
|
||||||
|
const abortError = new Error("Request aborted");
|
||||||
|
abortError.name = "AbortError";
|
||||||
|
return Promise.reject(abortError);
|
||||||
|
}
|
||||||
|
|
||||||
|
let path = request.path;
|
||||||
|
if (request.query) {
|
||||||
|
const queryString = buildQueryString(request.query);
|
||||||
|
if (queryString) {
|
||||||
|
path += `?${queryString}`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const { port, method } = request;
|
||||||
|
const url = `${request.protocol}//${request.hostname}${
|
||||||
|
port ? `:${port}` : ""
|
||||||
|
}${path}`;
|
||||||
|
const body =
|
||||||
|
method === "GET" || method === "HEAD" ? undefined : request.body;
|
||||||
|
|
||||||
|
const transformedHeaders: Record<string, string> = {};
|
||||||
|
for (const key of Object.keys(request.headers)) {
|
||||||
|
const keyLower = key.toLowerCase();
|
||||||
|
if (keyLower === "host" || keyLower === "content-length") {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
transformedHeaders[keyLower] = request.headers[key];
|
||||||
|
}
|
||||||
|
|
||||||
|
let contentType: string = undefined;
|
||||||
|
if (transformedHeaders["content-type"] !== undefined) {
|
||||||
|
contentType = transformedHeaders["content-type"];
|
||||||
|
}
|
||||||
|
|
||||||
|
if (transformedHeaders["cache-control"] === undefined) {
|
||||||
|
// every time is a new request
|
||||||
|
transformedHeaders["cache-control"] = "no-cache";
|
||||||
|
}
|
||||||
|
|
||||||
|
let transformedBody: any = body;
|
||||||
|
if (ArrayBuffer.isView(body)) {
|
||||||
|
transformedBody = bufferToArrayBuffer(body);
|
||||||
|
}
|
||||||
|
|
||||||
|
const param: RequestUrlParam = {
|
||||||
|
body: transformedBody,
|
||||||
|
headers: transformedHeaders,
|
||||||
|
method: method,
|
||||||
|
url: url,
|
||||||
|
contentType: contentType,
|
||||||
|
};
|
||||||
|
|
||||||
|
const raceOfPromises = [
|
||||||
|
requestUrl(param).then((rsp) => {
|
||||||
|
const headers = rsp.headers;
|
||||||
|
const headersLower: Record<string, string> = {};
|
||||||
|
for (const key of Object.keys(headers)) {
|
||||||
|
headersLower[key.toLowerCase()] = headers[key];
|
||||||
|
}
|
||||||
|
const stream = new ReadableStream<Uint8Array>({
|
||||||
|
start(controller) {
|
||||||
|
controller.enqueue(new Uint8Array(rsp.arrayBuffer));
|
||||||
|
controller.close();
|
||||||
|
},
|
||||||
|
});
|
||||||
|
return {
|
||||||
|
response: new HttpResponse({
|
||||||
|
headers: headersLower,
|
||||||
|
statusCode: rsp.status,
|
||||||
|
body: stream,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}),
|
||||||
|
requestTimeout(this.requestTimeoutInMs),
|
||||||
|
];
|
||||||
|
|
||||||
|
if (abortSignal) {
|
||||||
|
raceOfPromises.push(
|
||||||
|
new Promise<never>((resolve, reject) => {
|
||||||
|
abortSignal.onabort = () => {
|
||||||
|
const abortError = new Error("Request aborted");
|
||||||
|
abortError.name = "AbortError";
|
||||||
|
reject(abortError);
|
||||||
|
};
|
||||||
|
})
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return Promise.race(raceOfPromises);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
// other stuffs
|
||||||
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
export const DEFAULT_S3_CONFIG = {
|
export const DEFAULT_S3_CONFIG = {
|
||||||
s3Endpoint: "",
|
s3Endpoint: "",
|
||||||
@@ -34,6 +164,9 @@ export const DEFAULT_S3_CONFIG = {
|
|||||||
s3AccessKeyID: "",
|
s3AccessKeyID: "",
|
||||||
s3SecretAccessKey: "",
|
s3SecretAccessKey: "",
|
||||||
s3BucketName: "",
|
s3BucketName: "",
|
||||||
|
bypassCorsLocally: true,
|
||||||
|
partsConcurrency: 20,
|
||||||
|
forcePathStyle: false,
|
||||||
};
|
};
|
||||||
|
|
||||||
export type S3ObjectType = _Object;
|
export type S3ObjectType = _Object;
|
||||||
@@ -66,15 +199,31 @@ export const getS3Client = (s3Config: S3Config) => {
|
|||||||
if (!(endpoint.startsWith("http://") || endpoint.startsWith("https://"))) {
|
if (!(endpoint.startsWith("http://") || endpoint.startsWith("https://"))) {
|
||||||
endpoint = `https://${endpoint}`;
|
endpoint = `https://${endpoint}`;
|
||||||
}
|
}
|
||||||
const s3Client = new S3Client({
|
|
||||||
region: s3Config.s3Region,
|
if (VALID_REQURL && s3Config.bypassCorsLocally) {
|
||||||
endpoint: endpoint,
|
const s3Client = new S3Client({
|
||||||
credentials: {
|
region: s3Config.s3Region,
|
||||||
accessKeyId: s3Config.s3AccessKeyID,
|
endpoint: endpoint,
|
||||||
secretAccessKey: s3Config.s3SecretAccessKey,
|
forcePathStyle: s3Config.forcePathStyle,
|
||||||
},
|
credentials: {
|
||||||
});
|
accessKeyId: s3Config.s3AccessKeyID,
|
||||||
return s3Client;
|
secretAccessKey: s3Config.s3SecretAccessKey,
|
||||||
|
},
|
||||||
|
requestHandler: new ObsHttpHandler(),
|
||||||
|
});
|
||||||
|
return s3Client;
|
||||||
|
} else {
|
||||||
|
const s3Client = new S3Client({
|
||||||
|
region: s3Config.s3Region,
|
||||||
|
endpoint: endpoint,
|
||||||
|
forcePathStyle: s3Config.forcePathStyle,
|
||||||
|
credentials: {
|
||||||
|
accessKeyId: s3Config.s3AccessKeyID,
|
||||||
|
secretAccessKey: s3Config.s3SecretAccessKey,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
return s3Client;
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
export const getRemoteMeta = async (
|
export const getRemoteMeta = async (
|
||||||
@@ -99,7 +248,9 @@ export const uploadToRemote = async (
|
|||||||
vault: Vault,
|
vault: Vault,
|
||||||
isRecursively: boolean = false,
|
isRecursively: boolean = false,
|
||||||
password: string = "",
|
password: string = "",
|
||||||
remoteEncryptedKey: string = ""
|
remoteEncryptedKey: string = "",
|
||||||
|
uploadRaw: boolean = false,
|
||||||
|
rawContent: string | ArrayBuffer = ""
|
||||||
) => {
|
) => {
|
||||||
let uploadFile = fileOrFolderPath;
|
let uploadFile = fileOrFolderPath;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
@@ -107,11 +258,12 @@ export const uploadToRemote = async (
|
|||||||
}
|
}
|
||||||
const isFolder = fileOrFolderPath.endsWith("/");
|
const isFolder = fileOrFolderPath.endsWith("/");
|
||||||
|
|
||||||
const DEFAULT_CONTENT_TYPE = "application/octet-stream";
|
|
||||||
|
|
||||||
if (isFolder && isRecursively) {
|
if (isFolder && isRecursively) {
|
||||||
throw Error("upload function doesn't implement recursive function yet!");
|
throw Error("upload function doesn't implement recursive function yet!");
|
||||||
} else if (isFolder && !isRecursively) {
|
} else if (isFolder && !isRecursively) {
|
||||||
|
if (uploadRaw) {
|
||||||
|
throw Error(`you specify uploadRaw, but you also provide a folder key!`);
|
||||||
|
}
|
||||||
// folder
|
// folder
|
||||||
const contentType = DEFAULT_CONTENT_TYPE;
|
const contentType = DEFAULT_CONTENT_TYPE;
|
||||||
await s3Client.send(
|
await s3Client.send(
|
||||||
@@ -133,17 +285,27 @@ export const uploadToRemote = async (
|
|||||||
mime.lookup(fileOrFolderPath) || DEFAULT_CONTENT_TYPE
|
mime.lookup(fileOrFolderPath) || DEFAULT_CONTENT_TYPE
|
||||||
) || DEFAULT_CONTENT_TYPE;
|
) || DEFAULT_CONTENT_TYPE;
|
||||||
}
|
}
|
||||||
const localContent = await vault.adapter.readBinary(fileOrFolderPath);
|
let localContent = undefined;
|
||||||
|
if (uploadRaw) {
|
||||||
|
if (typeof rawContent === "string") {
|
||||||
|
localContent = new TextEncoder().encode(rawContent).buffer;
|
||||||
|
} else {
|
||||||
|
localContent = rawContent;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
localContent = await vault.adapter.readBinary(fileOrFolderPath);
|
||||||
|
}
|
||||||
let remoteContent = localContent;
|
let remoteContent = localContent;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
remoteContent = await encryptArrayBuffer(localContent, password);
|
remoteContent = await encryptArrayBuffer(localContent, password);
|
||||||
}
|
}
|
||||||
const body = arrayBufferToBuffer(remoteContent);
|
|
||||||
|
|
||||||
|
const bytesIn5MB = 5242880;
|
||||||
|
const body = new Uint8Array(remoteContent);
|
||||||
const upload = new Upload({
|
const upload = new Upload({
|
||||||
client: s3Client,
|
client: s3Client,
|
||||||
queueSize: 20, // concurrency
|
queueSize: s3Config.partsConcurrency, // concurrency
|
||||||
partSize: 5242880, // minimal 5MB by default
|
partSize: bytesIn5MB, // minimal 5MB by default
|
||||||
leavePartsOnError: false,
|
leavePartsOnError: false,
|
||||||
params: {
|
params: {
|
||||||
Bucket: s3Config.s3BucketName,
|
Bucket: s3Config.s3BucketName,
|
||||||
@@ -176,7 +338,6 @@ export const listFromRemote = async (
|
|||||||
const contents = [] as _Object[];
|
const contents = [] as _Object[];
|
||||||
|
|
||||||
let isTruncated = true;
|
let isTruncated = true;
|
||||||
let continuationToken = "";
|
|
||||||
do {
|
do {
|
||||||
const rsp = await s3Client.send(new ListObjectsV2Command(confCmd));
|
const rsp = await s3Client.send(new ListObjectsV2Command(confCmd));
|
||||||
|
|
||||||
@@ -192,7 +353,8 @@ export const listFromRemote = async (
|
|||||||
confCmd.ContinuationToken = rsp.NextContinuationToken;
|
confCmd.ContinuationToken = rsp.NextContinuationToken;
|
||||||
if (
|
if (
|
||||||
isTruncated &&
|
isTruncated &&
|
||||||
(continuationToken === undefined || continuationToken === "")
|
(confCmd.ContinuationToken === undefined ||
|
||||||
|
confCmd.ContinuationToken === "")
|
||||||
) {
|
) {
|
||||||
throw Error("isTruncated is true but no continuationToken provided");
|
throw Error("isTruncated is true but no continuationToken provided");
|
||||||
}
|
}
|
||||||
@@ -252,11 +414,14 @@ export const downloadFromRemote = async (
|
|||||||
vault: Vault,
|
vault: Vault,
|
||||||
mtime: number,
|
mtime: number,
|
||||||
password: string = "",
|
password: string = "",
|
||||||
remoteEncryptedKey: string = ""
|
remoteEncryptedKey: string = "",
|
||||||
|
skipSaving: boolean = false
|
||||||
) => {
|
) => {
|
||||||
const isFolder = fileOrFolderPath.endsWith("/");
|
const isFolder = fileOrFolderPath.endsWith("/");
|
||||||
|
|
||||||
await mkdirpInVault(fileOrFolderPath, vault);
|
if (!skipSaving) {
|
||||||
|
await mkdirpInVault(fileOrFolderPath, vault);
|
||||||
|
}
|
||||||
|
|
||||||
// the file is always local file
|
// the file is always local file
|
||||||
// we need to encrypt it
|
// we need to encrypt it
|
||||||
@@ -264,6 +429,7 @@ export const downloadFromRemote = async (
|
|||||||
if (isFolder) {
|
if (isFolder) {
|
||||||
// mkdirp locally is enough
|
// mkdirp locally is enough
|
||||||
// do nothing here
|
// do nothing here
|
||||||
|
return new ArrayBuffer(0);
|
||||||
} else {
|
} else {
|
||||||
let downloadFile = fileOrFolderPath;
|
let downloadFile = fileOrFolderPath;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
@@ -278,9 +444,12 @@ export const downloadFromRemote = async (
|
|||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
localContent = await decryptArrayBuffer(remoteContent, password);
|
localContent = await decryptArrayBuffer(remoteContent, password);
|
||||||
}
|
}
|
||||||
await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
|
if (!skipSaving) {
|
||||||
mtime: mtime,
|
await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
|
||||||
});
|
mtime: mtime,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return localContent;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -338,7 +507,8 @@ export const deleteFromRemote = async (
|
|||||||
*/
|
*/
|
||||||
export const checkConnectivity = async (
|
export const checkConnectivity = async (
|
||||||
s3Client: S3Client,
|
s3Client: S3Client,
|
||||||
s3Config: S3Config
|
s3Config: S3Config,
|
||||||
|
callbackFunc?: any
|
||||||
) => {
|
) => {
|
||||||
try {
|
try {
|
||||||
const results = await s3Client.send(
|
const results = await s3Client.send(
|
||||||
@@ -349,10 +519,19 @@ export const checkConnectivity = async (
|
|||||||
results.$metadata === undefined ||
|
results.$metadata === undefined ||
|
||||||
results.$metadata.httpStatusCode === undefined
|
results.$metadata.httpStatusCode === undefined
|
||||||
) {
|
) {
|
||||||
|
const err = "results or $metadata or httStatusCode is undefined";
|
||||||
|
log.debug(err);
|
||||||
|
if (callbackFunc !== undefined) {
|
||||||
|
callbackFunc(err);
|
||||||
|
}
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
return results.$metadata.httpStatusCode === 200;
|
return results.$metadata.httpStatusCode === 200;
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
log.debug(err);
|
||||||
|
if (callbackFunc !== undefined) {
|
||||||
|
callbackFunc(err);
|
||||||
|
}
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|||||||
+273
-52
@@ -1,17 +1,115 @@
|
|||||||
import { Buffer } from "buffer";
|
import { Buffer } from "buffer";
|
||||||
import { Vault } from "obsidian";
|
import { Vault, requestUrl } from "obsidian";
|
||||||
import type { FileStat, WebDAVClient } from "webdav/web";
|
|
||||||
import { AuthType, BufferLike, createClient } from "webdav/web";
|
|
||||||
import { Queue } from "@fyears/tsqueue";
|
import { Queue } from "@fyears/tsqueue";
|
||||||
import chunk from "lodash/chunk";
|
import chunk from "lodash/chunk";
|
||||||
import flatten from "lodash/flatten";
|
import flatten from "lodash/flatten";
|
||||||
import type { RemoteItem, WebdavConfig } from "./baseTypes";
|
import { getReasonPhrase } from "http-status-codes";
|
||||||
|
import { RemoteItem, VALID_REQURL, WebdavConfig } from "./baseTypes";
|
||||||
import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
|
import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
|
||||||
import { bufferToArrayBuffer, getPathFolder, mkdirpInVault } from "./misc";
|
import { bufferToArrayBuffer, getPathFolder, mkdirpInVault } from "./misc";
|
||||||
export type { WebDAVClient } from "webdav/web";
|
|
||||||
|
|
||||||
import * as origLog from "loglevel";
|
import { log } from "./moreOnLog";
|
||||||
const log = origLog.getLogger("rs-default");
|
|
||||||
|
import type {
|
||||||
|
FileStat,
|
||||||
|
WebDAVClient,
|
||||||
|
RequestOptionsWithState,
|
||||||
|
Response,
|
||||||
|
ResponseDataDetailed,
|
||||||
|
} from "webdav/web";
|
||||||
|
import { getPatcher } from "webdav/web";
|
||||||
|
if (VALID_REQURL) {
|
||||||
|
getPatcher().patch(
|
||||||
|
"request",
|
||||||
|
async (
|
||||||
|
options: RequestOptionsWithState
|
||||||
|
): Promise<Response | ResponseDataDetailed<any>> => {
|
||||||
|
const transformedHeaders = { ...options.headers };
|
||||||
|
delete transformedHeaders["host"];
|
||||||
|
delete transformedHeaders["Host"];
|
||||||
|
delete transformedHeaders["content-length"];
|
||||||
|
delete transformedHeaders["Content-Length"];
|
||||||
|
const r = await requestUrl({
|
||||||
|
url: options.url,
|
||||||
|
method: options.method,
|
||||||
|
body: options.data as string | ArrayBuffer,
|
||||||
|
headers: transformedHeaders,
|
||||||
|
});
|
||||||
|
|
||||||
|
let r2: Response | ResponseDataDetailed<any> = undefined;
|
||||||
|
if (options.responseType === undefined) {
|
||||||
|
r2 = {
|
||||||
|
data: undefined,
|
||||||
|
status: r.status,
|
||||||
|
statusText: getReasonPhrase(r.status),
|
||||||
|
headers: r.headers,
|
||||||
|
};
|
||||||
|
} else if (options.responseType === "json") {
|
||||||
|
r2 = {
|
||||||
|
data: r.json,
|
||||||
|
status: r.status,
|
||||||
|
statusText: getReasonPhrase(r.status),
|
||||||
|
headers: r.headers,
|
||||||
|
};
|
||||||
|
} else if (options.responseType === "text") {
|
||||||
|
r2 = {
|
||||||
|
data: r.text,
|
||||||
|
status: r.status,
|
||||||
|
statusText: getReasonPhrase(r.status),
|
||||||
|
headers: r.headers,
|
||||||
|
};
|
||||||
|
} else if (options.responseType === "arraybuffer") {
|
||||||
|
r2 = {
|
||||||
|
data: r.arrayBuffer,
|
||||||
|
status: r.status,
|
||||||
|
statusText: getReasonPhrase(r.status),
|
||||||
|
headers: r.headers,
|
||||||
|
};
|
||||||
|
} else {
|
||||||
|
throw Error(
|
||||||
|
`do not know how to deal with responseType = ${options.responseType}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return r2;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// getPatcher().patch("request", (options: any) => {
|
||||||
|
// // console.log("using fetch");
|
||||||
|
// const r = fetch(options.url, {
|
||||||
|
// method: options.method,
|
||||||
|
// body: options.data as any,
|
||||||
|
// headers: options.headers,
|
||||||
|
// signal: options.signal,
|
||||||
|
// })
|
||||||
|
// .then((rsp) => {
|
||||||
|
// if (options.responseType === undefined) {
|
||||||
|
// return Promise.all([undefined, rsp]);
|
||||||
|
// }
|
||||||
|
// if (options.responseType === "json") {
|
||||||
|
// return Promise.all([rsp.json(), rsp]);
|
||||||
|
// }
|
||||||
|
// if (options.responseType === "text") {
|
||||||
|
// return Promise.all([rsp.text(), rsp]);
|
||||||
|
// }
|
||||||
|
// if (options.responseType === "arraybuffer") {
|
||||||
|
// return Promise.all([rsp.arrayBuffer(), rsp]);
|
||||||
|
// }
|
||||||
|
// })
|
||||||
|
// .then(([d, r]) => {
|
||||||
|
// return {
|
||||||
|
// data: d,
|
||||||
|
// status: r.status,
|
||||||
|
// statusText: r.statusText,
|
||||||
|
// headers: r.headers,
|
||||||
|
// };
|
||||||
|
// });
|
||||||
|
// // console.log("using fetch");
|
||||||
|
// return r;
|
||||||
|
// });
|
||||||
|
import { AuthType, BufferLike, createClient } from "webdav/web";
|
||||||
|
export type { WebDAVClient } from "webdav/web";
|
||||||
|
|
||||||
export const DEFAULT_WEBDAV_CONFIG = {
|
export const DEFAULT_WEBDAV_CONFIG = {
|
||||||
address: "",
|
address: "",
|
||||||
@@ -19,37 +117,41 @@ export const DEFAULT_WEBDAV_CONFIG = {
|
|||||||
password: "",
|
password: "",
|
||||||
authType: "basic",
|
authType: "basic",
|
||||||
manualRecursive: false,
|
manualRecursive: false,
|
||||||
|
depth: "auto_unknown",
|
||||||
|
remoteBaseDir: "",
|
||||||
} as WebdavConfig;
|
} as WebdavConfig;
|
||||||
|
|
||||||
const getWebdavPath = (fileOrFolderPath: string, vaultName: string) => {
|
const getWebdavPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||||
let key = fileOrFolderPath;
|
let key = fileOrFolderPath;
|
||||||
if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
|
if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
|
||||||
// special
|
// special
|
||||||
key = `/${vaultName}/`;
|
key = `/${remoteBaseDir}/`;
|
||||||
}
|
}
|
||||||
if (!fileOrFolderPath.startsWith("/")) {
|
if (!fileOrFolderPath.startsWith("/")) {
|
||||||
key = `/${vaultName}/${fileOrFolderPath}`;
|
key = `/${remoteBaseDir}/${fileOrFolderPath}`;
|
||||||
}
|
}
|
||||||
return key;
|
return key;
|
||||||
};
|
};
|
||||||
|
|
||||||
const getNormPath = (fileOrFolderPath: string, vaultName: string) => {
|
const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||||
if (
|
if (
|
||||||
!(
|
!(
|
||||||
fileOrFolderPath === `/${vaultName}` ||
|
fileOrFolderPath === `/${remoteBaseDir}` ||
|
||||||
fileOrFolderPath.startsWith(`/${vaultName}/`)
|
fileOrFolderPath.startsWith(`/${remoteBaseDir}/`)
|
||||||
)
|
)
|
||||||
) {
|
) {
|
||||||
throw Error(`"${fileOrFolderPath}" doesn't starts with "/${vaultName}/"`);
|
throw Error(
|
||||||
|
`"${fileOrFolderPath}" doesn't starts with "/${remoteBaseDir}/"`
|
||||||
|
);
|
||||||
}
|
}
|
||||||
// if (fileOrFolderPath.startsWith("/")) {
|
// if (fileOrFolderPath.startsWith("/")) {
|
||||||
// return fileOrFolderPath.slice(1);
|
// return fileOrFolderPath.slice(1);
|
||||||
// }
|
// }
|
||||||
return fileOrFolderPath.slice(`/${vaultName}/`.length);
|
return fileOrFolderPath.slice(`/${remoteBaseDir}/`.length);
|
||||||
};
|
};
|
||||||
|
|
||||||
const fromWebdavItemToRemoteItem = (x: FileStat, vaultName: string) => {
|
const fromWebdavItemToRemoteItem = (x: FileStat, remoteBaseDir: string) => {
|
||||||
let key = getNormPath(x.filename, vaultName);
|
let key = getNormPath(x.filename, remoteBaseDir);
|
||||||
if (x.type === "directory" && !key.endsWith("/")) {
|
if (x.type === "directory" && !key.endsWith("/")) {
|
||||||
key = `${key}/`;
|
key = `${key}/`;
|
||||||
}
|
}
|
||||||
@@ -64,13 +166,19 @@ const fromWebdavItemToRemoteItem = (x: FileStat, vaultName: string) => {
|
|||||||
|
|
||||||
export class WrappedWebdavClient {
|
export class WrappedWebdavClient {
|
||||||
webdavConfig: WebdavConfig;
|
webdavConfig: WebdavConfig;
|
||||||
vaultName: string;
|
remoteBaseDir: string;
|
||||||
client: WebDAVClient;
|
client: WebDAVClient;
|
||||||
vaultFolderExists: boolean;
|
vaultFolderExists: boolean;
|
||||||
constructor(webdavConfig: WebdavConfig, vaultName: string) {
|
saveUpdatedConfigFunc: () => Promise<any>;
|
||||||
|
constructor(
|
||||||
|
webdavConfig: WebdavConfig,
|
||||||
|
remoteBaseDir: string,
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any>
|
||||||
|
) {
|
||||||
this.webdavConfig = webdavConfig;
|
this.webdavConfig = webdavConfig;
|
||||||
this.vaultName = vaultName;
|
this.remoteBaseDir = remoteBaseDir;
|
||||||
this.vaultFolderExists = false;
|
this.vaultFolderExists = false;
|
||||||
|
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||||
}
|
}
|
||||||
|
|
||||||
init = async () => {
|
init = async () => {
|
||||||
@@ -98,25 +206,82 @@ export class WrappedWebdavClient {
|
|||||||
if (this.vaultFolderExists) {
|
if (this.vaultFolderExists) {
|
||||||
// pass
|
// pass
|
||||||
} else {
|
} else {
|
||||||
const res = await this.client.exists(`/${this.vaultName}`);
|
const res = await this.client.exists(`/${this.remoteBaseDir}/`);
|
||||||
if (res) {
|
if (res) {
|
||||||
// log.info("remote vault folder exits!");
|
// log.info("remote vault folder exits!");
|
||||||
this.vaultFolderExists = true;
|
this.vaultFolderExists = true;
|
||||||
} else {
|
} else {
|
||||||
log.info("remote vault folder not exists, creating");
|
log.info("remote vault folder not exists, creating");
|
||||||
await this.client.createDirectory(`/${this.vaultName}`);
|
await this.client.createDirectory(`/${this.remoteBaseDir}/`);
|
||||||
log.info("remote vault folder created!");
|
log.info("remote vault folder created!");
|
||||||
this.vaultFolderExists = true;
|
this.vaultFolderExists = true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// adjust depth parameter
|
||||||
|
if (this.webdavConfig.depth === "auto_unknown") {
|
||||||
|
let testPassed = false;
|
||||||
|
try {
|
||||||
|
const res = await this.client.customRequest(`/${this.remoteBaseDir}/`, {
|
||||||
|
method: "PROPFIND",
|
||||||
|
headers: {
|
||||||
|
Depth: "infinity",
|
||||||
|
},
|
||||||
|
responseType: "text",
|
||||||
|
});
|
||||||
|
if (res.status === 403) {
|
||||||
|
throw Error("not support Infinity, get 403");
|
||||||
|
} else {
|
||||||
|
testPassed = true;
|
||||||
|
this.webdavConfig.depth = "auto_infinity";
|
||||||
|
this.webdavConfig.manualRecursive = false;
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
testPassed = false;
|
||||||
|
}
|
||||||
|
if (!testPassed) {
|
||||||
|
try {
|
||||||
|
const res = await this.client.customRequest(
|
||||||
|
`/${this.remoteBaseDir}/`,
|
||||||
|
{
|
||||||
|
method: "PROPFIND",
|
||||||
|
headers: {
|
||||||
|
Depth: "1",
|
||||||
|
},
|
||||||
|
responseType: "text",
|
||||||
|
}
|
||||||
|
);
|
||||||
|
testPassed = true;
|
||||||
|
this.webdavConfig.depth = "auto_1";
|
||||||
|
this.webdavConfig.manualRecursive = true;
|
||||||
|
} catch (error) {
|
||||||
|
testPassed = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (testPassed) {
|
||||||
|
// the depth option has been changed
|
||||||
|
// save the setting
|
||||||
|
if (this.saveUpdatedConfigFunc !== undefined) {
|
||||||
|
await this.saveUpdatedConfigFunc();
|
||||||
|
log.info(
|
||||||
|
`webdav depth="auto_unknown" is changed to ${this.webdavConfig.depth}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export const getWebdavClient = (
|
export const getWebdavClient = (
|
||||||
webdavConfig: WebdavConfig,
|
webdavConfig: WebdavConfig,
|
||||||
vaultName: string
|
remoteBaseDir: string,
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any>
|
||||||
) => {
|
) => {
|
||||||
return new WrappedWebdavClient(webdavConfig, vaultName);
|
return new WrappedWebdavClient(
|
||||||
|
webdavConfig,
|
||||||
|
remoteBaseDir,
|
||||||
|
saveUpdatedConfigFunc
|
||||||
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const getRemoteMeta = async (
|
export const getRemoteMeta = async (
|
||||||
@@ -124,12 +289,12 @@ export const getRemoteMeta = async (
|
|||||||
fileOrFolderPath: string
|
fileOrFolderPath: string
|
||||||
) => {
|
) => {
|
||||||
await client.init();
|
await client.init();
|
||||||
const remotePath = getWebdavPath(fileOrFolderPath, client.vaultName);
|
const remotePath = getWebdavPath(fileOrFolderPath, client.remoteBaseDir);
|
||||||
// log.info(`remotePath = ${remotePath}`);
|
// log.info(`remotePath = ${remotePath}`);
|
||||||
const res = (await client.client.stat(remotePath, {
|
const res = (await client.client.stat(remotePath, {
|
||||||
details: false,
|
details: false,
|
||||||
})) as FileStat;
|
})) as FileStat;
|
||||||
return fromWebdavItemToRemoteItem(res, client.vaultName);
|
return fromWebdavItemToRemoteItem(res, client.remoteBaseDir);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const uploadToRemote = async (
|
export const uploadToRemote = async (
|
||||||
@@ -138,25 +303,30 @@ export const uploadToRemote = async (
|
|||||||
vault: Vault,
|
vault: Vault,
|
||||||
isRecursively: boolean = false,
|
isRecursively: boolean = false,
|
||||||
password: string = "",
|
password: string = "",
|
||||||
remoteEncryptedKey: string = ""
|
remoteEncryptedKey: string = "",
|
||||||
|
uploadRaw: boolean = false,
|
||||||
|
rawContent: string | ArrayBuffer = ""
|
||||||
) => {
|
) => {
|
||||||
await client.init();
|
await client.init();
|
||||||
let uploadFile = fileOrFolderPath;
|
let uploadFile = fileOrFolderPath;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
uploadFile = remoteEncryptedKey;
|
uploadFile = remoteEncryptedKey;
|
||||||
}
|
}
|
||||||
uploadFile = getWebdavPath(uploadFile, client.vaultName);
|
uploadFile = getWebdavPath(uploadFile, client.remoteBaseDir);
|
||||||
|
|
||||||
const isFolder = fileOrFolderPath.endsWith("/");
|
const isFolder = fileOrFolderPath.endsWith("/");
|
||||||
|
|
||||||
if (isFolder && isRecursively) {
|
if (isFolder && isRecursively) {
|
||||||
throw Error("upload function doesn't implement recursive function yet!");
|
throw Error("upload function doesn't implement recursive function yet!");
|
||||||
} else if (isFolder && !isRecursively) {
|
} else if (isFolder && !isRecursively) {
|
||||||
|
if (uploadRaw) {
|
||||||
|
throw Error(`you specify uploadRaw, but you also provide a folder key!`);
|
||||||
|
}
|
||||||
// folder
|
// folder
|
||||||
if (password === "") {
|
if (password === "") {
|
||||||
// if not encrypted, mkdir a remote folder
|
// if not encrypted, mkdir a remote folder
|
||||||
await client.client.createDirectory(uploadFile, {
|
await client.client.createDirectory(uploadFile, {
|
||||||
recursive: true,
|
recursive: false, // the sync algo should guarantee no need to recursive
|
||||||
});
|
});
|
||||||
const res = await getRemoteMeta(client, uploadFile);
|
const res = await getRemoteMeta(client, uploadFile);
|
||||||
return res;
|
return res;
|
||||||
@@ -164,7 +334,7 @@ export const uploadToRemote = async (
|
|||||||
// if encrypted, upload a fake file with the encrypted file name
|
// if encrypted, upload a fake file with the encrypted file name
|
||||||
await client.client.putFileContents(uploadFile, "", {
|
await client.client.putFileContents(uploadFile, "", {
|
||||||
overwrite: true,
|
overwrite: true,
|
||||||
onUploadProgress: (progress) => {
|
onUploadProgress: (progress: any) => {
|
||||||
// log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
|
// log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -174,19 +344,29 @@ export const uploadToRemote = async (
|
|||||||
} else {
|
} else {
|
||||||
// file
|
// file
|
||||||
// we ignore isRecursively parameter here
|
// we ignore isRecursively parameter here
|
||||||
const localContent = await vault.adapter.readBinary(fileOrFolderPath);
|
let localContent = undefined;
|
||||||
|
if (uploadRaw) {
|
||||||
|
if (typeof rawContent === "string") {
|
||||||
|
localContent = new TextEncoder().encode(rawContent).buffer;
|
||||||
|
} else {
|
||||||
|
localContent = rawContent;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
localContent = await vault.adapter.readBinary(fileOrFolderPath);
|
||||||
|
}
|
||||||
let remoteContent = localContent;
|
let remoteContent = localContent;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
remoteContent = await encryptArrayBuffer(localContent, password);
|
remoteContent = await encryptArrayBuffer(localContent, password);
|
||||||
}
|
}
|
||||||
// we need to create folders before uploading
|
// updated 20220326: the algorithm guarantee this
|
||||||
const dir = getPathFolder(uploadFile);
|
// // we need to create folders before uploading
|
||||||
if (dir !== "/" && dir !== "") {
|
// const dir = getPathFolder(uploadFile);
|
||||||
await client.client.createDirectory(dir, { recursive: true });
|
// if (dir !== "/" && dir !== "") {
|
||||||
}
|
// await client.client.createDirectory(dir, { recursive: false });
|
||||||
|
// }
|
||||||
await client.client.putFileContents(uploadFile, remoteContent, {
|
await client.client.putFileContents(uploadFile, remoteContent, {
|
||||||
overwrite: true,
|
overwrite: true,
|
||||||
onUploadProgress: (progress) => {
|
onUploadProgress: (progress: any) => {
|
||||||
log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
|
log.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -205,10 +385,13 @@ export const listFromRemote = async (
|
|||||||
await client.init();
|
await client.init();
|
||||||
|
|
||||||
let contents = [] as FileStat[];
|
let contents = [] as FileStat[];
|
||||||
if (client.webdavConfig.manualRecursive) {
|
if (
|
||||||
|
client.webdavConfig.depth === "auto_1" ||
|
||||||
|
client.webdavConfig.depth === "manual_1"
|
||||||
|
) {
|
||||||
// the remote doesn't support infinity propfind,
|
// the remote doesn't support infinity propfind,
|
||||||
// we need to do a bfs here
|
// we need to do a bfs here
|
||||||
const q = new Queue([`/${client.vaultName}`]);
|
const q = new Queue([`/${client.remoteBaseDir}`]);
|
||||||
const CHUNK_SIZE = 10;
|
const CHUNK_SIZE = 10;
|
||||||
while (q.length > 0) {
|
while (q.length > 0) {
|
||||||
const itemsToFetch = [];
|
const itemsToFetch = [];
|
||||||
@@ -223,7 +406,10 @@ export const listFromRemote = async (
|
|||||||
return client.client.getDirectoryContents(x, {
|
return client.client.getDirectoryContents(x, {
|
||||||
deep: false,
|
deep: false,
|
||||||
details: false /* no need for verbose details here */,
|
details: false /* no need for verbose details here */,
|
||||||
glob: "/**" /* avoid dot files by using glob */,
|
// TODO: to support .obsidian,
|
||||||
|
// we need to load all files including dot,
|
||||||
|
// anyway to reduce the resources?
|
||||||
|
// glob: "/**" /* avoid dot files by using glob */,
|
||||||
}) as Promise<FileStat[]>;
|
}) as Promise<FileStat[]>;
|
||||||
});
|
});
|
||||||
const r2 = flatten(await Promise.all(r));
|
const r2 = flatten(await Promise.all(r));
|
||||||
@@ -240,17 +426,20 @@ export const listFromRemote = async (
|
|||||||
} else {
|
} else {
|
||||||
// the remote supports infinity propfind
|
// the remote supports infinity propfind
|
||||||
contents = (await client.client.getDirectoryContents(
|
contents = (await client.client.getDirectoryContents(
|
||||||
`/${client.vaultName}`,
|
`/${client.remoteBaseDir}`,
|
||||||
{
|
{
|
||||||
deep: true,
|
deep: true,
|
||||||
details: false /* no need for verbose details here */,
|
details: false /* no need for verbose details here */,
|
||||||
glob: "/**" /* avoid dot files by using glob */,
|
// TODO: to support .obsidian,
|
||||||
|
// we need to load all files including dot,
|
||||||
|
// anyway to reduce the resources?
|
||||||
|
// glob: "/**" /* avoid dot files by using glob */,
|
||||||
}
|
}
|
||||||
)) as FileStat[];
|
)) as FileStat[];
|
||||||
}
|
}
|
||||||
return {
|
return {
|
||||||
Contents: contents.map((x) =>
|
Contents: contents.map((x) =>
|
||||||
fromWebdavItemToRemoteItem(x, client.vaultName)
|
fromWebdavItemToRemoteItem(x, client.remoteBaseDir)
|
||||||
),
|
),
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
@@ -261,7 +450,7 @@ const downloadFromRemoteRaw = async (
|
|||||||
) => {
|
) => {
|
||||||
await client.init();
|
await client.init();
|
||||||
const buff = (await client.client.getFileContents(
|
const buff = (await client.client.getFileContents(
|
||||||
getWebdavPath(fileOrFolderPath, client.vaultName)
|
getWebdavPath(fileOrFolderPath, client.remoteBaseDir)
|
||||||
)) as BufferLike;
|
)) as BufferLike;
|
||||||
if (buff instanceof ArrayBuffer) {
|
if (buff instanceof ArrayBuffer) {
|
||||||
return buff;
|
return buff;
|
||||||
@@ -277,13 +466,16 @@ export const downloadFromRemote = async (
|
|||||||
vault: Vault,
|
vault: Vault,
|
||||||
mtime: number,
|
mtime: number,
|
||||||
password: string = "",
|
password: string = "",
|
||||||
remoteEncryptedKey: string = ""
|
remoteEncryptedKey: string = "",
|
||||||
|
skipSaving: boolean = false
|
||||||
) => {
|
) => {
|
||||||
await client.init();
|
await client.init();
|
||||||
|
|
||||||
const isFolder = fileOrFolderPath.endsWith("/");
|
const isFolder = fileOrFolderPath.endsWith("/");
|
||||||
|
|
||||||
await mkdirpInVault(fileOrFolderPath, vault);
|
if (!skipSaving) {
|
||||||
|
await mkdirpInVault(fileOrFolderPath, vault);
|
||||||
|
}
|
||||||
|
|
||||||
// the file is always local file
|
// the file is always local file
|
||||||
// we need to encrypt it
|
// we need to encrypt it
|
||||||
@@ -291,20 +483,24 @@ export const downloadFromRemote = async (
|
|||||||
if (isFolder) {
|
if (isFolder) {
|
||||||
// mkdirp locally is enough
|
// mkdirp locally is enough
|
||||||
// do nothing here
|
// do nothing here
|
||||||
|
return new ArrayBuffer(0);
|
||||||
} else {
|
} else {
|
||||||
let downloadFile = fileOrFolderPath;
|
let downloadFile = fileOrFolderPath;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
downloadFile = remoteEncryptedKey;
|
downloadFile = remoteEncryptedKey;
|
||||||
}
|
}
|
||||||
downloadFile = getWebdavPath(downloadFile, client.vaultName);
|
downloadFile = getWebdavPath(downloadFile, client.remoteBaseDir);
|
||||||
const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
|
const remoteContent = await downloadFromRemoteRaw(client, downloadFile);
|
||||||
let localContent = remoteContent;
|
let localContent = remoteContent;
|
||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
localContent = await decryptArrayBuffer(remoteContent, password);
|
localContent = await decryptArrayBuffer(remoteContent, password);
|
||||||
}
|
}
|
||||||
await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
|
if (!skipSaving) {
|
||||||
mtime: mtime,
|
await vault.adapter.writeBinary(fileOrFolderPath, localContent, {
|
||||||
});
|
mtime: mtime,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return localContent;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -321,7 +517,7 @@ export const deleteFromRemote = async (
|
|||||||
if (password !== "") {
|
if (password !== "") {
|
||||||
remoteFileName = remoteEncryptedKey;
|
remoteFileName = remoteEncryptedKey;
|
||||||
}
|
}
|
||||||
remoteFileName = getWebdavPath(remoteFileName, client.vaultName);
|
remoteFileName = getWebdavPath(remoteFileName, client.remoteBaseDir);
|
||||||
|
|
||||||
await client.init();
|
await client.init();
|
||||||
try {
|
try {
|
||||||
@@ -333,15 +529,40 @@ export const deleteFromRemote = async (
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
export const checkConnectivity = async (client: WrappedWebdavClient) => {
|
export const checkConnectivity = async (
|
||||||
|
client: WrappedWebdavClient,
|
||||||
|
callbackFunc?: any
|
||||||
|
) => {
|
||||||
|
if (
|
||||||
|
!(
|
||||||
|
client.webdavConfig.address.startsWith("http://") ||
|
||||||
|
client.webdavConfig.address.startsWith("https://")
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
const err = "Error: the url should start with http(s):// but it does not!";
|
||||||
|
log.debug(err);
|
||||||
|
if (callbackFunc !== undefined) {
|
||||||
|
callbackFunc(err);
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
try {
|
try {
|
||||||
await client.init();
|
await client.init();
|
||||||
const results = await getRemoteMeta(client, "/");
|
const results = await getRemoteMeta(client, "/");
|
||||||
if (results === undefined) {
|
if (results === undefined) {
|
||||||
|
const err = "results is undefined";
|
||||||
|
log.debug(err);
|
||||||
|
if (callbackFunc !== undefined) {
|
||||||
|
callbackFunc(err);
|
||||||
|
}
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
return true;
|
return true;
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
log.debug(err);
|
||||||
|
if (callbackFunc !== undefined) {
|
||||||
|
callbackFunc(err);
|
||||||
|
}
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|||||||
+1055
-301
File diff suppressed because it is too large
Load Diff
+965
-370
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,63 @@
|
|||||||
|
import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
|
||||||
|
import type RemotelySavePlugin from "./main"; // unavoidable
|
||||||
|
import type { TransItemType } from "./i18n";
|
||||||
|
|
||||||
|
import { log } from "./moreOnLog";
|
||||||
|
|
||||||
|
export class SyncAlgoV2Modal extends Modal {
|
||||||
|
agree: boolean;
|
||||||
|
readonly plugin: RemotelySavePlugin;
|
||||||
|
constructor(app: App, plugin: RemotelySavePlugin) {
|
||||||
|
super(app);
|
||||||
|
this.plugin = plugin;
|
||||||
|
this.agree = false;
|
||||||
|
}
|
||||||
|
onOpen() {
|
||||||
|
let { contentEl } = this;
|
||||||
|
const t = (x: TransItemType, vars?: any) => {
|
||||||
|
return this.plugin.i18n.t(x, vars);
|
||||||
|
};
|
||||||
|
|
||||||
|
contentEl.createEl("h2", {
|
||||||
|
text: t("syncalgov2_title"),
|
||||||
|
});
|
||||||
|
|
||||||
|
const ul = contentEl.createEl("ul");
|
||||||
|
t("syncalgov2_texts")
|
||||||
|
.split("\n")
|
||||||
|
.forEach((val) => {
|
||||||
|
ul.createEl("li", {
|
||||||
|
text: val,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
new Setting(contentEl)
|
||||||
|
.addButton((button) => {
|
||||||
|
button.setButtonText(t("syncalgov2_button_agree"));
|
||||||
|
button.onClick(async () => {
|
||||||
|
this.agree = true;
|
||||||
|
this.close();
|
||||||
|
});
|
||||||
|
})
|
||||||
|
.addButton((button) => {
|
||||||
|
button.setButtonText(t("syncalgov2_button_disagree"));
|
||||||
|
button.onClick(() => {
|
||||||
|
this.close();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
onClose() {
|
||||||
|
let { contentEl } = this;
|
||||||
|
contentEl.empty();
|
||||||
|
if (this.agree) {
|
||||||
|
log.info("agree to use the new algorithm");
|
||||||
|
this.plugin.saveAgreeToUseNewSyncAlgorithm();
|
||||||
|
this.plugin.enableAutoSyncIfSet();
|
||||||
|
this.plugin.enableInitSyncIfSet();
|
||||||
|
} else {
|
||||||
|
log.info("do not agree to use the new algorithm");
|
||||||
|
this.plugin.unload();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -8,6 +8,8 @@ import {
|
|||||||
encryptArrayBuffer,
|
encryptArrayBuffer,
|
||||||
encryptStringToBase32,
|
encryptStringToBase32,
|
||||||
encryptStringToBase64url,
|
encryptStringToBase64url,
|
||||||
|
getSizeFromEncToOrig,
|
||||||
|
getSizeFromOrigToEnc,
|
||||||
} from "../src/encrypt";
|
} from "../src/encrypt";
|
||||||
import { base64ToBase64url, bufferToArrayBuffer } from "../src/misc";
|
import { base64ToBase64url, bufferToArrayBuffer } from "../src/misc";
|
||||||
|
|
||||||
@@ -110,4 +112,34 @@ describe("Encryption tests", () => {
|
|||||||
|
|
||||||
expect(Buffer.from(dec).equals(Buffer.from(opensslArrBuf))).to.be.true;
|
expect(Buffer.from(dec).equals(Buffer.from(opensslArrBuf))).to.be.true;
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("should get size from origin to encrypted correctly", () => {
|
||||||
|
expect(() => getSizeFromOrigToEnc(-1)).to.throw();
|
||||||
|
expect(() => getSizeFromOrigToEnc(0.5)).to.throw();
|
||||||
|
expect(getSizeFromOrigToEnc(0)).equals(32);
|
||||||
|
expect(getSizeFromOrigToEnc(15)).equals(32);
|
||||||
|
expect(getSizeFromOrigToEnc(16)).equals(48);
|
||||||
|
expect(getSizeFromOrigToEnc(31)).equals(48);
|
||||||
|
expect(getSizeFromOrigToEnc(32)).equals(64);
|
||||||
|
expect(getSizeFromOrigToEnc(14787203)).equals(14787232);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should get size from encrypted to origin correctly", () => {
|
||||||
|
expect(() => getSizeFromEncToOrig(-1)).to.throw();
|
||||||
|
expect(() => getSizeFromEncToOrig(30)).to.throw();
|
||||||
|
|
||||||
|
expect(getSizeFromEncToOrig(32)).to.deep.equal({
|
||||||
|
minSize: 0,
|
||||||
|
maxSize: 15,
|
||||||
|
});
|
||||||
|
expect(getSizeFromEncToOrig(48)).to.deep.equal({
|
||||||
|
minSize: 16,
|
||||||
|
maxSize: 31,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(() => getSizeFromEncToOrig(14787231)).to.throw();
|
||||||
|
|
||||||
|
let { minSize, maxSize } = getSizeFromEncToOrig(14787232);
|
||||||
|
expect(minSize <= 14787203 && 14787203 <= maxSize).to.be.true;
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -0,0 +1,86 @@
|
|||||||
|
import * as chai from "chai";
|
||||||
|
import chaiAsPromised from "chai-as-promised";
|
||||||
|
|
||||||
|
import {
|
||||||
|
isEqualMetadataOnRemote,
|
||||||
|
MetadataOnRemote,
|
||||||
|
} from "../src/metadataOnRemote";
|
||||||
|
|
||||||
|
chai.use(chaiAsPromised);
|
||||||
|
const expect = chai.expect;
|
||||||
|
|
||||||
|
describe("Metadata operations tests", () => {
|
||||||
|
it("should compare objects deeply", async () => {
|
||||||
|
const a: MetadataOnRemote = {
|
||||||
|
deletions: [
|
||||||
|
{ key: "xxx", actionWhen: 1 },
|
||||||
|
{ key: "yyy", actionWhen: 2 },
|
||||||
|
],
|
||||||
|
};
|
||||||
|
const b: MetadataOnRemote = {
|
||||||
|
deletions: [
|
||||||
|
{ key: "xxx", actionWhen: 1 },
|
||||||
|
{ key: "yyy", actionWhen: 2 },
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
expect(isEqualMetadataOnRemote(a, b));
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should find diff", async () => {
|
||||||
|
const a: MetadataOnRemote = {
|
||||||
|
deletions: [
|
||||||
|
{ key: "xxxx", actionWhen: 1 },
|
||||||
|
{ key: "yyy", actionWhen: 2 },
|
||||||
|
],
|
||||||
|
};
|
||||||
|
const b: MetadataOnRemote = {
|
||||||
|
deletions: [
|
||||||
|
{ key: "xxx", actionWhen: 1 },
|
||||||
|
{ key: "yyy", actionWhen: 2 },
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
expect(!isEqualMetadataOnRemote(a, b));
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should treat undefined correctly", async () => {
|
||||||
|
const a: MetadataOnRemote = undefined;
|
||||||
|
let b: MetadataOnRemote = {
|
||||||
|
deletions: [
|
||||||
|
{ key: "xxx", actionWhen: 1 },
|
||||||
|
{ key: "yyy", actionWhen: 2 },
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
expect(!isEqualMetadataOnRemote(a, b));
|
||||||
|
|
||||||
|
b = { deletions: [] };
|
||||||
|
expect(isEqualMetadataOnRemote(a, b));
|
||||||
|
|
||||||
|
b = { deletions: undefined };
|
||||||
|
expect(isEqualMetadataOnRemote(a, b));
|
||||||
|
|
||||||
|
b = undefined;
|
||||||
|
expect(isEqualMetadataOnRemote(a, b));
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should ignore generated at fields", async () => {
|
||||||
|
const a: MetadataOnRemote = {
|
||||||
|
deletions: [
|
||||||
|
{ key: "xxxx", actionWhen: 1 },
|
||||||
|
{ key: "yyy", actionWhen: 2 },
|
||||||
|
],
|
||||||
|
generatedWhen: 1,
|
||||||
|
};
|
||||||
|
const b: MetadataOnRemote = {
|
||||||
|
deletions: [
|
||||||
|
{ key: "xxx", actionWhen: 1 },
|
||||||
|
{ key: "yyy", actionWhen: 2 },
|
||||||
|
],
|
||||||
|
generatedWhen: 2,
|
||||||
|
};
|
||||||
|
|
||||||
|
expect(isEqualMetadataOnRemote(a, b));
|
||||||
|
});
|
||||||
|
});
|
||||||
+143
-3
@@ -21,7 +21,7 @@ describe("Misc: hidden file", () => {
|
|||||||
|
|
||||||
item = "_hidden_loose";
|
item = "_hidden_loose";
|
||||||
expect(misc.isHiddenPath(item)).to.be.true;
|
expect(misc.isHiddenPath(item)).to.be.true;
|
||||||
expect(misc.isHiddenPath(item, false)).to.be.false;
|
expect(misc.isHiddenPath(item, true, false)).to.be.false;
|
||||||
|
|
||||||
item = "/sdd/_hidden_loose";
|
item = "/sdd/_hidden_loose";
|
||||||
expect(misc.isHiddenPath(item)).to.be.true;
|
expect(misc.isHiddenPath(item)).to.be.true;
|
||||||
@@ -30,10 +30,21 @@ describe("Misc: hidden file", () => {
|
|||||||
expect(misc.isHiddenPath(item)).to.be.true;
|
expect(misc.isHiddenPath(item)).to.be.true;
|
||||||
|
|
||||||
item = "what/../_hidden_loose/what/what/what";
|
item = "what/../_hidden_loose/what/what/what";
|
||||||
expect(misc.isHiddenPath(item, false)).to.be.false;
|
expect(misc.isHiddenPath(item, true, false)).to.be.false;
|
||||||
|
|
||||||
item = "what/../_hidden_loose/../.hidden/what/what/what";
|
item = "what/../_hidden_loose/../.hidden/what/what/what";
|
||||||
expect(misc.isHiddenPath(item, false)).to.be.true;
|
expect(misc.isHiddenPath(item, true, false)).to.be.true;
|
||||||
|
|
||||||
|
item = "what/../_hidden_loose/../.hidden/what/what/what";
|
||||||
|
expect(misc.isHiddenPath(item, false, true)).to.be.false;
|
||||||
|
|
||||||
|
item = "what/_hidden_loose/what/what/what";
|
||||||
|
expect(misc.isHiddenPath(item, false, true)).to.be.true;
|
||||||
|
expect(misc.isHiddenPath(item, true, false)).to.be.false;
|
||||||
|
|
||||||
|
item = "what/.hidden/what/what/what";
|
||||||
|
expect(misc.isHiddenPath(item, false, true)).to.be.false;
|
||||||
|
expect(misc.isHiddenPath(item, true, false)).to.be.true;
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -68,6 +79,20 @@ describe("Misc: get folder levels", () => {
|
|||||||
expect(misc.getFolderLevels(item3)).to.deep.equal(res3);
|
expect(misc.getFolderLevels(item3)).to.deep.equal(res3);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("should correctly add ending slash if required", () => {
|
||||||
|
const item = "xxx/yyy/zzz.md";
|
||||||
|
const res = ["xxx/", "xxx/yyy/"];
|
||||||
|
expect(misc.getFolderLevels(item, true)).to.deep.equal(res);
|
||||||
|
|
||||||
|
const item2 = "xxx/yyy/zzz";
|
||||||
|
const res2 = ["xxx/", "xxx/yyy/"];
|
||||||
|
expect(misc.getFolderLevels(item2, true)).to.deep.equal(res2);
|
||||||
|
|
||||||
|
const item3 = "xxx/yyy/zzz/";
|
||||||
|
const res3 = ["xxx/", "xxx/yyy/", "xxx/yyy/zzz/"];
|
||||||
|
expect(misc.getFolderLevels(item3, true)).to.deep.equal(res3);
|
||||||
|
});
|
||||||
|
|
||||||
it("should treat path starting with / correctly", () => {
|
it("should treat path starting with / correctly", () => {
|
||||||
const item = "/xxx/yyy/zzz.md";
|
const item = "/xxx/yyy/zzz.md";
|
||||||
const res = ["/xxx", "/xxx/yyy"];
|
const res = ["/xxx", "/xxx/yyy"];
|
||||||
@@ -91,6 +116,27 @@ describe("Misc: get folder levels", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("Misc: get parent folder", () => {
|
||||||
|
it("should treat empty path correctly", () => {
|
||||||
|
const item = "";
|
||||||
|
expect(misc.getParentFolder(item)).equals("/");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should treat one level path correctly", () => {
|
||||||
|
let item = "abc/";
|
||||||
|
expect(misc.getParentFolder(item)).equals("/");
|
||||||
|
item = "/efg/";
|
||||||
|
expect(misc.getParentFolder(item)).equals("/");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should treat more levels path correctly", () => {
|
||||||
|
let item = "abc/efg";
|
||||||
|
expect(misc.getParentFolder(item)).equals("abc/");
|
||||||
|
item = "/hij/klm/";
|
||||||
|
expect(misc.getParentFolder(item)).equals("/hij/");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe("Misc: vaild file name tests", () => {
|
describe("Misc: vaild file name tests", () => {
|
||||||
it("should treat no ascii correctly", async () => {
|
it("should treat no ascii correctly", async () => {
|
||||||
const x = misc.isVaildText("😄🍎 apple 苹果");
|
const x = misc.isVaildText("😄🍎 apple 苹果");
|
||||||
@@ -145,3 +191,97 @@ describe("Misc: extract svg", () => {
|
|||||||
expect(y).to.equal("<rect/><g/>");
|
expect(y).to.equal("<rect/><g/>");
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("Misc: get split ranges", () => {
|
||||||
|
it("should deal with big parts", () => {
|
||||||
|
const k = misc.getSplitRanges(10, 20);
|
||||||
|
const k2: misc.SplitRange[] = [
|
||||||
|
{
|
||||||
|
partNum: 1,
|
||||||
|
start: 0,
|
||||||
|
end: 10,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
expect(k).to.deep.equal(k2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should deal with 0 remainder", () => {
|
||||||
|
const k = misc.getSplitRanges(20, 10);
|
||||||
|
const k2: misc.SplitRange[] = [
|
||||||
|
{
|
||||||
|
partNum: 1,
|
||||||
|
start: 0,
|
||||||
|
end: 10,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
partNum: 2,
|
||||||
|
start: 10,
|
||||||
|
end: 20,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
expect(k).to.deep.equal(k2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should deal with not-0 remainder", () => {
|
||||||
|
const k = misc.getSplitRanges(25, 10);
|
||||||
|
const k2: misc.SplitRange[] = [
|
||||||
|
{
|
||||||
|
partNum: 1,
|
||||||
|
start: 0,
|
||||||
|
end: 10,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
partNum: 2,
|
||||||
|
start: 10,
|
||||||
|
end: 20,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
partNum: 3,
|
||||||
|
start: 20,
|
||||||
|
end: 25,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
expect(k).to.deep.equal(k2);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("Misc: at which level", () => {
|
||||||
|
it("should throw error on some parameters", () => {
|
||||||
|
expect(() => misc.atWhichLevel(undefined)).to.throw();
|
||||||
|
expect(() => misc.atWhichLevel("")).to.throw();
|
||||||
|
expect(() => misc.atWhichLevel("..")).to.throw();
|
||||||
|
expect(() => misc.atWhichLevel(".")).to.throw();
|
||||||
|
expect(() => misc.atWhichLevel("/")).to.throw();
|
||||||
|
expect(() => misc.atWhichLevel("/xxyy")).to.throw();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should treat folders correctly", () => {
|
||||||
|
expect(misc.atWhichLevel("x/")).to.be.equal(1);
|
||||||
|
expect(misc.atWhichLevel("x/y/")).to.be.equal(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should treat files correctly", () => {
|
||||||
|
expect(misc.atWhichLevel("x.md")).to.be.equal(1);
|
||||||
|
expect(misc.atWhichLevel("x/y.md")).to.be.equal(2);
|
||||||
|
expect(misc.atWhichLevel("x/y/z.md")).to.be.equal(3);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("Misc: special char for dir", () => {
|
||||||
|
it("should return false for normal string", () => {
|
||||||
|
expect(misc.checkHasSpecialCharForDir("")).to.be.false;
|
||||||
|
expect(misc.checkHasSpecialCharForDir("xxx")).to.be.false;
|
||||||
|
expect(misc.checkHasSpecialCharForDir("yyy_xxx")).to.be.false;
|
||||||
|
expect(misc.checkHasSpecialCharForDir("yyy.xxx")).to.be.false;
|
||||||
|
expect(misc.checkHasSpecialCharForDir("yyy?xxx")).to.be.false;
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should return true for special cases", () => {
|
||||||
|
expect(misc.checkHasSpecialCharForDir("?")).to.be.true;
|
||||||
|
expect(misc.checkHasSpecialCharForDir("/")).to.be.true;
|
||||||
|
expect(misc.checkHasSpecialCharForDir("\\")).to.be.true;
|
||||||
|
expect(misc.checkHasSpecialCharForDir("xxx/yyy")).to.be.true;
|
||||||
|
expect(misc.checkHasSpecialCharForDir("xxx\\yyy")).to.be.true;
|
||||||
|
expect(misc.checkHasSpecialCharForDir("xxx?yyy")).to.be.true;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
@@ -0,0 +1,111 @@
|
|||||||
|
import { expect } from "chai";
|
||||||
|
import type { WebdavConfig } from "../src/baseTypes";
|
||||||
|
import { applyWebdavPresetRulesInplace } from "../src/presetRules";
|
||||||
|
|
||||||
|
describe("Preset rules tests", () => {
|
||||||
|
it("should check undefined correctly", () => {
|
||||||
|
let x: Partial<WebdavConfig> | undefined = undefined;
|
||||||
|
const y = applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(y.webdav === undefined);
|
||||||
|
expect(!y.changed);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should check empty object", () => {
|
||||||
|
let x: Partial<WebdavConfig> | undefined = {};
|
||||||
|
const y = applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(y.webdav).deep.equals({});
|
||||||
|
expect(!y.changed);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should modify depths correctly", () => {
|
||||||
|
let x: Partial<WebdavConfig> = {
|
||||||
|
address: "https://example.teracloud.jp/dav/",
|
||||||
|
depth: "auto_unknown",
|
||||||
|
};
|
||||||
|
let y = applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(x.depth === "auto_1");
|
||||||
|
expect(y.changed);
|
||||||
|
|
||||||
|
x = {
|
||||||
|
address: "https://example.teracloud.jp/dav/example",
|
||||||
|
depth: "auto_unknown",
|
||||||
|
};
|
||||||
|
y = applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(x.depth === "auto_1");
|
||||||
|
expect(y.changed);
|
||||||
|
|
||||||
|
x = {
|
||||||
|
address: "https://dav.jianguoyun.com/dav/",
|
||||||
|
depth: "auto_unknown",
|
||||||
|
};
|
||||||
|
y = applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(x.depth === "auto_1");
|
||||||
|
expect(y.changed);
|
||||||
|
|
||||||
|
x = {
|
||||||
|
address: "https://dav.jianguoyun.com/dav/",
|
||||||
|
depth: "auto_infinity",
|
||||||
|
};
|
||||||
|
y = applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(x.depth === "auto_1");
|
||||||
|
expect(y.changed);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should not modify depths if depths is set automatically correctly", () => {
|
||||||
|
let x: Partial<WebdavConfig> = {
|
||||||
|
address: "https://dav.jianguoyun.com/dav/",
|
||||||
|
depth: "auto_1",
|
||||||
|
};
|
||||||
|
let y = applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(x.depth === "auto_1");
|
||||||
|
expect(!y.changed);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should not modify depths if depths have been set manually", () => {
|
||||||
|
let x: Partial<WebdavConfig> = {
|
||||||
|
address: "https://example.teracloud.jp/dav/",
|
||||||
|
depth: "manual_infinity",
|
||||||
|
};
|
||||||
|
let y = applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(x.depth === "manual_infinity");
|
||||||
|
expect(!y.changed);
|
||||||
|
|
||||||
|
x = {
|
||||||
|
address: "https://example.teracloud.jp/dav/example",
|
||||||
|
depth: "manual_1",
|
||||||
|
};
|
||||||
|
y = applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(x.depth === "manual_1");
|
||||||
|
expect(!y.changed);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should not modify depths when urls are not in preset rules", () => {
|
||||||
|
let x: Partial<WebdavConfig> = {
|
||||||
|
address: "https://teracloud.jp/dav/",
|
||||||
|
depth: "auto_unknown",
|
||||||
|
};
|
||||||
|
applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(x.depth === "auto_unknown");
|
||||||
|
|
||||||
|
x = {
|
||||||
|
address: "https://dav.jianguoyun.com/dav_example",
|
||||||
|
depth: "auto_unknown",
|
||||||
|
};
|
||||||
|
applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(x.depth === "auto_unknown");
|
||||||
|
|
||||||
|
x = {
|
||||||
|
address: "",
|
||||||
|
depth: "auto_unknown",
|
||||||
|
};
|
||||||
|
applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(x.depth === "auto_unknown");
|
||||||
|
|
||||||
|
x = {
|
||||||
|
address: "https://dav.jianguoyun.com/dav/",
|
||||||
|
depth: "what" as any,
|
||||||
|
};
|
||||||
|
applyWebdavPresetRulesInplace(x);
|
||||||
|
expect(x.depth === ("what" as any));
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -9,6 +9,7 @@
|
|||||||
"noImplicitAny": true,
|
"noImplicitAny": true,
|
||||||
"moduleResolution": "node",
|
"moduleResolution": "node",
|
||||||
// "allowSyntheticDefaultImports": true,
|
// "allowSyntheticDefaultImports": true,
|
||||||
|
"resolveJsonModule": true,
|
||||||
"esModuleInterop": true,
|
"esModuleInterop": true,
|
||||||
"importHelpers": true,
|
"importHelpers": true,
|
||||||
"isolatedModules": true,
|
"isolatedModules": true,
|
||||||
|
|||||||
+2
-1
@@ -1,3 +1,4 @@
|
|||||||
{
|
{
|
||||||
"0.2.14": "0.12.15"
|
"0.3.2": "0.12.15",
|
||||||
|
"0.3.20": "0.13.21"
|
||||||
}
|
}
|
||||||
|
|||||||
+3
-1
@@ -57,6 +57,7 @@ module.exports = {
|
|||||||
// events: require.resolve("events"),
|
// events: require.resolve("events"),
|
||||||
// http: require.resolve("stream-http"),
|
// http: require.resolve("stream-http"),
|
||||||
// https: require.resolve("https-browserify"),
|
// https: require.resolve("https-browserify"),
|
||||||
|
net: false,
|
||||||
// os: require.resolve("os-browserify/browser"),
|
// os: require.resolve("os-browserify/browser"),
|
||||||
path: require.resolve("path-browserify"),
|
path: require.resolve("path-browserify"),
|
||||||
// punycode: require.resolve("punycode"),
|
// punycode: require.resolve("punycode"),
|
||||||
@@ -66,8 +67,9 @@ module.exports = {
|
|||||||
// string_decoder: require.resolve("string_decoder"),
|
// string_decoder: require.resolve("string_decoder"),
|
||||||
// sys: require.resolve("util"),
|
// sys: require.resolve("util"),
|
||||||
// timers: require.resolve("timers-browserify"),
|
// timers: require.resolve("timers-browserify"),
|
||||||
|
tls: false,
|
||||||
// tty: require.resolve("tty-browserify"),
|
// tty: require.resolve("tty-browserify"),
|
||||||
// url: require.resolve("url"),
|
url: require.resolve("url/"),
|
||||||
// util: require.resolve("util"),
|
// util: require.resolve("util"),
|
||||||
// vm: require.resolve("vm-browserify"),
|
// vm: require.resolve("vm-browserify"),
|
||||||
// zlib: require.resolve("browserify-zlib"),
|
// zlib: require.resolve("browserify-zlib"),
|
||||||
|
|||||||
Reference in New Issue
Block a user