Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2ace90155c | ||
|
|
d885a4c743 | ||
|
|
b6d46d8b91 | ||
|
|
06dad54d4c | ||
|
|
0802767726 | ||
|
|
be4a2d3271 | ||
|
|
7ca2d19255 | ||
|
|
ff765d5ae7 | ||
|
|
bdbf0b1484 | ||
|
|
7497b5fae7 | ||
|
|
408acb6230 | ||
|
|
d9cab7b1ff | ||
|
|
5e53967e01 | ||
|
|
fb9f4a67b4 | ||
|
|
26a426dda8 | ||
|
|
de64c3c53f | ||
|
|
0cefafa491 | ||
|
|
b769becb97 | ||
|
|
7b3600a46f | ||
|
|
69e72eae1d | ||
|
|
b0acde0ba6 | ||
|
|
11b7fee80b | ||
|
|
c4c39f6b79 | ||
|
|
45578a01dd | ||
|
|
0391c42999 | ||
|
|
807eec928e | ||
|
|
3d7c4d2a4a | ||
|
|
cb779fc7bf | ||
|
|
9d8e2af7b9 | ||
|
|
a48440e60b | ||
|
|
2a84fae368 | ||
|
|
3c3426a842 | ||
|
|
74de7da89a | ||
|
|
1f33ac5d7a | ||
|
|
63c54d1956 | ||
|
|
b584f89a95 | ||
|
|
fa17ea074b | ||
|
|
cb98bae79a | ||
|
|
d1e30e3536 | ||
|
|
36079fc1d0 | ||
|
|
67467a5034 | ||
|
|
2a3df8ab53 | ||
|
|
e66b0c71c4 | ||
|
|
a081d09212 | ||
|
|
6ed6122bb6 | ||
|
|
235e346d2f | ||
|
|
084cbc8391 | ||
|
|
dc0c1db779 | ||
|
|
2645ff34e6 | ||
|
|
f25a2c2992 | ||
|
|
3d1269a9f2 | ||
|
|
ed52a8542f | ||
|
|
757eb5c801 | ||
|
|
048e7b6251 | ||
|
|
b762052da3 | ||
|
|
c61efd1367 | ||
|
|
605bffa471 | ||
|
|
895e3db4c6 | ||
|
|
ce1990a35f | ||
|
|
9ea7c8e858 | ||
|
|
61a3fab219 | ||
|
|
5340e38eac | ||
|
|
8d5868b8d8 | ||
|
|
55175a6d06 | ||
|
|
f60bd25490 | ||
|
|
1d8463a3ed | ||
|
|
9fe1b1d5e6 | ||
|
|
df7b6e1848 | ||
|
|
a9126e5947 | ||
|
|
3bb7355db3 | ||
|
|
f33fa26c03 | ||
|
|
5ce350ba41 | ||
|
|
1d32f1242d | ||
|
|
d8ab054da1 | ||
|
|
b877228415 | ||
|
|
28b99557a8 | ||
|
|
ae28cf9183 | ||
|
|
8f68ac4ded | ||
|
|
220fd07a8b | ||
|
|
fe572b41c9 | ||
|
|
ca5ca5f576 | ||
|
|
0e6182b887 | ||
|
|
c5a7085fda | ||
|
|
640f1e56f1 | ||
|
|
cb6f7e572c | ||
|
|
83e0073134 | ||
|
|
cfe316f690 | ||
|
|
c472654060 | ||
|
|
46cbfcc3aa | ||
|
|
ce94a6d79c | ||
|
|
0fc0dcad64 | ||
|
|
577cdde21f | ||
|
|
583b365e72 | ||
|
|
3d213b2be8 | ||
|
|
ee224bf4f2 | ||
|
|
f1bd0b1ce6 | ||
|
|
300ed213af | ||
|
|
4be67ce491 | ||
|
|
98107ba4ea | ||
|
|
b674dd0f10 | ||
|
|
7930509e2a | ||
|
|
1c918d82da | ||
|
|
593fd7471b | ||
|
|
222f386586 | ||
|
|
dcd02457cb | ||
|
|
791c0e8df6 | ||
|
|
c37bf6aedd | ||
|
|
bed28d9f0b | ||
|
|
02e03681f7 | ||
|
|
62452341a3 | ||
|
|
bff2f6a642 | ||
|
|
833fdee69e | ||
|
|
936fce76a1 | ||
|
|
e2e8265d43 | ||
|
|
e228250613 | ||
|
|
dde4327249 | ||
|
|
e283efc8f7 | ||
|
|
6825241071 | ||
|
|
98380b6c92 | ||
|
|
d3eb2166aa | ||
|
|
7ecce29940 | ||
|
|
581c6237cc | ||
|
|
257c995090 | ||
|
|
fd095a9093 | ||
|
|
acc9233611 | ||
|
|
4456db11cf | ||
|
|
54449dd207 | ||
|
|
822941f1c3 | ||
|
|
62b176d709 | ||
|
|
9553bff44a | ||
|
|
ede1f4e1bc | ||
|
|
97f4c0c427 | ||
|
|
94a56dabdd | ||
|
|
4947eb91a2 | ||
|
|
2d12c9977d | ||
|
|
f2794ac539 | ||
|
|
519fd27dd5 | ||
|
|
dcbd36e33a | ||
|
|
e40a6adf63 | ||
|
|
06bf59bf2a | ||
|
|
d51659d3d1 | ||
|
|
7ec0102c7a | ||
|
|
c828a341ba | ||
|
|
d7ff793715 | ||
|
|
996533328e | ||
|
|
aff5a8b088 | ||
|
|
9fc46553e1 | ||
|
|
447e0c0aa4 | ||
|
|
768d6636d0 | ||
|
|
5f5b5de505 | ||
|
|
5df06bbed5 | ||
|
|
1f4737bfb8 | ||
|
|
40020c3e44 | ||
|
|
c512330d84 | ||
|
|
e34b120a63 | ||
|
|
725b12832c | ||
|
|
e341c4f780 | ||
|
|
10d22cb912 | ||
|
|
06b15b2146 | ||
|
|
2fbd87eed4 | ||
|
|
f6ea9938d1 | ||
|
|
38b189e2a7 | ||
|
|
6d1b451f4c | ||
|
|
69537f7002 | ||
|
|
17de78240f | ||
|
|
8cbcdf5323 | ||
|
|
6ba5abc0a6 | ||
|
|
d820285d1e | ||
|
|
a6002ba340 | ||
|
|
1f31303906 | ||
|
|
0fcedf397f | ||
|
|
085d8448d2 | ||
|
|
0d9da32b00 | ||
|
|
22880d6cf5 | ||
|
|
a084ec7728 | ||
|
|
eeeb4893c7 | ||
|
|
ed1ac66ac0 | ||
|
|
c33a9ecfa4 | ||
|
|
cabca54d80 | ||
|
|
8dde6c59d2 | ||
|
|
480cf224c6 | ||
|
|
37a801332f | ||
|
|
1e33f8b7d2 | ||
|
|
071b10387c | ||
|
|
b99053ef10 | ||
|
|
ff237ad8cb | ||
|
|
b89a163a66 | ||
|
|
991376a7a3 | ||
|
|
2da39bdfec | ||
|
|
f38c3d36be | ||
|
|
da0f183fad | ||
|
|
eb2ecca825 | ||
|
|
2494a2d96e | ||
|
|
8bb095c4aa | ||
|
|
c5e3147805 | ||
|
|
942e54961e | ||
|
|
29a3c76b4e | ||
|
|
897e4fc4e5 | ||
|
|
0124a49d7e | ||
|
|
3e245af50c | ||
|
|
695c74588f | ||
|
|
e3bd41a05a | ||
|
|
a6b73bde6a | ||
|
|
87d6e1f75f | ||
|
|
347c051d0c | ||
|
|
7422956621 | ||
|
|
7b67ba5b26 | ||
|
|
43cf95c417 | ||
|
|
53a1c32b43 | ||
|
|
71e25be28e | ||
|
|
afc5670313 | ||
|
|
81eb45d32c |
@@ -1,3 +1,5 @@
|
|||||||
DROPBOX_APP_KEY=
|
DROPBOX_APP_KEY=
|
||||||
ONEDRIVE_CLIENT_ID=
|
ONEDRIVE_CLIENT_ID=
|
||||||
ONEDRIVE_AUTHORITY=https://
|
ONEDRIVE_AUTHORITY=https://
|
||||||
|
REMOTELYSAVE_WEBSITE=http://127.0.0.1:46683
|
||||||
|
REMOTELYSAVE_CLIENT_ID=cli-xxx
|
||||||
|
|||||||
@@ -31,13 +31,30 @@ body:
|
|||||||
- type: dropdown
|
- type: dropdown
|
||||||
id: service
|
id: service
|
||||||
attributes:
|
attributes:
|
||||||
label: What remote cloud services are you using?
|
label: What remote cloud services are you using? (Please choose the specified one if it's in the list)
|
||||||
multiple: true
|
multiple: true
|
||||||
options:
|
options:
|
||||||
- S3
|
- S3
|
||||||
|
- S3 (Cloudflare R2)
|
||||||
|
- S3 (BackBlaze B2)
|
||||||
|
- S3 (腾讯云 COS Tencent Cloud COS)
|
||||||
|
- S3 (阿里云 OSS Alibaba Cloud OSS)
|
||||||
|
- S3 (MinIO)
|
||||||
|
- S3 (Wasabi)
|
||||||
|
- S3 (Storj)
|
||||||
- OneDrive for personal
|
- OneDrive for personal
|
||||||
|
- OneDrive for business
|
||||||
- Dropbox
|
- Dropbox
|
||||||
- webdav
|
- webdav
|
||||||
|
- webdav (ownCloud)
|
||||||
|
- webdav (InfiniCloud (formally TeraCLOUD))
|
||||||
|
- webdav (AList)
|
||||||
|
- webdav (Cloudreve)
|
||||||
|
- webdav (坚果云 JianGuoYun/NutStore)
|
||||||
|
- webdav (NextCloud)
|
||||||
|
- webdav (FastMail)
|
||||||
|
- webdav (rclone webdav)
|
||||||
|
- webdav (nginx)
|
||||||
- others
|
- others
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|||||||
@@ -21,9 +21,26 @@ body:
|
|||||||
multiple: true
|
multiple: true
|
||||||
options:
|
options:
|
||||||
- S3
|
- S3
|
||||||
|
- S3 (Cloudflare R2)
|
||||||
|
- S3 (BackBlaze B2)
|
||||||
|
- S3 (腾讯云 COS Tencent Cloud COS)
|
||||||
|
- S3 (阿里云 OSS Alibaba Cloud OSS)
|
||||||
|
- S3 (MinIO)
|
||||||
|
- S3 (Wasabi)
|
||||||
|
- S3 (Storj)
|
||||||
- OneDrive for personal
|
- OneDrive for personal
|
||||||
|
- OneDrive for business
|
||||||
- Dropbox
|
- Dropbox
|
||||||
- webdav
|
- webdav
|
||||||
|
- webdav (ownCloud)
|
||||||
|
- webdav (InfiniCloud (formally TeraCLOUD))
|
||||||
|
- webdav (AList)
|
||||||
|
- webdav (Cloudreve)
|
||||||
|
- webdav (坚果云 JianGuoYun/NutStore)
|
||||||
|
- webdav (NextCloud)
|
||||||
|
- webdav (FastMail)
|
||||||
|
- webdav (rclone webdav)
|
||||||
|
- webdav (nginx)
|
||||||
- others
|
- others
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -19,6 +19,8 @@ jobs:
|
|||||||
DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
|
DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
|
||||||
ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
|
ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
|
||||||
ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
|
ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
|
||||||
|
REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}}
|
||||||
|
REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}}
|
||||||
|
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
@@ -29,10 +31,18 @@ jobs:
|
|||||||
- name: Checkout codes
|
- name: Checkout codes
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
lfs: true
|
|
||||||
submodules: recursive
|
submodules: recursive
|
||||||
- name: Checkout LFS
|
- name: Checkout LFS file list
|
||||||
run: git lfs checkout
|
run: git lfs ls-files --long | cut -d ' ' -f1 | sort > .lfs-assets-id
|
||||||
|
- name: LFS Cache
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: .git/lfs/objects
|
||||||
|
key: ${{ runner.os }}-lfs-${{ hashFiles('.lfs-assets-id') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-lfs-
|
||||||
|
- name: Git LFS Pull
|
||||||
|
run: git lfs pull
|
||||||
- name: Use Node.js ${{ matrix.node-version }}
|
- name: Use Node.js ${{ matrix.node-version }}
|
||||||
uses: actions/setup-node@v2
|
uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
|
|||||||
@@ -0,0 +1,43 @@
|
|||||||
|
name: "CLA Assistant"
|
||||||
|
on:
|
||||||
|
issue_comment:
|
||||||
|
types: [created]
|
||||||
|
pull_request_target:
|
||||||
|
types: [opened,closed,synchronize]
|
||||||
|
|
||||||
|
# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
|
||||||
|
permissions:
|
||||||
|
actions: write
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
statuses: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
CLAAssistant:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: "CLA Assistant"
|
||||||
|
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
|
||||||
|
uses: contributor-assistant/github-action@v2.3.0
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
# the below token should have repo scope and must be manually added by you in the repository's secret
|
||||||
|
# This token is required only if you have configured to store the signatures in a remote repository/organization
|
||||||
|
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
|
||||||
|
with:
|
||||||
|
path-to-signatures: 'signatures/version1/cla.json'
|
||||||
|
path-to-document: 'https://github.com/remotely-save/remotely-save/blob/master/CLA.md' # e.g. a CLA or a DCO document
|
||||||
|
# branch should not be protected
|
||||||
|
branch: 'main'
|
||||||
|
allowlist: bot*
|
||||||
|
|
||||||
|
# the followings are the optional inputs - If the optional inputs are not given, then default values will be taken
|
||||||
|
remote-organization-name: remotely-save
|
||||||
|
remote-repository-name: cla-signed
|
||||||
|
#create-file-commit-message: 'For example: Creating file for storing CLA Signatures'
|
||||||
|
#signed-commit-message: 'For example: $contributorName has signed the CLA in $owner/$repo#$pullRequestNo'
|
||||||
|
custom-notsigned-prcomment: '<br/>Thank you for your submission, we really appreciate it. However, we ask that $you sign our [Contributor License Agreement](https://github.com/remotely-save/remotely-save/blob/master/CLA.md) before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.<br/>'
|
||||||
|
#custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA'
|
||||||
|
#custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.'
|
||||||
|
#lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
|
||||||
|
#use-dco-flag: true - If you are using DCO instead of CLA
|
||||||
@@ -23,6 +23,8 @@ jobs:
|
|||||||
DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
|
DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
|
||||||
ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
|
ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
|
||||||
ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
|
ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
|
||||||
|
REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}}
|
||||||
|
REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}}
|
||||||
|
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
@@ -32,10 +34,18 @@ jobs:
|
|||||||
- name: Checkout codes
|
- name: Checkout codes
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
lfs: true
|
|
||||||
submodules: recursive
|
submodules: recursive
|
||||||
- name: Checkout LFS
|
- name: Checkout LFS file list
|
||||||
run: git lfs checkout
|
run: git lfs ls-files --long | cut -d ' ' -f1 | sort > .lfs-assets-id
|
||||||
|
- name: LFS Cache
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: .git/lfs/objects
|
||||||
|
key: ${{ runner.os }}-lfs-${{ hashFiles('.lfs-assets-id') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-lfs-
|
||||||
|
- name: Git LFS Pull
|
||||||
|
run: git lfs pull
|
||||||
- name: Use Node.js ${{ matrix.node-version }}
|
- name: Use Node.js ${{ matrix.node-version }}
|
||||||
uses: actions/setup-node@v2
|
uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
|
|||||||
@@ -1,3 +0,0 @@
|
|||||||
node_modules/
|
|
||||||
main.js
|
|
||||||
data.json
|
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
In order to clarify the intellectual property license granted with Contributions from any person or entity, Remotely Save dev team ("Remotely Save") must have on file a signed Contributor License Agreement ("CLA") from each Contributor, indicating agreement with the license terms below. This agreement is for your protection as a Contributor as well as the protection of Remotely Save and its users. It does not change your rights to use your own Contributions for any other purpose.
|
||||||
|
|
||||||
|
You accept and agree to the following terms and conditions for Your Contributions (present and future) that you submit to Remotely Save. Except for the license granted herein to Remotely Save and recipients of software distributed by Remotely Save, You reserve all right, title, and interest in and to Your Contributions.
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Remotely Save. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Remotely Save for inclusion in, or documentation of, any of the products owned or managed by Remotely Save (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Remotely Save or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Remotely Save for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Remotely Save and to recipients of software distributed by Remotely Save a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Remotely Save and to recipients of software distributed by Remotely Save a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to Remotely Save, or that your employer has executed a separate Corporate CLA with Remotely Save.
|
||||||
|
|
||||||
|
5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
|
||||||
|
|
||||||
|
6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
|
||||||
|
|
||||||
|
7. Should You wish to submit work that is not Your original creation, You may submit it to Remotely Save separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
|
||||||
|
|
||||||
|
8. You agree to notify Remotely Save of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
## What
|
||||||
|
|
||||||
|
Starting from April 29, 2024, all individual contributors' contributions are only possibly accepted after they sign the CLA.
|
||||||
|
|
||||||
|
We do not accept corporate contributions at this moment.
|
||||||
|
|
||||||
|
You can check out [CLA](./CLA.md).
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
1. Make some changes to the code. Open a pull request.
|
||||||
|
2. A rebot will check the status.
|
||||||
|

|
||||||
|
3. Read the [CLA](./CLA.md) carefully and make a decision.
|
||||||
|
4. If you decide to sign the CLA, please make a comment "I have read the CLA Document and I hereby sign the CLA".
|
||||||
|
5. If you decide to not sign the CLA, please close the PR.
|
||||||
|
6. The robot should recheck and pass the check automatically.
|
||||||
|

|
||||||
|
7. Your pr will be reviewed.
|
||||||
|
8. If you sign the CLA and submit some more PRs, the robot should pass the test automatically.
|
||||||
@@ -1,202 +1,3 @@
|
|||||||
Apache License
|
The codes or files or subfolders inside the folder `src`, `tests`, `docs`, `assets`, are released under the "Open Source" license: "Apache License, version 2.0", described at: https://www.apache.org/licenses/LICENSE-2.0 .
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
The codes or files or subfolders inside the folder `pro`, are released under the "Source Available" license: "PolyForm Strict License 1.0.0", described at: https://polyformproject.org/licenses/strict/1.0.0/ .
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright [yyyy] [name of copyright owner]
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.
|
|
||||||
|
|
||||||
|
|||||||
@@ -17,23 +17,23 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
|
|||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Supports:
|
- Supports:
|
||||||
- Amazon S3 or S3-compatible
|
- Amazon S3 or S3-compatible (Cloudflare R2 / BackBlaze B2 / MinIO / ...)
|
||||||
- Dropbox
|
- Dropbox
|
||||||
- OneDrive for personal
|
- OneDrive for personal
|
||||||
- Webdav
|
- Webdav
|
||||||
|
- Webdis
|
||||||
- [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details.
|
- [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details.
|
||||||
- **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
|
- **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
|
||||||
- **[End-to-end encryption](./docs/encryption.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
|
- **[End-to-end encryption](./docs/encryption/README.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
|
||||||
- **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).**
|
||||||
- \*\*Skip Large files and skip paths by custom regex conditions!
|
- **Skip Large files** and **skip paths** by custom regex conditions!
|
||||||
- **Fully open source under [Apache-2.0 License](./LICENSE).**
|
- **[Sync Algorithm](./docs/sync_algorithm/v3/intro.md) is provided for discussion.**
|
||||||
- **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.**
|
- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** for free version. **[Advanced Conflict Handling](./pro/README.md)** for PRO version.
|
||||||
|
- Source Available. See [License](./LICENSE) for details.
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
||||||
- **To support deletions sync, extra metadata will also be uploaded.** See [Minimal Intrusive](./docs/minimal_intrusive_design.md).
|
|
||||||
- **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
|
|
||||||
- **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
|
- **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
|
||||||
- **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
|
- **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.
|
- **You should protect your `data.json` file.** The file contains sensitive information.
|
||||||
@@ -63,15 +63,21 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
|||||||
|
|
||||||
- Tutorials / Examples:
|
- Tutorials / Examples:
|
||||||
- [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/README.md)
|
- [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/README.md)
|
||||||
|
- [BackBlaze B2](./docs/remote_services/s3_backblaze_b2/README.md)
|
||||||
|
- [Storj](./docs/remote_services/s3_storj_io/README.md)
|
||||||
|
- [腾讯云 COS](./docs/remote_services/s3_tencent_cloud_cos/README.zh-cn.md) | [Tencent Cloud COS](./docs/remote_services/s3_tencent_cloud_cos/README.md)
|
||||||
- [MinIO](./docs/remote_services/s3_minio/README.md)
|
- [MinIO](./docs/remote_services/s3_minio/README.md)
|
||||||
- Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
|
- [又拍云](./docs/remote_services/s3_upyun/README.zh-cn.md)
|
||||||
|
- Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name.
|
||||||
- If you are using AWS S3, create [policy and user](./docs/remote_services/s3_general/s3_user_policy.md).
|
- If you are using AWS S3, create [policy and user](./docs/remote_services/s3_general/s3_user_policy.md).
|
||||||
- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md).
|
- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md).
|
||||||
- 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 do not set the prefix in the settings, the bucket should be empty and solely for syncing a vault. You can set the prefix in the settings so that the same bucket can store multiple vaults.
|
||||||
- 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.
|
||||||
- Click the new "circle arrow" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (Or, you could configure auto sync in the settings panel (See next chapter).) While syncing, the icon becomes "two half-circle arrows". Besides clicking the icon on the sidebar ribbon, you can also activate the corresponding command in the command palette.
|
- Click the new "circle arrow" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (Or, you could configure auto sync in the settings panel (See next chapter).) While syncing, the icon becomes "two half-circle arrows". Besides clicking the icon on the sidebar ribbon, you can also activate the corresponding command in the command palette.
|
||||||
- **Be patient while syncing.** Especially in the first-time sync.
|
- **Be patient while syncing.** Especially in the first-time sync.
|
||||||
|
- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
|
||||||
|
|
||||||
### Dropbox
|
### Dropbox
|
||||||
|
|
||||||
@@ -79,6 +85,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
|||||||
- 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. [More with screenshot is here](./docs/dropbox_review_material/README.md).
|
- 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**.
|
||||||
|
- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
|
||||||
|
|
||||||
### OneDrive for personal
|
### OneDrive for personal
|
||||||
|
|
||||||
@@ -87,16 +94,30 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
|||||||
- 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.
|
||||||
- If you decide to authorize this plugin to connect to OneDrive, please go to plugin's settings, and choose OneDrive then follow the instructions.
|
- If you decide to authorize this plugin to connect to OneDrive, please go to plugin's settings, and choose OneDrive then follow the instructions.
|
||||||
- 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**.
|
||||||
|
- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
|
||||||
|
- You might also want to checkout [faq for OneDrive](./docs/remote_services/onedrive/README.md).
|
||||||
|
|
||||||
### webdav
|
### webdav
|
||||||
|
|
||||||
- Tutorials / Examples:
|
- Tutorials / Examples:
|
||||||
|
- [Nextcloud](./docs/remote_services/webdav_nextcloud/README.md)
|
||||||
|
- [The Good Cloud](./docs/remote_services/webdav_thegoodcloud/README.md)
|
||||||
- [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
|
- [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
|
||||||
- [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
|
- [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
|
||||||
- [坚果云 JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
|
- [Synology webdav server](./docs/remote_services/webdav_synology_webdav_server/README.md) | [群晖 webdav server](./docs/remote_services/webdav_synology_webdav_server/README.zh-cn.md)
|
||||||
|
- [AList(中文)](./docs/remote_services/webdav_alist/README.zh-cn.md) | [AList (English)](./docs/remote_services/webdav_alist/README.md)
|
||||||
|
- [坚果云](./docs/remote_services/webdav_jianguoyun/README.zh-cn.md) | [JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
|
||||||
- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md).
|
- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md).
|
||||||
- Your data would be synced to a `${vaultName}` sub folder on your webdav server.
|
- Your data would be synced to a `${vaultName}` sub folder on your webdav server.
|
||||||
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
||||||
|
- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
|
||||||
|
|
||||||
|
### Webdis
|
||||||
|
|
||||||
|
- Tutorials:
|
||||||
|
- [Webdis](./docs/remote_services/webdis/README.md)
|
||||||
|
- Mostly experimental.
|
||||||
|
- You have to setup and protect your web server by yourself.
|
||||||
|
|
||||||
## Scheduled Auto Sync
|
## Scheduled Auto Sync
|
||||||
|
|
||||||
@@ -110,6 +131,10 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
|||||||
|
|
||||||
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).
|
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).
|
||||||
|
|
||||||
|
## PRO Features
|
||||||
|
|
||||||
|
See [PRO](./pro/README.md) for more details.
|
||||||
|
|
||||||
## How To Debug
|
## How To Debug
|
||||||
|
|
||||||
See [here](./docs/how_to_debug/README.md) for more details.
|
See [here](./docs/how_to_debug/README.md) for more details.
|
||||||
|
|||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:07fd075d0f73c708d77fd97bb31d6f185f094031e8275e8fd582e3a0145f6be8
|
||||||
|
size 415757
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:4c5754df8b5d6878a7fa58992fc7e37ddcce1ecf578a0fc2ec751b6f7bab6f13
|
||||||
|
size 284700
|
||||||
+55
@@ -0,0 +1,55 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
|
||||||
|
"organizeImports": {
|
||||||
|
"enabled": true
|
||||||
|
},
|
||||||
|
"files": {
|
||||||
|
"ignore": ["main.js"]
|
||||||
|
},
|
||||||
|
"formatter": {
|
||||||
|
"enabled": true,
|
||||||
|
"formatWithErrors": false,
|
||||||
|
"ignore": [],
|
||||||
|
"attributePosition": "auto",
|
||||||
|
"indentStyle": "space",
|
||||||
|
"indentWidth": 2,
|
||||||
|
"lineEnding": "lf",
|
||||||
|
"lineWidth": 80
|
||||||
|
},
|
||||||
|
"javascript": {
|
||||||
|
"formatter": {
|
||||||
|
"arrowParentheses": "always",
|
||||||
|
"bracketSameLine": false,
|
||||||
|
"bracketSpacing": true,
|
||||||
|
"jsxQuoteStyle": "double",
|
||||||
|
"quoteProperties": "asNeeded",
|
||||||
|
"semicolons": "always",
|
||||||
|
"trailingComma": "es5"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"linter": {
|
||||||
|
"enabled": true,
|
||||||
|
"rules": {
|
||||||
|
"recommended": true,
|
||||||
|
"suspicious": {
|
||||||
|
"noExplicitAny": "off",
|
||||||
|
"noPrototypeBuiltins": "off",
|
||||||
|
"noControlCharactersInRegex": "off"
|
||||||
|
},
|
||||||
|
"style": {
|
||||||
|
"noUselessElse": "off",
|
||||||
|
"useNodejsImportProtocol": "off",
|
||||||
|
"noUnusedTemplateLiteral": "off",
|
||||||
|
"useTemplate": "off",
|
||||||
|
"noNonNullAssertion": "off"
|
||||||
|
},
|
||||||
|
"performance": {
|
||||||
|
"noDelete": "off"
|
||||||
|
},
|
||||||
|
"complexity": {
|
||||||
|
"noForEach": "off",
|
||||||
|
"useLiteralKeys": "off"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
// Importing the http module
|
|
||||||
const http = require("http");
|
|
||||||
|
|
||||||
const requestHandler = (req, res) => {
|
|
||||||
let body = [];
|
|
||||||
req
|
|
||||||
.on("data", (chunk) => {
|
|
||||||
body.push(chunk);
|
|
||||||
})
|
|
||||||
.on("end", () => {
|
|
||||||
const parsed = JSON.parse(Buffer.concat(body).toString());
|
|
||||||
const prettyParsed = JSON.stringify(parsed, null, 2);
|
|
||||||
console.log(prettyParsed);
|
|
||||||
res.setHeader("Content-Type", "application/json");
|
|
||||||
res.end(prettyParsed);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
const server = http.createServer(requestHandler);
|
|
||||||
|
|
||||||
const addr = "0.0.0.0";
|
|
||||||
const port = 3000;
|
|
||||||
server.listen(port, addr, undefined, () => {
|
|
||||||
console.log(`Server is Running on ${addr}:${port}`);
|
|
||||||
});
|
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# Encryption
|
||||||
|
|
||||||
|
Currently (March 2024), Remotely Save supports two end to end encryption format:
|
||||||
|
|
||||||
|
1. [RClone Crypt](./rclone.md) format, which is the recommend way now.
|
||||||
|
2. [OpenSSL enc](./openssl.md) format
|
||||||
|
|
||||||
|
Here is also the [comparation](./comparation.md).
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# Comparation Between Encryption Formats
|
||||||
|
|
||||||
|
## Warning
|
||||||
|
|
||||||
|
**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
|
||||||
|
|
||||||
|
If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
|
||||||
|
|
||||||
|
## The feature table
|
||||||
|
|
||||||
|
| | RClone Crypt | OpenSSL enc | comments |
|
||||||
|
| ------------------------ | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| key generation | scrypt with fixed salt | PBKDF2 with dynamic salt | scrypt is better than PBKDF2 from the algorithm aspect. But RClone uses fixed salt by default. Also the parameters might affect the result. |
|
||||||
|
| content encryption | XSalsa20Poly1305 on chunks | AES-256-CBC | XSalsa20Poly1305 is way better than AES-256-CBC. And encryption by chunks should require less resources. |
|
||||||
|
| file name encryption | EME on each segment of the path | AES-256-CBC on the whole path | RClone has the benefit as well as pitfall that the path structure is preserved. Maybe it's more of a design decision difference? No comment on EME and AES-256-CBC. |
|
||||||
|
| viewing decrypted result | RClone has command that can mount the encrypted vault as if the encryption is transparent. | No convenient way except writing some scripts we are aware of. | RClone is way more convenient. |
|
||||||
|
|
||||||
|
## Some notes
|
||||||
|
|
||||||
|
1. Anyway, security is a hard problem. The author of Remotely Save doesn't have sufficient knowledge to "judge" which one is the better format. **Use them at your own risk.**
|
||||||
|
2. Currently the RClone Crypt format is recommended by default in Remotely Save. Just because of the taste from the Remotely Save author, who likes RClone.
|
||||||
|
3. **Always use a long password.**
|
||||||
|
4. Both algorithms are selected deliberately to **be compatible with some well-known third-party tools** (instead of some home-made methods) and **have many tests to ensure the correctness**.
|
||||||
@@ -1,10 +1,22 @@
|
|||||||
# Encryption
|
# OpenSSL enc format
|
||||||
|
|
||||||
If a password is set, the files are encrypted before being sent to the cloud.
|
If a password is set, the files are encrypted before being sent to the cloud.
|
||||||
|
|
||||||
The encryption algorithm is delibrately designed to be aligned with openssl format.
|
## Warning
|
||||||
|
|
||||||
1. The encryption algorithm is implemented using web-crypto.
|
**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
|
||||||
|
|
||||||
|
If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
|
||||||
|
|
||||||
|
## Comparation between encryption formats
|
||||||
|
|
||||||
|
See the doc [Comparation](./comparation.md).
|
||||||
|
|
||||||
|
## Interoperability with official OpenSSL
|
||||||
|
|
||||||
|
This encryption algorithm is delibrately designed to be aligned with openssl format.
|
||||||
|
|
||||||
|
1. The encryption algorithm is implemented using web-crypto. Using AES-256-CBC.
|
||||||
2. The file content is encrypted using openssl format. Assuming a file named `sometext.txt`, a password `somepassword`, then the encryption is equivalent to the following command:
|
2. The file content is encrypted using openssl format. Assuming a file named `sometext.txt`, a password `somepassword`, then the encryption is equivalent to the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
# RClone Crypt format
|
||||||
|
|
||||||
|
The encryption is compatible with RClone Crypt with **base64** name encryption format.
|
||||||
|
|
||||||
|
It's developed based on another js project by the same author of Remotely Save: [`@fyears/rclone-crypt`](https://github.com/fyears/rclone-crypt), which is NOT an official library from RClone, and is NOT affiliated with RClone.
|
||||||
|
|
||||||
|
Reasonable tests are also ported from official RClone code, to ensure the compatibility and correctness of the encryption.
|
||||||
|
|
||||||
|
## Warning
|
||||||
|
|
||||||
|
**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
|
||||||
|
|
||||||
|
If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
|
||||||
|
|
||||||
|
## Comparation between encryption formats
|
||||||
|
|
||||||
|
See the doc [Comparation](./comparation.md).
|
||||||
|
|
||||||
|
## Interoperability with official RClone
|
||||||
|
|
||||||
|
Please pay attention that the plugin uses **base64** of encrypted file names, while official RClone by default uses **base32** file names. The intention is purely for potentially support longer file names.
|
||||||
|
|
||||||
|
You could set up the RClone profile by calling `rclone config`. You need to create two profiles, one for your original connection and the other for RClone Crypt.
|
||||||
|
|
||||||
|
Finally, a working config file should like this:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[webdav1]
|
||||||
|
type = webdav
|
||||||
|
url = https://example.com/sharefolder1/subfolder1 # the same as the web address in Remotely Save settings.
|
||||||
|
vendor = other
|
||||||
|
user = <some webdav username>
|
||||||
|
pass = <some webdav password, obfuscated>
|
||||||
|
|
||||||
|
[webdav1crypt]
|
||||||
|
type = crypt
|
||||||
|
remote = nas1test:vaultname # the same as your "Remote Base Directory" (usually the vault name) in Remotely Save settings
|
||||||
|
password = <some encryption password, obfuscated>
|
||||||
|
filename_encoding = base64 # don't forget this!!!
|
||||||
|
```
|
||||||
|
|
||||||
|
You can use the `mount` command to view and see the files in file explorer! On Windows, the command should like this (the remote vault is mounted to drive `X:`):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
rclone mount webdav1crypt: X: --network-mode
|
||||||
|
```
|
||||||
@@ -12,8 +12,8 @@ See [here](./export_sync_plans.md).
|
|||||||
|
|
||||||
See [here](./check_console_output.md).
|
See [here](./check_console_output.md).
|
||||||
|
|
||||||
## Advanced: Save Console Output Then Read Them Later
|
## Advanced: Use `Logstravaganza` to export logs
|
||||||
|
|
||||||
This method works for desktop and mobile devices (iOS, Android).
|
This method works for desktop and mobile devices (iOS, Android), especially useful for iOS.
|
||||||
|
|
||||||
See [here](./save_console_output_and_export.md).
|
See [here](./use_logstravaganza.md).
|
||||||
|
|||||||
@@ -1,25 +0,0 @@
|
|||||||
# 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".
|
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
# Use `Logstravaganza`
|
||||||
|
|
||||||
|
On iOS, it's quite hard to directly check the console logs.
|
||||||
|
|
||||||
|
Luckily, there is a third-party plugin: [`Logstravaganza`](https://obsidian.md/plugins?search=Logstravaganza#), by Carlo Zottmann, that can redirect the output to a note.
|
||||||
|
|
||||||
|
You can just:
|
||||||
|
|
||||||
|
1. Install it.
|
||||||
|
2. Enable it.
|
||||||
|
3. Do something, to trigger some console logs.
|
||||||
|
4. Checkout `LOGGING-NOTE (device name).md` in the root of your vault.
|
||||||
|
|
||||||
|
See more on its site: <https://github.com/czottmann/obsidian-logstravaganza>.
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
# How to receive `obsidian://` in Linux
|
||||||
|
|
||||||
|
## Background
|
||||||
|
|
||||||
|
For example, when we are authorizing OneDrive, we have to jump back to Obsidian automatically using `obsidian://`.
|
||||||
|
|
||||||
|
## Short Desc From Official Obsidian Doc
|
||||||
|
|
||||||
|
Official doc has some explanation:
|
||||||
|
|
||||||
|
<https://help.obsidian.md/Extending+Obsidian/Obsidian+URI#Register+Obsidian+URI>
|
||||||
|
|
||||||
|
# Long Desc
|
||||||
|
|
||||||
|
Assuming the username is `somebody`, and the `.AppImage` file is downloaded to `~/Desktop`.
|
||||||
|
|
||||||
|
1. Download and **extract** the app image file in terminal
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /home/somebody/Desktop
|
||||||
|
chmod +x Obsidian-x.y.z.AppImage
|
||||||
|
./Obsidian-x.y.z.AppImage --appimage-extract
|
||||||
|
|
||||||
|
# you should have the folder squashfs-root
|
||||||
|
# we want to rename it
|
||||||
|
mv squashfs-root Obsidian
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Create a `.desktop` file
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# copy and paste the follow MULTI LINE command
|
||||||
|
# you might need to input your password because it requires root privilege
|
||||||
|
# remember to adjust the path
|
||||||
|
cat > ~/Desktop/obsidian.desktop <<EOF
|
||||||
|
[Desktop Entry]
|
||||||
|
Name=Obsidian
|
||||||
|
Comment=obsidian
|
||||||
|
Exec=/home/somebody/Desktop/Obsidian/obsidian %u
|
||||||
|
Keywords=obsidian
|
||||||
|
StartupNotify=true
|
||||||
|
Terminal=false
|
||||||
|
Type=Application
|
||||||
|
Icon=/home/somebody/Desktop/Obsidian/obsidian.png
|
||||||
|
MimeType=x-scheme-handler/obsidian;
|
||||||
|
EOF
|
||||||
|
|
||||||
|
# yeah we can check out the output
|
||||||
|
cat ~/Desktop/obsidian.desktop
|
||||||
|
## [Desktop Entry]
|
||||||
|
## ...
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Right click the `obsidian.desktop` file on the Desktop, and click "Allow launching"
|
||||||
|
|
||||||
|
4. Double click the `obsidian.desktop` file.
|
||||||
@@ -1,8 +1,10 @@
|
|||||||
# Minimal Intrusive Design
|
# Minimal Intrusive Design
|
||||||
|
|
||||||
Before version 0.3.0, the plugin did not upload additional meta data to the remote.
|
~~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.
|
~~From version 0.3.0 ~ 0.3.40, the plugin just upload minimal extra necessary meta data to the remote.~~
|
||||||
|
|
||||||
|
From version 0.4.1 and above, the plugin doesn't need uploading meta data due to the sync algorithm upgrade.
|
||||||
|
|
||||||
## Benefits
|
## Benefits
|
||||||
|
|
||||||
@@ -12,10 +14,14 @@ For example, it's possbile for a uses to manually upload a file to s3, and next
|
|||||||
|
|
||||||
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.
|
||||||
|
|
||||||
## Necessarity Of Uploading Extra Metadata
|
## ~~Necessarity Of Uploading Extra Metadata from 0.3.0 ~ 0.3.40~~
|
||||||
|
|
||||||
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").~~
|
||||||
|
|
||||||
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.
|
~~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.~~
|
||||||
|
|
||||||
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.
|
~~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.~~
|
||||||
|
|
||||||
|
## No uploading extra metadata from 0.4.1
|
||||||
|
|
||||||
|
Some information, including previous successful sync status of each file, is kept locally.
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# OneDrive
|
||||||
|
|
||||||
|
- **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).
|
||||||
|
- After the authorization, the plugin can read your name and email, and read and write files in your OneDrive's `/Apps/remotely-save` folder.
|
||||||
|
- If you decide to authorize this plugin to connect to OneDrive, please go to plugin's settings, and choose OneDrive then follow the instructions.
|
||||||
|
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
||||||
|
- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
### How about OneDrive for Business?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### I cannot find `/Apps/remotely-save` folder
|
||||||
|
|
||||||
|
Mystically some users report that their OneDrive generate `/Application/Graph` instead of `/Apps/remotely-save`. See [#517](https://github.com/remotely-save/remotely-save/issues/517).
|
||||||
|
|
||||||
|
The solution is simple:
|
||||||
|
|
||||||
|
1. Backup your vault manually.
|
||||||
|
2. Go to onedrive website (<https://onedrive.live.com/>), and rename `/Application/Graph` to `/Application/remotely-save` (right click on the folder and you will see rename option)
|
||||||
|
3. Come back to Obsidian and try to sync!
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
# Backblaze B2
|
||||||
|
|
||||||
|
## Links
|
||||||
|
|
||||||
|
https://www.backblaze.com/cloud-storage
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
1. Create a Backblaze account [on this page](https://www.backblaze.com/cloud-storage). Credit card info _is not_ required. Backblaze B2 offers 10 GB of free storage.
|
||||||
|
|
||||||
|
2. Please be aware that, though B2 provides some free quota, **it may still cost you money if the usage of storage or api requests exceed a certain value!!!** Especially pay attention to the api requests!!!
|
||||||
|
|
||||||
|
3. Create a **bucket**, you can leave the default settings, or you can enable the encryption (which is different from what you can set in Remotely Save):
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
4. Copy `Endpoint`, eg. `s3.us-east-005.backblazeb2.com` — it'll be used later.
|
||||||
|
|
||||||
|
5. Copy `bucketname` near the 🪣 icon (the "bucket icon") — it'll be used later.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
6. Go to **Application Keys**:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
7. **Add a new key**:
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
8. Save `keyID` and `applicationKey` — they will be used later.
|
||||||
|
|
||||||
|
9. Go to Remotely Save settings in Obsidian and:
|
||||||
|
|
||||||
|
- Choose `S3 or compatibile` in **Remote Service**:
|
||||||
|
- Copy `Endpoint` from Backblaze (see 3. above) to `Endpoint` in Remotely Save
|
||||||
|
- From `endpoint` take `region` (eg. `us-east-005`) and paste it in `endpoint` in Remotely Save
|
||||||
|
- Copy `keyID` (see 7. above) to `Access Key ID` in Remotely Save
|
||||||
|
- Copy `applicationKey` (see 7. above) to `Secret Access Key` in Remotely Save
|
||||||
|
- Copy `bucketname` (see 4. above) to `Bucket Name` in Remotely Save
|
||||||
|

|
||||||
|
|
||||||
|
10. **Enable Bypass CORS**:
|
||||||
|

|
||||||
|
|
||||||
|
11. Click **Check** in _Check Connectivity_ to see if you can connect to B2 bucket:
|
||||||
|

|
||||||
|
|
||||||
|
12. Sync!
|
||||||
|
|
||||||
|

|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:fae18a84bb218461aca01c7de47ddadfd2b451d865ec889c098cd6918f6e8773
|
||||||
|
size 59679
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:9389f9c4462740371edb548f7e05191ede5277a5d470e3254c60fbcc4a75e552
|
||||||
|
size 4558
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:46f35968938ebf3bbafae64ee49a4927844fd0abf79e4190522be91776d9fed0
|
||||||
|
size 107623
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:7fb639c7b4e595516594ee9d07c864e7cd15b608a97c81386f4cf72d499d0e5f
|
||||||
|
size 80121
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:299bfca82b77de86f60d8f481b5f74069dc977dece19fa025ee629d1e6f783d4
|
||||||
|
size 6499
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:5985e918b521c91cc185f60c58cdd334ee76695b897a02e02eaa17c1bad71609
|
||||||
|
size 10214
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:5796791bcf89c99c1e1e844c0083739fd46b1a458dc274f3c3fa3f65b87b71b3
|
||||||
|
size 70728
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:3633379fcb12f1a5e0a4d1d68c193ddc7bf0be7edd92f2f6006351817035a94f
|
||||||
|
size 27164
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:9e130be182ae7d3270e5de3fec442ac5e81efd61822e844cd61ed24c7e485d39
|
||||||
|
size 16802
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:29a8971fea065fd86223850198640f4072ee3fda2112820829cda1348f122c59
|
||||||
|
size 11103
|
||||||
@@ -28,19 +28,12 @@ Using the principle of least privilege is crucial for security when allowing a t
|
|||||||
{
|
{
|
||||||
"Version": "2012-10-17",
|
"Version": "2012-10-17",
|
||||||
"Statement": [
|
"Statement": [
|
||||||
{
|
|
||||||
"Sid": "ObsidianBucket",
|
|
||||||
"Effect": "Allow",
|
|
||||||
"Action": [
|
|
||||||
"s3:HeadBucket"
|
|
||||||
],
|
|
||||||
"Resource": "arn:aws:s3:::my-bucket"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"Sid": "ObsidianObjects",
|
"Sid": "ObsidianObjects",
|
||||||
"Effect": "Allow",
|
"Effect": "Allow",
|
||||||
"Action": [
|
"Action": [
|
||||||
"s3:HeadObject",
|
"s3:HeadObject",
|
||||||
|
"s3:ListBucket",
|
||||||
"s3:PutObject",
|
"s3:PutObject",
|
||||||
"s3:CopyObject",
|
"s3:CopyObject",
|
||||||
"s3:UploadPart",
|
"s3:UploadPart",
|
||||||
@@ -56,7 +49,10 @@ Using the principle of least privilege is crucial for security when allowing a t
|
|||||||
"s3:DeleteObject",
|
"s3:DeleteObject",
|
||||||
"s3:DeleteObjects"
|
"s3:DeleteObjects"
|
||||||
],
|
],
|
||||||
"Resource": "arn:aws:s3:::my-bucket/*"
|
"Resource": [
|
||||||
|
"arn:aws:s3:::my-bucket",
|
||||||
|
"arn:aws:s3:::my-bucket/*"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# Storj
|
||||||
|
|
||||||
|
## Links
|
||||||
|
|
||||||
|
<https://www.storj.io/>
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
1. Register an account. Login.
|
||||||
|
2. Create a bucket.
|
||||||
|
3. Create S3 Credentials in Access Management. Allow all permissions for the bucket. Remember the access key and secret key and the end point. The end point is likely to be [`https://gateway.storjshare.io`](https://docs.storj.io/dcs/api/s3/s3-compatible-gateway).
|
||||||
|

|
||||||
|

|
||||||
|
4. Input your credentials into remotely-save settings. Region [should be `global`](https://docs.storj.io/dcs/api/s3/s3-compatibility).
|
||||||
|

|
||||||
|
5. Check connectivity.
|
||||||
|
6. Sync!
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:a3484f74f45fbdae6110de285edeff10c196c13160cb97f079da77843ae92e80
|
||||||
|
size 386188
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:42593d98e1b154f4174a932088e72c25db9a976b5613f4d6ae21df1445b4559c
|
||||||
|
size 278219
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:7843c31153054eb4762dbaf3027c1042b0d7cb4dd774bf584788cd7a97ba4044
|
||||||
|
size 571188
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# Tencent Cloud COS
|
||||||
|
|
||||||
|
English | [中文](./README.zh-cn.md)
|
||||||
|
|
||||||
|
## Link
|
||||||
|
|
||||||
|
- international <https://console.tencentcloud.com/cos>
|
||||||
|
|
||||||
|
## 步骤 Steps
|
||||||
|
|
||||||
|
The example shows the steps of China version. International version should be similar.
|
||||||
|
|
||||||
|
1. Create a bucket with **private read-write permissions** and recommendly enable server-side-encryption.
|
||||||
|
2. In bucket list page, enter the bucket overview page of the bucket you just created. You should see the bucket name (your texts with the number of your account id), region, and access address.
|
||||||
|

|
||||||
|
3. In CAM page, create api key, and note down the SecretID and SecretKey.
|
||||||
|

|
||||||
|
4. **Remove the bucket name from your access address to obtain your endpoint address! If your access address on the website is `https://<bucket-name-with-number>.cos.<region>.myqcloud.com`, then the endpoint address you are going to use is `https://cos.<region>.myqcloud.com`.**
|
||||||
|
5. In remotely-save settings page, enter your endpoint adress, SecretID, SecretKey,and bucket name.
|
||||||
|

|
||||||
|
6. Check Connectivity.
|
||||||
|

|
||||||
|
7. Sync!
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# 腾讯云 COS
|
||||||
|
|
||||||
|
[English](./README.md) | 中文
|
||||||
|
|
||||||
|
## 链接
|
||||||
|
|
||||||
|
- 中国区 <https://console.cloud.tencent.com/cos>
|
||||||
|
|
||||||
|
## 步骤
|
||||||
|
|
||||||
|
注意这里用中国区示例,国际区配置应该类似。
|
||||||
|
|
||||||
|
1. 在“存储桶列表”页,[“创建存储桶”](https://console.cloud.tencent.com/cos/bucket?action=create)。注意创建**私有读写**,建议打开服务端加密。
|
||||||
|
2. 在桶列表页,点击刚刚存储的桶,进入概览页。可以见到桶名称(一般来说是之前指定的英文加账号数字),地域,访问域名。记录下来。
|
||||||
|

|
||||||
|
3. 在[“访问管理页”](https://console.cloud.tencent.com/cam/capi) ,“API 密钥管理”,“创建密钥”,要记录 SecretID 和 SecretKey。
|
||||||
|

|
||||||
|
4. **把桶名称从访问域名移除,才是你即将输入的服务地址!假如你在腾讯云网站看到访问域名是 `https://<bucket-name-with-number>.cos.<region>.myqcloud.com`,那么“服务地址”是 `https://cos.<region>.myqcloud.com`.**
|
||||||
|
5. 在 remotely-save 设置,输入服务地址,SecretID,SecretKey,和 桶名称。
|
||||||
|

|
||||||
|
6. 检查连接。
|
||||||
|

|
||||||
|
7. 可以同步了!
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:08b47288686c8ef8c6426776f7df52411efe431966e8f7f2f9a3a8836ee4d6c6
|
||||||
|
size 323127
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:94c0ec5db7a75c54c36224f067659682e271aea2e61b1ee50d046cd493ba72ac
|
||||||
|
size 58410
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:f51f542756def80a77404e47f9793d1cd6917df5ab6e09d5a0ee1f7191855dc6
|
||||||
|
size 425021
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:55064233031b44066fb7b77e17ba1eb1d0ae8398235a343cc7e137b07aaf7a39
|
||||||
|
size 668954
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# 又拍云
|
||||||
|
|
||||||
|
## 链接
|
||||||
|
|
||||||
|
- 官网 <https://www.upyun.com/>
|
||||||
|
- 官网的 S3 文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/>
|
||||||
|
|
||||||
|
## 注意!!!!!
|
||||||
|
|
||||||
|
又拍云似乎(?)文件都是默认公开的,强烈建议注意隐私问题,强烈建议设置插件加密。
|
||||||
|
|
||||||
|
## 步骤
|
||||||
|
|
||||||
|
1. 注册,新建对象存储。
|
||||||
|
2. 参考官网文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/>,创建操作员然后创建 S3 访问凭证。
|
||||||
|
3. 在 Remotely Save 设置以下:
|
||||||
|
- 服务地址(Endpoint):`s3.api.upyun.com` **一定是这个域名**
|
||||||
|
- 区域(Region):`us-east-1`
|
||||||
|
- Acccess Key ID:您获取到的访问凭证的 AccessKey
|
||||||
|
- Secret Access Key:您获取到的访问凭证的 SecretAccessKey
|
||||||
|
- 存储桶(Bucket)的名字:您创建的“服务名”
|
||||||
|
- 是否生成文件夹 Object:不生成(默认) **一定要选择不生成**
|
||||||
|
4. 可以在插件设置里,加上密码。
|
||||||
|
5. 同步。
|
||||||
@@ -1,22 +1,23 @@
|
|||||||
# AList
|
# AList
|
||||||
|
|
||||||
## 链接 Links
|
English | [中文](./README.zh-cn.md)
|
||||||
|
|
||||||
|
## Links
|
||||||
|
|
||||||
- English official website: <https://alist.nn.ci/> and <https://alist.nn.ci/guide/webdav.html>
|
- English official website: <https://alist.nn.ci/> and <https://alist.nn.ci/guide/webdav.html>
|
||||||
- 中文官网:<https://alist.nn.ci/zh/> 和 <https://alist.nn.ci/zh/guide/webdav.html>
|
|
||||||
|
|
||||||
## 步骤 Steps
|
## Steps
|
||||||
|
|
||||||
1. 安装和使用 AList。获取账号名和密码。在网页上登录。Install and run AList. Get the account and password. Login using the web page.
|
1. Install and run AList. Get the account and password. Login using the web page.
|
||||||
2. 新建挂载,检查挂载路径。如图所示是 `/alisttest davpath`。Add new storage. Pay attention to the mount path. The screenshot shows the mount path as `/alisttest davpath`.
|
2. Add new storage. Pay attention to the mount path. The screenshot shows the mount path as `/alisttest davpath`.
|
||||||

|

|
||||||

|

|
||||||
3. 从而构建 webdav 网址如下,**http(s)://域名** + **端口** + **`/dav`** + **挂载路径**,其中挂载路径中假如有空格,换成 `%20`:Construct the webdav address as: **http(s)://domain** + **port** + **`/dav`** + **mount path**, and the space inside the mount path should be replaced with `%20`:
|
3. Construct the webdav address as: **http(s)://domain** + **port** + **`/dav`** + **mount path**, and the space inside the mount path should be replaced with `%20`:
|
||||||
```
|
```
|
||||||
http[s]://domain:port/dav/[mountpath url encoded]
|
http[s]://domain:port/dav/[mountpath url encoded]
|
||||||
http://127.0.0.1:5244/dav/alisttest%20davpath
|
http://127.0.0.1:5244/dav/alisttest%20davpath
|
||||||
```
|
```
|
||||||
4. 在 remotely-save 设置,输入**带域名端口`/dav`和挂载路径的网址**、账号、密码。In remotely-save setting page, select webdav type, then input the **full address with mount path**/account/password.
|
4. In remotely-save setting page, select webdav type, then input the **full address with mount path**/account/password.
|
||||||

|

|
||||||
5. 在 remotely-save 设置,检查连接。In remotely-save setting page, click "Check Connectivity".
|
5. In remotely-save setting page, click "Check Connectivity".
|
||||||
6. 同步文件!Sync!
|
6. Sync!
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# AList
|
||||||
|
|
||||||
|
[English](./README.md) | 中文
|
||||||
|
|
||||||
|
## 链接
|
||||||
|
|
||||||
|
- 中文官网:<https://alist.nn.ci/zh/> 和 <https://alist.nn.ci/zh/guide/webdav.html>
|
||||||
|
|
||||||
|
## 步骤
|
||||||
|
|
||||||
|
1. 安装和使用 AList。获取账号名和密码。在网页上登录。
|
||||||
|
2. 新建挂载,检查挂载路径。如图所示是 `/alisttest davpath`。
|
||||||
|

|
||||||
|

|
||||||
|
3. 从而构建 webdav 网址如下,**http(s)://域名** + **端口** + **`/dav`** + **挂载路径**,其中挂载路径中假如有空格,换成 `%20`:
|
||||||
|
```
|
||||||
|
http[s]://domain:port/dav/[mountpath url encoded]
|
||||||
|
http://127.0.0.1:5244/dav/alisttest%20davpath
|
||||||
|
```
|
||||||
|
4. 在 remotely-save 设置,输入**带域名端口`/dav`和挂载路径的网址**、账号、密码。
|
||||||
|

|
||||||
|
5. 在 remotely-save 设置,检查连接。
|
||||||
|
6. 同步文件!
|
||||||
@@ -1,22 +1,22 @@
|
|||||||
# 坚果云 JianGuoYun/NutStore
|
# JianGuoYun/NutStore
|
||||||
|
|
||||||
## 链接 Link
|
English | [中文](./README.zh-cn.md)
|
||||||
|
|
||||||
|
## Link
|
||||||
|
|
||||||
<https://www.jianguoyun.com/>
|
<https://www.jianguoyun.com/>
|
||||||
|
|
||||||
## 注意!!!Attentions!!!
|
## Attentions!!!
|
||||||
|
|
||||||
坚果云有限制 api 数量等设定。本插件会产生若干查询,如果文件较多很容易触发 api 上限,从而工作不正常。这不是插件 bug,也没有办法解决。
|
|
||||||
|
|
||||||
JianGuoYun/NutStore has api limits. The plugin may generate many queries, and it's possible to reach the api limits if there are many files, then do not work properly. It's not a bug and there's no way to fix this situation.
|
JianGuoYun/NutStore has api limits. The plugin may generate many queries, and it's possible to reach the api limits if there are many files, then do not work properly. It's not a bug and there's no way to fix this situation.
|
||||||
|
|
||||||
## 步骤 Steps
|
## Steps
|
||||||
|
|
||||||
1. **知悉坚果云有 api 限制,本插件可能因此工作不正常。Be aware that JianGuoYun/NutStore has api limits, and the plugin may not work properly because of this.**
|
1. **Be aware that JianGuoYun/NutStore has api limits, and the plugin may not work properly because of this.**
|
||||||
2. 注册账号,登录。Register an account.
|
2. Register an account.
|
||||||
3. 去“个人信息”->“安全”,“添加应用”,从而获取了 webDAV 账号(应该是 email)和 WebDAV 密码(一串特殊的字符,不等于网站密码)。Go to "settings"->"Security", click "Add Application", then obtain the WebDAV account (email), and WebDAV password (a string different from web site password).
|
3. Go to "settings"->"Security", click "Add Application", then obtain the WebDAV account (email), and WebDAV password (a string different from web site password).
|
||||||

|

|
||||||
4. 在 remotely-save 设置,输入网址、账号、密码、**“发送到服务器的 Depth Header”设置为“只支持 depth='1'”**。Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
|
4. Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
|
||||||

|

|
||||||
5. 在 remotely-save 设置,检查连接。In remotely-save setting page, click "Check Connectivity".
|
5. In remotely-save setting page, click "Check Connectivity".
|
||||||
6. 同步文件!Sync!
|
6. Sync!
|
||||||
|
|||||||
@@ -0,0 +1,22 @@
|
|||||||
|
# 坚果云
|
||||||
|
|
||||||
|
[English](./README.md) | 中文
|
||||||
|
|
||||||
|
## 链接
|
||||||
|
|
||||||
|
<https://www.jianguoyun.com/>
|
||||||
|
|
||||||
|
## 注意!!!
|
||||||
|
|
||||||
|
坚果云有限制 api 数量等设定。本插件会产生若干查询,如果文件较多很容易触发 api 上限,从而工作不正常。这不是插件 bug,也没有办法解决。
|
||||||
|
|
||||||
|
## 步骤
|
||||||
|
|
||||||
|
1. **知悉坚果云有 api 限制,本插件可能因此工作不正常。**
|
||||||
|
2. 注册账号,登录。
|
||||||
|
3. 去“个人信息”->“安全”,“添加应用”,从而获取了 webDAV 账号(应该是 email)和 WebDAV 密码(一串特殊的字符,不等于网站密码)。
|
||||||
|

|
||||||
|
4. 在 remotely-save 设置,输入网址、账号、密码、**“发送到服务器的 Depth Header”设置为“只支持 depth='1'”**。
|
||||||
|

|
||||||
|
5. 在 remotely-save 设置,检查连接。
|
||||||
|
6. 同步文件!
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# Nextcloud
|
||||||
|
|
||||||
|
## Link
|
||||||
|
|
||||||
|
<https://nextcloud.com/>
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
1. Install, or find a hosted version.
|
||||||
|
* The docker version <https://github.com/nextcloud/docker> for internal network, and [Caddy as reverse proxy](https://caddyserver.com/docs/quick-starts/reverse-proxy) (for https), are personally recommended.
|
||||||
|
* If you find installing Nextcloud by yourselves is difficult, you can find some "Nextcloud's trusted, certified providers" on [Nextcloud Sign up page](https://nextcloud.com/sign-up/); For example, [The Good Cloud](https://thegood.cloud/) there generously provides 2 GB free stoarage space.
|
||||||
|
* Remotely Save is tested to be working with the docker version and The Good Cloud.
|
||||||
|
2. Go to Nextcloud's settings. Find the webdav url (something like `https://cloud.example.com/remote.php/dav/files/USERNAME`). Use this (without tailing slash), and your account and your password, in Remotely Save.
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
# Synology Webdav Server
|
||||||
|
|
||||||
|
English | [中文](./README.zh-cn.md)
|
||||||
|
|
||||||
|
## Link
|
||||||
|
|
||||||
|
<https://kb.synology.com/en-global/DSM/tutorial/How_to_access_files_on_Synology_NAS_with_WebDAV>
|
||||||
|
|
||||||
|
## Attention
|
||||||
|
|
||||||
|
The tutorial author (the author of Remotely Save) is NOT an expert of NAS / Synology. Please read the doc carefully and change it to accommodate your needs by yourself.
|
||||||
|
|
||||||
|
**It's dangerous to expose your NAS into public Internet if you don't know how to set up firewalls and other protections.**
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
Synology DSM 7 is used in this tutorial.
|
||||||
|
|
||||||
|
1. Create a new shared folder if you don't have one. For this tutorial, a new shared folder `share2` is created. You should assing a proper user to read / write the shared folder.
|
||||||
|

|
||||||
|
|
||||||
|
2. Assuming you want to sync your vault into sub folder `哈哈哈/sub folder`, please create the sub folder(s) correspondingly inide the shared folder `share2`.
|
||||||
|
|
||||||
|
3. Install webdav server from package center.
|
||||||
|

|
||||||
|
|
||||||
|
4. Enter the webdav server settings.
|
||||||
|
|
||||||
|
5. If you know how to configure https certificates correctly, you are strongly recommend to enable https.
|
||||||
|
|
||||||
|
For the demonstration purpose, this tutorial enable http server for the later steps.
|
||||||
|
|
||||||
|
Also "Enable DavDepthInfinity", which could speed up the plugin runnings greatly.
|
||||||
|
|
||||||
|
"Apply".
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
6. In Remotely Save settings, you should input your address as:
|
||||||
|
|
||||||
|
`http(s)://<your synology ip or domain>:<port>/<shared folder>/<sub folders>`
|
||||||
|
|
||||||
|
For example, in the tutorial, the proper url should be:
|
||||||
|
|
||||||
|
`http://<ip>:5000/share2/哈哈哈/sub folder`
|
||||||
|
|
||||||
|
Username and password should be the user you configured before with read / write permissions to `share2`.
|
||||||
|
|
||||||
|
Depth header should be "supports depth="infinity"".
|
||||||
|
|
||||||
|
Check connectivity!
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
7. Sync!
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
# 群晖 Webdav Server
|
||||||
|
|
||||||
|
[English](./README.md) | 中文
|
||||||
|
|
||||||
|
## 链接
|
||||||
|
|
||||||
|
<https://kb.synology.cn/zh-cn/DSM/tutorial/How_to_access_files_on_Synology_NAS_with_WebDAV>
|
||||||
|
|
||||||
|
## 注意
|
||||||
|
|
||||||
|
教程作者(Remotely Save 作者)**不是** NAS、群晖专家。请仔细阅读文档,并自行改动以适应您自身需求。
|
||||||
|
|
||||||
|
**没有设置防火墙和其他保护措施的话,将 NAS 暴露到公网上非常危险。**
|
||||||
|
|
||||||
|
## 步骤
|
||||||
|
|
||||||
|
本教程有用到群晖 DSM 7。
|
||||||
|
|
||||||
|
1. 创建共享文件夹。本教程示例创建了 `share2`。你需要允许某个账号对此的读写权限。
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
2. 假设之后你想同步你的库到子文件夹,`哈哈哈/sub folder`,请先在共享文件夹 `share2` 底下创建好。
|
||||||
|
|
||||||
|
3. 从套件中心安装 webdav server 。
|
||||||
|

|
||||||
|
|
||||||
|
4. 进入 webdav server 设置。
|
||||||
|
|
||||||
|
5. 如果你知道如何正确配置 https 证书的话,强烈建议开启 https。
|
||||||
|
|
||||||
|
本教程简化示例,开启了 http。
|
||||||
|
|
||||||
|
也设置“Enable DavDepthInfinity”,这可以加速插件连接速度。
|
||||||
|
|
||||||
|
“Apply”。
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
6. 在 Remotely Save 设置页,你的地址应如下格式输入:
|
||||||
|
|
||||||
|
`http(s)://<your synology ip or domain>:<port>/<shared folder>/<sub folders>`
|
||||||
|
|
||||||
|
比如说,本教程里,正确的地址类似于:
|
||||||
|
|
||||||
|
`http://<ip>:5000/share2/哈哈哈/sub folder`
|
||||||
|
|
||||||
|
用户名和密码是你之前配置了允许读写 `share2` 的那个账号。
|
||||||
|
|
||||||
|
Depth 设置应为“supports depth="infinity"”。
|
||||||
|
|
||||||
|
检查连接!
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
7. 同步!
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:71e61c25db793c00d4406ea0f46745941e16e268a41b7328b03a183ab0706ec8
|
||||||
|
size 59700
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:0f0725099989b5496048c0e3cb284b4f6537d66866b4618c8e73ee758cb2b642
|
||||||
|
size 174986
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:7bc6d03a9deb0e8babd2ed102e7b85ee1062797abf1146ae71f80237a852ff10
|
||||||
|
size 522084
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:ba3781f24b5d65ee6915d496f7542c569116141cdced24ca505f4373d9efa9df
|
||||||
|
size 536163
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# The Good Cloud
|
||||||
|
|
||||||
|
## Link
|
||||||
|
|
||||||
|
<https://thegood.cloud/>
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
It's a hosted version of Nextcloud providing 2GB free spaces. See [NextCloud](../webdav_nextcloud/README.md) for more instructions.
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
# Webdis
|
||||||
|
|
||||||
|
## Links
|
||||||
|
|
||||||
|
- Webdis: <https://github.com/nicolasff/webdis>
|
||||||
|
- Redis®: <https://redis.io/>
|
||||||
|
|
||||||
|
## Explanation and Background
|
||||||
|
|
||||||
|
I like the Redis® software very much, and would like to experiment using it as a "file storage". It seems to be nature by using path as the key and the content as the value (Sort of..., see below).
|
||||||
|
|
||||||
|
However, Redis® works by using TCP connections, and browser js cannot establish raw TCP connections. We need a HTTP gateway, to provide the HTTP api. Wedis seems to be the most famous open source one.
|
||||||
|
|
||||||
|
And of course, this method should work for Redis® alternatives: Valkey, Redict, KeyDB, Dragonfly, Garnet, ...
|
||||||
|
|
||||||
|
## Disclaimer
|
||||||
|
|
||||||
|
This app is NOT an official Redis® Ltd / Redis® OSS / Webdis product. Redis is a registered trademark of Redis Ltd.
|
||||||
|
|
||||||
|
**Never expose your Redis® or Webdis to public without security protection!!!** You are response for protecting your server.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
1. Install Redis®.
|
||||||
|
2. Install Webdis.
|
||||||
|
3. In `webdis.json`, configure the ACL for using password and username, and / or ip filters. **Never expose your Redis® or Webdis to public without security protection!!!**.
|
||||||
|
4. Install and configure reverse proxy, firewall, https, etc. (You have to configure HTTPS correctly if you want to use it on iOS)
|
||||||
|
5. In Remotely Save settings, enter your server address, username, password, and adjust the "base dir". Check connection.
|
||||||
|
6. Sync!
|
||||||
|
7. Serveral keys and values will be generated in your Redis® database:
|
||||||
|
|
||||||
|
```
|
||||||
|
rs:fs:v1:${encodeURIComponent(vaultName+'/'+folderStructure+'/'+fileName)}:meta # you can HGETALL it
|
||||||
|
rs:fs:v1:${encodeURIComponent(vaultName+'/'+folderStructure+'/'+fileName)}:content # you can GET it
|
||||||
|
```
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# Sync Algorithm
|
||||||
|
|
||||||
|
- [v1](./v1/README.md)
|
||||||
|
- [v2](./v2/README.md)
|
||||||
|
- v3
|
||||||
|
- [intro doc for end users](./v3/intro.md)
|
||||||
|
- [design doc](./v3/design.md)
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# Sync Algorithm V3
|
||||||
|
|
||||||
|
- [intro doc for end users](./intro.md)
|
||||||
|
- [design doc](./design.md)
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
# Sync Algorithm V3
|
||||||
|
|
||||||
|
Drafted on 20240117.
|
||||||
|
|
||||||
|
An absolutely better sync algorithm. Better for tracking deletions and better for subbranching.
|
||||||
|
|
||||||
|
## Huge Thanks
|
||||||
|
|
||||||
|
Basically a combination of algorithm v2 + [synclone](https://github.com/Jwink3101/syncrclone/blob/master/docs/algorithm.md) + [rsinc](https://github.com/ConorWilliams/rsinc) + (some of rclone [bisync](https://rclone.org/bisync/)). All of the later three are released under MIT License so no worries about the licenses.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
Must have
|
||||||
|
|
||||||
|
1. true deletion detection
|
||||||
|
2. deletion protection (blocking) with a setting
|
||||||
|
3. transaction from the old algorithm
|
||||||
|
4. user warning show up, **new algorithm needs all clients to be updated!** (deliberately corrput the metadata file??)
|
||||||
|
5. filters
|
||||||
|
6. conflict warning
|
||||||
|
7. partial sync
|
||||||
|
|
||||||
|
Nice to have
|
||||||
|
|
||||||
|
1. true time and hash
|
||||||
|
2. conflict rename
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
We have _five_ input sources:
|
||||||
|
|
||||||
|
1. local all files
|
||||||
|
2. remote all files
|
||||||
|
3. _local previous succeeded sync history_
|
||||||
|
4. local deletions
|
||||||
|
5. remote deletions.
|
||||||
|
|
||||||
|
Init run, consuming remote deletions :
|
||||||
|
|
||||||
|
Change history data into _local previous succeeded sync history_.
|
||||||
|
|
||||||
|
Later runs, use the first, second, third sources **only**.
|
||||||
|
|
||||||
|
Bidirectional table is modified based on synclone and rsinc. Incremental push / pull only tables is further modified based on the bidirectional table. The number inside the table cell is the decision branch in the code.
|
||||||
|
|
||||||
|
Bidirectional:
|
||||||
|
|
||||||
|
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||||
|
| --------------- | ------------------ | ------------------------- | ------------------ | ------------------------- |
|
||||||
|
| local unchanged | (02/21) do nothing | (09) pull | (07) delete local | (??) conflict |
|
||||||
|
| local modified | (10) push | (16/17/18/19/20) conflict | (08) push | (??) conflict |
|
||||||
|
| local deleted | (04) delete remote | (05) pull | (01) clean history | (03) pull |
|
||||||
|
| local created | (??) conflict | (??) conflict | (06) push | (11/12/13/14/15) conflict |
|
||||||
|
|
||||||
|
Incremental push only:
|
||||||
|
|
||||||
|
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||||
|
| --------------- | ---------------------------- | ---------------------------- | ---------------------- | ---------------------------- |
|
||||||
|
| local unchanged | (02/21) do nothing | **(26) conflict push** | **(32) conflict push** | (??) conflict |
|
||||||
|
| local modified | (10) push | **(25) conflict push** | (08) push | (??) conflict |
|
||||||
|
| local deleted | **(29) conflict do nothing** | **(30) conflict do nothing** | (01) clean history | **(28) conflict do nothing** |
|
||||||
|
| local created | (??) conflict | (??) conflict | (06) push | **(23) conflict push** |
|
||||||
|
|
||||||
|
Incremental pull only:
|
||||||
|
|
||||||
|
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||||
|
| --------------- | ---------------------- | ---------------------- | ---------------------------- | ---------------------- |
|
||||||
|
| local unchanged | (02/21) do nothing | (09) pull | **(33) conflict do nothing** | (??) conflict |
|
||||||
|
| local modified | **(27) conflict pull** | **(24) conflict pull** | **(34) conflict do nothing** | (??) conflict |
|
||||||
|
| local deleted | **(35) conflict pull** | (05) pull | (01) clean history | (03) pull |
|
||||||
|
| local created | (??) conflict | (??) conflict | **(31) conflict do nothing** | **(22) conflict pull** |
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
# Introduction To Sync Algorithm V3
|
||||||
|
|
||||||
|
- [x] sync conflict: keep newer
|
||||||
|
- [x] sync conflict: keep larger
|
||||||
|
- [ ] sync conflict: keep both and rename
|
||||||
|
- [ ] sync conflict: show warning
|
||||||
|
- [x] deletion: true deletion status computation
|
||||||
|
- [x] meta data: no remote meta data any more
|
||||||
|
- [x] migration: old data auto transfer to new db (hopefully)
|
||||||
|
- [x] sync direction: incremental push only
|
||||||
|
- [x] sync direction: incremental pull only
|
||||||
|
- [x] sync protection: warning based on the threshold
|
||||||
|
- [ ] partial sync: better sync on save
|
||||||
|
- [x] encrpytion: new encryption method, see [this](../../encryption/)
|
||||||
+8
-1
@@ -1,5 +1,6 @@
|
|||||||
import dotenv from "dotenv/config";
|
import "dotenv/config";
|
||||||
import esbuild from "esbuild";
|
import esbuild from "esbuild";
|
||||||
|
import inlineWorkerPlugin from "esbuild-plugin-inline-worker";
|
||||||
import process from "process";
|
import process from "process";
|
||||||
// import builtins from 'builtin-modules'
|
// import builtins from 'builtin-modules'
|
||||||
|
|
||||||
@@ -16,6 +17,8 @@ const prod = process.argv[2] === "production";
|
|||||||
const DEFAULT_DROPBOX_APP_KEY = process.env.DROPBOX_APP_KEY || "";
|
const DEFAULT_DROPBOX_APP_KEY = process.env.DROPBOX_APP_KEY || "";
|
||||||
const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
|
const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
|
||||||
const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
|
const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
|
||||||
|
const DEFAULT_REMOTELYSAVE_WEBSITE = process.env.REMOTELYSAVE_WEBSITE || "";
|
||||||
|
const DEFAULT_REMOTELYSAVE_CLIENT_ID = process.env.REMOTELYSAVE_CLIENT_ID || "";
|
||||||
|
|
||||||
esbuild
|
esbuild
|
||||||
.context({
|
.context({
|
||||||
@@ -35,6 +38,7 @@ esbuild
|
|||||||
"net",
|
"net",
|
||||||
"http",
|
"http",
|
||||||
"https",
|
"https",
|
||||||
|
"vm",
|
||||||
// ...builtins
|
// ...builtins
|
||||||
],
|
],
|
||||||
inject: ["./esbuild.injecthelper.mjs"],
|
inject: ["./esbuild.injecthelper.mjs"],
|
||||||
@@ -50,10 +54,13 @@ 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}"`,
|
||||||
|
"process.env.DEFAULT_REMOTELYSAVE_WEBSITE": `"${DEFAULT_REMOTELYSAVE_WEBSITE}"`,
|
||||||
|
"process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID": `"${DEFAULT_REMOTELYSAVE_CLIENT_ID}"`,
|
||||||
global: "window",
|
global: "window",
|
||||||
"process.env.NODE_DEBUG": `undefined`, // ugly fix
|
"process.env.NODE_DEBUG": `undefined`, // ugly fix
|
||||||
"process.env.DEBUG": `undefined`, // ugly fix
|
"process.env.DEBUG": `undefined`, // ugly fix
|
||||||
},
|
},
|
||||||
|
plugins: [inlineWorkerPlugin()],
|
||||||
})
|
})
|
||||||
.then((context) => {
|
.then((context) => {
|
||||||
if (process.argv.includes("--watch")) {
|
if (process.argv.includes("--watch")) {
|
||||||
|
|||||||
@@ -1,2 +1,2 @@
|
|||||||
export let Buffer = require("buffer").Buffer;
|
export const Buffer = require("buffer").Buffer;
|
||||||
export let process = require("process/browser");
|
export const process = require("process/browser");
|
||||||
|
|||||||
+2
-2
@@ -1,11 +1,11 @@
|
|||||||
{
|
{
|
||||||
"id": "remotely-save",
|
"id": "remotely-save",
|
||||||
"name": "Remotely Save",
|
"name": "Remotely Save",
|
||||||
"version": "0.3.34",
|
"version": "0.5.2",
|
||||||
"minAppVersion": "0.13.21",
|
"minAppVersion": "0.13.21",
|
||||||
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
||||||
"author": "fyears",
|
"author": "fyears",
|
||||||
"authorUrl": "https://github.com/fyears",
|
"authorUrl": "https://github.com/fyears",
|
||||||
"isDesktopOnly": false,
|
"isDesktopOnly": false,
|
||||||
"fundingUrl": "https://github.com/remotely-save/donation"
|
"fundingUrl": "https://remotelysave.com"
|
||||||
}
|
}
|
||||||
|
|||||||
+2
-2
@@ -1,11 +1,11 @@
|
|||||||
{
|
{
|
||||||
"id": "remotely-save",
|
"id": "remotely-save",
|
||||||
"name": "Remotely Save",
|
"name": "Remotely Save",
|
||||||
"version": "0.3.34",
|
"version": "0.5.2",
|
||||||
"minAppVersion": "0.13.21",
|
"minAppVersion": "0.13.21",
|
||||||
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
||||||
"author": "fyears",
|
"author": "fyears",
|
||||||
"authorUrl": "https://github.com/fyears",
|
"authorUrl": "https://github.com/fyears",
|
||||||
"isDesktopOnly": false,
|
"isDesktopOnly": false,
|
||||||
"fundingUrl": "https://github.com/remotely-save/donation"
|
"fundingUrl": "https://remotelysave.com"
|
||||||
}
|
}
|
||||||
|
|||||||
+40
-36
@@ -1,85 +1,90 @@
|
|||||||
{
|
{
|
||||||
"name": "remotely-save",
|
"name": "remotely-save",
|
||||||
"version": "0.3.25",
|
"version": "0.5.2",
|
||||||
"description": "This is yet another sync plugin for Obsidian app.",
|
"description": "This is yet another sync plugin for Obsidian app.",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev2": "node esbuild.config.mjs --watch",
|
"dev2": "node esbuild.config.mjs --watch",
|
||||||
"build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
|
"build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
|
||||||
"build": "webpack --mode production",
|
"build": "webpack --mode production",
|
||||||
"dev": "webpack --mode development --watch",
|
"dev": "webpack --mode development --watch",
|
||||||
"format": "npx prettier --trailing-comma es5 --write .",
|
"format": "npx @biomejs/biome check --apply .",
|
||||||
"clean": "npx rimraf main.js",
|
"clean": "npx rimraf main.js",
|
||||||
"test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'"
|
"test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts' 'pro/tests/**/*.ts'"
|
||||||
},
|
},
|
||||||
"browser": {
|
"browser": {
|
||||||
"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/"
|
"url": "url/",
|
||||||
|
"fs": false,
|
||||||
|
"vm": false
|
||||||
},
|
},
|
||||||
"source": "main.ts",
|
"source": "main.ts",
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "",
|
"author": "",
|
||||||
"license": "Apache-2.0",
|
"license": "SEE LICENSE IN LICENSE",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
"@biomejs/biome": "1.7.3",
|
||||||
"@microsoft/microsoft-graph-types": "^2.40.0",
|
"@microsoft/microsoft-graph-types": "^2.40.0",
|
||||||
"@types/chai": "^4.3.11",
|
"@types/chai": "^4.3.14",
|
||||||
"@types/chai-as-promised": "^7.1.8",
|
"@types/chai-as-promised": "^7.1.8",
|
||||||
"@types/jsdom": "^21.1.6",
|
"@types/jsdom": "^21.1.6",
|
||||||
"@types/lodash": "^4.14.202",
|
"@types/lodash": "^4.17.0",
|
||||||
"@types/mime-types": "^2.1.4",
|
"@types/mime-types": "^2.1.4",
|
||||||
"@types/mocha": "^10.0.6",
|
"@types/mocha": "^10.0.6",
|
||||||
"@types/mustache": "^4.2.5",
|
"@types/mustache": "^4.2.5",
|
||||||
"@types/node": "^20.10.4",
|
"@types/node": "^20.12.7",
|
||||||
"@types/qrcode": "^1.5.5",
|
"@types/qrcode": "^1.5.5",
|
||||||
"builtin-modules": "^3.3.0",
|
"builtin-modules": "^3.3.0",
|
||||||
"chai": "^4.3.10",
|
|
||||||
"chai-as-promised": "^7.1.1",
|
|
||||||
"cross-env": "^7.0.3",
|
"cross-env": "^7.0.3",
|
||||||
"dotenv": "^16.3.1",
|
"dotenv": "^16.4.5",
|
||||||
"esbuild": "^0.19.9",
|
"esbuild": "^0.20.2",
|
||||||
"jsdom": "^23.0.1",
|
"esbuild-plugin-inline-worker": "^0.1.1",
|
||||||
"mocha": "^10.2.0",
|
"jsdom": "^24.0.0",
|
||||||
"npm-check-updates": "^16.14.12",
|
"mocha": "^10.4.0",
|
||||||
"obsidian": "^1.4.11",
|
"npm-check-updates": "^16.14.20",
|
||||||
"prettier": "^3.1.1",
|
"obsidian": "^1.5.7",
|
||||||
"ts-loader": "^9.5.1",
|
"ts-loader": "^9.5.1",
|
||||||
"ts-node": "^10.9.2",
|
"ts-node": "^10.9.2",
|
||||||
"tslib": "^2.6.2",
|
"tslib": "^2.6.2",
|
||||||
"typescript": "^5.3.3",
|
"typescript": "^5.4.5",
|
||||||
"webdav-server": "^2.6.2",
|
"webdav-server": "^2.6.2",
|
||||||
"webpack": "^5.89.0",
|
"webpack": "^5.91.0",
|
||||||
"webpack-cli": "^5.1.4"
|
"webpack-cli": "^5.1.4",
|
||||||
|
"worker-loader": "^3.0.8"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@aws-sdk/client-s3": "^3.474.0",
|
"@aws-sdk/client-s3": "^3.563.0",
|
||||||
"@aws-sdk/lib-storage": "^3.474.0",
|
"@aws-sdk/lib-storage": "^3.563.0",
|
||||||
"@aws-sdk/signature-v4-crt": "^3.474.0",
|
"@aws-sdk/signature-v4-crt": "^3.556.0",
|
||||||
"@aws-sdk/types": "^3.468.0",
|
"@aws-sdk/types": "^3.535.0",
|
||||||
"@azure/msal-node": "^2.6.0",
|
"@azure/msal-node": "^2.7.0",
|
||||||
|
"@fyears/rclone-crypt": "^0.0.7",
|
||||||
"@fyears/tsqueue": "^1.0.1",
|
"@fyears/tsqueue": "^1.0.1",
|
||||||
"@microsoft/microsoft-graph-client": "^3.0.7",
|
"@microsoft/microsoft-graph-client": "^3.0.7",
|
||||||
"@smithy/fetch-http-handler": "^2.3.1",
|
"@sanity/diff-match-patch": "^3.1.1",
|
||||||
"@smithy/protocol-http": "^3.0.11",
|
"@smithy/fetch-http-handler": "^2.5.0",
|
||||||
"@smithy/querystring-builder": "^2.0.15",
|
"@smithy/protocol-http": "^3.3.0",
|
||||||
"acorn": "^8.11.2",
|
"@smithy/querystring-builder": "^2.2.0",
|
||||||
|
"acorn": "^8.11.3",
|
||||||
"aggregate-error": "^5.0.0",
|
"aggregate-error": "^5.0.0",
|
||||||
"assert": "^2.1.0",
|
"assert": "^2.1.0",
|
||||||
"aws-crt": "^1.20.0",
|
"aws-crt": "^1.21.2",
|
||||||
"buffer": "^6.0.3",
|
"buffer": "^6.0.3",
|
||||||
"crypto-browserify": "^3.12.0",
|
"crypto-browserify": "^3.12.0",
|
||||||
"delay": "^6.0.0",
|
|
||||||
"dropbox": "^10.34.0",
|
"dropbox": "^10.34.0",
|
||||||
"emoji-regex": "^10.3.0",
|
"emoji-regex": "^10.3.0",
|
||||||
"http-status-codes": "^2.3.0",
|
"http-status-codes": "^2.3.0",
|
||||||
"localforage": "^1.10.0",
|
"localforage": "^1.10.0",
|
||||||
|
"localforage-getitems": "^1.4.2",
|
||||||
|
"localforage-removeitems": "^1.4.0",
|
||||||
"lodash": "^4.17.21",
|
"lodash": "^4.17.21",
|
||||||
"loglevel": "^1.8.1",
|
"lucide": "^0.376.1",
|
||||||
"lucide": "^0.298.0",
|
|
||||||
"mime-types": "^2.1.35",
|
"mime-types": "^2.1.35",
|
||||||
"mustache": "^4.2.0",
|
"mustache": "^4.2.0",
|
||||||
"nanoid": "^5.0.4",
|
"nanoid": "^5.0.7",
|
||||||
|
"node-diff3": "^3.1.2",
|
||||||
"p-queue": "^8.0.1",
|
"p-queue": "^8.0.1",
|
||||||
"path-browserify": "^1.0.1",
|
"path-browserify": "^1.0.1",
|
||||||
"process": "^0.11.10",
|
"process": "^0.11.10",
|
||||||
@@ -89,8 +94,7 @@
|
|||||||
"stream-browserify": "^3.0.0",
|
"stream-browserify": "^3.0.0",
|
||||||
"url": "^0.11.3",
|
"url": "^0.11.3",
|
||||||
"util": "^0.12.5",
|
"util": "^0.12.5",
|
||||||
"webdav": "^5.3.1",
|
"webdav": "^5.6.0",
|
||||||
"webdav-fs": "^4.0.1",
|
|
||||||
"xregexp": "^5.1.1"
|
"xregexp": "^5.1.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+104
@@ -0,0 +1,104 @@
|
|||||||
|
# PolyForm Strict License 1.0.0
|
||||||
|
|
||||||
|
<https://polyformproject.org/licenses/strict/1.0.0>
|
||||||
|
|
||||||
|
## Acceptance
|
||||||
|
|
||||||
|
In order to get any license under these terms, you must agree
|
||||||
|
to them as both strict obligations and conditions to all
|
||||||
|
your licenses.
|
||||||
|
|
||||||
|
## Copyright License
|
||||||
|
|
||||||
|
The licensor grants you a copyright license for the software
|
||||||
|
to do everything you might do with the software that would
|
||||||
|
otherwise infringe the licensor's copyright in it for any
|
||||||
|
permitted purpose, other than distributing the software or
|
||||||
|
making changes or new works based on the software.
|
||||||
|
|
||||||
|
## Patent License
|
||||||
|
|
||||||
|
The licensor grants you a patent license for the software that
|
||||||
|
covers patent claims the licensor can license, or becomes able
|
||||||
|
to license, that you would infringe by using the software.
|
||||||
|
|
||||||
|
## Noncommercial Purposes
|
||||||
|
|
||||||
|
Any noncommercial purpose is a permitted purpose.
|
||||||
|
|
||||||
|
## Personal Uses
|
||||||
|
|
||||||
|
Personal use for research, experiment, and testing for
|
||||||
|
the benefit of public knowledge, personal study, private
|
||||||
|
entertainment, hobby projects, amateur pursuits, or religious
|
||||||
|
observance, without any anticipated commercial application,
|
||||||
|
is use for a permitted purpose.
|
||||||
|
|
||||||
|
## Noncommercial Organizations
|
||||||
|
|
||||||
|
Use by any charitable organization, educational institution,
|
||||||
|
public research organization, public safety or health
|
||||||
|
organization, environmental protection organization,
|
||||||
|
or government institution is use for a permitted purpose
|
||||||
|
regardless of the source of funding or obligations resulting
|
||||||
|
from the funding.
|
||||||
|
|
||||||
|
## Fair Use
|
||||||
|
|
||||||
|
You may have "fair use" rights for the software under the
|
||||||
|
law. These terms do not limit them.
|
||||||
|
|
||||||
|
## No Other Rights
|
||||||
|
|
||||||
|
These terms do not allow you to sublicense or transfer any of
|
||||||
|
your licenses to anyone else, or prevent the licensor from
|
||||||
|
granting licenses to anyone else. These terms do not imply
|
||||||
|
any other licenses.
|
||||||
|
|
||||||
|
## Patent Defense
|
||||||
|
|
||||||
|
If you make any written claim that the software infringes or
|
||||||
|
contributes to infringement of any patent, your patent license
|
||||||
|
for the software granted under these terms ends immediately. If
|
||||||
|
your company makes such a claim, your patent license ends
|
||||||
|
immediately for work on behalf of your company.
|
||||||
|
|
||||||
|
## Violations
|
||||||
|
|
||||||
|
The first time you are notified in writing that you have
|
||||||
|
violated any of these terms, or done anything with the software
|
||||||
|
not covered by your licenses, your licenses can nonetheless
|
||||||
|
continue if you come into full compliance with these terms,
|
||||||
|
and take practical steps to correct past violations, within
|
||||||
|
32 days of receiving notice. Otherwise, all your licenses
|
||||||
|
end immediately.
|
||||||
|
|
||||||
|
## No Liability
|
||||||
|
|
||||||
|
***As far as the law allows, the software comes as is, without
|
||||||
|
any warranty or condition, and the licensor will not be liable
|
||||||
|
to you for any damages arising out of these terms or the use
|
||||||
|
or nature of the software, under any kind of legal claim.***
|
||||||
|
|
||||||
|
## Definitions
|
||||||
|
|
||||||
|
The **licensor** is the individual or entity offering these
|
||||||
|
terms, and the **software** is the software the licensor makes
|
||||||
|
available under these terms.
|
||||||
|
|
||||||
|
**You** refers to the individual or entity agreeing to these
|
||||||
|
terms.
|
||||||
|
|
||||||
|
**Your company** is any legal entity, sole proprietorship,
|
||||||
|
or other kind of organization that you work for, plus all
|
||||||
|
organizations that have control over, are under the control of,
|
||||||
|
or are under common control with that organization. **Control**
|
||||||
|
means ownership of substantially all the assets of an entity,
|
||||||
|
or the power to direct its management and policies by vote,
|
||||||
|
contract, or otherwise. Control can be direct or indirect.
|
||||||
|
|
||||||
|
**Your licenses** are all the licenses granted to you for the
|
||||||
|
software under these terms.
|
||||||
|
|
||||||
|
**Use** means anything you do with the software requiring one
|
||||||
|
of your licenses.
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# Pro Features
|
||||||
|
|
||||||
|
## What?
|
||||||
|
|
||||||
|
Remotely Save has some "pro features", which users have to pay for using them.
|
||||||
|
|
||||||
|
## Sign Up / Sign In
|
||||||
|
|
||||||
|
Please go to <https://remotelysave.com> to sign up and sign in an account firstly.
|
||||||
|
|
||||||
|
## Smart Conflict
|
||||||
|
|
||||||
|
Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the files.
|
||||||
|
|
||||||
|
PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
The codes or files or subfolders inside the current folder (`pro` in the repo), are released under "source available" license: "PolyForm Strict License 1.0.0".
|
||||||
|
|
||||||
|
Suggestions are welcome.
|
||||||
@@ -0,0 +1,302 @@
|
|||||||
|
import { nanoid } from "nanoid";
|
||||||
|
import { base64url } from "rfc4648";
|
||||||
|
import {
|
||||||
|
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
||||||
|
type RemotelySavePluginSettings,
|
||||||
|
} from "../../src/baseTypes";
|
||||||
|
import {
|
||||||
|
COMMAND_CALLBACK_PRO,
|
||||||
|
type FeatureInfo,
|
||||||
|
PRO_CLIENT_ID,
|
||||||
|
type PRO_FEATURE_TYPE,
|
||||||
|
PRO_WEBSITE,
|
||||||
|
type ProConfig,
|
||||||
|
} from "./baseTypesPro";
|
||||||
|
|
||||||
|
const site = PRO_WEBSITE;
|
||||||
|
console.debug(`remotelysave official website: ${site}`);
|
||||||
|
|
||||||
|
export const DEFAULT_PRO_CONFIG: ProConfig = {
|
||||||
|
accessToken: "",
|
||||||
|
accessTokenExpiresInMs: 0,
|
||||||
|
accessTokenExpiresAtTimeMs: 0,
|
||||||
|
refreshToken: "",
|
||||||
|
enabledProFeatures: [],
|
||||||
|
email: "",
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* https://datatracker.ietf.org/doc/html/rfc7636
|
||||||
|
* dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
|
||||||
|
* => E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM
|
||||||
|
* @param x
|
||||||
|
* @returns BASE64URL-ENCODE(SHA256(ASCII(code_verifier)))
|
||||||
|
*/
|
||||||
|
async function codeVerifier2CodeChallenge(x: string) {
|
||||||
|
if (x === undefined || x === "") {
|
||||||
|
return "";
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
return base64url.stringify(
|
||||||
|
new Uint8Array(
|
||||||
|
await crypto.subtle.digest("SHA-256", new TextEncoder().encode(x))
|
||||||
|
),
|
||||||
|
{
|
||||||
|
pad: false,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
} catch (e) {
|
||||||
|
return "";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const generateAuthUrlAndCodeVerifierChallenge = async (
|
||||||
|
hasCallback: boolean
|
||||||
|
) => {
|
||||||
|
const appKey = PRO_CLIENT_ID ?? "cli-"; // hard-code
|
||||||
|
const codeVerifier = nanoid(128);
|
||||||
|
const codeChallenge = await codeVerifier2CodeChallenge(codeVerifier);
|
||||||
|
let authUrl = `${site}/oauth2/authorize?response_type=code&client_id=${appKey}&token_access_type=offline&code_challenge_method=S256&code_challenge=${codeChallenge}&scope=pro.list.read`;
|
||||||
|
if (hasCallback) {
|
||||||
|
authUrl += `&redirect_uri=obsidian://${COMMAND_CALLBACK_PRO}`;
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
authUrl,
|
||||||
|
codeVerifier,
|
||||||
|
codeChallenge,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export const sendAuthReq = async (
|
||||||
|
verifier: string,
|
||||||
|
authCode: string,
|
||||||
|
errorCallBack: any
|
||||||
|
) => {
|
||||||
|
const appKey = PRO_CLIENT_ID ?? "cli-"; // hard-code
|
||||||
|
try {
|
||||||
|
const k = {
|
||||||
|
code: authCode,
|
||||||
|
grant_type: "authorization_code",
|
||||||
|
code_verifier: verifier,
|
||||||
|
client_id: appKey,
|
||||||
|
// redirect_uri: `obsidian://${COMMAND_CALLBACK_PRO}`,
|
||||||
|
scope: "pro.list.read",
|
||||||
|
};
|
||||||
|
// console.debug(k);
|
||||||
|
const resp1 = await fetch(`${site}/api/v1/oauth2/token`, {
|
||||||
|
method: "POST",
|
||||||
|
body: new URLSearchParams(k),
|
||||||
|
});
|
||||||
|
const resp2 = await resp1.json();
|
||||||
|
return resp2;
|
||||||
|
} catch (e) {
|
||||||
|
console.error(e);
|
||||||
|
if (errorCallBack !== undefined) {
|
||||||
|
await errorCallBack(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export const sendRefreshTokenReq = async (refreshToken: string) => {
|
||||||
|
const appKey = PRO_CLIENT_ID ?? "cli-"; // hard-code
|
||||||
|
try {
|
||||||
|
console.info("start auto getting refreshed Remotely Save access token.");
|
||||||
|
const resp1 = await fetch(`${site}/api/v1/oauth2/token`, {
|
||||||
|
method: "POST",
|
||||||
|
body: new URLSearchParams({
|
||||||
|
grant_type: "refresh_token",
|
||||||
|
refresh_token: refreshToken,
|
||||||
|
client_id: appKey,
|
||||||
|
scope: "pro.list.read",
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
const resp2: AuthResError | AuthResSucc = await resp1.json();
|
||||||
|
console.info("finish auto getting refreshed Remotely Save access token.");
|
||||||
|
return resp2;
|
||||||
|
} catch (e) {
|
||||||
|
console.error(e);
|
||||||
|
throw e;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
interface AuthResError {
|
||||||
|
error: "invalid_request";
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AuthResSucc {
|
||||||
|
error: undefined; // needed for typescript
|
||||||
|
refresh_token?: string;
|
||||||
|
access_token: string;
|
||||||
|
expires_in: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const setConfigBySuccessfullAuthInplace = async (
|
||||||
|
config: ProConfig,
|
||||||
|
authRes: AuthResError | AuthResSucc,
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||||
|
) => {
|
||||||
|
if (authRes.error !== undefined) {
|
||||||
|
throw Error(`you should not save the setting for ${authRes.error}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
config.accessToken = authRes.access_token;
|
||||||
|
config.accessTokenExpiresAtTimeMs =
|
||||||
|
Date.now() + authRes.expires_in * 1000 - 5 * 60 * 1000;
|
||||||
|
config.accessTokenExpiresInMs = authRes.expires_in * 1000;
|
||||||
|
config.refreshToken = authRes.refresh_token || config.refreshToken;
|
||||||
|
|
||||||
|
// manually set it expired after 80 days;
|
||||||
|
config.credentialsShouldBeDeletedAtTimeMs =
|
||||||
|
Date.now() + OAUTH2_FORCE_EXPIRE_MILLISECONDS;
|
||||||
|
|
||||||
|
await saveUpdatedConfigFunc?.();
|
||||||
|
|
||||||
|
console.info(
|
||||||
|
"finish updating local info of Remotely Save official website token"
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getAccessToken = async (
|
||||||
|
config: ProConfig,
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||||
|
) => {
|
||||||
|
const ts = Date.now();
|
||||||
|
if (
|
||||||
|
config.accessToken !== undefined &&
|
||||||
|
config.accessToken !== "" &&
|
||||||
|
config.accessTokenExpiresAtTimeMs > ts &&
|
||||||
|
(config.credentialsShouldBeDeletedAtTimeMs ?? ts + 1000 * 1000) > ts
|
||||||
|
) {
|
||||||
|
return config.accessToken;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.debug(
|
||||||
|
`currently, accessToken=${config.accessToken}, accessTokenExpiresAtTimeMs=${
|
||||||
|
config.accessTokenExpiresAtTimeMs
|
||||||
|
}, credentialsShouldBeDeletedAtTimeMs=${
|
||||||
|
config.credentialsShouldBeDeletedAtTimeMs
|
||||||
|
},comp1=${config.accessTokenExpiresAtTimeMs > ts}, comp2=${
|
||||||
|
(config.credentialsShouldBeDeletedAtTimeMs ?? ts + 1000 * 1000) > ts
|
||||||
|
}`
|
||||||
|
);
|
||||||
|
|
||||||
|
// try to get it again??
|
||||||
|
const res = await sendRefreshTokenReq(config.refreshToken ?? "refresh-");
|
||||||
|
await setConfigBySuccessfullAuthInplace(config, res, saveUpdatedConfigFunc);
|
||||||
|
|
||||||
|
if (res.error !== undefined) {
|
||||||
|
throw Error("cannot update accessToken");
|
||||||
|
}
|
||||||
|
return res.access_token;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getAndSaveProFeatures = async (
|
||||||
|
config: ProConfig,
|
||||||
|
pluginVersion: string,
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||||
|
) => {
|
||||||
|
const access = await getAccessToken(config, saveUpdatedConfigFunc);
|
||||||
|
|
||||||
|
const resp1 = await fetch(`${site}/api/v1/pro/list`, {
|
||||||
|
method: "GET",
|
||||||
|
headers: {
|
||||||
|
Authorization: `Bearer ${access}`,
|
||||||
|
"REMOTELYSAVE-API-Plugin-Ver": pluginVersion,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const rsp2: {
|
||||||
|
proFeatures: FeatureInfo[];
|
||||||
|
} = await resp1.json();
|
||||||
|
|
||||||
|
config.enabledProFeatures = rsp2.proFeatures;
|
||||||
|
await saveUpdatedConfigFunc?.();
|
||||||
|
return rsp2;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getAndSaveProEmail = async (
|
||||||
|
config: ProConfig,
|
||||||
|
pluginVersion: string,
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||||
|
) => {
|
||||||
|
const access = await getAccessToken(config, saveUpdatedConfigFunc);
|
||||||
|
|
||||||
|
const resp1 = await fetch(`${site}/api/v1/profile/list`, {
|
||||||
|
method: "GET",
|
||||||
|
headers: {
|
||||||
|
Authorization: `Bearer ${access}`,
|
||||||
|
"REMOTELYSAVE-API-Plugin-Ver": pluginVersion,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const rsp2: {
|
||||||
|
email: string;
|
||||||
|
} = await resp1.json();
|
||||||
|
|
||||||
|
config.email = rsp2.email;
|
||||||
|
await saveUpdatedConfigFunc?.();
|
||||||
|
return rsp2;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If the check doesn't pass, the function should throw the error
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
export const checkProRunnableAndFixInplace = async (
|
||||||
|
featuresToCheck: PRO_FEATURE_TYPE[],
|
||||||
|
config: RemotelySavePluginSettings,
|
||||||
|
pluginVersion: string,
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||||
|
): Promise<true> => {
|
||||||
|
// if no pro features are used, we are good to go, no checking
|
||||||
|
if (
|
||||||
|
featuresToCheck.contains("feature-smart_conflict") &&
|
||||||
|
config.conflictAction !== "smart_conflict"
|
||||||
|
) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// many checks if status is valid
|
||||||
|
|
||||||
|
// no account
|
||||||
|
if (config.pro === undefined || config.pro.refreshToken === undefined) {
|
||||||
|
throw Error(`you need to "connect" to your account to use PRO features`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// every features should have at most 40 days expiration dates
|
||||||
|
// and if the time has expired, we also check
|
||||||
|
const msIn40Days = 1000 * 60 * 60 * 24 * 40;
|
||||||
|
for (const f of config.pro.enabledProFeatures) {
|
||||||
|
const tooFarInTheFuture = f.expireAtTimeMs >= Date.now() + msIn40Days;
|
||||||
|
const alreadyExpired = f.expireAtTimeMs <= Date.now();
|
||||||
|
if (tooFarInTheFuture || alreadyExpired) {
|
||||||
|
console.info(
|
||||||
|
`the pro feature is too far in the future and has expired, check again.`
|
||||||
|
);
|
||||||
|
await getAndSaveProFeatures(
|
||||||
|
config.pro,
|
||||||
|
pluginVersion,
|
||||||
|
saveUpdatedConfigFunc
|
||||||
|
);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// check for the features
|
||||||
|
if (featuresToCheck.contains("feature-smart_conflict")) {
|
||||||
|
if (config.conflictAction === "smart_conflict") {
|
||||||
|
if (
|
||||||
|
config.pro.enabledProFeatures.filter(
|
||||||
|
(x) => x.featureName === "feature-smart_conflict"
|
||||||
|
).length === 1
|
||||||
|
) {
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
throw Error(
|
||||||
|
`You're trying to use "smart conflict" PRO feature but you haven't subscribe to it.`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
};
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
export const MERGABLE_SIZE = 1000 * 1000; // 1 MB
|
||||||
|
|
||||||
|
export const COMMAND_CALLBACK_PRO = "remotely-save-cb-pro";
|
||||||
|
export const PRO_CLIENT_ID = process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID;
|
||||||
|
export const PRO_WEBSITE = process.env.DEFAULT_REMOTELYSAVE_WEBSITE;
|
||||||
|
|
||||||
|
export type PRO_FEATURE_TYPE =
|
||||||
|
| "feature-smart_conflict"
|
||||||
|
| "feature-google_drive";
|
||||||
|
|
||||||
|
export interface FeatureInfo {
|
||||||
|
featureName: PRO_FEATURE_TYPE;
|
||||||
|
enableAtTimeMs: bigint;
|
||||||
|
expireAtTimeMs: bigint;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ProConfig {
|
||||||
|
email?: string;
|
||||||
|
refreshToken?: string;
|
||||||
|
accessToken: string;
|
||||||
|
accessTokenExpiresInMs: number;
|
||||||
|
accessTokenExpiresAtTimeMs: number;
|
||||||
|
enabledProFeatures: FeatureInfo[];
|
||||||
|
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||||
|
}
|
||||||
@@ -0,0 +1,257 @@
|
|||||||
|
import isEqual from "lodash/isEqual";
|
||||||
|
// import {
|
||||||
|
// makePatches,
|
||||||
|
// applyPatches,
|
||||||
|
// stringifyPatches,
|
||||||
|
// parsePatch,
|
||||||
|
// } from "@sanity/diff-match-patch";
|
||||||
|
import {
|
||||||
|
LCS,
|
||||||
|
diff3Merge,
|
||||||
|
diffComm,
|
||||||
|
diffPatch,
|
||||||
|
mergeDiff3,
|
||||||
|
mergeDigIn,
|
||||||
|
patch,
|
||||||
|
} from "node-diff3";
|
||||||
|
import type { Entity } from "../../src/baseTypes";
|
||||||
|
import { copyFile } from "../../src/copyLogic";
|
||||||
|
import type { FakeFs } from "../../src/fsAll";
|
||||||
|
import { MERGABLE_SIZE } from "./baseTypesPro";
|
||||||
|
|
||||||
|
export function isMergable(a: Entity, b?: Entity) {
|
||||||
|
if (b !== undefined && a.keyRaw !== b.keyRaw) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
!a.keyRaw.endsWith("/") &&
|
||||||
|
a.sizeRaw <= MERGABLE_SIZE &&
|
||||||
|
(a.keyRaw.endsWith(".md") || a.keyRaw.endsWith(".markdown"))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* slightly modify to adjust in markdown context
|
||||||
|
* @param a
|
||||||
|
* @param o
|
||||||
|
* @param b
|
||||||
|
*/
|
||||||
|
function mergeDigInModified(a: string, o: string, b: string) {
|
||||||
|
const { conflict, result } = mergeDigIn(a, o, b);
|
||||||
|
for (let index = 0; index < result.length; ++index) {
|
||||||
|
if (["<<<<<<<", "=======", ">>>>>>>"].contains(result[index])) {
|
||||||
|
result[index] = "`" + result[index] + "`";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
conflict,
|
||||||
|
result,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function getLCSText(a: string, b: string) {
|
||||||
|
const aa = a.split("\n");
|
||||||
|
const bb = b.split("\n");
|
||||||
|
let raw = LCS(aa, bb);
|
||||||
|
|
||||||
|
const k: string[] = [];
|
||||||
|
|
||||||
|
do {
|
||||||
|
k.unshift(aa[raw.buffer1index]);
|
||||||
|
|
||||||
|
raw = raw.chain as any;
|
||||||
|
} while (raw !== null && raw !== undefined && raw.buffer1index !== -1);
|
||||||
|
|
||||||
|
return k.join("\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* It's tricky. We find LCS then pretend it's the original text
|
||||||
|
* @param a
|
||||||
|
* @param b
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
function twoWayMerge(a: string, b: string): string {
|
||||||
|
// const c = getLCSText(a, b);
|
||||||
|
// const patches = makePatches(c, a);
|
||||||
|
// const [d] = applyPatches(patches, b);
|
||||||
|
const c = getLCSText(a, b);
|
||||||
|
const d = mergeDigInModified(a, c, b).result.join("\n");
|
||||||
|
return d;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Originally three way merge.
|
||||||
|
* @param a
|
||||||
|
* @param b
|
||||||
|
* @param orig
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
function threeWayMerge(a: string, b: string, orig: string) {
|
||||||
|
return mergeDigInModified(a, orig, b).result.join("\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function mergeFile(
|
||||||
|
key: string,
|
||||||
|
left: FakeFs,
|
||||||
|
right: FakeFs,
|
||||||
|
contentOrig: ArrayBuffer | null | undefined
|
||||||
|
) {
|
||||||
|
// console.debug(
|
||||||
|
// `mergeFile: key=${key}, left=${left.kind}, right=${right.kind}`
|
||||||
|
// );
|
||||||
|
if (key.endsWith("/")) {
|
||||||
|
throw Error(`should not call ${key} in mergeFile`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!key.endsWith(".md") && !key.endsWith(".markdown")) {
|
||||||
|
throw Error(`currently only support markdown files in mergeFile`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const [contentLeft, contentRight] = await Promise.all([
|
||||||
|
left.readFile(key),
|
||||||
|
right.readFile(key),
|
||||||
|
]);
|
||||||
|
|
||||||
|
let newArrayBuffer: ArrayBuffer | undefined = undefined;
|
||||||
|
const decoder = new TextDecoder("utf-8");
|
||||||
|
|
||||||
|
if (isEqual(contentLeft, contentRight)) {
|
||||||
|
// we are lucky enough
|
||||||
|
newArrayBuffer = contentLeft;
|
||||||
|
// TODO: save the write
|
||||||
|
} else {
|
||||||
|
if (contentOrig === null || contentOrig === undefined) {
|
||||||
|
const newText = twoWayMerge(
|
||||||
|
decoder.decode(contentLeft),
|
||||||
|
decoder.decode(contentRight)
|
||||||
|
);
|
||||||
|
// no need to worry about the offset here because the array is new and not sliced
|
||||||
|
newArrayBuffer = new TextEncoder().encode(newText).buffer;
|
||||||
|
} else {
|
||||||
|
const newText = threeWayMerge(
|
||||||
|
decoder.decode(contentLeft),
|
||||||
|
decoder.decode(contentRight),
|
||||||
|
decoder.decode(contentOrig)
|
||||||
|
);
|
||||||
|
newArrayBuffer = new TextEncoder().encode(newText).buffer;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const mtime = Date.now();
|
||||||
|
|
||||||
|
// left (local) must wait for the right
|
||||||
|
// because the mtime might be different after upload
|
||||||
|
// upload firstly
|
||||||
|
const rightEntity = await right.writeFile(key, newArrayBuffer, mtime, mtime);
|
||||||
|
// write local secondly
|
||||||
|
const leftEntity = await left.writeFile(
|
||||||
|
key,
|
||||||
|
newArrayBuffer,
|
||||||
|
rightEntity.mtimeCli ?? mtime,
|
||||||
|
rightEntity.mtimeCli ?? mtime
|
||||||
|
);
|
||||||
|
|
||||||
|
return {
|
||||||
|
entity: rightEntity,
|
||||||
|
content: newArrayBuffer,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getFileRename(key: string) {
|
||||||
|
if (
|
||||||
|
key === "" ||
|
||||||
|
key === "." ||
|
||||||
|
key === ".." ||
|
||||||
|
key === "/" ||
|
||||||
|
key.endsWith("/")
|
||||||
|
) {
|
||||||
|
throw Error(`we cannot rename key=${key}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const segsPath = key.split("/");
|
||||||
|
const name = segsPath[segsPath.length - 1];
|
||||||
|
const segsName = name.split(".");
|
||||||
|
|
||||||
|
if (segsName.length === 0) {
|
||||||
|
throw Error(`we cannot rename key=${key}`);
|
||||||
|
} else if (segsName.length === 1) {
|
||||||
|
// name = "kkk" without any dot
|
||||||
|
segsPath[segsPath.length - 1] = `${name}.dup`;
|
||||||
|
} else if (segsName.length === 2) {
|
||||||
|
if (segsName[0] === "") {
|
||||||
|
// name = ".kkkk" with leading dot
|
||||||
|
segsPath[segsPath.length - 1] = `${name}.dup`;
|
||||||
|
} else if (segsName[1] === "") {
|
||||||
|
// name = "kkkk." with tailing dot
|
||||||
|
segsPath[segsPath.length - 1] = `${segsName[0]}.dup`;
|
||||||
|
} else {
|
||||||
|
// name = "aaa.bbb" normally
|
||||||
|
segsPath[segsPath.length - 1] = `${segsName[0]}.dup.${segsName[1]}`;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// name = "[...].bbb.ccc"
|
||||||
|
const firstPart = segsName.slice(0, segsName.length - 1).join(".");
|
||||||
|
const thirdPart = segsName[segsName.length - 1];
|
||||||
|
segsPath[segsPath.length - 1] = `${firstPart}.dup.${thirdPart}`;
|
||||||
|
}
|
||||||
|
const res = segsPath.join("/");
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* local: x.md -> x.dup.md -> upload to remote
|
||||||
|
* remote: x.md -> download to local -> using original name x.md
|
||||||
|
*/
|
||||||
|
export async function duplicateFile(
|
||||||
|
key: string,
|
||||||
|
left: FakeFs,
|
||||||
|
right: FakeFs,
|
||||||
|
uploadCallback: (entity: Entity) => Promise<any>,
|
||||||
|
downloadCallback: (entity: Entity) => Promise<any>
|
||||||
|
) {
|
||||||
|
let key2 = getFileRename(key);
|
||||||
|
let usable = false;
|
||||||
|
do {
|
||||||
|
try {
|
||||||
|
const s = await left.stat(key2);
|
||||||
|
if (s === null || s === undefined) {
|
||||||
|
throw Error(`not exist $${key2}`);
|
||||||
|
}
|
||||||
|
console.debug(`key2=${key2} exists, cannot use for new file`);
|
||||||
|
key2 = getFileRename(key2);
|
||||||
|
console.debug(`key2=${key2} is prepared for next try`);
|
||||||
|
} catch (e) {
|
||||||
|
// not exists, exactly what we want
|
||||||
|
console.debug(`key2=${key2} doesn't exist, usable for new file`);
|
||||||
|
usable = true;
|
||||||
|
}
|
||||||
|
} while (!usable);
|
||||||
|
await left.rename(key, key2);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* x.dup.md -> upload to remote
|
||||||
|
*/
|
||||||
|
async function f1() {
|
||||||
|
const k = await copyFile(key2, left, right);
|
||||||
|
await uploadCallback(k.entity);
|
||||||
|
return k.entity;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* x.md -> download to local
|
||||||
|
*/
|
||||||
|
async function f2() {
|
||||||
|
const k = await copyFile(key, right, left);
|
||||||
|
await downloadCallback(k.entity);
|
||||||
|
return k.entity;
|
||||||
|
}
|
||||||
|
|
||||||
|
const [resUpload, resDownload] = await Promise.all([f1(), f2()]);
|
||||||
|
|
||||||
|
return {
|
||||||
|
upload: resUpload,
|
||||||
|
download: resDownload,
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
{
|
||||||
|
"settings_conflictaction_smart_conflict": "Smart Conflict (PRO) (beta)",
|
||||||
|
"settings_conflictaction_smart_conflict_desc": "<p><strong>!!It's a PRO feature! You need an online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p><p><ul><li>For small markdown files, the plugin tries to merge them with diff3 algorithm.</li><li>For large files or not-markdown files, the plugin saves both files by renaming them.</li></ul></p><p><strong>Please manually backup your vaule before using this feature!</strong></p>",
|
||||||
|
|
||||||
|
"protocol_pro_connecting": "Connectting",
|
||||||
|
"protocol_pro_connect_manualinput_succ": "You've connected",
|
||||||
|
"protocol_pro_connect_fail": "Something went wrong from response from Remotely Save official website. Maybe the network connection is not good. Maybe you rejected the auth?",
|
||||||
|
"protocol_pro_connect_succ_revoke": "You've connected as user {{email}}. If you want to disconnect, click this button.",
|
||||||
|
|
||||||
|
"modal_prorevokeauth": "Revoke auth by clicking here and follow the steps.",
|
||||||
|
"modal_prorevokeauth_clean": "Clean",
|
||||||
|
"modal_prorevokeauth_clean_desc": "Clean local auth record",
|
||||||
|
"modal_prorevokeauth_clean_button": "Clean",
|
||||||
|
"modal_prorevokeauth_clean_notice": "Local auth record is cleaned",
|
||||||
|
"modal_prorevokeauth_clean_fail": "Fail to clean local auth record.",
|
||||||
|
"modal_proauth_copybutton": "Click to copy the auth url",
|
||||||
|
"modal_proauth_copynotice": "The auth url is copied to the clipboard!",
|
||||||
|
"modal_proauth_maualinput": "The Code from the website",
|
||||||
|
"modal_proauth_maualinput_desc": "Please input the code here from the end of auth flow, and press confirm.",
|
||||||
|
"modal_proauth_maualinput_notice": "Trying to connect, wait...",
|
||||||
|
"modal_proauth_maualinput_conn_fail": "Failed to connect",
|
||||||
|
|
||||||
|
"settings_pro": "Account (for PRO features)",
|
||||||
|
"settings_pro_tutorial": "<p>Using <stong>basic</strong> features of Remotely Save is <strong>FREE</strong> and do <strong>NOT</strong> need an account.</p><p>However, you will <strong>need</strong> an online account and <strong>PAY</strong> for the <strong>PRO</strong> features such as smart conflict.</p><p>Firstly please click the button to sign up and sign in to the website: <a href=\"https://remotelysave.com\">https://remotelysave.com</a>. Notice: It's different from, and NOT affiliated with Obsidian account.</p><p>Secondly please \"connect\" your local device to your online account.",
|
||||||
|
"settings_pro_features": "Features",
|
||||||
|
"settings_pro_features_desc": "Here are features you've enabled:<br/>{{{features}}}",
|
||||||
|
"settings_pro_features_refresh_button": "Check again",
|
||||||
|
"settings_pro_features_refresh_fetch": "Fetching...",
|
||||||
|
"settings_pro_features_refresh_succ": "Refreshed!",
|
||||||
|
"settings_pro_revoke": "Disconnect",
|
||||||
|
"settings_pro_revoke_desc": "You've connected as user {{email}}. If you want to disconnect, click this button.",
|
||||||
|
"settings_pro_revoke_button": "Disconnect",
|
||||||
|
"settings_pro_intro": "Remotely Save Online Account",
|
||||||
|
"settings_pro_intro_desc": "Click the button to jump to the website to sign up or sign in.",
|
||||||
|
"settings_pro_intro_button": "Sign Up / Sign In",
|
||||||
|
"settings_pro_auth": "Connect",
|
||||||
|
"settings_pro_auth_desc": "After you sign up and sign in the account on the website, you need to connect your plugin here to the online account. Please click the button to connect.",
|
||||||
|
"settings_pro_auth_button": "Connect"
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import en from "./en.json";
|
||||||
|
import zh_cn from "./zh_cn.json";
|
||||||
|
import zh_tw from "./zh_tw.json";
|
||||||
|
|
||||||
|
export const LANGS = {
|
||||||
|
en: en,
|
||||||
|
zh_cn: zh_cn,
|
||||||
|
zh_tw: zh_tw,
|
||||||
|
};
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
{
|
||||||
|
"settings_conflictaction_smart_conflict": "智能处理冲突 (PRO) (beta)",
|
||||||
|
"settings_conflictaction_smart_conflict_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p><p><ul><li>小 markdown 文件,本插件尝试使用 diff3 算法合并它;</li><li>对于大文件或非 markdown 文件,本插件尝试改名字并均进行保存。</li></ul></p><p><strong>请注意先手动备份 vault 文件再用此功能!</strong></p>",
|
||||||
|
|
||||||
|
"protocol_pro_connecting": "正在连接",
|
||||||
|
"protocol_pro_connect_manualinput_succ": "连接成功",
|
||||||
|
"protocol_pro_connect_fail": "Remotely Save 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权?",
|
||||||
|
"protocol_pro_connect_succ_revoke": "您已连接上账号 {{email}}。如果要取消连接,请点击此按钮。",
|
||||||
|
|
||||||
|
"modal_prorevokeauth": "点击这里和按照步骤取消授权。",
|
||||||
|
"modal_prorevokeauth_clean": "清理",
|
||||||
|
"modal_prorevokeauth_clean_desc": "清理本地授权记录",
|
||||||
|
"modal_prorevokeauth_clean_button": "清理",
|
||||||
|
"modal_prorevokeauth_clean_notice": "清理本地授权记录完毕",
|
||||||
|
"modal_prorevokeauth_clean_fail": "清理本地授权记录粗错。",
|
||||||
|
"modal_proauth_copybutton": "点击从而复制授权网址",
|
||||||
|
"modal_proauth_copynotice": "授权网址已复制!",
|
||||||
|
"modal_proauth_maualinput": "网站的授权码",
|
||||||
|
"modal_proauth_maualinput_desc": "请输入授权流程最后一步的授权码,然后点击确认。",
|
||||||
|
"modal_proauth_maualinput_notice": "正在连接,请稍候......",
|
||||||
|
"modal_proauth_maualinput_conn_fail": "连接失败",
|
||||||
|
|
||||||
|
"settings_pro": "账号(PRO 付费功能)",
|
||||||
|
"settings_pro_tutorial": "<p>使用 Remotely Save 的<stong>基本</strong>功能是<strong>免费的</strong>,而且<strong>不</strong>需要注册对应账号。</p><p>但是,您<strong>需要</strong>注册账号和对<strong>PRO</strong>功能<strong>付费</strong>使用,如智能处理冲突功能。</p><p>第一步:点击按钮从而注册和登录网站:<a href=\"https://remotelysave.com\">https://remotelysave.com</a>。注意:这和 Obsidian 官方账号无关,是不同的账号。</p><p>第二部:点击“连接”按钮,从而连接本设备和在线账号。",
|
||||||
|
"settings_pro_features": "功能",
|
||||||
|
"settings_pro_features_desc": "您开通了以下功能:<br/>{{{features}}}",
|
||||||
|
"settings_pro_features_refresh_button": "再次检查",
|
||||||
|
"settings_pro_features_refresh_fetch": "正在获取数据......",
|
||||||
|
"settings_pro_features_refresh_succ": "已刷新!",
|
||||||
|
"settings_pro_revoke": "断开连接",
|
||||||
|
"settings_pro_revoke_desc": "您已连接上账号 {{email}}。如果要取消连接,请点击此按钮。",
|
||||||
|
"settings_pro_revoke_button": "断开连接",
|
||||||
|
"settings_pro_intro": "Remotely Save 账号",
|
||||||
|
"settings_pro_intro_desc": "点击此按钮,从而到网站上注册和登录。",
|
||||||
|
"settings_pro_intro_button": "注册或登录",
|
||||||
|
"settings_pro_auth": "连接",
|
||||||
|
"settings_pro_auth_desc": "在网站上注册和登录后,您需要“连接”本设备和在线账号。请点击按钮开始连接。",
|
||||||
|
"settings_pro_auth_button": "连接"
|
||||||
|
}
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
{
|
||||||
|
"settings_conflictaction_smart_conflict": "智慧處理衝突 (PRO) (beta)",
|
||||||
|
"settings_conflictaction_smart_conflict_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p><p><ul><li>小 markdown 檔案,本外掛嘗試使用 diff3 演算法合併它;</li><li>對於大檔案或非 markdown 檔案,本外掛嘗試改名字並均進行儲存。</li></ul></p><p><strong>請注意先手動備份 vault 檔案再用此功能!</strong></p>",
|
||||||
|
|
||||||
|
"protocol_pro_connecting": "正在連線",
|
||||||
|
"protocol_pro_connect_manualinput_succ": "連線成功",
|
||||||
|
"protocol_pro_connect_fail": "Remotely Save 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權?",
|
||||||
|
"protocol_pro_connect_succ_revoke": "您已連線上賬號 {{email}}。如果要取消連線,請點選此按鈕。",
|
||||||
|
|
||||||
|
"modal_prorevokeauth": "點選這裡和按照步驟取消授權。",
|
||||||
|
"modal_prorevokeauth_clean": "清理",
|
||||||
|
"modal_prorevokeauth_clean_desc": "清理本地授權記錄",
|
||||||
|
"modal_prorevokeauth_clean_button": "清理",
|
||||||
|
"modal_prorevokeauth_clean_notice": "清理本地授權記錄完畢",
|
||||||
|
"modal_prorevokeauth_clean_fail": "清理本地授權記錄粗錯。",
|
||||||
|
"modal_proauth_copybutton": "點選從而複製授權網址",
|
||||||
|
"modal_proauth_copynotice": "授權網址已複製!",
|
||||||
|
"modal_proauth_maualinput": "網站的授權碼",
|
||||||
|
"modal_proauth_maualinput_desc": "請輸入授權流程最後一步的授權碼,然後點選確認。",
|
||||||
|
"modal_proauth_maualinput_notice": "正在連線,請稍候......",
|
||||||
|
"modal_proauth_maualinput_conn_fail": "連線失敗",
|
||||||
|
|
||||||
|
"settings_pro": "賬號(PRO 付費功能)",
|
||||||
|
"settings_pro_tutorial": "<p>使用 Remotely Save 的<stong>基本</strong>功能是<strong>免費的</strong>,而且<strong>不</strong>需要註冊對應賬號。</p><p>但是,您<strong>需要</strong>註冊賬號和對<strong>PRO</strong>功能<strong>付費</strong>使用,如智慧處理衝突功能。</p><p>第一步:點選按鈕從而註冊和登入網站:<a href=\"https://remotelysave.com\">https://remotelysave.com</a>。注意:這和 Obsidian 官方賬號無關,是不同的賬號。</p><p>第二部:點選“連線”按鈕,從而連線本裝置和線上賬號。",
|
||||||
|
"settings_pro_features": "功能",
|
||||||
|
"settings_pro_features_desc": "您開通了以下功能:<br/>{{{features}}}",
|
||||||
|
"settings_pro_features_refresh_button": "再次檢查",
|
||||||
|
"settings_pro_features_refresh_fetch": "正在獲取資料......",
|
||||||
|
"settings_pro_features_refresh_succ": "已重新整理!",
|
||||||
|
"settings_pro_revoke": "斷開連線",
|
||||||
|
"settings_pro_revoke_desc": "您已連線上賬號 {{email}}。如果要取消連線,請點選此按鈕。",
|
||||||
|
"settings_pro_revoke_button": "斷開連線",
|
||||||
|
"settings_pro_intro": "Remotely Save 賬號",
|
||||||
|
"settings_pro_intro_desc": "點選此按鈕,從而到網站上註冊和登入。",
|
||||||
|
"settings_pro_intro_button": "註冊或登入",
|
||||||
|
"settings_pro_auth": "連線",
|
||||||
|
"settings_pro_auth_desc": "在網站上註冊和登入後,您需要“連線”本裝置和線上賬號。請點選按鈕開始連線。",
|
||||||
|
"settings_pro_auth_button": "連線"
|
||||||
|
}
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
import type { Entity } from "../../src/baseTypes";
|
||||||
|
import type { InternalDBs } from "../../src/localdb";
|
||||||
|
|
||||||
|
export const upsertFileContentHistoryByVaultAndProfile = async (
|
||||||
|
db: InternalDBs,
|
||||||
|
vaultRandomID: string,
|
||||||
|
profileID: string,
|
||||||
|
prevSync: Entity,
|
||||||
|
prevContent: ArrayBuffer
|
||||||
|
) => {
|
||||||
|
await db.fileContentHistoryTbl.setItem(
|
||||||
|
`${vaultRandomID}\t${profileID}\t${prevSync.key}`,
|
||||||
|
prevContent
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getFileContentHistoryByVaultAndProfile = async (
|
||||||
|
db: InternalDBs,
|
||||||
|
vaultRandomID: string,
|
||||||
|
profileID: string,
|
||||||
|
prevSync: Entity
|
||||||
|
) => {
|
||||||
|
return (await db.fileContentHistoryTbl.getItem(
|
||||||
|
`${vaultRandomID}\t${profileID}\t${prevSync.key}`
|
||||||
|
)) as ArrayBuffer | null | undefined;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const clearFileContentHistoryByVaultAndProfile = async (
|
||||||
|
db: InternalDBs,
|
||||||
|
vaultRandomID: string,
|
||||||
|
profileID: string,
|
||||||
|
key: string
|
||||||
|
) => {
|
||||||
|
await db.fileContentHistoryTbl.removeItem(
|
||||||
|
`${vaultRandomID}\t${profileID}\t${key}`
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const clearAllFileContentHistoryByVault = async (
|
||||||
|
db: InternalDBs,
|
||||||
|
vaultRandomID: string
|
||||||
|
) => {
|
||||||
|
const keys = (await db.fileContentHistoryTbl.keys()).filter((x) =>
|
||||||
|
x.startsWith(`${vaultRandomID}\t`)
|
||||||
|
);
|
||||||
|
await db.fileContentHistoryTbl.removeItems(keys);
|
||||||
|
};
|
||||||
@@ -0,0 +1,359 @@
|
|||||||
|
import cloneDeep from "lodash/cloneDeep";
|
||||||
|
import { type App, Modal, Notice, Setting } from "obsidian";
|
||||||
|
import { features } from "process";
|
||||||
|
import type { TransItemType } from "../../src/i18n";
|
||||||
|
import type RemotelySavePlugin from "../../src/main";
|
||||||
|
import { stringToFragment } from "../../src/misc";
|
||||||
|
import {
|
||||||
|
DEFAULT_PRO_CONFIG,
|
||||||
|
generateAuthUrlAndCodeVerifierChallenge,
|
||||||
|
getAndSaveProEmail,
|
||||||
|
getAndSaveProFeatures,
|
||||||
|
sendAuthReq,
|
||||||
|
setConfigBySuccessfullAuthInplace,
|
||||||
|
} from "./account";
|
||||||
|
import {
|
||||||
|
type FeatureInfo,
|
||||||
|
PRO_CLIENT_ID,
|
||||||
|
type ProConfig,
|
||||||
|
} from "./baseTypesPro";
|
||||||
|
|
||||||
|
export class ProAuthModal extends Modal {
|
||||||
|
readonly plugin: RemotelySavePlugin;
|
||||||
|
readonly authDiv: HTMLDivElement;
|
||||||
|
readonly revokeAuthDiv: HTMLDivElement;
|
||||||
|
readonly revokeAuthSetting: Setting;
|
||||||
|
readonly proFeaturesListSetting: Setting;
|
||||||
|
readonly t: (x: TransItemType, vars?: any) => string;
|
||||||
|
constructor(
|
||||||
|
app: App,
|
||||||
|
plugin: RemotelySavePlugin,
|
||||||
|
authDiv: HTMLDivElement,
|
||||||
|
revokeAuthDiv: HTMLDivElement,
|
||||||
|
revokeAuthSetting: Setting,
|
||||||
|
proFeaturesListSetting: Setting,
|
||||||
|
t: (x: TransItemType, vars?: any) => string
|
||||||
|
) {
|
||||||
|
super(app);
|
||||||
|
this.plugin = plugin;
|
||||||
|
this.authDiv = authDiv;
|
||||||
|
this.revokeAuthDiv = revokeAuthDiv;
|
||||||
|
this.revokeAuthSetting = revokeAuthSetting;
|
||||||
|
this.proFeaturesListSetting = proFeaturesListSetting;
|
||||||
|
this.t = t;
|
||||||
|
}
|
||||||
|
|
||||||
|
async onOpen() {
|
||||||
|
const { contentEl } = this;
|
||||||
|
|
||||||
|
const { authUrl, codeVerifier, codeChallenge } =
|
||||||
|
await generateAuthUrlAndCodeVerifierChallenge(false);
|
||||||
|
this.plugin.oauth2Info.verifier = codeVerifier;
|
||||||
|
|
||||||
|
const t = this.t;
|
||||||
|
|
||||||
|
const div2 = contentEl.createDiv();
|
||||||
|
div2.createEl(
|
||||||
|
"button",
|
||||||
|
{
|
||||||
|
text: t("modal_proauth_copybutton"),
|
||||||
|
},
|
||||||
|
(el) => {
|
||||||
|
el.onclick = async () => {
|
||||||
|
await navigator.clipboard.writeText(authUrl);
|
||||||
|
new Notice(t("modal_proauth_copynotice"));
|
||||||
|
};
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
contentEl.createEl("p").createEl("a", {
|
||||||
|
href: authUrl,
|
||||||
|
text: authUrl,
|
||||||
|
});
|
||||||
|
|
||||||
|
// manual paste
|
||||||
|
let authCode = "";
|
||||||
|
new Setting(contentEl)
|
||||||
|
.setName(t("modal_proauth_maualinput"))
|
||||||
|
.setDesc(t("modal_proauth_maualinput_desc"))
|
||||||
|
.addText((text) =>
|
||||||
|
text
|
||||||
|
.setPlaceholder("")
|
||||||
|
.setValue("")
|
||||||
|
.onChange((val) => {
|
||||||
|
authCode = val.trim();
|
||||||
|
})
|
||||||
|
)
|
||||||
|
.addButton(async (button) => {
|
||||||
|
button.setButtonText(t("submit"));
|
||||||
|
button.onClick(async () => {
|
||||||
|
new Notice(t("modal_proauth_maualinput_notice"));
|
||||||
|
try {
|
||||||
|
const authRes = await sendAuthReq(
|
||||||
|
codeVerifier ?? "verifier",
|
||||||
|
authCode,
|
||||||
|
async (e: any) => {
|
||||||
|
new Notice(t("protocol_pro_connect_fail"));
|
||||||
|
new Notice(`${e}`);
|
||||||
|
throw e;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
console.debug(authRes);
|
||||||
|
const self = this;
|
||||||
|
setConfigBySuccessfullAuthInplace(
|
||||||
|
this.plugin.settings.pro!,
|
||||||
|
authRes!,
|
||||||
|
() => self.plugin.saveSettings()
|
||||||
|
);
|
||||||
|
await getAndSaveProFeatures(
|
||||||
|
this.plugin.settings.pro!,
|
||||||
|
this.plugin.manifest.version,
|
||||||
|
() => self.plugin.saveSettings()
|
||||||
|
);
|
||||||
|
this.proFeaturesListSetting.setDesc(
|
||||||
|
stringToFragment(
|
||||||
|
t("settings_pro_features_desc", {
|
||||||
|
features: featureListToText(
|
||||||
|
this.plugin.settings.pro!.enabledProFeatures
|
||||||
|
),
|
||||||
|
})
|
||||||
|
)
|
||||||
|
);
|
||||||
|
await getAndSaveProEmail(
|
||||||
|
this.plugin.settings.pro!,
|
||||||
|
this.plugin.manifest.version,
|
||||||
|
() => self.plugin.saveSettings()
|
||||||
|
);
|
||||||
|
|
||||||
|
new Notice(
|
||||||
|
t("protocol_pro_connect_manualinput_succ", {
|
||||||
|
email: this.plugin.settings.pro!.email ?? "(no email)",
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
this.plugin.oauth2Info.verifier = ""; // reset it
|
||||||
|
this.plugin.oauth2Info.authDiv?.toggleClass(
|
||||||
|
"pro-auth-button-hide",
|
||||||
|
this.plugin.settings.pro?.refreshToken !== ""
|
||||||
|
);
|
||||||
|
this.plugin.oauth2Info.authDiv = undefined;
|
||||||
|
|
||||||
|
this.plugin.oauth2Info.revokeAuthSetting?.setDesc(
|
||||||
|
t("protocol_pro_connect_succ_revoke", {
|
||||||
|
email: this.plugin.settings.pro?.email,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
this.plugin.oauth2Info.revokeAuthSetting = undefined;
|
||||||
|
this.plugin.oauth2Info.revokeDiv?.toggleClass(
|
||||||
|
"pro-revoke-auth-button-hide",
|
||||||
|
this.plugin.settings.pro?.email === ""
|
||||||
|
);
|
||||||
|
this.plugin.oauth2Info.revokeDiv = undefined;
|
||||||
|
|
||||||
|
this.close();
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
new Notice(t("modal_proauth_maualinput_conn_fail"));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
onClose() {
|
||||||
|
const { contentEl } = this;
|
||||||
|
contentEl.empty();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ProRevokeAuthModal extends Modal {
|
||||||
|
readonly plugin: RemotelySavePlugin;
|
||||||
|
readonly authDiv: HTMLDivElement;
|
||||||
|
readonly revokeAuthDiv: HTMLDivElement;
|
||||||
|
readonly t: (x: TransItemType, vars?: any) => string;
|
||||||
|
constructor(
|
||||||
|
app: App,
|
||||||
|
plugin: RemotelySavePlugin,
|
||||||
|
authDiv: HTMLDivElement,
|
||||||
|
revokeAuthDiv: HTMLDivElement,
|
||||||
|
t: (x: TransItemType, vars?: any) => string
|
||||||
|
) {
|
||||||
|
super(app);
|
||||||
|
this.plugin = plugin;
|
||||||
|
this.authDiv = authDiv;
|
||||||
|
this.revokeAuthDiv = revokeAuthDiv;
|
||||||
|
this.t = t;
|
||||||
|
}
|
||||||
|
|
||||||
|
async onOpen() {
|
||||||
|
const { contentEl } = this;
|
||||||
|
const t = this.t;
|
||||||
|
|
||||||
|
contentEl.createEl("p", {
|
||||||
|
text: t("modal_prorevokeauth"),
|
||||||
|
});
|
||||||
|
|
||||||
|
new Setting(contentEl)
|
||||||
|
.setName(t("modal_prorevokeauth_clean"))
|
||||||
|
.setDesc(t("modal_prorevokeauth_clean_desc"))
|
||||||
|
.addButton(async (button) => {
|
||||||
|
button.setButtonText(t("modal_prorevokeauth_clean_button"));
|
||||||
|
button.onClick(async () => {
|
||||||
|
try {
|
||||||
|
this.plugin.settings.pro = cloneDeep(DEFAULT_PRO_CONFIG);
|
||||||
|
await this.plugin.saveSettings();
|
||||||
|
this.authDiv.toggleClass(
|
||||||
|
"pro-auth-button-hide",
|
||||||
|
this.plugin.settings.pro?.refreshToken !== ""
|
||||||
|
);
|
||||||
|
this.revokeAuthDiv.toggleClass(
|
||||||
|
"pro-revoke-auth-button-hide",
|
||||||
|
this.plugin.settings.pro?.refreshToken === ""
|
||||||
|
);
|
||||||
|
new Notice(t("modal_prorevokeauth_clean_notice"));
|
||||||
|
this.close();
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
new Notice(t("modal_prorevokeauth_clean_fail"));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
onClose() {
|
||||||
|
const { contentEl } = this;
|
||||||
|
contentEl.empty();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const featureListToText = (features: FeatureInfo[]) => {
|
||||||
|
// TODO: i18n
|
||||||
|
if (features === undefined || features.length === 0) {
|
||||||
|
return "No features enabled.";
|
||||||
|
}
|
||||||
|
return features
|
||||||
|
.map((x) => {
|
||||||
|
return `${x.featureName} (expire: ${new Date(
|
||||||
|
Number(x.expireAtTimeMs)
|
||||||
|
).toISOString()})`;
|
||||||
|
})
|
||||||
|
.join("<br/>");
|
||||||
|
};
|
||||||
|
|
||||||
|
export const generateProSettingsPart = (
|
||||||
|
proDiv: HTMLDivElement,
|
||||||
|
t: (x: TransItemType, vars?: any) => string,
|
||||||
|
app: App,
|
||||||
|
plugin: RemotelySavePlugin,
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||||
|
) => {
|
||||||
|
proDiv
|
||||||
|
.createEl("h2", { text: t("settings_pro") })
|
||||||
|
.setAttribute("id", "settings-pro");
|
||||||
|
|
||||||
|
proDiv.createEl("div", {
|
||||||
|
text: stringToFragment(t("settings_pro_tutorial")),
|
||||||
|
});
|
||||||
|
|
||||||
|
const proSelectAuthDiv = proDiv.createDiv();
|
||||||
|
const proAuthDiv = proSelectAuthDiv.createDiv({
|
||||||
|
cls: "pro-auth-button-hide settings-auth-related",
|
||||||
|
});
|
||||||
|
|
||||||
|
const proRevokeAuthDiv = proSelectAuthDiv.createDiv({
|
||||||
|
cls: "pro-revoke-auth-button-hide settings-auth-related",
|
||||||
|
});
|
||||||
|
|
||||||
|
const proFeaturesListSetting = new Setting(proRevokeAuthDiv)
|
||||||
|
.setName(t("settings_pro_features"))
|
||||||
|
.setDesc(
|
||||||
|
stringToFragment(
|
||||||
|
t("settings_pro_features_desc", {
|
||||||
|
features: featureListToText(plugin.settings.pro!.enabledProFeatures),
|
||||||
|
})
|
||||||
|
)
|
||||||
|
);
|
||||||
|
proFeaturesListSetting.addButton(async (button) => {
|
||||||
|
button.setButtonText(t("settings_pro_features_refresh_button"));
|
||||||
|
button.onClick(async () => {
|
||||||
|
new Notice(t("settings_pro_features_refresh_fetch"));
|
||||||
|
await getAndSaveProFeatures(
|
||||||
|
plugin.settings.pro!,
|
||||||
|
plugin.manifest.version,
|
||||||
|
saveUpdatedConfigFunc
|
||||||
|
);
|
||||||
|
proFeaturesListSetting.setDesc(
|
||||||
|
stringToFragment(
|
||||||
|
t("settings_pro_features_desc", {
|
||||||
|
features: featureListToText(
|
||||||
|
plugin.settings.pro!.enabledProFeatures
|
||||||
|
),
|
||||||
|
})
|
||||||
|
)
|
||||||
|
);
|
||||||
|
new Notice(t("settings_pro_features_refresh_succ"));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const proRevokeAuthSetting = new Setting(proRevokeAuthDiv)
|
||||||
|
.setName(t("settings_pro_revoke"))
|
||||||
|
.setDesc(
|
||||||
|
t("settings_pro_revoke_desc", {
|
||||||
|
email: plugin.settings.pro?.email,
|
||||||
|
})
|
||||||
|
)
|
||||||
|
.addButton(async (button) => {
|
||||||
|
button.setButtonText(t("settings_pro_revoke_button"));
|
||||||
|
button.onClick(async () => {
|
||||||
|
new ProRevokeAuthModal(
|
||||||
|
app,
|
||||||
|
plugin,
|
||||||
|
proAuthDiv,
|
||||||
|
proRevokeAuthDiv,
|
||||||
|
t
|
||||||
|
).open();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
new Setting(proAuthDiv)
|
||||||
|
.setName(t("settings_pro_intro"))
|
||||||
|
.setDesc(stringToFragment(t("settings_pro_intro_desc")))
|
||||||
|
.addButton(async (button) => {
|
||||||
|
button.setButtonText(t("settings_pro_intro_button"));
|
||||||
|
button.onClick(async () => {
|
||||||
|
window.open("https://remotelysave.com/user/signupin", "_self");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
new Setting(proAuthDiv)
|
||||||
|
.setName(t("settings_pro_auth"))
|
||||||
|
.setDesc(t("settings_pro_auth_desc"))
|
||||||
|
.addButton(async (button) => {
|
||||||
|
button.setButtonText(t("settings_pro_auth_button"));
|
||||||
|
button.onClick(async () => {
|
||||||
|
const modal = new ProAuthModal(
|
||||||
|
app,
|
||||||
|
plugin,
|
||||||
|
proAuthDiv,
|
||||||
|
proRevokeAuthDiv,
|
||||||
|
proRevokeAuthSetting,
|
||||||
|
proFeaturesListSetting,
|
||||||
|
t
|
||||||
|
);
|
||||||
|
plugin.oauth2Info.helperModal = modal;
|
||||||
|
plugin.oauth2Info.authDiv = proAuthDiv;
|
||||||
|
plugin.oauth2Info.revokeDiv = proRevokeAuthDiv;
|
||||||
|
plugin.oauth2Info.revokeAuthSetting = proRevokeAuthSetting;
|
||||||
|
|
||||||
|
modal.open();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
proAuthDiv.toggleClass(
|
||||||
|
"pro-auth-button-hide",
|
||||||
|
plugin.settings.pro?.refreshToken !== ""
|
||||||
|
);
|
||||||
|
proRevokeAuthDiv.toggleClass(
|
||||||
|
"pro-revoke-auth-button-hide",
|
||||||
|
plugin.settings.pro?.refreshToken === ""
|
||||||
|
);
|
||||||
|
};
|
||||||
@@ -0,0 +1,68 @@
|
|||||||
|
import { deepStrictEqual, rejects, throws } from "assert";
|
||||||
|
import { getFileRename } from "../src/conflictLogic";
|
||||||
|
|
||||||
|
describe("New name is generated", () => {
|
||||||
|
it("should throw for empty file", async () => {
|
||||||
|
for (const key of ["", "/", ".", ".."]) {
|
||||||
|
throws(() => getFileRename(key));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should throw for folder", async () => {
|
||||||
|
for (const key of ["sss/", "ssss/yyy/"]) {
|
||||||
|
throws(() => getFileRename(key));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should correctly get no ext files renamed", async () => {
|
||||||
|
deepStrictEqual(getFileRename("abc"), "abc.dup");
|
||||||
|
|
||||||
|
deepStrictEqual(getFileRename("xxxx/yyyy/abc"), "xxxx/yyyy/abc.dup");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should correctly get dot files renamed", async () => {
|
||||||
|
deepStrictEqual(getFileRename(".abc"), ".abc.dup");
|
||||||
|
|
||||||
|
deepStrictEqual(getFileRename("xxxx/yyyy/.efg"), "xxxx/yyyy/.efg.dup");
|
||||||
|
|
||||||
|
deepStrictEqual(getFileRename("xxxx/yyyy/hij."), "xxxx/yyyy/hij.dup");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should correctly get normal files renamed", async () => {
|
||||||
|
deepStrictEqual(getFileRename("abc.efg"), "abc.dup.efg");
|
||||||
|
|
||||||
|
deepStrictEqual(
|
||||||
|
getFileRename("xxxx/yyyy/abc.efg"),
|
||||||
|
"xxxx/yyyy/abc.dup.efg"
|
||||||
|
);
|
||||||
|
|
||||||
|
deepStrictEqual(
|
||||||
|
getFileRename("xxxx/yyyy/abc.tar.gz"),
|
||||||
|
"xxxx/yyyy/abc.tar.dup.gz"
|
||||||
|
);
|
||||||
|
|
||||||
|
deepStrictEqual(
|
||||||
|
getFileRename("xxxx/yyyy/.abc.efg"),
|
||||||
|
"xxxx/yyyy/.abc.dup.efg"
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should correctly get duplicated files renamed again", async () => {
|
||||||
|
deepStrictEqual(getFileRename("abc.dup"), "abc.dup.dup");
|
||||||
|
|
||||||
|
deepStrictEqual(
|
||||||
|
getFileRename("xxxx/yyyy/.abc.dup"),
|
||||||
|
"xxxx/yyyy/.abc.dup.dup"
|
||||||
|
);
|
||||||
|
|
||||||
|
deepStrictEqual(
|
||||||
|
getFileRename("xxxx/yyyy/abc.dup.md"),
|
||||||
|
"xxxx/yyyy/abc.dup.dup.md"
|
||||||
|
);
|
||||||
|
|
||||||
|
deepStrictEqual(
|
||||||
|
getFileRename("xxxx/yyyy/.abc.dup.md"),
|
||||||
|
"xxxx/yyyy/.abc.dup.dup.md"
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
+201
@@ -0,0 +1,201 @@
|
|||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# Main Basic Source
|
||||||
|
|
||||||
|
## What?
|
||||||
|
|
||||||
|
The main basic source code for Remotely Save.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
The codes or files or subfolders inside the current folder (`src` in the repo), are released under "open source" license: "Apache License, version 2.0".
|
||||||
+170
-51
@@ -3,17 +3,23 @@
|
|||||||
* To avoid circular dependency.
|
* To avoid circular dependency.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { Platform, requireApiVersion } from "obsidian";
|
import type { ProConfig } from "../pro/src/baseTypesPro";
|
||||||
import type { LangType, LangTypeAndAuto } from "./i18n";
|
import type { LangTypeAndAuto } from "./i18n";
|
||||||
|
|
||||||
export const DEFAULT_CONTENT_TYPE = "application/octet-stream";
|
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"
|
||||||
|
| "webdis";
|
||||||
|
|
||||||
export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR =
|
export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR =
|
||||||
| "webdav"
|
| "webdav"
|
||||||
| "dropbox"
|
| "dropbox"
|
||||||
| "onedrive";
|
| "onedrive"
|
||||||
|
| "webdis";
|
||||||
|
|
||||||
export interface S3Config {
|
export interface S3Config {
|
||||||
s3Endpoint: string;
|
s3Endpoint: string;
|
||||||
@@ -21,10 +27,20 @@ export interface S3Config {
|
|||||||
s3AccessKeyID: string;
|
s3AccessKeyID: string;
|
||||||
s3SecretAccessKey: string;
|
s3SecretAccessKey: string;
|
||||||
s3BucketName: string;
|
s3BucketName: string;
|
||||||
bypassCorsLocally?: boolean;
|
|
||||||
partsConcurrency?: number;
|
partsConcurrency?: number;
|
||||||
forcePathStyle?: boolean;
|
forcePathStyle?: boolean;
|
||||||
remotePrefix?: string;
|
remotePrefix?: string;
|
||||||
|
|
||||||
|
useAccurateMTime?: boolean;
|
||||||
|
reverseProxyNoSignUrl?: string;
|
||||||
|
|
||||||
|
generateFolderObject?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
|
bypassCorsLocally?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface DropboxConfig {
|
export interface DropboxConfig {
|
||||||
@@ -41,9 +57,10 @@ export interface DropboxConfig {
|
|||||||
|
|
||||||
export type WebdavAuthType = "digest" | "basic";
|
export type WebdavAuthType = "digest" | "basic";
|
||||||
export type WebdavDepthType =
|
export type WebdavDepthType =
|
||||||
| "auto_unknown"
|
| "auto" // deprecated on 20240116
|
||||||
| "auto_1"
|
| "auto_unknown" // deprecated on 20240116
|
||||||
| "auto_infinity"
|
| "auto_1" // deprecated on 20240116
|
||||||
|
| "auto_infinity" // deprecated on 20240116
|
||||||
| "manual_1"
|
| "manual_1"
|
||||||
| "manual_infinity";
|
| "manual_infinity";
|
||||||
|
|
||||||
@@ -52,9 +69,14 @@ export interface WebdavConfig {
|
|||||||
username: string;
|
username: string;
|
||||||
password: string;
|
password: string;
|
||||||
authType: WebdavAuthType;
|
authType: WebdavAuthType;
|
||||||
manualRecursive: boolean; // deprecated in 0.3.6, use depth
|
|
||||||
depth?: WebdavDepthType;
|
depth?: WebdavDepthType;
|
||||||
remoteBaseDir?: string;
|
remoteBaseDir?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
|
manualRecursive: boolean; // deprecated in 0.3.6, use depth
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface OnedriveConfig {
|
export interface OnedriveConfig {
|
||||||
@@ -68,6 +90,34 @@ export interface OnedriveConfig {
|
|||||||
username: string;
|
username: string;
|
||||||
credentialsShouldBeDeletedAtTime?: number;
|
credentialsShouldBeDeletedAtTime?: number;
|
||||||
remoteBaseDir?: string;
|
remoteBaseDir?: string;
|
||||||
|
emptyFile: "skip" | "error";
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface WebdisConfig {
|
||||||
|
address: string;
|
||||||
|
username?: string;
|
||||||
|
password?: string;
|
||||||
|
remoteBaseDir?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type SyncDirectionType =
|
||||||
|
| "bidirectional"
|
||||||
|
| "incremental_pull_only"
|
||||||
|
| "incremental_push_only";
|
||||||
|
|
||||||
|
export type CipherMethodType = "rclone-base64" | "openssl-base64" | "unknown";
|
||||||
|
|
||||||
|
export type QRExportType =
|
||||||
|
| "basic_and_advanced"
|
||||||
|
| "s3"
|
||||||
|
| "dropbox"
|
||||||
|
| "onedrive"
|
||||||
|
| "webdav"
|
||||||
|
| "webdis";
|
||||||
|
|
||||||
|
export interface ProfilerConfig {
|
||||||
|
enablePrinting?: boolean;
|
||||||
|
recordSize?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface RemotelySavePluginSettings {
|
export interface RemotelySavePluginSettings {
|
||||||
@@ -75,35 +125,53 @@ export interface RemotelySavePluginSettings {
|
|||||||
webdav: WebdavConfig;
|
webdav: WebdavConfig;
|
||||||
dropbox: DropboxConfig;
|
dropbox: DropboxConfig;
|
||||||
onedrive: OnedriveConfig;
|
onedrive: OnedriveConfig;
|
||||||
|
webdis: WebdisConfig;
|
||||||
password: string;
|
password: string;
|
||||||
serviceType: SUPPORTED_SERVICES_TYPE;
|
serviceType: SUPPORTED_SERVICES_TYPE;
|
||||||
currLogLevel?: string;
|
currLogLevel?: string;
|
||||||
autoRunEveryMilliseconds?: number;
|
autoRunEveryMilliseconds?: number;
|
||||||
initRunAfterMilliseconds?: number;
|
initRunAfterMilliseconds?: number;
|
||||||
syncOnSaveAfterMilliseconds?: number;
|
syncOnSaveAfterMilliseconds?: number;
|
||||||
agreeToUploadExtraMetadata?: boolean;
|
|
||||||
concurrency?: number;
|
concurrency?: number;
|
||||||
syncConfigDir?: boolean;
|
syncConfigDir?: boolean;
|
||||||
syncUnderscoreItems?: boolean;
|
syncUnderscoreItems?: boolean;
|
||||||
lang?: LangTypeAndAuto;
|
lang?: LangTypeAndAuto;
|
||||||
logToDB?: boolean;
|
agreeToUseSyncV3?: boolean;
|
||||||
skipSizeLargerThan?: number;
|
skipSizeLargerThan?: number;
|
||||||
ignorePaths?: string[];
|
ignorePaths?: string[];
|
||||||
enableStatusBarInfo?: boolean;
|
enableStatusBarInfo?: boolean;
|
||||||
deleteToWhere?: "system" | "obsidian";
|
deleteToWhere?: "system" | "obsidian";
|
||||||
|
conflictAction?: ConflictActionType;
|
||||||
|
howToCleanEmptyFolder?: EmptyFolderCleanType;
|
||||||
|
|
||||||
|
protectModifyPercentage?: number;
|
||||||
|
syncDirection?: SyncDirectionType;
|
||||||
|
|
||||||
|
obfuscateSettingFile?: boolean;
|
||||||
|
|
||||||
|
enableMobileStatusBar?: boolean;
|
||||||
|
|
||||||
|
encryptionMethod?: CipherMethodType;
|
||||||
|
|
||||||
|
profiler?: ProfilerConfig;
|
||||||
|
|
||||||
|
pro?: ProConfig;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
|
agreeToUploadExtraMetadata?: boolean;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @deprecated
|
* @deprecated
|
||||||
*/
|
*/
|
||||||
vaultRandomID?: string;
|
vaultRandomID?: string;
|
||||||
}
|
|
||||||
|
|
||||||
export interface RemoteItem {
|
/**
|
||||||
key: string;
|
* @deprecated
|
||||||
lastModified: number;
|
*/
|
||||||
size: number;
|
logToDB?: boolean;
|
||||||
remoteType: SUPPORTED_SERVICES_TYPE;
|
|
||||||
etag?: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export const COMMAND_URI = "remotely-save";
|
export const COMMAND_URI = "remotely-save";
|
||||||
@@ -121,32 +189,89 @@ 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 =
|
export type EmptyFolderCleanType = "skip" | "clean_both";
|
||||||
| "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 DecisionTypeForFileSize =
|
export type ConflictActionType =
|
||||||
| "skipUploadingTooLarge"
|
| "keep_newer"
|
||||||
| "skipDownloadingTooLarge"
|
| "keep_larger"
|
||||||
| "skipUsingLocalDelTooLarge"
|
| "smart_conflict";
|
||||||
| "skipUsingRemoteDelTooLarge"
|
|
||||||
| "errorLocalTooLargeConflictRemote"
|
|
||||||
| "errorRemoteTooLargeConflictLocal";
|
|
||||||
|
|
||||||
type DecisionTypeForFolder =
|
export type DecisionTypeForMixedEntity =
|
||||||
| "createFolder"
|
| "only_history"
|
||||||
| "uploadLocalDelHistToRemoteFolder"
|
| "equal"
|
||||||
| "keepRemoteDelHistFolder"
|
| "local_is_modified_then_push"
|
||||||
| "skipFolder";
|
| "remote_is_modified_then_pull"
|
||||||
|
| "local_is_created_then_push"
|
||||||
|
| "remote_is_created_then_pull"
|
||||||
|
| "local_is_created_too_large_then_do_nothing"
|
||||||
|
| "remote_is_created_too_large_then_do_nothing"
|
||||||
|
| "local_is_deleted_thus_also_delete_remote"
|
||||||
|
| "remote_is_deleted_thus_also_delete_local"
|
||||||
|
| "conflict_created_then_keep_local"
|
||||||
|
| "conflict_created_then_keep_remote"
|
||||||
|
| "conflict_created_then_smart_conflict"
|
||||||
|
| "conflict_created_then_do_nothing"
|
||||||
|
| "conflict_modified_then_keep_local"
|
||||||
|
| "conflict_modified_then_keep_remote"
|
||||||
|
| "conflict_modified_then_smart_conflict"
|
||||||
|
| "folder_existed_both_then_do_nothing"
|
||||||
|
| "folder_existed_local_then_also_create_remote"
|
||||||
|
| "folder_existed_remote_then_also_create_local"
|
||||||
|
| "folder_to_be_created"
|
||||||
|
| "folder_to_skip"
|
||||||
|
| "folder_to_be_deleted_on_both"
|
||||||
|
| "folder_to_be_deleted_on_remote"
|
||||||
|
| "folder_to_be_deleted_on_local";
|
||||||
|
|
||||||
export type DecisionType =
|
/**
|
||||||
| DecisionTypeForFile
|
* uniform representation
|
||||||
| DecisionTypeForFileSize
|
* everything should be flat and primitive, so that we can copy.
|
||||||
| DecisionTypeForFolder;
|
*/
|
||||||
|
export interface Entity {
|
||||||
|
key?: string;
|
||||||
|
keyEnc?: string;
|
||||||
|
keyRaw: string;
|
||||||
|
mtimeCli?: number;
|
||||||
|
mtimeCliFmt?: string;
|
||||||
|
mtimeSvr?: number;
|
||||||
|
mtimeSvrFmt?: string;
|
||||||
|
prevSyncTime?: number;
|
||||||
|
prevSyncTimeFmt?: string;
|
||||||
|
size?: number; // might be unknown or to be filled
|
||||||
|
sizeEnc?: number;
|
||||||
|
sizeRaw: number;
|
||||||
|
hash?: string;
|
||||||
|
etag?: string;
|
||||||
|
synthesizedFolder?: boolean;
|
||||||
|
synthesizedFile?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface UploadedType {
|
||||||
|
entity: Entity;
|
||||||
|
mtimeCli?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A replacement of FileOrFolderMixedState
|
||||||
|
*/
|
||||||
|
export interface MixedEntity {
|
||||||
|
key: string;
|
||||||
|
local?: Entity;
|
||||||
|
prevSync?: Entity;
|
||||||
|
remote?: Entity;
|
||||||
|
|
||||||
|
decisionBranch?: number;
|
||||||
|
decision?: DecisionTypeForMixedEntity;
|
||||||
|
conflictAction?: ConflictActionType;
|
||||||
|
|
||||||
|
change?: boolean;
|
||||||
|
|
||||||
|
sideNotes?: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
export interface FileOrFolderMixedState {
|
export interface FileOrFolderMixedState {
|
||||||
key: string;
|
key: string;
|
||||||
existLocal?: boolean;
|
existLocal?: boolean;
|
||||||
@@ -161,7 +286,7 @@ export interface FileOrFolderMixedState {
|
|||||||
sizeRemoteEnc?: number;
|
sizeRemoteEnc?: number;
|
||||||
changeRemoteMtimeUsingMapping?: boolean;
|
changeRemoteMtimeUsingMapping?: boolean;
|
||||||
changeLocalMtimeUsingMapping?: boolean;
|
changeLocalMtimeUsingMapping?: boolean;
|
||||||
decision?: DecisionType;
|
decision?: string; // old DecisionType is deleted, fallback to string
|
||||||
decisionBranch?: number;
|
decisionBranch?: number;
|
||||||
syncDone?: "done";
|
syncDone?: "done";
|
||||||
remoteEncryptedKey?: string;
|
remoteEncryptedKey?: string;
|
||||||
@@ -172,24 +297,18 @@ export interface FileOrFolderMixedState {
|
|||||||
deltimeRemoteFmt?: 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_DEBUG_FOLDER = "_debug_remotely_save/";
|
||||||
export const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX =
|
export const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX =
|
||||||
"sync_plans_hist_exported_on_";
|
"sync_plans_hist_exported_on_";
|
||||||
export const DEFAULT_LOG_HISTORY_FILE_PREFIX = "log_hist_exported_on_";
|
export const DEFAULT_LOG_HISTORY_FILE_PREFIX = "log_hist_exported_on_";
|
||||||
|
export const DEFAULT_PROFILER_RESULT_FILE_PREFIX =
|
||||||
|
"profiler_results_exported_on_";
|
||||||
|
|
||||||
export type SyncTriggerSourceType =
|
export type SyncTriggerSourceType =
|
||||||
| "manual"
|
| "manual"
|
||||||
| "auto"
|
|
||||||
| "dry"
|
| "dry"
|
||||||
| "autoOnceInit"
|
| "auto"
|
||||||
|
| "auto_once_init"
|
||||||
| "auto_sync_on_save";
|
| "auto_sync_on_save";
|
||||||
|
|
||||||
export const REMOTELY_SAVE_VERSION_2022 = "0.3.25";
|
export const REMOTELY_SAVE_VERSION_2022 = "0.3.25";
|
||||||
|
|||||||
@@ -0,0 +1,14 @@
|
|||||||
|
/**
|
||||||
|
* Every utils requiring Obsidian is placed here.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { Platform, requireApiVersion } from "obsidian";
|
||||||
|
|
||||||
|
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 API_VER_ENSURE_REQURL_OK = "1.0.0"; // always bypass CORS here
|
||||||
|
|
||||||
|
export const VALID_REQURL =
|
||||||
|
(!Platform.isAndroidApp && requireApiVersion(API_VER_REQURL)) ||
|
||||||
|
(Platform.isAndroidApp && requireApiVersion(API_VER_REQURL_ANDROID));
|
||||||
+10
-12
@@ -1,10 +1,8 @@
|
|||||||
import { base64, base64url } from "rfc4648";
|
import { base64url } from "rfc4648";
|
||||||
import { reverseString } from "./misc";
|
import { reverseString } from "./misc";
|
||||||
|
|
||||||
import type { RemotelySavePluginSettings } from "./baseTypes";
|
import type { RemotelySavePluginSettings } from "./baseTypes";
|
||||||
|
|
||||||
import { log } from "./moreOnLog";
|
|
||||||
|
|
||||||
const DEFAULT_README: string =
|
const DEFAULT_README: string =
|
||||||
"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.";
|
"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.";
|
||||||
|
|
||||||
@@ -19,10 +17,10 @@ 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:");
|
// console.debug("loading, original config on disk:");
|
||||||
// log.debug(x);
|
// console.debug(x);
|
||||||
if (x === null || x === undefined) {
|
if (x === null || x === undefined) {
|
||||||
log.debug("the messy config is null or undefined, skip");
|
console.debug("the messy config is null or undefined, skip");
|
||||||
return x as any;
|
return x as any;
|
||||||
}
|
}
|
||||||
if ("readme" in x && "d" in x) {
|
if ("readme" in x && "d" in x) {
|
||||||
@@ -35,12 +33,12 @@ export const messyConfigToNormal = (
|
|||||||
}) as Buffer
|
}) as Buffer
|
||||||
).toString("utf-8")
|
).toString("utf-8")
|
||||||
);
|
);
|
||||||
// log.debug("loading, parsed config is:");
|
// console.debug("loading, parsed config is:");
|
||||||
// log.debug(y);
|
// console.debug(y);
|
||||||
return y;
|
return y;
|
||||||
} else {
|
} else {
|
||||||
// return as is
|
// return as is
|
||||||
// log.debug("loading, parsed config is the same");
|
// console.debug("loading, parsed config is the same");
|
||||||
return x;
|
return x;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
@@ -52,7 +50,7 @@ export const normalConfigToMessy = (
|
|||||||
x: RemotelySavePluginSettings | null | undefined
|
x: RemotelySavePluginSettings | null | undefined
|
||||||
) => {
|
) => {
|
||||||
if (x === null || x === undefined) {
|
if (x === null || x === undefined) {
|
||||||
log.debug("the normal config is null or undefined, skip");
|
console.debug("the normal config is null or undefined, skip");
|
||||||
return x;
|
return x;
|
||||||
}
|
}
|
||||||
const y = {
|
const y = {
|
||||||
@@ -63,7 +61,7 @@ export const normalConfigToMessy = (
|
|||||||
})
|
})
|
||||||
),
|
),
|
||||||
};
|
};
|
||||||
// log.debug("encoding, encoded config is:");
|
// console.debug("encoding, encoded config is:");
|
||||||
// log.debug(y);
|
// console.debug(y);
|
||||||
return y;
|
return y;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -0,0 +1,60 @@
|
|||||||
|
import type { FakeFs } from "./fsAll";
|
||||||
|
|
||||||
|
export async function copyFolder(key: string, left: FakeFs, right: FakeFs) {
|
||||||
|
if (!key.endsWith("/")) {
|
||||||
|
throw Error(`should not call ${key} in copyFolder`);
|
||||||
|
}
|
||||||
|
const statsLeft = await left.stat(key);
|
||||||
|
const entity = await right.mkdir(key, statsLeft.mtimeCli);
|
||||||
|
return {
|
||||||
|
entity: entity,
|
||||||
|
content: undefined,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function copyFile(key: string, left: FakeFs, right: FakeFs) {
|
||||||
|
// console.debug(`copyFile: key=${key}, left=${left.kind}, right=${right.kind}`);
|
||||||
|
if (key.endsWith("/")) {
|
||||||
|
throw Error(`should not call ${key} in copyFile`);
|
||||||
|
}
|
||||||
|
const statsLeft = await left.stat(key);
|
||||||
|
const content = await left.readFile(key);
|
||||||
|
|
||||||
|
if (statsLeft.size === undefined || statsLeft.size === 0) {
|
||||||
|
// some weird bugs on android not returning size. just ignore them
|
||||||
|
statsLeft.size = content.byteLength;
|
||||||
|
} else {
|
||||||
|
if (statsLeft.size !== content.byteLength) {
|
||||||
|
throw Error(
|
||||||
|
`error copying ${left.kind}=>${right.kind}: size not matched`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (statsLeft.mtimeCli === undefined) {
|
||||||
|
throw Error(`error copying ${left.kind}=>${right.kind}, no mtimeCli`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// console.debug(`copyFile: about to start right.writeFile`);
|
||||||
|
return {
|
||||||
|
entity: await right.writeFile(
|
||||||
|
key,
|
||||||
|
content,
|
||||||
|
statsLeft.mtimeCli,
|
||||||
|
statsLeft.mtimeCli /* TODO */
|
||||||
|
),
|
||||||
|
content: content,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function copyFileOrFolder(
|
||||||
|
key: string,
|
||||||
|
left: FakeFs,
|
||||||
|
right: FakeFs
|
||||||
|
) {
|
||||||
|
if (key.endsWith("/")) {
|
||||||
|
return await copyFolder(key, left, right);
|
||||||
|
} else {
|
||||||
|
return await copyFile(key, left, right);
|
||||||
|
}
|
||||||
|
}
|
||||||
+47
-84
@@ -1,102 +1,65 @@
|
|||||||
import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
|
import type { Vault } from "obsidian";
|
||||||
|
|
||||||
import type { SyncPlanType } from "./sync";
|
|
||||||
import {
|
import {
|
||||||
|
DEFAULT_DEBUG_FOLDER,
|
||||||
|
DEFAULT_PROFILER_RESULT_FILE_PREFIX,
|
||||||
|
DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX,
|
||||||
|
} from "./baseTypes";
|
||||||
|
import {
|
||||||
|
readAllProfilerResultsByVault,
|
||||||
readAllSyncPlanRecordTextsByVault,
|
readAllSyncPlanRecordTextsByVault,
|
||||||
readAllLogRecordTextsByVault,
|
|
||||||
} from "./localdb";
|
} from "./localdb";
|
||||||
import type { InternalDBs } from "./localdb";
|
import type { InternalDBs } from "./localdb";
|
||||||
import { mkdirpInVault } from "./misc";
|
import { mkdirpInVault } from "./misc";
|
||||||
import {
|
import type { SyncPlanType } from "./sync";
|
||||||
DEFAULT_DEBUG_FOLDER,
|
|
||||||
DEFAULT_LOG_HISTORY_FILE_PREFIX,
|
|
||||||
DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX,
|
|
||||||
FileOrFolderMixedState,
|
|
||||||
} from "./baseTypes";
|
|
||||||
|
|
||||||
import { log } from "./moreOnLog";
|
const getSubsetOfSyncPlan = (x: string, onlyChange: boolean) => {
|
||||||
|
if (!onlyChange) {
|
||||||
const turnSyncPlanToTable = (record: string) => {
|
return x;
|
||||||
const syncPlan: SyncPlanType = JSON.parse(record);
|
|
||||||
const { ts, tsFmt, remoteType, mixedStates } = syncPlan;
|
|
||||||
|
|
||||||
type allowedHeadersType = keyof FileOrFolderMixedState;
|
|
||||||
const headers: allowedHeadersType[] = [
|
|
||||||
"key",
|
|
||||||
"remoteEncryptedKey",
|
|
||||||
"existLocal",
|
|
||||||
"sizeLocal",
|
|
||||||
"sizeLocalEnc",
|
|
||||||
"mtimeLocal",
|
|
||||||
"deltimeLocal",
|
|
||||||
"changeLocalMtimeUsingMapping",
|
|
||||||
"existRemote",
|
|
||||||
"sizeRemote",
|
|
||||||
"sizeRemoteEnc",
|
|
||||||
"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(" | ")} |`);
|
|
||||||
}
|
}
|
||||||
|
const y: SyncPlanType = JSON.parse(x);
|
||||||
return lines.join("\n");
|
const z: SyncPlanType = Object.fromEntries(
|
||||||
|
Object.entries(y).filter(([key, val]) => {
|
||||||
|
if (key === "/$@meta") {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return val.change === undefined || val.change === true;
|
||||||
|
})
|
||||||
|
);
|
||||||
|
return JSON.stringify(z, null, 2);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const exportVaultSyncPlansToFiles = async (
|
export const exportVaultSyncPlansToFiles = async (
|
||||||
db: InternalDBs,
|
db: InternalDBs,
|
||||||
vault: Vault,
|
vault: Vault,
|
||||||
vaultRandomID: string,
|
vaultRandomID: string,
|
||||||
toFormat: "table" | "json" = "json"
|
howMany: number,
|
||||||
|
onlyChange: boolean
|
||||||
) => {
|
) => {
|
||||||
log.info("exporting");
|
console.info("exporting sync plans");
|
||||||
await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
|
await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
|
||||||
const records = await readAllSyncPlanRecordTextsByVault(db, vaultRandomID);
|
const records = await readAllSyncPlanRecordTextsByVault(db, vaultRandomID);
|
||||||
let md = "";
|
let md = "";
|
||||||
if (records.length === 0) {
|
if (records.length === 0) {
|
||||||
md = "No sync plans history found";
|
md = "No sync plans history found";
|
||||||
} else {
|
} else {
|
||||||
if (toFormat === "json") {
|
if (howMany <= 0) {
|
||||||
md =
|
md =
|
||||||
"Sync plans found:\n\n" +
|
"Sync plans found:\n\n" +
|
||||||
records.map((x) => "```json\n" + x + "\n```\n").join("\n");
|
records
|
||||||
} else if (toFormat === "table") {
|
.map(
|
||||||
md =
|
(x) => "```json\n" + getSubsetOfSyncPlan(x, onlyChange) + "\n```\n"
|
||||||
"Sync plans found:\n\n" + records.map(turnSyncPlanToTable).join("\n\n");
|
)
|
||||||
|
.join("\n");
|
||||||
} else {
|
} else {
|
||||||
const _: never = toFormat;
|
md =
|
||||||
|
"Sync plans found:\n\n" +
|
||||||
|
records
|
||||||
|
.map(
|
||||||
|
(x) => "```json\n" + getSubsetOfSyncPlan(x, onlyChange) + "\n```\n"
|
||||||
|
)
|
||||||
|
.slice(0, howMany)
|
||||||
|
.join("\n");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
const ts = Date.now();
|
const ts = Date.now();
|
||||||
@@ -104,29 +67,29 @@ export const exportVaultSyncPlansToFiles = async (
|
|||||||
await vault.create(filePath, md, {
|
await vault.create(filePath, md, {
|
||||||
mtime: ts,
|
mtime: ts,
|
||||||
});
|
});
|
||||||
log.info("finish exporting");
|
console.info("finish exporting sync plans");
|
||||||
};
|
};
|
||||||
|
|
||||||
export const exportVaultLoggerOutputToFiles = async (
|
export const exportVaultProfilerResultsToFiles = async (
|
||||||
db: InternalDBs,
|
db: InternalDBs,
|
||||||
vault: Vault,
|
vault: Vault,
|
||||||
vaultRandomID: string
|
vaultRandomID: string
|
||||||
) => {
|
) => {
|
||||||
|
console.info("exporting profiler results");
|
||||||
await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
|
await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
|
||||||
const records = await readAllLogRecordTextsByVault(db, vaultRandomID);
|
const records = await readAllProfilerResultsByVault(db, vaultRandomID);
|
||||||
let md = "";
|
let md = "";
|
||||||
if (records.length === 0) {
|
if (records.length === 0) {
|
||||||
md = "No logger history found.";
|
md = "No profiler results found";
|
||||||
} else {
|
} else {
|
||||||
md =
|
md =
|
||||||
"Logger history found:\n\n" +
|
"Profiler results found:\n\n" +
|
||||||
"```text\n" +
|
records.map((x) => "```\n" + x + "\n```\n").join("\n");
|
||||||
records.join("\n") +
|
|
||||||
"\n```\n";
|
|
||||||
}
|
}
|
||||||
const ts = Date.now();
|
const ts = Date.now();
|
||||||
const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_LOG_HISTORY_FILE_PREFIX}${ts}.md`;
|
const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_PROFILER_RESULT_FILE_PREFIX}${ts}.md`;
|
||||||
await vault.create(filePath, md, {
|
await vault.create(filePath, md, {
|
||||||
mtime: ts,
|
mtime: ts,
|
||||||
});
|
});
|
||||||
|
console.info("finish exporting profiler results");
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,8 +1,6 @@
|
|||||||
import { base32, base64url } from "rfc4648";
|
import { base32, base64url } from "rfc4648";
|
||||||
import { bufferToArrayBuffer, hexStringToTypedArray } from "./misc";
|
import { bufferToArrayBuffer, hexStringToTypedArray } from "./misc";
|
||||||
|
|
||||||
import { log } from "./moreOnLog";
|
|
||||||
|
|
||||||
const DEFAULT_ITER = 20000;
|
const DEFAULT_ITER = 20000;
|
||||||
|
|
||||||
// base32.stringify(Buffer.from('Salted__'))
|
// base32.stringify(Buffer.from('Salted__'))
|
||||||
@@ -41,7 +39,7 @@ export const encryptArrayBuffer = async (
|
|||||||
arrBuf: ArrayBuffer,
|
arrBuf: ArrayBuffer,
|
||||||
password: string,
|
password: string,
|
||||||
rounds: number = DEFAULT_ITER,
|
rounds: number = DEFAULT_ITER,
|
||||||
saltHex: string = ""
|
saltHex = ""
|
||||||
) => {
|
) => {
|
||||||
let salt: Uint8Array;
|
let salt: Uint8Array;
|
||||||
if (saltHex !== "") {
|
if (saltHex !== "") {
|
||||||
@@ -111,7 +109,7 @@ export const encryptStringToBase32 = async (
|
|||||||
text: string,
|
text: string,
|
||||||
password: string,
|
password: string,
|
||||||
rounds: number = DEFAULT_ITER,
|
rounds: number = DEFAULT_ITER,
|
||||||
saltHex: string = ""
|
saltHex = ""
|
||||||
) => {
|
) => {
|
||||||
const enc = await encryptArrayBuffer(
|
const enc = await encryptArrayBuffer(
|
||||||
bufferToArrayBuffer(new TextEncoder().encode(text)),
|
bufferToArrayBuffer(new TextEncoder().encode(text)),
|
||||||
@@ -140,7 +138,7 @@ export const encryptStringToBase64url = async (
|
|||||||
text: string,
|
text: string,
|
||||||
password: string,
|
password: string,
|
||||||
rounds: number = DEFAULT_ITER,
|
rounds: number = DEFAULT_ITER,
|
||||||
saltHex: string = ""
|
saltHex = ""
|
||||||
) => {
|
) => {
|
||||||
const enc = await encryptArrayBuffer(
|
const enc = await encryptArrayBuffer(
|
||||||
bufferToArrayBuffer(new TextEncoder().encode(text)),
|
bufferToArrayBuffer(new TextEncoder().encode(text)),
|
||||||
@@ -0,0 +1,251 @@
|
|||||||
|
import {
|
||||||
|
Cipher as CipherRCloneCryptPack,
|
||||||
|
encryptedSize,
|
||||||
|
} from "@fyears/rclone-crypt";
|
||||||
|
|
||||||
|
// @ts-ignore
|
||||||
|
import EncryptWorker from "./encryptRClone.worker";
|
||||||
|
|
||||||
|
interface RecvMsg {
|
||||||
|
status: "ok" | "error";
|
||||||
|
outputName?: string;
|
||||||
|
outputContent?: ArrayBuffer;
|
||||||
|
error?: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const getSizeFromOrigToEnc = encryptedSize;
|
||||||
|
|
||||||
|
export class CipherRclone {
|
||||||
|
readonly password: string;
|
||||||
|
readonly cipher: CipherRCloneCryptPack;
|
||||||
|
readonly workers: Worker[];
|
||||||
|
init: boolean;
|
||||||
|
workerIdx: number;
|
||||||
|
constructor(password: string, workerNum: number) {
|
||||||
|
this.password = password;
|
||||||
|
this.init = false;
|
||||||
|
this.workerIdx = 0;
|
||||||
|
|
||||||
|
// console.debug("begin creating CipherRCloneCryptPack");
|
||||||
|
this.cipher = new CipherRCloneCryptPack("base64");
|
||||||
|
// console.debug("finish creating CipherRCloneCryptPack");
|
||||||
|
|
||||||
|
// console.debug("begin creating EncryptWorker");
|
||||||
|
this.workers = [];
|
||||||
|
for (let i = 0; i < workerNum; ++i) {
|
||||||
|
this.workers.push(new (EncryptWorker as any)() as Worker);
|
||||||
|
}
|
||||||
|
|
||||||
|
// console.debug("finish creating EncryptWorker");
|
||||||
|
}
|
||||||
|
|
||||||
|
closeResources() {
|
||||||
|
for (let i = 0; i < this.workers.length; ++i) {
|
||||||
|
this.workers[i].terminate();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async prepareByCallingWorker(): Promise<void> {
|
||||||
|
if (this.init) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// console.debug("begin prepareByCallingWorker");
|
||||||
|
await this.cipher.key(this.password, "");
|
||||||
|
// console.debug("finish getting key");
|
||||||
|
|
||||||
|
const res: Promise<void>[] = [];
|
||||||
|
for (let i = 0; i < this.workers.length; ++i) {
|
||||||
|
res.push(
|
||||||
|
new Promise((resolve, reject) => {
|
||||||
|
const channel = new MessageChannel();
|
||||||
|
|
||||||
|
channel.port2.onmessage = (event) => {
|
||||||
|
// console.debug("main: receiving msg in prepare");
|
||||||
|
const { status } = event.data as RecvMsg;
|
||||||
|
if (status === "ok") {
|
||||||
|
// console.debug("main: receiving init ok in prepare");
|
||||||
|
this.init = true;
|
||||||
|
resolve(); // return the class object itself
|
||||||
|
} else {
|
||||||
|
reject("error after prepareByCallingWorker");
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
channel.port2.onmessageerror = (event) => {
|
||||||
|
// console.debug("main: receiving error in prepare");
|
||||||
|
reject(event);
|
||||||
|
};
|
||||||
|
|
||||||
|
// console.debug("main: before postMessage in prepare");
|
||||||
|
this.workers[i].postMessage(
|
||||||
|
{
|
||||||
|
action: "prepare",
|
||||||
|
dataKeyBuf: this.cipher.dataKey.buffer,
|
||||||
|
nameKeyBuf: this.cipher.nameKey.buffer,
|
||||||
|
nameTweakBuf: this.cipher.nameTweak.buffer,
|
||||||
|
},
|
||||||
|
[channel.port1 /* buffer no transfered because we need to copy */]
|
||||||
|
);
|
||||||
|
})
|
||||||
|
);
|
||||||
|
}
|
||||||
|
await Promise.all(res);
|
||||||
|
}
|
||||||
|
|
||||||
|
async encryptNameByCallingWorker(inputName: string): Promise<string> {
|
||||||
|
// console.debug("main: start encryptNameByCallingWorker");
|
||||||
|
await this.prepareByCallingWorker();
|
||||||
|
// console.debug(
|
||||||
|
// "main: really start generate promise in encryptNameByCallingWorker"
|
||||||
|
// );
|
||||||
|
++this.workerIdx;
|
||||||
|
const whichWorker = this.workerIdx % this.workers.length;
|
||||||
|
return await new Promise((resolve, reject) => {
|
||||||
|
const channel = new MessageChannel();
|
||||||
|
|
||||||
|
channel.port2.onmessage = (event) => {
|
||||||
|
// console.debug("main: receiving msg in encryptNameByCallingWorker");
|
||||||
|
const { outputName } = event.data as RecvMsg;
|
||||||
|
if (outputName === undefined) {
|
||||||
|
reject("unknown outputName after encryptNameByCallingWorker");
|
||||||
|
} else {
|
||||||
|
resolve(outputName);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
channel.port2.onmessageerror = (event) => {
|
||||||
|
// console.debug("main: receiving error in encryptNameByCallingWorker");
|
||||||
|
reject(event);
|
||||||
|
};
|
||||||
|
|
||||||
|
// console.debug("main: before postMessage in encryptNameByCallingWorker");
|
||||||
|
this.workers[whichWorker].postMessage(
|
||||||
|
{
|
||||||
|
action: "encryptName",
|
||||||
|
inputName: inputName,
|
||||||
|
},
|
||||||
|
[channel.port1]
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async decryptNameByCallingWorker(inputName: string): Promise<string> {
|
||||||
|
await this.prepareByCallingWorker();
|
||||||
|
++this.workerIdx;
|
||||||
|
const whichWorker = this.workerIdx % this.workers.length;
|
||||||
|
return await new Promise((resolve, reject) => {
|
||||||
|
const channel = new MessageChannel();
|
||||||
|
|
||||||
|
channel.port2.onmessage = (event) => {
|
||||||
|
// console.debug("main: receiving msg in decryptNameByCallingWorker");
|
||||||
|
const { outputName, status } = event.data as RecvMsg;
|
||||||
|
|
||||||
|
if (status === "error") {
|
||||||
|
reject("error");
|
||||||
|
} else {
|
||||||
|
if (outputName === undefined) {
|
||||||
|
reject("unknown outputName after decryptNameByCallingWorker");
|
||||||
|
} else {
|
||||||
|
resolve(outputName);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
channel.port2.onmessageerror = (event) => {
|
||||||
|
// console.debug("main: receiving error in decryptNameByCallingWorker");
|
||||||
|
reject(event);
|
||||||
|
channel;
|
||||||
|
};
|
||||||
|
|
||||||
|
// console.debug("main: before postMessage in decryptNameByCallingWorker");
|
||||||
|
this.workers[whichWorker].postMessage(
|
||||||
|
{
|
||||||
|
action: "decryptName",
|
||||||
|
inputName: inputName,
|
||||||
|
},
|
||||||
|
[channel.port1]
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async encryptContentByCallingWorker(
|
||||||
|
input: ArrayBuffer
|
||||||
|
): Promise<ArrayBuffer> {
|
||||||
|
await this.prepareByCallingWorker();
|
||||||
|
++this.workerIdx;
|
||||||
|
const whichWorker = this.workerIdx % this.workers.length;
|
||||||
|
return await new Promise((resolve, reject) => {
|
||||||
|
const channel = new MessageChannel();
|
||||||
|
|
||||||
|
channel.port2.onmessage = (event) => {
|
||||||
|
// console.debug("main: receiving msg in encryptContentByCallingWorker");
|
||||||
|
const { outputContent } = event.data as RecvMsg;
|
||||||
|
if (outputContent === undefined) {
|
||||||
|
reject("unknown outputContent after encryptContentByCallingWorker");
|
||||||
|
} else {
|
||||||
|
resolve(outputContent);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
channel.port2.onmessageerror = (event) => {
|
||||||
|
// console.debug("main: receiving error in encryptContentByCallingWorker");
|
||||||
|
reject(event);
|
||||||
|
};
|
||||||
|
|
||||||
|
// console.debug(
|
||||||
|
// "main: before postMessage in encryptContentByCallingWorker"
|
||||||
|
// );
|
||||||
|
this.workers[whichWorker].postMessage(
|
||||||
|
{
|
||||||
|
action: "encryptContent",
|
||||||
|
inputContent: input,
|
||||||
|
},
|
||||||
|
[channel.port1, input]
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async decryptContentByCallingWorker(
|
||||||
|
input: ArrayBuffer
|
||||||
|
): Promise<ArrayBuffer> {
|
||||||
|
await this.prepareByCallingWorker();
|
||||||
|
++this.workerIdx;
|
||||||
|
const whichWorker = this.workerIdx % this.workers.length;
|
||||||
|
return await new Promise((resolve, reject) => {
|
||||||
|
const channel = new MessageChannel();
|
||||||
|
|
||||||
|
channel.port2.onmessage = (event) => {
|
||||||
|
// console.debug("main: receiving msg in decryptContentByCallingWorker");
|
||||||
|
const { outputContent, status } = event.data as RecvMsg;
|
||||||
|
|
||||||
|
if (status === "error") {
|
||||||
|
reject("error");
|
||||||
|
} else {
|
||||||
|
if (outputContent === undefined) {
|
||||||
|
reject("unknown outputContent after decryptContentByCallingWorker");
|
||||||
|
} else {
|
||||||
|
resolve(outputContent);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
channel.port2.onmessageerror = (event) => {
|
||||||
|
// console.debug(
|
||||||
|
// "main: receiving onmessageerror in decryptContentByCallingWorker"
|
||||||
|
// );
|
||||||
|
reject(event);
|
||||||
|
};
|
||||||
|
|
||||||
|
// console.debug(
|
||||||
|
// "main: before postMessage in decryptContentByCallingWorker"
|
||||||
|
// );
|
||||||
|
this.workers[whichWorker].postMessage(
|
||||||
|
{
|
||||||
|
action: "decryptContent",
|
||||||
|
inputContent: input,
|
||||||
|
},
|
||||||
|
[channel.port1, input]
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,184 @@
|
|||||||
|
import { Cipher as CipherRCloneCryptPack } from "@fyears/rclone-crypt";
|
||||||
|
import { nanoid } from "nanoid";
|
||||||
|
|
||||||
|
const ctx: WorkerGlobalScope = self as any;
|
||||||
|
|
||||||
|
const workerNanoID = nanoid();
|
||||||
|
const cipher = new CipherRCloneCryptPack("base64");
|
||||||
|
|
||||||
|
// console.debug(`worker [${workerNanoID}]: cipher created`);
|
||||||
|
|
||||||
|
async function encryptNameStr(input: string) {
|
||||||
|
const res = await cipher.encryptFileName(input);
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function decryptNameStr(input: string) {
|
||||||
|
return await cipher.decryptFileName(input);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function encryptContentBuf(input: ArrayBuffer) {
|
||||||
|
return (await cipher.encryptData(new Uint8Array(input), undefined)).buffer;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function decryptContentBuf(input: ArrayBuffer) {
|
||||||
|
return (await cipher.decryptData(new Uint8Array(input))).buffer;
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.addEventListener("message", async (event: any) => {
|
||||||
|
const port: MessagePort = event.ports[0];
|
||||||
|
const {
|
||||||
|
action,
|
||||||
|
dataKeyBuf,
|
||||||
|
nameKeyBuf,
|
||||||
|
nameTweakBuf,
|
||||||
|
inputName,
|
||||||
|
inputContent,
|
||||||
|
} = event.data as {
|
||||||
|
action:
|
||||||
|
| "prepare"
|
||||||
|
| "encryptContent"
|
||||||
|
| "decryptContent"
|
||||||
|
| "encryptName"
|
||||||
|
| "decryptName";
|
||||||
|
dataKeyBuf?: ArrayBuffer;
|
||||||
|
nameKeyBuf?: ArrayBuffer;
|
||||||
|
nameTweakBuf?: ArrayBuffer;
|
||||||
|
inputName?: string;
|
||||||
|
inputContent?: ArrayBuffer;
|
||||||
|
};
|
||||||
|
|
||||||
|
// console.debug(`worker [${workerNanoID}]: receiving action=${action}`);
|
||||||
|
|
||||||
|
if (action === "prepare") {
|
||||||
|
// console.debug(`worker [${workerNanoID}]: prepare: start`);
|
||||||
|
try {
|
||||||
|
if (
|
||||||
|
dataKeyBuf === undefined ||
|
||||||
|
nameKeyBuf === undefined ||
|
||||||
|
nameTweakBuf === undefined
|
||||||
|
) {
|
||||||
|
// console.debug(`worker [${workerNanoID}]: prepare: no buffer??`);
|
||||||
|
throw Error(
|
||||||
|
`worker [${workerNanoID}]: prepare: internal keys not transferred to worker properly`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// console.debug(`worker [${workerNanoID}]: prepare: so we update`);
|
||||||
|
cipher.updateInternalKey(
|
||||||
|
new Uint8Array(dataKeyBuf),
|
||||||
|
new Uint8Array(nameKeyBuf),
|
||||||
|
new Uint8Array(nameTweakBuf)
|
||||||
|
);
|
||||||
|
port.postMessage({
|
||||||
|
status: "ok",
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
console.error(error);
|
||||||
|
port.postMessage({
|
||||||
|
status: "error",
|
||||||
|
error: error,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
} else if (action === "encryptName") {
|
||||||
|
try {
|
||||||
|
if (inputName === undefined) {
|
||||||
|
throw Error(
|
||||||
|
`worker [${workerNanoID}]: encryptName: internal inputName not transferred to worker properly`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const outputName = await encryptNameStr(inputName);
|
||||||
|
// console.debug(
|
||||||
|
// `worker [${workerNanoID}]: after encryptNameStr, before postMessage`
|
||||||
|
// );
|
||||||
|
port.postMessage({
|
||||||
|
status: "ok",
|
||||||
|
outputName: outputName,
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
console.error(`worker [${workerNanoID}]: encryptName=${inputName}`);
|
||||||
|
console.error(error);
|
||||||
|
port.postMessage({
|
||||||
|
status: "error",
|
||||||
|
error: error,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
} else if (action === "decryptName") {
|
||||||
|
try {
|
||||||
|
if (inputName === undefined) {
|
||||||
|
throw Error(
|
||||||
|
`worker [${workerNanoID}]: decryptName: internal inputName not transferred to worker properly`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const outputName = await decryptNameStr(inputName);
|
||||||
|
// console.debug(
|
||||||
|
// `worker [${workerNanoID}]: after decryptNameStr, before postMessage`
|
||||||
|
// );
|
||||||
|
port.postMessage({
|
||||||
|
status: "ok",
|
||||||
|
outputName: outputName,
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
console.error(`worker [${workerNanoID}]: decryptName=${inputName}`);
|
||||||
|
console.error(error);
|
||||||
|
port.postMessage({
|
||||||
|
status: "error",
|
||||||
|
error: error,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
} else if (action === "encryptContent") {
|
||||||
|
try {
|
||||||
|
if (inputContent === undefined) {
|
||||||
|
throw Error(
|
||||||
|
`worker [${workerNanoID}]: encryptContent: internal inputContent not transferred to worker properly`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const outputContent = await encryptContentBuf(inputContent);
|
||||||
|
// console.debug(
|
||||||
|
// `worker [${workerNanoID}]: after encryptContentBuf, before postMessage`
|
||||||
|
// );
|
||||||
|
port.postMessage(
|
||||||
|
{
|
||||||
|
status: "ok",
|
||||||
|
outputContent: outputContent,
|
||||||
|
},
|
||||||
|
[outputContent]
|
||||||
|
);
|
||||||
|
} catch (error) {
|
||||||
|
console.error(error);
|
||||||
|
port.postMessage({
|
||||||
|
status: "error",
|
||||||
|
error: error,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
} else if (action === "decryptContent") {
|
||||||
|
try {
|
||||||
|
if (inputContent === undefined) {
|
||||||
|
throw Error(
|
||||||
|
`worker [${workerNanoID}]: decryptContent: internal inputContent not transferred to worker properly`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const outputContent = await decryptContentBuf(inputContent);
|
||||||
|
// console.debug(
|
||||||
|
// `worker [${workerNanoID}]: after decryptContentBuf, before postMessage`
|
||||||
|
// );
|
||||||
|
port.postMessage(
|
||||||
|
{
|
||||||
|
status: "ok",
|
||||||
|
outputContent: outputContent,
|
||||||
|
},
|
||||||
|
[outputContent]
|
||||||
|
);
|
||||||
|
} catch (error) {
|
||||||
|
console.error(error);
|
||||||
|
port.postMessage({
|
||||||
|
status: "error",
|
||||||
|
error: error,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
port.postMessage({
|
||||||
|
status: "error",
|
||||||
|
error: `worker [${workerNanoID}]: unknown action=${action}`,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
import type { Entity } from "./baseTypes";
|
||||||
|
|
||||||
|
export abstract class FakeFs {
|
||||||
|
abstract kind: string;
|
||||||
|
abstract walk(): Promise<Entity[]>;
|
||||||
|
abstract walkPartial(): Promise<Entity[]>;
|
||||||
|
abstract stat(key: string): Promise<Entity>;
|
||||||
|
abstract mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity>;
|
||||||
|
abstract writeFile(
|
||||||
|
key: string,
|
||||||
|
content: ArrayBuffer,
|
||||||
|
mtime: number,
|
||||||
|
ctime: number
|
||||||
|
): Promise<Entity>;
|
||||||
|
abstract readFile(key: string): Promise<ArrayBuffer>;
|
||||||
|
abstract rename(key1: string, key2: string): Promise<void>;
|
||||||
|
abstract rm(key: string): Promise<void>;
|
||||||
|
abstract checkConnect(callbackFunc?: any): Promise<boolean>;
|
||||||
|
abstract getUserDisplayName(): Promise<string>;
|
||||||
|
abstract revokeAuth(): Promise<any>;
|
||||||
|
abstract allowEmptyFile(): boolean;
|
||||||
|
}
|
||||||
@@ -0,0 +1,772 @@
|
|||||||
|
import { Dropbox, DropboxAuth } from "dropbox";
|
||||||
|
import type { DropboxResponse, DropboxResponseError, files } from "dropbox";
|
||||||
|
import random from "lodash/random";
|
||||||
|
import {
|
||||||
|
COMMAND_CALLBACK_DROPBOX,
|
||||||
|
type DropboxConfig,
|
||||||
|
type Entity,
|
||||||
|
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
||||||
|
} from "./baseTypes";
|
||||||
|
import { FakeFs } from "./fsAll";
|
||||||
|
import {
|
||||||
|
bufferToArrayBuffer,
|
||||||
|
delay,
|
||||||
|
getFolderLevels,
|
||||||
|
getParentFolder,
|
||||||
|
hasEmojiInText,
|
||||||
|
headersToRecord,
|
||||||
|
} from "./misc";
|
||||||
|
|
||||||
|
export { Dropbox } from "dropbox";
|
||||||
|
|
||||||
|
export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
|
||||||
|
accessToken: "",
|
||||||
|
clientID: process.env.DEFAULT_DROPBOX_APP_KEY ?? "",
|
||||||
|
refreshToken: "",
|
||||||
|
accessTokenExpiresInSeconds: 0,
|
||||||
|
accessTokenExpiresAtTime: 0,
|
||||||
|
accountID: "",
|
||||||
|
username: "",
|
||||||
|
credentialsShouldBeDeletedAtTime: 0,
|
||||||
|
};
|
||||||
|
|
||||||
|
const getDropboxPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||||
|
let key = fileOrFolderPath;
|
||||||
|
if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
|
||||||
|
// special
|
||||||
|
key = `/${remoteBaseDir}`;
|
||||||
|
} else if (fileOrFolderPath.startsWith("/")) {
|
||||||
|
console.warn(
|
||||||
|
`why the path ${fileOrFolderPath} starts with '/'? but we just go on.`
|
||||||
|
);
|
||||||
|
key = `/${remoteBaseDir}${fileOrFolderPath}`;
|
||||||
|
} else {
|
||||||
|
key = `/${remoteBaseDir}/${fileOrFolderPath}`;
|
||||||
|
}
|
||||||
|
if (key.endsWith("/")) {
|
||||||
|
key = key.slice(0, key.length - 1);
|
||||||
|
}
|
||||||
|
return key;
|
||||||
|
};
|
||||||
|
|
||||||
|
const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||||
|
if (
|
||||||
|
!(
|
||||||
|
fileOrFolderPath === `/${remoteBaseDir}` ||
|
||||||
|
fileOrFolderPath.startsWith(`/${remoteBaseDir}/`)
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
throw Error(
|
||||||
|
`"${fileOrFolderPath}" doesn't starts with "/${remoteBaseDir}/"`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return fileOrFolderPath.slice(`/${remoteBaseDir}/`.length);
|
||||||
|
};
|
||||||
|
|
||||||
|
const fromDropboxItemToEntity = (
|
||||||
|
x:
|
||||||
|
| files.FileMetadataReference
|
||||||
|
| files.FolderMetadataReference
|
||||||
|
| files.DeletedMetadataReference,
|
||||||
|
remoteBaseDir: string
|
||||||
|
): Entity => {
|
||||||
|
let key = getNormPath(x.path_display!, remoteBaseDir);
|
||||||
|
if (x[".tag"] === "folder" && !key.endsWith("/")) {
|
||||||
|
key = `${key}/`;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (x[".tag"] === "folder") {
|
||||||
|
return {
|
||||||
|
key: key,
|
||||||
|
keyRaw: key,
|
||||||
|
size: 0,
|
||||||
|
sizeRaw: 0,
|
||||||
|
} as Entity;
|
||||||
|
} else if (x[".tag"] === "file") {
|
||||||
|
const mtimeCli = Date.parse(x.client_modified).valueOf();
|
||||||
|
const mtimeSvr = Date.parse(x.server_modified).valueOf();
|
||||||
|
return {
|
||||||
|
key: key,
|
||||||
|
keyRaw: key,
|
||||||
|
mtimeCli: mtimeCli,
|
||||||
|
mtimeSvr: mtimeSvr,
|
||||||
|
size: x.size,
|
||||||
|
sizeRaw: x.size,
|
||||||
|
hash: x.content_hash,
|
||||||
|
} as Entity;
|
||||||
|
} else {
|
||||||
|
// x[".tag"] === "deleted"
|
||||||
|
throw Error("do not support deleted tag");
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* https://github.com/remotely-save/remotely-save/issues/567
|
||||||
|
* https://www.dropboxforum.com/t5/Dropbox-API-Support-Feedback/Case-Sensitivity-in-API-2/td-p/191279
|
||||||
|
* @param entities
|
||||||
|
*/
|
||||||
|
export const fixEntityListCasesInplace = (entities: { key?: string }[]) => {
|
||||||
|
for (const iterator of entities) {
|
||||||
|
if (iterator.key === undefined) {
|
||||||
|
throw Error(`dropbox list should all have key, but meet undefined`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
entities.sort((a, b) => a.key!.length - b.key!.length);
|
||||||
|
// console.log(JSON.stringify(entities,null,2));
|
||||||
|
|
||||||
|
const caseMapping: Record<string, string> = { "": "" };
|
||||||
|
for (const e of entities) {
|
||||||
|
// console.log(`looking for: ${JSON.stringify(e, null, 2)}`);
|
||||||
|
|
||||||
|
let parentFolder = getParentFolder(e.key!);
|
||||||
|
if (parentFolder === "/") {
|
||||||
|
parentFolder = "";
|
||||||
|
}
|
||||||
|
const parentFolderLower = parentFolder.toLocaleLowerCase();
|
||||||
|
const segs = e.key!.split("/");
|
||||||
|
if (e.key!.endsWith("/")) {
|
||||||
|
// folder
|
||||||
|
if (caseMapping.hasOwnProperty(parentFolderLower)) {
|
||||||
|
const newKey = `${caseMapping[parentFolderLower]}${segs
|
||||||
|
.slice(-2)
|
||||||
|
.join("/")}`;
|
||||||
|
caseMapping[newKey.toLocaleLowerCase()] = newKey;
|
||||||
|
e.key = newKey;
|
||||||
|
// console.log(JSON.stringify(caseMapping,null,2));
|
||||||
|
// continue;
|
||||||
|
} else {
|
||||||
|
throw Error(`${parentFolder} doesn't have cases record??`);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// file
|
||||||
|
if (caseMapping.hasOwnProperty(parentFolderLower)) {
|
||||||
|
const newKey = `${caseMapping[parentFolderLower]}${segs
|
||||||
|
.slice(-1)
|
||||||
|
.join("/")}`;
|
||||||
|
e.key = newKey;
|
||||||
|
// continue;
|
||||||
|
} else {
|
||||||
|
throw Error(`${parentFolder} doesn't have cases record??`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return entities;
|
||||||
|
};
|
||||||
|
|
||||||
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
// Other usual common methods
|
||||||
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
|
interface ErrSubType {
|
||||||
|
error: {
|
||||||
|
retry_after: number;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function retryReq<T>(
|
||||||
|
reqFunc: () => Promise<DropboxResponse<T>>,
|
||||||
|
extraHint = ""
|
||||||
|
): Promise<DropboxResponse<T> | undefined> {
|
||||||
|
const waitSeconds = [1, 2, 4, 8]; // hard code exponential backoff
|
||||||
|
for (let idx = 0; idx < waitSeconds.length; ++idx) {
|
||||||
|
try {
|
||||||
|
if (idx !== 0) {
|
||||||
|
console.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 ||
|
||||||
|
Number.parseInt(headers["retry-after"] || "1") ||
|
||||||
|
1;
|
||||||
|
const fallbackSec = waitSeconds[idx];
|
||||||
|
const secMin = Math.max(svrSec, fallbackSec);
|
||||||
|
const secMax = Math.max(secMin * 1.8, 2);
|
||||||
|
console.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(random(secMin * 1000, secMax * 1000));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
// Dropbox authorization using PKCE
|
||||||
|
// see https://dropbox.tech/developers/pkce--what-and-why-
|
||||||
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
|
export const getAuthUrlAndVerifier = async (
|
||||||
|
appKey: string,
|
||||||
|
needManualPatse = false
|
||||||
|
) => {
|
||||||
|
const auth = new DropboxAuth({
|
||||||
|
clientId: appKey,
|
||||||
|
});
|
||||||
|
|
||||||
|
const callback = needManualPatse
|
||||||
|
? undefined
|
||||||
|
: `obsidian://${COMMAND_CALLBACK_DROPBOX}`;
|
||||||
|
const authUrl = (
|
||||||
|
await auth.getAuthenticationUrl(
|
||||||
|
callback as any,
|
||||||
|
undefined,
|
||||||
|
"code",
|
||||||
|
"offline",
|
||||||
|
undefined,
|
||||||
|
"none",
|
||||||
|
true
|
||||||
|
)
|
||||||
|
).toString();
|
||||||
|
const verifier = auth.getCodeVerifier();
|
||||||
|
return {
|
||||||
|
authUrl: authUrl,
|
||||||
|
verifier: verifier,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export interface DropboxSuccessAuthRes {
|
||||||
|
access_token: string;
|
||||||
|
token_type: "bearer";
|
||||||
|
expires_in: string;
|
||||||
|
refresh_token?: string;
|
||||||
|
scope?: string;
|
||||||
|
uid?: string;
|
||||||
|
account_id?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const sendAuthReq = async (
|
||||||
|
appKey: string,
|
||||||
|
verifier: string,
|
||||||
|
authCode: string,
|
||||||
|
errorCallBack: any
|
||||||
|
) => {
|
||||||
|
try {
|
||||||
|
const resp1 = await fetch("https://api.dropboxapi.com/oauth2/token", {
|
||||||
|
method: "POST",
|
||||||
|
body: new URLSearchParams({
|
||||||
|
code: authCode,
|
||||||
|
grant_type: "authorization_code",
|
||||||
|
code_verifier: verifier,
|
||||||
|
client_id: appKey,
|
||||||
|
redirect_uri: `obsidian://${COMMAND_CALLBACK_DROPBOX}`,
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
const resp2 = (await resp1.json()) as DropboxSuccessAuthRes;
|
||||||
|
return resp2;
|
||||||
|
} catch (e) {
|
||||||
|
console.error(e);
|
||||||
|
if (errorCallBack !== undefined) {
|
||||||
|
await errorCallBack(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export const sendRefreshTokenReq = async (
|
||||||
|
appKey: string,
|
||||||
|
refreshToken: string
|
||||||
|
) => {
|
||||||
|
try {
|
||||||
|
console.info("start auto getting refreshed Dropbox access token.");
|
||||||
|
const resp1 = await fetch("https://api.dropboxapi.com/oauth2/token", {
|
||||||
|
method: "POST",
|
||||||
|
body: new URLSearchParams({
|
||||||
|
grant_type: "refresh_token",
|
||||||
|
refresh_token: refreshToken,
|
||||||
|
client_id: appKey,
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
const resp2 = (await resp1.json()) as DropboxSuccessAuthRes;
|
||||||
|
console.info("finish auto getting refreshed Dropbox access token.");
|
||||||
|
return resp2;
|
||||||
|
} catch (e) {
|
||||||
|
console.error(e);
|
||||||
|
throw e;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export const setConfigBySuccessfullAuthInplace = async (
|
||||||
|
config: DropboxConfig,
|
||||||
|
authRes: DropboxSuccessAuthRes,
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||||
|
) => {
|
||||||
|
console.info("start updating local info of Dropbox token");
|
||||||
|
|
||||||
|
config.accessToken = authRes.access_token;
|
||||||
|
config.accessTokenExpiresInSeconds = Number.parseInt(authRes.expires_in);
|
||||||
|
config.accessTokenExpiresAtTime =
|
||||||
|
Date.now() + Number.parseInt(authRes.expires_in) * 1000 - 10 * 1000;
|
||||||
|
|
||||||
|
// manually set it expired after 80 days;
|
||||||
|
config.credentialsShouldBeDeletedAtTime =
|
||||||
|
Date.now() + OAUTH2_FORCE_EXPIRE_MILLISECONDS;
|
||||||
|
|
||||||
|
if (authRes.refresh_token !== undefined) {
|
||||||
|
config.refreshToken = authRes.refresh_token;
|
||||||
|
config.accountID = authRes.account_id!;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (saveUpdatedConfigFunc !== undefined) {
|
||||||
|
await saveUpdatedConfigFunc();
|
||||||
|
}
|
||||||
|
|
||||||
|
console.info("finish updating local info of Dropbox token");
|
||||||
|
};
|
||||||
|
|
||||||
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
// real exported interface
|
||||||
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
|
export class FakeFsDropbox extends FakeFs {
|
||||||
|
kind: "dropbox";
|
||||||
|
dropboxConfig: DropboxConfig;
|
||||||
|
remoteBaseDir: string;
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any>;
|
||||||
|
dropbox!: Dropbox;
|
||||||
|
vaultFolderExists: boolean;
|
||||||
|
foldersCreatedBefore: Set<string>;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
dropboxConfig: DropboxConfig,
|
||||||
|
vaultName: string,
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any>
|
||||||
|
) {
|
||||||
|
super();
|
||||||
|
this.kind = "dropbox";
|
||||||
|
this.dropboxConfig = dropboxConfig;
|
||||||
|
this.remoteBaseDir = this.dropboxConfig.remoteBaseDir || vaultName || "";
|
||||||
|
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||||
|
this.vaultFolderExists = false;
|
||||||
|
this.foldersCreatedBefore = new Set();
|
||||||
|
}
|
||||||
|
|
||||||
|
async _init() {
|
||||||
|
// check token
|
||||||
|
if (
|
||||||
|
this.dropboxConfig.accessToken === "" ||
|
||||||
|
this.dropboxConfig.refreshToken === ""
|
||||||
|
) {
|
||||||
|
throw Error("The user has not manually auth yet.");
|
||||||
|
}
|
||||||
|
const currentTs = Date.now();
|
||||||
|
const customHeaders = {
|
||||||
|
"Cache-Control": "no-cache",
|
||||||
|
};
|
||||||
|
if (this.dropboxConfig.accessTokenExpiresAtTime > currentTs) {
|
||||||
|
this.dropbox = new Dropbox({
|
||||||
|
accessToken: this.dropboxConfig.accessToken,
|
||||||
|
customHeaders: customHeaders,
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
if (this.dropboxConfig.refreshToken === "") {
|
||||||
|
throw Error(
|
||||||
|
"We need to automatically refresh token but none is stored."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const resp = await sendRefreshTokenReq(
|
||||||
|
this.dropboxConfig.clientID,
|
||||||
|
this.dropboxConfig.refreshToken
|
||||||
|
);
|
||||||
|
|
||||||
|
setConfigBySuccessfullAuthInplace(
|
||||||
|
this.dropboxConfig,
|
||||||
|
resp,
|
||||||
|
this.saveUpdatedConfigFunc
|
||||||
|
);
|
||||||
|
this.dropbox = new Dropbox({
|
||||||
|
accessToken: this.dropboxConfig.accessToken,
|
||||||
|
customHeaders: customHeaders,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// check vault folder
|
||||||
|
// console.info(`checking remote has folder /${this.remoteBaseDir}`);
|
||||||
|
if (this.vaultFolderExists) {
|
||||||
|
// console.info(`already checked, /${this.remoteBaseDir} exist before`)
|
||||||
|
} else {
|
||||||
|
const res = await this.dropbox.filesListFolder({
|
||||||
|
path: "",
|
||||||
|
recursive: false,
|
||||||
|
});
|
||||||
|
for (const item of res.result.entries) {
|
||||||
|
if (item.path_display === `/${this.remoteBaseDir}`) {
|
||||||
|
this.vaultFolderExists = true;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!this.vaultFolderExists) {
|
||||||
|
console.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({
|
||||||
|
path: `/${this.remoteBaseDir}`,
|
||||||
|
});
|
||||||
|
console.info(`remote folder /${this.remoteBaseDir} created`);
|
||||||
|
this.vaultFolderExists = true;
|
||||||
|
} else {
|
||||||
|
// console.info(`remote folder /${this.remoteBaseDir} exists`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
async walk(): Promise<Entity[]> {
|
||||||
|
return await this._walk(false);
|
||||||
|
}
|
||||||
|
|
||||||
|
async walkPartial(): Promise<Entity[]> {
|
||||||
|
return await this._walk(true);
|
||||||
|
}
|
||||||
|
|
||||||
|
async _walk(partial: boolean): Promise<Entity[]> {
|
||||||
|
await this._init();
|
||||||
|
|
||||||
|
let res = await this.dropbox.filesListFolder({
|
||||||
|
path: `/${this.remoteBaseDir}`,
|
||||||
|
recursive: !partial,
|
||||||
|
include_deleted: false,
|
||||||
|
limit: partial ? 10 : 1000,
|
||||||
|
});
|
||||||
|
if (res.status !== 200) {
|
||||||
|
throw Error(JSON.stringify(res));
|
||||||
|
}
|
||||||
|
// console.info(res);
|
||||||
|
|
||||||
|
const contents = res.result.entries;
|
||||||
|
const unifiedContents = contents
|
||||||
|
.filter((x) => x[".tag"] !== "deleted")
|
||||||
|
.filter((x) => x.path_display !== `/${this.remoteBaseDir}`)
|
||||||
|
.map((x) => fromDropboxItemToEntity(x, this.remoteBaseDir));
|
||||||
|
|
||||||
|
if (!partial) {
|
||||||
|
while (res.result.has_more) {
|
||||||
|
res = await this.dropbox.filesListFolderContinue({
|
||||||
|
cursor: res.result.cursor,
|
||||||
|
});
|
||||||
|
if (res.status !== 200) {
|
||||||
|
throw Error(JSON.stringify(res));
|
||||||
|
}
|
||||||
|
|
||||||
|
const contents2 = res.result.entries;
|
||||||
|
const unifiedContents2 = contents2
|
||||||
|
.filter((x) => x[".tag"] !== "deleted")
|
||||||
|
.filter((x) => x.path_display !== `/${this.remoteBaseDir}`)
|
||||||
|
.map((x) => fromDropboxItemToEntity(x, this.remoteBaseDir));
|
||||||
|
unifiedContents.push(...unifiedContents2);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fixEntityListCasesInplace(unifiedContents);
|
||||||
|
|
||||||
|
return unifiedContents;
|
||||||
|
}
|
||||||
|
|
||||||
|
async stat(key: string): Promise<Entity> {
|
||||||
|
await this._init();
|
||||||
|
return await this._statFromRoot(getDropboxPath(key, this.remoteBaseDir));
|
||||||
|
}
|
||||||
|
|
||||||
|
async _statFromRoot(key: string): Promise<Entity> {
|
||||||
|
// if (key === "" || key === "/") {
|
||||||
|
// // filesGetMetadata doesn't support root folder
|
||||||
|
// // we instead try to list files
|
||||||
|
// // if no error occurs, we ensemble a fake result.
|
||||||
|
// const rsp = await retryReq(() =>
|
||||||
|
// client.dropbox.filesListFolder({
|
||||||
|
// path: `/${client.key}`,
|
||||||
|
// recursive: false, // don't need to recursive here
|
||||||
|
// })
|
||||||
|
// );
|
||||||
|
// if (rsp.status !== 200) {
|
||||||
|
// throw Error(JSON.stringify(rsp));
|
||||||
|
// }
|
||||||
|
// return {
|
||||||
|
// key: remotePath,
|
||||||
|
// lastModified: undefined,
|
||||||
|
// size: 0,
|
||||||
|
// remoteType: "dropbox",
|
||||||
|
// etag: undefined,
|
||||||
|
// } as Entity;
|
||||||
|
// }
|
||||||
|
|
||||||
|
const rsp = await retryReq(() =>
|
||||||
|
this.dropbox.filesGetMetadata({
|
||||||
|
path: key,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
if (rsp === undefined) {
|
||||||
|
throw Error("dropbox.filesGetMetadata undefinded");
|
||||||
|
}
|
||||||
|
if (rsp.status !== 200) {
|
||||||
|
throw Error(JSON.stringify(rsp));
|
||||||
|
}
|
||||||
|
return fromDropboxItemToEntity(rsp.result, this.remoteBaseDir);
|
||||||
|
}
|
||||||
|
|
||||||
|
async mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity> {
|
||||||
|
if (!key.endsWith("/")) {
|
||||||
|
throw Error(`you should not call mkdir on ${key}`);
|
||||||
|
}
|
||||||
|
await this._init();
|
||||||
|
|
||||||
|
const uploadFile = getDropboxPath(key, this.remoteBaseDir);
|
||||||
|
|
||||||
|
return await this._mkdirFromRoot(uploadFile, mtime, ctime);
|
||||||
|
}
|
||||||
|
|
||||||
|
async _mkdirFromRoot(
|
||||||
|
key: string,
|
||||||
|
mtime?: number,
|
||||||
|
ctime?: number
|
||||||
|
): Promise<Entity> {
|
||||||
|
if (hasEmojiInText(key)) {
|
||||||
|
throw new Error(
|
||||||
|
`${key}: Error: Dropbox does not support emoji in file / folder names.`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (this.foldersCreatedBefore?.has(key)) {
|
||||||
|
// created, pass
|
||||||
|
} else {
|
||||||
|
try {
|
||||||
|
await retryReq(
|
||||||
|
() =>
|
||||||
|
this.dropbox.filesCreateFolderV2({
|
||||||
|
path: key,
|
||||||
|
}),
|
||||||
|
key // just a hint
|
||||||
|
);
|
||||||
|
this.foldersCreatedBefore?.add(key);
|
||||||
|
} catch (e: unknown) {
|
||||||
|
const err = e as DropboxResponseError<files.CreateFolderError>;
|
||||||
|
if (err.status === undefined) {
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
|
if (err.status === 409) {
|
||||||
|
// pass
|
||||||
|
this.foldersCreatedBefore?.add(key);
|
||||||
|
} else {
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return await this._statFromRoot(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
async writeFile(
|
||||||
|
key: string,
|
||||||
|
content: ArrayBuffer,
|
||||||
|
mtime: number,
|
||||||
|
ctime: number
|
||||||
|
): Promise<Entity> {
|
||||||
|
if (key.endsWith("/")) {
|
||||||
|
throw Error(`you should not call writeFile on ${key}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
await this._init();
|
||||||
|
const uploadFile = getDropboxPath(key, this.remoteBaseDir);
|
||||||
|
|
||||||
|
return await this._writeFileFromRoot(
|
||||||
|
uploadFile,
|
||||||
|
content,
|
||||||
|
mtime,
|
||||||
|
ctime,
|
||||||
|
key
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async _writeFileFromRoot(
|
||||||
|
key: string,
|
||||||
|
content: ArrayBuffer,
|
||||||
|
mtime: number,
|
||||||
|
ctime: number,
|
||||||
|
origKey: string
|
||||||
|
): Promise<Entity> {
|
||||||
|
if (hasEmojiInText(origKey)) {
|
||||||
|
throw new Error(
|
||||||
|
`${origKey}: Error: Dropbox does not support emoji in file / folder names.`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const mtimeFixed = Math.floor(mtime / 1000.0) * 1000;
|
||||||
|
const ctimeFixed = Math.floor(ctime / 1000.0) * 1000;
|
||||||
|
const mtimeStr = new Date(mtimeFixed)
|
||||||
|
.toISOString()
|
||||||
|
.replace(/\.\d{3}Z$/, "Z");
|
||||||
|
|
||||||
|
// in dropbox, we don't need to create folders before uploading! cool!
|
||||||
|
// TODO: filesUploadSession for larger files (>=150 MB)
|
||||||
|
|
||||||
|
await retryReq(
|
||||||
|
() =>
|
||||||
|
this.dropbox.filesUpload({
|
||||||
|
path: key,
|
||||||
|
contents: content,
|
||||||
|
mode: {
|
||||||
|
".tag": "overwrite",
|
||||||
|
},
|
||||||
|
client_modified: mtimeStr,
|
||||||
|
}),
|
||||||
|
origKey // hint
|
||||||
|
);
|
||||||
|
|
||||||
|
// we want to mark that parent folders are created
|
||||||
|
if (this.foldersCreatedBefore !== undefined) {
|
||||||
|
const dirs = getFolderLevels(origKey).map((x) =>
|
||||||
|
getDropboxPath(x, this.remoteBaseDir)
|
||||||
|
);
|
||||||
|
for (const dir of dirs) {
|
||||||
|
this.foldersCreatedBefore?.add(dir);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return await this._statFromRoot(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
async readFile(key: string): Promise<ArrayBuffer> {
|
||||||
|
await this._init();
|
||||||
|
if (key.endsWith("/")) {
|
||||||
|
throw new Error(`you should not call readFile on folder ${key}`);
|
||||||
|
}
|
||||||
|
const downloadFile = getDropboxPath(key, this.remoteBaseDir);
|
||||||
|
return await this._readFileFromRoot(downloadFile);
|
||||||
|
}
|
||||||
|
|
||||||
|
async _readFileFromRoot(key: string): Promise<ArrayBuffer> {
|
||||||
|
const rsp = await retryReq(
|
||||||
|
() =>
|
||||||
|
this.dropbox.filesDownload({
|
||||||
|
path: key,
|
||||||
|
}),
|
||||||
|
`downloadFromRemoteRaw=${key}`
|
||||||
|
);
|
||||||
|
if (rsp === undefined) {
|
||||||
|
throw Error(`unknown rsp from dropbox download: ${rsp}`);
|
||||||
|
}
|
||||||
|
if ((rsp.result as any).fileBlob !== undefined) {
|
||||||
|
// we get a Blob
|
||||||
|
const content = (rsp.result as any).fileBlob as Blob;
|
||||||
|
return await content.arrayBuffer();
|
||||||
|
} else if ((rsp.result as any).fileBinary !== undefined) {
|
||||||
|
// we get a Buffer
|
||||||
|
const content = (rsp.result as any).fileBinary as Buffer;
|
||||||
|
return bufferToArrayBuffer(content);
|
||||||
|
} else {
|
||||||
|
throw Error(`unknown rsp from dropbox download: ${rsp}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async rename(key1: string, key2: string): Promise<void> {
|
||||||
|
const remoteFileName1 = getDropboxPath(key1, this.remoteBaseDir);
|
||||||
|
const remoteFileName2 = getDropboxPath(key2, this.remoteBaseDir);
|
||||||
|
await this._init();
|
||||||
|
try {
|
||||||
|
await retryReq(
|
||||||
|
() =>
|
||||||
|
this.dropbox.filesMoveV2({
|
||||||
|
from_path: remoteFileName1,
|
||||||
|
to_path: remoteFileName2,
|
||||||
|
}),
|
||||||
|
`${key1}=>${key2}` // just a hint here
|
||||||
|
);
|
||||||
|
} catch (err) {
|
||||||
|
console.error("some error while moving");
|
||||||
|
console.error(err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async rm(key: string): Promise<void> {
|
||||||
|
if (key === "/") {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const remoteFileName = getDropboxPath(key, this.remoteBaseDir);
|
||||||
|
|
||||||
|
await this._init();
|
||||||
|
try {
|
||||||
|
await retryReq(
|
||||||
|
() =>
|
||||||
|
this.dropbox.filesDeleteV2({
|
||||||
|
path: remoteFileName,
|
||||||
|
}),
|
||||||
|
key // just a hint here
|
||||||
|
);
|
||||||
|
} catch (err) {
|
||||||
|
console.error("some error while deleting");
|
||||||
|
console.error(err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||||
|
try {
|
||||||
|
await this._init();
|
||||||
|
const results = await this._statFromRoot(`/${this.remoteBaseDir}`);
|
||||||
|
if (results === undefined) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
} catch (err) {
|
||||||
|
console.debug(err);
|
||||||
|
callbackFunc?.(err);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getUserDisplayName() {
|
||||||
|
await this._init();
|
||||||
|
const acct = await this.dropbox.usersGetCurrentAccount();
|
||||||
|
return acct.result.name.display_name;
|
||||||
|
}
|
||||||
|
|
||||||
|
async revokeAuth() {
|
||||||
|
try {
|
||||||
|
await this._init();
|
||||||
|
await this.dropbox.authTokenRevoke();
|
||||||
|
return true;
|
||||||
|
} catch (e) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
allowEmptyFile(): boolean {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,580 @@
|
|||||||
|
import type { CipherMethodType, Entity } from "./baseTypes";
|
||||||
|
import * as openssl from "./encryptOpenSSL";
|
||||||
|
import * as rclone from "./encryptRClone";
|
||||||
|
import { isVaildText } from "./misc";
|
||||||
|
|
||||||
|
import cloneDeep from "lodash/cloneDeep";
|
||||||
|
import { FakeFs } from "./fsAll";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* quick guess, no actual decryption here
|
||||||
|
* @param name
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
function isLikelyOpenSSLEncryptedName(name: string): boolean {
|
||||||
|
if (
|
||||||
|
name.startsWith(openssl.MAGIC_ENCRYPTED_PREFIX_BASE32) ||
|
||||||
|
name.startsWith(openssl.MAGIC_ENCRYPTED_PREFIX_BASE64URL)
|
||||||
|
) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* quick guess, no actual decryption here
|
||||||
|
* @param name
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
function isLikelyEncryptedName(name: string): boolean {
|
||||||
|
return isLikelyOpenSSLEncryptedName(name);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* quick guess, no actual decryption here, only openssl can be guessed here
|
||||||
|
* @param name
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
function isLikelyEncryptedNameNotMatchMethod(
|
||||||
|
name: string,
|
||||||
|
method: CipherMethodType
|
||||||
|
): boolean {
|
||||||
|
if (isLikelyOpenSSLEncryptedName(name) && method !== "openssl-base64") {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
if (!isLikelyOpenSSLEncryptedName(name) && method === "openssl-base64") {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PasswordCheckType {
|
||||||
|
ok: boolean;
|
||||||
|
reason:
|
||||||
|
| "empty_remote"
|
||||||
|
| "unknown_encryption_method"
|
||||||
|
| "remote_encrypted_local_no_password"
|
||||||
|
| "password_matched"
|
||||||
|
| "password_or_method_not_matched_or_remote_not_encrypted"
|
||||||
|
| "likely_no_password_both_sides"
|
||||||
|
| "encryption_method_not_matched";
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Useful if isPasswordEmpty()
|
||||||
|
*/
|
||||||
|
function copyEntityAndCopyKeyEncSizeEnc(entity: Entity) {
|
||||||
|
const res = cloneDeep(entity);
|
||||||
|
res["keyEnc"] = res["keyRaw"];
|
||||||
|
res["sizeEnc"] = res["sizeRaw"];
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class FakeFsEncrypt extends FakeFs {
|
||||||
|
innerFs: FakeFs;
|
||||||
|
readonly password: string;
|
||||||
|
readonly method: CipherMethodType;
|
||||||
|
cipherRClone?: rclone.CipherRclone;
|
||||||
|
cacheMapOrigToEnc: Record<string, string>;
|
||||||
|
hasCacheMap: boolean;
|
||||||
|
kind: string;
|
||||||
|
|
||||||
|
constructor(innerFs: FakeFs, password: string, method: CipherMethodType) {
|
||||||
|
super();
|
||||||
|
this.innerFs = innerFs;
|
||||||
|
this.password = password ?? "";
|
||||||
|
this.method = method;
|
||||||
|
this.cacheMapOrigToEnc = {};
|
||||||
|
this.hasCacheMap = false;
|
||||||
|
|
||||||
|
this.kind = `encrypt(${this.innerFs.kind},${
|
||||||
|
this.password !== "" ? method : "no password"
|
||||||
|
})`;
|
||||||
|
|
||||||
|
if (method === "rclone-base64") {
|
||||||
|
this.cipherRClone = new rclone.CipherRclone(password, 5);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
isPasswordEmpty() {
|
||||||
|
return this.password === "";
|
||||||
|
}
|
||||||
|
|
||||||
|
isFolderAware() {
|
||||||
|
if (this.method === "openssl-base64") {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (this.method === "rclone-base64") {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
throw Error(`no idea about isFolderAware for method=${this.method}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
async isPasswordOk(): Promise<PasswordCheckType> {
|
||||||
|
const innerWalkResult = await this.walkPartial();
|
||||||
|
|
||||||
|
if (innerWalkResult === undefined || innerWalkResult.length === 0) {
|
||||||
|
// remote empty
|
||||||
|
return {
|
||||||
|
ok: true,
|
||||||
|
reason: "empty_remote",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
const santyCheckKey = innerWalkResult[0].keyRaw;
|
||||||
|
|
||||||
|
if (this.isPasswordEmpty()) {
|
||||||
|
// TODO: no way to distinguish remote rclone encrypted
|
||||||
|
// if local has no password??
|
||||||
|
if (isLikelyEncryptedName(santyCheckKey)) {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
reason: "remote_encrypted_local_no_password",
|
||||||
|
};
|
||||||
|
} else {
|
||||||
|
return {
|
||||||
|
ok: true,
|
||||||
|
reason: "likely_no_password_both_sides",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (this.method === "unknown") {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
reason: "unknown_encryption_method",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (isLikelyEncryptedNameNotMatchMethod(santyCheckKey, this.method)) {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
reason: "encryption_method_not_matched",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
const k = await this._decryptName(santyCheckKey);
|
||||||
|
if (k === undefined) {
|
||||||
|
throw Error(`decryption failed`);
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
ok: true,
|
||||||
|
reason: "password_matched",
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
reason: "password_or_method_not_matched_or_remote_not_encrypted",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async walk(): Promise<Entity[]> {
|
||||||
|
const innerWalkResult = await this.innerFs.walk();
|
||||||
|
return await this._dealWithWalk(innerWalkResult);
|
||||||
|
}
|
||||||
|
|
||||||
|
async walkPartial(): Promise<Entity[]> {
|
||||||
|
const innerWalkResult = await this.innerFs.walkPartial();
|
||||||
|
return await this._dealWithWalk(innerWalkResult);
|
||||||
|
}
|
||||||
|
|
||||||
|
async _dealWithWalk(innerWalkResult: Entity[]): Promise<Entity[]> {
|
||||||
|
const res: Entity[] = [];
|
||||||
|
|
||||||
|
if (this.isPasswordEmpty()) {
|
||||||
|
for (const innerEntity of innerWalkResult) {
|
||||||
|
res.push(copyEntityAndCopyKeyEncSizeEnc(innerEntity));
|
||||||
|
this.cacheMapOrigToEnc[innerEntity.key!] = innerEntity.key!;
|
||||||
|
}
|
||||||
|
this.hasCacheMap = true;
|
||||||
|
return res;
|
||||||
|
} else {
|
||||||
|
for (const innerEntity of innerWalkResult) {
|
||||||
|
const key = await this._decryptName(innerEntity.keyRaw);
|
||||||
|
const size = key.endsWith("/") ? 0 : undefined;
|
||||||
|
res.push({
|
||||||
|
key: key,
|
||||||
|
keyRaw: innerEntity.keyRaw,
|
||||||
|
keyEnc: innerEntity.key!,
|
||||||
|
mtimeCli: innerEntity.mtimeCli,
|
||||||
|
mtimeSvr: innerEntity.mtimeSvr,
|
||||||
|
size: size,
|
||||||
|
sizeEnc: innerEntity.size!,
|
||||||
|
sizeRaw: innerEntity.sizeRaw,
|
||||||
|
hash: undefined,
|
||||||
|
synthesizedFolder: innerEntity.synthesizedFolder,
|
||||||
|
});
|
||||||
|
|
||||||
|
this.cacheMapOrigToEnc[key] = innerEntity.keyRaw;
|
||||||
|
}
|
||||||
|
this.hasCacheMap = true;
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async stat(key: string): Promise<Entity> {
|
||||||
|
if (!this.hasCacheMap) {
|
||||||
|
throw new Error("You have to build the cacheMap firstly for stat");
|
||||||
|
}
|
||||||
|
const keyEnc = this.cacheMapOrigToEnc[key];
|
||||||
|
if (keyEnc === undefined) {
|
||||||
|
throw new Error(`no encrypted key ${key} before!`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const innerEntity = await this.innerFs.stat(keyEnc);
|
||||||
|
if (this.isPasswordEmpty()) {
|
||||||
|
return copyEntityAndCopyKeyEncSizeEnc(innerEntity);
|
||||||
|
} else {
|
||||||
|
return {
|
||||||
|
key: key,
|
||||||
|
keyRaw: innerEntity.keyRaw,
|
||||||
|
keyEnc: innerEntity.key!,
|
||||||
|
mtimeCli: innerEntity.mtimeCli,
|
||||||
|
mtimeSvr: innerEntity.mtimeSvr,
|
||||||
|
size: undefined,
|
||||||
|
sizeEnc: innerEntity.size!,
|
||||||
|
sizeRaw: innerEntity.sizeRaw,
|
||||||
|
hash: undefined,
|
||||||
|
synthesizedFolder: innerEntity.synthesizedFolder,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity> {
|
||||||
|
if (!this.hasCacheMap) {
|
||||||
|
throw new Error("You have to build the cacheMap firstly for mkdir");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!key.endsWith("/")) {
|
||||||
|
throw new Error(`should not call mkdir on ${key}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
let keyEnc = this.cacheMapOrigToEnc[key];
|
||||||
|
if (keyEnc === undefined) {
|
||||||
|
if (this.isPasswordEmpty()) {
|
||||||
|
keyEnc = key;
|
||||||
|
} else {
|
||||||
|
keyEnc = await this._encryptName(key);
|
||||||
|
}
|
||||||
|
this.cacheMapOrigToEnc[key] = keyEnc;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.isPasswordEmpty() || this.isFolderAware()) {
|
||||||
|
const innerEntity = await this.innerFs.mkdir(keyEnc, mtime, ctime);
|
||||||
|
return copyEntityAndCopyKeyEncSizeEnc(innerEntity);
|
||||||
|
} else {
|
||||||
|
const now = Date.now();
|
||||||
|
let content = new ArrayBuffer(0);
|
||||||
|
if (!this.innerFs.allowEmptyFile()) {
|
||||||
|
content = new ArrayBuffer(1);
|
||||||
|
}
|
||||||
|
const innerEntity = await this.innerFs.writeFile(
|
||||||
|
keyEnc,
|
||||||
|
content,
|
||||||
|
mtime ?? now,
|
||||||
|
ctime ?? now
|
||||||
|
);
|
||||||
|
return {
|
||||||
|
key: key,
|
||||||
|
keyRaw: innerEntity.keyRaw,
|
||||||
|
keyEnc: innerEntity.key!,
|
||||||
|
mtimeCli: innerEntity.mtimeCli,
|
||||||
|
mtimeSvr: innerEntity.mtimeSvr,
|
||||||
|
size: 0,
|
||||||
|
sizeEnc: innerEntity.size!,
|
||||||
|
sizeRaw: innerEntity.sizeRaw,
|
||||||
|
hash: undefined,
|
||||||
|
synthesizedFolder: innerEntity.synthesizedFolder,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async writeFile(
|
||||||
|
key: string,
|
||||||
|
content: ArrayBuffer,
|
||||||
|
mtime: number,
|
||||||
|
ctime: number
|
||||||
|
): Promise<Entity> {
|
||||||
|
if (!this.hasCacheMap) {
|
||||||
|
throw new Error("You have to build the cacheMap firstly for readFile");
|
||||||
|
}
|
||||||
|
let keyEnc = this.cacheMapOrigToEnc[key];
|
||||||
|
if (keyEnc === undefined) {
|
||||||
|
if (this.isPasswordEmpty()) {
|
||||||
|
keyEnc = key;
|
||||||
|
} else {
|
||||||
|
keyEnc = await this._encryptName(key);
|
||||||
|
}
|
||||||
|
this.cacheMapOrigToEnc[key] = keyEnc;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.isPasswordEmpty()) {
|
||||||
|
const innerEntity = await this.innerFs.writeFile(
|
||||||
|
keyEnc,
|
||||||
|
content,
|
||||||
|
mtime,
|
||||||
|
ctime
|
||||||
|
);
|
||||||
|
return copyEntityAndCopyKeyEncSizeEnc(innerEntity);
|
||||||
|
} else {
|
||||||
|
const contentEnc = await this._encryptContent(content);
|
||||||
|
const innerEntity = await this.innerFs.writeFile(
|
||||||
|
keyEnc,
|
||||||
|
contentEnc,
|
||||||
|
mtime,
|
||||||
|
ctime
|
||||||
|
);
|
||||||
|
return {
|
||||||
|
key: key,
|
||||||
|
keyRaw: innerEntity.keyRaw,
|
||||||
|
keyEnc: innerEntity.key!,
|
||||||
|
mtimeCli: innerEntity.mtimeCli,
|
||||||
|
mtimeSvr: innerEntity.mtimeSvr,
|
||||||
|
size: undefined,
|
||||||
|
sizeEnc: innerEntity.size!,
|
||||||
|
sizeRaw: innerEntity.sizeRaw,
|
||||||
|
hash: undefined,
|
||||||
|
synthesizedFolder: innerEntity.synthesizedFolder,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async readFile(key: string): Promise<ArrayBuffer> {
|
||||||
|
if (!this.hasCacheMap) {
|
||||||
|
throw new Error("You have to build the cacheMap firstly for readFile");
|
||||||
|
}
|
||||||
|
const keyEnc = this.cacheMapOrigToEnc[key];
|
||||||
|
if (keyEnc === undefined) {
|
||||||
|
throw new Error(`no encrypted key ${key} before! cannot readFile`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const contentEnc = await this.innerFs.readFile(keyEnc);
|
||||||
|
if (this.isPasswordEmpty()) {
|
||||||
|
return contentEnc;
|
||||||
|
} else {
|
||||||
|
const res = await this._decryptContent(contentEnc);
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async rename(key1: string, key2: string): Promise<void> {
|
||||||
|
if (!this.hasCacheMap) {
|
||||||
|
throw new Error("You have to build the cacheMap firstly for readFile");
|
||||||
|
}
|
||||||
|
let key1Enc = this.cacheMapOrigToEnc[key1];
|
||||||
|
if (key1Enc === undefined) {
|
||||||
|
if (this.isPasswordEmpty()) {
|
||||||
|
key1Enc = key1;
|
||||||
|
} else {
|
||||||
|
key1Enc = await this._encryptName(key1);
|
||||||
|
}
|
||||||
|
this.cacheMapOrigToEnc[key1] = key1Enc;
|
||||||
|
}
|
||||||
|
let key2Enc = this.cacheMapOrigToEnc[key2];
|
||||||
|
if (key2Enc === undefined) {
|
||||||
|
if (this.isPasswordEmpty()) {
|
||||||
|
key2Enc = key2;
|
||||||
|
} else {
|
||||||
|
key2Enc = await this._encryptName(key2);
|
||||||
|
}
|
||||||
|
this.cacheMapOrigToEnc[key2] = key2Enc;
|
||||||
|
}
|
||||||
|
return await this.innerFs.rename(key1Enc, key2Enc);
|
||||||
|
}
|
||||||
|
|
||||||
|
async rm(key: string): Promise<void> {
|
||||||
|
if (!this.hasCacheMap) {
|
||||||
|
throw new Error("You have to build the cacheMap firstly for rm");
|
||||||
|
}
|
||||||
|
const keyEnc = this.cacheMapOrigToEnc[key];
|
||||||
|
if (keyEnc === undefined) {
|
||||||
|
throw new Error(`no encrypted key ${key} before! cannot rm`);
|
||||||
|
}
|
||||||
|
return await this.innerFs.rm(keyEnc);
|
||||||
|
}
|
||||||
|
|
||||||
|
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||||
|
return await this.innerFs.checkConnect(callbackFunc);
|
||||||
|
}
|
||||||
|
|
||||||
|
async closeResources() {
|
||||||
|
if (this.method === "rclone-base64" && this.cipherRClone !== undefined) {
|
||||||
|
this.cipherRClone.closeResources();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async encryptEntity(input: Entity): Promise<Entity> {
|
||||||
|
if (input.key === undefined) {
|
||||||
|
// input.key should always have value
|
||||||
|
throw Error(`input ${input.keyRaw} is abnormal without key`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.isPasswordEmpty()) {
|
||||||
|
return copyEntityAndCopyKeyEncSizeEnc(input);
|
||||||
|
}
|
||||||
|
|
||||||
|
// below is for having password
|
||||||
|
const local = cloneDeep(input);
|
||||||
|
if (local.sizeEnc === undefined && local.size !== undefined) {
|
||||||
|
// it's not filled yet, we fill it
|
||||||
|
// local.size is possibly undefined if it's "prevSync" Entity
|
||||||
|
// but local.key should always have value
|
||||||
|
local.sizeEnc = this._getSizeFromOrigToEnc(local.size);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (local.keyEnc === undefined || local.keyEnc === "") {
|
||||||
|
let keyEnc = this.cacheMapOrigToEnc[input.key];
|
||||||
|
if (keyEnc !== undefined && keyEnc !== "" && keyEnc !== local.key) {
|
||||||
|
// we can reuse remote encrypted key if any
|
||||||
|
local.keyEnc = keyEnc;
|
||||||
|
} else {
|
||||||
|
// we assign a new encrypted key because of no remote
|
||||||
|
keyEnc = await this._encryptName(input.key);
|
||||||
|
local.keyEnc = keyEnc;
|
||||||
|
// remember to add back to cache!
|
||||||
|
this.cacheMapOrigToEnc[input.key] = keyEnc;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return local;
|
||||||
|
}
|
||||||
|
|
||||||
|
async _encryptContent(content: ArrayBuffer) {
|
||||||
|
// console.debug("start encryptContent");
|
||||||
|
if (this.password === "") {
|
||||||
|
return content;
|
||||||
|
}
|
||||||
|
if (this.method === "openssl-base64") {
|
||||||
|
const res = await openssl.encryptArrayBuffer(content, this.password);
|
||||||
|
if (res === undefined) {
|
||||||
|
throw Error(`cannot encrypt content`);
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
} else if (this.method === "rclone-base64") {
|
||||||
|
const res =
|
||||||
|
await this.cipherRClone!.encryptContentByCallingWorker(content);
|
||||||
|
if (res === undefined) {
|
||||||
|
throw Error(`cannot encrypt content`);
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
} else {
|
||||||
|
throw Error(`not supported encrypt method=${this.method}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async _decryptContent(content: ArrayBuffer) {
|
||||||
|
// console.debug("start decryptContent");
|
||||||
|
if (this.password === "") {
|
||||||
|
return content;
|
||||||
|
}
|
||||||
|
if (this.method === "openssl-base64") {
|
||||||
|
const res = await openssl.decryptArrayBuffer(content, this.password);
|
||||||
|
if (res === undefined) {
|
||||||
|
throw Error(`cannot decrypt content`);
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
} else if (this.method === "rclone-base64") {
|
||||||
|
const res =
|
||||||
|
await this.cipherRClone!.decryptContentByCallingWorker(content);
|
||||||
|
if (res === undefined) {
|
||||||
|
throw Error(`cannot decrypt content`);
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
} else {
|
||||||
|
throw Error(`not supported decrypt method=${this.method}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async _encryptName(name: string) {
|
||||||
|
// console.debug("start encryptName");
|
||||||
|
if (this.password === "") {
|
||||||
|
return name;
|
||||||
|
}
|
||||||
|
if (this.method === "openssl-base64") {
|
||||||
|
const res = await openssl.encryptStringToBase64url(name, this.password);
|
||||||
|
if (res === undefined) {
|
||||||
|
throw Error(`cannot encrypt name=${name}`);
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
} else if (this.method === "rclone-base64") {
|
||||||
|
const res = await this.cipherRClone!.encryptNameByCallingWorker(name);
|
||||||
|
if (res === undefined) {
|
||||||
|
throw Error(`cannot encrypt name=${name}`);
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
} else {
|
||||||
|
throw Error(`not supported encrypt method=${this.method}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async _decryptName(name: string): Promise<string> {
|
||||||
|
// console.debug("start decryptName");
|
||||||
|
if (this.password === "") {
|
||||||
|
return name;
|
||||||
|
}
|
||||||
|
if (this.method === "openssl-base64") {
|
||||||
|
if (name.startsWith(openssl.MAGIC_ENCRYPTED_PREFIX_BASE32)) {
|
||||||
|
// backward compitable with the openssl-base32
|
||||||
|
try {
|
||||||
|
const res = await openssl.decryptBase32ToString(name, this.password);
|
||||||
|
if (res !== undefined && isVaildText(res)) {
|
||||||
|
return res;
|
||||||
|
} else {
|
||||||
|
throw Error(`cannot decrypt name=${name}`);
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
throw Error(`cannot decrypt name=${name}`);
|
||||||
|
}
|
||||||
|
} else if (name.startsWith(openssl.MAGIC_ENCRYPTED_PREFIX_BASE64URL)) {
|
||||||
|
try {
|
||||||
|
const res = await openssl.decryptBase64urlToString(
|
||||||
|
name,
|
||||||
|
this.password
|
||||||
|
);
|
||||||
|
if (res !== undefined && isVaildText(res)) {
|
||||||
|
return res;
|
||||||
|
} else {
|
||||||
|
throw Error(`cannot decrypt name=${name}`);
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
throw Error(`cannot decrypt name=${name}`);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
throw Error(
|
||||||
|
`method=${this.method} but the name=${name}, likely mismatch`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
} else if (this.method === "rclone-base64") {
|
||||||
|
const res = await this.cipherRClone!.decryptNameByCallingWorker(name);
|
||||||
|
if (res === undefined) {
|
||||||
|
throw Error(`cannot decrypt name=${name}`);
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
} else {
|
||||||
|
throw Error(`not supported decrypt method=${this.method}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
_getSizeFromOrigToEnc(x: number) {
|
||||||
|
if (this.password === "") {
|
||||||
|
return x;
|
||||||
|
}
|
||||||
|
if (this.method === "openssl-base64") {
|
||||||
|
return openssl.getSizeFromOrigToEnc(x);
|
||||||
|
} else if (this.method === "rclone-base64") {
|
||||||
|
return rclone.getSizeFromOrigToEnc(x);
|
||||||
|
} else {
|
||||||
|
throw Error(`not supported encrypt method=${this.method}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getUserDisplayName(): Promise<string> {
|
||||||
|
return await this.innerFs.getUserDisplayName();
|
||||||
|
}
|
||||||
|
|
||||||
|
async revokeAuth(): Promise<any> {
|
||||||
|
return await this.innerFs.revokeAuth();
|
||||||
|
}
|
||||||
|
|
||||||
|
allowEmptyFile(): boolean {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
import type { RemotelySavePluginSettings } from "./baseTypes";
|
||||||
|
import type { FakeFs } from "./fsAll";
|
||||||
|
import { FakeFsDropbox } from "./fsDropbox";
|
||||||
|
import { FakeFsOnedrive } from "./fsOnedrive";
|
||||||
|
import { FakeFsS3 } from "./fsS3";
|
||||||
|
import { FakeFsWebdav } from "./fsWebdav";
|
||||||
|
import { FakeFsWebdis } from "./fsWebdis";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* To avoid circular dependency, we need a new file here.
|
||||||
|
*/
|
||||||
|
export function getClient(
|
||||||
|
settings: RemotelySavePluginSettings,
|
||||||
|
vaultName: string,
|
||||||
|
saveUpdatedConfigFunc: () => Promise<any>
|
||||||
|
): FakeFs {
|
||||||
|
switch (settings.serviceType) {
|
||||||
|
case "s3":
|
||||||
|
return new FakeFsS3(settings.s3);
|
||||||
|
case "webdav":
|
||||||
|
return new FakeFsWebdav(
|
||||||
|
settings.webdav,
|
||||||
|
vaultName,
|
||||||
|
saveUpdatedConfigFunc
|
||||||
|
);
|
||||||
|
case "dropbox":
|
||||||
|
return new FakeFsDropbox(
|
||||||
|
settings.dropbox,
|
||||||
|
vaultName,
|
||||||
|
saveUpdatedConfigFunc
|
||||||
|
);
|
||||||
|
case "onedrive":
|
||||||
|
return new FakeFsOnedrive(
|
||||||
|
settings.onedrive,
|
||||||
|
vaultName,
|
||||||
|
saveUpdatedConfigFunc
|
||||||
|
);
|
||||||
|
case "webdis":
|
||||||
|
return new FakeFsWebdis(
|
||||||
|
settings.webdis,
|
||||||
|
vaultName,
|
||||||
|
saveUpdatedConfigFunc
|
||||||
|
);
|
||||||
|
default:
|
||||||
|
throw Error(`cannot init client for serviceType=${settings.serviceType}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
+186
@@ -0,0 +1,186 @@
|
|||||||
|
import { DEFAULT_DEBUG_FOLDER, type Entity } from "./baseTypes";
|
||||||
|
import { FakeFs } from "./fsAll";
|
||||||
|
|
||||||
|
import { TFile, TFolder, type Vault } from "obsidian";
|
||||||
|
import { mkdirpInVault, statFix, unixTimeToStr } from "./misc";
|
||||||
|
import { listFilesInObsFolder } from "./obsFolderLister";
|
||||||
|
import type { Profiler } from "./profiler";
|
||||||
|
|
||||||
|
export class FakeFsLocal extends FakeFs {
|
||||||
|
vault: Vault;
|
||||||
|
syncConfigDir: boolean;
|
||||||
|
configDir: string;
|
||||||
|
pluginID: string;
|
||||||
|
profiler: Profiler | undefined;
|
||||||
|
deleteToWhere: "obsidian" | "system";
|
||||||
|
kind: "local";
|
||||||
|
constructor(
|
||||||
|
vault: Vault,
|
||||||
|
syncConfigDir: boolean,
|
||||||
|
configDir: string,
|
||||||
|
pluginID: string,
|
||||||
|
profiler: Profiler | undefined,
|
||||||
|
deleteToWhere: "obsidian" | "system"
|
||||||
|
) {
|
||||||
|
super();
|
||||||
|
|
||||||
|
this.vault = vault;
|
||||||
|
this.syncConfigDir = syncConfigDir;
|
||||||
|
this.configDir = configDir;
|
||||||
|
this.pluginID = pluginID;
|
||||||
|
this.profiler = profiler;
|
||||||
|
this.deleteToWhere = deleteToWhere;
|
||||||
|
this.kind = "local";
|
||||||
|
}
|
||||||
|
|
||||||
|
async walk(): Promise<Entity[]> {
|
||||||
|
this.profiler?.addIndent();
|
||||||
|
this.profiler?.insert("enter walk for local");
|
||||||
|
const local: Entity[] = [];
|
||||||
|
|
||||||
|
const localTAbstractFiles = this.vault.getAllLoadedFiles();
|
||||||
|
this.profiler?.insert("finish getting walk for local");
|
||||||
|
for (const entry of localTAbstractFiles) {
|
||||||
|
let r: Entity | undefined = undefined;
|
||||||
|
let key = entry.path;
|
||||||
|
|
||||||
|
if (entry.path === "/") {
|
||||||
|
// ignore
|
||||||
|
continue;
|
||||||
|
} else if (entry instanceof TFile) {
|
||||||
|
let mtimeLocal: number | undefined = entry.stat.mtime;
|
||||||
|
if (mtimeLocal <= 0) {
|
||||||
|
mtimeLocal = entry.stat.ctime;
|
||||||
|
}
|
||||||
|
if (mtimeLocal === 0) {
|
||||||
|
mtimeLocal = undefined;
|
||||||
|
}
|
||||||
|
if (mtimeLocal === undefined) {
|
||||||
|
throw Error(
|
||||||
|
`Your file has last modified time 0: ${key}, don't know how to deal with it`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
r = {
|
||||||
|
key: entry.path, // local always unencrypted
|
||||||
|
keyRaw: entry.path,
|
||||||
|
mtimeCli: mtimeLocal,
|
||||||
|
mtimeSvr: mtimeLocal,
|
||||||
|
size: entry.stat.size, // local always unencrypted
|
||||||
|
sizeRaw: entry.stat.size,
|
||||||
|
};
|
||||||
|
} else if (entry instanceof TFolder) {
|
||||||
|
key = `${entry.path}/`;
|
||||||
|
r = {
|
||||||
|
key: key,
|
||||||
|
keyRaw: key,
|
||||||
|
size: 0,
|
||||||
|
sizeRaw: 0,
|
||||||
|
};
|
||||||
|
} else {
|
||||||
|
throw Error(`unexpected ${entry}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (r.keyRaw.startsWith(DEFAULT_DEBUG_FOLDER)) {
|
||||||
|
// skip listing the debug folder,
|
||||||
|
// which should always not involved in sync
|
||||||
|
// continue;
|
||||||
|
} else {
|
||||||
|
local.push(r);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
this.profiler?.insert("finish transforming walk for local");
|
||||||
|
|
||||||
|
if (this.syncConfigDir) {
|
||||||
|
this.profiler?.insert("into syncConfigDir");
|
||||||
|
const syncFiles = await listFilesInObsFolder(
|
||||||
|
this.configDir,
|
||||||
|
this.vault,
|
||||||
|
this.pluginID
|
||||||
|
);
|
||||||
|
for (const f of syncFiles) {
|
||||||
|
local.push(f);
|
||||||
|
}
|
||||||
|
this.profiler?.insert("finish syncConfigDir");
|
||||||
|
}
|
||||||
|
|
||||||
|
this.profiler?.insert("finish walk for local");
|
||||||
|
this.profiler?.removeIndent();
|
||||||
|
return local;
|
||||||
|
}
|
||||||
|
|
||||||
|
async walkPartial(): Promise<Entity[]> {
|
||||||
|
return await this.walk();
|
||||||
|
}
|
||||||
|
|
||||||
|
async stat(key: string): Promise<Entity> {
|
||||||
|
const statRes = await statFix(this.vault, key);
|
||||||
|
if (statRes === undefined || statRes === null) {
|
||||||
|
throw Error(`${key} does not exist! cannot stat for local`);
|
||||||
|
}
|
||||||
|
const isFolder = statRes.type === "folder";
|
||||||
|
return {
|
||||||
|
key: isFolder ? `${key}/` : key, // local always unencrypted
|
||||||
|
keyRaw: isFolder ? `${key}/` : key,
|
||||||
|
mtimeCli: statRes.mtime,
|
||||||
|
mtimeSvr: statRes.mtime,
|
||||||
|
mtimeCliFmt: unixTimeToStr(statRes.mtime),
|
||||||
|
mtimeSvrFmt: unixTimeToStr(statRes.mtime),
|
||||||
|
size: statRes.size, // local always unencrypted
|
||||||
|
sizeRaw: statRes.size,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity> {
|
||||||
|
// console.debug(`mkdir: ${key}`);
|
||||||
|
await mkdirpInVault(key, this.vault);
|
||||||
|
return await this.stat(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
async writeFile(
|
||||||
|
key: string,
|
||||||
|
content: ArrayBuffer,
|
||||||
|
mtime: number,
|
||||||
|
ctime: number
|
||||||
|
): Promise<Entity> {
|
||||||
|
await this.vault.adapter.writeBinary(key, content, {
|
||||||
|
mtime: mtime,
|
||||||
|
ctime: ctime,
|
||||||
|
});
|
||||||
|
return await this.stat(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
async readFile(key: string): Promise<ArrayBuffer> {
|
||||||
|
return await this.vault.adapter.readBinary(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
async rename(key1: string, key2: string): Promise<void> {
|
||||||
|
return await this.vault.adapter.rename(key1, key2);
|
||||||
|
}
|
||||||
|
|
||||||
|
async rm(key: string): Promise<void> {
|
||||||
|
if (this.deleteToWhere === "obsidian") {
|
||||||
|
await this.vault.adapter.trashLocal(key);
|
||||||
|
} else {
|
||||||
|
// "system"
|
||||||
|
if (!(await this.vault.adapter.trashSystem(key))) {
|
||||||
|
await this.vault.adapter.trashLocal(key);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
async getUserDisplayName(): Promise<string> {
|
||||||
|
throw new Error("Method not implemented.");
|
||||||
|
}
|
||||||
|
|
||||||
|
async revokeAuth(): Promise<any> {
|
||||||
|
throw new Error("Method not implemented.");
|
||||||
|
}
|
||||||
|
|
||||||
|
allowEmptyFile(): boolean {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user